@abacatepay/types 0.0.4 → 2.0.1

package/dist/v2/routes.d.ts

@@ -0,0 +1,129 @@
+import type { RESTGetListCouponsQueryParams, RESTGetListCustomersQueryParams, RESTGetListPayoutsQueryParams, RESTGetListProductsQueryParams, RESTGetListSubscriptionsQueryParams, RESTGetProductQueryParams } from './rest';
+export declare const Routes: {
+    readonly customers: {
+        /**
+         * POST - https://api.abacatepay.com/v2/customers/create
+         */
+        readonly create: "/customers/create";
+        /**
+         * GET - https://api.abacatepay.com/v2/customers/list
+         */
+        readonly list: ({ page, limit }?: RESTGetListCustomersQueryParams) => `/customers/list?page=${number}&limit=${number}`;
+        /**
+         * GET - https://api.abacatepay.com/v2/customers/get
+         */
+        readonly get: (id: string) => `/customers/get?id=${string}`;
+        /**
+         * DELETE - https://api.abacatepay.com/v2/customers/delete
+         */
+        readonly delete: "/customers/delete";
+    };
+    readonly checkouts: {
+        /**
+         * POST - https://api.abacatepay.com/v2/checkouts/create
+         */
+        readonly create: "/checkouts/create";
+        /**
+         * GET - https://api.abacatepay.com/v2/checkouts/list
+         */
+        readonly list: "/checkouts/list";
+        /**
+         * GET - https://api.abacatepay.com/v2/checkouts/get
+         */
+        readonly get: (id: string) => `/checkouts/get?id=${string}`;
+    };
+    readonly transparents: {
+        /**
+         * POST - https://api.abacatepay.com/v2/transparents/create
+         */
+        readonly createQRCode: "/transparents/create";
+        /**
+         * POST - https://api.abacatepay.com/v2/transparents/simulate-payment
+         */
+        readonly simulatePayment: (id: string) => `/transparents/simulate-payment?id=${string}`;
+        /**
+         * GET - https://api.abacatepay.com/v2/transparents/check
+         */
+        readonly checkStatus: (id: string) => `/transparents/check?id=${string}`;
+    };
+    readonly coupons: {
+        /**
+         * POST - https://api.abacatepay.com/v2/coupons/create
+         */
+        readonly create: "/coupons/create";
+        /**
+         * GET - https://api.abacatepay.com/v2/coupons/list
+         */
+        readonly list: ({ page, limit }?: RESTGetListCouponsQueryParams) => `/coupons/list?page=${number}&limit=${number}`;
+        /**
+         * GET - https://api.abacatepay.com/v2/coupons/get
+         */
+        readonly get: (id: string) => `/coupons/get?id=${string}`;
+        /**
+         * DELETE - https://api.abacatepay.com/v2/coupons/delete
+         */
+        readonly delete: "/coupons/delete";
+        /**
+         * PATCH - https://api.abacatepay.com/v2/coupons/toggle
+         */
+        readonly toggleStatus: "/coupons/toggle";
+    };
+    readonly payouts: {
+        /**
+         * POST - https://api.abacatepay.com/v2/payouts/create
+         */
+        readonly create: "/payouts/create";
+        /**
+         * GET - https://api.abacatepay.com/v2/payouts/get
+         */
+        readonly get: (externalId: string) => `/payouts/get?externalId=${string}`;
+        /**
+         * GET - https://api.abacatepay.com/v2/payouts/list
+         */
+        readonly list: ({ page, limit }?: RESTGetListPayoutsQueryParams) => string;
+    };
+    readonly store: {
+        /**
+         * GET - https://api.abacatepay.com/v2/store/get
+         */
+        readonly get: "/store/get";
+    };
+    readonly mrr: {
+        /**
+         * GET - https://api.abacatepay.com/v2/public-mrr/mrr
+         */
+        readonly get: "/public-mrr/mrr";
+        /**
+         * GET - https://api.abacatepay.com/v2/public-mrr/merchant-info
+         */
+        readonly merchant: "/public-mrr/merchant-info";
+        /**
+         * GET - https://api.abacatepay.com/v2/public-mrr/renevue
+         */
+        readonly revenue: (start: string, end: string) => `/public-mrr/revenue?startDate=${string}&endDate=${string}`;
+    };
+    readonly subscriptions: {
+        /**
+         * POST - https://api.abacatepay.com/v2/subscriptions/create
+         */
+        readonly create: "/subscriptions/create";
+        /**
+         * GET - https://api.abacatepay.com/v2/subscriptions/list
+         */
+        readonly list: ({ cursor, limit }?: RESTGetListSubscriptionsQueryParams) => `/subscriptions/list?${string}`;
+    };
+    readonly products: {
+        /**
+         * POST - https://api.abacatepay.com/v2/products/create
+         */
+        readonly create: "/products/create";
+        /**
+         * GET - https://api.abacatepay.com/v2/products/list
+         */
+        readonly list: ({ page, limit }?: RESTGetListProductsQueryParams) => `/products/list?page=${number}&limit=${number}`;
+        /**
+         * GET - https://api.abacatepay.com/v2/products/get
+         */
+        readonly get: ({ id, externalId }?: RESTGetProductQueryParams) => `/products/get?${string}`;
+    };
+};

package/dist/v2/routes.js

@@ -0,0 +1,162 @@
+export const Routes = {
+    customers: {
+        /**
+         * POST - https://api.abacatepay.com/v2/customers/create
+         */
+        create: '/customers/create',
+        /**
+         * GET - https://api.abacatepay.com/v2/customers/list
+         */
+        list({ page = 1, limit = 20 } = {}) {
+            return `/customers/list?page=${page}&limit=${limit}`;
+        },
+        /**
+         * GET - https://api.abacatepay.com/v2/customers/get
+         */
+        get(id) {
+            return `/customers/get?id=${id}`;
+        },
+        /**
+         * DELETE - https://api.abacatepay.com/v2/customers/delete
+         */
+        delete: '/customers/delete',
+    },
+    checkouts: {
+        /**
+         * POST - https://api.abacatepay.com/v2/checkouts/create
+         */
+        create: '/checkouts/create',
+        /**
+         * GET - https://api.abacatepay.com/v2/checkouts/list
+         */
+        list: '/checkouts/list',
+        /**
+         * GET - https://api.abacatepay.com/v2/checkouts/get
+         */
+        get(id) {
+            return `/checkouts/get?id=${id}`;
+        },
+    },
+    transparents: {
+        /**
+         * POST - https://api.abacatepay.com/v2/transparents/create
+         */
+        createQRCode: '/transparents/create',
+        /**
+         * POST - https://api.abacatepay.com/v2/transparents/simulate-payment
+         */
+        simulatePayment(id) {
+            return `/transparents/simulate-payment?id=${id}`;
+        },
+        /**
+         * GET - https://api.abacatepay.com/v2/transparents/check
+         */
+        checkStatus(id) {
+            return `/transparents/check?id=${id}`;
+        },
+    },
+    coupons: {
+        /**
+         * POST - https://api.abacatepay.com/v2/coupons/create
+         */
+        create: '/coupons/create',
+        /**
+         * GET - https://api.abacatepay.com/v2/coupons/list
+         */
+        list({ page = 1, limit = 20 } = {}) {
+            return `/coupons/list?page=${page}&limit=${limit}`;
+        },
+        /**
+         * GET - https://api.abacatepay.com/v2/coupons/get
+         */
+        get(id) {
+            return `/coupons/get?id=${id}`;
+        },
+        /**
+         * DELETE - https://api.abacatepay.com/v2/coupons/delete
+         */
+        delete: '/coupons/delete',
+        /**
+         * PATCH - https://api.abacatepay.com/v2/coupons/toggle
+         */
+        toggleStatus: '/coupons/toggle',
+    },
+    payouts: {
+        /**
+         * POST - https://api.abacatepay.com/v2/payouts/create
+         */
+        create: '/payouts/create',
+        /**
+         * GET - https://api.abacatepay.com/v2/payouts/get
+         */
+        get(externalId) {
+            return `/payouts/get?externalId=${externalId}`;
+        },
+        /**
+         * GET - https://api.abacatepay.com/v2/payouts/list
+         */
+        list({ page = 1, limit = 20 } = {}) {
+            return `/payouts/list?page=${page}&limit=${limit}`;
+        },
+    },
+    store: {
+        /**
+         * GET - https://api.abacatepay.com/v2/store/get
+         */
+        get: '/store/get',
+    },
+    mrr: {
+        /**
+         * GET - https://api.abacatepay.com/v2/public-mrr/mrr
+         */
+        get: '/public-mrr/mrr',
+        /**
+         * GET - https://api.abacatepay.com/v2/public-mrr/merchant-info
+         */
+        merchant: '/public-mrr/merchant-info',
+        /**
+         * GET - https://api.abacatepay.com/v2/public-mrr/renevue
+         */
+        revenue(start, end) {
+            return `/public-mrr/revenue?startDate=${start}&endDate=${end}`;
+        },
+    },
+    subscriptions: {
+        /**
+         * POST - https://api.abacatepay.com/v2/subscriptions/create
+         */
+        create: '/subscriptions/create',
+        /**
+         * GET - https://api.abacatepay.com/v2/subscriptions/list
+         */
+        list({ cursor, limit = 20 } = {}) {
+            const query = new URLSearchParams({ limit: `${limit}` });
+            if (cursor)
+                query.append('cursor', cursor);
+            return `/subscriptions/list?${query}`;
+        },
+    },
+    products: {
+        /**
+         * POST - https://api.abacatepay.com/v2/products/create
+         */
+        create: '/products/create',
+        /**
+         * GET - https://api.abacatepay.com/v2/products/list
+         */
+        list({ page = 1, limit = 20 } = {}) {
+            return `/products/list?page=${page}&limit=${limit}`;
+        },
+        /**
+         * GET - https://api.abacatepay.com/v2/products/get
+         */
+        get({ id, externalId } = {}) {
+            const query = new URLSearchParams();
+            if (id)
+                query.append('id', id);
+            if (externalId)
+                query.append('externalId', externalId);
+            return `/products/get?${query}`;
+        },
+    },
+};

package/dist/v2/utils.d.ts

@@ -0,0 +1,26 @@
+import { type WebhookEvent } from './webhook';
+/**
+ * A type guard check for `payout.done` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a payout done webhook.
+ */
+export declare function isPayoutDoneWebhookEvent(event: WebhookEvent): event is import("./webhook").WebhookPayoutDoneEvent;
+/**
+ * A type guard check for `payout.failed` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a payout failed webhook.
+ */
+export declare function isPayoutFailedWebhookEvent(event: WebhookEvent): event is import("./webhook").WebhookPayoutFailedEvent;
+/**
+ * A type guard check for `billing.paid` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a billing paid webhook.
+ */
+export declare function isBillingPaidWebhookEvent(event: WebhookEvent): event is import("./webhook").WebhookBillingPaidEvent;
+/**
+ * Verify whether the signature is valid or not.
+ * @param raw Raw body response (string).
+ * @param signature The content of the`X-Webhook-Signature` header.
+ * @returns A boolean that indicates if the signature is valid.
+ */
+export declare const verifyWebhookSignature: (raw: string, signature: string) => boolean;

package/dist/v2/utils.js

@@ -0,0 +1,42 @@
+import { createHmac, timingSafeEqual } from 'node:crypto';
+import { WebhookEventType } from './webhook';
+/**
+ * A type guard check for `payout.done` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a payout done webhook.
+ */
+export function isPayoutDoneWebhookEvent(event) {
+    return event.event === WebhookEventType.PayoutDone;
+}
+/**
+ * A type guard check for `payout.failed` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a payout failed webhook.
+ */
+export function isPayoutFailedWebhookEvent(event) {
+    return event.event === WebhookEventType.PayoutFailed;
+}
+/**
+ * A type guard check for `billing.paid` webhook events.
+ * @param event - The webhook event to check against.
+ * @returns A boolean that indicates if the webhook is a billing paid webhook.
+ */
+export function isBillingPaidWebhookEvent(event) {
+    return event.event === WebhookEventType.BillingPaid;
+}
+const ABACATEPAY_PUBLIC_KEY = 't9dXRhHHo3yDEj5pVDYz0frf7q6bMKyMRmxxCPIPp3RCplBfXRxqlC6ZpiWmOqj4L63qEaeUOtrCI8P0VMUgo6iIga2ri9ogaHFs0WIIywSMg0q7RmBfybe1E5XJcfC4IW3alNqym0tXoAKkzvfEjZxV6bE0oG2zJrNNYmUCKZyV0KZ3JS8Votf9EAWWYdiDkMkpbMdPggfh1EqHlVkMiTady6jOR3hyzGEHrIz2Ret0xHKMbiqkr9HS1JhNHDX9';
+/**
+ * Verify whether the signature is valid or not.
+ * @param raw Raw body response (string).
+ * @param signature The content of the`X-Webhook-Signature` header.
+ * @returns A boolean that indicates if the signature is valid.
+ */
+export const verifyWebhookSignature = (raw, signature) => {
+    const bodyBuffer = Buffer.from(raw, 'utf8');
+    const expectedSig = createHmac('sha256', ABACATEPAY_PUBLIC_KEY)
+        .update(bodyBuffer)
+        .digest('base64');
+    const A = Buffer.from(expectedSig);
+    const B = Buffer.from(signature);
+    return A.length === B.length && timingSafeEqual(A, B);
+};

package/dist/v2/webhook.d.ts

@@ -0,0 +1,135 @@
+import type { APIPayout, PaymentMethod, PaymentStatus, PayoutStatus } from '.';
+export interface BaseWebhookEvent<Type extends WebhookEventType, Data extends object> {
+    /**
+     * The data received in the event.
+     */
+    data: Data;
+    /**
+     * Unique identifier for the webhook.
+     */
+    id: string;
+    /**
+     * This field identifies the type of event received.
+     */
+    event: Type;
+    /**
+     * Indicates whether the event occurred in the development environment.
+     */
+    devMode: boolean;
+}
+/**
+ * https://docs.abacatepay.com/pages/webhooks#payout-failed
+ */
+export type WebhookPayoutFailedEvent = BaseWebhookEvent<WebhookEventType.PayoutFailed, {
+    /**
+     * Transaction data.
+     */
+    transaction: Omit<APIPayout, 'status'> & {
+        /**
+         * Status of the payout. Always `PayoutStatus.Cancelled`.
+         *
+         * @see {@link PayoutStatus.Cancelled}
+         */
+        status: PayoutStatus.Cancelled;
+    };
+}>;
+/**
+ * https://docs.abacatepay.com/pages/webhooks#payout-done
+ */
+export type WebhookPayoutDoneEvent = BaseWebhookEvent<WebhookEventType.PayoutDone, {
+    /**
+     * Transaction data.
+     */
+    transaction: Omit<APIPayout, 'status'> & {
+        /**
+         * Status of the payout. Always `PayoutStatus.Complete`.
+         *
+         * @see {@link PayoutStatus.Complete}
+         */
+        status: PayoutStatus.Complete;
+    };
+}>;
+/**
+ * https://docs.abacatepay.com/pages/webhooks#billing-paid
+ */
+export type WebhookBillingPaidEvent = BaseWebhookEvent<WebhookEventType.BillingPaid, {
+    /**
+     * Payment data.
+     */
+    payment: {
+        /**
+         * Charge amount in cents (e.g. 4000 = R$40.00).
+         */
+        amount: number;
+        /**
+         * The fee charged by AbacatePay.
+         */
+        fee: 80;
+        /**
+         * Payment method.
+         *
+         * @see {@link PaymentMethod}
+         */
+        method: PaymentMethod;
+    };
+} & ({
+    pixQrCode: {
+        /**
+         * Charge amount in cents (e.g. 4000 = R$40.00).
+         */
+        amount: number;
+        /**
+         * Unique billing identifier.
+         */
+        id: string;
+        /**
+         * Kind of the payment.
+         */
+        kind: 'PIX';
+        /**
+         * Billing status, can only be `PAID` here.
+         *
+         * @see {@link PaymentStatus.Paid}
+         */
+        status: PaymentStatus.Paid;
+    };
+} | {
+    billing: {
+        /**
+         * Charge amount in cents (e.g. 4000 = R$40.00).
+         */
+        amount: number;
+        /**
+         * Unique billing identifier.
+         */
+        id: string;
+        /**
+         * Bill ID in your system.
+         */
+        externalId: string;
+        /**
+         * Status of the payment. Always `PaymentStatus.Paid`.
+         *
+         * @see {@link PaymentStatus.Paid}
+         */
+        status: PaymentStatus.Paid;
+        /**
+         * URL where the user can complete the payment.
+         */
+        url: string;
+    };
+})>;
+/**
+ * https://docs.abacatepay.com/pages/webhooks
+ *
+ * Any field that contains the tag "@unstable" means that the field is an assumption, it is uncertain (Since AbacatePay does not provide any information about).
+ */
+export type WebhookEvent = WebhookPayoutDoneEvent | WebhookPayoutFailedEvent | WebhookBillingPaidEvent;
+/**
+ * https://docs.abacatepay.com/pages/webhooks
+ */
+export declare enum WebhookEventType {
+    PayoutFailed = "payout.failed",
+    PayoutDone = "payout.done",
+    BillingPaid = "billing.paid"
+}

package/dist/v2/webhook.js

@@ -0,0 +1,9 @@
+/**
+ * https://docs.abacatepay.com/pages/webhooks
+ */
+export var WebhookEventType;
+(function (WebhookEventType) {
+    WebhookEventType["PayoutFailed"] = "payout.failed";
+    WebhookEventType["PayoutDone"] = "payout.done";
+    WebhookEventType["BillingPaid"] = "billing.paid";
+})(WebhookEventType || (WebhookEventType = {}));

package/dist/version.d.ts

@@ -1,2 +1,8 @@
-export declare const version: "0.0.4";
-export declare const API_VERSION: "1";
+/**
+ * Current version of [@abacatepay/types](https://www.npmjs.com/package/@abacatepay/types).
+ */
+export declare const version: "2.0.1";
+/**
+ * Current version of the AbacatePay API
+ */
+export declare const API_VERSION: "2";

package/dist/version.js

@@ -1,4 +1,9 @@
-// Auto-generated in build (DO NOT edit)
-export const version = '0.0.4';
-// Current AbacatePay API version - https://docs.abacatepay.com/pages/introduction
-export const API_VERSION = '1';
+// AUTO-GENERATED — DO NOT EDIT
+/**
+ * Current version of [@abacatepay/types](https://www.npmjs.com/package/@abacatepay/types).
+ */
+export const version = '2.0.1';
+/**
+ * Current version of the AbacatePay API
+ */
+export const API_VERSION = '2';

package/package.json

@@ -1,10 +1,11 @@
 {
-	"version": "0.0.4",
+	"version": "2.0.1",
 	"name": "@abacatepay/types",
 	"description": "Abacate Pay API typings that are always up to date.",
 	"type": "module",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
+	"license": "Apache-2.0",
 	"exports": {
 		".": {
 			"import": "./dist/index.js",
@@ -13,12 +14,28 @@
 		"./v1": {
 			"import": "./dist/v1/index.js",
 			"types": "./dist/v1/index.d.ts"
-		}
+		},
+		"./v1/*": {
+			"import": "./dist/v1/*.js",
+			"types": "./dist/v1/*.d.ts"
+		},
+		"./v2": {
+			"import": "./dist/v2/index.js",
+			"types": "./dist/v2/index.d.ts"
+		},
+		"./v2/*": {
+			"import": "./dist/v2/*.js",
+			"types": "./dist/v2/*.d.ts"
+		},
+		"./v*": null
 	},
 	"typesVersions": {
 		"*": {
 			"v1": [
 				"dist/v1/index.d.ts"
+			],
+			"v2": [
+				"dist/v2/index.d.ts"
 			]
 		}
 	},
@@ -26,10 +43,10 @@
 		"dist"
 	],
 	"scripts": {
-		"gen:version": "bun run scripts/version.ts",
 		"build": "bun run gen:version && tsc",
 		"prepublishOnly": "bun run build",
-		"fmt": "bunx biome check --write types && clear"
+		"gen:version": "bun run scripts/version.ts",
+		"fmt": "bunx biome check --write package.json types && clear"
 	},
 	"devDependencies": {
 		"@biomejs/biome": "^2.3.8",
@@ -43,5 +60,9 @@
 	],
 	"publishConfig": {
 		"access": "public"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/almeidazs/ecosystem"
 	}
 }