recur-tw 0.14.0 → 0.16.0

package/dist/index.cjs

@@ -2814,7 +2814,7 @@ function toCamelCase(obj) {
 
 // package.json
 var package_default = {
-  version: "0.13.3"};
+  version: "0.15.0"};
 var SDK_VERSION = package_default.version;
 var SDK_TYPE = "react";
 var RecurContext = React.createContext(null);
@@ -3748,6 +3748,272 @@ function useSubscribe(options = {}) {
     reset
   };
 }
+var DEFAULT_BASE_URL = "https://api.recur.tw";
+var SDK_TYPE2 = "react";
+var SDK_VERSION2 = package_default.version;
+function usePromoCode(options = {}) {
+  const context = React.useContext(RecurContext);
+  const publishableKey = options.publishableKey || context?.config?.publishableKey;
+  const baseUrl = options.baseUrl || context?.config?.baseUrl || DEFAULT_BASE_URL;
+  if (!publishableKey) {
+    throw new Error(
+      'usePromoCode requires a publishableKey. Either wrap your app in <RecurProvider> or pass publishableKey directly: usePromoCode({ publishableKey: "pk_..." })'
+    );
+  }
+  const [status, setStatus] = React.useState("idle");
+  const [code, setCode] = React.useState(null);
+  const [discount, setDiscount] = React.useState(null);
+  const [appliesToAllProducts, setAppliesToAllProducts] = React.useState(false);
+  const [applicableProducts, setApplicableProducts] = React.useState([]);
+  const [error, setError] = React.useState(null);
+  const abortControllerRef = React.useRef(null);
+  const apply = React.useCallback(
+    async (inputCode) => {
+      const trimmed = inputCode.trim();
+      if (!trimmed) {
+        return;
+      }
+      abortControllerRef.current?.abort();
+      const controller = new AbortController();
+      abortControllerRef.current = controller;
+      setStatus("validating");
+      setError(null);
+      setDiscount(null);
+      setCode(null);
+      setAppliesToAllProducts(false);
+      setApplicableProducts([]);
+      try {
+        const body = { code: trimmed };
+        if (options.customerId) {
+          body.external_id = options.customerId;
+        }
+        if (options.recurCustomerId) {
+          body.customer_id = options.recurCustomerId;
+        }
+        const response = await fetch(`${baseUrl}/v1/promotion-codes/validate`, {
+          method: "POST",
+          headers: {
+            "Content-Type": "application/json",
+            "X-Recur-Publishable-Key": publishableKey,
+            "X-Recur-SDK-Type": SDK_TYPE2,
+            "X-Recur-SDK-Version": SDK_VERSION2,
+            "X-Recur-Source": typeof window !== "undefined" ? window.location.origin : "server"
+          },
+          body: JSON.stringify(body),
+          signal: controller.signal
+        });
+        if (controller.signal.aborted) return;
+        if (!response.ok) {
+          const errorData = await response.json().catch(() => ({}));
+          const message = errorData?.error?.message || "\u9A57\u8B49\u5931\u6557\uFF0C\u8ACB\u7A0D\u5F8C\u518D\u8A66";
+          setStatus("invalid");
+          setError(message);
+          return;
+        }
+        const raw = await response.json();
+        const result = toCamelCase(raw);
+        if (controller.signal.aborted) return;
+        if (result.valid) {
+          setStatus("valid");
+          setCode(trimmed.toUpperCase());
+          setDiscount(result.discount || null);
+          setAppliesToAllProducts(result.appliesToAllProducts ?? false);
+          setApplicableProducts(result.applicableProducts ?? []);
+        } else {
+          const errorStatus = result.errorCode === "PROMO_CODE_ALREADY_USED" ? "already_used" : "invalid";
+          setStatus(errorStatus);
+          setError(result.errorMessage || "\u6B64\u512A\u60E0\u78BC\u7121\u6548");
+        }
+      } catch (err) {
+        if (err instanceof DOMException && err.name === "AbortError") return;
+        setStatus("invalid");
+        setError("\u7DB2\u8DEF\u932F\u8AA4\uFF0C\u8ACB\u7A0D\u5F8C\u518D\u8A66");
+      }
+    },
+    [publishableKey, baseUrl, options.customerId, options.recurCustomerId]
+  );
+  const clear = React.useCallback(() => {
+    abortControllerRef.current?.abort();
+    setStatus("idle");
+    setCode(null);
+    setDiscount(null);
+    setAppliesToAllProducts(false);
+    setApplicableProducts([]);
+    setError(null);
+  }, []);
+  return {
+    apply,
+    clear,
+    status,
+    isLoading: status === "validating",
+    isValid: status === "valid",
+    code,
+    discount,
+    appliesToAllProducts,
+    applicableProducts,
+    error
+  };
+}
+var defaultStyles = {
+  container: {
+    display: "flex",
+    flexDirection: "column",
+    gap: "6px",
+    fontFamily: "system-ui, -apple-system, sans-serif",
+    fontSize: "14px"
+  },
+  row: {
+    display: "flex",
+    gap: "8px",
+    alignItems: "center"
+  },
+  input: {
+    flex: 1,
+    padding: "8px 12px",
+    border: "1px solid #d1d5db",
+    borderRadius: "6px",
+    fontSize: "14px",
+    fontFamily: "inherit",
+    outline: "none",
+    textTransform: "uppercase",
+    letterSpacing: "0.05em"
+  },
+  button: {
+    padding: "8px 16px",
+    border: "1px solid #d1d5db",
+    borderRadius: "6px",
+    fontSize: "14px",
+    fontFamily: "inherit",
+    cursor: "pointer",
+    backgroundColor: "#fff",
+    whiteSpace: "nowrap"
+  },
+  buttonDisabled: {
+    opacity: 0.5,
+    cursor: "not-allowed"
+  },
+  messageSuccess: {
+    color: "#16a34a",
+    fontSize: "13px",
+    margin: 0
+  },
+  messageError: {
+    color: "#dc2626",
+    fontSize: "13px",
+    margin: 0
+  }
+};
+function PromoCodeInput({
+  promo,
+  placeholder = "\u512A\u60E0\u78BC",
+  applyText = "\u5957\u7528",
+  clearText = "\u79FB\u9664",
+  disabled = false,
+  className,
+  style: containerStyle,
+  inputClassName,
+  inputStyle,
+  buttonClassName,
+  buttonStyle,
+  messageClassName,
+  messageStyle,
+  unstyled = false
+}) {
+  const [inputValue, setInputValue] = React.useState("");
+  const handleApply = React.useCallback(() => {
+    if (inputValue.trim()) {
+      promo.apply(inputValue.trim());
+    }
+  }, [inputValue, promo]);
+  const handleClear = React.useCallback(() => {
+    setInputValue("");
+    promo.clear();
+  }, [promo]);
+  const handleKeyDown = React.useCallback(
+    (e) => {
+      if (e.key === "Enter") {
+        e.preventDefault();
+        handleApply();
+      }
+    },
+    [handleApply]
+  );
+  const isApplied = promo.isValid;
+  const isDisabled = disabled || promo.isLoading;
+  const s = unstyled ? null : defaultStyles;
+  return /* @__PURE__ */ jsxRuntime.jsxs(
+    "div",
+    {
+      className,
+      style: s ? { ...s.container, ...containerStyle } : containerStyle,
+      children: [
+        /* @__PURE__ */ jsxRuntime.jsxs("div", { style: s?.row, children: [
+          /* @__PURE__ */ jsxRuntime.jsx(
+            "input",
+            {
+              type: "text",
+              value: isApplied ? promo.code || "" : inputValue,
+              onChange: (e) => setInputValue(e.target.value),
+              onKeyDown: handleKeyDown,
+              placeholder,
+              disabled: isDisabled || isApplied,
+              className: inputClassName,
+              style: s ? { ...s.input, ...inputStyle } : inputStyle,
+              "aria-label": placeholder
+            }
+          ),
+          isApplied ? /* @__PURE__ */ jsxRuntime.jsx(
+            "button",
+            {
+              type: "button",
+              onClick: handleClear,
+              disabled,
+              className: buttonClassName,
+              style: s ? { ...s.button, ...buttonStyle } : buttonStyle,
+              children: clearText
+            }
+          ) : /* @__PURE__ */ jsxRuntime.jsx(
+            "button",
+            {
+              type: "button",
+              onClick: handleApply,
+              disabled: isDisabled || !inputValue.trim(),
+              className: buttonClassName,
+              style: s ? {
+                ...s.button,
+                ...isDisabled || !inputValue.trim() ? s.buttonDisabled : {},
+                ...buttonStyle
+              } : buttonStyle,
+              children: promo.isLoading ? "\u9A57\u8B49\u4E2D..." : applyText
+            }
+          )
+        ] }),
+        promo.isValid && promo.discount && /* @__PURE__ */ jsxRuntime.jsxs(
+          "p",
+          {
+            className: messageClassName,
+            style: s ? { ...s.messageSuccess, ...messageStyle } : messageStyle,
+            role: "status",
+            children: [
+              promo.discount.label,
+              promo.discount.bonusTrialDays && promo.discount.bonusTrialDays > 0 ? ` + ${promo.discount.bonusTrialDays} \u5929\u514D\u8CBB\u8A66\u7528` : "",
+              promo.discount.bonusMonths && promo.discount.bonusMonths > 0 ? ` + \u8D08\u9001 ${promo.discount.bonusMonths} \u500B\u6708` : ""
+            ]
+          }
+        ),
+        promo.error && /* @__PURE__ */ jsxRuntime.jsx(
+          "p",
+          {
+            className: messageClassName,
+            style: s ? { ...s.messageError, ...messageStyle } : messageStyle,
+            role: "alert",
+            children: promo.error
+          }
+        )
+      ]
+    }
+  );
+}
 function useCustomer() {
   const context = React.useContext(CustomerContext);
   if (!context) {
@@ -3824,9 +4090,11 @@ function useCustomer() {
   };
 }
 
+exports.PromoCodeInput = PromoCodeInput;
 exports.RecurProvider = RecurProvider;
 exports.useCustomer = useCustomer;
 exports.usePlans = useProducts;
 exports.useProducts = useProducts;
+exports.usePromoCode = usePromoCode;
 exports.useRecur = useRecur;
 exports.useSubscribe = useSubscribe;

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import React from 'react';
+import React, { CSSProperties } from 'react';
 
 /**
  * Recur Loading Spinner Web Component
@@ -1313,6 +1313,218 @@ interface UseSubscribeResult {
  */
 declare function useSubscribe(options?: UseSubscribeOptions): UseSubscribeResult;
 
+interface UsePromoCodeOptions {
+    /**
+     * Customer identifier from your system (external ID).
+     * Required for publishable key validation — the API rejects requests without it.
+     */
+    customerId?: string;
+    /**
+     * Recur internal customer ID (alternative to customerId).
+     * Use this if you already have the Recur customer ID.
+     */
+    recurCustomerId?: string;
+    /**
+     * Publishable API key. If omitted, falls back to RecurProvider context.
+     * This allows standalone usage without wrapping in RecurProvider.
+     *
+     * @example 'pk_test_abc123...'
+     */
+    publishableKey?: string;
+    /**
+     * Base URL for API calls. Defaults to 'https://api.recur.tw'.
+     */
+    baseUrl?: string;
+}
+type PromoCodeStatus = 'idle' | 'validating' | 'valid' | 'invalid' | 'already_used';
+interface PromoCodeDiscount {
+    /** Discount type */
+    type: 'PERCENTAGE' | 'FIXED_AMOUNT' | 'FIRST_PERIOD_PRICE';
+    /** Raw discount value (basis points for %, TWD for fixed) */
+    amount: number;
+    /** Final amount after discount (0 if no amount was provided) */
+    discountedAmount: number;
+    /** Human-readable label (e.g., "20% off", "NT$100 off") */
+    label: string;
+    /** Bonus trial days */
+    bonusTrialDays?: number;
+    /** Bonus months */
+    bonusMonths?: number;
+}
+interface ApplicableProduct {
+    id: string;
+    name: string;
+    price: number;
+    priceAfterDiscount: number;
+    interval?: string | null;
+    intervalCount?: number | null;
+}
+interface UsePromoCodeReturn {
+    /**
+     * Validate and apply a promo code.
+     * Call this on button click or input blur.
+     */
+    apply: (code: string) => Promise<void>;
+    /**
+     * Clear the current promo code state.
+     */
+    clear: () => void;
+    /** Current status */
+    status: PromoCodeStatus;
+    /** Whether a validation request is in progress */
+    isLoading: boolean;
+    /** Whether the current code is valid */
+    isValid: boolean;
+    /**
+     * The validated promo code string.
+     * Pass this directly to subscribe() — null if no valid code.
+     */
+    code: string | null;
+    /** Discount details (when valid) */
+    discount: PromoCodeDiscount | null;
+    /** Whether the discount applies to all products */
+    appliesToAllProducts: boolean;
+    /** Applicable products with discounted prices (when restricted to specific products) */
+    applicableProducts: ApplicableProduct[];
+    /** Error message (when invalid) */
+    error: string | null;
+}
+/**
+ * usePromoCode Hook
+ *
+ * Validate promotion codes and get discount information.
+ * Works with or without RecurProvider.
+ *
+ * @example With RecurProvider (publishableKey from context)
+ * ```tsx
+ * <RecurProvider config={{ publishableKey: 'pk_test_xxx' }}>
+ *   <PricingPage />
+ * </RecurProvider>
+ *
+ * function PricingPage() {
+ *   const promo = usePromoCode({ customerId: 'user_123' })
+ *
+ *   return (
+ *     <div>
+ *       <input onBlur={(e) => promo.apply(e.target.value)} />
+ *       {promo.isValid && <span>{promo.discount.label}</span>}
+ *       {promo.error && <span>{promo.error}</span>}
+ *     </div>
+ *   )
+ * }
+ * ```
+ *
+ * @example Standalone (no RecurProvider needed)
+ * ```tsx
+ * function PricingPage() {
+ *   const promo = usePromoCode({
+ *     publishableKey: 'pk_test_xxx',
+ *     customerId: 'user_123',
+ *   })
+ *   // ... same usage
+ * }
+ * ```
+ */
+declare function usePromoCode(options?: UsePromoCodeOptions): UsePromoCodeReturn;
+
+interface PromoCodeInputProps {
+    /**
+     * Return value from usePromoCode().
+     * The component reads state and calls apply/clear from this object.
+     */
+    promo: UsePromoCodeReturn;
+    /**
+     * Input placeholder text
+     * @default "優惠碼"
+     */
+    placeholder?: string;
+    /**
+     * Apply button text
+     * @default "套用"
+     */
+    applyText?: string;
+    /**
+     * Clear button text (shown when a code is applied)
+     * @default "移除"
+     */
+    clearText?: string;
+    /**
+     * Disable the input and button
+     */
+    disabled?: boolean;
+    /**
+     * CSS class for the outer container
+     */
+    className?: string;
+    /**
+     * Inline styles for the outer container
+     */
+    style?: CSSProperties;
+    /**
+     * CSS class for the input element
+     */
+    inputClassName?: string;
+    /**
+     * Inline styles for the input element
+     */
+    inputStyle?: CSSProperties;
+    /**
+     * CSS class for the apply/clear button
+     */
+    buttonClassName?: string;
+    /**
+     * Inline styles for the apply/clear button
+     */
+    buttonStyle?: CSSProperties;
+    /**
+     * CSS class for the status message (success/error)
+     */
+    messageClassName?: string;
+    /**
+     * Inline styles for the status message
+     */
+    messageStyle?: CSSProperties;
+    /**
+     * When true, renders without any default inline styles.
+     * Use this when you want full control via className and style props.
+     * @default false
+     */
+    unstyled?: boolean;
+}
+/**
+ * PromoCodeInput
+ *
+ * A drop-in promo code input component that works with usePromoCode().
+ *
+ * @example Minimal usage
+ * ```tsx
+ * const promo = usePromoCode({ customerId: 'user_123' });
+ * <PromoCodeInput promo={promo} />
+ * ```
+ *
+ * @example Custom styling with className (Tailwind)
+ * ```tsx
+ * <PromoCodeInput
+ *   promo={promo}
+ *   unstyled
+ *   className="flex flex-col gap-1"
+ *   inputClassName="border rounded px-3 py-2 uppercase"
+ *   buttonClassName="bg-blue-500 text-white px-4 py-2 rounded"
+ *   messageClassName="text-sm"
+ * />
+ * ```
+ *
+ * @example Custom styling with style props
+ * ```tsx
+ * <PromoCodeInput
+ *   promo={promo}
+ *   inputStyle={{ border: '2px solid #3b82f6', borderRadius: 8 }}
+ *   buttonStyle={{ backgroundColor: '#3b82f6', color: 'white' }}
+ * />
+ * ```
+ */
+declare function PromoCodeInput({ promo, placeholder, applyText, clearText, disabled, className, style: containerStyle, inputClassName, inputStyle, buttonClassName, buttonStyle, messageClassName, messageStyle, unstyled, }: PromoCodeInputProps): react_jsx_runtime.JSX.Element;
+
 /**
  * useCustomer Hook
  *
@@ -1460,4 +1672,4 @@ declare function useSubscribe(options?: UseSubscribeOptions): UseSubscribeResult
  */
 declare function useCustomer(): UseCustomerResult;
 
-export { type ApiErrorCode, type CheckDeniedReason, type CheckOptions, type CheckResult, type CheckoutError, type CheckoutErrorDetails, type CheckoutOptions, type CheckoutResult, type CustomerIdentifier, type DuplicateSubscriptionDetails, type Entitlement, type EntitlementCustomer, type EntitlementStatus, type EntitlementSubscription, type PaymentFailedAction, type PaymentFailureCode, type PaymentFailureDetails, type Plan, type PlansResult, type Product, type ProductMetadata, type ProductsResult, type RecurConfig, type RecurContextValue, RecurProvider, type RecurProviderProps, type SubscriptionResult, type UseCustomerResult, type UseProductsOptions as UsePlansOptions, type UseProductsResult as UsePlansResult, type UseProductsOptions, type UseProductsResult, type UseSubscribeOptions, type UseSubscribeResult, useCustomer, useProducts as usePlans, useProducts, useRecur, useSubscribe };
+export { type ApiErrorCode, type ApplicableProduct, type CheckDeniedReason, type CheckOptions, type CheckResult, type CheckoutError, type CheckoutErrorDetails, type CheckoutOptions, type CheckoutResult, type CustomerIdentifier, type DuplicateSubscriptionDetails, type Entitlement, type EntitlementCustomer, type EntitlementStatus, type EntitlementSubscription, type PaymentFailedAction, type PaymentFailureCode, type PaymentFailureDetails, type Plan, type PlansResult, type Product, type ProductMetadata, type ProductsResult, type PromoCodeDiscount, PromoCodeInput, type PromoCodeInputProps, type PromoCodeStatus, type RecurConfig, type RecurContextValue, RecurProvider, type RecurProviderProps, type SubscriptionResult, type UseCustomerResult, type UseProductsOptions as UsePlansOptions, type UseProductsResult as UsePlansResult, type UseProductsOptions, type UseProductsResult, type UsePromoCodeOptions, type UsePromoCodeReturn, type UseSubscribeOptions, type UseSubscribeResult, useCustomer, useProducts as usePlans, useProducts, usePromoCode, useRecur, useSubscribe };