matt/port-nimara-client-portal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

FEAT: Correct spelling of 'Documenso' in API utility functions and add connectivity test for Documenso API

Browse Source
This commit is contained in:
Matt
2025-06-17 15:17:19 +02:00
parent 8d378f5b53
commit 0b881a2588
6 changed files with 112 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
server/utils/documeso.ts
View File

@@ -1,10 +1,10 @@
// Documeso API client utilities
interface DocumesoConfig {
// Documenso API client utilities
interface DocumensoConfig {
apiUrl: string;
apiKey: string;
}
interface DocumesoRecipient {
interface DocumensoRecipient {
id: number;
documentId: number;
email: string;
@@ -19,7 +19,7 @@ interface DocumesoRecipient {
signingUrl: string;
}
interface DocumesoDocument {
interface DocumensoDocument {
id: number;
externalId: string;
userId: number;
@@ -30,30 +30,40 @@ interface DocumesoDocument {
createdAt: string;
updatedAt: string;
completedAt: string | null;
recipients: DocumesoRecipient[];
recipients: DocumensoRecipient[];
}
interface DocumesoListResponse {
documents: DocumesoDocument[];
interface DocumensoListResponse {
documents: DocumensoDocument[];
total: number;
page: number;
perPage: number;
}
// Get Documeso configuration
const getDocumesoConfig = (): DocumesoConfig => {
// Get Documenso configuration from environment variables
const getDocumensoConfig = (): DocumensoConfig => {
const apiUrl = process.env.NUXT_DOCUMENSO_BASE_URL;
const apiKey = process.env.NUXT_DOCUMENSO_API_KEY;
if (!apiUrl || !apiKey) {
throw createError({
statusCode: 500,
statusMessage: 'Documenso configuration missing. Please check NUXT_DOCUMENSO_BASE_URL and NUXT_DOCUMENSO_API_KEY environment variables.'
});
}
return {
apiUrl: 'https://signatures.portnimara.dev/api/v1',
apiKey: 'Bearer api_malptg62zqyb0wrp'
apiUrl: `${apiUrl}/api/v1`,
apiKey: `Bearer ${apiKey}`
};
};
// Fetch a single document by ID
export const getDocumesoDocument = async (documentId: number): Promise<DocumesoDocument> => {
const config = getDocumesoConfig();
export const getDocumensoDocument = async (documentId: number): Promise<DocumensoDocument> => {
const config = getDocumensoConfig();
try {
const response = await $fetch<DocumesoDocument>(`${config.apiUrl}/documents/${documentId}`, {
const response = await $fetch<DocumensoDocument>(`${config.apiUrl}/documents/${documentId}`, {
headers: {
'Authorization': config.apiKey,
'Content-Type': 'application/json'
@@ -62,17 +72,17 @@ export const getDocumesoDocument = async (documentId: number): Promise<DocumesoD
return response;
} catch (error) {
console.error('Failed to fetch Documeso document:', error);
console.error('Failed to fetch Documenso document:', error);
throw error;
}
};
// Search documents by external ID (e.g., 'loi-94')
export const searchDocumesoDocuments = async (externalId?: string): Promise<DocumesoDocument[]> => {
const config = getDocumesoConfig();
export const searchDocumensoDocuments = async (externalId?: string): Promise<DocumensoDocument[]> => {
const config = getDocumensoConfig();
try {
const response = await $fetch<DocumesoListResponse>(`${config.apiUrl}/documents`, {
const response = await $fetch<DocumensoListResponse>(`${config.apiUrl}/documents`, {
headers: {
'Authorization': config.apiKey,
'Content-Type': 'application/json'
@@ -84,37 +94,37 @@ export const searchDocumesoDocuments = async (externalId?: string): Promise<Docu
// If externalId is provided, filter by it
if (externalId) {
return response.documents.filter(doc => doc.externalId === externalId);
return response.documents.filter((doc: DocumensoDocument) => doc.externalId === externalId);
}
return response.documents;
} catch (error) {
console.error('Failed to search Documeso documents:', error);
console.error('Failed to search Documenso documents:', error);
throw error;
}
};
// Get document by external ID (e.g., 'loi-94')
export const getDocumesoDocumentByExternalId = async (externalId: string): Promise<DocumesoDocument | null> => {
const documents = await searchDocumesoDocuments(externalId);
export const getDocumensoDocumentByExternalId = async (externalId: string): Promise<DocumensoDocument | null> => {
const documents = await searchDocumensoDocuments(externalId);
return documents.length > 0 ? documents[0] : null;
};
// Check signature status for a document
export const checkDocumentSignatureStatus = async (documentId: number): Promise<{
documentStatus: string;
unsignedRecipients: DocumesoRecipient[];
signedRecipients: DocumesoRecipient[];
unsignedRecipients: DocumensoRecipient[];
signedRecipients: DocumensoRecipient[];
clientSigned: boolean;
allSigned: boolean;
}> => {
const document = await getDocumesoDocument(documentId);
const document = await getDocumensoDocument(documentId);
const unsignedRecipients = document.recipients.filter(r => r.signingStatus === 'NOT_SIGNED');
const signedRecipients = document.recipients.filter(r => r.signingStatus === 'SIGNED');
const unsignedRecipients = document.recipients.filter((r: DocumensoRecipient) => r.signingStatus === 'NOT_SIGNED');
const signedRecipients = document.recipients.filter((r: DocumensoRecipient) => r.signingStatus === 'SIGNED');
// Check if client (signingOrder = 1) has signed
const clientRecipient = document.recipients.find(r => r.signingOrder === 1);
const clientRecipient = document.recipients.find((r: DocumensoRecipient) => r.signingOrder === 1);
const clientSigned = clientRecipient ? clientRecipient.signingStatus === 'SIGNED' : false;
const allSigned = unsignedRecipients.length === 0;
@@ -129,7 +139,7 @@ export const checkDocumentSignatureStatus = async (documentId: number): Promise<
};
// Get recipients who need to sign (excluding client)
export const getRecipientsToRemind = async (documentId: number): Promise<DocumesoRecipient[]> => {
export const getRecipientsToRemind = async (documentId: number): Promise<DocumensoRecipient[]> => {
const status = await checkDocumentSignatureStatus(documentId);
// Only remind if client has signed
@@ -138,16 +148,16 @@ export const getRecipientsToRemind = async (documentId: number): Promise<Documes
}
// Return unsigned recipients with signingOrder > 1
return status.unsignedRecipients.filter(r => r.signingOrder > 1);
return status.unsignedRecipients.filter((r: DocumensoRecipient) => r.signingOrder > 1);
};
// Format recipient name for emails
export const formatRecipientName = (recipient: DocumesoRecipient): string => {
export const formatRecipientName = (recipient: DocumensoRecipient): string => {
const firstName = recipient.name.split(' ')[0];
return firstName;
};
// Get signing URL for a recipient
export const getSigningUrl = (recipient: DocumesoRecipient): string => {
export const getSigningUrl = (recipient: DocumensoRecipient): string => {
return recipient.signingUrl;
};