@equinor/cpl-utils 0.2.0 → 0.2.1

package/dist/index.d.mts

@@ -113,6 +113,67 @@ declare function hasCircularDependency<T extends object>(items: T[], idKey: keyo
  */
 declare function itemIsDefined<T>(item: T): item is Exclude<typeof item, undefined>;
 
+type NestedRecord<K extends readonly string[]> = K extends [
+    infer First extends string,
+    ...infer Rest extends string[]
+] ? Record<First, NestedRecord<Rest>> : unknown;
+/**
+ * Checks if an object has a nested property chain, using Object.prototype.hasOwnProperty at each level.
+ * Returns true if all keys exist and are objects (except the last, which can be any value).
+ *
+ * @template K - Tuple of string keys representing the property chain.
+ * @param object - The object to check.
+ * @param keys - The property chain to check for.
+ * @returns {boolean} True if the nested property exists, false otherwise.
+ *
+ * @example
+ * // Basic usage
+ * const apiError = { error: { message: 'Not found' } }
+ * if (
+ *   objectHasOwnNestedProperty(apiError, 'error', 'message') &&
+ *   typeof apiError.error.message === 'string'
+ * ) {
+ *   return apiError.error.message
+ * }
+ *
+ * @example
+ * // Deeply nested object
+ * const data = { a: { b: { c: 42 } } }
+ * if (objectHasOwnNestedProperty(data, 'a', 'b', 'c')) {
+ *   console.log(data.a.b.c) // 42
+ * }
+ *
+
+ * @example
+ * // Usage in a try/catch block to extract a deeply nested error message
+ * try {
+ *   // ...some code that may throw
+ * } catch(error) {
+ *   if (
+ *     objectHasOwnNestedProperty(error, 'body', 'error', 'message') &&
+ *     typeof error.body.error.message === 'string'
+ *   ) {
+ *     setErrorMessage(error.body.error.message)
+ *   }
+ * }
+ *
+ * // Missing property
+ * const obj = { a: { b: {} } }
+ * objectHasOwnNestedProperty(obj, 'a', 'b', 'c') // false
+ *
+ * @example
+ * // Works with arrays as values
+ * const arrObj = { a: { b: [1, 2, 3] } }
+ * objectHasOwnNestedProperty(arrObj, 'a', 'b') // true
+ *
+ * @example
+ * // TypeScript type guard
+ * if (objectHasOwnNestedProperty(apiError, 'error', 'message')) {
+ *   // apiError is now typed as { error: { message: unknown } }
+ * }
+ */
+declare function objectHasOwnNestedProperty<K extends readonly string[]>(object: unknown, ...keys: K): object is NestedRecord<K>;
+
 /**
  * A better typed `Object.prototype.objectHasOwnOroperty`. It helps TypeScript
  * infer types when an object has multiple types with different properties.
@@ -144,4 +205,4 @@ declare function itemIsDefined<T>(item: T): item is Exclude<typeof item, undefin
  */
 declare function objectHasOwnProperty<Key extends PropertyKey>(object: object, key: Key): object is Record<Key, unknown>;
 
-export { type TreeNode, buildTreeNodes, hasCircularDependency, itemIsDefined, objectHasOwnProperty };
+export { type TreeNode, buildTreeNodes, hasCircularDependency, itemIsDefined, objectHasOwnNestedProperty, objectHasOwnProperty };

package/dist/index.d.ts

@@ -113,6 +113,67 @@ declare function hasCircularDependency<T extends object>(items: T[], idKey: keyo
  */
 declare function itemIsDefined<T>(item: T): item is Exclude<typeof item, undefined>;
 
+type NestedRecord<K extends readonly string[]> = K extends [
+    infer First extends string,
+    ...infer Rest extends string[]
+] ? Record<First, NestedRecord<Rest>> : unknown;
+/**
+ * Checks if an object has a nested property chain, using Object.prototype.hasOwnProperty at each level.
+ * Returns true if all keys exist and are objects (except the last, which can be any value).
+ *
+ * @template K - Tuple of string keys representing the property chain.
+ * @param object - The object to check.
+ * @param keys - The property chain to check for.
+ * @returns {boolean} True if the nested property exists, false otherwise.
+ *
+ * @example
+ * // Basic usage
+ * const apiError = { error: { message: 'Not found' } }
+ * if (
+ *   objectHasOwnNestedProperty(apiError, 'error', 'message') &&
+ *   typeof apiError.error.message === 'string'
+ * ) {
+ *   return apiError.error.message
+ * }
+ *
+ * @example
+ * // Deeply nested object
+ * const data = { a: { b: { c: 42 } } }
+ * if (objectHasOwnNestedProperty(data, 'a', 'b', 'c')) {
+ *   console.log(data.a.b.c) // 42
+ * }
+ *
+
+ * @example
+ * // Usage in a try/catch block to extract a deeply nested error message
+ * try {
+ *   // ...some code that may throw
+ * } catch(error) {
+ *   if (
+ *     objectHasOwnNestedProperty(error, 'body', 'error', 'message') &&
+ *     typeof error.body.error.message === 'string'
+ *   ) {
+ *     setErrorMessage(error.body.error.message)
+ *   }
+ * }
+ *
+ * // Missing property
+ * const obj = { a: { b: {} } }
+ * objectHasOwnNestedProperty(obj, 'a', 'b', 'c') // false
+ *
+ * @example
+ * // Works with arrays as values
+ * const arrObj = { a: { b: [1, 2, 3] } }
+ * objectHasOwnNestedProperty(arrObj, 'a', 'b') // true
+ *
+ * @example
+ * // TypeScript type guard
+ * if (objectHasOwnNestedProperty(apiError, 'error', 'message')) {
+ *   // apiError is now typed as { error: { message: unknown } }
+ * }
+ */
+declare function objectHasOwnNestedProperty<K extends readonly string[]>(object: unknown, ...keys: K): object is NestedRecord<K>;
+
 /**
  * A better typed `Object.prototype.objectHasOwnOroperty`. It helps TypeScript
  * infer types when an object has multiple types with different properties.
@@ -144,4 +205,4 @@ declare function itemIsDefined<T>(item: T): item is Exclude<typeof item, undefin
  */
 declare function objectHasOwnProperty<Key extends PropertyKey>(object: object, key: Key): object is Record<Key, unknown>;
 
-export { type TreeNode, buildTreeNodes, hasCircularDependency, itemIsDefined, objectHasOwnProperty };
+export { type TreeNode, buildTreeNodes, hasCircularDependency, itemIsDefined, objectHasOwnNestedProperty, objectHasOwnProperty };

package/dist/index.js

@@ -23,6 +23,7 @@ __export(index_exports, {
   buildTreeNodes: () => buildTreeNodes,
   hasCircularDependency: () => hasCircularDependency,
   itemIsDefined: () => itemIsDefined,
+  objectHasOwnNestedProperty: () => objectHasOwnNestedProperty,
   objectHasOwnProperty: () => objectHasOwnProperty
 });
 module.exports = __toCommonJS(index_exports);
@@ -107,10 +108,26 @@ function buildTreeNodes(items, idKey, parentIdKey, options = {}) {
 function itemIsDefined(item) {
   return item !== void 0;
 }
+
+// src/object-has-own-nested-property.ts
+function objectHasOwnNestedProperty(object, ...keys) {
+  if (typeof object !== "object" || object === null) {
+    return false;
+  }
+  let currentObject = object;
+  for (const key of keys) {
+    if (!objectHasOwnProperty(currentObject, key) || typeof currentObject[key] !== "object" || currentObject[key] === null) {
+      return false;
+    }
+    currentObject = currentObject[key];
+  }
+  return true;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   buildTreeNodes,
   hasCircularDependency,
   itemIsDefined,
+  objectHasOwnNestedProperty,
   objectHasOwnProperty
 });

package/dist/index.mjs

@@ -78,9 +78,25 @@ function buildTreeNodes(items, idKey, parentIdKey, options = {}) {
 function itemIsDefined(item) {
   return item !== void 0;
 }
+
+// src/object-has-own-nested-property.ts
+function objectHasOwnNestedProperty(object, ...keys) {
+  if (typeof object !== "object" || object === null) {
+    return false;
+  }
+  let currentObject = object;
+  for (const key of keys) {
+    if (!objectHasOwnProperty(currentObject, key) || typeof currentObject[key] !== "object" || currentObject[key] === null) {
+      return false;
+    }
+    currentObject = currentObject[key];
+  }
+  return true;
+}
 export {
   buildTreeNodes,
   hasCircularDependency,
   itemIsDefined,
+  objectHasOwnNestedProperty,
   objectHasOwnProperty
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/cpl-utils",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",