@powfix/core-js 0.24.6 → 0.25.0

package/dist/shared/types/Object.cjs

@@ -0,0 +1 @@
+'use strict';

package/dist/shared/types/Object.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Makes all properties required and strips `null` from property types.
+ *
+ * @example
+ * type Input = {
+ *   a?: string | null
+ *   b: number | null
+ * }
+ * type Result = CustomRequired<Input>
+ * // {
+ * //   a: string
+ * //   b: number
+ * // }
+ */
+type CustomRequired<T> = {
+    [P in keyof T]-?: T[P] extends infer A | null ? A : T[P];
+};
+type R = Record<string, any>;
+/**
+ * Extracts keys of properties whose value is an object (but not arrays).
+ *
+ * @example
+ * type Example = {
+ *   id: number
+ *   info: { name: string }
+ *   tags: string[]
+ * }
+ * type ObjKeys = ObjectKeys<Example> // "info"
+ */
+export type ObjectKeys<T, RT = CustomRequired<T>> = keyof {
+    [P in keyof RT as RT[P] extends any[] ? never : RT[P] extends R ? P : never]: RT[P];
+};
+/**
+ * Extracts keys of properties whose value is an array of objects.
+ *
+ * @example
+ * type Example = {
+ *   id: number
+ *   posts: { title: string }[]
+ *   scores: number[]
+ * }
+ * type ArrayObjKeys = ArrayObjectKeys<Example> // "posts"
+ */
+export type ArrayObjectKeys<T, RT = CustomRequired<T>> = keyof {
+    [P in keyof RT as RT[P] extends R[] ? P : never]: RT[P];
+};
+type DepthLevel = [never, 0, 1, 2, 3, 4, 5];
+type DepthType = DepthLevel[number];
+/**
+ * Recursively collects nested object keys (`a.b.c`) up to a defined depth.
+ *
+ * Default depth = 5.
+ *
+ * @example
+ * type Example = {
+ *   user: {
+ *     profile: {
+ *       email: string
+ *     }
+ *   }
+ *   tags: string[]
+ * }
+ *
+ * type Keys = NestedObjectKeys<Example>
+ * // "user" | "user.profile" | "user.profile.email"
+ */
+export type NestedObjectKeys<T, Depth extends DepthType = 5, RT = CustomRequired<T>> = keyof {
+    [P in keyof RT & string as Depth extends never ? never : RT[P] extends any[] ? never : RT[P] extends R ? P | `${P}.${NestedObjectKeys<RT[P], DepthLevel[Depth]>}` : never]: RT[P];
+};
+/**
+ * Recursively collects nested object keys inside array properties.
+ *
+ * Keys include the root array field name and dot paths inside array item objects.
+ *
+ * @example
+ * type Example = {
+ *   comments: {
+ *     users: {
+ *       name: string,
+ *       addresses: {
+ *         name
+ *       }[]
+ *     }[]
+ *   }[]
+ * }
+ *
+ * type Keys = NestedArrayObjectKeys<Example>
+ * // "comments" | "comments.users" | "comments.users.addresses"
+ */
+export type NestedArrayObjectKeys<T, Depth extends DepthType = 5, RT = CustomRequired<T>> = keyof {
+    [P in keyof RT & string as Depth extends never ? never : RT[P] extends R[] ? P | `${P}.${NestedArrayObjectKeys<RT[P][number], DepthLevel[Depth]>}` : never]: RT[P];
+};
+/**
+ * Picks only properties that are objects (not arrays).
+ *
+ * @example
+ * type Example = {
+ *   id: number
+ *   settings: { dark: boolean }
+ *   history: string[]
+ * }
+ *
+ * type Result = PickObjects<Example>
+ * // { settings: { dark: boolean } }
+ */
+export type PickObjects<T> = Pick<T, ObjectKeys<T>>;
+/**
+ * Picks only properties that are arrays of objects.
+ *
+ * @example
+ * type Example = {
+ *   users: { name: string }[]
+ *   count: number
+ * }
+ *
+ * type Result = PickArrayObjects<Example>
+ * // { users: { name: string }[] }
+ */
+export type PickArrayObjects<T> = Pick<T, ArrayObjectKeys<T>>;
+export {};

package/dist/shared/types/index.cjs

@@ -1,6 +1,7 @@
 'use strict';
 var IntRage = require('./IntRage');
 var PartialExcept = require('./PartialExcept');
+var Object$1 = require('./Object');
 Object.keys(IntRage).forEach(function(k) {
     if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
         enumerable: true,
@@ -17,3 +18,11 @@ Object.keys(PartialExcept).forEach(function(k) {
         }
     });
 });
+Object.keys(Object$1).forEach(function(k) {
+    if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+        enumerable: true,
+        get: function get() {
+            return Object$1[k];
+        }
+    });
+});

package/dist/shared/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from './IntRage.js';
 export * from './PartialExcept.js';
+export * from './Object.js';

package/dist/shared/types/index.js

@@ -1,2 +1,3 @@
 export * from './IntRage.js';
 export * from './PartialExcept.js';
+export * from './Object.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powfix/core-js",
-  "version": "0.24.6",
+  "version": "0.25.0",
   "description": "core package",
   "author": "Kwon Kyung-Min <powfix@gmail.com>",
   "private": false,