@alipay/ams-checkout 0.0.1710212811-dev.0 → 0.0.1710212811-dev.3

package/esm/common/applepay/index.d.ts

@@ -6,7 +6,7 @@
  * 2. If applicable, the use of the Software is also subject to the terms and conditions of any non-disclosure agreement signed by you and the relevant Ant Group entity.
  */
 import { IGetMerchantSession, ICompletePaymentAuthorized, ICompleteApplePay, ILogError, IApplePayTrace } from './interface';
-import { IpaymentSessionMetaData } from '../../types';
+import { ApplePaySubTypeEnum, IpaymentSessionMetaData } from '../../types';
 /**
  * Apple Pay Service
  */
@@ -30,9 +30,11 @@ declare class ApplePayService {
      */
     setApplePayParams(getMerchantSession: IGetMerchantSession, completePaymentAuthorized: ICompletePaymentAuthorized, completeApplePay: ICompleteApplePay, logError: ILogError, applePayTrace: IApplePayTrace): void;
     /**
-     * Apple Pay is enabled
+     * Is Apple Pay Enabled
+     * @param subTypeEnum
+     * @returns
      */
-    isEnabled: () => boolean;
+    canMakePayments(subTypeEnum?: ApplePaySubTypeEnum): any;
     /**
      * has Active Card in Apple Pay
      * @param merchantIdentifier

package/esm/common/applepay/index.js

@@ -16,6 +16,9 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * 2. If applicable, the use of the Software is also subject to the terms and conditions of any non-disclosure agreement signed by you and the relevant Ant Group entity.
  */
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import { APPLE_PAY_VERSION, APPLE_PAY_RECURRING_VERSION } from "./interface";
+import { ApplePaySubTypeEnum } from "../../types";
+
 /**
  * Apple Pay Service
  */
@@ -31,12 +34,6 @@ var ApplePayService = /*#__PURE__*/function () {
     _defineProperty(this, "completeApplePay", void 0);
     _defineProperty(this, "logError", void 0);
     _defineProperty(this, "applePayTrace", void 0);
-    /**
-     * Apple Pay is enabled
-     */
-    _defineProperty(this, "isEnabled", function () {
-      return window.ApplePaySession ? window.ApplePaySession.canMakePayments() : false;
-    });
     _defineProperty(this, "onvalidatemerchant", function (event) {
       _this.applePayTrace('onValidateMerchant');
       _this.getMerchantSession({
@@ -88,23 +85,71 @@ var ApplePayService = /*#__PURE__*/function () {
         throw Error('ApplePaySession is null in window');
       }
       var paymentSessionFactor = param.paymentSessionFactor;
-      var applePay = paymentSessionFactor.applePay,
+      var extendInfo = paymentSessionFactor.extendInfo,
         merchantInfo = paymentSessionFactor.merchantInfo,
         paymentAmount = paymentSessionFactor.paymentAmount,
-        order = paymentSessionFactor.order;
+        order = paymentSessionFactor.order,
+        recurringInfo = paymentSessionFactor.recurringInfo;
       _this.merchantIdentifier = merchantInfo === null || merchantInfo === void 0 ? void 0 : merchantInfo.partnerId;
-      var request = {
-        merchantCapabilities: applePay === null || applePay === void 0 ? void 0 : applePay.merchantCapabilities,
-        supportedNetworks: applePay === null || applePay === void 0 ? void 0 : applePay.supportedNetworks,
-        countryCode: merchantInfo === null || merchantInfo === void 0 ? void 0 : merchantInfo.registeredCountry,
-        currencyCode: paymentAmount === null || paymentAmount === void 0 ? void 0 : paymentAmount.currency,
-        total: {
-          type: 'final',
-          label: order === null || order === void 0 ? void 0 : order.orderDescription,
-          amount: paymentAmount === null || paymentAmount === void 0 ? void 0 : paymentAmount.value
+      if (!(extendInfo !== null && extendInfo !== void 0 && extendInfo.merchantCapabilities) || !(extendInfo !== null && extendInfo !== void 0 && extendInfo.supportedNetworks) || !(merchantInfo !== null && merchantInfo !== void 0 && merchantInfo.registeredCountry) || !(paymentAmount !== null && paymentAmount !== void 0 && paymentAmount.currency) || !(paymentAmount !== null && paymentAmount !== void 0 && paymentAmount.value)) {
+        _this.logError("invalid session data");
+        return;
+      }
+      // todo 补充参数校验
+      if (recurringInfo) {
+        var _recurringInfo$interv;
+        if (!(order !== null && order !== void 0 && order.orderDescription) || recurringInfo !== null && recurringInfo !== void 0 && recurringInfo.managementURL) {
+          _this.logError("invalid session data");
+          return;
         }
-      };
-      _this.session = new ApplePaySession(2, request);
+        // && order
+        var lineItem = {
+          type: 'final',
+          label: recurringInfo.title,
+          amount: paymentAmount === null || paymentAmount === void 0 ? void 0 : paymentAmount.value,
+          paymentTiming: "recurring",
+          recurringPaymentStartDate: recurringInfo !== null && recurringInfo !== void 0 && recurringInfo.startDate ? new Date(recurringInfo.startDate) : null,
+          recurringPaymentEndDate: recurringInfo !== null && recurringInfo !== void 0 && recurringInfo.endDate ? new Date(recurringInfo.endDate) : null,
+          recurringPaymentIntervalUnit: recurringInfo !== null && recurringInfo !== void 0 && recurringInfo.intervalUnit ? recurringInfo.intervalUnit : "month",
+          recurringPaymentIntervalCount: (_recurringInfo$interv = recurringInfo === null || recurringInfo === void 0 ? void 0 : recurringInfo.intervalCount) !== null && _recurringInfo$interv !== void 0 ? _recurringInfo$interv : 1
+        };
+        var recurringRequest = {
+          // 不知道显示在哪里
+          paymentDescription: order === null || order === void 0 ? void 0 : order.orderDescription,
+          billingAgreement: recurringInfo.agreementDescription,
+          // todo
+          regularBilling: lineItem,
+          managementURL: recurringInfo === null || recurringInfo === void 0 ? void 0 : recurringInfo.managementURL,
+          tokenNotificationURL: recurringInfo === null || recurringInfo === void 0 ? void 0 : recurringInfo.tokenNotificationURL
+        };
+        var request = {
+          merchantCapabilities: extendInfo === null || extendInfo === void 0 ? void 0 : extendInfo.merchantCapabilities,
+          supportedNetworks: extendInfo === null || extendInfo === void 0 ? void 0 : extendInfo.supportedNetworks,
+          countryCode: merchantInfo === null || merchantInfo === void 0 ? void 0 : merchantInfo.registeredCountry,
+          currencyCode: paymentAmount === null || paymentAmount === void 0 ? void 0 : paymentAmount.currency,
+          total: {
+            type: 'final',
+            label: extendInfo === null || extendInfo === void 0 ? void 0 : extendInfo.merchantName,
+            amount: paymentAmount === null || paymentAmount === void 0 ? void 0 : paymentAmount.value
+          },
+          recurringPaymentRequest: recurringRequest,
+          lineItems: [lineItem]
+        };
+        _this.session = new ApplePaySession(APPLE_PAY_RECURRING_VERSION, request);
+      } else {
+        var _request = {
+          merchantCapabilities: extendInfo === null || extendInfo === void 0 ? void 0 : extendInfo.merchantCapabilities,
+          supportedNetworks: extendInfo === null || extendInfo === void 0 ? void 0 : extendInfo.supportedNetworks,
+          countryCode: merchantInfo === null || merchantInfo === void 0 ? void 0 : merchantInfo.registeredCountry,
+          currencyCode: paymentAmount === null || paymentAmount === void 0 ? void 0 : paymentAmount.currency,
+          total: {
+            type: 'final',
+            label: extendInfo === null || extendInfo === void 0 ? void 0 : extendInfo.merchantName,
+            amount: paymentAmount === null || paymentAmount === void 0 ? void 0 : paymentAmount.value
+          }
+        };
+        _this.session = new ApplePaySession(APPLE_PAY_VERSION, _request);
+      }
       _this.session.onvalidatemerchant = _this.onvalidatemerchant;
       _this.session.onpaymentauthorized = _this.onpaymentauthorized;
       _this.session.oncancel = function () {
@@ -133,14 +178,28 @@ var ApplePayService = /*#__PURE__*/function () {
       this.logError = logError;
       this.applePayTrace = applePayTrace;
     }
+
+    /**
+     * Is Apple Pay Enabled
+     * @param subTypeEnum 
+     * @returns 
+     */
   }, {
-    key: "hasActiveCard",
-    value: (
+    key: "canMakePayments",
+    value: function canMakePayments(subTypeEnum) {
+      if (ApplePaySubTypeEnum.ApplePayRecurringPayment === subTypeEnum) {
+        return window.ApplePaySession ? window.ApplePaySession.canMakePayments() && window.ApplePaySession.supportsVersion(APPLE_PAY_RECURRING_VERSION) : false;
+      }
+      return window.ApplePaySession ? window.ApplePaySession.canMakePayments() && window.ApplePaySession.supportsVersion(APPLE_PAY_VERSION) : false;
+    }
+
     /**
      * has Active Card in Apple Pay
      * @param merchantIdentifier
      */
-    function () {
+  }, {
+    key: "hasActiveCard",
+    value: (function () {
       var _hasActiveCard = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(merchantIdentifier) {
         var _window3, ApplePaySession;
         return _regeneratorRuntime().wrap(function _callee$(_context) {

package/esm/common/applepay/interface.d.ts

@@ -6,6 +6,8 @@
  * 2. If applicable, the use of the Software is also subject to the terms and conditions of any non-disclosure agreement signed by you and the relevant Ant Group entity.
  */
 export type Version = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+export declare const APPLE_PAY_VERSION = 2;
+export declare const APPLE_PAY_RECURRING_VERSION = 14;
 export interface IApplePayValidateMerchantEvent {
     validationURL: string;
 }
@@ -35,10 +37,41 @@ export interface IApplePayPaymentContact {
     countryCode: string;
 }
 export type IApplePayLineItemType = 'final' | 'pending';
+export type ApplePayPaymentTiming = "immediate" | "recurring" | "deferred" | "automaticReload";
+export type ApplePayRecurringPaymentDateUnit = "year" | "month" | "day" | "hour" | "minute";
+/**
+ *
+{
+    "label": "Subscription",
+    "amount": "20.00",
+    "type": "final",
+    "paymentTiming": "recurring",
+    "recurringPaymentStartDate": new Date("2022-01-01T00:00:00"),
+    "recurringPaymentIntervalUnit": "month",
+    "recurringPaymentIntervalCount": 6,
+    "recurringPaymentEndDate": new Date("2024-01-01T00:00:00"),
+}
+ */
 export interface IApplePayLineItem {
+    /**
+     * A value that indicates whether the line item is final or pending.
+     */
     type: IApplePayLineItemType;
+    /**
+     * A required value that’s a short, localized description of the line item.
+     */
     label: string;
+    /**
+     * A required value that’s the monetary amount of the line item.
+     */
     amount: string;
+    paymentTiming?: ApplePayPaymentTiming;
+    recurringPaymentStartDate?: Date;
+    recurringPaymentEndDate?: Date;
+    recurringPaymentIntervalUnit?: ApplePayRecurringPaymentDateUnit;
+    recurringPaymentIntervalCount?: number;
+    deferredPaymentDate?: Date;
+    automaticReloadPaymentThresholdAmount?: string;
 }
 export type applePayShippingType = 'shipping' | 'delivery' | 'storePickup' | 'servicePickup';
 export interface IApplePayShippingMethod {
@@ -75,6 +108,34 @@ export interface IApplePayPaymentRequest {
     currencyCode: string;
     shippingType?: applePayShippingType;
     shippingMethods?: IApplePayShippingMethod[];
+    recurringPaymentRequest?: IApplePayRecurringPaymentRequest;
+}
+export interface IApplePayRecurringPaymentRequest {
+    /**
+     * A description of the recurring payment that Apple Pay displays to the user in the payment sheet.
+     */
+    paymentDescription: string;
+    /**
+     * A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment.
+     */
+    billingAgreement?: string;
+    /**
+     * The regular billing cycle for the recurring payment, including start and end dates, an interval, and an interval count.
+     */
+    regularBilling: IApplePayLineItem;
+    /**
+     * 订阅试用的周期控制，暂时不需要
+     * The trial billing cycle for the recurring payment.
+     */
+    trialBilling?: IApplePayLineItem;
+    /**
+     * A URL to a web page where the user can update or delete the payment method for the recurring payment.
+     */
+    managementURL: string;
+    /**
+     * A URL you provide for receiving life-cycle notifications from the Apple Pay servers about the Apple Pay merchant token for the recurring payment.
+     */
+    tokenNotificationURL?: string;
 }
 export interface IApplePaySession {
     supportsVersion?: (version: Version) => boolean;

package/esm/common/applepay/interface.js

@@ -1 +1,73 @@
-export {};
+/**
+ * Copyright (c) 2022 International Business Group, Ant Group. All rights reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), the rights to use, copy, modify, merge, and/or distribute the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * 1. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE; and
+ * 2. If applicable, the use of the Software is also subject to the terms and conditions of any non-disclosure agreement signed by you and the relevant Ant Group entity.
+ */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_on_the_web_version_history
+
+export var APPLE_PAY_VERSION = 2;
+export var APPLE_PAY_RECURRING_VERSION = 14;
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepayvalidatemerchantevent
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepaymerchantcapability
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypaymentrequest/1916122-supportednetworks
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepaycontactfield
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypaymentcontact
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepaylineitemtype
+
+//https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypaymenttiming
+
+//https://developer.apple.com/documentation/apple_pay_on_the_web/applepayrecurringpaymentdateunit
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepaylineitem
+/**
+ * 
+{
+    "label": "Subscription",
+    "amount": "20.00",
+    "type": "final",
+    "paymentTiming": "recurring",
+    "recurringPaymentStartDate": new Date("2022-01-01T00:00:00"),
+    "recurringPaymentIntervalUnit": "month",
+    "recurringPaymentIntervalCount": 6,
+    "recurringPaymentEndDate": new Date("2024-01-01T00:00:00"),
+}
+ */
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepayshippingtype
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepayshippingmethod
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypaymentauthorizedevent
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/apple_pay_js_api/apple_pay_status_codes
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypaymentauthorizationresult
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypaymentrequest
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepayrecurringpaymentrequest
+
+// https://developer.apple.com/documentation/apple_pay_on_the_web/applepaysession
+
+// IGetMerchantSession spi type
+
+// ICompletePaymentAuthorized spi type
+
+// ICompleteApplePay spi type
+
+// ILogError spi type
+
+// trace msg type
+
+// IApplePayTrace spi type

package/esm/core/applepay/index.d.ts

@@ -5,7 +5,7 @@
  * 1. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE; and
  * 2. If applicable, the use of the Software is also subject to the terms and conditions of any non-disclosure agreement signed by you and the relevant Ant Group entity.
  */
-import { IApplePayOptionsParams } from '../../types';
+import { ApplePaySubTypeEnum, IApplePayOptionsParams } from '../../types';
 import CoreInstance from '../instance';
 /**
  * Apple pay Component
@@ -20,8 +20,10 @@ declare class ApplePayComponent extends CoreInstance {
     private logDeviceId;
     /**
      * Is Apple Pay Enabled
+     * @param subTypeEnum
+     * @returns
      */
-    isAppPayEnabled(): boolean;
+    canMakePayments(subTypeEnum?: ApplePaySubTypeEnum): any;
     /**
      * Submit Pay
      * @param paymentSessionData

package/esm/core/applepay/index.js

@@ -132,11 +132,13 @@ var ApplePayComponent = /*#__PURE__*/function (_CoreInstance) {
 
     /**
      * Is Apple Pay Enabled
+     * @param subTypeEnum 
+     * @returns 
      */
   }, {
-    key: "isAppPayEnabled",
-    value: function isAppPayEnabled() {
-      return this._applePayService.isEnabled();
+    key: "canMakePayments",
+    value: function canMakePayments(subTypeEnum) {
+      return window.ApplePaySession ? this._applePayService.canMakePayments(subTypeEnum) : false;
     }
 
     /**
@@ -356,7 +358,6 @@ var ApplePayComponent = /*#__PURE__*/function (_CoreInstance) {
           biz: 'sdk'
         }).send();
       };
-
       // set Apple Pay params
       this._applePayService.setApplePayParams(getMerchantSession, completePaymentAuthorized, completeApplePay, logError, applePayTrace);
 

package/esm/types/index.d.ts

@@ -135,16 +135,17 @@ export interface IpaymentSessionMetaData {
         skipSdkQuery: boolean;
     };
     paymentSessionFactor?: {
-        applePay?: {
+        extendInfo?: {
             merchantCapabilities?: string[];
             supportedNetworks?: string[];
+            merchantName?: string;
         };
         merchantInfo?: {
             registeredCountry?: string;
             partnerId?: string;
         };
         order?: {
-            orderDescription?: string;
+            orderDescription: string;
         };
         paymentAmount?: {
             value?: string;
@@ -156,6 +157,43 @@ export interface IpaymentSessionMetaData {
         paymentMethodViewMetaData?: any;
         paymentRequestId?: string;
         supportedLanguages?: any;
+        /**
+         * 当前为苹果分期场景的信息
+         */
+        recurringInfo?: {
+            /**
+             * 代扣协议开始日期 不传为当前系统时间
+             */
+            startDate?: number;
+            /**
+             * 代扣协议结束日期 不传不限制结束时间
+             */
+            endDate?: number;
+            /**
+             * 付款时间间隔单位，支持："year" "month" "day" "hour" "minute" 不传默认month
+             */
+            intervalUnit?: string;
+            /**
+             * 付款时间间隔。比如每过6个月付款一次，intervalCount就是6, 不传默认为1
+             */
+            intervalCount?: number;
+            /**
+             * 分期标题信息
+             */
+            title?: string;
+            /**
+             * 分期管理页面
+             */
+            managementURL?: string;
+            /**
+             * 苹果通知ipay MAPN信息变更的地址
+             */
+            tokenNotificationURL?: string;
+            /**
+             * 分期协议描述
+             */
+            agreementDescription?: string;
+        };
     };
 }
 export declare enum localeEnum {
@@ -433,4 +471,11 @@ export interface CallbackEventInfo {
 export interface MultipleCallbackEvents {
     [key: string]: CallbackEventInfo;
 }
+export declare enum PaymentMethodTypeEnum {
+    ApplePay = "ApplePay"
+}
+export declare enum ApplePaySubTypeEnum {
+    ApplePayRecurringPayment = "ApplePayRecurringPayment"
+}
+export type SubPaymentMethodTypeEnum = ApplePaySubTypeEnum;
 export {};

package/esm/types/index.js

@@ -164,4 +164,12 @@ export var RedirectType = /*#__PURE__*/function (RedirectType) {
   RedirectType["NormalUrl"] = "NormalUrl";
   RedirectType["Unknown"] = "Unknown";
   return RedirectType;
+}({});
+export var PaymentMethodTypeEnum = /*#__PURE__*/function (PaymentMethodTypeEnum) {
+  PaymentMethodTypeEnum["ApplePay"] = "ApplePay";
+  return PaymentMethodTypeEnum;
+}({});
+export var ApplePaySubTypeEnum = /*#__PURE__*/function (ApplePaySubTypeEnum) {
+  ApplePaySubTypeEnum["ApplePayRecurringPayment"] = "ApplePayRecurringPayment";
+  return ApplePaySubTypeEnum;
 }({});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alipay/ams-checkout",
-  "version": "0.0.1710212811-dev.0",
+  "version": "0.0.1710212811-dev.3",
   "description": "",
   "author": "",
   "main": "esm/index.js",