@dropins/tools 1.3.1-alpha02 → 1.4.0-alpha2

package/package.json

@@ -1 +1 @@
-{"name": "@dropins/tools", "version": "1.3.1-alpha02", "license": "SEE LICENSE IN LICENSE.md"}
+{"name": "@dropins/tools", "version": "1.4.0-alpha2", "license": "SEE LICENSE IN LICENSE.md"}

package/preact-compat.js

@@ -1,4 +1,4 @@
 /*! Copyright 2025 Adobe
 All Rights Reserved. */
-import{N as a,b as t,k as n,C as r,e as u,L as o,U as d,o as l,f as c,G as i,_ as m,i as f,j as E,m as _,R as S,n as p,r as C,s as R,u as y,v as I,w as L,z as N,I as O,F as T,J as b,K as h,M as x,O as D,Q as F,q as M,x as g,P as U,V,y as v,a as A,g as P,c as k,W as w,d as z,T as B,p as W,A as Y,h as j,X as q,Y as G,Z as H}from"./chunks/icons/Add.js";export{a as Children,t as Component,n as Fragment,r as PureComponent,u as StrictMode,o as Suspense,d as SuspenseList,l as __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,c as cloneElement,i as createContext,m as createElement,f as createFactory,E as createPortal,_ as createRef,S as default,p as findDOMNode,C as flushSync,R as forwardRef,y as hydrate,I as isElement,L as isFragment,N as isMemo,O as isValidElement,T as lazy,b as memo,h as render,x as startTransition,D as unmountComponentAtNode,F as unstable_batchedUpdates,M as useCallback,g as useContext,U as useDebugValue,V as useDeferredValue,v as useEffect,A as useErrorBoundary,P as useId,k as useImperativeHandle,w as useInsertionEffect,z as useLayoutEffect,B as useMemo,W as useReducer,Y as useRef,j as useState,q as useSyncExternalStore,G as useTransition,H as version};
+import{N as a,b as t,k as n,C as r,e as u,L as o,U as d,o as l,f as c,G as i,_ as m,i as f,j as E,m as _,R as S,n as p,r as C,s as R,u as y,v as I,w as L,z as N,I as O,F as T,J as b,K as h,M as x,O as D,Q as F,q as M,x as g,P as U,V,y as v,c as A,g as P,d as k,W as w,a as z,T as B,p as W,A as Y,h as j,X as q,Y as G,Z as H}from"./chunks/icons/Add.js";export{a as Children,t as Component,n as Fragment,r as PureComponent,u as StrictMode,o as Suspense,d as SuspenseList,l as __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED,c as cloneElement,i as createContext,m as createElement,f as createFactory,E as createPortal,_ as createRef,S as default,p as findDOMNode,C as flushSync,R as forwardRef,y as hydrate,I as isElement,L as isFragment,N as isMemo,O as isValidElement,T as lazy,b as memo,h as render,x as startTransition,D as unmountComponentAtNode,F as unstable_batchedUpdates,M as useCallback,g as useContext,U as useDebugValue,V as useDeferredValue,v as useEffect,A as useErrorBoundary,P as useId,k as useImperativeHandle,w as useInsertionEffect,z as useLayoutEffect,B as useMemo,W as useReducer,Y as useRef,j as useState,q as useSyncExternalStore,G as useTransition,H as version};
 //# sourceMappingURL=preact-compat.js.map

package/preact-hooks.js

@@ -1,4 +1,4 @@
 /*! Copyright 2025 Adobe
 All Rights Reserved. */
-import{q as a,x as u,P as t,y as r,a as o,g as f,c,d,T as l,p as m,A as n,h as p}from"./chunks/icons/Add.js";export{a as useCallback,u as useContext,t as useDebugValue,r as useEffect,o as useErrorBoundary,f as useId,c as useImperativeHandle,d as useLayoutEffect,l as useMemo,m as useReducer,n as useRef,p as useState};
+import{q as a,x as u,P as t,y as r,c as o,g as f,d as c,a as d,T as l,p as m,A as n,h as p}from"./chunks/icons/Add.js";export{a as useCallback,u as useContext,t as useDebugValue,r as useEffect,o as useErrorBoundary,f as useId,c as useImperativeHandle,d as useLayoutEffect,l as useMemo,m as useReducer,n as useRef,p as useState};
 //# sourceMappingURL=preact-hooks.js.map

package/types/elsie/src/components/Icon/Icon.d.ts

@@ -3,9 +3,9 @@ import { SVGProps } from 'preact/compat';
 
 export type IconType = keyof typeof import('@adobe-commerce/elsie/icons');
 export interface IconProps extends Omit<SVGProps<SVGSVGElement>, 'size'> {
-    source: FunctionComponent<SVGProps<SVGSVGElement> & {
+    source?: FunctionComponent<SVGProps<SVGSVGElement> & {
         title?: string;
-    }> | IconType;
+    }> | IconType | string;
     size?: '12' | '16' | '24' | '32' | '64' | '80';
     stroke?: '1' | '2' | '3' | '4';
     className?: string;

package/types/elsie/src/components/Portal/Portal.d.ts

@@ -0,0 +1,9 @@
+import { ComponentChildren } from 'preact';
+import { FunctionComponent } from 'preact/compat';
+
+interface PortalProps {
+    children: ComponentChildren;
+}
+export declare const Portal: FunctionComponent<PortalProps>;
+export {};
+//# sourceMappingURL=Portal.d.ts.map

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

@@ -40,4 +40,5 @@ 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';
+export { default as Edit } from './Edit.svg';
 //# sourceMappingURL=index.d.ts.map

package/types/elsie/src/lib/aem/assets.d.ts

@@ -0,0 +1,91 @@
+import { ImageProps } from '../../components';
+
+declare const AEM_ASSETS_FORMATS: readonly ["gif", "jpg", "jpeg", "png", "webp"];
+declare const AEM_ASSETS_ALLOWED_ROTATIONS: readonly [90, 180, 270];
+declare const AEM_ASSETS_ALLOWED_FLIPS: readonly ["h", "v", "hv"];
+/** The allowed formats for the `AEM Assets` image optimization API. */
+export type AemAssetsFormat = (typeof AEM_ASSETS_FORMATS)[number];
+/** The allowed rotations for the `AEM Assets` image optimization API. */
+export type AemAssetsRotation = (typeof AEM_ASSETS_ALLOWED_ROTATIONS)[number];
+/** The allowed flips for the `AEM Assets` image optimization API. */
+export type AemAssetsFlip = (typeof AEM_ASSETS_ALLOWED_FLIPS)[number];
+/**
+ * Defines a crop region of an image.
+ * @example
+ * ```ts
+ * // Crop the image to a 80% width and height, starting at 10% from the top and left.
+ * const cropSettings: AemAssetsCropSettings = {
+ *   xOrigin: 10,
+ *   yOrigin: 10,
+ *   width: 80,
+ *   height: 80,
+ * };
+ */
+export interface AemAssetsCropSettings {
+    /** The (relative) x origin of the crop (between 0 and 100) */
+    xOrigin?: number;
+    /** The (relative) y origin of the crop (between 0 and 100) */
+    yOrigin?: number;
+    /** The width of the crop (between 0 and 100) */
+    width?: number;
+    /** The height of the crop (between 0 and 100) */
+    height?: number;
+}
+/**
+ * The parameters accepted by the `AEM Assets` image optimization API.
+ * @see https://adobe-aem-assets-delivery-experimental.redoc.ly/
+ */
+export interface AemAssetsParams {
+    format: AemAssetsFormat;
+    rotate?: AemAssetsRotation;
+    flip?: AemAssetsFlip;
+    crop?: AemAssetsCropSettings;
+    width?: number;
+    height?: number;
+    quality?: number;
+    attachment?: boolean;
+    sharpen?: boolean;
+    blur?: number;
+    dpr?: number;
+    smartCrop?: string;
+    [key: string]: unknown;
+}
+type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+/** The parameters to be applied to the asset (known width required when using a slot) */
+export type AemAssetsImageSlotConfigParams = WithRequired<Partial<AemAssetsParams>, 'width'>;
+/** The configuration for an image slot. */
+export interface AemAssetsImageSlotConfig {
+    /** The alias (i.e. seoName) of the image */
+    alias: string;
+    /** The props to be applied to the underlying {@link Image} component */
+    imageProps: Partial<Omit<ImageProps, 'params' | 'width' | 'height'>> & {
+        src: string;
+    };
+    /** The parameters to be applied to the asset (known width required when using a slot) */
+    params: AemAssetsImageSlotConfigParams;
+    /** The element that will contain the image in the slot */
+    wrapper?: HTMLElement;
+}
+interface RenderContext {
+    replaceWith: (element: HTMLElement) => void;
+}
+/** Returns whether AEM Assets is enabled in the Storefront. */
+export declare function isAemAssetsEnabled(): boolean;
+/** The default optimization parameters used globally, unless overriden (per use). */
+export declare function getDefaultAemAssetsOptimizationParams(): AemAssetsParams;
+/** Returns true if the given URL is an AEM Assets URL. */
+export declare function isAemAssetsUrl(url: string | URL): boolean;
+/** Generates an optimized URL for AEM Assets. */
+export declare function generateAemAssetsOptimizedUrl(assetUrl: string, alias: string, params?: Partial<AemAssetsParams>): string;
+/**
+ * Tries to generate an optimized URL for AEM Assets. Returns the given
+ * url if AEM Assets is not enabled or is not an AEM Assets URL.
+ */
+export declare function tryGenerateAemAssetsOptimizedUrl(assetUrl: string, alias: string, params?: Partial<AemAssetsParams>): string;
+/** Creates a slot that renders an AEM Assets image. */
+export declare function makeAemAssetsImageSlot(config: AemAssetsImageSlotConfig): (ctx: RenderContext) => void;
+export declare function tryRenderAemAssetsImage(ctx: RenderContext, config: AemAssetsImageSlotConfig): void;
+export {};
+//# sourceMappingURL=assets.d.ts.map