@adobe-commerce/elsie 1.0.0-alpha1

package/dist/types/elsie/src/i18n/index.d.ts

@@ -0,0 +1,443 @@
+export type Lang = 'en_US';
+export declare const definition: {
+    default: {
+        Dropin: {
+            ExampleComponentName: {
+                item: {
+                    label: string;
+                };
+            };
+            Pagination: {
+                backwardButton: {
+                    ariaLabel: string;
+                };
+                forwardButton: {
+                    ariaLabel: string;
+                };
+            };
+            Incrementer: {
+                decreaseLabel: string;
+                increaseLabel: string;
+                label: string;
+                errorMessage: string;
+                minQuantityMessage: string;
+                maxQuantityMessage: string;
+            };
+            Modal: {
+                Close: {
+                    label: string;
+                };
+            };
+            InputPassword: {
+                placeholder: string;
+                floatingLabel: string;
+                buttonShowTitle: string;
+                buttonHideTitle: string;
+            };
+            PasswordStatusIndicator: {
+                chartTwoSymbols: string;
+                chartThreeSymbols: string;
+                chartFourSymbols: string;
+                messageLengthPassword: string;
+            };
+            InlineAlert: {
+                dismissLabel: string;
+            };
+            PriceSummary: {
+                subTotal: {
+                    label: string;
+                    withTaxes: string;
+                    withoutTaxes: string;
+                };
+                shipping: {
+                    label: string;
+                    editZipAction: string;
+                    estimated: string;
+                    estimatedDestination: string;
+                    destinationLinkAriaLabel: string;
+                    zipPlaceholder: string;
+                    withTaxes: string;
+                    withoutTaxes: string;
+                    alternateField: {
+                        zip: string;
+                        state: string;
+                    };
+                };
+                taxes: {
+                    total: string;
+                    totalOnly: string;
+                    breakdown: string;
+                    showBreakdown: string;
+                    hideBreakdown: string;
+                    estimated: string;
+                };
+                total: {
+                    estimated: string;
+                    label: string;
+                    withoutTax: string;
+                };
+            };
+            ProgressSpinner: {
+                updating: {
+                    label: string;
+                };
+                updatingChildren: {
+                    label: string;
+                };
+            };
+            PriceRange: {
+                from: {
+                    label: string;
+                };
+                to: {
+                    label: string;
+                };
+                asLowAs: {
+                    label: string;
+                };
+            };
+            Swatches: {
+                outOfStock: {
+                    label: string;
+                };
+                selected: {
+                    label: string;
+                };
+                swatch: {
+                    label: string;
+                };
+            };
+            Accordion: {
+                open: {
+                    label: string;
+                };
+                close: {
+                    label: string;
+                };
+            };
+            CartItem: {
+                each: {
+                    label: string;
+                };
+                pricePerItem: {
+                    label: string;
+                };
+                quantity: {
+                    label: string;
+                };
+                remove: {
+                    label: string;
+                };
+                removeDefault: {
+                    label: string;
+                };
+                taxIncluded: {
+                    label: string;
+                };
+                taxExcluded: {
+                    label: string;
+                };
+                updating: {
+                    label: string;
+                };
+            };
+            InputDate: {
+                picker: string;
+            };
+        };
+    };
+    en_US: {
+        Dropin: {
+            ExampleComponentName: {
+                item: {
+                    label: string;
+                };
+            };
+            Pagination: {
+                backwardButton: {
+                    ariaLabel: string;
+                };
+                forwardButton: {
+                    ariaLabel: string;
+                };
+            };
+            Incrementer: {
+                decreaseLabel: string;
+                increaseLabel: string;
+                label: string;
+                errorMessage: string;
+                minQuantityMessage: string;
+                maxQuantityMessage: string;
+            };
+            Modal: {
+                Close: {
+                    label: string;
+                };
+            };
+            InputPassword: {
+                placeholder: string;
+                floatingLabel: string;
+                buttonShowTitle: string;
+                buttonHideTitle: string;
+            };
+            PasswordStatusIndicator: {
+                chartTwoSymbols: string;
+                chartThreeSymbols: string;
+                chartFourSymbols: string;
+                messageLengthPassword: string;
+            };
+            InlineAlert: {
+                dismissLabel: string;
+            };
+            PriceSummary: {
+                subTotal: {
+                    label: string;
+                    withTaxes: string;
+                    withoutTaxes: string;
+                };
+                shipping: {
+                    label: string;
+                    editZipAction: string;
+                    estimated: string;
+                    estimatedDestination: string;
+                    destinationLinkAriaLabel: string;
+                    zipPlaceholder: string;
+                    withTaxes: string;
+                    withoutTaxes: string;
+                    alternateField: {
+                        zip: string;
+                        state: string;
+                    };
+                };
+                taxes: {
+                    total: string;
+                    totalOnly: string;
+                    breakdown: string;
+                    showBreakdown: string;
+                    hideBreakdown: string;
+                    estimated: string;
+                };
+                total: {
+                    estimated: string;
+                    label: string;
+                    withoutTax: string;
+                };
+            };
+            ProgressSpinner: {
+                updating: {
+                    label: string;
+                };
+                updatingChildren: {
+                    label: string;
+                };
+            };
+            PriceRange: {
+                from: {
+                    label: string;
+                };
+                to: {
+                    label: string;
+                };
+                asLowAs: {
+                    label: string;
+                };
+            };
+            Swatches: {
+                outOfStock: {
+                    label: string;
+                };
+                selected: {
+                    label: string;
+                };
+                swatch: {
+                    label: string;
+                };
+            };
+            Accordion: {
+                open: {
+                    label: string;
+                };
+                close: {
+                    label: string;
+                };
+            };
+            CartItem: {
+                each: {
+                    label: string;
+                };
+                pricePerItem: {
+                    label: string;
+                };
+                quantity: {
+                    label: string;
+                };
+                remove: {
+                    label: string;
+                };
+                removeDefault: {
+                    label: string;
+                };
+                taxIncluded: {
+                    label: string;
+                };
+                taxExcluded: {
+                    label: string;
+                };
+                updating: {
+                    label: string;
+                };
+            };
+            InputDate: {
+                picker: string;
+            };
+        };
+    };
+};
+export * from 'preact-i18n';
+export declare const getDefinitionByLanguage: (lang: Lang) => {
+    Dropin: {
+        ExampleComponentName: {
+            item: {
+                label: string;
+            };
+        };
+        Pagination: {
+            backwardButton: {
+                ariaLabel: string;
+            };
+            forwardButton: {
+                ariaLabel: string;
+            };
+        };
+        Incrementer: {
+            decreaseLabel: string;
+            increaseLabel: string;
+            label: string;
+            errorMessage: string;
+            minQuantityMessage: string;
+            maxQuantityMessage: string;
+        };
+        Modal: {
+            Close: {
+                label: string;
+            };
+        };
+        InputPassword: {
+            placeholder: string;
+            floatingLabel: string;
+            buttonShowTitle: string;
+            buttonHideTitle: string;
+        };
+        PasswordStatusIndicator: {
+            chartTwoSymbols: string;
+            chartThreeSymbols: string;
+            chartFourSymbols: string;
+            messageLengthPassword: string;
+        };
+        InlineAlert: {
+            dismissLabel: string;
+        };
+        PriceSummary: {
+            subTotal: {
+                label: string;
+                withTaxes: string;
+                withoutTaxes: string;
+            };
+            shipping: {
+                label: string;
+                editZipAction: string;
+                estimated: string;
+                estimatedDestination: string;
+                destinationLinkAriaLabel: string;
+                zipPlaceholder: string;
+                withTaxes: string;
+                withoutTaxes: string;
+                alternateField: {
+                    zip: string;
+                    state: string;
+                };
+            };
+            taxes: {
+                total: string;
+                totalOnly: string;
+                breakdown: string;
+                showBreakdown: string;
+                hideBreakdown: string;
+                estimated: string;
+            };
+            total: {
+                estimated: string;
+                label: string;
+                withoutTax: string;
+            };
+        };
+        ProgressSpinner: {
+            updating: {
+                label: string;
+            };
+            updatingChildren: {
+                label: string;
+            };
+        };
+        PriceRange: {
+            from: {
+                label: string;
+            };
+            to: {
+                label: string;
+            };
+            asLowAs: {
+                label: string;
+            };
+        };
+        Swatches: {
+            outOfStock: {
+                label: string;
+            };
+            selected: {
+                label: string;
+            };
+            swatch: {
+                label: string;
+            };
+        };
+        Accordion: {
+            open: {
+                label: string;
+            };
+            close: {
+                label: string;
+            };
+        };
+        CartItem: {
+            each: {
+                label: string;
+            };
+            pricePerItem: {
+                label: string;
+            };
+            quantity: {
+                label: string;
+            };
+            remove: {
+                label: string;
+            };
+            removeDefault: {
+                label: string;
+            };
+            taxIncluded: {
+                label: string;
+            };
+            taxExcluded: {
+                label: string;
+            };
+            updating: {
+                label: string;
+            };
+        };
+        InputDate: {
+            picker: string;
+        };
+    };
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/types/elsie/src/icons/index.d.ts

@@ -0,0 +1,43 @@
+export { default as Add } from './Add.svg';
+export { default as Bulk } from './Bulk.svg';
+export { default as Burger } from './Burger.svg';
+export { default as Cart } from './Cart.svg';
+export { default as Check } from './Check.svg';
+export { default as ChevronDown } from './ChevronDown.svg';
+export { default as ChevronUp } from './ChevronUp.svg';
+export { default as ChevronRight } from './ChevronRight.svg';
+export { default as Close } from './Close.svg';
+export { default as Heart } from './Heart.svg';
+export { default as Minus } from './Minus.svg';
+export { default as Placeholder } from './Placeholder.svg';
+export { default as PlaceholderFilled } from './PlaceholderFilled.svg';
+export { default as Search } from './Search.svg';
+export { default as SearchFilled } from './SearchFilled.svg';
+export { default as Sort } from './Sort.svg';
+export { default as Star } from './Star.svg';
+export { default as View } from './View.svg';
+export { default as User } from './User.svg';
+export { default as Warning } from './Warning.svg';
+export { default as Locker } from './Locker.svg';
+export { default as Wallet } from './Wallet.svg';
+export { default as Card } from './Card.svg';
+export { default as Order } from './Order.svg';
+export { default as Delivery } from './Delivery.svg';
+export { default as OrderError } from './OrderError.svg';
+export { default as OrderSuccess } from './OrderSuccess.svg';
+export { default as PaymentError } from './PaymentError.svg';
+export { default as CheckWithCircle } from './CheckWithCircle.svg';
+export { default as WarningWithCircle } from './WarningWithCircle.svg';
+export { default as WarningFilled } from './WarningFilled.svg';
+export { default as InfoFilled } from './InfoFilled.svg';
+export { default as HeartFilled } from './HeartFilled.svg';
+export { default as Trash } from './Trash.svg';
+export { default as Eye } from './Eye.svg';
+export { default as EyeClose } from './EyeClose.svg';
+export { default as Date } from './Date.svg';
+export { default as AddressBook } from './AddressBook.svg';
+export { default as EmptyBox } from './EmptyBox.svg';
+export { default as Coupon } from './Coupon.svg';
+export { default as Gift } from './Gift.svg';
+export { default as GiftCard } from './GiftCard.svg';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/elsie/src/lib/classes.d.ts

@@ -0,0 +1,6 @@
+import { JSXInternal } from 'preact/src/jsx';
+
+type ClassName = string | JSXInternal.SignalLike<string | undefined>;
+export declare const classes: (classes: Array<ClassName | [ClassName, boolean] | undefined>) => string;
+export {};
+//# sourceMappingURL=classes.d.ts.map

package/dist/types/elsie/src/lib/config.d.ts

@@ -0,0 +1,7 @@
+export declare class Config<T> {
+    private config;
+    constructor(initialConfig: T);
+    getConfig(): T;
+    setConfig(newConfig: T): void;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/types/elsie/src/lib/debounce.d.ts

@@ -0,0 +1,2 @@
+export declare const debounce: (fn: Function, ms: number) => (this: any, ...args: any[]) => void;
+//# sourceMappingURL=debounce.d.ts.map

package/dist/types/elsie/src/lib/deepmerge.d.ts

@@ -0,0 +1,5 @@
+export { default as deepmerge } from 'deepmerge';
+export declare function merge<T>(prev: T, next?: {
+    [key: string]: any;
+}): T;
+//# sourceMappingURL=deepmerge.d.ts.map

package/dist/types/elsie/src/lib/deviceUtils.d.ts

@@ -0,0 +1,2 @@
+export declare const isIOSMobileDevice: () => boolean;
+//# sourceMappingURL=deviceUtils.d.ts.map

package/dist/types/elsie/src/lib/form-values.d.ts

@@ -0,0 +1,5 @@
+export declare const getFormValues: (form: HTMLFormElement) => {
+    [k: string]: any;
+};
+export declare const getFormErrors: (form: HTMLFormElement) => {};
+//# sourceMappingURL=form-values.d.ts.map

package/dist/types/elsie/src/lib/i18n.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Convert locale from Magento standard to react-intl BCP 47 language tag
+ *
+ * @param {string} locale - A locale (e.g. `fr_FR`).
+ * @returns {string} A BCP 47 language tag (e.g. `fr-FR`).
+ */
+export declare const toLanguageTag: (locale: string) => string;
+//# sourceMappingURL=i18n.d.ts.map

package/dist/types/elsie/src/lib/image-params-keymap.d.ts

@@ -0,0 +1,4 @@
+export declare const setImageParamsKeyMap: (value: typeof this._map) => void, getImageParamsKeyMap: () => {
+    [key: string]: string;
+} | undefined;
+//# sourceMappingURL=image-params-keymap.d.ts.map

package/dist/types/elsie/src/lib/index.d.ts

@@ -0,0 +1,16 @@
+export * from './form-values';
+export * from './classes';
+export * from './deepmerge';
+export * from './debounce';
+export * from './resolve-image';
+export * from './render';
+export * from './i18n';
+export * from './initializer';
+export * from './config';
+export * from './types';
+export * from './slot';
+export * from './vcomponent';
+export * from './image-params-keymap';
+export * from './is-number';
+export * from './deviceUtils';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/elsie/src/lib/initializer.d.ts

@@ -0,0 +1,81 @@
+import { Config } from '.';
+
+type Listener = {
+    off(): void;
+};
+type Listeners<T> = (config?: T) => Array<Listener | undefined>;
+type Init<T> = (config?: T) => Promise<void>;
+type Options<T> = {
+    init: Init<T>;
+    listeners: Listeners<T>;
+};
+export type Model<T = any, D = any> = {
+    transformer?: (data: D) => T & {
+        [key: string]: any;
+    };
+};
+/**
+ * The `Initializer` class is responsible for setting up event listeners and initializing a module with the given configuration.
+ *
+ * @template T - The type of the configuration object.
+ * @class
+ */
+export declare class Initializer<T> {
+    private _listeners;
+    listeners: Listeners<T>;
+    init: Init<T>;
+    config: Config<T>;
+    /**
+     * Creates an instance of Initializer.
+     * @param options - The initialization options.
+     * @param options.init - A function that initializes the module.
+     * @param options.listeners - A function that sets up event listeners.
+     */
+    constructor({ init, listeners }: Options<T>);
+}
+type Initializers = [Initializer<any>, {
+    [key: string]: any;
+} | undefined][];
+/**
+ * The Initializers class provides methods to register, mount, and configure initializers.
+ *
+ * @class
+ *
+ * @method register - Registers a new initializer. If the initializers have already been mounted, it immediately binds the event listeners and initializes the API for the new initializer.
+ * @method mount - Mounts all registered initializers. This involves binding the event listeners and initializing the APIs for each initializer, in that order.
+ * @method setImageParamKeys - Sets the image parameter keys. These keys are used when initializing the APIs for the initializers.
+ */
+export declare class initializers {
+    static _initializers: Initializers;
+    static _mounted: boolean;
+    static _imageParamsKeyMap: {
+        [key: string]: string;
+    } | undefined;
+    /**
+     * Registers a new initializer. If the initializers have already been mounted,it immediately binds the event listeners and initializes the API for the new initializer.
+     * @param initializer - The initializer to register.
+     * @param options - Optional configuration for the initializer.
+     */
+    static register(initializer: Initializer<any>, options?: {
+        [key: string]: any;
+    }): void;
+    /**
+     * Mounts the provided initializer immediately. This involves binding the event listeners and initializing the API for the initializer.
+     */
+    static mountImmediately(initializer: Initializer<any>, options?: {
+        [key: string]: any;
+    }): Promise<void>;
+    /**
+     * Mounts all registered initializers. This involves binding the event listeners and initializing the APIs for each initializer, in that order.
+     */
+    static mount(): void;
+    /**
+     * Sets the image parameter keys. These keys are used when initializing the APIs for the initializers.
+     * @param params - The image parameter keys.
+     */
+    static setImageParamKeys(params: {
+        [key: string]: any;
+    }): void;
+}
+export {};
+//# sourceMappingURL=initializer.d.ts.map

package/dist/types/elsie/src/lib/is-number.d.ts

@@ -0,0 +1,2 @@
+export declare const isNumber: (value: number | string) => value is number;
+//# sourceMappingURL=is-number.d.ts.map

package/dist/types/elsie/src/lib/render.d.ts

@@ -0,0 +1,42 @@
+import { VNode } from 'preact';
+import { Container } from '.';
+import { Signal } from './signals';
+
+export declare const SlotQueueContext: import('preact').Context<Signal<Set<string>> | null>;
+type RenderAPI = {
+    remove: () => void;
+    setProps: (cb: (prev: any) => any) => void;
+};
+/**
+ * The `Render` class provides methods to render and unmount components, as well as to render components to a string.
+ * @class
+ *
+ * @property {Function} render - Renders a component to a root element.
+ * @property {Function} toString - Renders a component to a string.
+ */
+export declare class Render {
+    private _provider;
+    constructor(provider: VNode<any>);
+    /**
+     * Renders a container to a root element.
+     * @param Container - The container to render.
+     * @param props - The container parameters.
+     * @returns A function to render the component to a root element.
+     */
+    render<T>(Component: Container<T>, props: T): (rootElement: HTMLElement) => Promise<RenderAPI>;
+    /**
+     * UnRenders a component from a root element.
+     * @param rootElement - The root element to unmount the component from.
+     * @deprecated Use `remove` method from the returned object of the `mount` method instead.
+     */
+    unmount(rootElement: HTMLElement): void;
+    /**
+     * Renders a component to a string.
+     * @param Component - The component to render.
+     * @param props - The component props.
+     * @param options - Optional rendering options.
+     */
+    toString<T>(Component: Container<T>, props: T, options?: T): Promise<string>;
+}
+export {};
+//# sourceMappingURL=render.d.ts.map

package/dist/types/elsie/src/lib/resolve-image.d.ts

@@ -0,0 +1,10 @@
+export interface ResolveImageUrlOptions {
+    width: number;
+    height?: number;
+    auto?: string;
+    quality?: number;
+    crop?: boolean;
+    fit?: string;
+}
+export declare const generateSrcset: (imageURL: string, options: ResolveImageUrlOptions) => string | undefined;
+//# sourceMappingURL=resolve-image.d.ts.map