@adonis-agora/payments 0.16.1 → 0.17.0

package/dist/src/invoice/invoice_provider.d.ts

@@ -1,4 +1,4 @@
-import type { Invoice, InvoiceOptions } from '../types.js';
+import type { Invoice, InvoiceOptions, InvoiceTaxes } from '../types.js';
 /** Context handed to invoice provider factories. */
 export interface InvoiceContext {
     config: () => unknown;
@@ -14,6 +14,25 @@ export interface InvoiceProvider {
     emit(input: InvoiceEmitInput): Promise<Invoice>;
     /** Look up an issued invoice by its id at the provider. */
     find(invoiceId: string): Promise<Invoice | null>;
+    /**
+     * Ask the provider to cancel an invoice. Cancelling a fiscal invoice usually depends on
+     * the city hall, so the returned invoice may still be `issued` while the cancellation is
+     * processed — follow the provider's webhook (Asaas: `nfse.canceled` /
+     * `nfse.cancellation_denied`) for the outcome.
+     *
+     * Providers whose cancellation is not implemented throw a `[payments] … not supported`
+     * error rather than pretending the invoice was cancelled.
+     */
+    cancel(invoiceId: string, options?: InvoiceCancelOptions): Promise<Invoice>;
+}
+export interface InvoiceCancelOptions {
+    /** Why the invoice is being cancelled (providers that take a justification send it). */
+    reason?: string;
+    /**
+     * Cancel only at the provider, without asking the city hall (Asaas: `cancelOnlyOnAsaas`).
+     * For a note the city hall already cancelled by other means.
+     */
+    providerOnly?: boolean;
 }
 export interface InvoiceEmitInput {
     /** The billing customer's data (name, taxId, address...). */
@@ -22,6 +41,12 @@ export interface InvoiceEmitInput {
         taxId: string;
         email?: string;
         address?: Record<string, unknown>;
+        /**
+         * The customer's id AT THE INVOICE PROVIDER, when it has its own customer records
+         * (Asaas: `cus_…`). Asaas identifies the recipient by this id or by the charge
+         * (`payment`) — never by the CPF/CNPJ.
+         */
+        gatewayId?: string;
     };
     /** Amount in the currency's smallest unit (e.g. cents). */
     amount: number;
@@ -33,9 +58,31 @@ export interface InvoiceEmitInput {
         code?: string;
         /** Municipal service code. */
         cityServiceCode?: string;
+        /** The provider's own id of the municipal service (Asaas: `municipalServiceId`). */
+        municipalServiceId?: string;
+        /** The municipal service's name (Asaas: `municipalServiceName`). */
+        municipalServiceName?: string;
     };
-    /** Tax configuration (ISS, etc.). */
-    tax?: Record<string, unknown>;
+    /** Tax configuration (ISS, retentions, etc.). */
+    tax?: InvoiceTaxes;
+    /**
+     * The issue date (`YYYY-MM-DD`). Providers that schedule emission (Asaas) emit on this
+     * date; defaults to today in Brasília.
+     */
+    effectiveDate?: string;
+    /**
+     * Deductions in the currency's smallest unit. They do not change the invoice total; they
+     * reduce the ISS base. Defaults to 0.
+     */
+    deductions?: number;
+    /** Free-text observations printed on the invoice. */
+    observations?: string;
+    /**
+     * Your own id for this invoice. Providers that support it store it, and the Asaas driver
+     * also uses it for idempotency: an emit with a reference that already has a live
+     * (not cancelled, not failed) invoice returns that invoice instead of creating a second one.
+     */
+    externalReference?: string;
     /** The gateway payment this invoice is attached to, when available. */
     payment?: {
         gatewayId: string;
@@ -44,5 +91,5 @@ export interface InvoiceEmitInput {
     /** Extra provider-specific fields. */
     metadata?: Record<string, unknown>;
 }
-export type { Invoice, InvoiceOptions };
+export type { Invoice, InvoiceOptions, InvoiceTaxes };
 //# sourceMappingURL=invoice_provider.d.ts.map

package/dist/src/invoice/invoice_provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invoice_provider.d.ts","sourceRoot":"","sources":["../../../src/invoice/invoice_provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,oDAAoD;AACpD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,OAAO,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,2DAA2D;IAC3D,IAAI,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhD,2DAA2D;IAC3D,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,gBAAgB;IAC/B,6DAA6D;IAC7D,QAAQ,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC,CAAC;IACF,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,OAAO,EAAE;QACP,WAAW,EAAE,MAAM,CAAC;QACpB,oBAAoB;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,8BAA8B;QAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF,qCAAqC;IACrC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,uEAAuE;IACvE,OAAO,CAAC,EAAE;QACR,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC"}
+{"version":3,"file":"invoice_provider.d.ts","sourceRoot":"","sources":["../../../src/invoice/invoice_provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEzE,oDAAoD;AACpD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,OAAO,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,2DAA2D;IAC3D,IAAI,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhD,2DAA2D;IAC3D,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IAEjD;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC7E;AAED,MAAM,WAAW,oBAAoB;IACnC,wFAAwF;IACxF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,6DAA6D;IAC7D,QAAQ,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC;;;;WAIG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,OAAO,EAAE;QACP,WAAW,EAAE,MAAM,CAAC;QACpB,oBAAoB;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,8BAA8B;QAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,oFAAoF;QACpF,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,oEAAoE;QACpE,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC/B,CAAC;IACF,iDAAiD;IACjD,GAAG,CAAC,EAAE,YAAY,CAAC;IACnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,uEAAuE;IACvE,OAAO,CAAC,EAAE;QACR,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC"}

package/dist/src/types.d.ts

@@ -332,6 +332,30 @@ export interface WebhookEvent<T = unknown> {
  * })
  * ```
  */
+/**
+ * Tax configuration of a service invoice. The named fields are the ones Asaas' NFS-e API
+ * requires (rates in percent, e.g. `iss: 2` = 2%); providers that use other names read
+ * their own keys from the same object, which is why it stays open.
+ */
+export interface InvoiceTaxes {
+    /** Whether the service taker withholds the ISS. */
+    retainIss?: boolean;
+    /** ISS rate (%). */
+    iss?: number;
+    /** PIS rate (%). */
+    pis?: number;
+    /** COFINS rate (%). */
+    cofins?: number;
+    /** CSLL rate (%). */
+    csll?: number;
+    /** INSS rate (%). */
+    inss?: number;
+    /** IR rate (%). */
+    ir?: number;
+    /** NBS code (Nomenclatura Brasileira de Serviços). */
+    nbsCode?: string;
+    [key: string]: unknown;
+}
 export interface InvoiceOptions {
     /** Named invoice provider (a key of `invoice.providers`). Defaults to `invoice.default`. */
     provider?: string;
@@ -342,16 +366,30 @@ export interface InvoiceOptions {
         code?: string;
         /** Municipal service code (código de serviço municipal). */
         cityServiceCode?: string;
+        /** The provider's own id of the municipal service (Asaas: `municipalServiceId`). */
+        municipalServiceId?: string;
+        /** The municipal service's name (Asaas: `municipalServiceName`). */
+        municipalServiceName?: string;
     };
     /** Tax configuration. Falls back to `invoice.defaults.tax`. */
-    tax?: Record<string, unknown>;
+    tax?: InvoiceTaxes;
     /** Invoice recipient. Defaults to the billing customer's data. */
     customer?: {
         name?: string;
         taxId?: string;
         email?: string;
         address?: Record<string, unknown>;
+        /** The customer's id at the invoice provider (Asaas: `cus_…`). */
+        gatewayId?: string;
     };
+    /** Issue date (`YYYY-MM-DD`). */
+    effectiveDate?: string;
+    /** Deductions in the currency's smallest unit (reduce the ISS base, not the total). */
+    deductions?: number;
+    /** Free-text observations printed on the invoice. */
+    observations?: string;
+    /** Your own id for this invoice; the Asaas provider uses it for idempotency. */
+    externalReference?: string;
     /** Extra provider-specific fields. */
     metadata?: Record<string, unknown>;
 }

package/dist/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,kFAAkF;AAClF,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC;AAE3B,iEAAiE;AACjE,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,YAAY,GACZ,MAAM,GACN,QAAQ,GACR,UAAU,GACV,UAAU,GACV,UAAU,CAAC;AAEf;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,UAAU,GACV,OAAO,CAAC;AAEZ,8EAA8E;AAC9E,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN,KAAK,GACL,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,eAAe,GACf,YAAY,GACZ,KAAK,GACL,MAAM,GACN,SAAS,GACT,SAAS,CAAC;AAEd;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,oBAAoB,YAC/B,KAAK,EACL,aAAa,EACb,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,eAAe,EACf,YAAY,EACZ,KAAK,EACL,MAAM,EACN,SAAS,EACT,WAAW,CACH,CAAC;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtE,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,KAAK,CAAC;IACd,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,MAAM,GACN,cAAc,GACd,KAAK,GACL,MAAM,GACN,UAAU,GACV,SAAS,CAAC;AAEd,wEAAwE;AACxE,MAAM,WAAW,OAAO;IACtB,mEAAmE;IACnE,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,aAAa,CAAC;IACtB;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,+EAA+E;IAC/E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6EAA6E;IAC7E,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gGAAgG;IAChG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACnD,mFAAmF;IACnF,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;IAC9B,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAC3B,SAAS,GACT,SAAS,GACT,wBAAwB,GACxB,oBAAoB,GACpB,UAAU,GACV,SAAS,GACT,eAAe,GACf,qBAAqB,GACrB,OAAO,GACP,kBAAkB,GAClB,OAAO,CAAC;AAEZ;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,kDAAkD;IAClD,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,mEAAmE;AACnE,MAAM,WAAW,sBAAsB;IACrC,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,CAAC;IACzB,6EAA6E;IAC7E,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,yCAAyC;AACzC,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gEAAgE;IAChE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,sEAAsE;IACtE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC3C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,qFAAqF;IACrF,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+EAA+E;IAC/E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;IACxC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,sFAAsF;IACtF,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,wCAAwC;IACxC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,EACF,OAAO,GACP,MAAM,GACN,MAAM,GACN,MAAM,GACN,eAAe,GACf,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,UAAU,CAAC;IACf,MAAM,EAAE,WAAW,CAAC;IACpB,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,iDAAiD;AACjD,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,OAAO;IACvC,8CAA8C;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAC;IACb,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oCAAoC;IACpC,IAAI,EAAE,CAAC,CAAC;IACR,2CAA2C;IAC3C,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC9B;AAID;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,cAAc;IAC7B,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sFAAsF;IACtF,OAAO,CAAC,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,wCAAwC;QACxC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,4DAA4D;QAC5D,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;IACF,+DAA+D;IAC/D,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,kEAAkE;IAClE,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC,CAAC;IACF,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,kFAAkF;AAClF,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC;AAE3B,iEAAiE;AACjE,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,YAAY,GACZ,MAAM,GACN,QAAQ,GACR,UAAU,GACV,UAAU,GACV,UAAU,CAAC;AAEf;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,UAAU,GACV,OAAO,CAAC;AAEZ,8EAA8E;AAC9E,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN,KAAK,GACL,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,eAAe,GACf,YAAY,GACZ,KAAK,GACL,MAAM,GACN,SAAS,GACT,SAAS,CAAC;AAEd;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,oBAAoB,YAC/B,KAAK,EACL,aAAa,EACb,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,eAAe,EACf,YAAY,EACZ,KAAK,EACL,MAAM,EACN,SAAS,EACT,WAAW,CACH,CAAC;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtE,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,KAAK,CAAC;IACd,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,MAAM,GACN,cAAc,GACd,KAAK,GACL,MAAM,GACN,UAAU,GACV,SAAS,CAAC;AAEd,wEAAwE;AACxE,MAAM,WAAW,OAAO;IACtB,mEAAmE;IACnE,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,aAAa,CAAC;IACtB;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,+EAA+E;IAC/E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6EAA6E;IAC7E,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gGAAgG;IAChG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACnD,mFAAmF;IACnF,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;IAC9B,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAC3B,SAAS,GACT,SAAS,GACT,wBAAwB,GACxB,oBAAoB,GACpB,UAAU,GACV,SAAS,GACT,eAAe,GACf,qBAAqB,GACrB,OAAO,GACP,kBAAkB,GAClB,OAAO,CAAC;AAEZ;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,kDAAkD;IAClD,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,mEAAmE;AACnE,MAAM,WAAW,sBAAsB;IACrC,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,CAAC;IACzB,6EAA6E;IAC7E,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,yCAAyC;AACzC,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gEAAgE;IAChE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,sEAAsE;IACtE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC3C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,qFAAqF;IACrF,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+EAA+E;IAC/E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;IACxC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,sFAAsF;IACtF,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,wCAAwC;IACxC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,EACF,OAAO,GACP,MAAM,GACN,MAAM,GACN,MAAM,GACN,eAAe,GACf,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,UAAU,CAAC;IACf,MAAM,EAAE,WAAW,CAAC;IACpB,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,iDAAiD;AACjD,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,OAAO;IACvC,8CAA8C;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAC;IACb,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oCAAoC;IACpC,IAAI,EAAE,CAAC,CAAC;IACR,2CAA2C;IAC3C,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC9B;AAID;;;;;;;;;;;;;;;;;;;GAmBG;AACH;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,mDAAmD;IACnD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,oBAAoB;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sFAAsF;IACtF,OAAO,CAAC,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,wCAAwC;QACxC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,4DAA4D;QAC5D,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,oFAAoF;QACpF,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,oEAAoE;QACpE,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC/B,CAAC;IACF,+DAA+D;IAC/D,GAAG,CAAC,EAAE,YAAY,CAAC;IACnB,kEAAkE;IAClE,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,kEAAkE;QAClE,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,iCAAiC;IACjC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uFAAuF;IACvF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gFAAgF;IAChF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonis-agora/payments",
-  "version": "0.16.1",
+  "version": "0.17.0",
   "description": "Billing library for AdonisJS — 18 payment gateways behind one driver contract, with a Cashier-style subscription billing layer: Billable mixin, Lucid stores, idempotent webhook processing and an optional Durable-backed dispatcher. Part of the Agora ecosystem.",
   "license": "MIT",
   "repository": {
@@ -8,6 +8,42 @@
     "url": "git+https://github.com/DavideCarvalho/adonis-agora-payments.git",
     "directory": "packages/adonis"
   },
+  "homepage": "https://davidecarvalho.github.io/agora/docs/payments",
+  "bugs": {
+    "url": "https://github.com/DavideCarvalho/adonis-agora-payments/issues"
+  },
+  "keywords": [
+    "adonisjs",
+    "adonis",
+    "payments",
+    "billing",
+    "subscriptions",
+    "stripe",
+    "adyen",
+    "paypal",
+    "mollie",
+    "razorpay",
+    "square",
+    "paddle",
+    "lemonsqueezy",
+    "polar",
+    "dodo",
+    "abacatepay",
+    "asaas",
+    "woovi",
+    "openpix",
+    "pagarme",
+    "infinitepay",
+    "pagbank",
+    "pagseguro",
+    "efi",
+    "gerencianet",
+    "mercadopago",
+    "pix",
+    "boleto",
+    "dashboard",
+    "agora"
+  ],
   "author": "Davi Carvalho <davi@goflip.ai>",
   "type": "module",
   "main": "./dist/src/index.js",
@@ -133,56 +169,24 @@
   },
   "devDependencies": {
     "@adonis-agora/payments-dashboard": "0.4.0",
-    "@adonisjs/assembler": "^8.5.1",
-    "@adonisjs/core": "7.5.0",
-    "@adonisjs/lucid": "^22.4.2",
-    "@mdx-js/mdx": "^3.1.1",
-    "@testcontainers/postgresql": "^12.1.0",
-    "@types/luxon": "^3.7.5",
-    "@types/node": "^26.4.1",
-    "@types/pg": "^8.23.1",
-    "@woovi/node-sdk": "^1.3.3",
-    "luxon": "^3.7.2",
-    "pg": "^8.23.0",
-    "stripe": "^22.6.1",
-    "typescript": "^7.0.2",
-    "vitest": "5.0.0"
+    "@adonisjs/assembler": "8.5.2",
+    "@adonisjs/core": "7.5.2",
+    "@adonisjs/lucid": "22.4.2",
+    "@mdx-js/mdx": "3.1.1",
+    "@testcontainers/postgresql": "12.2.0",
+    "@types/luxon": "3.7.6",
+    "@types/node": "26.6.4",
+    "@types/pg": "8.23.1",
+    "@woovi/node-sdk": "1.3.3",
+    "luxon": "3.7.2",
+    "pg": "8.23.1",
+    "stripe": "22.6.2",
+    "typescript": "7.0.2",
+    "vitest": "5.0.3"
   },
   "engines": {
     "node": ">=20.6.0"
   },
-  "keywords": [
-    "adonisjs",
-    "adonis",
-    "payments",
-    "billing",
-    "subscriptions",
-    "stripe",
-    "adyen",
-    "paypal",
-    "mollie",
-    "razorpay",
-    "square",
-    "paddle",
-    "lemonsqueezy",
-    "polar",
-    "dodo",
-    "abacatepay",
-    "asaas",
-    "woovi",
-    "openpix",
-    "pagarme",
-    "infinitepay",
-    "pagbank",
-    "pagseguro",
-    "efi",
-    "gerencianet",
-    "mercadopago",
-    "pix",
-    "boleto",
-    "dashboard",
-    "agora"
-  ],
   "scripts": {
     "build": "tsc -p tsconfig.json && pnpm run copy:stubs && pnpm run copy:spa",
     "copy:stubs": "mkdir -p dist/stubs/config dist/stubs/database/migrations dist/stubs/make/billable dist/stubs/make/webhook_handler && cp -r stubs/config/. dist/stubs/config/ && cp -r stubs/database/migrations/. dist/stubs/database/migrations/ && cp -r stubs/make/billable/. dist/stubs/make/billable/ && cp -r stubs/make/webhook_handler/. dist/stubs/make/webhook_handler/",