@paykit-sdk/gopay 1.0.5 → 1.1.2

package/dist/schema.d.mts

@@ -1,18 +1,4 @@
-interface GoPayTokenResponse {
-    /**
-     * The type of the token
-     */
-    token_type: string;
-    /**
-     * The access token
-     */
-    access_token: string;
-    /**
-     * The expiry time of the token
-     */
-    expires_in: number;
-}
-interface GoPayPaymentResponse {
+interface GoPayPaymentBaseResponse {
     /**
      * The ID of the payment
      */
@@ -25,10 +11,6 @@ interface GoPayPaymentResponse {
      * The state of the payment
      */
     state: 'CREATED' | 'PAYMENT_METHOD_CHOSEN' | 'PAID' | 'AUTHORIZED' | 'CANCELED' | 'TIMEOUTED' | 'REFUNDED' | 'PARTIALLY_REFUNDED';
-    /**
-     * The sub state of the payment
-     */
-    sub_state?: string;
     /**
      * The amount of the payment
      */
@@ -37,64 +19,86 @@ interface GoPayPaymentResponse {
      * The currency of the payment
      */
     currency: string;
-    /**
-     * The payment instrument of the payment
-     */
-    payment_instrument?: string;
     /**
      * The payer of the payment
      */
-    payer?: any;
+    payer: {
+        /**
+         * The allowed payment instruments of the payer
+         */
+        allowed_payment_instruments: string[];
+        /**
+         * The default payment instrument of the payer
+         */
+        default_payment_instrument: string;
+        /**
+         * The contact of the payer
+         */
+        contact: {
+            email: string;
+        };
+    };
     /**
      * The target of the payment
      */
-    target?: any;
-    /**
-     * The recurrence of the payment
-     */
-    recurrence?: {
+    target: {
         /**
-         * The recurrence cycle of the payment
+         * The type of the target
          */
-        recurrence_cycle?: string;
+        type: 'ACCOUNT';
         /**
-         * The state of the recurrence e.g (STOPPED)
+         * The GoID of the target
          */
-        recurrence_state?: string;
+        goid: number;
+    };
+    /**
+     * The additional parameters of the payment
+     */
+    additional_params?: Array<{
         /**
-         * The recurrence date to of the payment
+         * The name of the additional parameter
          */
-        recurrence_date_to?: string;
+        name: string;
         /**
-         * The recurrence date from of the payment
+         * The value of the additional parameter
          */
-        recurrence_date_from?: string;
-    };
+        value: string;
+    }>;
     /**
-     * The preauthorization of the payment
+     * The language of the payment
      */
-    preauthorization?: any;
+    lang?: string;
     /**
      * The GW URL of the payment
      */
     gw_url?: string;
+}
+interface GoPaySubscriptionResponse extends GoPayPaymentBaseResponse {
     /**
-     * The language of the payment
+     * The payment instrument of the payment
      */
-    lang?: string;
+    payment_instrument?: string;
     /**
-     * The additional parameters of the payment
+     * The recurrence of the payment
      */
-    additional_params?: Array<{
+    recurrence: {
         /**
-         * The name of the additional parameter
+         * The recurrence cycle of the payment
          */
-        name: string;
+        recurrence_cycle: string;
         /**
-         * The value of the additional parameter
+         * The period of the recurrence, e.g `1`
          */
-        value: string;
-    }>;
+        recurrence_period: number;
+        /**
+         * The recurrence date to of the payment
+         */
+        recurrence_date_to: string;
+        /**
+         * The state of the recurrence
+         */
+        recurrence_state: 'REQUESTED' | 'STOPPED';
+    };
 }
 interface GoPayPaymentItem {
     /**
@@ -211,7 +215,7 @@ interface GoPayPaymentRequest {
      */
     items?: Array<{
         /**
-         * The name of the item
+         * The name of the item, this resolves to the item_id in PayKit
          */
         name: string;
         /**
@@ -292,4 +296,4 @@ interface GoPayPaymentRequest {
     preauthorization?: boolean;
 }
 
-export type { GoPayPaymentItem, GoPayPaymentRequest, GoPayPaymentResponse, GoPayTokenResponse };
+export type { GoPayPaymentBaseResponse, GoPayPaymentItem, GoPayPaymentRequest, GoPaySubscriptionResponse };

package/dist/schema.d.ts

@@ -1,18 +1,4 @@
-interface GoPayTokenResponse {
-    /**
-     * The type of the token
-     */
-    token_type: string;
-    /**
-     * The access token
-     */
-    access_token: string;
-    /**
-     * The expiry time of the token
-     */
-    expires_in: number;
-}
-interface GoPayPaymentResponse {
+interface GoPayPaymentBaseResponse {
     /**
      * The ID of the payment
      */
@@ -25,10 +11,6 @@ interface GoPayPaymentResponse {
      * The state of the payment
      */
     state: 'CREATED' | 'PAYMENT_METHOD_CHOSEN' | 'PAID' | 'AUTHORIZED' | 'CANCELED' | 'TIMEOUTED' | 'REFUNDED' | 'PARTIALLY_REFUNDED';
-    /**
-     * The sub state of the payment
-     */
-    sub_state?: string;
     /**
      * The amount of the payment
      */
@@ -37,64 +19,86 @@ interface GoPayPaymentResponse {
      * The currency of the payment
      */
     currency: string;
-    /**
-     * The payment instrument of the payment
-     */
-    payment_instrument?: string;
     /**
      * The payer of the payment
      */
-    payer?: any;
+    payer: {
+        /**
+         * The allowed payment instruments of the payer
+         */
+        allowed_payment_instruments: string[];
+        /**
+         * The default payment instrument of the payer
+         */
+        default_payment_instrument: string;
+        /**
+         * The contact of the payer
+         */
+        contact: {
+            email: string;
+        };
+    };
     /**
      * The target of the payment
      */
-    target?: any;
-    /**
-     * The recurrence of the payment
-     */
-    recurrence?: {
+    target: {
         /**
-         * The recurrence cycle of the payment
+         * The type of the target
          */
-        recurrence_cycle?: string;
+        type: 'ACCOUNT';
         /**
-         * The state of the recurrence e.g (STOPPED)
+         * The GoID of the target
          */
-        recurrence_state?: string;
+        goid: number;
+    };
+    /**
+     * The additional parameters of the payment
+     */
+    additional_params?: Array<{
         /**
-         * The recurrence date to of the payment
+         * The name of the additional parameter
          */
-        recurrence_date_to?: string;
+        name: string;
         /**
-         * The recurrence date from of the payment
+         * The value of the additional parameter
          */
-        recurrence_date_from?: string;
-    };
+        value: string;
+    }>;
     /**
-     * The preauthorization of the payment
+     * The language of the payment
      */
-    preauthorization?: any;
+    lang?: string;
     /**
      * The GW URL of the payment
      */
     gw_url?: string;
+}
+interface GoPaySubscriptionResponse extends GoPayPaymentBaseResponse {
     /**
-     * The language of the payment
+     * The payment instrument of the payment
      */
-    lang?: string;
+    payment_instrument?: string;
     /**
-     * The additional parameters of the payment
+     * The recurrence of the payment
      */
-    additional_params?: Array<{
+    recurrence: {
         /**
-         * The name of the additional parameter
+         * The recurrence cycle of the payment
          */
-        name: string;
+        recurrence_cycle: string;
         /**
-         * The value of the additional parameter
+         * The period of the recurrence, e.g `1`
          */
-        value: string;
-    }>;
+        recurrence_period: number;
+        /**
+         * The recurrence date to of the payment
+         */
+        recurrence_date_to: string;
+        /**
+         * The state of the recurrence
+         */
+        recurrence_state: 'REQUESTED' | 'STOPPED';
+    };
 }
 interface GoPayPaymentItem {
     /**
@@ -211,7 +215,7 @@ interface GoPayPaymentRequest {
      */
     items?: Array<{
         /**
-         * The name of the item
+         * The name of the item, this resolves to the item_id in PayKit
          */
         name: string;
         /**
@@ -292,4 +296,4 @@ interface GoPayPaymentRequest {
     preauthorization?: boolean;
 }
 
-export type { GoPayPaymentItem, GoPayPaymentRequest, GoPayPaymentResponse, GoPayTokenResponse };
+export type { GoPayPaymentBaseResponse, GoPayPaymentItem, GoPayPaymentRequest, GoPaySubscriptionResponse };

package/dist/utils/mapper.d.mts

@@ -1,12 +1,18 @@
-import { Payment, Invoice, Subscription, Refund } from '@paykit-sdk/core';
-import { GoPayPaymentResponse } from '../schema.mjs';
+import { Payment, Checkout, Invoice, Subscription, Refund } from '@paykit-sdk/core';
+import { GoPayPaymentBaseResponse, GoPaySubscriptionResponse } from '../schema.mjs';
 
-declare const paykitPayment$InboundSchema: (data: GoPayPaymentResponse) => Payment;
-declare const paykitInvoice$InboundSchema: (data: GoPayPaymentResponse, isSubscription: boolean) => Invoice;
-declare const paykitSubscription$InboundSchema: (data: GoPayPaymentResponse) => Subscription;
+/**
+ * Decodes HTML entities that GoPay returns for JSON strings
+ * GoPay HTML-encodes values containing special characters (quotes, etc.)
+ */
+declare const decodeHtmlEntities: (str: string) => string;
+declare const paykitPayment$InboundSchema: (data: GoPayPaymentBaseResponse) => Payment;
+declare const paykitCheckout$InboundSchema: (data: GoPayPaymentBaseResponse) => Checkout;
+declare const paykitInvoice$InboundSchema: <T extends "payment" | "subscription">(data: T extends "payment" ? GoPayPaymentBaseResponse : GoPaySubscriptionResponse, isSubscription: boolean) => Invoice;
+declare const paykitSubscription$InboundSchema: (data: GoPaySubscriptionResponse) => Subscription;
 /**
  * Refund
  */
-declare const paykitRefund$InboundSchema: (data: GoPayPaymentResponse) => Refund;
+declare const paykitRefund$InboundSchema: (data: GoPayPaymentBaseResponse) => Refund;
 
-export { paykitInvoice$InboundSchema, paykitPayment$InboundSchema, paykitRefund$InboundSchema, paykitSubscription$InboundSchema };
+export { decodeHtmlEntities, paykitCheckout$InboundSchema, paykitInvoice$InboundSchema, paykitPayment$InboundSchema, paykitRefund$InboundSchema, paykitSubscription$InboundSchema };

package/dist/utils/mapper.d.ts

@@ -1,12 +1,18 @@
-import { Payment, Invoice, Subscription, Refund } from '@paykit-sdk/core';
-import { GoPayPaymentResponse } from '../schema.js';
+import { Payment, Checkout, Invoice, Subscription, Refund } from '@paykit-sdk/core';
+import { GoPayPaymentBaseResponse, GoPaySubscriptionResponse } from '../schema.js';
 
-declare const paykitPayment$InboundSchema: (data: GoPayPaymentResponse) => Payment;
-declare const paykitInvoice$InboundSchema: (data: GoPayPaymentResponse, isSubscription: boolean) => Invoice;
-declare const paykitSubscription$InboundSchema: (data: GoPayPaymentResponse) => Subscription;
+/**
+ * Decodes HTML entities that GoPay returns for JSON strings
+ * GoPay HTML-encodes values containing special characters (quotes, etc.)
+ */
+declare const decodeHtmlEntities: (str: string) => string;
+declare const paykitPayment$InboundSchema: (data: GoPayPaymentBaseResponse) => Payment;
+declare const paykitCheckout$InboundSchema: (data: GoPayPaymentBaseResponse) => Checkout;
+declare const paykitInvoice$InboundSchema: <T extends "payment" | "subscription">(data: T extends "payment" ? GoPayPaymentBaseResponse : GoPaySubscriptionResponse, isSubscription: boolean) => Invoice;
+declare const paykitSubscription$InboundSchema: (data: GoPaySubscriptionResponse) => Subscription;
 /**
  * Refund
  */
-declare const paykitRefund$InboundSchema: (data: GoPayPaymentResponse) => Refund;
+declare const paykitRefund$InboundSchema: (data: GoPayPaymentBaseResponse) => Refund;
 
-export { paykitInvoice$InboundSchema, paykitPayment$InboundSchema, paykitRefund$InboundSchema, paykitSubscription$InboundSchema };
+export { decodeHtmlEntities, paykitCheckout$InboundSchema, paykitInvoice$InboundSchema, paykitPayment$InboundSchema, paykitRefund$InboundSchema, paykitSubscription$InboundSchema };

package/dist/utils/mapper.js

@@ -3,10 +3,53 @@
 var core = require('@paykit-sdk/core');
 
 // src/utils/mapper.ts
+var decodeHtmlEntities = (str) => {
+  return str.replace(/"/g, '"').replace(/'/g, "'").replace(/"/g, '"').replace(/'/g, "'");
+};
 var paykitPayment$InboundSchema = (data) => {
-  const itemId = JSON.parse(
-    data.additional_params?.find((param) => param.name === core.PAYKIT_METADATA_KEY)?.value ?? "{}"
-  ).itemId;
+  const { item } = JSON.parse(
+    decodeHtmlEntities(
+      data.additional_params?.find((param) => param.name === core.PAYKIT_METADATA_KEY)?.value ?? "{}"
+    )
+  );
+  const metadata = core.omitInternalMetadata(
+    data.additional_params?.reduce(
+      (acc, param) => {
+        acc[param.name] = String(param.value);
+        return acc;
+      },
+      {}
+    ) ?? {}
+  );
+  const statusMap = {
+    CREATED: "pending",
+    PAYMENT_METHOD_CHOSEN: "processing",
+    PAID: "succeeded",
+    AUTHORIZED: "requires_capture",
+    CANCELED: "canceled",
+    TIMEOUTED: "canceled",
+    REFUNDED: "canceled",
+    PARTIALLY_REFUNDED: "canceled"
+  };
+  const requiresAction = data.state === "CREATED" || data.state === "AUTHORIZED" ? true : false;
+  return {
+    id: data.id.toString(),
+    amount: data.amount,
+    currency: data.currency,
+    customer: data.payer?.contact?.email ? { email: data.payer.contact.email } : "",
+    status: statusMap[data.state],
+    item_id: item,
+    metadata,
+    requires_action: requiresAction,
+    payment_url: data.gw_url ?? null
+  };
+};
+var paykitCheckout$InboundSchema = (data) => {
+  const { item, qty, type } = JSON.parse(
+    decodeHtmlEntities(
+      data.additional_params?.find((param) => param.name === core.PAYKIT_METADATA_KEY)?.value ?? "{}"
+    )
+  );
   const metadata = core.omitInternalMetadata(
     data.additional_params?.reduce(
       (acc, param) => {
@@ -20,24 +63,24 @@ var paykitPayment$InboundSchema = (data) => {
     id: data.id.toString(),
     amount: data.amount,
     currency: data.currency,
-    customer: data.payer ?? { email: data.payer?.email ?? "" },
-    status: data.state,
-    item_id: itemId,
-    metadata
+    customer: data.payer?.contact?.email ? { email: data.payer.contact.email } : "",
+    payment_url: data.gw_url ?? "",
+    metadata,
+    session_type: type,
+    products: [{ id: item, quantity: parseInt(qty) }]
   };
 };
 var paykitInvoice$InboundSchema = (data, isSubscription) => {
-  const quantity = JSON.parse(
-    data.additional_params?.find((param) => param.name === core.PAYKIT_METADATA_KEY)?.value ?? "{}"
-  ).qty;
-  const itemId = JSON.parse(
-    data.additional_params?.find((param) => param.name === core.PAYKIT_METADATA_KEY)?.value ?? "{}"
-  ).itemId;
+  const { item, qty } = JSON.parse(
+    decodeHtmlEntities(
+      data.additional_params?.find((param) => param.name === core.PAYKIT_METADATA_KEY)?.value ?? "{}"
+    )
+  );
   const status = (() => {
     if (data.state === "PAID") return "paid";
     return "open";
   })();
-  const paidAt = isSubscription ? new Date(data.recurrence?.recurrence_date_from ?? "") : /* @__PURE__ */ new Date();
+  const paidAt = isSubscription ? new Date(data.recurrence?.recurrence_date_to ?? "") : /* @__PURE__ */ new Date();
   const metadata = core.omitInternalMetadata(
     data.additional_params?.reduce(
       (acc, param) => {
@@ -51,20 +94,22 @@ var paykitInvoice$InboundSchema = (data, isSubscription) => {
     id: data.id.toString(),
     amount_paid: data.amount,
     currency: data.currency,
-    customer: data.payer ?? { email: data.payer?.email ?? "" },
+    customer: data.payer?.contact?.email ? { email: data.payer.contact.email } : "",
     status,
     paid_at: paidAt.toISOString(),
     metadata: metadata ?? {},
     custom_fields: null,
     subscription_id: isSubscription ? data.id.toString() : null,
     billing_mode: isSubscription ? "recurring" : "one_time",
-    line_items: [{ id: itemId, quantity: parseInt(quantity) }]
+    line_items: [{ id: item, quantity: parseInt(qty) }]
   };
 };
 var paykitSubscription$InboundSchema = (data) => {
-  const itemId = JSON.parse(
-    data.additional_params?.find((param) => param.name === core.PAYKIT_METADATA_KEY)?.value ?? "{}"
-  ).itemId;
+  const { item } = JSON.parse(
+    decodeHtmlEntities(
+      data.additional_params?.find((param) => param.name === core.PAYKIT_METADATA_KEY)?.value ?? "{}"
+    )
+  );
   const billingIntervalMap = {
     DAY: "day",
     WEEK: "week",
@@ -72,8 +117,28 @@ var paykitSubscription$InboundSchema = (data) => {
     ON_DEMAND: "month"
   };
   const billingInterval = billingIntervalMap[data.recurrence?.recurrence_cycle ?? "ON_DEMAND"];
-  const currentPeriodStart = new Date(data.recurrence?.recurrence_date_from ?? "");
+  const recurrencePeriod = data.recurrence?.recurrence_period ?? 1;
+  const recurrenceCycle = data.recurrence?.recurrence_cycle;
   const currentPeriodEnd = new Date(data.recurrence?.recurrence_date_to ?? "");
+  const currentPeriodStart = (() => {
+    if (!currentPeriodEnd) return /* @__PURE__ */ new Date();
+    const endDate = new Date(currentPeriodEnd);
+    const startDate = new Date(endDate);
+    switch (recurrenceCycle) {
+      case "DAY":
+        startDate.setDate(startDate.getDate() - recurrencePeriod);
+        break;
+      case "WEEK":
+        startDate.setDate(startDate.getDate() - recurrencePeriod * 7);
+        break;
+      case "MONTH":
+        startDate.setMonth(startDate.getMonth() - recurrencePeriod);
+        break;
+      default:
+        startDate.setDate(startDate.getDate() - recurrencePeriod);
+    }
+    return startDate;
+  })();
   const metadata = core.omitInternalMetadata(
     data.additional_params?.reduce(
       (acc, param) => {
@@ -83,18 +148,32 @@ var paykitSubscription$InboundSchema = (data) => {
       {}
     ) ?? {}
   );
+  const requiresAction = data.state === "CREATED" ? true : false;
+  const status = (() => {
+    if (data.state === "CREATED") return "pending";
+    if (data.state === "PAID") return "active";
+    if (data.state === "CANCELED") return "canceled";
+    if (data.state === "TIMEOUTED") return "canceled";
+    if (data.state === "REFUNDED") return "canceled";
+    if (data.state === "PARTIALLY_REFUNDED") return "canceled";
+    if (data.state === "AUTHORIZED") return "active";
+    if (data.state === "PAYMENT_METHOD_CHOSEN") return "active";
+    return "pending";
+  })();
   return {
     id: data.id.toString(),
-    status: "active",
-    customer: data.payer ?? { email: data.payer?.email ?? "" },
-    item_id: itemId,
+    status,
+    customer: data.payer?.contact?.email ? { email: data.payer.contact.email } : "",
+    item_id: item,
     billing_interval: billingInterval,
     currency: data.currency,
     amount: data.amount,
-    metadata: metadata ?? {},
+    metadata,
     custom_fields: null,
     current_period_start: currentPeriodStart,
-    current_period_end: currentPeriodEnd
+    current_period_end: currentPeriodEnd,
+    requires_action: requiresAction,
+    payment_url: requiresAction ? data.gw_url ?? null : null
   };
 };
 var paykitRefund$InboundSchema = (data) => {
@@ -107,6 +186,8 @@ var paykitRefund$InboundSchema = (data) => {
   };
 };
 
+exports.decodeHtmlEntities = decodeHtmlEntities;
+exports.paykitCheckout$InboundSchema = paykitCheckout$InboundSchema;
 exports.paykitInvoice$InboundSchema = paykitInvoice$InboundSchema;
 exports.paykitPayment$InboundSchema = paykitPayment$InboundSchema;
 exports.paykitRefund$InboundSchema = paykitRefund$InboundSchema;