@metamask-previews/design-system-react 0.28.0-preview.55a2d71 → 0.28.0-preview.ba3ace4e

package/dist/components/Icon/Icon.registry.d.cts

@@ -0,0 +1,46 @@
+import type { IconName } from "@metamask-previews/design-system-shared";
+import type { LazyExoticComponent } from "react";
+import type { IconComponentType } from "./icons/index.cjs";
+import { isIconName } from "./icons/index.cjs";
+/**
+ * Preloads all icon modules for the Jest test environment.
+ * Icons are cached as synchronous components so tests can query the DOM
+ * immediately without waiting for React.lazy resolution.
+ *
+ * @returns A promise that resolves when all icons are cached.
+ */
+export declare function preloadIconsForTests(): Promise<void>;
+/**
+ * Returns a cached React.lazy wrapper for the given icon name.
+ * Each icon is loaded on demand via dynamic import, enabling per-icon
+ * code splitting instead of bundling all ~291 icons upfront.
+ *
+ * @param name - The icon name to resolve.
+ * @returns A lazy-loaded icon component.
+ */
+export declare function getLazyIcon(name: IconName): LazyExoticComponent<IconComponentType>;
+type GetIconComponentOptions = {
+    useTestCache?: boolean;
+};
+/**
+ * Resolves an icon component for rendering.
+ * Returns a synchronously cached component when present in the test preload
+ * cache (populated by preloadIconsForTests()). Otherwise returns a React.lazy
+ * wrapper for per-icon code splitting.
+ *
+ * @param name - The icon name to resolve.
+ * @param options - Optional resolver configuration.
+ * @param options.useTestCache - When false, skips the test preload cache.
+ * @returns The icon component to render.
+ */
+export declare function getIconComponent(name: IconName, options?: GetIconComponentOptions): IconComponentType | LazyExoticComponent<IconComponentType>;
+/**
+ * Preloads an icon module so it is available synchronously on the next render.
+ * Useful for warming commonly used icons before they appear on screen.
+ *
+ * @param name - The icon name to preload.
+ * @returns A promise that resolves when the icon module has loaded.
+ */
+export declare function preloadIcon(name: IconName): Promise<void>;
+export { isIconName };
+//# sourceMappingURL=Icon.registry.d.cts.map

package/dist/components/Icon/Icon.registry.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Icon.registry.d.cts","sourceRoot":"","sources":["../../../src/components/Icon/Icon.registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,gDAAgD;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc;AAGjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,0BAAgB;AACjD,OAAO,EAAe,UAAU,EAAE,0BAAgB;AAWlD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CASpD;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,QAAQ,GACb,mBAAmB,CAAC,iBAAiB,CAAC,CASxC;AAED,KAAK,uBAAuB,GAAG;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,QAAQ,EACd,OAAO,CAAC,EAAE,uBAAuB,GAChC,iBAAiB,GAAG,mBAAmB,CAAC,iBAAiB,CAAC,CAU5D;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAEzD;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/components/Icon/Icon.registry.d.mts

@@ -0,0 +1,46 @@
+import type { IconName } from "@metamask-previews/design-system-shared";
+import type { LazyExoticComponent } from "react";
+import type { IconComponentType } from "./icons/index.mjs";
+import { isIconName } from "./icons/index.mjs";
+/**
+ * Preloads all icon modules for the Jest test environment.
+ * Icons are cached as synchronous components so tests can query the DOM
+ * immediately without waiting for React.lazy resolution.
+ *
+ * @returns A promise that resolves when all icons are cached.
+ */
+export declare function preloadIconsForTests(): Promise<void>;
+/**
+ * Returns a cached React.lazy wrapper for the given icon name.
+ * Each icon is loaded on demand via dynamic import, enabling per-icon
+ * code splitting instead of bundling all ~291 icons upfront.
+ *
+ * @param name - The icon name to resolve.
+ * @returns A lazy-loaded icon component.
+ */
+export declare function getLazyIcon(name: IconName): LazyExoticComponent<IconComponentType>;
+type GetIconComponentOptions = {
+    useTestCache?: boolean;
+};
+/**
+ * Resolves an icon component for rendering.
+ * Returns a synchronously cached component when present in the test preload
+ * cache (populated by preloadIconsForTests()). Otherwise returns a React.lazy
+ * wrapper for per-icon code splitting.
+ *
+ * @param name - The icon name to resolve.
+ * @param options - Optional resolver configuration.
+ * @param options.useTestCache - When false, skips the test preload cache.
+ * @returns The icon component to render.
+ */
+export declare function getIconComponent(name: IconName, options?: GetIconComponentOptions): IconComponentType | LazyExoticComponent<IconComponentType>;
+/**
+ * Preloads an icon module so it is available synchronously on the next render.
+ * Useful for warming commonly used icons before they appear on screen.
+ *
+ * @param name - The icon name to preload.
+ * @returns A promise that resolves when the icon module has loaded.
+ */
+export declare function preloadIcon(name: IconName): Promise<void>;
+export { isIconName };
+//# sourceMappingURL=Icon.registry.d.mts.map

package/dist/components/Icon/Icon.registry.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Icon.registry.d.mts","sourceRoot":"","sources":["../../../src/components/Icon/Icon.registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,gDAAgD;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc;AAGjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,0BAAgB;AACjD,OAAO,EAAe,UAAU,EAAE,0BAAgB;AAWlD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CASpD;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,QAAQ,GACb,mBAAmB,CAAC,iBAAiB,CAAC,CASxC;AAED,KAAK,uBAAuB,GAAG;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,QAAQ,EACd,OAAO,CAAC,EAAE,uBAAuB,GAChC,iBAAiB,GAAG,mBAAmB,CAAC,iBAAiB,CAAC,CAU5D;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAEzD;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/components/Icon/Icon.registry.mjs

@@ -0,0 +1,67 @@
+import { lazy } from "react";
+import { iconLoaders, isIconName } from "./icons/index.mjs";
+const lazyIconCache = new Map();
+const testIconCache = new Map();
+let testPreloadPromise;
+/**
+ * Preloads all icon modules for the Jest test environment.
+ * Icons are cached as synchronous components so tests can query the DOM
+ * immediately without waiting for React.lazy resolution.
+ *
+ * @returns A promise that resolves when all icons are cached.
+ */
+export function preloadIconsForTests() {
+    testPreloadPromise ?? (testPreloadPromise = Promise.all(Object.entries(iconLoaders).map(async ([name, loader]) => {
+        const mod = await loader();
+        testIconCache.set(name, mod.default);
+    })).then(() => undefined));
+    return testPreloadPromise;
+}
+/**
+ * Returns a cached React.lazy wrapper for the given icon name.
+ * Each icon is loaded on demand via dynamic import, enabling per-icon
+ * code splitting instead of bundling all ~291 icons upfront.
+ *
+ * @param name - The icon name to resolve.
+ * @returns A lazy-loaded icon component.
+ */
+export function getLazyIcon(name) {
+    let lazyIcon = lazyIconCache.get(name);
+    if (!lazyIcon) {
+        lazyIcon = lazy(iconLoaders[name]);
+        lazyIconCache.set(name, lazyIcon);
+    }
+    return lazyIcon;
+}
+/**
+ * Resolves an icon component for rendering.
+ * Returns a synchronously cached component when present in the test preload
+ * cache (populated by preloadIconsForTests()). Otherwise returns a React.lazy
+ * wrapper for per-icon code splitting.
+ *
+ * @param name - The icon name to resolve.
+ * @param options - Optional resolver configuration.
+ * @param options.useTestCache - When false, skips the test preload cache.
+ * @returns The icon component to render.
+ */
+export function getIconComponent(name, options) {
+    if (options?.useTestCache !== false) {
+        const cachedTestIcon = testIconCache.get(name);
+        if (cachedTestIcon) {
+            return cachedTestIcon;
+        }
+    }
+    return getLazyIcon(name);
+}
+/**
+ * Preloads an icon module so it is available synchronously on the next render.
+ * Useful for warming commonly used icons before they appear on screen.
+ *
+ * @param name - The icon name to preload.
+ * @returns A promise that resolves when the icon module has loaded.
+ */
+export function preloadIcon(name) {
+    return iconLoaders[name]().then(() => undefined);
+}
+export { isIconName };
+//# sourceMappingURL=Icon.registry.mjs.map

package/dist/components/Icon/Icon.registry.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"Icon.registry.mjs","sourceRoot":"","sources":["../../../src/components/Icon/Icon.registry.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,cAAc;AAG7B,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,0BAAgB;AAElD,MAAM,aAAa,GAAG,IAAI,GAAG,EAG1B,CAAC;AAEJ,MAAM,aAAa,GAAG,IAAI,GAAG,EAA+B,CAAC;AAE7D,IAAI,kBAA6C,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB;IAClC,kBAAkB,KAAlB,kBAAkB,GAAK,OAAO,CAAC,GAAG,CAChC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;QACvD,MAAM,GAAG,GAAG,MAAM,MAAM,EAAE,CAAC;QAC3B,aAAa,CAAC,GAAG,CAAC,IAAgB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACnD,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,EAAC;IAExB,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CACzB,IAAc;IAEd,IAAI,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAEvC,IAAI,CAAC,QAAQ,EAAE;QACb,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QACnC,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;KACnC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAMD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAc,EACd,OAAiC;IAEjC,IAAI,OAAO,EAAE,YAAY,KAAK,KAAK,EAAE;QACnC,MAAM,cAAc,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE/C,IAAI,cAAc,EAAE;YAClB,OAAO,cAAc,CAAC;SACvB;KACF;IAED,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,IAAc;IACxC,OAAO,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;AACnD,CAAC;AAED,OAAO,EAAE,UAAU,EAAE,CAAC","sourcesContent":["import type { IconName } from '@metamask-previews/design-system-shared';\nimport type { LazyExoticComponent } from 'react';\nimport { lazy } from 'react';\n\nimport type { IconComponentType } from './icons';\nimport { iconLoaders, isIconName } from './icons';\n\nconst lazyIconCache = new Map<\n  IconName,\n  LazyExoticComponent<IconComponentType>\n>();\n\nconst testIconCache = new Map<IconName, IconComponentType>();\n\nlet testPreloadPromise: Promise<void> | undefined;\n\n/**\n * Preloads all icon modules for the Jest test environment.\n * Icons are cached as synchronous components so tests can query the DOM\n * immediately without waiting for React.lazy resolution.\n *\n * @returns A promise that resolves when all icons are cached.\n */\nexport function preloadIconsForTests(): Promise<void> {\n  testPreloadPromise ??= Promise.all(\n    Object.entries(iconLoaders).map(async ([name, loader]) => {\n      const mod = await loader();\n      testIconCache.set(name as IconName, mod.default);\n    }),\n  ).then(() => undefined);\n\n  return testPreloadPromise;\n}\n\n/**\n * Returns a cached React.lazy wrapper for the given icon name.\n * Each icon is loaded on demand via dynamic import, enabling per-icon\n * code splitting instead of bundling all ~291 icons upfront.\n *\n * @param name - The icon name to resolve.\n * @returns A lazy-loaded icon component.\n */\nexport function getLazyIcon(\n  name: IconName,\n): LazyExoticComponent<IconComponentType> {\n  let lazyIcon = lazyIconCache.get(name);\n\n  if (!lazyIcon) {\n    lazyIcon = lazy(iconLoaders[name]);\n    lazyIconCache.set(name, lazyIcon);\n  }\n\n  return lazyIcon;\n}\n\ntype GetIconComponentOptions = {\n  useTestCache?: boolean;\n};\n\n/**\n * Resolves an icon component for rendering.\n * Returns a synchronously cached component when present in the test preload\n * cache (populated by preloadIconsForTests()). Otherwise returns a React.lazy\n * wrapper for per-icon code splitting.\n *\n * @param name - The icon name to resolve.\n * @param options - Optional resolver configuration.\n * @param options.useTestCache - When false, skips the test preload cache.\n * @returns The icon component to render.\n */\nexport function getIconComponent(\n  name: IconName,\n  options?: GetIconComponentOptions,\n): IconComponentType | LazyExoticComponent<IconComponentType> {\n  if (options?.useTestCache !== false) {\n    const cachedTestIcon = testIconCache.get(name);\n\n    if (cachedTestIcon) {\n      return cachedTestIcon;\n    }\n  }\n\n  return getLazyIcon(name);\n}\n\n/**\n * Preloads an icon module so it is available synchronously on the next render.\n * Useful for warming commonly used icons before they appear on screen.\n *\n * @param name - The icon name to preload.\n * @returns A promise that resolves when the icon module has loaded.\n */\nexport function preloadIcon(name: IconName): Promise<void> {\n  return iconLoaders[name]().then(() => undefined);\n}\n\nexport { isIconName };\n"]}