recur-tw 0.8.4 → 0.8.5

package/dist/index.d.cts

@@ -273,6 +273,8 @@ interface CheckoutResult {
      */
     checkout: {
         id: string;
+        /** Stripe-like client secret for secure status polling */
+        clientSecret: string;
         checkoutNumber: string;
         status: string;
         productId: string;
@@ -399,6 +401,31 @@ interface RecurContextValue {
      * Update configuration
      */
     updateConfig: (config: Partial<RecurConfig>) => void;
+    /**
+     * Get checkout status using client secret
+     * Used to poll payment status after 3D verification or async operations
+     */
+    getCheckoutStatus: (checkoutId: string, clientSecret: string) => Promise<CheckoutStatusResult>;
+}
+/**
+ * Checkout status result from polling
+ */
+interface CheckoutStatusResult {
+    /** Checkout/PaymentIntent ID */
+    id: string;
+    /** Current status */
+    status: 'REQUIRES_PAYMENT_METHOD' | 'REQUIRES_CONFIRMATION' | 'REQUIRES_ACTION' | 'PROCESSING' | 'SUCCEEDED' | 'CANCELED';
+    /** Amount in smallest currency unit */
+    amount: number;
+    /** Currency code */
+    currency: string;
+    /** Last charge information */
+    lastCharge?: {
+        id: string;
+        status: string;
+        failureCode?: string;
+        failureMessage?: string;
+    };
 }
 /**
  * PAYUNi SDK types

package/dist/index.d.ts

@@ -273,6 +273,8 @@ interface CheckoutResult {
      */
     checkout: {
         id: string;
+        /** Stripe-like client secret for secure status polling */
+        clientSecret: string;
         checkoutNumber: string;
         status: string;
         productId: string;
@@ -399,6 +401,31 @@ interface RecurContextValue {
      * Update configuration
      */
     updateConfig: (config: Partial<RecurConfig>) => void;
+    /**
+     * Get checkout status using client secret
+     * Used to poll payment status after 3D verification or async operations
+     */
+    getCheckoutStatus: (checkoutId: string, clientSecret: string) => Promise<CheckoutStatusResult>;
+}
+/**
+ * Checkout status result from polling
+ */
+interface CheckoutStatusResult {
+    /** Checkout/PaymentIntent ID */
+    id: string;
+    /** Current status */
+    status: 'REQUIRES_PAYMENT_METHOD' | 'REQUIRES_CONFIRMATION' | 'REQUIRES_ACTION' | 'PROCESSING' | 'SUCCEEDED' | 'CANCELED';
+    /** Amount in smallest currency unit */
+    amount: number;
+    /** Currency code */
+    currency: string;
+    /** Last charge information */
+    lastCharge?: {
+        id: string;
+        status: string;
+        failureCode?: string;
+        failureMessage?: string;
+    };
 }
 /**
  * PAYUNi SDK types

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "recur-tw",
-  "version": "0.8.4",
+  "version": "0.8.5",
   "description": "React & Vanilla JS SDK for embedding subscription checkout flows (Taiwan / PAYUNi)",
   "type": "module",
   "private": false,
@@ -28,6 +28,14 @@
     "url": "https://github.com/kaikhq/recur.tw/issues"
   },
   "homepage": "https://github.com/kaikhq/recur.tw/tree/main/packages/recur-sdk#readme",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "type-check": "tsc --noEmit",
+    "examples": "npx http-server examples -p 8080 -o"
+  },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -74,6 +82,7 @@
     "@types/node": "^20.19.9",
     "@types/react": "^19.1.9",
     "@types/react-dom": "^19.1.7",
+    "@workspace/typescript-config": "workspace:*",
     "autoprefixer": "^10.4.22",
     "eslint": "^9",
     "eslint-plugin-react": "^7.37.5",
@@ -84,15 +93,6 @@
     "tailwindcss": "^4.1.11",
     "tsup": "^8.3.5",
     "typescript": "^5.9.2",
-    "typescript-eslint": "^8.47.0",
-    "@workspace/typescript-config": "0.0.0"
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "type-check": "tsc --noEmit",
-    "examples": "npx http-server examples -p 8080 -o"
+    "typescript-eslint": "^8.47.0"
   }
-}
+}

package/dist/server.d.cts

@@ -1,194 +0,0 @@
-/**
- * Recur Server SDK Types
- */
-interface RecurConfig {
-    /**
-     * Secret API key for authentication
-     * Get this from your organization settings
-     *
-     * @example 'sk_test_abc123...' or 'sk_live_xyz789...'
-     */
-    secretKey: string;
-    /**
-     * Base URL for API calls
-     * Defaults to 'https://api.recur.tw'
-     */
-    baseUrl?: string;
-}
-/**
- * Parameters for creating a portal session
- *
- * Customer Identification (at least one required):
- * - customer: Internal customer ID in Recur (highest priority)
- * - externalId: Customer's external ID from your system
- * - email: Customer's email address (lowest priority)
- */
-interface PortalSessionCreateParams {
-    /**
-     * The internal ID of the customer to create a portal session for
-     * Takes highest priority when multiple identifiers are provided
-     */
-    customer?: string;
-    /**
-     * Customer's email address
-     * Used to identify the customer if `customer` and `externalId` are not provided
-     */
-    email?: string;
-    /**
-     * Customer's external ID from your system
-     * Used to identify the customer if `customer` is not provided
-     */
-    externalId?: string;
-    /**
-     * The URL to redirect the customer to when they exit the portal
-     * If not provided, uses the default return URL from portal configuration
-     */
-    returnUrl?: string;
-    /**
-     * The ID of a specific portal configuration to use
-     * If not provided, uses the default configuration
-     */
-    configuration?: string;
-    /**
-     * Preferred locale for the portal
-     */
-    locale?: 'zh-TW' | 'en';
-}
-interface PortalSession {
-    /**
-     * Unique identifier for the portal session
-     */
-    id: string;
-    /**
-     * String representing the object's type
-     */
-    object: 'portal.session';
-    /**
-     * The URL to redirect the customer to access the portal
-     */
-    url: string;
-    /**
-     * The ID of the customer for this session
-     */
-    customer: string;
-    /**
-     * The URL to redirect the customer when they exit the portal
-     */
-    returnUrl: string;
-    /**
-     * The status of the session
-     */
-    status: 'active' | 'expired';
-    /**
-     * Time at which the session expires (ISO 8601)
-     */
-    expiresAt: string;
-    /**
-     * Time at which the session was last accessed (ISO 8601), or null
-     */
-    accessedAt: string | null;
-    /**
-     * Time at which the session was created (ISO 8601)
-     */
-    createdAt: string;
-}
-interface RecurError {
-    type: 'authentication_error' | 'invalid_request_error' | 'api_error';
-    code: string;
-    message: string;
-    details?: unknown;
-}
-declare class RecurAPIError extends Error {
-    readonly type: string;
-    readonly code: string;
-    readonly statusCode: number;
-    constructor(error: RecurError, statusCode: number);
-}
-
-/**
- * Portal Sessions Resource
- *
- * Create portal sessions to allow customers to manage their subscriptions
- */
-
-declare class PortalSessions {
-    private config;
-    constructor(config: RecurConfig);
-    /**
-     * Create a portal session for a customer
-     *
-     * Customer can be identified using one of:
-     * - `customer`: Internal customer ID (highest priority)
-     * - `externalId`: External customer ID from your system
-     * - `email`: Customer's email address (lowest priority)
-     *
-     * @param params - Portal session creation parameters
-     * @returns The created portal session with URL
-     *
-     * @example
-     * ```typescript
-     * // By customer ID
-     * const session = await recur.portal.sessions.create({
-     *   customer: 'cus_xxx',
-     *   returnUrl: 'https://myapp.com/account',
-     * });
-     *
-     * // By email
-     * const session = await recur.portal.sessions.create({
-     *   email: 'customer@example.com',
-     *   returnUrl: 'https://myapp.com/account',
-     * });
-     *
-     * // By external ID
-     * const session = await recur.portal.sessions.create({
-     *   externalId: 'user_123',
-     *   returnUrl: 'https://myapp.com/account',
-     * });
-     *
-     * // Redirect the customer to the portal
-     * redirect(session.url);
-     * ```
-     */
-    create(params: PortalSessionCreateParams): Promise<PortalSession>;
-}
-declare class Portal {
-    readonly sessions: PortalSessions;
-    constructor(config: RecurConfig);
-}
-
-/**
- * Recur Server SDK
- *
- * Server-side SDK for interacting with the Recur API
- * Use this in your backend (API routes, server actions, etc.)
- *
- * @example
- * ```typescript
- * import { Recur } from 'recur-tw/server';
- *
- * const recur = new Recur(process.env.RECUR_SECRET_KEY!);
- *
- * // Create a portal session
- * const session = await recur.portal.sessions.create({
- *   customer: 'cus_xxx',
- *   returnUrl: 'https://myapp.com/account',
- * });
- * ```
- */
-
-declare class Recur {
-    private config;
-    /**
-     * Portal resource for managing customer portal sessions
-     */
-    readonly portal: Portal;
-    /**
-     * Create a new Recur client
-     *
-     * @param secretKey - Your Recur secret API key (sk_test_xxx or sk_live_xxx)
-     * @param options - Additional configuration options
-     */
-    constructor(secretKey: string, options?: Omit<RecurConfig, 'secretKey'>);
-}
-
-export { type PortalSession, type PortalSessionCreateParams, Recur, RecurAPIError, type RecurConfig, type RecurError };

package/dist/server.d.ts

@@ -1,194 +0,0 @@
-/**
- * Recur Server SDK Types
- */
-interface RecurConfig {
-    /**
-     * Secret API key for authentication
-     * Get this from your organization settings
-     *
-     * @example 'sk_test_abc123...' or 'sk_live_xyz789...'
-     */
-    secretKey: string;
-    /**
-     * Base URL for API calls
-     * Defaults to 'https://api.recur.tw'
-     */
-    baseUrl?: string;
-}
-/**
- * Parameters for creating a portal session
- *
- * Customer Identification (at least one required):
- * - customer: Internal customer ID in Recur (highest priority)
- * - externalId: Customer's external ID from your system
- * - email: Customer's email address (lowest priority)
- */
-interface PortalSessionCreateParams {
-    /**
-     * The internal ID of the customer to create a portal session for
-     * Takes highest priority when multiple identifiers are provided
-     */
-    customer?: string;
-    /**
-     * Customer's email address
-     * Used to identify the customer if `customer` and `externalId` are not provided
-     */
-    email?: string;
-    /**
-     * Customer's external ID from your system
-     * Used to identify the customer if `customer` is not provided
-     */
-    externalId?: string;
-    /**
-     * The URL to redirect the customer to when they exit the portal
-     * If not provided, uses the default return URL from portal configuration
-     */
-    returnUrl?: string;
-    /**
-     * The ID of a specific portal configuration to use
-     * If not provided, uses the default configuration
-     */
-    configuration?: string;
-    /**
-     * Preferred locale for the portal
-     */
-    locale?: 'zh-TW' | 'en';
-}
-interface PortalSession {
-    /**
-     * Unique identifier for the portal session
-     */
-    id: string;
-    /**
-     * String representing the object's type
-     */
-    object: 'portal.session';
-    /**
-     * The URL to redirect the customer to access the portal
-     */
-    url: string;
-    /**
-     * The ID of the customer for this session
-     */
-    customer: string;
-    /**
-     * The URL to redirect the customer when they exit the portal
-     */
-    returnUrl: string;
-    /**
-     * The status of the session
-     */
-    status: 'active' | 'expired';
-    /**
-     * Time at which the session expires (ISO 8601)
-     */
-    expiresAt: string;
-    /**
-     * Time at which the session was last accessed (ISO 8601), or null
-     */
-    accessedAt: string | null;
-    /**
-     * Time at which the session was created (ISO 8601)
-     */
-    createdAt: string;
-}
-interface RecurError {
-    type: 'authentication_error' | 'invalid_request_error' | 'api_error';
-    code: string;
-    message: string;
-    details?: unknown;
-}
-declare class RecurAPIError extends Error {
-    readonly type: string;
-    readonly code: string;
-    readonly statusCode: number;
-    constructor(error: RecurError, statusCode: number);
-}
-
-/**
- * Portal Sessions Resource
- *
- * Create portal sessions to allow customers to manage their subscriptions
- */
-
-declare class PortalSessions {
-    private config;
-    constructor(config: RecurConfig);
-    /**
-     * Create a portal session for a customer
-     *
-     * Customer can be identified using one of:
-     * - `customer`: Internal customer ID (highest priority)
-     * - `externalId`: External customer ID from your system
-     * - `email`: Customer's email address (lowest priority)
-     *
-     * @param params - Portal session creation parameters
-     * @returns The created portal session with URL
-     *
-     * @example
-     * ```typescript
-     * // By customer ID
-     * const session = await recur.portal.sessions.create({
-     *   customer: 'cus_xxx',
-     *   returnUrl: 'https://myapp.com/account',
-     * });
-     *
-     * // By email
-     * const session = await recur.portal.sessions.create({
-     *   email: 'customer@example.com',
-     *   returnUrl: 'https://myapp.com/account',
-     * });
-     *
-     * // By external ID
-     * const session = await recur.portal.sessions.create({
-     *   externalId: 'user_123',
-     *   returnUrl: 'https://myapp.com/account',
-     * });
-     *
-     * // Redirect the customer to the portal
-     * redirect(session.url);
-     * ```
-     */
-    create(params: PortalSessionCreateParams): Promise<PortalSession>;
-}
-declare class Portal {
-    readonly sessions: PortalSessions;
-    constructor(config: RecurConfig);
-}
-
-/**
- * Recur Server SDK
- *
- * Server-side SDK for interacting with the Recur API
- * Use this in your backend (API routes, server actions, etc.)
- *
- * @example
- * ```typescript
- * import { Recur } from 'recur-tw/server';
- *
- * const recur = new Recur(process.env.RECUR_SECRET_KEY!);
- *
- * // Create a portal session
- * const session = await recur.portal.sessions.create({
- *   customer: 'cus_xxx',
- *   returnUrl: 'https://myapp.com/account',
- * });
- * ```
- */
-
-declare class Recur {
-    private config;
-    /**
-     * Portal resource for managing customer portal sessions
-     */
-    readonly portal: Portal;
-    /**
-     * Create a new Recur client
-     *
-     * @param secretKey - Your Recur secret API key (sk_test_xxx or sk_live_xxx)
-     * @param options - Additional configuration options
-     */
-    constructor(secretKey: string, options?: Omit<RecurConfig, 'secretKey'>);
-}
-
-export { type PortalSession, type PortalSessionCreateParams, Recur, RecurAPIError, type RecurConfig, type RecurError };