@adobe-commerce/elsie 1.3.0-alpha01 → 1.3.0-alpha02

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe-commerce/elsie",
-  "version": "1.3.0-alpha01",
+  "version": "1.3.0-alpha02",
   "license": "SEE LICENSE IN LICENSE.md",
   "description": "Domain Package SDK",
   "engines": {

package/src/docs/Utilities/getCookie.mdx

@@ -0,0 +1,29 @@
+import { Meta, Unstyled } from '@storybook/blocks';
+
+<Meta title="Utilities/getCookie" />
+<Unstyled>
+
+# getCookie(cookieName)
+
+This function takes in a cookie name and returns the value of the cookie.
+
+## Params
+
+`cookieName`
+: The name of the cookie to get
+
+## Returns
+
+Returns the value of the cookie.
+
+## Examples
+
+```ts
+import { getCookie } from '@adobe-commerce/elsie/lib';
+
+const result = getCookie('foo');
+
+console.log(result); // "bar"
+```
+
+</Unstyled>

package/src/docs/Utilities/getPathValue.mdx

@@ -0,0 +1,38 @@
+import { Meta, Unstyled } from '@storybook/blocks';
+
+<Meta title="Utilities/getPathValue" />
+<Unstyled>
+
+# getPathValue(obj, key)
+
+This function takes in an object and a key and returns the value of the key.
+
+## Params
+
+`obj`
+: The object to get the value from
+
+`key`
+: The key to get the value from (supports dot notation)
+
+## Returns
+
+Returns the value of the key.
+
+## Examples
+
+```ts
+import { getPathValue } from '@adobe-commerce/elsie/lib';
+
+const obj = {
+  foo: {
+    bar: 'baz',
+  },
+};
+
+const result = getPathValue(obj, 'foo.bar');
+
+console.log(result); // "baz"
+```
+
+</Unstyled>

package/src/lib/aem/configs.ts

@@ -1,4 +1,5 @@
 import { deepmerge } from '../deepmerge';
+import { getPathValue } from '../get-path-value';
 
 interface ConfigHeaders {
   all?: Record<string, string>;
@@ -34,51 +35,6 @@ function resetConfig() {
   rootConfig = null;
 }
 
-/**
- * Builds the URL for the config file.
- *
- * @returns {URL} - The URL for the config file.
- */
-function buildConfigURL() {
-  return new URL(`${window.location.origin}/config.json`);
-}
-
-/**
- * Retrieves a value from a config object using dot notation.
- *
- * @param {Object} obj - The config object.
- * @param {string} key - The key to retrieve (supports dot notation).
- * @returns {any} - The value of the key.
- */
-function getValue(obj: Record<string, any>, key: string): any {
-  return key.split('.').reduce((current: Record<string, any>, part: string) => {
-    if (!Object.prototype.hasOwnProperty.call(current, part)) {
-      console.warn(`Property ${key} does not exist in the object`);
-      return undefined;
-    }
-    return current[part];
-  }, obj);
-}
-
-/**
- * Get cookie
- * @param {string} cookieName - The name of the cookie to get
- * @returns {string} - The value of the cookie
- */
-function getCookie(cookieName: string): string | undefined {
-  const cookies = document.cookie.split(';');
-  let foundValue;
-
-  cookies.forEach((cookie) => {
-    const [name, value] = cookie.trim().split('=');
-    if (name === cookieName) {
-      foundValue = decodeURIComponent(value);
-    }
-  });
-
-  return foundValue;
-}
-
 /**
  * Get root path
  * @param {Object} [configObj=config] - The config object.
@@ -149,8 +105,8 @@ function getHeaders(scope: string): Record<string, string> {
 /**
  * Applies config overrides from metadata.
  *
- * @param {Object} [configObj=config] - The base config.
- * @param {string} [root=rootPath] - The root path.
+ * @param {Object} [configObj] - The base config.
+ * @param {string} [root] - The root path.
  * @returns {Object} - The config with overrides applied.
  */
 function applyConfigOverrides(
@@ -168,43 +124,12 @@ function applyConfigOverrides(
   );
 }
 
-/**
- * Fetches config from remote and saves in session, then returns it, otherwise
- * returns if it already exists.
- *
- * @returns {Promise<Object>} - The config JSON from session storage
- */
-async function getConfigFromSession(): Promise<Config> {
-  try {
-    const configJSON = window.sessionStorage.getItem('config');
-    if (!configJSON) {
-      throw new Error('No config in session storage');
-    }
-
-    const parsedConfig = JSON.parse(configJSON);
-    if (
-      !parsedConfig[':expiry'] ||
-      parsedConfig[':expiry'] < Math.round(Date.now() / 1000)
-    ) {
-      throw new Error('Config expired');
-    }
-    return parsedConfig;
-  } catch (e) {
-    const config = await fetch(buildConfigURL());
-    if (!config.ok) throw new Error('Failed to fetch config');
-    const configJSON = await config.json();
-    configJSON[':expiry'] = Math.round(Date.now() / 1000) + 7200;
-    window.sessionStorage.setItem('config', JSON.stringify(configJSON));
-    return configJSON;
-  }
-}
-
 /**
  * Initializes the configuration system.
- * @returns {Promise<void>}
+ * @returns {Object} The initialized root configuration
  */
-async function initializeConfig(): Promise<ConfigRoot> {
-  config = await getConfigFromSession();
+function initializeConfig(configObj: Config): ConfigRoot {
+  config = configObj;
   rootPath = getRootPath(config);
   rootConfig = applyConfigOverrides(config, rootPath);
   return rootConfig;
@@ -222,12 +147,11 @@ function getConfigValue(configParam: string): any {
       'Configuration not initialized. Call initializeConfig() first.'
     );
   }
-  return getValue(rootConfig, configParam);
+  return getPathValue(rootConfig, configParam);
 }
 
 export {
   initializeConfig,
-  getCookie,
   getRootPath,
   getListOfRootPaths,
   isMultistore,

package/src/lib/get-cookie.ts

@@ -0,0 +1,18 @@
+/**
+ * Get cookie
+ * @param {string} cookieName - The name of the cookie to get
+ * @returns {string} - The value of the cookie
+ */
+export function getCookie(cookieName: string): string | undefined {
+  const cookies = document.cookie.split(';');
+  let foundValue;
+
+  cookies.forEach((cookie) => {
+    const [name, value] = cookie.trim().split('=');
+    if (name === cookieName) {
+      foundValue = decodeURIComponent(value);
+    }
+  });
+
+  return foundValue;
+}

package/src/lib/get-path-value.ts

@@ -0,0 +1,22 @@
+/**
+ * Retrieves a value from a config object using dot notation.
+ *
+ * @param {Object} obj - The config object.
+ * @param {string} key - The key to retrieve (supports dot notation).
+ * @returns {any} - The value of the key.
+ */
+export function getPathValue(obj: Record<string, any>, key: string): any {
+  try {
+    return key
+      .split('.')
+      .reduce((current: Record<string, any>, part: string) => {
+        if (!Object.prototype.hasOwnProperty.call(current, part)) {
+          throw Error();
+        }
+        return current[part];
+      }, obj);
+  } catch {
+    console.warn(`Property ${key} does not exist in the object`);
+    return undefined;
+  }
+}