@coin-voyage/paykit 2.2.0-beta.0 → 2.2.0-beta.1

package/dist/hooks/usePayStatus.d.ts

@@ -1,17 +1,18 @@
-import type { PaymentStatus } from "../types";
+import { PayOrderStatus } from "@coin-voyage/shared/common";
 /** Returns the current payment, or undefined if there is none.
  *
  * Status values:
- * - `payment_pending` - the user has not paid yet
- * - `payment_started` - the user has paid & payment is in progress. This status
+ * - `PENDING` - the user has not paid yet
+ * - `AWAITING_PAYMENT` - the user has requested payment details but not yet executed the payment.
+ * - `AWAITING_CONFIRMATION` - the user has paid & payment is in progress. This status
  *    typically lasts a few seconds.
- * - `payment_completed` - the final call or transfer succeeded
- * - `payment_bounced` - the final call or transfer reverted. Funds were sent
- * - `payment_expired` - the payment expired before the user paid
- * - `payment_failed` - the payment failed for some reason
- *    to the payment's configured refund address on the destination chain.
+ * - `OPTIMISTIC_CONFIRMED` - the user has paid and the payment is verified on the blockchain, but not yet confirmed. This status can last from a few seconds to several minutes, depending on the chains transaction speed.
+ * - `EXECUTING_ORDER` - the payment is confirmed and the order is being executed. This status typically lasts a few seconds.
+ * - `COMPLETED` - the payOrder is finalized and succeeded
+ * - `EXPIRED` - the payOrder expired before the user paid
+ * - `REFUNDED` - the payment was refunded to the payment's configured refund address on the destination chain.
  */
 export declare function usePayStatus(): {
     paymentId: string;
-    status: PaymentStatus;
+    status: PayOrderStatus;
 } | undefined;

package/dist/hooks/usePayStatus.js

@@ -1,41 +1,22 @@
-import { PayOrderStatus } from "@coin-voyage/shared/common";
 import usePayContext from "../components/contexts/pay";
 /** Returns the current payment, or undefined if there is none.
  *
  * Status values:
- * - `payment_pending` - the user has not paid yet
- * - `payment_started` - the user has paid & payment is in progress. This status
+ * - `PENDING` - the user has not paid yet
+ * - `AWAITING_PAYMENT` - the user has requested payment details but not yet executed the payment.
+ * - `AWAITING_CONFIRMATION` - the user has paid & payment is in progress. This status
  *    typically lasts a few seconds.
- * - `payment_completed` - the final call or transfer succeeded
- * - `payment_bounced` - the final call or transfer reverted. Funds were sent
- * - `payment_expired` - the payment expired before the user paid
- * - `payment_failed` - the payment failed for some reason
- *    to the payment's configured refund address on the destination chain.
+ * - `OPTIMISTIC_CONFIRMED` - the user has paid and the payment is verified on the blockchain, but not yet confirmed. This status can last from a few seconds to several minutes, depending on the chains transaction speed.
+ * - `EXECUTING_ORDER` - the payment is confirmed and the order is being executed. This status typically lasts a few seconds.
+ * - `COMPLETED` - the payOrder is finalized and succeeded
+ * - `EXPIRED` - the payOrder expired before the user paid
+ * - `REFUNDED` - the payment was refunded to the payment's configured refund address on the destination chain.
  */
 export function usePayStatus() {
     const { paymentState } = usePayContext();
     if (!paymentState || !paymentState.payOrder) {
         return undefined;
     }
-    const order = paymentState.payOrder;
-    const paymentId = order.id;
-    if ([PayOrderStatus.EXECUTING_ORDER, PayOrderStatus.COMPLETED].includes(order.status)) {
-        return { paymentId, status: "payment_completed" };
-    }
-    if (order.status === PayOrderStatus.FAILED) {
-        return { paymentId, status: "payment_failed" };
-    }
-    if (order.status === PayOrderStatus.REFUNDED) {
-        return { paymentId, status: "payment_bounced" };
-    }
-    if (order.status === PayOrderStatus.AWAITING_CONFIRMATION) {
-        return { paymentId, status: "payment_started" };
-    }
-    if (order.status === PayOrderStatus.EXPIRED) {
-        return { paymentId, status: "payment_expired" };
-    }
-    if ([PayOrderStatus.AWAITING_PAYMENT, PayOrderStatus.PENDING].includes(order.status)) {
-        return { paymentId, status: "payment_pending" };
-    }
+    return { paymentId: paymentState.payOrder.id, status: paymentState.payOrder.status };
 }
 //# sourceMappingURL=usePayStatus.js.map

package/dist/hooks/usePayStatus.js.map

@@ -1 +1 @@
-{"version":3,"file":"usePayStatus.js","sourceRoot":"","sources":["../../src/hooks/usePayStatus.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,aAAa,MAAM,4BAA4B,CAAA;AAGtD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,EAAE,CAAA;IACxC,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QAC5C,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,KAAK,GAAG,YAAY,CAAC,QAAQ,CAAA;IACnC,MAAM,SAAS,GAAG,KAAK,CAAC,EAAE,CAAA;IAE1B,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACtF,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAA;IACnD,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM,EAAE,CAAC;QAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAA;IAChD,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,cAAc,CAAC,QAAQ,EAAE,CAAC;QAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAA;IACjD,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,cAAc,CAAC,qBAAqB,EAAE,CAAC;QAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAA;IACjD,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,cAAc,CAAC,OAAO,EAAE,CAAC;QAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAA;IACjD,CAAC;IAED,IAAI,CAAC,cAAc,CAAC,gBAAgB,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACrF,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAA;IACjD,CAAC;AACH,CAAC"}
+{"version":3,"file":"usePayStatus.js","sourceRoot":"","sources":["../../src/hooks/usePayStatus.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,4BAA4B,CAAA;AAEtD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,EAAE,CAAA;IACxC,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QAC5C,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,OAAO,EAAE,SAAS,EAAE,YAAY,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAA;AACtF,CAAC"}

package/dist/types.d.ts

@@ -5,7 +5,7 @@ import type { ReactNode } from "react";
 import type { Languages as Lang } from "./lib/localizations";
 export type APIEnvironment = APIEnvironmentShared;
 export type WalletConfiguration = WalletConfigurationImport;
-export type { PayOrder, PayOrderMetadata } from "@coin-voyage/shared/common";
+export type { PayOrder, PayOrderMetadata, PayOrderStatus, PayOrderEvent, WebhookEventType } from "@coin-voyage/shared/common";
 export type PayKitConfig = {
     children?: ReactNode;
     apiKey: string;
@@ -126,5 +126,3 @@ export type PayModalOptions = {
     /** Automatically reset the payment state after a successful payment. */
     resetOnSuccess?: boolean;
 };
-/** Payment status. See webhooks and React usePayStatus() hook. */
-export type PaymentStatus = "payment_pending" | "payment_started" | "payment_completed" | "payment_bounced" | "payment_expired" | "payment_failed";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@coin-voyage/paykit",
   "description": "Seamless crypto payments. Onboard users from any chain, any coin into your app with one click.",
-  "version": "2.2.0-beta.0",
+  "version": "2.2.0-beta.1",
   "private": false,
   "sideEffects": false,
   "author": "Lars <lars@coinvoyage.io>",
@@ -88,6 +88,7 @@
     "release:build": "pnpm clean && pnpm build",
     "pre:release": "pnpm version prerelease --preid=beta",
     "pre:publish": "pnpm publish --access public --tag beta --no-git-checks",
+    "release": "pnpm publish --access public --no-git-checks",
     "type-check": "tsc --noEmit"
   }
 }