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

package/dist/index.d.ts

@@ -1,10 +1,38 @@
-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.union([FieldNameEnum, PrivateFieldNameEnum]);
+
+declare type AllFieldNames = z.infer<typeof AllFieldNames>;
+
+/**
+ * Payment requests
+ */
+declare const Amount = z.object({
+    amountAtom: z.number(),
+    currency: RequiredString,
+});
+
+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.object({
+    provider: z.string(),
+    processor_name: nullOrUndefOr(z.string()),
+    metadata: nullOrUndefOr(z.record(z.string(), z.any())),
+});
+
+declare type CheckoutPaymentMethod = z.infer<typeof CheckoutPaymentMethod>;
 
 export declare type Config = Omit<ElementsFormProps, 'children'> & {
     formTarget?: string;
@@ -18,9 +46,60 @@ 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) =>
+BaseElementsStyle.extend({
+    placeholder: placeholderType,
+});
+
+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
+ */
+
+// 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',
+}
 
 export declare class OpenPayForm {
     config: Config;
@@ -55,4 +134,14 @@ export declare class OpenPayForm {
     destroy(): void;
 }
 
+declare type PaymentRequestStartParams = {
+    amountToDisplayForSetupMode?: Amount;
+};
+
+declare type PaymentRequestStatus = {
+    isLoading: boolean;
+    isAvailable: boolean;
+    startFlow: (params?: PaymentRequestStartParams) => Promise<void>;
+};
+
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getopenpay/openpay-js",
-  "version": "0.1.1-alpha.1",
+  "version": "0.1.1-alpha.2",
   "description": "Accept payments through OpenPay, right on your site",
   "author": "OpenPay <info@getopenpay.com> (https://getopenpay.com)",
   "license": "ISC",
@@ -31,13 +31,13 @@
     "dev": "tsc -p tsconfig.build.json && NODE_ENV=development vite build --mode development --watch"
   },
   "dependencies": {
-    "penpal": "^6.2.2"
+    "penpal": "^6.2.2",
+    "@stripe/stripe-js": "^4.3.0"
   },
   "devDependencies": {
-    "@getopenpay/utils": "*",
     "@getopenpay/eslint-config": "*",
     "@getopenpay/typescript-config": "*",
-    "@stripe/stripe-js": "^4.3.0",
+    "@getopenpay/utils": "*",
     "@types/node": "^22.0.2",
     "@types/react": "^18.2.0",
     "@types/react-dom": "^18.2.0",