@getopenpay/openpay-js 0.1.1-alpha.1 → 0.1.1-alpha.3

package/dist/index.d.ts

@@ -1,10 +1,52 @@
-import { CdeConnection } from '@getopenpay/utils';
-import { CheckoutPaymentMethod } from '@getopenpay/utils';
-import { ElementProps } from '@getopenpay/utils';
-import { ElementsFormProps } from '@getopenpay/utils';
-import { FieldName } from '@getopenpay/utils';
 import { PaymentRequestPaymentMethodEvent } from '@stripe/stripe-js';
-import { PaymentRequestStatus } from '@getopenpay/utils';
+import { z } from 'zod';
+
+declare const AllFieldNames: z.ZodUnion<[z.ZodNativeEnum<typeof FieldName>, z.ZodNativeEnum<typeof PrivateFieldName>]>;
+
+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 type Amount = z.infer<typeof Amount>;
+
+declare type CdeConnection = {
+    send: (data: CdeMessage) => Promise<unknown>;
+};
+
+declare type CdeMessage = {
+    type: string;
+} & Record<string, unknown>;
+
+/**
+ * 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 type CheckoutPaymentMethod = z.infer<typeof CheckoutPaymentMethod>;
 
 export declare type Config = Omit<ElementsFormProps, 'children'> & {
     formTarget?: string;
@@ -18,9 +60,105 @@ declare class ConnectionManager {
     getConnection(): CdeConnection;
 }
 
+declare type ElementProps<PlaceholderType extends z.ZodTypeAny = z.ZodString> = {
+    styles?: ElementsStyle<z.ZodOptional<PlaceholderType>>;
+};
+
+declare type ElementsFormChildrenProps = {
+    submit: () => void;
+    applePay: PaymentRequestStatus;
+    googlePay: PaymentRequestStatus;
+    loaded: boolean;
+};
+
+declare type ElementsFormProps = {
+    className?: string;
+    checkoutSecureToken: string;
+    children: (props: ElementsFormChildrenProps) => JSX.Element;
+    onFocus?: (elementId: string) => void;
+    onBlur?: (elementId: string) => void;
+    onChange?: (elementId: string) => void;
+    onLoad?: (totalAmountAtoms?: number, currency?: string) => void;
+    onLoadError?: (message: string) => void;
+    onValidationError?: (field: AllFieldNames, errors: string[], elementId?: string) => void;
+    onCheckoutStarted?: () => void;
+    onCheckoutSuccess?: (invoiceUrls: string[], subscriptionIds: string[], customerId: string) => void;
+    onSetupPaymentMethodSuccess?: (paymentMethodId: string) => void;
+    onCheckoutError?: (message: string) => void;
+    baseUrl?: string;
+};
+
+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>;
+}, {
+    placeholder: T;
+}>, "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>;
+}, {
+    placeholder: T;
+}>>, 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>;
+    }, {
+        placeholder: T;
+    }>>, 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>;
+}, {
+    placeholder: T;
+}>> 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>;
+    }, {
+        placeholder: T;
+    }>>[k_1]; } : never>;
+
+declare type ElementsStyle<T extends z.ZodTypeAny> = z.infer<ReturnType<typeof ElementsStyle<T>>>;
+
 export declare type ElementType = 'card' | 'card-number' | 'card-expiry' | 'card-cvc';
 
-export { FieldName }
+/**
+ * Expected input fields
+ */
+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"
+}
 
 export declare class OpenPayForm {
     config: Config;
@@ -55,4 +193,20 @@ export declare class OpenPayForm {
     destroy(): void;
 }
 
+declare type PaymentRequestStartParams = {
+    amountToDisplayForSetupMode?: Amount;
+};
+
+declare type PaymentRequestStatus = {
+    isLoading: boolean;
+    isAvailable: boolean;
+    startFlow: (params?: PaymentRequestStartParams) => Promise<void>;
+};
+
+declare enum PrivateFieldName {
+    CARD_NUMBER = "cardNumber",
+    CARD_EXPIRY = "cardExpiry",
+    CARD_CVC = "cardCvc"
+}
+
 export { }