@foxy.io/sdk 1.11.3 → 1.13.0

package/dist/types/backend/Graph/user_invitation.d.ts

@@ -0,0 +1,38 @@
+import type { Graph } from '../../core';
+import type { Store } from './store';
+import type { User } from './user';
+
+export interface UserInvitation extends Graph {
+  curie: 'fx:user_invitation';
+  links: {
+    'self': UserInvitation;
+    'fx:user': User;
+    'fx:store': Store;
+    'fx:resend': { curie: 'fx:resend' };
+    'fx:accept': { curie: 'fx:accept' };
+    'fx:reject': { curie: 'fx:reject' };
+    'fx:revoke': { curie: 'fx:revoke' };
+  };
+  props: {
+    /* Read-only website URL of the store that the user is invited to. */
+    store_url: string;
+    /* Read-only name of the store that the user is invited to. */
+    store_name: string;
+    /* Read-only email of the store that the user is invited to. */
+    store_email: string;
+    /* Read-only (sub)domain of the store that the user is invited to. */
+    store_domain: string;
+    /* Read-only first name of the user that is invited. */
+    first_name: string | null;
+    /* Read-only last name of the user that is invited. */
+    last_name: string | null;
+    /* Read-only email of the user that is invited. */
+    email: string;
+    /* Read-only status of the invitation, `sent` on creation. Use POST actions in links to change the status. */
+    status: 'sent' | 'accepted' | 'rejected' | 'revoked' | 'expired';
+    /* Read-only date the invitation was created. */
+    date_created: string;
+    /* Read-only date the invitation was last modified. */
+    date_modified: string;
+  };
+}

package/dist/types/backend/Graph/user_invitations.d.ts

@@ -0,0 +1,10 @@
+import type { CollectionGraphLinks, CollectionGraphProps } from '../../core/defaults';
+import type { Graph } from '../../core';
+import type { UserInvitation } from './user_invitation';
+
+export interface UserInvitations extends Graph {
+  curie: 'fx:user_accesses';
+  links: CollectionGraphLinks<UserInvitations>;
+  props: CollectionGraphProps;
+  child: UserInvitation;
+}

package/dist/types/backend/Rels.d.ts

@@ -89,6 +89,8 @@ export * from './Graph/locale_codes';
 export * from './Graph/native_integration';
 export * from './Graph/native_integrations';
 export * from './Graph/original_transaction';
+export * from './Graph/passkey';
+export * from './Graph/passkeys';
 export * from './Graph/payment';
 export * from './Graph/payment_gateway';
 export * from './Graph/payment_gateways';
@@ -116,6 +118,7 @@ export * from './Graph/reporting_email_exists';
 export * from './Graph/reporting_store_domain_exists';
 export * from './Graph/reports';
 export * from './Graph/send_emails';
+export * from './Graph/send_webhooks';
 export * from './Graph/shipment';
 export * from './Graph/shipments';
 export * from './Graph/shipping_address_types';
@@ -159,6 +162,8 @@ export * from './Graph/transactions';
 export * from './Graph/user';
 export * from './Graph/user_access';
 export * from './Graph/user_accesses';
+export * from './Graph/user_invitation';
+export * from './Graph/user_invitations';
 export * from './Graph/users';
 export * from './Graph/void';
 export * from './Graph/webhook_log';

package/dist/types/customer/API.d.ts

@@ -17,6 +17,7 @@ export declare class API extends Core.API<Graph> {
     } & {
         signUpParams: any;
         credentials: any;
+        boolean: any;
         email: any;
     };
     constructor(params: ConstructorParameters<typeof Core.API>[0]);
@@ -48,5 +49,14 @@ export declare class API extends Core.API<Graph> {
     }): Promise<void>;
     /** Destroys current session and clears local session data. */
     signOut(): Promise<void>;
+    /**
+     * When logged in with a temporary password, this property getter will return `true`.
+     * Will return `false` if password reset is not required or if the session has not been
+     * initiated, or if the session was initiated before the introduction of this feature.
+     *
+     * @returns {boolean} Password reset requirement.
+     */
+    get usesTemporaryPassword(): boolean;
+    set usesTemporaryPassword(value: boolean);
     private __fetch;
 }

package/dist/types/customer/Graph/default_payment_method.d.ts

@@ -15,8 +15,8 @@ export interface DefaultPaymentMethod extends Graph {
     save_cc: boolean;
     /** The credit card or debit card type. This will be determined automatically once the payment card is saved. */
     cc_type: string | null;
-    /** The payment card number. This property will not be displayed as part of this resource, but can be used to modify this payment method. */
-    cc_number?: number;
+    /** Token returned by our Tokenization Embed. Send this field with PATCH to update customer's payment method. */
+    cc_token?: string;
     /** A masked version of this payment card showing only the last 4 digits. */
     cc_number_masked: string | null;
     /** The payment card expiration month in the MM format. */

package/dist/types/customer/Graph/index.d.ts

@@ -41,9 +41,9 @@ interface Customer extends Graph {
     /** The date of the last time this customer authenticated with the FoxyCart checkout. */
     last_login_date: string;
     /** The customer's given name. */
-    first_name: string;
+    first_name: string | null;
     /** The customer's surname. */
-    last_name: string;
+    last_name: string | null;
     /** The customer's email address. This is used as the login to the FoxyCart checkout for this customer. */
     email: string;
     /** A tax identification number for this customer. */

package/dist/types/customer/Graph/transaction_template.d.ts

@@ -32,7 +32,7 @@ export interface TransactionTemplate extends Graph {
     /** The city of this address. */
     billing_city: string;
     /** The two character code for states in the United States. Other countries may call this a province. When a two character code isn't available, use the full region name. */
-    billing_region: string;
+    billing_state: string;
     /** The postal code of the billing address. */
     billing_postal_code: string;
     /** The country code of the billing address. */
@@ -54,7 +54,7 @@ export interface TransactionTemplate extends Graph {
     /** The city of this address. */
     shipping_city: string;
     /** The two character code for states in the United States. Other countries may call this a province. When a two character code isn't available, use the full region name. */
-    shipping_region: string;
+    shipping_state: string;
     /** The postal code of the shipping address. */
     shipping_postal_code: string;
     /** The country code of the shipping address. */

package/dist/types/customer/PaymentCardEmbed.d.ts

@@ -0,0 +1,69 @@
+import type { PaymentCardEmbedConfig } from './types';
+/**
+ * A convenience wrapper for the payment card embed iframe. You don't have to use
+ * this class to embed the payment card iframe, but it provides a more convenient
+ * way to interact with the iframe and listen to its events.
+ *
+ * @example
+ * const embed = new PaymentCardEmbed({
+ *   url: 'https://embed.foxy.io/v1.html?template_set_id=123'
+ * });
+ *
+ * await embed.mount(document.body);
+ * console.log('Token:', await embed.tokenize());
+ */
+export declare class PaymentCardEmbed {
+    /**
+     * An event handler that is triggered when Enter is pressed in the card form.
+     * This feature is not available for template sets configured with the `stripe_connect`
+     * hosted payment gateway due to the limitations of Stripe.js.
+     */
+    onsubmit: (() => void) | null;
+    private __tokenizationRequests;
+    private __iframeMessageHandler;
+    private __iframeLoadHandler;
+    private __mountingTask;
+    private __channel;
+    private __iframe;
+    private __config;
+    private __url;
+    constructor({ url, ...config }: {
+        url: string;
+    } & PaymentCardEmbedConfig);
+    /**
+     * Updates the configuration of the payment card embed.
+     * You can change style, translations, language and interactivity settings.
+     * To change the URL of the payment card embed, you need to create a new instance.
+     * You are not required to provide the full configuration object, only the properties you want to change.
+     *
+     * @param config - The new configuration.
+     */
+    configure(config: PaymentCardEmbedConfig): void;
+    /**
+     * Requests the tokenization of the card data.
+     *
+     * @returns A promise that resolves with the tokenized card data.
+     */
+    tokenize(): Promise<string>;
+    /**
+     * Safely removes the embed iframe from the parent node,
+     * closing the message channel and cleaning up event listeners.
+     */
+    unmount(): void;
+    /**
+     * Mounts the payment card embed in the given root element. If the embed is already mounted,
+     * it will be unmounted first.
+     *
+     * @param root - The root element to mount the embed in.
+     * @returns A promise that resolves when the embed is mounted.
+     */
+    mount(root: Element): Promise<void>;
+    /**
+     * Clears the card data from the embed.
+     * No-op if the embed is not mounted.
+     */
+    clear(): void;
+    protected _createMessageChannel(): MessageChannel;
+    protected _createIframe(root: Element): HTMLIFrameElement;
+    protected _createId(): string;
+}

package/dist/types/customer/index.d.ts

@@ -3,6 +3,7 @@ export { getAllowedFrequencies } from './getAllowedFrequencies.js';
 export { getNextTransactionDateConstraints } from './getNextTransactionDateConstraints.js';
 export { getTimeFromFrequency } from '../backend/getTimeFromFrequency.js';
 export { isNextTransactionDate } from './isNextTransactionDate.js';
+export { PaymentCardEmbed } from './PaymentCardEmbed.js';
 import type * as Rels from './Rels';
 export type { Graph } from './Graph';
 export type { Rels };

package/dist/types/customer/types.d.ts

@@ -1,3 +1,87 @@
+/** Tokenization embed configuration that can be updated any time after mount. */
+export type PaymentCardEmbedConfig = Partial<{
+  /** Translations. Note that Stripe and Square provide their own translations that can't be customized. */
+  translations: {
+    stripe?: {
+      label?: string;
+      status?: {
+        idle?: string;
+        busy?: string;
+        fail?: string;
+      };
+    };
+    square?: {
+      label?: string;
+      status?: {
+        idle?: string;
+        busy?: string;
+        fail?: string;
+      };
+    };
+    default?: {
+      'cc-number'?: {
+        label?: string;
+        placeholder?: string;
+        v8n_required?: string;
+        v8n_invalid?: string;
+        v8n_unsupported?: string;
+      };
+      'cc-exp'?: {
+        label?: string;
+        placeholder?: string;
+        v8n_required?: string;
+        v8n_invalid?: string;
+        v8n_expired?: string;
+      };
+      'cc-csc'?: {
+        label?: string;
+        placeholder?: string;
+        v8n_required?: string;
+        v8n_invalid?: string;
+      };
+      'status'?: {
+        idle?: string;
+        busy?: string;
+        fail?: string;
+        misconfigured?: string;
+      };
+    };
+  };
+  /** If true, all fields inside the embed will be disabled. */
+  disabled: boolean;
+  /** If true, all fields inside the embed will be set to be read-only. For Stripe and Square the fields will be disabled and styled as readonly. */
+  readonly: boolean;
+  /** Appearance settings. */
+  style: Partial<{
+    '--lumo-space-m': string;
+    '--lumo-space-s': string;
+    '--lumo-contrast-5pct': string;
+    '--lumo-contrast-10pct': string;
+    '--lumo-contrast-50pct': string;
+    '--lumo-size-m': string;
+    '--lumo-size-xs': string;
+    '--lumo-border-radius-m': string;
+    '--lumo-border-radius-s': string;
+    '--lumo-font-family': string;
+    '--lumo-font-size-m': string;
+    '--lumo-font-size-s': string;
+    '--lumo-font-size-xs': string;
+    '--lumo-primary-color': string;
+    '--lumo-primary-text-color': string;
+    '--lumo-primary-color-50pct': string;
+    '--lumo-secondary-text-color': string;
+    '--lumo-disabled-text-color': string;
+    '--lumo-body-text-color': string;
+    '--lumo-error-text-color': string;
+    '--lumo-error-color-10pct': string;
+    '--lumo-error-color-50pct': string;
+    '--lumo-line-height-xs': string;
+    '--lumo-base-color': string;
+  }>;
+  /** Locale to use with Stripe or Square. Has no effect on the default UI. */
+  lang: string;
+}>;
+
 /** User credentials for authentication. */
 export interface Credentials {
   /** Email address associated with an account. */
@@ -26,6 +110,7 @@ export interface SignUpParams {
 }
 
 export interface Session {
+  force_password_reset?: boolean;
   session_token: string;
   expires_in: number;
   jwt: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@foxy.io/sdk",
   "type": "commonjs",
-  "version": "1.11.3",
+  "version": "1.13.0",
   "description": "Universal SDK for a full server-side and a limited in-browser access to Foxy hAPI.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",