instasign 1.1.7 → 1.1.8

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.1.8] - 2026-03-27
+
+### Added
+- **Type Exports**: `VALID_SIGN_REQUEST_STATUSES` now exports type `expired`
+- **Sign Requests API**: `signRequests.create()` and `envelopes.addAll()` now accepts an optional `expirationDate` parameter.
+
 ## [1.1.7] - 2026-03-26
 
 ### Added

package/dist/index.cjs

@@ -203,14 +203,15 @@ var VALID_SIGN_REQUEST_STATUSES = [
   "pending",
   "completed",
   "canceled",
-  "queued"
+  "queued",
+  "expired"
 ];
 var VALID_SIGN_REQUEST_SIGNATURE_TYPES = ["otp", "advanced", "qualified"];
 var VALID_ENVELOPE_STATUSES = [
   "pending",
   "in-progress",
   "completed",
-  "cancelled"
+  "canceled"
 ];
 var VALID_ORDER_BY = ["updatedAt", "createdAt"];
 var VALID_ORDER_DIRECTION = ["asc", "desc"];

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/resources/Envelopes.ts","../src/resources/SignRequests.ts","../src/resources/Webhooks.ts","../src/instasign.ts","../../types/src/index.ts"],"sourcesContent":["export * from './resources/Envelopes.js';\nexport * from './resources/SignRequests.js';\nexport * from './resources/Webhooks.js';\nexport * from './instasign.js';\nexport * from './types.js';\nexport * from '@instasign/types';\n\nexport type * from '../types/schema.js';","import { AxiosInstance } from 'axios';\nimport {\n    Envelope,\n    type AddSignRequestsToEnvelopeParams,\n    type AddSignRequestsToEnvelopeResponse,\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 remove(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 sign requests to an envelope\n     */\n    async addAll(params: AddSignRequestsToEnvelopeParams): Promise<AddSignRequestsToEnvelopeResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:add-sign-requests', 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    'envelope_all_requests_signed',\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    'envelope_all_requests_signed': { 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_SIGN_REQUEST_SIGNATURE_TYPES = ['otp', 'advanced', 'qualified'] as const;\n\nexport type SignatureType = typeof VALID_SIGN_REQUEST_SIGNATURE_TYPES[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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACcO,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,OAAO,QAAqF;AAC9F,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,2CAA2C,MAAM;AACzF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAO,QAAiG;AAC1G,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,yCAAyC,MAAM;AACvF,WAAO,SAAS,KAAK;AAAA,EACzB;AACJ;;;ACvEO,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,aAAwB;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,mBAAqC;AAiB9B,IAAM,YAAN,MAAgB;AAAA,EACX;AAAA,EAEQ;AAAA,EACA;AAAA,EACA;AAAA,EAEhB,YAAY,QAA0B;AAClC,SAAK,SAAS,aAAAA,QAAM,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;AAAA,EACA;AACJ;AAeO,IAAM,8BAA8B;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAIO,IAAM,qCAAqC,CAAC,OAAO,YAAY,WAAW;AAI1E,IAAM,0BAA0B;AAAA,EACnC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAOO,IAAM,iBAAiB,CAAC,aAAa,WAAW;AAGhD,IAAM,wBAAwB,CAAC,OAAO,MAAM;","names":["axios"]}
+{"version":3,"sources":["../src/index.ts","../src/resources/Envelopes.ts","../src/resources/SignRequests.ts","../src/resources/Webhooks.ts","../src/instasign.ts","../../types/src/index.ts"],"sourcesContent":["export * from './resources/Envelopes.js';\nexport * from './resources/SignRequests.js';\nexport * from './resources/Webhooks.js';\nexport * from './instasign.js';\nexport * from './types.js';\nexport * from '@instasign/types';\n\nexport type * from '../types/schema.js';","import { AxiosInstance } from 'axios';\nimport {\n    Envelope,\n    type AddSignRequestsToEnvelopeParams,\n    type AddSignRequestsToEnvelopeResponse,\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 remove(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 sign requests to an envelope\n     */\n    async addAll(params: AddSignRequestsToEnvelopeParams): Promise<AddSignRequestsToEnvelopeResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:add-sign-requests', 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    'envelope_all_requests_signed',\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    'envelope_all_requests_signed': { 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    'expired',\n] as const;\n\nexport type SignRequestStatus = typeof VALID_SIGN_REQUEST_STATUSES[number];\n\nexport const VALID_SIGN_REQUEST_SIGNATURE_TYPES = ['otp', 'advanced', 'qualified'] as const;\n\nexport type SignatureType = typeof VALID_SIGN_REQUEST_SIGNATURE_TYPES[number];\n\nexport const VALID_ENVELOPE_STATUSES = [\n    'pending',\n    'in-progress',\n    'completed',\n    'canceled',\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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACcO,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,OAAO,QAAqF;AAC9F,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,2CAA2C,MAAM;AACzF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAO,QAAiG;AAC1G,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,yCAAyC,MAAM;AACvF,WAAO,SAAS,KAAK;AAAA,EACzB;AACJ;;;ACvEO,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,aAAwB;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,mBAAqC;AAiB9B,IAAM,YAAN,MAAgB;AAAA,EACX;AAAA,EAEQ;AAAA,EACA;AAAA,EACA;AAAA,EAEhB,YAAY,QAA0B;AAClC,SAAK,SAAS,aAAAA,QAAM,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;AAAA,EACA;AACJ;AAeO,IAAM,8BAA8B;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAIO,IAAM,qCAAqC,CAAC,OAAO,YAAY,WAAW;AAI1E,IAAM,0BAA0B;AAAA,EACnC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAOO,IAAM,iBAAiB,CAAC,aAAa,WAAW;AAGhD,IAAM,wBAAwB,CAAC,OAAO,MAAM;","names":["axios"]}

package/dist/index.d.cts

@@ -687,18 +687,21 @@ interface components {
             /** @enum {string} */
             status: "pending" | "completed" | "canceled" | "queued";
             /** @enum {string} */
-            signatureType: "otp" | "advanced" | "qualified";
+            signatureType?: "otp" | "advanced" | "qualified";
             fileName: string;
-            originalFile: string;
+            originalFile?: string;
             signedFile?: string;
             metadata?: {
                 [key: string]: unknown;
             };
             clientReferenceId?: string;
             /** Format: date-time */
-            createdAt: string;
+            expirationDate?: string;
+            isExpired?: boolean;
             /** Format: date-time */
-            updatedAt: string;
+            createdAt?: string;
+            /** Format: date-time */
+            updatedAt?: string;
         };
         SignRequestUpdateMetadataResult: {
             requestId: string;
@@ -743,11 +746,11 @@ type WebhookPayloadMap = {
         requestId: string;
     };
 };
-declare const VALID_SIGN_REQUEST_STATUSES: readonly ["pending", "completed", "canceled", "queued"];
+declare const VALID_SIGN_REQUEST_STATUSES: readonly ["pending", "completed", "canceled", "queued", "expired"];
 type SignRequestStatus = typeof VALID_SIGN_REQUEST_STATUSES[number];
 declare const VALID_SIGN_REQUEST_SIGNATURE_TYPES: readonly ["otp", "advanced", "qualified"];
 type SignatureType = typeof VALID_SIGN_REQUEST_SIGNATURE_TYPES[number];
-declare const VALID_ENVELOPE_STATUSES: readonly ["pending", "in-progress", "completed", "cancelled"];
+declare const VALID_ENVELOPE_STATUSES: readonly ["pending", "in-progress", "completed", "canceled"];
 type EnvelopeStatus = typeof VALID_ENVELOPE_STATUSES[number];
 type SignRequestMetadata = Record<string, unknown>;
 type EnvelopeMetadata = Record<string, unknown>;

package/dist/index.d.ts

@@ -687,18 +687,21 @@ interface components {
             /** @enum {string} */
             status: "pending" | "completed" | "canceled" | "queued";
             /** @enum {string} */
-            signatureType: "otp" | "advanced" | "qualified";
+            signatureType?: "otp" | "advanced" | "qualified";
             fileName: string;
-            originalFile: string;
+            originalFile?: string;
             signedFile?: string;
             metadata?: {
                 [key: string]: unknown;
             };
             clientReferenceId?: string;
             /** Format: date-time */
-            createdAt: string;
+            expirationDate?: string;
+            isExpired?: boolean;
             /** Format: date-time */
-            updatedAt: string;
+            createdAt?: string;
+            /** Format: date-time */
+            updatedAt?: string;
         };
         SignRequestUpdateMetadataResult: {
             requestId: string;
@@ -743,11 +746,11 @@ type WebhookPayloadMap = {
         requestId: string;
     };
 };
-declare const VALID_SIGN_REQUEST_STATUSES: readonly ["pending", "completed", "canceled", "queued"];
+declare const VALID_SIGN_REQUEST_STATUSES: readonly ["pending", "completed", "canceled", "queued", "expired"];
 type SignRequestStatus = typeof VALID_SIGN_REQUEST_STATUSES[number];
 declare const VALID_SIGN_REQUEST_SIGNATURE_TYPES: readonly ["otp", "advanced", "qualified"];
 type SignatureType = typeof VALID_SIGN_REQUEST_SIGNATURE_TYPES[number];
-declare const VALID_ENVELOPE_STATUSES: readonly ["pending", "in-progress", "completed", "cancelled"];
+declare const VALID_ENVELOPE_STATUSES: readonly ["pending", "in-progress", "completed", "canceled"];
 type EnvelopeStatus = typeof VALID_ENVELOPE_STATUSES[number];
 type SignRequestMetadata = Record<string, unknown>;
 type EnvelopeMetadata = Record<string, unknown>;

package/dist/index.js

@@ -158,14 +158,15 @@ var VALID_SIGN_REQUEST_STATUSES = [
   "pending",
   "completed",
   "canceled",
-  "queued"
+  "queued",
+  "expired"
 ];
 var VALID_SIGN_REQUEST_SIGNATURE_TYPES = ["otp", "advanced", "qualified"];
 var VALID_ENVELOPE_STATUSES = [
   "pending",
   "in-progress",
   "completed",
-  "cancelled"
+  "canceled"
 ];
 var VALID_ORDER_BY = ["updatedAt", "createdAt"];
 var VALID_ORDER_DIRECTION = ["asc", "desc"];

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","../../types/src/index.ts"],"sourcesContent":["import { AxiosInstance } from 'axios';\nimport {\n    Envelope,\n    type AddSignRequestsToEnvelopeParams,\n    type AddSignRequestsToEnvelopeResponse,\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 remove(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 sign requests to an envelope\n     */\n    async addAll(params: AddSignRequestsToEnvelopeParams): Promise<AddSignRequestsToEnvelopeResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:add-sign-requests', 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    'envelope_all_requests_signed',\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    'envelope_all_requests_signed': { 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_SIGN_REQUEST_SIGNATURE_TYPES = ['otp', 'advanced', 'qualified'] as const;\n\nexport type SignatureType = typeof VALID_SIGN_REQUEST_SIGNATURE_TYPES[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,OAAO,QAAqF;AAC9F,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,2CAA2C,MAAM;AACzF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAO,QAAiG;AAC1G,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,yCAAyC,MAAM;AACvF,WAAO,SAAS,KAAK;AAAA,EACzB;AACJ;;;ACvEO,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;AAAA,EACA;AACJ;AAeO,IAAM,8BAA8B;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAIO,IAAM,qCAAqC,CAAC,OAAO,YAAY,WAAW;AAI1E,IAAM,0BAA0B;AAAA,EACnC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAOO,IAAM,iBAAiB,CAAC,aAAa,WAAW;AAGhD,IAAM,wBAAwB,CAAC,OAAO,MAAM;","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 AddSignRequestsToEnvelopeParams,\n    type AddSignRequestsToEnvelopeResponse,\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 remove(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 sign requests to an envelope\n     */\n    async addAll(params: AddSignRequestsToEnvelopeParams): Promise<AddSignRequestsToEnvelopeResponse | undefined> {\n        const response = await this.client.post('/functions/envelope:add-sign-requests', 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    'envelope_all_requests_signed',\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    'envelope_all_requests_signed': { 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    'expired',\n] as const;\n\nexport type SignRequestStatus = typeof VALID_SIGN_REQUEST_STATUSES[number];\n\nexport const VALID_SIGN_REQUEST_SIGNATURE_TYPES = ['otp', 'advanced', 'qualified'] as const;\n\nexport type SignatureType = typeof VALID_SIGN_REQUEST_SIGNATURE_TYPES[number];\n\nexport const VALID_ENVELOPE_STATUSES = [\n    'pending',\n    'in-progress',\n    'completed',\n    'canceled',\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,OAAO,QAAqF;AAC9F,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,2CAA2C,MAAM;AACzF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAO,QAAiG;AAC1G,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,yCAAyC,MAAM;AACvF,WAAO,SAAS,KAAK;AAAA,EACzB;AACJ;;;ACvEO,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;AAAA,EACA;AACJ;AAeO,IAAM,8BAA8B;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAIO,IAAM,qCAAqC,CAAC,OAAO,YAAY,WAAW;AAI1E,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.7",
+  "version": "1.1.8",
   "description": "Instasign API wrapper",
   "type": "module",
   "main": "./dist/index.cjs",

package/types/schema.d.ts

@@ -685,18 +685,21 @@ export interface components {
             /** @enum {string} */
             status: "pending" | "completed" | "canceled" | "queued";
             /** @enum {string} */
-            signatureType: "otp" | "advanced" | "qualified";
+            signatureType?: "otp" | "advanced" | "qualified";
             fileName: string;
-            originalFile: string;
+            originalFile?: string;
             signedFile?: string;
             metadata?: {
                 [key: string]: unknown;
             };
             clientReferenceId?: string;
             /** Format: date-time */
-            createdAt: string;
+            expirationDate?: string;
+            isExpired?: boolean;
             /** Format: date-time */
-            updatedAt: string;
+            createdAt?: string;
+            /** Format: date-time */
+            updatedAt?: string;
         };
         SignRequestUpdateMetadataResult: {
             requestId: string;