instasign 1.1.3 → 1.1.4

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { AxiosInstance } from 'axios';
-import { WebhookEventType, WebhookPayloadMap } from './webhook.types.js';
 
 /**
  * This file was auto-generated by openapi-typescript.
@@ -45,11 +44,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                requestId: string;
-                                signUrl: string;
-                                envelopeSignUrl?: string;
-                            };
+                            result: components["schemas"]["EnvelopeAddSignRequestResult"];
                         };
                     };
                 };
@@ -93,10 +88,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                success: boolean;
-                                message: string;
-                            };
+                            result: components["schemas"]["EnvelopeCompleteResult"];
                         };
                     };
                 };
@@ -147,9 +139,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                envelopeId: string;
-                            };
+                            result: components["schemas"]["EnvelopeCreateResult"];
                         };
                     };
                 };
@@ -193,9 +183,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                success: boolean;
-                            };
+                            result: components["schemas"]["EnvelopeDeleteResult"];
                         };
                     };
                 };
@@ -240,34 +228,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                envelopeId: string;
-                                name: string;
-                                description?: string;
-                                /** @enum {string} */
-                                status: "pending" | "in-progress" | "completed" | "cancelled";
-                                clientReferenceId?: string;
-                                signRequestsCount: number;
-                                signRequests: {
-                                    requestId: string;
-                                    /** @enum {string} */
-                                    status: "pending" | "completed" | "canceled" | "queued";
-                                    fileName: string;
-                                    fileUrl: string;
-                                    signedFileUrl?: string;
-                                    metadata: {
-                                        [key: string]: unknown;
-                                    };
-                                    clientReferenceId?: string;
-                                }[];
-                                /** Format: date-time */
-                                createdAt: string;
-                                /** Format: date-time */
-                                updatedAt: string;
-                                /** Format: date-time */
-                                expirationDate?: string;
-                                signUrl?: string;
-                            };
+                            result: components["schemas"]["EnvelopeGetResult"];
                         };
                     };
                 };
@@ -324,34 +285,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                envelopeId: string;
-                                name: string;
-                                description?: string;
-                                /** @enum {string} */
-                                status: "pending" | "in-progress" | "completed" | "cancelled";
-                                clientReferenceId?: string;
-                                signRequestsCount: number;
-                                signRequests: {
-                                    requestId: string;
-                                    /** @enum {string} */
-                                    status: "pending" | "completed" | "canceled" | "queued";
-                                    fileName: string;
-                                    fileUrl: string;
-                                    signedFileUrl?: string;
-                                    metadata: {
-                                        [key: string]: unknown;
-                                    };
-                                    clientReferenceId?: string;
-                                }[];
-                                /** Format: date-time */
-                                createdAt: string;
-                                /** Format: date-time */
-                                updatedAt: string;
-                                /** Format: date-time */
-                                expirationDate?: string;
-                                signUrl?: string;
-                            }[];
+                            result: components["schemas"]["EnvelopeListResult"][];
                         };
                     };
                 };
@@ -396,10 +330,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                success: boolean;
-                                message: string;
-                            };
+                            result: components["schemas"]["EnvelopeRemoveSignRequestResult"];
                         };
                     };
                 };
@@ -446,12 +377,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                envelopeId: string;
-                                metadata: {
-                                    [key: string]: unknown;
-                                };
-                            };
+                            result: components["schemas"]["EnvelopeUpdateMetadataResult"];
                         };
                     };
                 };
@@ -496,9 +422,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                signedFileUrl: string;
-                            };
+                            result: components["schemas"]["SignRequestCompleteResult"];
                         };
                     };
                 };
@@ -550,10 +474,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                requestId: string;
-                                signUrl: string;
-                            };
+                            result: components["schemas"]["SignRequestCreateResult"];
                         };
                     };
                 };
@@ -597,22 +518,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                requestId: string;
-                                /** @enum {string} */
-                                status: "pending" | "completed" | "canceled" | "queued";
-                                fileName: string;
-                                originalFile: string;
-                                signedFile?: string;
-                                metadata?: {
-                                    [key: string]: unknown;
-                                };
-                                clientReferenceId?: string;
-                                /** Format: date-time */
-                                createdAt: string;
-                                /** Format: date-time */
-                                updatedAt: string;
-                            };
+                            result: components["schemas"]["SignRequestGetResult"];
                         };
                     };
                 };
@@ -659,12 +565,7 @@ interface paths {
                     };
                     content: {
                         "application/json": {
-                            result: {
-                                requestId: string;
-                                metadata: {
-                                    [key: string]: unknown;
-                                };
-                            };
+                            result: components["schemas"]["SignRequestUpdateMetadataResult"];
                         };
                     };
                 };
@@ -679,7 +580,118 @@ interface paths {
 }
 type webhooks = Record<string, never>;
 interface components {
-    schemas: never;
+    schemas: {
+        EnvelopeAddSignRequestResult: {
+            requestId: string;
+            signUrl: string;
+            envelopeSignUrl?: string;
+        };
+        EnvelopeCompleteResult: {
+            success: boolean;
+            message: string;
+        };
+        EnvelopeCreateResult: {
+            envelopeId: string;
+        };
+        EnvelopeDeleteResult: {
+            success: boolean;
+        };
+        EnvelopeGetResult: {
+            envelopeId: string;
+            name: string;
+            description?: string;
+            /** @enum {string} */
+            status: "pending" | "in-progress" | "completed" | "cancelled";
+            clientReferenceId?: string;
+            signRequestsCount: number;
+            signRequests: {
+                requestId: string;
+                /** @enum {string} */
+                status: "pending" | "completed" | "canceled" | "queued";
+                fileName: string;
+                fileUrl: string;
+                signedFileUrl?: string;
+                metadata: {
+                    [key: string]: unknown;
+                };
+                clientReferenceId?: string;
+            }[];
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+            /** Format: date-time */
+            expirationDate?: string;
+            signUrl?: string;
+        };
+        EnvelopeListResult: {
+            envelopeId: string;
+            name: string;
+            description?: string;
+            /** @enum {string} */
+            status: "pending" | "in-progress" | "completed" | "cancelled";
+            clientReferenceId?: string;
+            signRequestsCount: number;
+            signRequests: {
+                requestId: string;
+                /** @enum {string} */
+                status: "pending" | "completed" | "canceled" | "queued";
+                fileName: string;
+                fileUrl: string;
+                signedFileUrl?: string;
+                metadata: {
+                    [key: string]: unknown;
+                };
+                clientReferenceId?: string;
+            }[];
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+            /** Format: date-time */
+            expirationDate?: string;
+            signUrl?: string;
+        };
+        EnvelopeRemoveSignRequestResult: {
+            success: boolean;
+            message: string;
+        };
+        EnvelopeUpdateMetadataResult: {
+            envelopeId: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+        };
+        SignRequestCompleteResult: {
+            signedFileUrl: string;
+        };
+        SignRequestCreateResult: {
+            requestId: string;
+            signUrl: string;
+        };
+        SignRequestGetResult: {
+            requestId: string;
+            /** @enum {string} */
+            status: "pending" | "completed" | "canceled" | "queued";
+            fileName: string;
+            originalFile: string;
+            signedFile?: string;
+            metadata?: {
+                [key: string]: unknown;
+            };
+            clientReferenceId?: string;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+        };
+        SignRequestUpdateMetadataResult: {
+            requestId: string;
+            metadata: {
+                [key: string]: unknown;
+            };
+        };
+    };
     responses: never;
     parameters: never;
     requestBodies: never;
@@ -689,6 +701,43 @@ interface components {
 type $defs = Record<string, never>;
 type operations = Record<string, never>;
 
+declare const VALID_WEBHOOK_EVENT_TYPES: readonly ["envelope_created", "envelope_expired", "sign_request_created", "sign_request_signed", "sign_request_expired"];
+type WebhookEventType = typeof VALID_WEBHOOK_EVENT_TYPES[number];
+type WebhookStatus = 'pending' | 'success' | 'error';
+type WebhookPayloadMap = {
+    'envelope_created': {
+        envelopeId: string;
+    };
+    'envelope_expired': {
+        envelopeId: string;
+    };
+    'sign_request_created': {
+        requestId: string;
+        status: string;
+        envelopeId?: string;
+    };
+    'sign_request_signed': {
+        requestId: string;
+        status: string;
+        envelopeId?: string;
+    };
+    'sign_request_expired': {
+        requestId: string;
+    };
+};
+declare const VALID_SIGN_REQUEST_STATUSES: readonly ["pending", "completed", "canceled", "queued"];
+type SignRequestStatus = typeof VALID_SIGN_REQUEST_STATUSES[number];
+declare const VALID_ENVELOPE_STATUSES: readonly ["pending", "in-progress", "completed", "cancelled"];
+type EnvelopeStatus = typeof VALID_ENVELOPE_STATUSES[number];
+type SignRequestMetadata = Record<string, unknown>;
+type EnvelopeMetadata = Record<string, unknown>;
+declare const VALID_ORDER_BY: readonly ["updatedAt", "createdAt"];
+type OrderBy = (typeof VALID_ORDER_BY)[number];
+declare const VALID_ORDER_DIRECTION: readonly ["asc", "desc"];
+type OrderDirection = (typeof VALID_ORDER_DIRECTION)[number];
+
+/** Extract a named component schema from the OpenAPI definition */
+type SchemaResult<N extends keyof components['schemas']> = components['schemas'][N];
 interface OperationResponse {
     success?: boolean;
     message?: string;
@@ -697,27 +746,45 @@ interface OperationResponse {
 type ResponseResult<P extends keyof paths> = NonNullable<NonNullable<paths[P]['post']['responses']>[200]['content']>['application/json']['result'];
 /** Extract the request body type from a Cloud Function */
 type RequestBody<P extends keyof paths> = NonNullable<NonNullable<paths[P]['post']['requestBody']>['content']>['application/json'];
-
 /** A full envelope with its sign requests */
-type Envelope = ResponseResult<'/functions/envelope:get'>;
+interface Envelope extends SchemaResult<'EnvelopeGetResult'> {
+}
 /** Envelope as returned in a list */
-type EnvelopeListItem = ResponseResult<'/functions/envelope:list'>[number];
-type CreateEnvelopeParams = RequestBody<'/functions/envelope:create'>;
-type GetEnvelopesParams = RequestBody<'/functions/envelope:list'>;
-type UpdateEnvelopeMetadataParams = RequestBody<'/functions/envelope:update-metadata'>;
-type RemoveSignRequestFromEnvelopeParams = RequestBody<'/functions/envelope:remove-sign-request'>;
-type AddSignRequestToEnvelopeParams = RequestBody<'/functions/envelope:add-sign-request'>;
-type CreateEnvelopeResponse = ResponseResult<'/functions/envelope:create'>;
-type UpdateEnvelopeMetadataResponse = ResponseResult<'/functions/envelope:update-metadata'>;
-type AddSignRequestToEnvelopeResponse = ResponseResult<'/functions/envelope:add-sign-request'>;
-
+interface EnvelopeListItem extends SchemaResult<'EnvelopeListResult'> {
+}
+interface CreateEnvelopeParams extends RequestBody<'/functions/envelope:create'> {
+}
+interface GetEnvelopesParams extends RequestBody<'/functions/envelope:list'> {
+}
+interface UpdateEnvelopeMetadataParams extends RequestBody<'/functions/envelope:update-metadata'> {
+}
+interface RemoveSignRequestFromEnvelopeParams extends RequestBody<'/functions/envelope:remove-sign-request'> {
+}
+interface AddSignRequestToEnvelopeParams extends RequestBody<'/functions/envelope:add-sign-request'> {
+}
+interface CreateEnvelopeResponse extends ResponseResult<'/functions/envelope:create'> {
+}
+interface UpdateEnvelopeMetadataResponse extends ResponseResult<'/functions/envelope:update-metadata'> {
+}
+interface AddSignRequestToEnvelopeResponse extends ResponseResult<'/functions/envelope:add-sign-request'> {
+}
 /** A single sign request */
-type SignRequest = ResponseResult<'/functions/envelope:get'>['signRequests'][number];
-type CreateSignRequestParams = RequestBody<'/functions/sign-request:create'>;
-type CompleteSignRequestParams = RequestBody<'/functions/sign-request:complete'>;
-type CreateSignRequestResponse = ResponseResult<'/functions/sign-request:create'>;
-type CompleteSignRequestResponse = ResponseResult<'/functions/sign-request:complete'>;
-
+interface SignRequest extends SchemaResult<'SignRequestGetResult'> {
+}
+interface CreateSignRequestParams extends RequestBody<'/functions/sign-request:create'> {
+}
+interface CompleteSignRequestParams extends RequestBody<'/functions/sign-request:complete'> {
+}
+interface GetFileFromRequestIdParams extends RequestBody<'/functions/sign-request:get'> {
+}
+interface UpdateSignRequestMetadataParams extends RequestBody<'/functions/sign-request:update-metadata'> {
+}
+interface CreateSignRequestResponse extends ResponseResult<'/functions/sign-request:create'> {
+}
+interface CompleteSignRequestResponse extends ResponseResult<'/functions/sign-request:complete'> {
+}
+interface UpdateSignRequestMetadataResponse extends ResponseResult<'/functions/sign-request:update-metadata'> {
+}
 type WebhookEvent = {
     [T in WebhookEventType]: {
         eventType: T;
@@ -817,4 +884,4 @@ declare class Instasign {
     constructor(config: IInstasignConfig);
 }
 
-export { type $defs, type AddSignRequestToEnvelopeParams, type AddSignRequestToEnvelopeResponse, type CompleteSignRequestParams, type CompleteSignRequestResponse, type CreateEnvelopeParams, type CreateEnvelopeResponse, type CreateSignRequestParams, type CreateSignRequestResponse, type Envelope, type EnvelopeCreatedEvent, type EnvelopeExpiredEvent, type EnvelopeListItem, Envelopes, type GetEnvelopesParams, type IInstasignConfig, Instasign, type OperationResponse, type RemoveSignRequestFromEnvelopeParams, type RequestBody, type ResponseResult, type SignRequest, type SignRequestCreatedEvent, type SignRequestExpiredEvent, type SignRequestSignedEvent, SignRequests, type UpdateEnvelopeMetadataParams, type UpdateEnvelopeMetadataResponse, type WebhookEvent, Webhooks, type components, type operations, type paths, type webhooks };
+export { type $defs, type AddSignRequestToEnvelopeParams, type AddSignRequestToEnvelopeResponse, type CompleteSignRequestParams, type CompleteSignRequestResponse, type CreateEnvelopeParams, type CreateEnvelopeResponse, type CreateSignRequestParams, type CreateSignRequestResponse, type Envelope, type EnvelopeCreatedEvent, type EnvelopeExpiredEvent, type EnvelopeListItem, type EnvelopeMetadata, type EnvelopeStatus, Envelopes, type GetEnvelopesParams, type GetFileFromRequestIdParams, type IInstasignConfig, Instasign, type OperationResponse, type OrderBy, type OrderDirection, type RemoveSignRequestFromEnvelopeParams, type RequestBody, type ResponseResult, type SchemaResult, type SignRequest, type SignRequestCreatedEvent, type SignRequestExpiredEvent, type SignRequestMetadata, type SignRequestSignedEvent, type SignRequestStatus, SignRequests, type UpdateEnvelopeMetadataParams, type UpdateEnvelopeMetadataResponse, type UpdateSignRequestMetadataParams, type UpdateSignRequestMetadataResponse, VALID_ENVELOPE_STATUSES, VALID_ORDER_BY, VALID_ORDER_DIRECTION, VALID_SIGN_REQUEST_STATUSES, VALID_WEBHOOK_EVENT_TYPES, type WebhookEvent, type WebhookEventType, type WebhookPayloadMap, type WebhookStatus, Webhooks, type components, type operations, type paths, type webhooks };

package/dist/index.js

@@ -152,10 +152,38 @@ var Instasign = class {
     this.webhooks = new Webhooks(config.webhookTolerance ?? 300);
   }
 };
+
+// ../types/src/index.ts
+var VALID_WEBHOOK_EVENT_TYPES = [
+  "envelope_created",
+  "envelope_expired",
+  "sign_request_created",
+  "sign_request_signed",
+  "sign_request_expired"
+];
+var VALID_SIGN_REQUEST_STATUSES = [
+  "pending",
+  "completed",
+  "canceled",
+  "queued"
+];
+var VALID_ENVELOPE_STATUSES = [
+  "pending",
+  "in-progress",
+  "completed",
+  "cancelled"
+];
+var VALID_ORDER_BY = ["updatedAt", "createdAt"];
+var VALID_ORDER_DIRECTION = ["asc", "desc"];
 export {
   Envelopes,
   Instasign,
   SignRequests,
+  VALID_ENVELOPE_STATUSES,
+  VALID_ORDER_BY,
+  VALID_ORDER_DIRECTION,
+  VALID_SIGN_REQUEST_STATUSES,
+  VALID_WEBHOOK_EVENT_TYPES,
   Webhooks
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/resources/Envelopes.ts","../src/resources/SignRequests.ts","../src/resources/Webhooks.ts","../src/instasign.ts"],"sourcesContent":["import { AxiosInstance } from 'axios';\nimport {\n    Envelope,\n    type AddSignRequestToEnvelopeParams,\n    type AddSignRequestToEnvelopeResponse,\n    type CreateEnvelopeParams,\n    type CreateEnvelopeResponse,\n    type GetEnvelopesParams,\n    type OperationResponse,\n    type RemoveSignRequestFromEnvelopeParams,\n    type UpdateEnvelopeMetadataParams,\n    type UpdateEnvelopeMetadataResponse\n} from '../types.js';\n\nexport class Envelopes {\n    constructor(private client: AxiosInstance) { }\n\n    /**\n     * Create a new envelope\n     */\n    async create(params: CreateEnvelopeParams): Promise<CreateEnvelopeResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:create', params);\n        return response.data.result;\n    }\n\n    /**\n     * List envelopes\n     */\n    async list(params: GetEnvelopesParams = {}): Promise<Envelope[] | undefined> {\n        const response = await this.client.post('/functions/envelope:list', params);\n        return response.data.result;\n    }\n\n    /**\n     * Retrieve a single envelope with its sign requests\n     */\n    async get(envelopeId: string): Promise<Envelope | undefined> {\n        const response = await this.client.post('/functions/envelope:get', { envelopeId });\n        return response.data.result;\n    }\n\n    /**\n     * Complete an envelope\n     */\n    async complete(envelopeId: string): Promise<OperationResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:complete', { envelopeId });\n        return response.data.result;\n    }\n\n    /**\n     * Delete an envelope\n     */\n    async delete(envelopeId: string): Promise<OperationResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:delete', { envelopeId });\n        return response.data.result;\n    }\n\n    /**\n     * Update envelope metadata\n     */\n    async updateMetadata(params: UpdateEnvelopeMetadataParams): Promise<UpdateEnvelopeMetadataResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:update-metadata', params);\n        return response.data.result;\n    }\n\n    /**\n     * Remove a sign request from an envelope\n     */\n    async removeSignRequest(params: RemoveSignRequestFromEnvelopeParams): Promise<OperationResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:remove-sign-request', params);\n        return response.data.result;\n    }\n\n    /**\n     * Add a sign request to an envelope\n     */\n    async addSignRequest(params: AddSignRequestToEnvelopeParams): Promise<AddSignRequestToEnvelopeResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:add-sign-request', params);\n        return response.data.result;\n    }\n\n    /**\n     * Add multiple sign requests to an envelope\n     */\n    // async addSignRequests(params: AddSignRequestToEnvelopeParams[]): Promise<AddSignRequestToEnvelopeResponse[] | undefined> {\n    //     // TODO(ciro): must be implemented on back-end\n    //     const response = await this.client.post('/functions/addMultipleSignRequestsToEnvelope', params);\n    //     return response.data.result;\n    // }\n}","import { AxiosInstance } from 'axios';\nimport {\n    type CreateSignRequestParams,\n    type CreateSignRequestResponse,\n    type CompleteSignRequestParams,\n    type CompleteSignRequestResponse,\n    type SignRequest,\n} from '../types.js';\n\nexport class SignRequests {\n    constructor(private client: AxiosInstance) { }\n\n    /**\n     * Create a new sign request\n     */\n    async create(params: CreateSignRequestParams): Promise<CreateSignRequestResponse | undefined> {\n        const response = await this.client.post('/functions/sign-request:create', params);\n        return response.data.result;\n    }\n\n    /**\n     * Complete a sign request\n     */\n    async complete(params: CompleteSignRequestParams): Promise<CompleteSignRequestResponse | undefined> {\n        const response = await this.client.post('/functions/sign-request:complete', params);\n        return response.data.result;\n    }\n\n    /**\n     * Get the file associated with a sign request\n     */\n    async get(requestId: string): Promise<SignRequest | undefined> {\n        const response = await this.client.post('/functions/sign-request:get', { requestId });\n        return response.data.result;\n    }\n}","import * as crypto from 'node:crypto';\nimport { WebhookEvent } from '../types';\n\nexport class Webhooks {\n    constructor(private tolerance: number = 300) { }\n\n    /**\n     * Verify and parse a webhook event\n     */\n    public constructEvent(payload: string, signatureHeader: string, webhookSecret: string): WebhookEvent {\n        const parts = signatureHeader.split(',');\n        const timestamp = parts.find((p) => p.startsWith('t='))?.split('=')[1];\n        const signature = parts.find((p) => p.startsWith('v1='))?.split('=')[1];\n\n        if (!timestamp || !signature) {\n            throw new Error('Invalid signature header');\n        }\n\n        const now = Math.floor(Date.now() / 1000);\n        if (Math.abs(now - parseInt(timestamp)) > this.tolerance) {\n            throw new Error('Signature too old');\n        }\n\n        const signedPayload = `${timestamp}.${payload}`;\n        const expectedSignature = crypto\n            .createHmac('sha256', webhookSecret)\n            .update(signedPayload)\n            .digest('hex');\n\n        const isValid = crypto.timingSafeEqual(\n            Buffer.from(signature),\n            Buffer.from(expectedSignature)\n        );\n\n        if (!isValid) {\n            throw new Error('Invalid signature');\n        }\n\n        return JSON.parse(payload) as WebhookEvent;\n    }\n}\n","import axios, { AxiosInstance } from 'axios';\nimport { Envelopes } from './resources/Envelopes.js';\nimport { SignRequests } from './resources/SignRequests.js';\nimport { Webhooks } from './resources/Webhooks.js';\n\nexport interface IInstasignConfig {\n    /// Required Instasign API key\n    apiKey: string;\n\n    /// Optional Parse Server config\n    appId?: string;\n    restApiKey?: string;\n    serverUrl?: string;\n    /// Optional webhook signature tolerance in seconds (default 300)\n    webhookTolerance?: number;\n}\n\nexport class Instasign {\n    private client: AxiosInstance;\n\n    public readonly envelopes: Envelopes;\n    public readonly signRequests: SignRequests;\n    public readonly webhooks: Webhooks;\n\n    constructor(config: IInstasignConfig) {\n        this.client = axios.create({\n            baseURL: config.serverUrl,\n            headers: {\n                'X-Parse-APPLICATION-ID': config.appId,\n                'X-Parse-REST-API-KEY': config.restApiKey,\n                'x-api-key': config.apiKey,\n                'Content-Type': 'application/json',\n            },\n        });\n\n        this.envelopes = new Envelopes(this.client);\n        this.signRequests = new SignRequests(this.client);\n        this.webhooks = new Webhooks(config.webhookTolerance ?? 300);\n    }\n}\n\n"],"mappings":";AAcO,IAAM,YAAN,MAAgB;AAAA,EACnB,YAAoB,QAAuB;AAAvB;AAAA,EAAyB;AAAA;AAAA;AAAA;AAAA,EAK7C,MAAM,OAAO,QAA2E;AACpF,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,8BAA8B,MAAM;AAC5E,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,SAA6B,CAAC,GAAoC;AACzE,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,4BAA4B,MAAM;AAC1E,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,IAAI,YAAmD;AACzD,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,2BAA2B,EAAE,WAAW,CAAC;AACjF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,SAAS,YAA4D;AACvE,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,gCAAgC,EAAE,WAAW,CAAC;AACtF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAO,YAA4D;AACrE,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,8BAA8B,EAAE,WAAW,CAAC;AACpF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,eAAe,QAA2F;AAC5G,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,uCAAuC,MAAM;AACrF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,kBAAkB,QAAqF;AACzG,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,2CAA2C,MAAM;AACzF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,eAAe,QAA+F;AAChH,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,wCAAwC,MAAM;AACtF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUJ;;;AChFO,IAAM,eAAN,MAAmB;AAAA,EACtB,YAAoB,QAAuB;AAAvB;AAAA,EAAyB;AAAA;AAAA;AAAA;AAAA,EAK7C,MAAM,OAAO,QAAiF;AAC1F,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,kCAAkC,MAAM;AAChF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,SAAS,QAAqF;AAChG,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,oCAAoC,MAAM;AAClF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,IAAI,WAAqD;AAC3D,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,+BAA+B,EAAE,UAAU,CAAC;AACpF,WAAO,SAAS,KAAK;AAAA,EACzB;AACJ;;;ACnCA,YAAY,YAAY;AAGjB,IAAM,WAAN,MAAe;AAAA,EAClB,YAAoB,YAAoB,KAAK;AAAzB;AAAA,EAA2B;AAAA;AAAA;AAAA;AAAA,EAKxC,eAAe,SAAiB,iBAAyB,eAAqC;AACjG,UAAM,QAAQ,gBAAgB,MAAM,GAAG;AACvC,UAAM,YAAY,MAAM,KAAK,CAAC,MAAM,EAAE,WAAW,IAAI,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC;AACrE,UAAM,YAAY,MAAM,KAAK,CAAC,MAAM,EAAE,WAAW,KAAK,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC;AAEtE,QAAI,CAAC,aAAa,CAAC,WAAW;AAC1B,YAAM,IAAI,MAAM,0BAA0B;AAAA,IAC9C;AAEA,UAAM,MAAM,KAAK,MAAM,KAAK,IAAI,IAAI,GAAI;AACxC,QAAI,KAAK,IAAI,MAAM,SAAS,SAAS,CAAC,IAAI,KAAK,WAAW;AACtD,YAAM,IAAI,MAAM,mBAAmB;AAAA,IACvC;AAEA,UAAM,gBAAgB,GAAG,SAAS,IAAI,OAAO;AAC7C,UAAM,oBACD,kBAAW,UAAU,aAAa,EAClC,OAAO,aAAa,EACpB,OAAO,KAAK;AAEjB,UAAM,UAAiB;AAAA,MACnB,OAAO,KAAK,SAAS;AAAA,MACrB,OAAO,KAAK,iBAAiB;AAAA,IACjC;AAEA,QAAI,CAAC,SAAS;AACV,YAAM,IAAI,MAAM,mBAAmB;AAAA,IACvC;AAEA,WAAO,KAAK,MAAM,OAAO;AAAA,EAC7B;AACJ;;;ACxCA,OAAO,WAA8B;AAiB9B,IAAM,YAAN,MAAgB;AAAA,EACX;AAAA,EAEQ;AAAA,EACA;AAAA,EACA;AAAA,EAEhB,YAAY,QAA0B;AAClC,SAAK,SAAS,MAAM,OAAO;AAAA,MACvB,SAAS,OAAO;AAAA,MAChB,SAAS;AAAA,QACL,0BAA0B,OAAO;AAAA,QACjC,wBAAwB,OAAO;AAAA,QAC/B,aAAa,OAAO;AAAA,QACpB,gBAAgB;AAAA,MACpB;AAAA,IACJ,CAAC;AAED,SAAK,YAAY,IAAI,UAAU,KAAK,MAAM;AAC1C,SAAK,eAAe,IAAI,aAAa,KAAK,MAAM;AAChD,SAAK,WAAW,IAAI,SAAS,OAAO,oBAAoB,GAAG;AAAA,EAC/D;AACJ;","names":[]}
+{"version":3,"sources":["../src/resources/Envelopes.ts","../src/resources/SignRequests.ts","../src/resources/Webhooks.ts","../src/instasign.ts","../../types/src/index.ts"],"sourcesContent":["import { AxiosInstance } from 'axios';\nimport {\n    Envelope,\n    type AddSignRequestToEnvelopeParams,\n    type AddSignRequestToEnvelopeResponse,\n    type CreateEnvelopeParams,\n    type CreateEnvelopeResponse,\n    type GetEnvelopesParams,\n    type OperationResponse,\n    type RemoveSignRequestFromEnvelopeParams,\n    type UpdateEnvelopeMetadataParams,\n    type UpdateEnvelopeMetadataResponse\n} from '../types.js';\n\nexport class Envelopes {\n    constructor(private client: AxiosInstance) { }\n\n    /**\n     * Create a new envelope\n     */\n    async create(params: CreateEnvelopeParams): Promise<CreateEnvelopeResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:create', params);\n        return response.data.result;\n    }\n\n    /**\n     * List envelopes\n     */\n    async list(params: GetEnvelopesParams = {}): Promise<Envelope[] | undefined> {\n        const response = await this.client.post('/functions/envelope:list', params);\n        return response.data.result;\n    }\n\n    /**\n     * Retrieve a single envelope with its sign requests\n     */\n    async get(envelopeId: string): Promise<Envelope | undefined> {\n        const response = await this.client.post('/functions/envelope:get', { envelopeId });\n        return response.data.result;\n    }\n\n    /**\n     * Complete an envelope\n     */\n    async complete(envelopeId: string): Promise<OperationResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:complete', { envelopeId });\n        return response.data.result;\n    }\n\n    /**\n     * Delete an envelope\n     */\n    async delete(envelopeId: string): Promise<OperationResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:delete', { envelopeId });\n        return response.data.result;\n    }\n\n    /**\n     * Update envelope metadata\n     */\n    async updateMetadata(params: UpdateEnvelopeMetadataParams): Promise<UpdateEnvelopeMetadataResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:update-metadata', params);\n        return response.data.result;\n    }\n\n    /**\n     * Remove a sign request from an envelope\n     */\n    async removeSignRequest(params: RemoveSignRequestFromEnvelopeParams): Promise<OperationResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:remove-sign-request', params);\n        return response.data.result;\n    }\n\n    /**\n     * Add a sign request to an envelope\n     */\n    async addSignRequest(params: AddSignRequestToEnvelopeParams): Promise<AddSignRequestToEnvelopeResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:add-sign-request', params);\n        return response.data.result;\n    }\n\n    /**\n     * Add multiple sign requests to an envelope\n     */\n    // async addSignRequests(params: AddSignRequestToEnvelopeParams[]): Promise<AddSignRequestToEnvelopeResponse[] | undefined> {\n    //     // TODO(ciro): must be implemented on back-end\n    //     const response = await this.client.post('/functions/addMultipleSignRequestsToEnvelope', params);\n    //     return response.data.result;\n    // }\n}","import { AxiosInstance } from 'axios';\nimport {\n    type CreateSignRequestParams,\n    type CreateSignRequestResponse,\n    type CompleteSignRequestParams,\n    type CompleteSignRequestResponse,\n    type SignRequest,\n} from '../types.js';\n\nexport class SignRequests {\n    constructor(private client: AxiosInstance) { }\n\n    /**\n     * Create a new sign request\n     */\n    async create(params: CreateSignRequestParams): Promise<CreateSignRequestResponse | undefined> {\n        const response = await this.client.post('/functions/sign-request:create', params);\n        return response.data.result;\n    }\n\n    /**\n     * Complete a sign request\n     */\n    async complete(params: CompleteSignRequestParams): Promise<CompleteSignRequestResponse | undefined> {\n        const response = await this.client.post('/functions/sign-request:complete', params);\n        return response.data.result;\n    }\n\n    /**\n     * Get the file associated with a sign request\n     */\n    async get(requestId: string): Promise<SignRequest | undefined> {\n        const response = await this.client.post('/functions/sign-request:get', { requestId });\n        return response.data.result;\n    }\n}","import * as crypto from 'node:crypto';\nimport { WebhookEvent } from '../types.js';\n\nexport class Webhooks {\n    constructor(private tolerance: number = 300) { }\n\n    /**\n     * Verify and parse a webhook event\n     */\n    public constructEvent(payload: string, signatureHeader: string, webhookSecret: string): WebhookEvent {\n        const parts = signatureHeader.split(',');\n        const timestamp = parts.find((p) => p.startsWith('t='))?.split('=')[1];\n        const signature = parts.find((p) => p.startsWith('v1='))?.split('=')[1];\n\n        if (!timestamp || !signature) {\n            throw new Error('Invalid signature header');\n        }\n\n        const now = Math.floor(Date.now() / 1000);\n        if (Math.abs(now - parseInt(timestamp)) > this.tolerance) {\n            throw new Error('Signature too old');\n        }\n\n        const signedPayload = `${timestamp}.${payload}`;\n        const expectedSignature = crypto\n            .createHmac('sha256', webhookSecret)\n            .update(signedPayload)\n            .digest('hex');\n\n        const isValid = crypto.timingSafeEqual(\n            Buffer.from(signature),\n            Buffer.from(expectedSignature)\n        );\n\n        if (!isValid) {\n            throw new Error('Invalid signature');\n        }\n\n        return JSON.parse(payload) as WebhookEvent;\n    }\n}\n","import axios, { AxiosInstance } from 'axios';\nimport { Envelopes } from './resources/Envelopes.js';\nimport { SignRequests } from './resources/SignRequests.js';\nimport { Webhooks } from './resources/Webhooks.js';\n\nexport interface IInstasignConfig {\n    /// Required Instasign API key\n    apiKey: string;\n\n    /// Optional Parse Server config\n    appId?: string;\n    restApiKey?: string;\n    serverUrl?: string;\n    /// Optional webhook signature tolerance in seconds (default 300)\n    webhookTolerance?: number;\n}\n\nexport class Instasign {\n    private client: AxiosInstance;\n\n    public readonly envelopes: Envelopes;\n    public readonly signRequests: SignRequests;\n    public readonly webhooks: Webhooks;\n\n    constructor(config: IInstasignConfig) {\n        this.client = axios.create({\n            baseURL: config.serverUrl,\n            headers: {\n                'X-Parse-APPLICATION-ID': config.appId,\n                'X-Parse-REST-API-KEY': config.restApiKey,\n                'x-api-key': config.apiKey,\n                'Content-Type': 'application/json',\n            },\n        });\n\n        this.envelopes = new Envelopes(this.client);\n        this.signRequests = new SignRequests(this.client);\n        this.webhooks = new Webhooks(config.webhookTolerance ?? 300);\n    }\n}\n\n","export const VALID_WEBHOOK_EVENT_TYPES = [\n    'envelope_created',\n    'envelope_expired',\n    'sign_request_created',\n    'sign_request_signed',\n    'sign_request_expired',\n] as const;\n\nexport type WebhookEventType = typeof VALID_WEBHOOK_EVENT_TYPES[number];\n\nexport type WebhookStatus = 'pending' | 'success' | 'error';\n\nexport type WebhookPayloadMap = {\n    'envelope_created': { envelopeId: string };\n    'envelope_expired': { envelopeId: string };\n    'sign_request_created': { requestId: string; status: string; envelopeId?: string };\n    'sign_request_signed': { requestId: string; status: string; envelopeId?: string };\n    'sign_request_expired': { requestId: string };\n};\n\nexport const VALID_SIGN_REQUEST_STATUSES = [\n    'pending',\n    'completed',\n    'canceled',\n    'queued',\n] as const;\n\nexport type SignRequestStatus = typeof VALID_SIGN_REQUEST_STATUSES[number];\n\nexport const VALID_ENVELOPE_STATUSES = [\n    'pending',\n    'in-progress',\n    'completed',\n    'cancelled',\n] as const;\n\nexport type EnvelopeStatus = typeof VALID_ENVELOPE_STATUSES[number];\n\nexport type SignRequestMetadata = Record<string, unknown>;\nexport type EnvelopeMetadata = Record<string, unknown>;\n\nexport const VALID_ORDER_BY = ['updatedAt', 'createdAt'] as const;\nexport type OrderBy = (typeof VALID_ORDER_BY)[number];\n\nexport const VALID_ORDER_DIRECTION = ['asc', 'desc'] as const;\nexport type OrderDirection = (typeof VALID_ORDER_DIRECTION)[number];\n"],"mappings":";AAcO,IAAM,YAAN,MAAgB;AAAA,EACnB,YAAoB,QAAuB;AAAvB;AAAA,EAAyB;AAAA;AAAA;AAAA;AAAA,EAK7C,MAAM,OAAO,QAA2E;AACpF,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,8BAA8B,MAAM;AAC5E,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,SAA6B,CAAC,GAAoC;AACzE,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,4BAA4B,MAAM;AAC1E,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,IAAI,YAAmD;AACzD,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,2BAA2B,EAAE,WAAW,CAAC;AACjF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,SAAS,YAA4D;AACvE,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,gCAAgC,EAAE,WAAW,CAAC;AACtF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAO,YAA4D;AACrE,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,8BAA8B,EAAE,WAAW,CAAC;AACpF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,eAAe,QAA2F;AAC5G,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,uCAAuC,MAAM;AACrF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,kBAAkB,QAAqF;AACzG,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,2CAA2C,MAAM;AACzF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,eAAe,QAA+F;AAChH,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,wCAAwC,MAAM;AACtF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUJ;;;AChFO,IAAM,eAAN,MAAmB;AAAA,EACtB,YAAoB,QAAuB;AAAvB;AAAA,EAAyB;AAAA;AAAA;AAAA;AAAA,EAK7C,MAAM,OAAO,QAAiF;AAC1F,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,kCAAkC,MAAM;AAChF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,SAAS,QAAqF;AAChG,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,oCAAoC,MAAM;AAClF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,IAAI,WAAqD;AAC3D,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,+BAA+B,EAAE,UAAU,CAAC;AACpF,WAAO,SAAS,KAAK;AAAA,EACzB;AACJ;;;ACnCA,YAAY,YAAY;AAGjB,IAAM,WAAN,MAAe;AAAA,EAClB,YAAoB,YAAoB,KAAK;AAAzB;AAAA,EAA2B;AAAA;AAAA;AAAA;AAAA,EAKxC,eAAe,SAAiB,iBAAyB,eAAqC;AACjG,UAAM,QAAQ,gBAAgB,MAAM,GAAG;AACvC,UAAM,YAAY,MAAM,KAAK,CAAC,MAAM,EAAE,WAAW,IAAI,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC;AACrE,UAAM,YAAY,MAAM,KAAK,CAAC,MAAM,EAAE,WAAW,KAAK,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC;AAEtE,QAAI,CAAC,aAAa,CAAC,WAAW;AAC1B,YAAM,IAAI,MAAM,0BAA0B;AAAA,IAC9C;AAEA,UAAM,MAAM,KAAK,MAAM,KAAK,IAAI,IAAI,GAAI;AACxC,QAAI,KAAK,IAAI,MAAM,SAAS,SAAS,CAAC,IAAI,KAAK,WAAW;AACtD,YAAM,IAAI,MAAM,mBAAmB;AAAA,IACvC;AAEA,UAAM,gBAAgB,GAAG,SAAS,IAAI,OAAO;AAC7C,UAAM,oBACD,kBAAW,UAAU,aAAa,EAClC,OAAO,aAAa,EACpB,OAAO,KAAK;AAEjB,UAAM,UAAiB;AAAA,MACnB,OAAO,KAAK,SAAS;AAAA,MACrB,OAAO,KAAK,iBAAiB;AAAA,IACjC;AAEA,QAAI,CAAC,SAAS;AACV,YAAM,IAAI,MAAM,mBAAmB;AAAA,IACvC;AAEA,WAAO,KAAK,MAAM,OAAO;AAAA,EAC7B;AACJ;;;ACxCA,OAAO,WAA8B;AAiB9B,IAAM,YAAN,MAAgB;AAAA,EACX;AAAA,EAEQ;AAAA,EACA;AAAA,EACA;AAAA,EAEhB,YAAY,QAA0B;AAClC,SAAK,SAAS,MAAM,OAAO;AAAA,MACvB,SAAS,OAAO;AAAA,MAChB,SAAS;AAAA,QACL,0BAA0B,OAAO;AAAA,QACjC,wBAAwB,OAAO;AAAA,QAC/B,aAAa,OAAO;AAAA,QACpB,gBAAgB;AAAA,MACpB;AAAA,IACJ,CAAC;AAED,SAAK,YAAY,IAAI,UAAU,KAAK,MAAM;AAC1C,SAAK,eAAe,IAAI,aAAa,KAAK,MAAM;AAChD,SAAK,WAAW,IAAI,SAAS,OAAO,oBAAoB,GAAG;AAAA,EAC/D;AACJ;;;ACvCO,IAAM,4BAA4B;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAcO,IAAM,8BAA8B;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAIO,IAAM,0BAA0B;AAAA,EACnC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAOO,IAAM,iBAAiB,CAAC,aAAa,WAAW;AAGhD,IAAM,wBAAwB,CAAC,OAAO,MAAM;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instasign",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Instasign API wrapper",
   "type": "module",
   "main": "./dist/index.cjs",