@genesislcap/foundation-utils 14.497.0 → 14.498.0

package/dist/custom-elements.json

@@ -1434,7 +1434,46 @@
                 "text": "string"
               }
             }
-          ]
+          ],
+          "description": "Returns true when `feature.<name>` is present in the current URL query string.",
+          "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "getActivatedFeatures",
+          "return": {
+            "type": {
+              "text": "string[]"
+            }
+          },
+          "description": "Returns the names of all feature flags currently present in the URL query string.",
+          "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "setActivatedFeatures",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "features",
+              "type": {
+                "text": "string[]"
+              }
+            },
+            {
+              "name": "options",
+              "default": "{}",
+              "type": {
+                "text": "SetActivatedFeaturesOptions"
+              }
+            }
+          ],
+          "description": "Rewrites URL `feature.*` query params to match the given feature list (presence-only).\nRemoves any existing `feature.*` params, then adds each selected feature as `feature.<name>`.\nReloads by default so boot-time consumers (e.g. AI registration) pick up the change.",
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -1445,6 +1484,22 @@
             "name": "isFeatureActivated",
             "module": "src/feature-flags/featureFlags.ts"
           }
+        },
+        {
+          "kind": "js",
+          "name": "getActivatedFeatures",
+          "declaration": {
+            "name": "getActivatedFeatures",
+            "module": "src/feature-flags/featureFlags.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "setActivatedFeatures",
+          "declaration": {
+            "name": "setActivatedFeatures",
+            "module": "src/feature-flags/featureFlags.ts"
+          }
         }
       ]
     },

package/dist/dts/feature-flags/featureFlags.d.ts

@@ -1,2 +1,47 @@
+/**
+ * Options for {@link setActivatedFeatures}.
+ * @public
+ */
+export type SetActivatedFeaturesOptions = {
+    /**
+     * When true (default), navigates to the updated URL so boot-time consumers re-evaluate.
+     * When false, updates the URL via `history.replaceState` without reloading.
+     */
+    reload?: boolean;
+};
+/**
+ * Returns true when `feature.<name>` is present in the given search string.
+ * @internal
+ */
+export declare const isFeatureActivatedInSearch: (search: string, feature: string) => boolean;
+/**
+ * Returns the names of all feature flags present in the given search string.
+ * @internal
+ */
+export declare const getActivatedFeaturesFromSearch: (search: string) => string[];
+/**
+ * Returns a new URL with `feature.*` query params rewritten to match the given feature list.
+ * @internal
+ */
+export declare const applyActivatedFeaturesToUrl: (url: URL, features: string[]) => URL;
+/**
+ * Returns true when `feature.<name>` is present in the current URL query string.
+ * @public
+ */
 export declare const isFeatureActivated: (feature: string) => boolean;
+/**
+ * Returns the names of all feature flags currently present in the URL query string.
+ * @example
+ * // URL: ?feature.ai&feature.forceHttp=true
+ * getActivatedFeatures(); // ['ai', 'forceHttp']
+ * @public
+ */
+export declare const getActivatedFeatures: () => string[];
+/**
+ * Rewrites URL `feature.*` query params to match the given feature list (presence-only).
+ * Removes any existing `feature.*` params, then adds each selected feature as `feature.<name>`.
+ * Reloads by default so boot-time consumers (e.g. AI registration) pick up the change.
+ * @public
+ */
+export declare const setActivatedFeatures: (features: string[], options?: SetActivatedFeaturesOptions) => void;
 //# sourceMappingURL=featureFlags.d.ts.map

package/dist/dts/feature-flags/featureFlags.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"featureFlags.d.ts","sourceRoot":"","sources":["../../../src/feature-flags/featureFlags.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,KAAG,OAapD,CAAC"}
+{"version":3,"file":"featureFlags.d.ts","sourceRoot":"","sources":["../../../src/feature-flags/featureFlags.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAIF;;;GAGG;AACH,eAAO,MAAM,0BAA0B,GAAI,QAAQ,MAAM,EAAE,SAAS,MAAM,KAAG,OAe5E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,8BAA8B,GAAI,QAAQ,MAAM,KAAG,MAAM,EAcrE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,GAAI,KAAK,GAAG,EAAE,UAAU,MAAM,EAAE,KAAG,GAmB1E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,KAAG,OACQ,CAAC;AAE9D;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,QAAO,MAAM,EACU,CAAC;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAC/B,UAAU,MAAM,EAAE,EAClB,UAAS,2BAAgC,KACxC,IAUF,CAAC"}

package/dist/esm/feature-flags/featureFlags.js

@@ -1,8 +1,15 @@
-export const isFeatureActivated = (feature) => {
-    const currentUrl = window.location.href;
-    const queryString = new URL(currentUrl).search;
-    const params = new URLSearchParams(queryString);
-    const featureKey = `feature.${feature}`.toLowerCase();
+const FEATURE_PREFIX = 'feature.';
+const isFeatureParamKey = (key) => key.toLowerCase().startsWith(FEATURE_PREFIX);
+/**
+ * Returns true when `feature.<name>` is present in the given search string.
+ * @internal
+ */
+export const isFeatureActivatedInSearch = (search, feature) => {
+    if (!feature) {
+        return false;
+    }
+    const featureKey = `${FEATURE_PREFIX}${feature}`.toLowerCase();
+    const params = new URLSearchParams(search);
     for (const [key] of params.entries()) {
         if (key.toLowerCase() === featureKey) {
             return true;
@@ -10,3 +17,69 @@ export const isFeatureActivated = (feature) => {
     }
     return false;
 };
+/**
+ * Returns the names of all feature flags present in the given search string.
+ * @internal
+ */
+export const getActivatedFeaturesFromSearch = (search) => {
+    const params = new URLSearchParams(search);
+    const features = [];
+    for (const [key] of params.entries()) {
+        if (isFeatureParamKey(key)) {
+            const feature = key.slice(FEATURE_PREFIX.length);
+            if (feature) {
+                features.push(feature);
+            }
+        }
+    }
+    return features;
+};
+/**
+ * Returns a new URL with `feature.*` query params rewritten to match the given feature list.
+ * @internal
+ */
+export const applyActivatedFeaturesToUrl = (url, features) => {
+    const next = new URL(url.href);
+    const params = next.searchParams;
+    for (const key of [...params.keys()]) {
+        if (isFeatureParamKey(key)) {
+            params.delete(key);
+        }
+    }
+    for (const feature of features) {
+        if (feature) {
+            // Use an explicit value so routers/normalizers that drop empty query values
+            // (e.g. some React Router redirect paths) still preserve the flag.
+            params.set(`${FEATURE_PREFIX}${feature}`, 'true');
+        }
+    }
+    return next;
+};
+/**
+ * Returns true when `feature.<name>` is present in the current URL query string.
+ * @public
+ */
+export const isFeatureActivated = (feature) => isFeatureActivatedInSearch(window.location.search, feature);
+/**
+ * Returns the names of all feature flags currently present in the URL query string.
+ * @example
+ * // URL: ?feature.ai&feature.forceHttp=true
+ * getActivatedFeatures(); // ['ai', 'forceHttp']
+ * @public
+ */
+export const getActivatedFeatures = () => getActivatedFeaturesFromSearch(window.location.search);
+/**
+ * Rewrites URL `feature.*` query params to match the given feature list (presence-only).
+ * Removes any existing `feature.*` params, then adds each selected feature as `feature.<name>`.
+ * Reloads by default so boot-time consumers (e.g. AI registration) pick up the change.
+ * @public
+ */
+export const setActivatedFeatures = (features, options = {}) => {
+    const { reload = true } = options;
+    const url = applyActivatedFeaturesToUrl(new URL(window.location.href), features);
+    if (reload) {
+        window.location.assign(url.toString());
+        return;
+    }
+    window.history.replaceState({}, '', url.toString());
+};

package/dist/foundation-utils.api.json

@@ -5829,6 +5829,30 @@
             }
           ]
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-utils!getActivatedFeatures:function(1)",
+          "docComment": "/**\n * Returns the names of all feature flags currently present in the URL query string.\n *\n * @example\n *\n * // URL: ?feature.ai&feature.forceHttp=true getActivatedFeatures(); // ['ai', 'forceHttp']\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "getActivatedFeatures: () => "
+            },
+            {
+              "kind": "Content",
+              "text": "string[]"
+            }
+          ],
+          "fileUrlPath": "src/feature-flags/featureFlags.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "getActivatedFeatures"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-utils!getAllElements:function(1)",
@@ -8246,7 +8270,7 @@
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-utils!isFeatureActivated:function(1)",
-          "docComment": "",
+          "docComment": "/**\n * Returns true when `feature.<name>` is present in the current URL query string.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -17879,6 +17903,90 @@
             "endIndex": 4
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-utils!setActivatedFeatures:function(1)",
+          "docComment": "/**\n * Rewrites URL `feature.*` query params to match the given feature list (presence-only). Removes any existing `feature.*` params, then adds each selected feature as `feature.<name>`. Reloads by default so boot-time consumers (e.g. AI registration) pick up the change.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "setActivatedFeatures: (features: "
+            },
+            {
+              "kind": "Content",
+              "text": "string[]"
+            },
+            {
+              "kind": "Content",
+              "text": ", options?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "SetActivatedFeaturesOptions",
+              "canonicalReference": "@genesislcap/foundation-utils!SetActivatedFeaturesOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            }
+          ],
+          "fileUrlPath": "src/feature-flags/featureFlags.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "features",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "options",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "setActivatedFeatures"
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-utils!SetActivatedFeaturesOptions:type",
+          "docComment": "/**\n * Options for {@link setActivatedFeatures}.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type SetActivatedFeaturesOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    reload?: boolean;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/feature-flags/featureFlags.ts",
+          "releaseTag": "Public",
+          "name": "SetActivatedFeaturesOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-utils!SHORTCUT_BLOCKED_DEFAULT_MESSAGE:var",

package/dist/foundation-utils.d.ts

@@ -38,6 +38,12 @@ export declare const activeColorScheme: CSSDesignToken<string>;
  */
 export declare let API_HOST: string;
 
+/**
+ * Returns a new URL with `feature.*` query params rewritten to match the given feature list.
+ * @internal
+ */
+export declare const applyActivatedFeaturesToUrl: (url: URL, features: string[]) => URL;
+
 /**
  * assureDesignSystem.
  *
@@ -682,6 +688,21 @@ export declare namespace Genesis {
  */
 export declare const GENESIS_SOCKET_URL: string;
 
+/**
+ * Returns the names of all feature flags currently present in the URL query string.
+ * @example
+ * // URL: ?feature.ai&feature.forceHttp=true
+ * getActivatedFeatures(); // ['ai', 'forceHttp']
+ * @public
+ */
+export declare const getActivatedFeatures: () => string[];
+
+/**
+ * Returns the names of all feature flags present in the given search string.
+ * @internal
+ */
+export declare const getActivatedFeaturesFromSearch: (search: string) => string[];
+
 /**
  * Recursively gather all elements including those in shadow DOM
  * @public
@@ -890,8 +911,18 @@ export declare const inSymphonyDesktop: () => boolean;
  */
 export declare const isDev: () => boolean;
 
+/**
+ * Returns true when `feature.<name>` is present in the current URL query string.
+ * @public
+ */
 export declare const isFeatureActivated: (feature: string) => boolean;
 
+/**
+ * Returns true when `feature.<name>` is present in the given search string.
+ * @internal
+ */
+export declare const isFeatureActivatedInSearch: (search: string, feature: string) => boolean;
+
 /**
  * JSON replacer function.
  * @param key - The object key.
@@ -2264,6 +2295,26 @@ export declare type ServerRowEntity = {
     };
 };
 
+/**
+ * Rewrites URL `feature.*` query params to match the given feature list (presence-only).
+ * Removes any existing `feature.*` params, then adds each selected feature as `feature.<name>`.
+ * Reloads by default so boot-time consumers (e.g. AI registration) pick up the change.
+ * @public
+ */
+export declare const setActivatedFeatures: (features: string[], options?: SetActivatedFeaturesOptions) => void;
+
+/**
+ * Options for {@link setActivatedFeatures}.
+ * @public
+ */
+export declare type SetActivatedFeaturesOptions = {
+    /**
+     * When true (default), navigates to the updated URL so boot-time consumers re-evaluate.
+     * When false, updates the URL via `history.replaceState` without reloading.
+     */
+    reload?: boolean;
+};
+
 export declare const SHORTCUT_BLOCKED_DEFAULT_MESSAGE = "This shortcut is currently unavailable in this context.";
 
 export declare const SHORTCUT_BLOCKED_DEFAULT_TITLE = "Shortcut blocked";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.497.0",
+  "version": "14.498.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -29,18 +29,18 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.497.0",
-    "@genesislcap/genx": "14.497.0",
-    "@genesislcap/rollup-builder": "14.497.0",
-    "@genesislcap/ts-builder": "14.497.0",
-    "@genesislcap/uvu-playwright-builder": "14.497.0",
-    "@genesislcap/vite-builder": "14.497.0",
-    "@genesislcap/webpack-builder": "14.497.0",
+    "@genesislcap/foundation-testing": "14.498.0",
+    "@genesislcap/genx": "14.498.0",
+    "@genesislcap/rollup-builder": "14.498.0",
+    "@genesislcap/ts-builder": "14.498.0",
+    "@genesislcap/uvu-playwright-builder": "14.498.0",
+    "@genesislcap/vite-builder": "14.498.0",
+    "@genesislcap/webpack-builder": "14.498.0",
     "@types/json-schema": "^7.0.11"
   },
   "dependencies": {
-    "@genesislcap/expression-builder": "14.497.0",
-    "@genesislcap/foundation-logger": "14.497.0",
+    "@genesislcap/expression-builder": "14.498.0",
+    "@genesislcap/foundation-logger": "14.498.0",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.50.0",
@@ -58,5 +58,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "8859a3cd83bd40fc5e5bbff9be5ebe02380fb6ec"
+  "gitHead": "88a07e46851fa94efc9399c50975c9eb2c21168c"
 }