instasign 1.1.2 → 1.1.4

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.1.4] - 2026-03-01
+- **Type Safety**: Improved internal type synchronization with compile-time schema validation against the OpenAPI specification.
+
+## [1.1.3] - 2026-03-01
+- **Improved Type Precision**: Refactored resource types (Envelopes, SignRequests) to be derived directly from the OpenAPI schema using new utility types (`ResponseResult`, `RequestBody`).
+- **Read-only Resources**: The `envelopes`, `signRequests`, and `webhooks` properties on the `Instasign` class are now `readonly`.
+
+### Fixed
+- **Swagger Enum Serialization**: Fixed an issue where string union types (like `status`) were serialized as generic objects in Swagger.
+- **Swagger Param Enums**: Enhanced parameter extraction to correctly map cloud function parameters (like `orderBy`, `orderDirection`) to OpenAPI enums.
+- **Swagger Nested Objects**: Increased recursion depth and refined mapping to ensure nested arrays and objects (like `signRequests` inside `envelope:list`) are fully typed.
+- **Swagger Date Serialization**: Fixed `Date` objects being expanded into generic objects; they are now correctly mapped to `string` with `format: date-time`.
+
+### Changed
+- **Type Safety**: Improved internal type synchronization with compile-time schema validation against the OpenAPI specification.
+
 ## [1.1.2] - 2026-03-01
 
 ### Added

package/README.md

@@ -15,7 +15,7 @@ npm install instasign
 
 ## Usage
 
-The package needs to be configured with your account's API key.
+The package needs to be configured with your account's API key. You can also provide Parse Server configuration if you are using a custom instance.
 
 ```typescript
 import { Instasign } from 'instasign';
@@ -23,9 +23,9 @@ import { Instasign } from 'instasign';
 const instasign = new Instasign({
   apiKey: 'your_api_key',
   restApiKey: 'your_parse_rest_api_key', // Optional
-  serverUrl: 'https://parseapi.back4app.com', // Optional
-  appId: 'your_app_id', // Optional
-  webhookTolerance: 300 // default is 300 seconds (5 minutes)
+  serverUrl: 'https://api.instasign.io', // Optional: Your server URL
+  appId: 'your_app_id', // Optional: Your Parse App ID
+  webhookTolerance: 300 // default is 300 seconds
 });
 ```
 
@@ -40,8 +40,12 @@ const envelope = await instasign.envelopes.create({
   description: 'Please sign the attached document',
 });
 
-// List envelopes
-const envelopes = await instasign.envelopes.list();
+// List envelopes with full type support for nested objects
+const envelopes = await instasign.envelopes.list({
+  status: 'pending',
+  orderBy: 'createdAt',
+  orderDirection: 'desc'
+});
 
 // Retrieve an envelope by ID
 const envelope = await instasign.envelopes.get('envelope_id_here');
@@ -95,8 +99,8 @@ const endpointSecret = 'secret_key';
 
 try {
   const event = instasign.webhooks.constructEvent(payload, sig, endpointSecret);
-  // Handle the event
-  console.log(event.type);
+  // Handle the event (fully typed)
+  console.log(event.type); // e.g., 'envelope.completed'
 } catch (err) {
   console.error(`Webhook Error: ${err.message}`);
   res.status(400).send(`Webhook Error: ${err.message}`);
@@ -105,7 +109,10 @@ try {
 
 ## TypeScript Support
 
-This library is built with TypeScript and provides industry-standard type definitions auto-generated from the Instasign OpenAPI schema. Every method in the SDK is strictly typed, ensuring you catch errors at compile time and get excellent IDE autocompletion.
+This library is built with TypeScript and provides industry-standard type definitions auto-generated from the Instasign OpenAPI schema. Every method in the SDK is strictly typed, including:
+- **Enums**: Fields like `status`, `orderBy`, and `orderDirection` use string union types.
+- **Nested Objects**: Complex structures like the `signRequests` array inside an envelope are fully typed.
+- **Dates**: Automatic mapping of ISO date strings for `createdAt`, `updatedAt`, and `expirationDate`.
 
 ## Configuration Options
 

package/dist/index.cjs

@@ -33,10 +33,14 @@ __export(index_exports, {
   Envelopes: () => Envelopes,
   Instasign: () => Instasign,
   SignRequests: () => SignRequests,
+  VALID_ENVELOPE_STATUSES: () => VALID_ENVELOPE_STATUSES,
+  VALID_ORDER_BY: () => VALID_ORDER_BY,
+  VALID_ORDER_DIRECTION: () => VALID_ORDER_DIRECTION,
+  VALID_SIGN_REQUEST_STATUSES: () => VALID_SIGN_REQUEST_STATUSES,
+  VALID_WEBHOOK_EVENT_TYPES: () => VALID_WEBHOOK_EVENT_TYPES,
   Webhooks: () => Webhooks
 });
 module.exports = __toCommonJS(index_exports);
-var import_axios = __toESM(require("axios"), 1);
 
 // src/resources/Envelopes.ts
 var Envelopes = class {
@@ -47,56 +51,56 @@ var Envelopes = class {
    * Create a new envelope
    */
   async create(params) {
-    const response = await this.client.post("/functions/createEnvelope", params);
+    const response = await this.client.post("/functions/envelope:create", params);
     return response.data.result;
   }
   /**
    * List envelopes
    */
   async list(params = {}) {
-    const response = await this.client.post("/functions/getEnvelopes", params);
+    const response = await this.client.post("/functions/envelope:list", params);
     return response.data.result;
   }
   /**
    * Retrieve a single envelope with its sign requests
    */
   async get(envelopeId) {
-    const response = await this.client.post("/functions/getEnvelope", { envelopeId });
+    const response = await this.client.post("/functions/envelope:get", { envelopeId });
     return response.data.result;
   }
   /**
    * Complete an envelope
    */
   async complete(envelopeId) {
-    const response = await this.client.post("/functions/completeEnvelope", { envelopeId });
+    const response = await this.client.post("/functions/envelope:complete", { envelopeId });
     return response.data.result;
   }
   /**
    * Delete an envelope
    */
   async delete(envelopeId) {
-    const response = await this.client.post("/functions/deleteEnvelope", { envelopeId });
+    const response = await this.client.post("/functions/envelope:delete", { envelopeId });
     return response.data.result;
   }
   /**
    * Update envelope metadata
    */
   async updateMetadata(params) {
-    const response = await this.client.post("/functions/updateEnvelopeMetadata", params);
+    const response = await this.client.post("/functions/envelope:update-metadata", params);
     return response.data.result;
   }
   /**
    * Remove a sign request from an envelope
    */
   async removeSignRequest(params) {
-    const response = await this.client.post("/functions/removeSignRequestFromEnvelope", params);
+    const response = await this.client.post("/functions/envelope:remove-sign-request", params);
     return response.data.result;
   }
   /**
    * Add a sign request to an envelope
    */
   async addSignRequest(params) {
-    const response = await this.client.post("/functions/addSignRequestToEnvelope", params);
+    const response = await this.client.post("/functions/envelope:add-sign-request", params);
     return response.data.result;
   }
   /**
@@ -118,21 +122,21 @@ var SignRequests = class {
    * Create a new sign request
    */
   async create(params) {
-    const response = await this.client.post("/functions/createSignRequest", params);
+    const response = await this.client.post("/functions/sign-request:create", params);
     return response.data.result;
   }
   /**
    * Complete a sign request
    */
   async complete(params) {
-    const response = await this.client.post("/functions/completeSignRequest", params);
+    const response = await this.client.post("/functions/sign-request:complete", params);
     return response.data.result;
   }
   /**
    * Get the file associated with a sign request
    */
-  async getFile(requestId) {
-    const response = await this.client.post("/functions/getFileFromRequestId", { requestId });
+  async get(requestId) {
+    const response = await this.client.post("/functions/sign-request:get", { requestId });
     return response.data.result;
   }
 };
@@ -170,7 +174,8 @@ var Webhooks = class {
   }
 };
 
-// src/index.ts
+// src/instasign.ts
+var import_axios = __toESM(require("axios"), 1);
 var Instasign = class {
   client;
   envelopes;
@@ -178,10 +183,10 @@ var Instasign = class {
   webhooks;
   constructor(config) {
     this.client = import_axios.default.create({
-      baseURL: config.serverUrl || "https://parseapi.back4app.com",
+      baseURL: config.serverUrl,
       headers: {
-        "X-Parse-APPLICATION-ID": config.appId || "jKFo8BFQRdiAUV4F3o3SIDWLpLUb2TVW7bVl7lwH",
-        "X-Parse-REST-API-KEY": config.restApiKey || "Gjm9pmxZh0DjXHkcFlf0kGZjHfYEY4ERw71TvLig",
+        "X-Parse-APPLICATION-ID": config.appId,
+        "X-Parse-REST-API-KEY": config.restApiKey,
         "x-api-key": config.apiKey,
         "Content-Type": "application/json"
       }
@@ -191,11 +196,39 @@ 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"];
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Envelopes,
   Instasign,
   SignRequests,
+  VALID_ENVELOPE_STATUSES,
+  VALID_ORDER_BY,
+  VALID_ORDER_DIRECTION,
+  VALID_SIGN_REQUEST_STATUSES,
+  VALID_WEBHOOK_EVENT_TYPES,
   Webhooks
 });
 //# sourceMappingURL=index.cjs.map

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"],"sourcesContent":["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 * from './resources/Envelopes.js';\nexport * from './resources/SignRequests.js';\nexport * from './resources/Webhooks.js';\nexport * from './types.js';\n\nexport type * from '../types/schema.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 envelopes: Envelopes;\n  public signRequests: SignRequests;\n  public webhooks: Webhooks;\n\n  constructor(config: IInstasignConfig) {\n    this.client = axios.create({\n      baseURL: config.serverUrl || 'https://parseapi.back4app.com',\n      headers: {\n        'X-Parse-APPLICATION-ID': config.appId || 'jKFo8BFQRdiAUV4F3o3SIDWLpLUb2TVW7bVl7lwH',\n        'X-Parse-REST-API-KEY': config.restApiKey || 'Gjm9pmxZh0DjXHkcFlf0kGZjHfYEY4ERw71TvLig',\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","import { AxiosInstance } from 'axios';\nimport {\n    type CreateEnvelopeParams,\n    type CreateEnvelopeResponse,\n    type GetEnvelopesParams,\n    type EnvelopeListItem,\n    type Envelope,\n    type OperationResponse,\n    type UpdateEnvelopeMetadataParams,\n    type UpdateEnvelopeMetadataResponse,\n    type RemoveSignRequestFromEnvelopeParams,\n    type AddSignRequestToEnvelopeParams,\n    type AddSignRequestToEnvelopeResponse,\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/createEnvelope', params);\n        return response.data.result;\n    }\n\n    /**\n     * List envelopes\n     */\n    async list(params: GetEnvelopesParams = {}): Promise<EnvelopeListItem[] | undefined> {\n        const response = await this.client.post('/functions/getEnvelopes', 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/getEnvelope', { 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/completeEnvelope', { 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/deleteEnvelope', { 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/updateEnvelopeMetadata', 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/removeSignRequestFromEnvelope', 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/addSignRequestToEnvelope', 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 SignRequestFile,\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/createSignRequest', 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/completeSignRequest', params);\n        return response.data.result;\n    }\n\n    /**\n     * Get the file associated with a sign request\n     */\n    async getFile(requestId: string): Promise<SignRequestFile | undefined> {\n        const response = await this.client.post('/functions/getFileFromRequestId', { 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"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAqC;;;ACe9B,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,6BAA6B,MAAM;AAC3E,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,KAAK,SAA6B,CAAC,GAA4C;AACjF,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,2BAA2B,MAAM;AACzE,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,IAAI,YAAmD;AACzD,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,0BAA0B,EAAE,WAAW,CAAC;AAChF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,SAAS,YAA4D;AACvE,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,+BAA+B,EAAE,WAAW,CAAC;AACrF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAO,YAA4D;AACrE,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,6BAA6B,EAAE,WAAW,CAAC;AACnF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,eAAe,QAA2F;AAC5G,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,qCAAqC,MAAM;AACnF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,kBAAkB,QAAqF;AACzG,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,4CAA4C,MAAM;AAC1F,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,eAAe,QAA+F;AAChH,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,uCAAuC,MAAM;AACrF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUJ;;;ACjFO,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,gCAAgC,MAAM;AAC9E,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,SAAS,QAAqF;AAChG,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,kCAAkC,MAAM;AAChF,WAAO,SAAS,KAAK;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,QAAQ,WAAyD;AACnE,UAAM,WAAW,MAAM,KAAK,OAAO,KAAK,mCAAmC,EAAE,UAAU,CAAC;AACxF,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;;;AHhBO,IAAM,YAAN,MAAgB;AAAA,EACb;AAAA,EAED;AAAA,EACA;AAAA,EACA;AAAA,EAEP,YAAY,QAA0B;AACpC,SAAK,SAAS,aAAAA,QAAM,OAAO;AAAA,MACzB,SAAS,OAAO,aAAa;AAAA,MAC7B,SAAS;AAAA,QACP,0BAA0B,OAAO,SAAS;AAAA,QAC1C,wBAAwB,OAAO,cAAc;AAAA,QAC7C,aAAa,OAAO;AAAA,QACpB,gBAAgB;AAAA,MAClB;AAAA,IACF,CAAC;AAED,SAAK,YAAY,IAAI,UAAU,KAAK,MAAM;AAC1C,SAAK,eAAe,IAAI,aAAa,KAAK,MAAM;AAChD,SAAK,WAAW,IAAI,SAAS,OAAO,oBAAoB,GAAG;AAAA,EAC7D;AACF;","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 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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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,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,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;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":["axios"]}