@genesislcap/foundation-utils 14.260.1 → 14.260.2-alpha-9e268e0.0

package/dist/custom-elements.json

@@ -169,6 +169,113 @@
         }
       ]
     },
+    {
+      "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/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": "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": [
+        {
+          "kind": "js",
+          "name": "assureDesignSystem",
+          "declaration": {
+            "name": "assureDesignSystem",
+            "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/data/inMemoryDatabase.ts",
@@ -420,79 +527,6 @@
         }
       ]
     },
-    {
-      "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/design-system/design-system.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "assureDesignSystem",
-          "return": {
-            "type": {
-              "text": "DesignSystemModule"
-            }
-          },
-          "parameters": [
-            {
-              "name": "module",
-              "type": {
-                "text": "DesignSystemModule"
-              }
-            }
-          ],
-          "description": "assureDesignSystem.",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "assureDesignSystem",
-          "declaration": {
-            "name": "assureDesignSystem",
-            "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/encoding/index.ts",
@@ -2598,6 +2632,106 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/mappers/dto/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./serverRow"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./types"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/mappers/dto/serverRow.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "The default `ServerRowDTOMapper`.",
+          "name": "DefaultServerRowDTOMapper",
+          "members": [
+            {
+              "kind": "field",
+              "name": "fromDTO",
+              "description": "Converts a server row DTO to an entity.",
+              "parameters": [
+                {
+                  "description": "The DTO to convert.",
+                  "name": "dto"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "toDTO",
+              "description": "Converts a server row entity to a DTO.",
+              "parameters": [
+                {
+                  "description": "The entity to convert.",
+                  "name": "entity"
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "privacy": "public"
+            }
+          ]
+        },
+        {
+          "kind": "variable",
+          "name": "ServerRowDTOMapper",
+          "description": "A DI token used to obtain a `ServerRowDTOMapper` instance.",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "DefaultServerRowDTOMapper",
+          "declaration": {
+            "name": "DefaultServerRowDTOMapper",
+            "module": "src/mappers/dto/serverRow.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "ServerRowDTOMapper",
+          "declaration": {
+            "name": "ServerRowDTOMapper",
+            "module": "src/mappers/dto/serverRow.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/mappers/dto/types.ts",
+      "declarations": [],
+      "exports": []
+    },
     {
       "kind": "javascript-module",
       "path": "src/encoding/base64/decode.ts",
@@ -2752,106 +2886,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/mappers/dto/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./serverRow"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./types"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/mappers/dto/serverRow.ts",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "The default `ServerRowDTOMapper`.",
-          "name": "DefaultServerRowDTOMapper",
-          "members": [
-            {
-              "kind": "field",
-              "name": "fromDTO",
-              "description": "Converts a server row DTO to an entity.",
-              "parameters": [
-                {
-                  "description": "The DTO to convert.",
-                  "name": "dto"
-                }
-              ],
-              "return": {
-                "type": {
-                  "text": ""
-                }
-              },
-              "privacy": "public"
-            },
-            {
-              "kind": "field",
-              "name": "toDTO",
-              "description": "Converts a server row entity to a DTO.",
-              "parameters": [
-                {
-                  "description": "The entity to convert.",
-                  "name": "entity"
-                }
-              ],
-              "return": {
-                "type": {
-                  "text": ""
-                }
-              },
-              "privacy": "public"
-            }
-          ]
-        },
-        {
-          "kind": "variable",
-          "name": "ServerRowDTOMapper",
-          "description": "A DI token used to obtain a `ServerRowDTOMapper` instance.",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "DefaultServerRowDTOMapper",
-          "declaration": {
-            "name": "DefaultServerRowDTOMapper",
-            "module": "src/mappers/dto/serverRow.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "ServerRowDTOMapper",
-          "declaration": {
-            "name": "ServerRowDTOMapper",
-            "module": "src/mappers/dto/serverRow.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/mappers/dto/types.ts",
-      "declarations": [],
-      "exports": []
-    },
     {
       "kind": "javascript-module",
       "path": "src/mappers/genesis-json-schema/index.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,CA2BjG"}

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,33 @@ 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) {
+    // Start with the target element and traverse up the DOM tree
+    let currentElement = element;
+    while (currentElement) {
+        // Try to find a design system specifically responsible for this element in the hierarchy
+        const provider = DesignSystem.responsibleFor(currentElement);
+        // If we found a valid provider that's associated with the current element
+        // or one of its ancestors (owner === currentElement)
+        if (provider && provider.prefix) {
+            return provider.prefix;
+        }
+        // Move up the DOM tree
+        currentElement = currentElement.parentElement;
+    }
+    // If no appropriate provider was found in the hierarchy
+    logger.warn(`DesignSystem provider not found for ${element.localName} element or its ancestors, falling back to ${fallbackPrefix} prefix.`);
+    return fallbackPrefix;
+}

package/dist/foundation-utils.api.json

@@ -3716,6 +3716,68 @@
             }
           ]
         },
+        {
+          "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

@@ -521,6 +521,20 @@ export declare namespace Genesis {
  */
 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

@@ -297,6 +297,9 @@ export namespace Genesis {
 // @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.260.1",
+  "version": "14.260.2-alpha-9e268e0.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -27,19 +27,19 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.260.1",
-    "@genesislcap/genx": "14.260.1",
-    "@genesislcap/rollup-builder": "14.260.1",
-    "@genesislcap/ts-builder": "14.260.1",
-    "@genesislcap/uvu-playwright-builder": "14.260.1",
-    "@genesislcap/vite-builder": "14.260.1",
-    "@genesislcap/webpack-builder": "14.260.1",
+    "@genesislcap/foundation-testing": "14.260.2-alpha-9e268e0.0",
+    "@genesislcap/genx": "14.260.2-alpha-9e268e0.0",
+    "@genesislcap/rollup-builder": "14.260.2-alpha-9e268e0.0",
+    "@genesislcap/ts-builder": "14.260.2-alpha-9e268e0.0",
+    "@genesislcap/uvu-playwright-builder": "14.260.2-alpha-9e268e0.0",
+    "@genesislcap/vite-builder": "14.260.2-alpha-9e268e0.0",
+    "@genesislcap/webpack-builder": "14.260.2-alpha-9e268e0.0",
     "@types/json-schema": "^7.0.11",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
     "@genesislcap/expression-builder": "14.258.1",
-    "@genesislcap/foundation-logger": "14.260.1",
+    "@genesislcap/foundation-logger": "14.260.2-alpha-9e268e0.0",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
@@ -57,5 +57,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "440fc2e296a21758cba55081875cc67b94707596"
+  "gitHead": "1095d5b866fc1f13c98386aa2d06b22415225bbf"
 }