@genesislcap/foundation-utils 14.246.0 → 14.246.1-alpha-e79f189.0

package/dist/custom-elements.json

@@ -369,7 +369,7 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/directives/index.ts",
+      "path": "src/decorators/index.ts",
       "declarations": [],
       "exports": [
         {
@@ -377,15 +377,45 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "./sync"
+            "package": "./renderOnChange"
           }
-        },
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/decorators/renderOnChange.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "renderOnChange",
+          "parameters": [
+            {
+              "name": "target",
+              "type": {
+                "text": "FASTElement & { render(): void }"
+              },
+              "description": "The target to define the property change handler on."
+            },
+            {
+              "name": "name",
+              "type": {
+                "text": "string"
+              },
+              "description": "The property name."
+            }
+          ],
+          "description": "Defines a property changed handler that calls a render() method on the target as an internal observation enhancement.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
         {
           "kind": "js",
-          "name": "*",
+          "name": "renderOnChange",
           "declaration": {
-            "name": "*",
-            "package": "./when-else"
+            "name": "renderOnChange",
+            "module": "src/decorators/renderOnChange.ts"
           }
         }
       ]
@@ -412,6 +442,32 @@
           ],
           "description": "assureDesignSystem.",
           "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "getCurrentDesignSystemPrefix",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
+          "parameters": [
+            {
+              "name": "element",
+              "type": {
+                "text": "HTMLElement"
+              }
+            },
+            {
+              "name": "fallbackPrefix",
+              "type": {
+                "text": "string"
+              },
+              "description": "The prefix to fallback to if the provider is not available"
+            }
+          ],
+          "description": "Get the current design system prefix. If the provider is not available, fallback to the provided prefix.",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -422,6 +478,14 @@
             "name": "assureDesignSystem",
             "module": "src/design-system/design-system.ts"
           }
+        },
+        {
+          "kind": "js",
+          "name": "getCurrentDesignSystemPrefix",
+          "declaration": {
+            "name": "getCurrentDesignSystemPrefix",
+            "module": "src/design-system/design-system.ts"
+          }
         }
       ]
     },
@@ -440,6 +504,29 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/directives/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./sync"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./when-else"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/encoding/index.ts",
@@ -896,59 +983,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/decorators/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./renderOnChange"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/decorators/renderOnChange.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "renderOnChange",
-          "parameters": [
-            {
-              "name": "target",
-              "type": {
-                "text": "FASTElement & { render(): void }"
-              },
-              "description": "The target to define the property change handler on."
-            },
-            {
-              "name": "name",
-              "type": {
-                "text": "string"
-              },
-              "description": "The property name."
-            }
-          ],
-          "description": "Defines a property changed handler that calls a render() method on the target as an internal observation enhancement.",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "renderOnChange",
-          "declaration": {
-            "name": "renderOnChange",
-            "module": "src/decorators/renderOnChange.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/error/errorMap.ts",

package/dist/dts/design-system/design-system.d.ts

@@ -51,4 +51,17 @@ export type DesignSystemResource<T = DesignSystemModule> = Promise<T>;
  * @public
  */
 export declare function assureDesignSystem(module: DesignSystemModule): DesignSystemModule;
+/**
+ * Get the current design system prefix. If the provider is not available, fallback to the provided prefix.
+ * @param fallbackPrefix - The prefix to fallback to if the provider is not available
+ * @returns The current design system prefix
+ *
+ * @example
+ * ```ts
+ * const prefix = getCurrentDesignSystemPrefix('my-prefix');
+ * logger.debug(prefix); // May return 'zero' or 'rapid' if the provider is available or 'my-prefix' if not
+ * ```
+ * @public
+ */
+export declare function getCurrentDesignSystemPrefix(element: HTMLElement, fallbackPrefix: string): string;
 //# sourceMappingURL=design-system.d.ts.map

package/dist/dts/design-system/design-system.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"design-system.d.ts","sourceRoot":"","sources":["../../../src/design-system/design-system.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,mBAAmB,CACjB,OAAO,CAAC,EAAE,WAAW,EACrB,MAAM,CAAC,EAAE,MAAM,GACd,YAAY,GAAG,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACjD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,GAAG,kBAAkB,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,GAAG,kBAAkB,CAQjF"}
+{"version":3,"file":"design-system.d.ts","sourceRoot":"","sources":["../../../src/design-system/design-system.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAG1D;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,mBAAmB,CACjB,OAAO,CAAC,EAAE,WAAW,EACrB,MAAM,CAAC,EAAE,MAAM,GACd,YAAY,GAAG,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACjD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,GAAG,kBAAkB,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,GAAG,kBAAkB,CAQjF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,CAajG"}

package/dist/esm/design-system/design-system.js

@@ -1,3 +1,5 @@
+import { DesignSystem } from '@microsoft/fast-foundation';
+import { logger } from '../utils';
 /**
  * assureDesignSystem.
  *
@@ -45,3 +47,22 @@ export function assureDesignSystem(module) {
     }
     return module;
 }
+/**
+ * Get the current design system prefix. If the provider is not available, fallback to the provided prefix.
+ * @param fallbackPrefix - The prefix to fallback to if the provider is not available
+ * @returns The current design system prefix
+ *
+ * @example
+ * ```ts
+ * const prefix = getCurrentDesignSystemPrefix('my-prefix');
+ * logger.debug(prefix); // May return 'zero' or 'rapid' if the provider is available or 'my-prefix' if not
+ * ```
+ * @public
+ */
+export function getCurrentDesignSystemPrefix(element, fallbackPrefix) {
+    const provider = DesignSystem.responsibleFor(element);
+    if (!provider || !provider.owner) {
+        logger.warn(`DesignSystem provider not found for ${element.localName} element, falling back to ${fallbackPrefix} prefix.`);
+    }
+    return provider && provider.owner ? provider.prefix : fallbackPrefix;
+}

package/dist/foundation-utils.api.json

@@ -3565,6 +3565,68 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-utils!getCurrentDesignSystemPrefix:function(1)",
+          "docComment": "/**\n * Get the current design system prefix. If the provider is not available, fallback to the provided prefix.\n *\n * @param fallbackPrefix - The prefix to fallback to if the provider is not available\n *\n * @returns The current design system prefix\n *\n * @example\n * ```ts\n * const prefix = getCurrentDesignSystemPrefix('my-prefix');\n * logger.debug(prefix); // May return 'zero' or 'rapid' if the provider is available or 'my-prefix' if not\n * ```\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function getCurrentDesignSystemPrefix(element: "
+            },
+            {
+              "kind": "Reference",
+              "text": "HTMLElement",
+              "canonicalReference": "!HTMLElement:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", fallbackPrefix: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/design-system/design-system.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "element",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "fallbackPrefix",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "getCurrentDesignSystemPrefix"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-utils!getDateFormatter:function(1)",

package/dist/foundation-utils.d.ts

@@ -505,6 +505,20 @@ export declare type FoundationLayoutContainer = {
  */
 export declare const GENESIS_SOCKET_URL: string;
 
+/**
+ * Get the current design system prefix. If the provider is not available, fallback to the provided prefix.
+ * @param fallbackPrefix - The prefix to fallback to if the provider is not available
+ * @returns The current design system prefix
+ *
+ * @example
+ * ```ts
+ * const prefix = getCurrentDesignSystemPrefix('my-prefix');
+ * logger.debug(prefix); // May return 'zero' or 'rapid' if the provider is available or 'my-prefix' if not
+ * ```
+ * @public
+ */
+export declare function getCurrentDesignSystemPrefix(element: HTMLElement, fallbackPrefix: string): string;
+
 /**
  * @public
  */

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

@@ -0,0 +1,35 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [getCurrentDesignSystemPrefix](./foundation-utils.getcurrentdesignsystemprefix.md)
+
+## getCurrentDesignSystemPrefix() function
+
+Get the current design system prefix. If the provider is not available, fallback to the provided prefix.
+
+**Signature:**
+
+```typescript
+export declare function getCurrentDesignSystemPrefix(element: HTMLElement, fallbackPrefix: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  element | HTMLElement |  |
+|  fallbackPrefix | string | The prefix to fallback to if the provider is not available |
+
+**Returns:**
+
+string
+
+The current design system prefix
+
+## Example
+
+
+```ts
+const prefix = getCurrentDesignSystemPrefix('my-prefix');
+logger.debug(prefix); // May return 'zero' or 'rapid' if the provider is available or 'my-prefix' if not
+```
+

package/docs/api/foundation-utils.md

@@ -32,6 +32,7 @@
 |  [formatDateTimestamp(timestamp)](./foundation-utils.formatdatetimestamp.md) | Formats \[DATE\] UNIX Timestamps (without time) to readable strings |
 |  [formatDateTimeTimestamp(timestamp)](./foundation-utils.formatdatetimetimestamp.md) | Formats \[DATETIME\] UNIX Timestamps (with time) to readable strings |
 |  [formatTimestamp(timestamp, withTime)](./foundation-utils.formattimestamp.md) | Formats \[DATE\|DATETIME\] Unix Timestamps to readable strings |
+|  [getCurrentDesignSystemPrefix(element, fallbackPrefix)](./foundation-utils.getcurrentdesignsystemprefix.md) | Get the current design system prefix. If the provider is not available, fallback to the provided prefix. |
 |  [getDateFormatter(locale, options)](./foundation-utils.getdateformatter.md) |  |
 |  [getNumberFormatter(format, locale)](./foundation-utils.getnumberformatter.md) |  |
 |  [JSONReplacer(key, value)](./foundation-utils.jsonreplacer.md) | JSON replacer function. |

package/docs/api-report.md

@@ -277,6 +277,9 @@ export type FoundationLayoutContainer = {
 // @public
 export const GENESIS_SOCKET_URL: string;
 
+// @public
+export function getCurrentDesignSystemPrefix(element: HTMLElement, fallbackPrefix: string): string;
+
 // @public (undocumented)
 export function getDateFormatter(locale?: string, options?: Intl.DateTimeFormatOptions): (params: any) => string;
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.246.0",
+  "version": "14.246.1-alpha-e79f189.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -27,17 +27,17 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.246.0",
-    "@genesislcap/genx": "14.246.0",
-    "@genesislcap/rollup-builder": "14.246.0",
-    "@genesislcap/ts-builder": "14.246.0",
-    "@genesislcap/uvu-playwright-builder": "14.246.0",
-    "@genesislcap/vite-builder": "14.246.0",
-    "@genesislcap/webpack-builder": "14.246.0",
+    "@genesislcap/foundation-testing": "14.246.1-alpha-e79f189.0",
+    "@genesislcap/genx": "14.246.1-alpha-e79f189.0",
+    "@genesislcap/rollup-builder": "14.246.1-alpha-e79f189.0",
+    "@genesislcap/ts-builder": "14.246.1-alpha-e79f189.0",
+    "@genesislcap/uvu-playwright-builder": "14.246.1-alpha-e79f189.0",
+    "@genesislcap/vite-builder": "14.246.1-alpha-e79f189.0",
+    "@genesislcap/webpack-builder": "14.246.1-alpha-e79f189.0",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.246.0",
+    "@genesislcap/foundation-logger": "14.246.1-alpha-e79f189.0",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
@@ -55,5 +55,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "3b622b3bd389713fd2d2cc72a3b3f61dd046bd28"
+  "gitHead": "228d83f62347569881dcf1a9cece988aee373adb"
 }