@genesislcap/foundation-utils 14.387.0 → 14.387.1-alpha-8fa3775.0

package/dist/custom-elements.json

@@ -391,6 +391,126 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/design-system/design-system.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "assureDesignSystem",
+          "return": {
+            "type": {
+              "text": "DesignSystemModule"
+            }
+          },
+          "parameters": [
+            {
+              "name": "module",
+              "type": {
+                "text": "DesignSystemModule"
+              }
+            }
+          ],
+          "description": "assureDesignSystem.",
+          "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "getCurrentDesignSystem",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
+          "parameters": [
+            {
+              "name": "element",
+              "type": {
+                "text": "HTMLElement"
+              },
+              "description": "The starting HTML element"
+            },
+            {
+              "name": "fallbackPrefix",
+              "type": {
+                "text": "string"
+              },
+              "description": "The prefix to fallback to if the provider is not available"
+            }
+          ],
+          "description": "Get the current design system provider element and prefix by checking available providers.\nIf no provider is found, falls back to the provided prefix.",
+          "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "getCurrentDesignSystemPrefix",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
+          "parameters": [
+            {
+              "name": "element",
+              "type": {
+                "text": "HTMLElement"
+              },
+              "description": "The starting HTML element"
+            },
+            {
+              "name": "fallbackPrefix",
+              "type": {
+                "text": "string"
+              },
+              "description": "The prefix to fallback to if the provider is not available"
+            }
+          ],
+          "description": "Get the current design system prefix by checking available providers.\nIf no provider is found, falls back to the provided prefix.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "assureDesignSystem",
+          "declaration": {
+            "name": "assureDesignSystem",
+            "module": "src/design-system/design-system.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "getCurrentDesignSystem",
+          "declaration": {
+            "name": "getCurrentDesignSystem",
+            "module": "src/design-system/design-system.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "getCurrentDesignSystemPrefix",
+          "declaration": {
+            "name": "getCurrentDesignSystemPrefix",
+            "module": "src/design-system/design-system.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/design-system/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./design-system"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/decorators/index.ts",
@@ -467,21 +587,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/encoding/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./base64"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/env/index.ts",
@@ -957,126 +1062,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/design-system/design-system.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "assureDesignSystem",
-          "return": {
-            "type": {
-              "text": "DesignSystemModule"
-            }
-          },
-          "parameters": [
-            {
-              "name": "module",
-              "type": {
-                "text": "DesignSystemModule"
-              }
-            }
-          ],
-          "description": "assureDesignSystem.",
-          "privacy": "public"
-        },
-        {
-          "kind": "function",
-          "name": "getCurrentDesignSystem",
-          "return": {
-            "type": {
-              "text": ""
-            }
-          },
-          "parameters": [
-            {
-              "name": "element",
-              "type": {
-                "text": "HTMLElement"
-              },
-              "description": "The starting HTML element"
-            },
-            {
-              "name": "fallbackPrefix",
-              "type": {
-                "text": "string"
-              },
-              "description": "The prefix to fallback to if the provider is not available"
-            }
-          ],
-          "description": "Get the current design system provider element and prefix by checking available providers.\nIf no provider is found, falls back to the provided prefix.",
-          "privacy": "public"
-        },
-        {
-          "kind": "function",
-          "name": "getCurrentDesignSystemPrefix",
-          "return": {
-            "type": {
-              "text": ""
-            }
-          },
-          "parameters": [
-            {
-              "name": "element",
-              "type": {
-                "text": "HTMLElement"
-              },
-              "description": "The starting HTML element"
-            },
-            {
-              "name": "fallbackPrefix",
-              "type": {
-                "text": "string"
-              },
-              "description": "The prefix to fallback to if the provider is not available"
-            }
-          ],
-          "description": "Get the current design system prefix by checking available providers.\nIf no provider is found, falls back to the provided prefix.",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "assureDesignSystem",
-          "declaration": {
-            "name": "assureDesignSystem",
-            "module": "src/design-system/design-system.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "getCurrentDesignSystem",
-          "declaration": {
-            "name": "getCurrentDesignSystem",
-            "module": "src/design-system/design-system.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "getCurrentDesignSystemPrefix",
-          "declaration": {
-            "name": "getCurrentDesignSystemPrefix",
-            "module": "src/design-system/design-system.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/design-system/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./design-system"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/error/errorMap.ts",
@@ -1276,6 +1261,21 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/encoding/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./base64"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/feature-flags/featureFlags.ts",
@@ -3753,6 +3753,14 @@
             "name": "*",
             "package": "./logger"
           }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./noop"
+          }
         }
       ]
     },
@@ -3778,6 +3786,74 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/utils/noop.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "noop",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "fn",
+              "optional": true,
+              "type": {
+                "text": "() => void"
+              }
+            },
+            {
+              "description": "An optional function to execute for its side effects.",
+              "name": "callback"
+            }
+          ],
+          "description": "A no-operation function that executes an optional callback.\n\nThis is a lower-level utility function. For preventing tree-shaking of custom elements,\nprefer using avoidTreeShaking which provides a more explicit API.",
+          "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "avoidTreeShaking",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "classes",
+              "type": {
+                "text": "unknown[]"
+              },
+              "description": "One or more custom element classes that should not be tree-shaken."
+            }
+          ],
+          "description": "Explicitly prevents tree-shaking of custom element classes by referencing them.\n\nBundlers may incorrectly remove code that it thinks has no side effects,\nsuch as custom element definitions that are only referenced in templates.\nBy passing these classes to `avoidTreeShaking`, we create a side effect\nthat signals to the bundler to preserve the code.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "noop",
+          "declaration": {
+            "name": "noop",
+            "module": "src/utils/noop.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "avoidTreeShaking",
+          "declaration": {
+            "name": "avoidTreeShaking",
+            "module": "src/utils/noop.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/utils/os-platform.ts",

package/dist/dts/utils/index.d.ts

@@ -2,4 +2,5 @@ export * from './deepMerge';
 export * from './delay';
 export * from './dom';
 export * from './logger';
+export * from './noop';
 //# sourceMappingURL=index.d.ts.map

package/dist/dts/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC"}

package/dist/dts/utils/noop.d.ts

@@ -0,0 +1,23 @@
+/**
+ * A no-operation function that executes an optional callback.
+ *
+ * This is a lower-level utility function. For preventing tree-shaking of custom elements,
+ * prefer using {@link avoidTreeShaking} which provides a more explicit API.
+ *
+ * @param callback - An optional function to execute for its side effects.
+ * @public
+ */
+export declare const noop: (fn?: () => void) => void;
+/**
+ * Explicitly prevents tree-shaking of custom element classes by referencing them.
+ *
+ * Bundlers may incorrectly remove code that it thinks has no side effects,
+ * such as custom element definitions that are only referenced in templates.
+ * By passing these classes to `avoidTreeShaking`, we create a side effect
+ * that signals to the bundler to preserve the code.
+ *
+ * @param classes - One or more custom element classes that should not be tree-shaken.
+ * @public
+ */
+export declare const avoidTreeShaking: (...classes: unknown[]) => void;
+//# sourceMappingURL=noop.d.ts.map

package/dist/dts/utils/noop.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"noop.d.ts","sourceRoot":"","sources":["../../../src/utils/noop.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,eAAO,MAAM,IAAI,GAAI,KAAK,MAAM,IAAI,KAAG,IAEtC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,GAAI,GAAG,SAAS,OAAO,EAAE,KAAG,IAOxD,CAAC"}

package/dist/esm/utils/index.js

@@ -2,3 +2,4 @@ export * from './deepMerge';
 export * from './delay';
 export * from './dom';
 export * from './logger';
+export * from './noop';

package/dist/esm/utils/noop.js

@@ -0,0 +1,31 @@
+/**
+ * A no-operation function that executes an optional callback.
+ *
+ * This is a lower-level utility function. For preventing tree-shaking of custom elements,
+ * prefer using {@link avoidTreeShaking} which provides a more explicit API.
+ *
+ * @param callback - An optional function to execute for its side effects.
+ * @public
+ */
+export const noop = (fn) => {
+    fn === null || fn === void 0 ? void 0 : fn();
+};
+/**
+ * Explicitly prevents tree-shaking of custom element classes by referencing them.
+ *
+ * Bundlers may incorrectly remove code that it thinks has no side effects,
+ * such as custom element definitions that are only referenced in templates.
+ * By passing these classes to `avoidTreeShaking`, we create a side effect
+ * that signals to the bundler to preserve the code.
+ *
+ * @param classes - One or more custom element classes that should not be tree-shaken.
+ * @public
+ */
+export const avoidTreeShaking = (...classes) => {
+    noop(() => {
+        // Reference each class to prevent tree-shaking
+        classes.forEach((cls) => {
+            void cls;
+        });
+    });
+};

package/dist/foundation-utils.api.json

@@ -297,6 +297,47 @@
           ],
           "name": "assureDesignSystem"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-utils!avoidTreeShaking:function(1)",
+          "docComment": "/**\n * Explicitly prevents tree-shaking of custom element classes by referencing them.\n *\n * Bundlers may incorrectly remove code that it thinks has no side effects, such as custom element definitions that are only referenced in templates. By passing these classes to `avoidTreeShaking`, we create a side effect that signals to the bundler to preserve the code.\n *\n * @param classes - One or more custom element classes that should not be tree-shaken.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "avoidTreeShaking: (...classes: "
+            },
+            {
+              "kind": "Content",
+              "text": "unknown[]"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            }
+          ],
+          "fileUrlPath": "src/utils/noop.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "classes",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "avoidTreeShaking"
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-utils!BUILDER:var",
@@ -12257,6 +12298,47 @@
           ],
           "name": "mapJsonSchemaFieldToExprBuilderField"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-utils!noop:function(1)",
+          "docComment": "/**\n * A no-operation function that executes an optional callback.\n *\n * This is a lower-level utility function. For preventing tree-shaking of custom elements, prefer using {@link avoidTreeShaking} which provides a more explicit API.\n *\n * @param callback - An optional function to execute for its side effects.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "noop: (fn?: "
+            },
+            {
+              "kind": "Content",
+              "text": "() => void"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            }
+          ],
+          "fileUrlPath": "src/utils/noop.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "fn",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "noop"
+        },
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-utils!NumberParser:class",

package/dist/foundation-utils.d.ts

@@ -77,6 +77,19 @@ export declare let API_HOST: string;
  */
 export declare function assureDesignSystem(module: DesignSystemModule): DesignSystemModule;
 
+/**
+ * Explicitly prevents tree-shaking of custom element classes by referencing them.
+ *
+ * Bundlers may incorrectly remove code that it thinks has no side effects,
+ * such as custom element definitions that are only referenced in templates.
+ * By passing these classes to `avoidTreeShaking`, we create a side effect
+ * that signals to the bundler to preserve the code.
+ *
+ * @param classes - One or more custom element classes that should not be tree-shaken.
+ * @public
+ */
+export declare const avoidTreeShaking: (...classes: unknown[]) => void;
+
 /**
  * @internal
  */
@@ -1479,6 +1492,17 @@ string,
 Genesis.FieldJsonSchema
 ]): Types.Field | null;
 
+/**
+ * A no-operation function that executes an optional callback.
+ *
+ * This is a lower-level utility function. For preventing tree-shaking of custom elements,
+ * prefer using {@link avoidTreeShaking} which provides a more explicit API.
+ *
+ * @param callback - An optional function to execute for its side effects.
+ * @public
+ */
+export declare const noop: (fn?: () => void) => void;
+
 /**
  * @public
  */

package/docs/api/foundation-utils.avoidtreeshaking.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [avoidTreeShaking](./foundation-utils.avoidtreeshaking.md)
+
+## avoidTreeShaking() function
+
+Explicitly prevents tree-shaking of custom element classes by referencing them.
+
+Bundlers may incorrectly remove code that it thinks has no side effects, such as custom element definitions that are only referenced in templates. By passing these classes to `avoidTreeShaking`<!-- -->, we create a side effect that signals to the bundler to preserve the code.
+
+**Signature:**
+
+```typescript
+avoidTreeShaking: (...classes: unknown[]) => void
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+classes
+
+
+</td><td>
+
+unknown\[\]
+
+
+</td><td>
+
+One or more custom element classes that should not be tree-shaken.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.md

@@ -192,6 +192,19 @@ Description
 assureDesignSystem.
 
 
+</td></tr>
+<tr><td>
+
+[avoidTreeShaking(classes)](./foundation-utils.avoidtreeshaking.md)
+
+
+</td><td>
+
+Explicitly prevents tree-shaking of custom element classes by referencing them.
+
+Bundlers may incorrectly remove code that it thinks has no side effects, such as custom element definitions that are only referenced in templates. By passing these classes to `avoidTreeShaking`<!-- -->, we create a side effect that signals to the bundler to preserve the code.
+
+
 </td></tr>
 <tr><td>
 
@@ -542,6 +555,19 @@ Maps fields contained in a JSON schema block enhanced with genesisType metadata
 Only sets the properties that are \*required\*. Optional properties, such as `defaultValue`<!-- -->, must be explicitly set by the user separately.
 
 
+</td></tr>
+<tr><td>
+
+[noop(fn)](./foundation-utils.noop.md)
+
+
+</td><td>
+
+A no-operation function that executes an optional callback.
+
+This is a lower-level utility function. For preventing tree-shaking of custom elements, prefer using [avoidTreeShaking()](./foundation-utils.avoidtreeshaking.md) which provides a more explicit API.
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/foundation-utils.noop.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [noop](./foundation-utils.noop.md)
+
+## noop() function
+
+A no-operation function that executes an optional callback.
+
+This is a lower-level utility function. For preventing tree-shaking of custom elements, prefer using [avoidTreeShaking()](./foundation-utils.avoidtreeshaking.md) which provides a more explicit API.
+
+**Signature:**
+
+```typescript
+noop: (fn?: () => void) => void
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fn
+
+
+</td><td>
+
+() =&gt; void
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api-report.md.api.md

@@ -35,6 +35,9 @@ export let API_HOST: string;
 // @public
 export function assureDesignSystem(module: DesignSystemModule): DesignSystemModule;
 
+// @public
+export const avoidTreeShaking: (...classes: unknown[]) => void;
+
 // Warning: (ae-internal-missing-underscore) The name "BIG_INT_64_BITS" should be prefixed with an underscore because the declaration is marked as @internal
 //
 // @internal (undocumented)
@@ -973,6 +976,9 @@ string,
 Genesis.FieldJsonSchema
 ]): Types.Field | null;
 
+// @public
+export const noop: (fn?: () => void) => void;
+
 // @public (undocumented)
 export class NumberParser {
     constructor(locale: string);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.387.0",
+  "version": "14.387.1-alpha-8fa3775.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -27,18 +27,18 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.387.0",
-    "@genesislcap/genx": "14.387.0",
-    "@genesislcap/rollup-builder": "14.387.0",
-    "@genesislcap/ts-builder": "14.387.0",
-    "@genesislcap/uvu-playwright-builder": "14.387.0",
-    "@genesislcap/vite-builder": "14.387.0",
-    "@genesislcap/webpack-builder": "14.387.0",
+    "@genesislcap/foundation-testing": "14.387.1-alpha-8fa3775.0",
+    "@genesislcap/genx": "14.387.1-alpha-8fa3775.0",
+    "@genesislcap/rollup-builder": "14.387.1-alpha-8fa3775.0",
+    "@genesislcap/ts-builder": "14.387.1-alpha-8fa3775.0",
+    "@genesislcap/uvu-playwright-builder": "14.387.1-alpha-8fa3775.0",
+    "@genesislcap/vite-builder": "14.387.1-alpha-8fa3775.0",
+    "@genesislcap/webpack-builder": "14.387.1-alpha-8fa3775.0",
     "@types/json-schema": "^7.0.11"
   },
   "dependencies": {
-    "@genesislcap/expression-builder": "14.387.0",
-    "@genesislcap/foundation-logger": "14.387.0",
+    "@genesislcap/expression-builder": "14.387.1-alpha-8fa3775.0",
+    "@genesislcap/foundation-logger": "14.387.1-alpha-8fa3775.0",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
@@ -56,5 +56,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "0e0b8fa3af6755e41cbd83e993e25e4de68e4d98"
+  "gitHead": "307a3526456233d9c9d1a4c034701b5e45233bb2"
 }