instasign 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.1.0] - 2026-02-28
+
+### Added
+- **Envelopes API**: Added `complete(envelopeId)` method to finalize envelopes from the SDK.
+
+### Changed
+- **License**: Changed package license from ISC to Apache-2.0.
+- **Dependency Refactoring**: Moved shared types to a dedicated `@instasign/types` package for better consistency across the project.
+- **Type Safety**: Improved internal type synchronization with compile-time schema validation against the OpenAPI specification.
+
 ## [1.0.1] - 2026-02-27
 
 ### Fixed

package/README.md

@@ -10,7 +10,7 @@ The **Instasign Node.js SDK** provides convenient access to the **Instasign Serv
 Install the package with:
 
 ```bash
-npm install instasign-api-sdk
+npm install instasign
 ```
 
 ## Usage
@@ -18,7 +18,7 @@ npm install instasign-api-sdk
 The package needs to be configured with your account's API key.
 
 ```typescript
-import { Instasign } from 'instasign-api-sdk';
+import { Instasign } from 'instasign';
 
 const instasign = new Instasign({
   apiKey: 'your_api_key',
@@ -119,4 +119,4 @@ This library is built with TypeScript and provides industry-standard type defini
 
 ## License
 
-ISC
+Apache-2.0

package/dist/index.cjs

@@ -0,0 +1,201 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  Envelopes: () => Envelopes,
+  Instasign: () => Instasign,
+  SignRequests: () => SignRequests,
+  Webhooks: () => Webhooks
+});
+module.exports = __toCommonJS(index_exports);
+var import_axios = __toESM(require("axios"), 1);
+
+// src/resources/Envelopes.ts
+var Envelopes = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Create a new envelope
+   */
+  async create(params) {
+    const response = await this.client.post("/functions/createEnvelope", params);
+    return response.data.result;
+  }
+  /**
+   * List envelopes
+   */
+  async list(params = {}) {
+    const response = await this.client.post("/functions/getEnvelopes", 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 });
+    return response.data.result;
+  }
+  /**
+   * Complete an envelope
+   */
+  async complete(envelopeId) {
+    const response = await this.client.post("/functions/completeEnvelope", { envelopeId });
+    return response.data.result;
+  }
+  /**
+   * Delete an envelope
+   */
+  async delete(envelopeId) {
+    const response = await this.client.post("/functions/deleteEnvelope", { envelopeId });
+    return response.data.result;
+  }
+  /**
+   * Update envelope metadata
+   */
+  async updateMetadata(params) {
+    const response = await this.client.post("/functions/updateEnvelopeMetadata", params);
+    return response.data.result;
+  }
+  /**
+   * Remove a sign request from an envelope
+   */
+  async removeSignRequest(params) {
+    const response = await this.client.post("/functions/removeSignRequestFromEnvelope", params);
+    return response.data.result;
+  }
+  /**
+   * Add a sign request to an envelope
+   */
+  async addSignRequest(params) {
+    const response = await this.client.post("/functions/addSignRequestToEnvelope", params);
+    return response.data.result;
+  }
+  /**
+   * Add multiple sign requests to an envelope
+   */
+  // async addSignRequests(params: AddSignRequestToEnvelopeParams[]): Promise<AddSignRequestToEnvelopeResponse[] | undefined> {
+  //     // TODO(ciro): must be implemented on back-end
+  //     const response = await this.client.post('/functions/addMultipleSignRequestsToEnvelope', params);
+  //     return response.data.result;
+  // }
+};
+
+// src/resources/SignRequests.ts
+var SignRequests = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Create a new sign request
+   */
+  async create(params) {
+    const response = await this.client.post("/functions/createSignRequest", params);
+    return response.data.result;
+  }
+  /**
+   * Complete a sign request
+   */
+  async complete(params) {
+    const response = await this.client.post("/functions/completeSignRequest", 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 });
+    return response.data.result;
+  }
+};
+
+// src/resources/Webhooks.ts
+var crypto = __toESM(require("crypto"), 1);
+var Webhooks = class {
+  constructor(tolerance = 300) {
+    this.tolerance = tolerance;
+  }
+  /**
+   * Verify and parse a webhook event
+   */
+  constructEvent(payload, signatureHeader, webhookSecret) {
+    const parts = signatureHeader.split(",");
+    const timestamp = parts.find((p) => p.startsWith("t="))?.split("=")[1];
+    const signature = parts.find((p) => p.startsWith("v1="))?.split("=")[1];
+    if (!timestamp || !signature) {
+      throw new Error("Invalid signature header");
+    }
+    const now = Math.floor(Date.now() / 1e3);
+    if (Math.abs(now - parseInt(timestamp)) > this.tolerance) {
+      throw new Error("Signature too old");
+    }
+    const signedPayload = `${timestamp}.${payload}`;
+    const expectedSignature = crypto.createHmac("sha256", webhookSecret).update(signedPayload).digest("hex");
+    const isValid = crypto.timingSafeEqual(
+      Buffer.from(signature),
+      Buffer.from(expectedSignature)
+    );
+    if (!isValid) {
+      throw new Error("Invalid signature");
+    }
+    return JSON.parse(payload);
+  }
+};
+
+// src/index.ts
+var Instasign = class {
+  client;
+  envelopes;
+  signRequests;
+  webhooks;
+  constructor(config) {
+    this.client = import_axios.default.create({
+      baseURL: config.serverUrl || "https://parseapi.back4app.com",
+      headers: {
+        "X-Parse-APPLICATION-ID": config.appId || "jKFo8BFQRdiAUV4F3o3SIDWLpLUb2TVW7bVl7lwH",
+        "X-Parse-REST-API-KEY": config.restApiKey || "Gjm9pmxZh0DjXHkcFlf0kGZjHfYEY4ERw71TvLig",
+        "x-api-key": config.apiKey,
+        "Content-Type": "application/json"
+      }
+    });
+    this.envelopes = new Envelopes(this.client);
+    this.signRequests = new SignRequests(this.client);
+    this.webhooks = new Webhooks(config.webhookTolerance ?? 300);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Envelopes,
+  Instasign,
+  SignRequests,
+  Webhooks
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +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';\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;;;AHjBO,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"]}