@paykit-sdk/comgate 1.0.0

package/dist/schema.d.mts

@@ -0,0 +1,265 @@
+interface ComgateWebhookResponse {
+    /**
+     * The transaction ID
+     */
+    transId: string;
+    /**
+     * The merchant ID
+     */
+    merchant: string;
+    /**
+     * Whether the transaction is in test mode
+     */
+    test: boolean;
+    /**
+     * The price
+     */
+    price: number;
+    /**
+     * The currency of the payment
+     */
+    curr: string;
+    /**
+     * The label of the payment
+     */
+    label: string;
+    /**
+     * The reference ID
+     */
+    refId: string;
+    /**
+     * The payer ID
+     */
+    payerId?: string;
+    /**
+     * The payer name
+     */
+    payerName?: string;
+    /**
+     * The payer account of the payment
+     */
+    payerAcc?: string;
+    /**
+     * The method of the payment
+     */
+    method?: string;
+    /**
+     * The account of the payment
+     */
+    account?: string;
+    /**
+     * The email of the payment
+     */
+    email: string;
+    /**
+     * The phone of the payment
+     */
+    phone?: string;
+    /**
+     * The name of the payment
+     */
+    name?: string;
+    /**
+     * The secret of the payment
+     */
+    secret: string;
+    /**
+     * The status of the payment
+     */
+    status: 'PAID' | 'CANCELLED' | 'AUTHORIZED';
+    /**
+     * The fee of the payment
+     */
+    fee?: string;
+    /**
+     * The full name of the payment
+     */
+    fullName: string;
+    /**
+     * The billing address city of the payment
+     */
+    billingAddrCity?: string;
+    /**
+     * The billing address street of the payment
+     */
+    billingAddrStreet?: string;
+    /**
+     * The billing address postal code of the payment
+     */
+    billingAddrPostalCode?: string;
+    /**
+     * The billing address country of the payment
+     */
+    billingAddrCountry?: string;
+    /**
+     * The delivery of the payment
+     */
+    delivery?: 'HOME_DELIVERY' | 'PICKUP' | 'ELECTRONIC_DELIVERY';
+    /**
+     * The home delivery city of the payment
+     */
+    homeDeliveryCity?: string;
+    /**
+     * The home delivery street of the payment
+     */
+    homeDeliveryStreet?: string;
+    /**
+     * The home delivery postal code of the payment
+     */
+    homeDeliveryPostalCode?: string;
+    /**
+     * The home delivery country of the payment
+     */
+    homeDeliveryCountry?: string;
+    /**
+     * The category of the payment
+     */
+    category?: 'PHYSICAL_GOODS_ONLY' | 'OTHER';
+    /**
+     * The applied fee of the payment
+     */
+    appliedFee?: number;
+    /**
+     * The applied fee type of the payment
+     */
+    appliedFeeType?: 'EU_UNREGULATED' | 'NON_EU_BUSINESS' | 'NON_EU_CONSUMER' | 'EU_CONSUMER';
+}
+interface ComgateWebhookStatusResponseBase {
+    /**
+     * The code of the response
+     */
+    code: 0 | 1100 | 1200 | 1400 | 1500;
+    message: string;
+}
+interface ComgateWebhookStatusSuccessResponse extends ComgateWebhookStatusResponseBase {
+    /**
+     * The code of the response
+     */
+    code: 0;
+    /**
+     * The merchant of the response
+     */
+    merchant: string;
+    /**
+     * String value of `true` or `false`
+     */
+    test: string;
+    /**
+     * Price of the product in cents or pennies
+     */
+    price: number;
+    /**
+     * Currency code according to ISO 4217
+     */
+    curr: string;
+    /**
+     * The label of the product
+     */
+    label: string;
+    /**
+     * The reference ID of the product
+     */
+    refId: string;
+    /**
+     * The payer ID of the product
+     */
+    payerId?: string;
+    /**
+     * The method of the product
+     */
+    method?: string;
+    /**
+     * The account of the product
+     */
+    account?: string;
+    /**
+     * Payer's contact e-mail
+     */
+    email: string;
+    /**
+     * The name of the product
+     */
+    name?: string;
+    /**
+     * The phone of the product
+     */
+    phone?: string;
+    /**
+     * The transaction ID of the product
+     */
+    transId: string;
+    /**
+     * The secret of the product
+     */
+    secret: string;
+    /**
+     * The status of the product
+     */
+    status: 'PAID' | 'CANCELLED' | 'AUTHORIZED' | 'PENDING';
+    /**
+     * The payer name of the product
+     */
+    payerName?: string;
+    /**
+     * The payer account of the product
+     */
+    payerAcc?: string;
+    /**
+     * The fee of the product
+     */
+    fee?: string;
+    /**
+     * The vs of the product
+     */
+    vs?: string;
+    /**
+     * The card valid of the product
+     */
+    cardValid?: string;
+    /**
+     * The card number of the product
+     */
+    cardNumber?: string;
+    /**
+     * The applied fee of the product
+     */
+    appliedFee?: number;
+    /**
+     * The applied fee type of the product
+     */
+    appliedFeeType?: 'EU_UNREGULATED' | 'NON_EU_BUSINESS' | 'NON_EU_CONSUMER' | 'EU_CONSUMER';
+    /**
+     * The payment error reason of the product
+     */
+    paymentErrorReason?: string;
+}
+interface ComgateRefundResponse {
+    /**
+     * The code of the response
+     */
+    code: 0;
+    /**
+     * The message of the response
+     */
+    message: string;
+}
+interface ComgatePaymentOperationResponse {
+    /**
+     * The code of the response
+     */
+    code: number;
+    /**
+     * The message of the response
+     */
+    message: string;
+    /**
+     * The transaction ID of the response
+     */
+    transId?: string;
+    /**
+     * The redirect of the response
+     */
+    redirect?: string;
+}
+
+export type { ComgatePaymentOperationResponse, ComgateRefundResponse, ComgateWebhookResponse, ComgateWebhookStatusResponseBase, ComgateWebhookStatusSuccessResponse };

package/dist/schema.d.ts

@@ -0,0 +1,265 @@
+interface ComgateWebhookResponse {
+    /**
+     * The transaction ID
+     */
+    transId: string;
+    /**
+     * The merchant ID
+     */
+    merchant: string;
+    /**
+     * Whether the transaction is in test mode
+     */
+    test: boolean;
+    /**
+     * The price
+     */
+    price: number;
+    /**
+     * The currency of the payment
+     */
+    curr: string;
+    /**
+     * The label of the payment
+     */
+    label: string;
+    /**
+     * The reference ID
+     */
+    refId: string;
+    /**
+     * The payer ID
+     */
+    payerId?: string;
+    /**
+     * The payer name
+     */
+    payerName?: string;
+    /**
+     * The payer account of the payment
+     */
+    payerAcc?: string;
+    /**
+     * The method of the payment
+     */
+    method?: string;
+    /**
+     * The account of the payment
+     */
+    account?: string;
+    /**
+     * The email of the payment
+     */
+    email: string;
+    /**
+     * The phone of the payment
+     */
+    phone?: string;
+    /**
+     * The name of the payment
+     */
+    name?: string;
+    /**
+     * The secret of the payment
+     */
+    secret: string;
+    /**
+     * The status of the payment
+     */
+    status: 'PAID' | 'CANCELLED' | 'AUTHORIZED';
+    /**
+     * The fee of the payment
+     */
+    fee?: string;
+    /**
+     * The full name of the payment
+     */
+    fullName: string;
+    /**
+     * The billing address city of the payment
+     */
+    billingAddrCity?: string;
+    /**
+     * The billing address street of the payment
+     */
+    billingAddrStreet?: string;
+    /**
+     * The billing address postal code of the payment
+     */
+    billingAddrPostalCode?: string;
+    /**
+     * The billing address country of the payment
+     */
+    billingAddrCountry?: string;
+    /**
+     * The delivery of the payment
+     */
+    delivery?: 'HOME_DELIVERY' | 'PICKUP' | 'ELECTRONIC_DELIVERY';
+    /**
+     * The home delivery city of the payment
+     */
+    homeDeliveryCity?: string;
+    /**
+     * The home delivery street of the payment
+     */
+    homeDeliveryStreet?: string;
+    /**
+     * The home delivery postal code of the payment
+     */
+    homeDeliveryPostalCode?: string;
+    /**
+     * The home delivery country of the payment
+     */
+    homeDeliveryCountry?: string;
+    /**
+     * The category of the payment
+     */
+    category?: 'PHYSICAL_GOODS_ONLY' | 'OTHER';
+    /**
+     * The applied fee of the payment
+     */
+    appliedFee?: number;
+    /**
+     * The applied fee type of the payment
+     */
+    appliedFeeType?: 'EU_UNREGULATED' | 'NON_EU_BUSINESS' | 'NON_EU_CONSUMER' | 'EU_CONSUMER';
+}
+interface ComgateWebhookStatusResponseBase {
+    /**
+     * The code of the response
+     */
+    code: 0 | 1100 | 1200 | 1400 | 1500;
+    message: string;
+}
+interface ComgateWebhookStatusSuccessResponse extends ComgateWebhookStatusResponseBase {
+    /**
+     * The code of the response
+     */
+    code: 0;
+    /**
+     * The merchant of the response
+     */
+    merchant: string;
+    /**
+     * String value of `true` or `false`
+     */
+    test: string;
+    /**
+     * Price of the product in cents or pennies
+     */
+    price: number;
+    /**
+     * Currency code according to ISO 4217
+     */
+    curr: string;
+    /**
+     * The label of the product
+     */
+    label: string;
+    /**
+     * The reference ID of the product
+     */
+    refId: string;
+    /**
+     * The payer ID of the product
+     */
+    payerId?: string;
+    /**
+     * The method of the product
+     */
+    method?: string;
+    /**
+     * The account of the product
+     */
+    account?: string;
+    /**
+     * Payer's contact e-mail
+     */
+    email: string;
+    /**
+     * The name of the product
+     */
+    name?: string;
+    /**
+     * The phone of the product
+     */
+    phone?: string;
+    /**
+     * The transaction ID of the product
+     */
+    transId: string;
+    /**
+     * The secret of the product
+     */
+    secret: string;
+    /**
+     * The status of the product
+     */
+    status: 'PAID' | 'CANCELLED' | 'AUTHORIZED' | 'PENDING';
+    /**
+     * The payer name of the product
+     */
+    payerName?: string;
+    /**
+     * The payer account of the product
+     */
+    payerAcc?: string;
+    /**
+     * The fee of the product
+     */
+    fee?: string;
+    /**
+     * The vs of the product
+     */
+    vs?: string;
+    /**
+     * The card valid of the product
+     */
+    cardValid?: string;
+    /**
+     * The card number of the product
+     */
+    cardNumber?: string;
+    /**
+     * The applied fee of the product
+     */
+    appliedFee?: number;
+    /**
+     * The applied fee type of the product
+     */
+    appliedFeeType?: 'EU_UNREGULATED' | 'NON_EU_BUSINESS' | 'NON_EU_CONSUMER' | 'EU_CONSUMER';
+    /**
+     * The payment error reason of the product
+     */
+    paymentErrorReason?: string;
+}
+interface ComgateRefundResponse {
+    /**
+     * The code of the response
+     */
+    code: 0;
+    /**
+     * The message of the response
+     */
+    message: string;
+}
+interface ComgatePaymentOperationResponse {
+    /**
+     * The code of the response
+     */
+    code: number;
+    /**
+     * The message of the response
+     */
+    message: string;
+    /**
+     * The transaction ID of the response
+     */
+    transId?: string;
+    /**
+     * The redirect of the response
+     */
+    redirect?: string;
+}
+
+export type { ComgatePaymentOperationResponse, ComgateRefundResponse, ComgateWebhookResponse, ComgateWebhookStatusResponseBase, ComgateWebhookStatusSuccessResponse };

package/dist/schema.js

@@ -0,0 +1,2 @@
+'use strict';
+

package/dist/schema.mjs

@@ -0,0 +1 @@
+

package/dist/utils/mapper.d.mts

@@ -0,0 +1,7 @@
+import { Payment, Invoice } from '@paykit-sdk/core';
+import { ComgateWebhookStatusSuccessResponse } from '../schema.mjs';
+
+declare const paykitPayment$InboundSchema: (webhookResponse: ComgateWebhookStatusSuccessResponse, status: Payment["status"]) => Payment;
+declare const paykitInvoice$InboundSchema: (webhookResponse: ComgateWebhookStatusSuccessResponse) => Invoice;
+
+export { paykitInvoice$InboundSchema, paykitPayment$InboundSchema };

package/dist/utils/mapper.d.ts

@@ -0,0 +1,7 @@
+import { Payment, Invoice } from '@paykit-sdk/core';
+import { ComgateWebhookStatusSuccessResponse } from '../schema.js';
+
+declare const paykitPayment$InboundSchema: (webhookResponse: ComgateWebhookStatusSuccessResponse, status: Payment["status"]) => Payment;
+declare const paykitInvoice$InboundSchema: (webhookResponse: ComgateWebhookStatusSuccessResponse) => Invoice;
+
+export { paykitInvoice$InboundSchema, paykitPayment$InboundSchema };

package/dist/utils/mapper.js

@@ -0,0 +1,39 @@
+'use strict';
+
+var core = require('@paykit-sdk/core');
+
+// src/utils/mapper.ts
+var paykitPayment$InboundSchema = (webhookResponse, status) => {
+  return {
+    id: webhookResponse.transId,
+    amount: webhookResponse.price,
+    currency: webhookResponse.curr,
+    customer: webhookResponse.payerId ?? { email: webhookResponse.email },
+    status,
+    metadata: core.omitInternalMetadata(JSON.parse(webhookResponse.refId)),
+    product_id: null
+  };
+};
+var paykitInvoice$InboundSchema = (webhookResponse) => {
+  const status = (() => {
+    if (webhookResponse.status == "PAID") return "paid";
+    return "open";
+  })();
+  return {
+    id: webhookResponse.transId,
+    status,
+    paid_at: (/* @__PURE__ */ new Date()).toISOString(),
+    amount_paid: webhookResponse.price,
+    currency: webhookResponse.curr,
+    customer: webhookResponse.payerId ?? { email: webhookResponse.email },
+    custom_fields: null,
+    subscription_id: null,
+    billing_mode: "one_time",
+    // comgate does not support recurring payments
+    line_items: webhookResponse.name ? [{ id: webhookResponse.name, quantity: 1 }] : [],
+    metadata: core.omitInternalMetadata(JSON.parse(webhookResponse.refId))
+  };
+};
+
+exports.paykitInvoice$InboundSchema = paykitInvoice$InboundSchema;
+exports.paykitPayment$InboundSchema = paykitPayment$InboundSchema;

package/dist/utils/mapper.mjs

@@ -0,0 +1,36 @@
+import { omitInternalMetadata } from '@paykit-sdk/core';
+
+// src/utils/mapper.ts
+var paykitPayment$InboundSchema = (webhookResponse, status) => {
+  return {
+    id: webhookResponse.transId,
+    amount: webhookResponse.price,
+    currency: webhookResponse.curr,
+    customer: webhookResponse.payerId ?? { email: webhookResponse.email },
+    status,
+    metadata: omitInternalMetadata(JSON.parse(webhookResponse.refId)),
+    product_id: null
+  };
+};
+var paykitInvoice$InboundSchema = (webhookResponse) => {
+  const status = (() => {
+    if (webhookResponse.status == "PAID") return "paid";
+    return "open";
+  })();
+  return {
+    id: webhookResponse.transId,
+    status,
+    paid_at: (/* @__PURE__ */ new Date()).toISOString(),
+    amount_paid: webhookResponse.price,
+    currency: webhookResponse.curr,
+    customer: webhookResponse.payerId ?? { email: webhookResponse.email },
+    custom_fields: null,
+    subscription_id: null,
+    billing_mode: "one_time",
+    // comgate does not support recurring payments
+    line_items: webhookResponse.name ? [{ id: webhookResponse.name, quantity: 1 }] : [],
+    metadata: omitInternalMetadata(JSON.parse(webhookResponse.refId))
+  };
+};
+
+export { paykitInvoice$InboundSchema, paykitPayment$InboundSchema };

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@paykit-sdk/comgate",
+  "version": "1.0.0",
+  "description": "Comgate provider for PayKit",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "prepublishOnly": "rm -rf dist && npm run build"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "peerDependencies": {
+    "@paykit-sdk/core": ">=1.1.9"
+  },
+  "devDependencies": {
+    "@paykit-sdk/core": "workspace:*",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.2",
+    "zod": "^3.24.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/usepaykit/paykit-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/usepaykit/paykit-sdk/issues"
+  }
+}