@onecx/accelerator 7.0.5 → 7.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onecx/accelerator",
-  "version": "7.0.5",
+  "version": "7.1.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -10,7 +10,7 @@
     "tslib": "^2.6.3",
     "rxjs": "^7.8.1",
     "@nx/devkit": "^22.0.2",
-    "@onecx/nx-migration-utils": "^7.0.5"
+    "@onecx/nx-migration-utils": "^7.1.0"
   },
   "type": "commonjs",
   "main": "./src/index.js",

package/src/index.d.ts

@@ -9,3 +9,4 @@ export * from './lib/utils/is-test.utils';
 export * from './lib/utils/normalize-locales.utils';
 export * from './lib/utils/get-normalized-browser-locales.utils';
 export * from './lib/utils/gatherer';
+export * from './lib/utils/ensure-property.utils';

package/src/index.js

@@ -12,4 +12,5 @@ tslib_1.__exportStar(require("./lib/utils/is-test.utils"), exports);
 tslib_1.__exportStar(require("./lib/utils/normalize-locales.utils"), exports);
 tslib_1.__exportStar(require("./lib/utils/get-normalized-browser-locales.utils"), exports);
 tslib_1.__exportStar(require("./lib/utils/gatherer"), exports);
+tslib_1.__exportStar(require("./lib/utils/ensure-property.utils"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/accelerator/src/index.ts"],"names":[],"mappings":";;;AAAA,4DAAiC;AACjC,uEAA4C;AAC5C,mFAAwD;AACxD,qEAA0C;AAC1C,sEAA2C;AAC3C,iEAAsC;AACtC,iEAAsC;AACtC,oEAAyC;AACzC,8EAAmD;AACnD,2FAAgE;AAChE,+DAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/accelerator/src/index.ts"],"names":[],"mappings":";;;AAAA,4DAAiC;AACjC,uEAA4C;AAC5C,mFAAwD;AACxD,qEAA0C;AAC1C,sEAA2C;AAC3C,iEAAsC;AACtC,iEAAsC;AACtC,oEAAyC;AACzC,8EAAmD;AACnD,2FAAgE;AAChE,+DAAoC;AACpC,4EAAiD"}

package/src/lib/utils/ensure-property.utils.d.ts

@@ -0,0 +1,58 @@
+type PathKeys<T, Depth extends number = 5> = [Depth] extends [never] ? never : T extends object ? {
+    [K in keyof T]-?: K extends string | number ? T[K] extends object | undefined ? `${K}` | `${K}.${PathKeys<NonNullable<T[K]>, Prev[Depth]>}` : `${K}` : never;
+}[keyof T] : never;
+type Prev = [never, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
+type PathToTuple<S extends string> = S extends `${infer First}.${infer Rest}` ? [First, ...PathToTuple<Rest>] : [S];
+type ValidPaths<T> = PathKeys<T> extends infer P ? P extends string ? PathToTuple<P> : never : never;
+type SetPathTuple<T, Path extends ReadonlyArray<string | number>, Value> = Path extends readonly [infer Key, ...infer Rest] ? Key extends string | number ? Rest extends ReadonlyArray<string | number> ? Rest['length'] extends 0 ? T & {
+    [K in Key]: Value;
+} : {
+    [K in keyof T | Key]-?: K extends Key ? K extends keyof T ? SetPathTuple<NonNullable<T[K]>, Rest, Value> : SetPathTuple<object, Rest, Value> : K extends keyof T ? T[K] : never;
+} : never : never : never;
+/**
+ * Ensures that a property exists at the specified path within an object.
+ * Creates intermediate objects as needed and sets the final property to the initial value
+ * only if the property is currently null or undefined.
+ *
+ * This function is useful for safely initializing deeply nested properties without worrying
+ * about intermediate objects being missing. It will not overwrite existing values - only
+ * null or undefined values are replaced.
+ *
+ * @template T - The object type
+ * @template Path - The path as a tuple of keys
+ * @template Value - The type of the value to set
+ * @param obj - The object to modify
+ * @param path - An array representing the path to the property (e.g., ['user', 'profile', 'name'])
+ * @param initialValue - The value to set if the property is currently null or undefined
+ *
+ * @example
+ * // Ensure a global debug flag exists
+ * ensureProperty(globalThis, ['myApp', 'config', 'debug'], false);
+ * // Access it safely:
+ * if (globalThis.myApp.config.debug) {
+ *   console.log('Debug mode enabled');
+ * }
+ *
+ * @example
+ * // Initialize nested configuration
+ * const config = {};
+ * ensureProperty(config, ['database', 'host'], 'localhost');
+ * ensureProperty(config, ['database', 'port'], 5432);
+ * // config is now { database: { host: 'localhost', port: 5432 } }
+ *
+ * @example
+ * // Won't overwrite existing values
+ * const obj = { name: 'John' };
+ * ensureProperty(obj, ['name'], 'Jane');
+ * // obj.name remains 'John'
+ *
+ * @example
+ * // Replaces null values
+ * const obj = { name: null };
+ * ensureProperty(obj, ['name'], 'Default');
+ * // obj.name is now 'Default'
+ */
+export declare function ensureProperty<const Path extends ReadonlyArray<string | number>, Value>(obj: typeof globalThis, path: Path, initialValue: Value): asserts obj is typeof globalThis & SetPathTuple<typeof globalThis, Path, Value>;
+export declare function ensureProperty<T extends object, const Path extends ValidPaths<T>, Value>(obj: T, path: Path, initialValue: Value): asserts obj is T & SetPathTuple<T, Path, Value>;
+export declare function ensureProperty<T extends object, const Path extends ReadonlyArray<string | number>, Value>(obj: T, path: Path, initialValue: Value): asserts obj is T & SetPathTuple<T, Path, Value>;
+export {};

package/src/lib/utils/ensure-property.utils.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureProperty = ensureProperty;
+function ensureProperty(obj, path, initialValue) {
+    let current = obj;
+    for (let i = 0; i < path.length - 1; i++) {
+        const key = path[i];
+        if (current[key] == null || typeof current[key] !== 'object') {
+            current[key] = {};
+        }
+        current = current[key];
+    }
+    const lastKey = path.at(-1);
+    if (lastKey === undefined) {
+        return;
+    }
+    current[lastKey] ??= initialValue;
+}
+//# sourceMappingURL=ensure-property.utils.js.map

package/src/lib/utils/ensure-property.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensure-property.utils.js","sourceRoot":"","sources":["../../../../../../libs/accelerator/src/lib/utils/ensure-property.utils.ts"],"names":[],"mappings":";;AAoHA,wCAoBC;AApBD,SAAgB,cAAc,CAC1B,GAAM,EACN,IAAU,EACV,YAAmB;IAEnB,IAAI,OAAO,GAAQ,GAAG,CAAC;IAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC3D,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;QACtB,CAAC;QACD,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO;IACX,CAAC;IACD,OAAO,CAAC,OAAO,CAAC,KAAK,YAAY,CAAC;AACtC,CAAC"}