Files
esign/packages/lib/utils/envelope-download.ts
zeekay d3e091aa97 Serve and call every route under /v1
The resource API is /v1/rest and the operation API is /v1/rpc: named
for what they are, so neither shadows the other, and the v2-beta alias
is gone. Hanzo IAM returns to /auth/callback, the callback path IAM
already derives for this host, so sign-in needs no IAM change.

Claude-Session: https://claude.ai/code/session_01TUxvfuta1Z44KVNYuAz71F
2026-09-24 14:52:07 -07:00

90 lines
2.9 KiB
TypeScript

import type { EnvelopeItem } from '@prisma/client';
import type { DocumentDataVersion } from '@hanzo/esign-lib/types/document';
import { NEXT_PUBLIC_WEBAPP_URL } from '../constants/app';
export type EnvelopeItemPdfUrlOptions =
| {
type: 'download';
envelopeItem: Pick<EnvelopeItem, 'id' | 'envelopeId'>;
token: string | undefined;
version: 'original' | 'signed';
presignToken?: undefined;
}
| {
type: 'view';
envelopeItem: Pick<EnvelopeItem, 'id' | 'envelopeId'>;
token: string | undefined;
presignToken?: string | undefined;
};
export const getEnvelopeItemPdfUrl = (options: EnvelopeItemPdfUrlOptions) => {
const { envelopeItem, token, type, presignToken } = options;
const { id, envelopeId } = envelopeItem;
if (type === 'download') {
const version = options.version;
return token
? `${NEXT_PUBLIC_WEBAPP_URL()}/v1/files/token/${token}/envelopeItem/${id}/download/${version}${presignToken ? `?presignToken=${presignToken}` : ''}`
: `${NEXT_PUBLIC_WEBAPP_URL()}/v1/files/envelope/${envelopeId}/envelopeItem/${id}/download/${version}`;
}
return token
? `${NEXT_PUBLIC_WEBAPP_URL()}/v1/files/token/${token}/envelopeItem/${id}${presignToken ? `?presignToken=${presignToken}` : ''}`
: `${NEXT_PUBLIC_WEBAPP_URL()}/v1/files/envelope/${envelopeId}/envelopeItem/${id}${presignToken ? `?token=${presignToken}` : ''}`;
};
export type DocumentDataUrlOptions = {
envelopeId: string;
envelopeItemId: string;
documentDataId: string;
token: string | undefined;
presignToken?: string | undefined;
version: DocumentDataVersion;
};
/**
* The difference between this and `getEnvelopeItemPdfUrl` is that this will
* hard cache since we add the `documentDataId` to the URL.
*
* Since `documentDataId` should change when the document is changed/signed, this is a
* good way to cache an envelope item by.
*/
export const getDocumentDataUrl = (options: DocumentDataUrlOptions) => {
const { envelopeId, envelopeItemId, documentDataId, token, presignToken, version } = options;
const partialUrl = `envelope/${envelopeId}/envelopeItem/${envelopeItemId}/dataId/${documentDataId}/${version}/item.pdf`;
// Recipient token endpoint.
if (token) {
return `${NEXT_PUBLIC_WEBAPP_URL()}/v1/files/token/${token}/${partialUrl}`;
}
// Endpoint authenticated by session or presigned token.
const baseUrl = `${NEXT_PUBLIC_WEBAPP_URL()}/v1/files/${partialUrl}`;
if (presignToken) {
return `${baseUrl}?presignToken=${presignToken}`;
}
return baseUrl;
};
/**
* Gets a PDF url for the PDF viewer.
*
* Returns `null` if invalid.
*/
export const getDocumentDataUrlForPdfViewer = (options: DocumentDataUrlOptions): string | null => {
const { envelopeId, envelopeItemId, documentDataId } = options;
if (!envelopeId || !envelopeItemId || !documentDataId) {
return null;
}
return getDocumentDataUrl(options);
};