@ministerjs/signing 0.1.0

package/dist/signing.d.mts

@@ -0,0 +1,158 @@
+interface CreateDocFromPdfBaseOptions<AT extends Record<string, true>> {
+    name: string;
+    signers: {
+        name: string;
+        authType: AT;
+        email?: string;
+        cpf?: string;
+        sendAutomaticEmail?: boolean;
+    }[];
+    disableSignerEmails?: boolean;
+    reference?: string;
+    folderId?: string;
+    folderPath?: string;
+}
+interface CreateDocFromPdfWithBase64<AT extends Record<string, true>> extends CreateDocFromPdfBaseOptions<AT> {
+    fileBase64: string;
+    fileUrl?: never;
+}
+interface CreateDocFromPdfWithUrl<AT extends Record<string, true>> extends CreateDocFromPdfBaseOptions<AT> {
+    fileBase64?: never;
+    fileUrl: string;
+}
+type CreateDocFromPdfOptions<AT extends Record<string, true>> = CreateDocFromPdfWithBase64<AT> | CreateDocFromPdfWithUrl<AT>;
+interface CreateDocFromDocxBaseOptions<AT extends Record<string, true>> {
+    name: string;
+    signers: {
+        name: string;
+        authType: AT;
+        email?: string;
+        cpf?: string;
+        sendAutomaticEmail?: boolean;
+    }[];
+    disableSignerEmails?: boolean;
+    reference?: string;
+    folderId?: string;
+    folderPath?: string;
+}
+interface CreateDocFromDocxWithBase64<AT extends Record<string, true>> extends CreateDocFromDocxBaseOptions<AT> {
+    fileBase64: string;
+    fileUrl?: never;
+}
+interface CreateDocFromDocxWithUrl<AT extends Record<string, true>> extends CreateDocFromDocxBaseOptions<AT> {
+    fileBase64?: never;
+    fileUrl: string;
+}
+type CreateDocFromDocxOptions<AT extends Record<string, true>> = CreateDocFromDocxWithBase64<AT> | CreateDocFromDocxWithUrl<AT>;
+interface ListDocsOptions {
+    page?: number;
+    folderPath?: string;
+    deleted?: boolean;
+    status?: "pending" | "signed" | "refused";
+}
+interface Doc {
+    id: string;
+    status: "pending" | "signed" | "refused";
+    name: string;
+    originalFile: string;
+    signedFile: string | null;
+    signers?: {
+        name: string;
+        email: string;
+        signUrl: string;
+    }[];
+    createdAt: string;
+}
+interface ExtraDoc {
+    id: string;
+    name: string;
+    originalFile: string;
+    signedFile: string | null;
+    createdAt?: string;
+}
+interface AddExtraDocOptionsBase {
+    docId: string;
+    name?: string;
+}
+interface AddExtraDocWithBase64 extends AddExtraDocOptionsBase {
+    fileBase64: string;
+    fileUrl?: never;
+}
+interface AddExtraDocWithUrl extends AddExtraDocOptionsBase {
+    fileBase64?: never;
+    fileUrl: string;
+}
+type AddExtraDocOptions = AddExtraDocWithBase64 | AddExtraDocWithUrl;
+interface GetRes<T> {
+    data: T;
+}
+interface ListRes<T> {
+    data: T[];
+    pageInfo?: {
+        totalResults: number;
+        next: string | null;
+        previous: string | null;
+    };
+}
+interface SigningService<AT extends Record<string, true>> extends EventTarget {
+    createDocFromPdf(data: CreateDocFromPdfWithBase64<AT>): Promise<GetRes<Doc>>;
+    createDocFromPdf(data: CreateDocFromPdfWithUrl<AT>): Promise<GetRes<Doc>>;
+    createDocFromPdf(data: CreateDocFromPdfOptions<AT>): Promise<GetRes<Doc>>;
+    createDocFromDocx(data: CreateDocFromDocxWithBase64<AT>): Promise<GetRes<Doc>>;
+    createDocFromDocx(data: CreateDocFromDocxWithUrl<AT>): Promise<GetRes<Doc>>;
+    createDocFromDocx(data: CreateDocFromDocxOptions<AT>): Promise<GetRes<Doc>>;
+    getDoc(id: string): Promise<GetRes<Doc>>;
+    listDocs(options?: ListDocsOptions): Promise<ListRes<Omit<Doc, "signers">>>;
+    listAllDocs(options?: Omit<ListDocsOptions, "page">): Promise<ListRes<Omit<Doc, "signers" | "listAllDocs">>>;
+    listAllDocsStream(options?: Omit<ListDocsOptions, "page">): AsyncGenerator<Omit<Doc, "signers" | "listAllDocs">>;
+    addExtraDoc(options: AddExtraDocWithBase64): Promise<GetRes<ExtraDoc>>;
+    addExtraDoc(options: AddExtraDocWithUrl): Promise<GetRes<ExtraDoc>>;
+    addExtraDoc(options: AddExtraDocOptions): Promise<GetRes<ExtraDoc>>;
+}
+
+type ExtraFields = {
+    selfiePhoto?: true;
+    documentPhoto?: true;
+};
+type ZapSignAuthType = ({
+    signatureOnScreen: true;
+} & ExtraFields) | ({
+    tokenEmail: true;
+} & ExtraFields) | ({
+    tokenSms: true;
+} & ExtraFields) | ({
+    tokenWhatsapp: true;
+} & ExtraFields) | ({
+    certificadoDigital: true;
+} & ExtraFields) | ({
+    signatureOnScreen: true;
+    tokenEmail: true;
+} & ExtraFields) | ({
+    signatureOnScreen: true;
+    tokenSms: true;
+} & ExtraFields) | ({
+    signatureOnScreen: true;
+    tokenWhatsapp: true;
+} & ExtraFields);
+interface Options {
+    apiKey: string;
+    apiUrl?: string;
+}
+declare class ZapSign extends EventTarget implements SigningService<ZapSignAuthType> {
+    private apiKey;
+    private apiUrl;
+    private headers;
+    constructor({ apiKey, apiUrl }: Options);
+    createDocFromPdf(options: CreateDocFromPdfWithBase64<ZapSignAuthType>): Promise<GetRes<Doc>>;
+    createDocFromPdf(options: CreateDocFromPdfWithUrl<ZapSignAuthType>): Promise<GetRes<Doc>>;
+    createDocFromDocx(options: CreateDocFromDocxWithBase64<ZapSignAuthType>): Promise<GetRes<Doc>>;
+    createDocFromDocx(options: CreateDocFromDocxWithUrl<ZapSignAuthType>): Promise<GetRes<Doc>>;
+    getDoc(token: string): Promise<GetRes<Doc>>;
+    listDocs(options?: ListDocsOptions): Promise<ListRes<Omit<Doc, "signers">>>;
+    listAllDocs(options?: Omit<ListDocsOptions, "page">): Promise<ListRes<Omit<Doc, "signers" | "listAllDocs">>>;
+    listAllDocsStream(options?: Omit<ListDocsOptions, "page">): AsyncGenerator<Omit<Doc, "signers" | "listAllDocs">, void, void>;
+    addExtraDoc(options: AddExtraDocWithBase64): Promise<GetRes<ExtraDoc>>;
+    addExtraDoc(options: AddExtraDocWithUrl): Promise<GetRes<ExtraDoc>>;
+}
+
+export { type AddExtraDocOptions, type AddExtraDocOptionsBase, type AddExtraDocWithBase64, type AddExtraDocWithUrl, type CreateDocFromDocxOptions, type CreateDocFromDocxWithBase64, type CreateDocFromDocxWithUrl, type CreateDocFromPdfOptions, type CreateDocFromPdfWithBase64, type CreateDocFromPdfWithUrl, type Doc, type ExtraDoc, type GetRes, type ListDocsOptions, type ListRes, type SigningService, ZapSign, type ZapSignAuthType };

package/dist/signing.d.ts

@@ -0,0 +1,158 @@
+interface CreateDocFromPdfBaseOptions<AT extends Record<string, true>> {
+    name: string;
+    signers: {
+        name: string;
+        authType: AT;
+        email?: string;
+        cpf?: string;
+        sendAutomaticEmail?: boolean;
+    }[];
+    disableSignerEmails?: boolean;
+    reference?: string;
+    folderId?: string;
+    folderPath?: string;
+}
+interface CreateDocFromPdfWithBase64<AT extends Record<string, true>> extends CreateDocFromPdfBaseOptions<AT> {
+    fileBase64: string;
+    fileUrl?: never;
+}
+interface CreateDocFromPdfWithUrl<AT extends Record<string, true>> extends CreateDocFromPdfBaseOptions<AT> {
+    fileBase64?: never;
+    fileUrl: string;
+}
+type CreateDocFromPdfOptions<AT extends Record<string, true>> = CreateDocFromPdfWithBase64<AT> | CreateDocFromPdfWithUrl<AT>;
+interface CreateDocFromDocxBaseOptions<AT extends Record<string, true>> {
+    name: string;
+    signers: {
+        name: string;
+        authType: AT;
+        email?: string;
+        cpf?: string;
+        sendAutomaticEmail?: boolean;
+    }[];
+    disableSignerEmails?: boolean;
+    reference?: string;
+    folderId?: string;
+    folderPath?: string;
+}
+interface CreateDocFromDocxWithBase64<AT extends Record<string, true>> extends CreateDocFromDocxBaseOptions<AT> {
+    fileBase64: string;
+    fileUrl?: never;
+}
+interface CreateDocFromDocxWithUrl<AT extends Record<string, true>> extends CreateDocFromDocxBaseOptions<AT> {
+    fileBase64?: never;
+    fileUrl: string;
+}
+type CreateDocFromDocxOptions<AT extends Record<string, true>> = CreateDocFromDocxWithBase64<AT> | CreateDocFromDocxWithUrl<AT>;
+interface ListDocsOptions {
+    page?: number;
+    folderPath?: string;
+    deleted?: boolean;
+    status?: "pending" | "signed" | "refused";
+}
+interface Doc {
+    id: string;
+    status: "pending" | "signed" | "refused";
+    name: string;
+    originalFile: string;
+    signedFile: string | null;
+    signers?: {
+        name: string;
+        email: string;
+        signUrl: string;
+    }[];
+    createdAt: string;
+}
+interface ExtraDoc {
+    id: string;
+    name: string;
+    originalFile: string;
+    signedFile: string | null;
+    createdAt?: string;
+}
+interface AddExtraDocOptionsBase {
+    docId: string;
+    name?: string;
+}
+interface AddExtraDocWithBase64 extends AddExtraDocOptionsBase {
+    fileBase64: string;
+    fileUrl?: never;
+}
+interface AddExtraDocWithUrl extends AddExtraDocOptionsBase {
+    fileBase64?: never;
+    fileUrl: string;
+}
+type AddExtraDocOptions = AddExtraDocWithBase64 | AddExtraDocWithUrl;
+interface GetRes<T> {
+    data: T;
+}
+interface ListRes<T> {
+    data: T[];
+    pageInfo?: {
+        totalResults: number;
+        next: string | null;
+        previous: string | null;
+    };
+}
+interface SigningService<AT extends Record<string, true>> extends EventTarget {
+    createDocFromPdf(data: CreateDocFromPdfWithBase64<AT>): Promise<GetRes<Doc>>;
+    createDocFromPdf(data: CreateDocFromPdfWithUrl<AT>): Promise<GetRes<Doc>>;
+    createDocFromPdf(data: CreateDocFromPdfOptions<AT>): Promise<GetRes<Doc>>;
+    createDocFromDocx(data: CreateDocFromDocxWithBase64<AT>): Promise<GetRes<Doc>>;
+    createDocFromDocx(data: CreateDocFromDocxWithUrl<AT>): Promise<GetRes<Doc>>;
+    createDocFromDocx(data: CreateDocFromDocxOptions<AT>): Promise<GetRes<Doc>>;
+    getDoc(id: string): Promise<GetRes<Doc>>;
+    listDocs(options?: ListDocsOptions): Promise<ListRes<Omit<Doc, "signers">>>;
+    listAllDocs(options?: Omit<ListDocsOptions, "page">): Promise<ListRes<Omit<Doc, "signers" | "listAllDocs">>>;
+    listAllDocsStream(options?: Omit<ListDocsOptions, "page">): AsyncGenerator<Omit<Doc, "signers" | "listAllDocs">>;
+    addExtraDoc(options: AddExtraDocWithBase64): Promise<GetRes<ExtraDoc>>;
+    addExtraDoc(options: AddExtraDocWithUrl): Promise<GetRes<ExtraDoc>>;
+    addExtraDoc(options: AddExtraDocOptions): Promise<GetRes<ExtraDoc>>;
+}
+
+type ExtraFields = {
+    selfiePhoto?: true;
+    documentPhoto?: true;
+};
+type ZapSignAuthType = ({
+    signatureOnScreen: true;
+} & ExtraFields) | ({
+    tokenEmail: true;
+} & ExtraFields) | ({
+    tokenSms: true;
+} & ExtraFields) | ({
+    tokenWhatsapp: true;
+} & ExtraFields) | ({
+    certificadoDigital: true;
+} & ExtraFields) | ({
+    signatureOnScreen: true;
+    tokenEmail: true;
+} & ExtraFields) | ({
+    signatureOnScreen: true;
+    tokenSms: true;
+} & ExtraFields) | ({
+    signatureOnScreen: true;
+    tokenWhatsapp: true;
+} & ExtraFields);
+interface Options {
+    apiKey: string;
+    apiUrl?: string;
+}
+declare class ZapSign extends EventTarget implements SigningService<ZapSignAuthType> {
+    private apiKey;
+    private apiUrl;
+    private headers;
+    constructor({ apiKey, apiUrl }: Options);
+    createDocFromPdf(options: CreateDocFromPdfWithBase64<ZapSignAuthType>): Promise<GetRes<Doc>>;
+    createDocFromPdf(options: CreateDocFromPdfWithUrl<ZapSignAuthType>): Promise<GetRes<Doc>>;
+    createDocFromDocx(options: CreateDocFromDocxWithBase64<ZapSignAuthType>): Promise<GetRes<Doc>>;
+    createDocFromDocx(options: CreateDocFromDocxWithUrl<ZapSignAuthType>): Promise<GetRes<Doc>>;
+    getDoc(token: string): Promise<GetRes<Doc>>;
+    listDocs(options?: ListDocsOptions): Promise<ListRes<Omit<Doc, "signers">>>;
+    listAllDocs(options?: Omit<ListDocsOptions, "page">): Promise<ListRes<Omit<Doc, "signers" | "listAllDocs">>>;
+    listAllDocsStream(options?: Omit<ListDocsOptions, "page">): AsyncGenerator<Omit<Doc, "signers" | "listAllDocs">, void, void>;
+    addExtraDoc(options: AddExtraDocWithBase64): Promise<GetRes<ExtraDoc>>;
+    addExtraDoc(options: AddExtraDocWithUrl): Promise<GetRes<ExtraDoc>>;
+}
+
+export { type AddExtraDocOptions, type AddExtraDocOptionsBase, type AddExtraDocWithBase64, type AddExtraDocWithUrl, type CreateDocFromDocxOptions, type CreateDocFromDocxWithBase64, type CreateDocFromDocxWithUrl, type CreateDocFromPdfOptions, type CreateDocFromPdfWithBase64, type CreateDocFromPdfWithUrl, type Doc, type ExtraDoc, type GetRes, type ListDocsOptions, type ListRes, type SigningService, ZapSign, type ZapSignAuthType };

package/dist/signing.js

@@ -0,0 +1,343 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  ZapSign: () => ZapSign
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/ZapSign.ts
+var ZapSign = class extends EventTarget {
+  apiKey;
+  apiUrl;
+  headers;
+  constructor({ apiKey, apiUrl }) {
+    super();
+    if (!apiKey) {
+      throw new Error("API key is required");
+    }
+    this.apiKey = apiKey;
+    this.apiUrl = apiUrl || "https://sandbox.api.zapsign.com.br/api/v1";
+    this.headers = {
+      Authorization: `Bearer ${this.apiKey}`,
+      "Content-Type": "application/json"
+    };
+  }
+  async createDocFromPdf({
+    name,
+    fileBase64,
+    fileUrl,
+    signers,
+    disableSignerEmails,
+    reference,
+    folderId,
+    folderPath
+  }) {
+    const url = `${this.apiUrl}/docs/`;
+    if (!fileBase64 && !fileUrl) {
+      throw new Error("Either fileBase64 or fileUrl must be provided");
+    }
+    if (fileBase64 && fileUrl) {
+      throw new Error("Only one of fileBase64 or fileUrl should be provided");
+    }
+    const mappedSigners = signers.map((signer) => {
+      const { name: name2, email, cpf, authType } = signer;
+      const authModeMap = [
+        [
+          "assinaturaTela-tokenEmail",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenEmail")
+        ],
+        [
+          "assinaturaTela-tokenSms",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenSms")
+        ],
+        [
+          "assinaturaTela-tokenWhatsapp",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenWhatsapp")
+        ],
+        ["assinaturaTela", Reflect.get(authType, "signatureOnScreen")],
+        ["tokenEmail", Reflect.get(authType, "tokenEmail")],
+        ["tokenSms", Reflect.get(authType, "tokenSms")],
+        ["tokenWhatsapp", Reflect.get(authType, "tokenWhatsapp")],
+        ["certificadoDigital", Reflect.get(authType, "certificadoDigital")]
+      ];
+      const auth_mode = authModeMap.find(([, value]) => value)?.[0];
+      return {
+        name: name2,
+        email,
+        cpf,
+        auth_mode,
+        require_selfie_photo: authType.selfiePhoto,
+        require_document_photo: authType.documentPhoto,
+        send_automatic_email: signer.sendAutomaticEmail || false,
+        lock_name: true,
+        lock_email: true
+      };
+    });
+    const body = JSON.stringify({
+      name,
+      url_pdf: fileUrl,
+      base64_pdf: fileBase64,
+      signers: mappedSigners,
+      disable_signer_emails: disableSignerEmails || false,
+      external_id: reference,
+      folder_token: folderId,
+      folder_path: folderPath
+    });
+    const res = await fetch(url, {
+      method: "POST",
+      headers: this.headers,
+      body
+    });
+    if (!res.ok) throw new Error(await res.text());
+    const parsedData = await res.json();
+    return {
+      data: {
+        id: parsedData.token,
+        status: parsedData.status,
+        name: parsedData.name,
+        originalFile: parsedData.original_file,
+        signedFile: parsedData.signed_file,
+        signers: parsedData.signers.map((signer) => ({
+          name: signer.name,
+          email: signer.email,
+          signUrl: signer.sign_url
+        })),
+        createdAt: parsedData.created_at
+      }
+    };
+  }
+  async createDocFromDocx({
+    name,
+    fileBase64,
+    fileUrl,
+    signers,
+    disableSignerEmails,
+    reference,
+    folderId,
+    folderPath
+  }) {
+    const url = `${this.apiUrl}/docs/`;
+    if (!fileBase64 && !fileUrl) {
+      throw new Error("Either fileBase64 or fileUrl must be provided");
+    }
+    if (fileBase64 && fileUrl) {
+      throw new Error("Only one of fileBase64 or fileUrl should be provided");
+    }
+    const mappedSigners = signers.map((signer) => {
+      const { name: name2, email, cpf, authType } = signer;
+      const authModeMap = [
+        [
+          "assinaturaTela-tokenEmail",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenEmail")
+        ],
+        [
+          "assinaturaTela-tokenSms",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenSms")
+        ],
+        [
+          "assinaturaTela-tokenWhatsapp",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenWhatsapp")
+        ],
+        ["assinaturaTela", Reflect.get(authType, "signatureOnScreen")],
+        ["tokenEmail", Reflect.get(authType, "tokenEmail")],
+        ["tokenSms", Reflect.get(authType, "tokenSms")],
+        ["tokenWhatsapp", Reflect.get(authType, "tokenWhatsapp")],
+        ["certificadoDigital", Reflect.get(authType, "certificadoDigital")]
+      ];
+      const auth_mode = authModeMap.find(([, value]) => value)?.[0];
+      return {
+        name: name2,
+        email,
+        cpf,
+        auth_mode,
+        require_selfie_photo: authType.selfiePhoto,
+        require_document_photo: authType.documentPhoto,
+        send_automatic_email: signer.sendAutomaticEmail || false,
+        lock_name: true,
+        lock_email: true
+      };
+    });
+    const body = JSON.stringify({
+      name,
+      url_docx: fileUrl,
+      base64_docx: fileBase64,
+      signers: mappedSigners,
+      disable_signer_emails: disableSignerEmails || false,
+      external_id: reference,
+      folder_token: folderId,
+      folder_path: folderPath
+    });
+    const res = await fetch(url, {
+      method: "POST",
+      headers: this.headers,
+      body
+    });
+    if (!res.ok) throw new Error(await res.text());
+    const parsedData = await res.json();
+    return {
+      data: {
+        id: parsedData.token,
+        status: parsedData.status,
+        name: parsedData.name,
+        originalFile: parsedData.original_file,
+        signedFile: parsedData.signed_file,
+        signers: parsedData.signers.map((signer) => ({
+          name: signer.name,
+          email: signer.email,
+          signUrl: signer.sign_url
+        })),
+        createdAt: parsedData.created_at
+      }
+    };
+  }
+  async getDoc(token) {
+    const response = await fetch(
+      `https://api.zapsign.com.br/api/v1/docs/${token}/`,
+      {
+        method: "GET",
+        headers: this.headers
+      }
+    );
+    if (!response.ok) throw new Error(await response.text());
+    const data = await response.json();
+    return {
+      data: {
+        id: data.token,
+        status: data.status,
+        name: data.name,
+        originalFile: data.original_file,
+        signedFile: data.signed_file,
+        signers: data.signers?.map((signer) => ({
+          name: signer.name,
+          email: signer.email,
+          signUrl: `https://app.zapsign.com.br/verificar/${signer.token}`
+        })),
+        createdAt: data.created_at
+      }
+    };
+  }
+  async listDocs(options) {
+    let url = `${this.apiUrl}/docs/`;
+    url += `?page=${options?.page || 1}`;
+    if (options?.folderPath) {
+      url += `&folder_path=${encodeURIComponent(options.folderPath)}`;
+    }
+    if (options?.deleted) {
+      url += `&deleted=${options.deleted}`;
+    }
+    if (options?.status) {
+      url += `&status=${options.status}`;
+    }
+    const response = await fetch(url, {
+      method: "GET",
+      headers: this.headers
+    });
+    if (!response.ok) throw new Error(await response.text());
+    const parsedData = await response.json();
+    const data = parsedData.results.map((doc) => ({
+      id: doc.token,
+      status: doc.status,
+      name: doc.name,
+      originalFile: doc.original_file,
+      signedFile: doc.signed_file,
+      createdAt: doc.created_at
+    }));
+    return {
+      data,
+      pageInfo: {
+        totalResults: parsedData.count,
+        next: parsedData.next,
+        previous: parsedData.previous
+      }
+    };
+  }
+  async listAllDocs(options) {
+    const allDocs = [];
+    for await (const doc of this.listAllDocsStream(options)) {
+      allDocs.push(doc);
+    }
+    return {
+      data: allDocs
+    };
+  }
+  async *listAllDocsStream(options) {
+    let page = 1;
+    let hasMore = true;
+    let count = 0;
+    while (hasMore) {
+      const { data, pageInfo } = await this.listDocs({ ...options, page });
+      count += data.length;
+      this.dispatchEvent(
+        new CustomEvent("list-all-progress", {
+          detail: {
+            data,
+            count
+          }
+        })
+      );
+      for (const doc of data) {
+        yield doc;
+      }
+      page++;
+      hasMore = Boolean(pageInfo?.next);
+    }
+  }
+  async addExtraDoc({
+    docId,
+    fileBase64,
+    fileUrl,
+    name
+  }) {
+    if (!docId) throw new Error("docId \xE9 obrigat\xF3rio");
+    if (!fileBase64 && !fileUrl) {
+      throw new Error("Informe fileBase64 ou fileUrl");
+    }
+    if (fileBase64 && fileUrl) {
+      throw new Error("Apenas um de fileBase64 ou fileUrl deve ser enviado");
+    }
+    const url = `${this.apiUrl}/docs/${docId}/upload-extra-doc/`;
+    const body = JSON.stringify({
+      base64_pdf: fileBase64,
+      url_pdf: fileUrl,
+      name
+    });
+    const res = await fetch(url, {
+      method: "POST",
+      headers: this.headers,
+      body
+    });
+    if (!res.ok) throw new Error(await res.text());
+    const data = await res.json();
+    return {
+      data: {
+        id: data.token,
+        name: data.name,
+        originalFile: data.original_file,
+        signedFile: data.signed_file
+      }
+    };
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ZapSign
+});

package/dist/signing.mjs

@@ -0,0 +1,316 @@
+// src/ZapSign.ts
+var ZapSign = class extends EventTarget {
+  apiKey;
+  apiUrl;
+  headers;
+  constructor({ apiKey, apiUrl }) {
+    super();
+    if (!apiKey) {
+      throw new Error("API key is required");
+    }
+    this.apiKey = apiKey;
+    this.apiUrl = apiUrl || "https://sandbox.api.zapsign.com.br/api/v1";
+    this.headers = {
+      Authorization: `Bearer ${this.apiKey}`,
+      "Content-Type": "application/json"
+    };
+  }
+  async createDocFromPdf({
+    name,
+    fileBase64,
+    fileUrl,
+    signers,
+    disableSignerEmails,
+    reference,
+    folderId,
+    folderPath
+  }) {
+    const url = `${this.apiUrl}/docs/`;
+    if (!fileBase64 && !fileUrl) {
+      throw new Error("Either fileBase64 or fileUrl must be provided");
+    }
+    if (fileBase64 && fileUrl) {
+      throw new Error("Only one of fileBase64 or fileUrl should be provided");
+    }
+    const mappedSigners = signers.map((signer) => {
+      const { name: name2, email, cpf, authType } = signer;
+      const authModeMap = [
+        [
+          "assinaturaTela-tokenEmail",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenEmail")
+        ],
+        [
+          "assinaturaTela-tokenSms",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenSms")
+        ],
+        [
+          "assinaturaTela-tokenWhatsapp",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenWhatsapp")
+        ],
+        ["assinaturaTela", Reflect.get(authType, "signatureOnScreen")],
+        ["tokenEmail", Reflect.get(authType, "tokenEmail")],
+        ["tokenSms", Reflect.get(authType, "tokenSms")],
+        ["tokenWhatsapp", Reflect.get(authType, "tokenWhatsapp")],
+        ["certificadoDigital", Reflect.get(authType, "certificadoDigital")]
+      ];
+      const auth_mode = authModeMap.find(([, value]) => value)?.[0];
+      return {
+        name: name2,
+        email,
+        cpf,
+        auth_mode,
+        require_selfie_photo: authType.selfiePhoto,
+        require_document_photo: authType.documentPhoto,
+        send_automatic_email: signer.sendAutomaticEmail || false,
+        lock_name: true,
+        lock_email: true
+      };
+    });
+    const body = JSON.stringify({
+      name,
+      url_pdf: fileUrl,
+      base64_pdf: fileBase64,
+      signers: mappedSigners,
+      disable_signer_emails: disableSignerEmails || false,
+      external_id: reference,
+      folder_token: folderId,
+      folder_path: folderPath
+    });
+    const res = await fetch(url, {
+      method: "POST",
+      headers: this.headers,
+      body
+    });
+    if (!res.ok) throw new Error(await res.text());
+    const parsedData = await res.json();
+    return {
+      data: {
+        id: parsedData.token,
+        status: parsedData.status,
+        name: parsedData.name,
+        originalFile: parsedData.original_file,
+        signedFile: parsedData.signed_file,
+        signers: parsedData.signers.map((signer) => ({
+          name: signer.name,
+          email: signer.email,
+          signUrl: signer.sign_url
+        })),
+        createdAt: parsedData.created_at
+      }
+    };
+  }
+  async createDocFromDocx({
+    name,
+    fileBase64,
+    fileUrl,
+    signers,
+    disableSignerEmails,
+    reference,
+    folderId,
+    folderPath
+  }) {
+    const url = `${this.apiUrl}/docs/`;
+    if (!fileBase64 && !fileUrl) {
+      throw new Error("Either fileBase64 or fileUrl must be provided");
+    }
+    if (fileBase64 && fileUrl) {
+      throw new Error("Only one of fileBase64 or fileUrl should be provided");
+    }
+    const mappedSigners = signers.map((signer) => {
+      const { name: name2, email, cpf, authType } = signer;
+      const authModeMap = [
+        [
+          "assinaturaTela-tokenEmail",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenEmail")
+        ],
+        [
+          "assinaturaTela-tokenSms",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenSms")
+        ],
+        [
+          "assinaturaTela-tokenWhatsapp",
+          Reflect.get(authType, "signatureOnScreen") && Reflect.get(authType, "tokenWhatsapp")
+        ],
+        ["assinaturaTela", Reflect.get(authType, "signatureOnScreen")],
+        ["tokenEmail", Reflect.get(authType, "tokenEmail")],
+        ["tokenSms", Reflect.get(authType, "tokenSms")],
+        ["tokenWhatsapp", Reflect.get(authType, "tokenWhatsapp")],
+        ["certificadoDigital", Reflect.get(authType, "certificadoDigital")]
+      ];
+      const auth_mode = authModeMap.find(([, value]) => value)?.[0];
+      return {
+        name: name2,
+        email,
+        cpf,
+        auth_mode,
+        require_selfie_photo: authType.selfiePhoto,
+        require_document_photo: authType.documentPhoto,
+        send_automatic_email: signer.sendAutomaticEmail || false,
+        lock_name: true,
+        lock_email: true
+      };
+    });
+    const body = JSON.stringify({
+      name,
+      url_docx: fileUrl,
+      base64_docx: fileBase64,
+      signers: mappedSigners,
+      disable_signer_emails: disableSignerEmails || false,
+      external_id: reference,
+      folder_token: folderId,
+      folder_path: folderPath
+    });
+    const res = await fetch(url, {
+      method: "POST",
+      headers: this.headers,
+      body
+    });
+    if (!res.ok) throw new Error(await res.text());
+    const parsedData = await res.json();
+    return {
+      data: {
+        id: parsedData.token,
+        status: parsedData.status,
+        name: parsedData.name,
+        originalFile: parsedData.original_file,
+        signedFile: parsedData.signed_file,
+        signers: parsedData.signers.map((signer) => ({
+          name: signer.name,
+          email: signer.email,
+          signUrl: signer.sign_url
+        })),
+        createdAt: parsedData.created_at
+      }
+    };
+  }
+  async getDoc(token) {
+    const response = await fetch(
+      `https://api.zapsign.com.br/api/v1/docs/${token}/`,
+      {
+        method: "GET",
+        headers: this.headers
+      }
+    );
+    if (!response.ok) throw new Error(await response.text());
+    const data = await response.json();
+    return {
+      data: {
+        id: data.token,
+        status: data.status,
+        name: data.name,
+        originalFile: data.original_file,
+        signedFile: data.signed_file,
+        signers: data.signers?.map((signer) => ({
+          name: signer.name,
+          email: signer.email,
+          signUrl: `https://app.zapsign.com.br/verificar/${signer.token}`
+        })),
+        createdAt: data.created_at
+      }
+    };
+  }
+  async listDocs(options) {
+    let url = `${this.apiUrl}/docs/`;
+    url += `?page=${options?.page || 1}`;
+    if (options?.folderPath) {
+      url += `&folder_path=${encodeURIComponent(options.folderPath)}`;
+    }
+    if (options?.deleted) {
+      url += `&deleted=${options.deleted}`;
+    }
+    if (options?.status) {
+      url += `&status=${options.status}`;
+    }
+    const response = await fetch(url, {
+      method: "GET",
+      headers: this.headers
+    });
+    if (!response.ok) throw new Error(await response.text());
+    const parsedData = await response.json();
+    const data = parsedData.results.map((doc) => ({
+      id: doc.token,
+      status: doc.status,
+      name: doc.name,
+      originalFile: doc.original_file,
+      signedFile: doc.signed_file,
+      createdAt: doc.created_at
+    }));
+    return {
+      data,
+      pageInfo: {
+        totalResults: parsedData.count,
+        next: parsedData.next,
+        previous: parsedData.previous
+      }
+    };
+  }
+  async listAllDocs(options) {
+    const allDocs = [];
+    for await (const doc of this.listAllDocsStream(options)) {
+      allDocs.push(doc);
+    }
+    return {
+      data: allDocs
+    };
+  }
+  async *listAllDocsStream(options) {
+    let page = 1;
+    let hasMore = true;
+    let count = 0;
+    while (hasMore) {
+      const { data, pageInfo } = await this.listDocs({ ...options, page });
+      count += data.length;
+      this.dispatchEvent(
+        new CustomEvent("list-all-progress", {
+          detail: {
+            data,
+            count
+          }
+        })
+      );
+      for (const doc of data) {
+        yield doc;
+      }
+      page++;
+      hasMore = Boolean(pageInfo?.next);
+    }
+  }
+  async addExtraDoc({
+    docId,
+    fileBase64,
+    fileUrl,
+    name
+  }) {
+    if (!docId) throw new Error("docId \xE9 obrigat\xF3rio");
+    if (!fileBase64 && !fileUrl) {
+      throw new Error("Informe fileBase64 ou fileUrl");
+    }
+    if (fileBase64 && fileUrl) {
+      throw new Error("Apenas um de fileBase64 ou fileUrl deve ser enviado");
+    }
+    const url = `${this.apiUrl}/docs/${docId}/upload-extra-doc/`;
+    const body = JSON.stringify({
+      base64_pdf: fileBase64,
+      url_pdf: fileUrl,
+      name
+    });
+    const res = await fetch(url, {
+      method: "POST",
+      headers: this.headers,
+      body
+    });
+    if (!res.ok) throw new Error(await res.text());
+    const data = await res.json();
+    return {
+      data: {
+        id: data.token,
+        name: data.name,
+        originalFile: data.original_file,
+        signedFile: data.signed_file
+      }
+    };
+  }
+};
+export {
+  ZapSign
+};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@ministerjs/signing",
+  "version": "0.1.0",
+  "license": "UNLICENSED",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/*"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/signing.d.ts",
+      "import": "./dist/signing.mjs",
+      "require": "./dist/signing.js"
+    }
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.32.0",
+    "@types/node": "^22.13.10",
+    "eslint": "^9.32.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^16.3.0",
+    "prettier": "^3.6.2",
+    "tsup": "^8.5.0",
+    "tsx": "^4.20.3",
+    "typescript": "~5.8.3",
+    "typescript-eslint": "^8.38.0",
+    "vitest": "^3.2.4"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "lint": "eslint ./src --fix --config ../../eslint.config.mjs",
+    "test": "vitest run --root ../../ --project @ministerjs/signing",
+    "build": "pnpm lint && pnpm test && tsup"
+  }
+}