@blocklet/payment-js 1.23.4 → 1.23.6

package/lib/index.d.ts

@@ -124,6 +124,16 @@ declare const _default: {
         getRechargeConfig: (_params: string, data?: never) => Promise<import("sequelize").InferAttributes<import("@blocklet/payment-types").PaymentCurrency, {
             omit: never;
         }>>;
+        checkRecurringSupport: (data: {
+            currency_ids: string[];
+        }, params?: never) => Promise<{
+            supported: boolean;
+            unsupported_currencies: Array<{
+                id: string;
+                name: string;
+                symbol: string;
+            }>;
+        }>;
     };
     paymentMethods: {
         create: (data: Partial<import("sequelize").InferAttributes<import("@blocklet/payment-types").PaymentMethod, {
@@ -539,3 +549,4 @@ declare const _default: {
 };
 export default _default;
 export * from '@blocklet/payment-types';
+export * from './util';

package/lib/index.js

@@ -76,3 +76,4 @@ exports.default = {
     ensureStart: resource_1.ensureStart,
 };
 __exportStar(require("@blocklet/payment-types"), exports);
+__exportStar(require("./util"), exports);

package/lib/resources/payment-currency.d.ts

@@ -1,4 +1,15 @@
 import type { RechargeConfig } from '@blocklet/payment-types';
+type CheckRecurringSupportParams = {
+    currency_ids: string[];
+};
+type CheckRecurringSupportResponse = {
+    supported: boolean;
+    unsupported_currencies: Array<{
+        id: string;
+        name: string;
+        symbol: string;
+    }>;
+};
 declare const _default: {
     create: (data: Partial<import("sequelize").InferAttributes<import("@blocklet/payment-types").PaymentCurrency, {
         omit: never;
@@ -22,5 +33,6 @@ declare const _default: {
     getRechargeConfig: (_params: string, data?: never) => Promise<import("sequelize").InferAttributes<import("@blocklet/payment-types").PaymentCurrency, {
         omit: never;
     }>>;
+    checkRecurringSupport: (data: CheckRecurringSupportParams, params?: never) => Promise<CheckRecurringSupportResponse>;
 };
 export default _default;

package/lib/resources/payment-currency.js

@@ -26,4 +26,8 @@ exports.default = {
         method: 'GET',
         path: '/api/payment-currencies/{id}/recharge-config',
     }),
+    checkRecurringSupport: (0, resource_1.createResourceCreateMethod)({
+        method: 'POST',
+        path: '/api/payment-currencies/check-recurring-support',
+    }),
 };

package/lib/util.d.ts

@@ -0,0 +1,44 @@
+declare const CURRENCY_SYMBOLS: Record<string, string>;
+/**
+ * Format credit amount for display in data contexts (balances, transactions, notifications)
+ * - If currency has symbol mapping (USD -> $): shows "$20 credits"
+ * - If no symbol mapping: shows "20 minutes" or "20 arcsphere credits"
+ *
+ * @param formattedAmount - Already formatted amount string (e.g., "20", "1,000.50")
+ * @param currencySymbol - Currency symbol (USD, EUR, minutes, etc.)
+ * @param showUnit - Whether to show the unit for non-mapped currencies (default: true)
+ * @returns Formatted credit string
+ *
+ * @example
+ * ```typescript
+ * import { formatCreditAmount } from '@blocklet/payment-js';
+ *
+ * formatCreditAmount("20", "USD")                // "$20 credits"
+ * formatCreditAmount("100", "minutes")           // "100 minutes"
+ * formatCreditAmount("50", "arcsphere credits")  // "50 arcsphere credits"
+ * formatCreditAmount("50", "custom", false)      // "50"
+ * ```
+ */
+export declare function formatCreditAmount(formattedAmount: string, currencySymbol?: string, showUnit?: boolean): string;
+/**
+ * Get currency symbol mapping
+ * @param currencySymbol - Currency code (USD, EUR, etc.)
+ * @returns Symbol string or undefined if no mapping exists
+ *
+ * @example
+ * ```typescript
+ * import { getCurrencySymbol } from '@blocklet/payment-js';
+ *
+ * getCurrencySymbol('USD');      // "$"
+ * getCurrencySymbol('EUR');      // "€"
+ * getCurrencySymbol('minutes');  // undefined
+ * ```
+ */
+export declare function getCurrencySymbol(currencySymbol: string): string | undefined;
+/**
+ * Check if a currency has a symbol mapping
+ * @param currencySymbol - Currency code
+ * @returns true if currency has a symbol mapping
+ */
+export declare function hasCurrencySymbol(currencySymbol: string): boolean;
+export { CURRENCY_SYMBOLS };

package/lib/util.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CURRENCY_SYMBOLS = void 0;
+exports.formatCreditAmount = formatCreditAmount;
+exports.getCurrencySymbol = getCurrencySymbol;
+exports.hasCurrencySymbol = hasCurrencySymbol;
+const CURRENCY_SYMBOLS = {
+    USD: '$',
+    EUR: '€',
+    GBP: '£',
+    JPY: '¥',
+    CNY: '¥',
+    KRW: '₩',
+    INR: '₹',
+    AUD: 'A$',
+    CAD: 'C$',
+    CHF: 'Fr',
+    HKD: 'HK$',
+    SGD: 'S$',
+    NZD: 'NZ$',
+};
+exports.CURRENCY_SYMBOLS = CURRENCY_SYMBOLS;
+/**
+ * Format credit amount for display in data contexts (balances, transactions, notifications)
+ * - If currency has symbol mapping (USD -> $): shows "$20 credits"
+ * - If no symbol mapping: shows "20 minutes" or "20 arcsphere credits"
+ *
+ * @param formattedAmount - Already formatted amount string (e.g., "20", "1,000.50")
+ * @param currencySymbol - Currency symbol (USD, EUR, minutes, etc.)
+ * @param showUnit - Whether to show the unit for non-mapped currencies (default: true)
+ * @returns Formatted credit string
+ *
+ * @example
+ * ```typescript
+ * import { formatCreditAmount } from '@blocklet/payment-js';
+ *
+ * formatCreditAmount("20", "USD")                // "$20 credits"
+ * formatCreditAmount("100", "minutes")           // "100 minutes"
+ * formatCreditAmount("50", "arcsphere credits")  // "50 arcsphere credits"
+ * formatCreditAmount("50", "custom", false)      // "50"
+ * ```
+ */
+function formatCreditAmount(formattedAmount, currencySymbol, showUnit = true) {
+    const mappedSymbol = CURRENCY_SYMBOLS[currencySymbol || ''];
+    if (mappedSymbol) {
+        return `${mappedSymbol}${formattedAmount} credits`;
+    }
+    return `${formattedAmount}${showUnit && currencySymbol ? ` ${currencySymbol}` : ''}`;
+}
+/**
+ * Get currency symbol mapping
+ * @param currencySymbol - Currency code (USD, EUR, etc.)
+ * @returns Symbol string or undefined if no mapping exists
+ *
+ * @example
+ * ```typescript
+ * import { getCurrencySymbol } from '@blocklet/payment-js';
+ *
+ * getCurrencySymbol('USD');      // "$"
+ * getCurrencySymbol('EUR');      // "€"
+ * getCurrencySymbol('minutes');  // undefined
+ * ```
+ */
+function getCurrencySymbol(currencySymbol) {
+    return CURRENCY_SYMBOLS[currencySymbol];
+}
+/**
+ * Check if a currency has a symbol mapping
+ * @param currencySymbol - Currency code
+ * @returns true if currency has a symbol mapping
+ */
+function hasCurrencySymbol(currencySymbol) {
+    return currencySymbol in CURRENCY_SYMBOLS;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blocklet/payment-js",
-  "version": "1.23.4",
+  "version": "1.23.6",
   "description": "Node.js client for Payment Kit",
   "keywords": [
     "types",
@@ -36,9 +36,9 @@
     "url": "https://github.com/blocklet/payment-kit/issues"
   },
   "dependencies": {
-    "@blocklet/constant": "^1.17.5",
-    "@blocklet/payment-types": "1.23.4",
-    "@blocklet/sdk": "^1.17.5"
+    "@blocklet/constant": "^1.17.6",
+    "@blocklet/payment-types": "1.23.6",
+    "@blocklet/sdk": "^1.17.6"
   },
   "importSort": {
     ".js, .jsx, .mjs": {
@@ -64,5 +64,5 @@
     "type-fest": "^4.41.0",
     "typescript": "5.5.4"
   },
-  "gitHead": "12cd3cecedb8aa3331a4a24fa093f62cc6630d5b"
+  "gitHead": "0026a41a10475159d72ade801561d6cbce0008fe"
 }