test(documenso): real-API E2E spec + 2.x response normalization
The documenso-template pathway was returning 201 with documensoId=null because Documenso 2.x renamed `id` → `documentId` and recipient `id` → `recipientId` in its API responses. Our DocumensoDocument interface still expected the legacy v1.13 shape, so destructuring silently yielded undefined and the documents row got NULL'd. - Add normalizeDocument() in documenso-client that reads either field name and surfaces the legacy `id` form downstream consumers expect - Apply normalization at every callsite that returns DocumensoDocument (createDocument, generateDocumentFromTemplate, sendDocument, getDocument) - New realapi Playwright project (opt-in: --project=realapi) targeting tests/e2e/realapi/, with 2-min timeout for real-network calls - New spec: documenso-real-api.spec.ts seeds client/yacht/berth/interest via the v1 API, fires generate-and-sign through the documenso-template pathway, asserts the response carries a documensoId, then GETs the document directly from Documenso to confirm it exists with PENDING status and recipients populated Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -23,6 +23,27 @@ async function documensoFetch(path: string, options?: RequestInit): Promise<unkn
|
||||
return res.json();
|
||||
}
|
||||
|
||||
// Documenso 2.x renamed top-level `id` → `documentId` and recipient `id` →
|
||||
// `recipientId`; v1.13 still uses `id`. Normalize both shapes to the legacy
|
||||
// `id` form that this codebase consumes everywhere downstream.
|
||||
function normalizeDocument(raw: unknown): DocumensoDocument {
|
||||
const r = (raw ?? {}) as Record<string, unknown>;
|
||||
const id = String(r.documentId ?? r.id ?? '');
|
||||
const status = String(r.status ?? 'PENDING');
|
||||
const recipientsRaw = (r.recipients as Array<Record<string, unknown>> | undefined) ?? [];
|
||||
const recipients = recipientsRaw.map((rec) => ({
|
||||
id: String(rec.recipientId ?? rec.id ?? ''),
|
||||
name: String(rec.name ?? ''),
|
||||
email: String(rec.email ?? ''),
|
||||
role: String(rec.role ?? ''),
|
||||
signingOrder: Number(rec.signingOrder ?? 0),
|
||||
status: String(rec.signingStatus ?? rec.status ?? 'PENDING'),
|
||||
signingUrl: typeof rec.signingUrl === 'string' ? rec.signingUrl : undefined,
|
||||
embeddedUrl: typeof rec.embeddedUrl === 'string' ? rec.embeddedUrl : undefined,
|
||||
}));
|
||||
return { id, status, recipients };
|
||||
}
|
||||
|
||||
export interface DocumensoRecipient {
|
||||
name: string;
|
||||
email: string;
|
||||
@@ -53,7 +74,7 @@ export async function createDocument(
|
||||
return documensoFetch('/api/v1/documents', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({ title, document: pdfBase64, recipients }),
|
||||
}) as Promise<DocumensoDocument>;
|
||||
}).then(normalizeDocument);
|
||||
}
|
||||
|
||||
export async function generateDocumentFromTemplate(
|
||||
@@ -63,17 +84,17 @@ export async function generateDocumentFromTemplate(
|
||||
return documensoFetch(`/api/v1/templates/${templateId}/generate-document`, {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(payload),
|
||||
}) as Promise<DocumensoDocument>;
|
||||
}).then(normalizeDocument);
|
||||
}
|
||||
|
||||
export async function sendDocument(docId: string): Promise<DocumensoDocument> {
|
||||
return documensoFetch(`/api/v1/documents/${docId}/send`, {
|
||||
method: 'POST',
|
||||
}) as Promise<DocumensoDocument>;
|
||||
}).then(normalizeDocument);
|
||||
}
|
||||
|
||||
export async function getDocument(docId: string): Promise<DocumensoDocument> {
|
||||
return documensoFetch(`/api/v1/documents/${docId}`) as Promise<DocumensoDocument>;
|
||||
return documensoFetch(`/api/v1/documents/${docId}`).then(normalizeDocument);
|
||||
}
|
||||
|
||||
export async function sendReminder(docId: string, signerId: string): Promise<void> {
|
||||
|
||||
Reference in New Issue
Block a user