@getopenpay/openpay-js 0.1.4 → 0.1.6-alpha.720e7c5

package/dist/index.d.ts

@@ -1,23 +1,17 @@
-import { PaymentRequestPaymentMethodEvent } from '@stripe/stripe-js';
+import { PaymentRequest as PaymentRequest_2 } from '@stripe/stripe-js';
 import { z } from 'zod';
 
-declare const AllFieldNames: z.ZodUnion<[z.ZodNativeEnum<typeof FieldName>, z.ZodNativeEnum<typeof PrivateFieldName>]>;
+declare const AllFieldNames = z.union([FieldNameEnum, PrivateFieldNameEnum]);
 
 declare type AllFieldNames = z.infer<typeof AllFieldNames>;
 
 /**
  * Payment requests
  */
-declare const Amount: z.ZodObject<{
-    amountAtom: z.ZodNumber;
-    currency: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    currency: string;
-    amountAtom: number;
-}, {
-    currency: string;
-    amountAtom: number;
-}>;
+declare const Amount = z.object({
+    amountAtom: z.number(),
+    currency: RequiredString,
+});
 
 declare type Amount = z.infer<typeof Amount>;
 
@@ -32,19 +26,11 @@ declare type CdeMessage = {
 /**
  * Core models
  */
-declare const CheckoutPaymentMethod: z.ZodObject<{
-    provider: z.ZodString;
-    processor_name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    metadata: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
-}, "strip", z.ZodTypeAny, {
-    provider: string;
-    processor_name?: string | null | undefined;
-    metadata?: Record<string, any> | null | undefined;
-}, {
-    provider: string;
-    processor_name?: string | null | undefined;
-    metadata?: Record<string, any> | null | undefined;
-}>;
+declare const CheckoutPaymentMethod = z.object({
+    provider: z.string(),
+    processor_name: nullOrUndefOr(z.string()),
+    metadata: nullOrUndefOr(z.record(z.string(), z.any())),
+});
 
 declare type CheckoutPaymentMethod = z.infer<typeof CheckoutPaymentMethod>;
 
@@ -55,8 +41,9 @@ export declare type Config = ElementsFormProps & {
 declare class ConnectionManager {
     private connections;
     constructor();
-    addConnection(id: string, connection: CdeConnection): void;
+    addConnection(id: ElementType, connection: CdeConnection): void;
     getConnection(): CdeConnection;
+    getAllConnections(): Map<ElementType, CdeConnection>;
 }
 
 declare type ElementProps<PlaceholderType extends z.ZodTypeAny = z.ZodString> = {
@@ -78,234 +65,263 @@ export declare type ElementsFormProps = {
     onCheckoutError?: (message: string) => void;
     baseUrl?: string;
     formTarget?: string;
-    onPaymentRequestLoad?: (paymentRequests: Record<'apple_pay' | 'google_pay', PaymentRequestStatus>) => void;
+    onPaymentRequestLoad?: (paymentRequests: Record<PaymentRequestProvider, PaymentRequestStatus>) => void;
 };
 
-declare const ElementsStyle: <T extends z.ZodTypeAny>(placeholderType: T) => z.ZodObject<z.objectUtil.extendShape<{
-    backgroundColor: z.ZodOptional<z.ZodString>;
-    color: z.ZodOptional<z.ZodString>;
-    fontFamily: z.ZodOptional<z.ZodString>;
-    fontSize: z.ZodOptional<z.ZodString>;
-    fontWeight: z.ZodOptional<z.ZodString>;
-    margin: z.ZodOptional<z.ZodString>;
-    padding: z.ZodOptional<z.ZodString>;
-    letterSpacing: z.ZodOptional<z.ZodString>;
-    lineHeight: z.ZodOptional<z.ZodString>;
-}, {
-    placeholder: T;
-    placeholderStyle: z.ZodOptional<z.ZodObject<{
-        color: z.ZodOptional<z.ZodString>;
-        fontSize: z.ZodOptional<z.ZodString>;
-        fontWeight: z.ZodOptional<z.ZodString>;
-        fontFamily: z.ZodOptional<z.ZodString>;
-        letterSpacing: z.ZodOptional<z.ZodString>;
-        lineHeight: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        color?: string | undefined;
-        fontFamily?: string | undefined;
-        fontSize?: string | undefined;
-        fontWeight?: string | undefined;
-        letterSpacing?: string | undefined;
-        lineHeight?: string | undefined;
-    }, {
-        color?: string | undefined;
-        fontFamily?: string | undefined;
-        fontSize?: string | undefined;
-        fontWeight?: string | undefined;
-        letterSpacing?: string | undefined;
-        lineHeight?: string | undefined;
-    }>>;
-}>, "strip", z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<z.objectUtil.extendShape<{
-    backgroundColor: z.ZodOptional<z.ZodString>;
-    color: z.ZodOptional<z.ZodString>;
-    fontFamily: z.ZodOptional<z.ZodString>;
-    fontSize: z.ZodOptional<z.ZodString>;
-    fontWeight: z.ZodOptional<z.ZodString>;
-    margin: z.ZodOptional<z.ZodString>;
-    padding: z.ZodOptional<z.ZodString>;
-    letterSpacing: z.ZodOptional<z.ZodString>;
-    lineHeight: z.ZodOptional<z.ZodString>;
-}, {
-    placeholder: T;
-    placeholderStyle: z.ZodOptional<z.ZodObject<{
-        color: z.ZodOptional<z.ZodString>;
-        fontSize: z.ZodOptional<z.ZodString>;
-        fontWeight: z.ZodOptional<z.ZodString>;
-        fontFamily: z.ZodOptional<z.ZodString>;
-        letterSpacing: z.ZodOptional<z.ZodString>;
-        lineHeight: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        color?: string | undefined;
-        fontFamily?: string | undefined;
-        fontSize?: string | undefined;
-        fontWeight?: string | undefined;
-        letterSpacing?: string | undefined;
-        lineHeight?: string | undefined;
-    }, {
-        color?: string | undefined;
-        fontFamily?: string | undefined;
-        fontSize?: string | undefined;
-        fontWeight?: string | undefined;
-        letterSpacing?: string | undefined;
-        lineHeight?: string | undefined;
-    }>>;
-}>>, any> extends infer T_1 ? { [k in keyof T_1]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<z.objectUtil.extendShape<{
-        backgroundColor: z.ZodOptional<z.ZodString>;
-        color: z.ZodOptional<z.ZodString>;
-        fontFamily: z.ZodOptional<z.ZodString>;
-        fontSize: z.ZodOptional<z.ZodString>;
-        fontWeight: z.ZodOptional<z.ZodString>;
-        margin: z.ZodOptional<z.ZodString>;
-        padding: z.ZodOptional<z.ZodString>;
-        letterSpacing: z.ZodOptional<z.ZodString>;
-        lineHeight: z.ZodOptional<z.ZodString>;
-    }, {
-        placeholder: T;
-        placeholderStyle: z.ZodOptional<z.ZodObject<{
-            color: z.ZodOptional<z.ZodString>;
-            fontSize: z.ZodOptional<z.ZodString>;
-            fontWeight: z.ZodOptional<z.ZodString>;
-            fontFamily: z.ZodOptional<z.ZodString>;
-            letterSpacing: z.ZodOptional<z.ZodString>;
-            lineHeight: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            color?: string | undefined;
-            fontFamily?: string | undefined;
-            fontSize?: string | undefined;
-            fontWeight?: string | undefined;
-            letterSpacing?: string | undefined;
-            lineHeight?: string | undefined;
-        }, {
-            color?: string | undefined;
-            fontFamily?: string | undefined;
-            fontSize?: string | undefined;
-            fontWeight?: string | undefined;
-            letterSpacing?: string | undefined;
-            lineHeight?: string | undefined;
-        }>>;
-    }>>, any>[k]; } : never, z.baseObjectInputType<z.objectUtil.extendShape<{
-    backgroundColor: z.ZodOptional<z.ZodString>;
-    color: z.ZodOptional<z.ZodString>;
-    fontFamily: z.ZodOptional<z.ZodString>;
-    fontSize: z.ZodOptional<z.ZodString>;
-    fontWeight: z.ZodOptional<z.ZodString>;
-    margin: z.ZodOptional<z.ZodString>;
-    padding: z.ZodOptional<z.ZodString>;
-    letterSpacing: z.ZodOptional<z.ZodString>;
-    lineHeight: z.ZodOptional<z.ZodString>;
-}, {
-    placeholder: T;
-    placeholderStyle: z.ZodOptional<z.ZodObject<{
-        color: z.ZodOptional<z.ZodString>;
-        fontSize: z.ZodOptional<z.ZodString>;
-        fontWeight: z.ZodOptional<z.ZodString>;
-        fontFamily: z.ZodOptional<z.ZodString>;
-        letterSpacing: z.ZodOptional<z.ZodString>;
-        lineHeight: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        color?: string | undefined;
-        fontFamily?: string | undefined;
-        fontSize?: string | undefined;
-        fontWeight?: string | undefined;
-        letterSpacing?: string | undefined;
-        lineHeight?: string | undefined;
-    }, {
-        color?: string | undefined;
-        fontFamily?: string | undefined;
-        fontSize?: string | undefined;
-        fontWeight?: string | undefined;
-        letterSpacing?: string | undefined;
-        lineHeight?: string | undefined;
-    }>>;
-}>> extends infer T_2 ? { [k_1 in keyof T_2]: z.baseObjectInputType<z.objectUtil.extendShape<{
-        backgroundColor: z.ZodOptional<z.ZodString>;
-        color: z.ZodOptional<z.ZodString>;
-        fontFamily: z.ZodOptional<z.ZodString>;
-        fontSize: z.ZodOptional<z.ZodString>;
-        fontWeight: z.ZodOptional<z.ZodString>;
-        margin: z.ZodOptional<z.ZodString>;
-        padding: z.ZodOptional<z.ZodString>;
-        letterSpacing: z.ZodOptional<z.ZodString>;
-        lineHeight: z.ZodOptional<z.ZodString>;
-    }, {
-        placeholder: T;
-        placeholderStyle: z.ZodOptional<z.ZodObject<{
-            color: z.ZodOptional<z.ZodString>;
-            fontSize: z.ZodOptional<z.ZodString>;
-            fontWeight: z.ZodOptional<z.ZodString>;
-            fontFamily: z.ZodOptional<z.ZodString>;
-            letterSpacing: z.ZodOptional<z.ZodString>;
-            lineHeight: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            color?: string | undefined;
-            fontFamily?: string | undefined;
-            fontSize?: string | undefined;
-            fontWeight?: string | undefined;
-            letterSpacing?: string | undefined;
-            lineHeight?: string | undefined;
-        }, {
-            color?: string | undefined;
-            fontFamily?: string | undefined;
-            fontSize?: string | undefined;
-            fontWeight?: string | undefined;
-            letterSpacing?: string | undefined;
-            lineHeight?: string | undefined;
-        }>>;
-    }>>[k_1]; } : never>;
+declare const ElementsStyle = <T extends z.ZodTypeAny>(placeholderType: T) =>
+BaseElementsStyle.extend({
+    placeholder: placeholderType,
+    placeholderStyle: z
+    .object({
+        color: OptionalString,
+        fontSize: OptionalString,
+        fontWeight: OptionalString,
+        fontFamily: OptionalString,
+        letterSpacing: OptionalString,
+        lineHeight: OptionalString,
+    })
+    .optional(),
+});
 
 declare type ElementsStyle<T extends z.ZodTypeAny> = z.infer<ReturnType<typeof ElementsStyle<T>>>;
 
-export declare type ElementType = 'card' | 'card-number' | 'card-expiry' | 'card-cvc';
+declare const ElementType = z.nativeEnum(ElementTypeEnum);
+
+declare type ElementType = z.infer<typeof ElementType>;
+
+declare enum ElementTypeEnum {
+    CARD = 'card',
+    CARD_NUMBER = 'card-number',
+    CARD_EXPIRY = 'card-expiry',
+    CARD_CVC = 'card-cvc',
+}
+
+declare type ElementTypeEnumValue = ElementTypeEnum[keyof ElementTypeEnum];
 
 /**
  * Expected input fields
  */
+
+// Supplied by the user
 export declare enum FieldName {
-    FIRST_NAME = "firstName",
-    LAST_NAME = "lastName",
-    EMAIL = "email",
-    ZIP_CODE = "zipCode",
-    CITY = "city",
-    STATE = "state",
-    COUNTRY = "country",
-    ADDRESS = "address",
-    PHONE = "phone",
-    PROMOTION_CODE = "promotionCode"
+    FIRST_NAME = 'firstName',
+    LAST_NAME = 'lastName',
+    EMAIL = 'email',
+    ZIP_CODE = 'zipCode',
+    CITY = 'city',
+    STATE = 'state',
+    COUNTRY = 'country',
+    ADDRESS = 'address',
+    PHONE = 'phone',
+    PROMOTION_CODE = 'promotionCode',
+}
+
+declare type InitOjsFlow<T extends InitOjsFlowResult> = (params: InitOjsFlowParams) => Promise<T>;
+
+declare type InitOjsFlowParams = {
+    /**
+     * Contains the context where OJS is run.
+     * Ideally this only contains "background" context (OJS-level objects), and not flow-level objects.
+     */
+    context: OjsContext;
+};
+
+declare type InitOjsFlowResult = {
+    isAvailable: boolean;
+};
+
+declare type InitStripePrFlowResult =
+| InitStripePrFlowSuccess
+| {
+    isAvailable: false;
+    reason: string;
+};
+
+declare type InitStripePrFlowSuccess = {
+    isAvailable: true;
+    // Passed to RunFlow
+    pr: PaymentRequest_2;
+    // Passed to the user
+    availableProviders: {
+        applePay: boolean;
+        googlePay: boolean;
+    };
+};
+
+declare type Loadable<T> =
+| {
+    status: 'loading';
+}
+| {
+    status: 'loaded';
+    result: T;
 }
+| {
+    status: 'error';
+    message: string;
+};
+
+declare const LoadedEventPayload = z.object({
+    type: z.literal(EventType.enum.LOADED),
+    sessionId: RequiredString,
+    totalAmountAtoms: z.number(),
+    currency: OptionalString,
+    checkoutPaymentMethods: z.array(CheckoutPaymentMethod),
+});
+
+declare type LoadedEventPayload = z.infer<typeof LoadedEventPayload>;
+
+declare type OjsContext = {
+    /**
+     * The form element for the OJS form (non-CDE form).
+     */
+    formDiv: HTMLElement;
+
+    /**
+     * The elements/partial session ID.
+     */
+    elementsSessionId: string;
+
+    /**
+     * All the checkout payment methods available in the session.
+     */
+    checkoutPaymentMethods: CheckoutPaymentMethod[];
+
+    /**
+     * All the CDE connection objects (one for each CDE iframe).
+     */
+    cdeConnections: Map<ElementType, CdeConnection>;
+
+    /**
+     * The base URL of the CDE iframe.
+     */
+    baseUrl: string;
+};
+
+declare type OjsFlow<T_PARAMS = unknown, T_INIT_RESULT extends InitOjsFlowResult = InitOjsFlowResult> = {
+    init?: InitOjsFlow<T_INIT_RESULT>;
+    run: RunOjsFlow<T_PARAMS, T_INIT_RESULT>;
+};
+
+declare type OjsFlowCallbacks = {
+    onCheckoutError: OnCheckoutError;
+    onCheckoutStarted: OnCheckoutStarted;
+    onCheckoutSuccess: OnCheckoutSuccess;
+    onSetupPaymentMethodSuccess: OnSetupPaymentMethodSuccess;
+    onValidationError: OnValidationError;
+};
+
+declare type OjsFlowParams<T_PARAMS = void, T_INIT_RESULT = void> = {
+    /**
+     * Contains the context where OJS is run.
+     * Ideally this only contains "background" context (OJS-level objects), and not flow-level objects.
+     */
+    context: OjsContext;
+
+    /**
+     * The checkout payment method object to be used for the flow.
+     */
+    checkoutPaymentMethod: CheckoutPaymentMethod;
+
+    /**
+     * Inputs from non-CDE fields (i.e. those which are part of the OJS form, but not the sensitive CDE form).
+     */
+    nonCdeFormInputs: Record<string, unknown>;
+
+    /**
+     * Lifecycle callbacks for OJS flows.
+     */
+    flowCallbacks: OjsFlowCallbacks;
+
+    /**
+     * Custom parameters for the flow.
+     */
+    customParams: T_PARAMS;
+
+    /**
+     * The result of the InitOjsFlow function.
+     */
+    initResult: T_INIT_RESULT;
+};
+
+declare const OjsFlows = {
+    // ✋ Note: For flows that require initialization, please add them to `init-flows.ts`
+
+    // Stripe
+    commonCC: {
+        run: runCommonCcFlow,
+    },
+    stripePR: {
+        init: initStripePrFlow,
+        run: runStripePrFlow,
+    },
+
+    // 👉 Add more flows here
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+} satisfies Record<string, OjsFlow<any, any>>;
+
+declare type OnCheckoutError = (message: string) => void;
+
+declare type OnCheckoutStarted = () => void;
+
+declare type OnCheckoutSuccess = (invoiceUrls: string[], subscriptionIds: string[], customerId: string) => void;
+
+declare type OnSetupPaymentMethodSuccess = (paymentMethodId: string) => void;
+
+declare type OnValidationError = (field: AllFieldNames, errors: string[], elementId?: string) => void;
 
 export declare class OpenPayForm {
     config: Config;
     formId: string;
-    sessionId: null | string;
-    checkoutPaymentMethods: Array<CheckoutPaymentMethod>;
     formTarget: string;
     checkoutFired: boolean;
+    ojsVersion: string;
     private referer;
     private eventHandler;
     private formProperties;
     private connectionManager;
-    private stripePm;
-    private paymentRequests;
+    private ojsFlowsInitialization;
+    private cdeLoadedPayload;
     private elements;
+    static ojsFlows: typeof OjsFlows;
     constructor(config: Config);
-    getStripePm(): PaymentRequestPaymentMethodEvent | undefined;
+    /**
+     * Assign the instance to the window as a singleton
+     * @param form - The OpenPayForm instance
+     */
+    static assignAsSingleton(form: OpenPayForm): void;
+    /**
+     * Get the singleton instance of OpenPayForm
+     * @returns The OpenPayForm instance
+     */
+    static getInstance(): OpenPayForm | null;
     getConnectionManager(): ConnectionManager;
     setFormHeight(height: string): void;
-    private initPaymentRequests;
-    createElement(type: ElementType, options?: ElementProps): {
-        type: ElementType;
+    tryInitOjsFlows: () => void;
+    onCdeLoaded: (payload: LoadedEventPayload) => void;
+    onStripePRStatusChange: (initStatus: Loadable<InitStripePrFlowResult>) => void;
+    createElement(elementValue: ElementTypeEnumValue, options?: ElementProps): {
+        type: ElementTypeEnum;
         node: HTMLIFrameElement;
         mount: (selector: string) => HTMLIFrameElement | undefined;
     };
     private buildQueryString;
     private connectToElement;
+    private getFormDiv;
+    private createOjsFlowContext;
+    private getNonCdeFormInputs;
+    private createOjsFlowCallbacks;
     submit(): void;
-    onUserCompletePaymentRequestUI(stripePm: PaymentRequestPaymentMethodEvent, checkoutPaymentMethod: CheckoutPaymentMethod): Promise<void>;
+    submitPaymentRequest: (provider: PaymentRequestProvider, initResult: InitStripePrFlowSuccess, params?: PaymentRequestStartParams) => Promise<void>;
     onPaymentRequestError(errMsg: string): void;
-    private initializePaymentRequests;
     destroy(): void;
 }
 
+declare const PaymentRequestProvider: z.ZodEnum<["apple_pay", "google_pay"]>;
+
+declare type PaymentRequestProvider = z.infer<typeof PaymentRequestProvider>;
+
 declare type PaymentRequestStartParams = {
     overridePaymentRequest?: {
         amount: Amount;
@@ -319,10 +335,8 @@ declare type PaymentRequestStatus = {
     startFlow: (params?: PaymentRequestStartParams) => Promise<void>;
 };
 
-declare enum PrivateFieldName {
-    CARD_NUMBER = "cardNumber",
-    CARD_EXPIRY = "cardExpiry",
-    CARD_CVC = "cardCvc"
-}
+declare type RunOjsFlow<T_PARAMS = undefined, T_INIT_RESULT = undefined> = (
+params: OjsFlowParams<T_PARAMS, T_INIT_RESULT>
+) => Promise<void>;
 
 export { }