@puq/type 0.4.11 → 0.4.50

package/dist/lib/utils/keys.d.ts

@@ -0,0 +1,36 @@
+import type { KeyOf } from './key-of.js';
+/**
+ * Represents an array of keys from an object type `T`.
+ * This utility type creates an array type where each element is a key of `T`,
+ * allowing you to define collections of property names. If `T` is not specified,
+ * it defaults to `unknown`, resulting in an array of any possible keys.
+ *
+ * @template T - The object type whose keys populate the array. Defaults to `unknown`.
+ * @returns An array type containing elements of type `KeyOf<T>`.
+ *
+ * @example
+ * ```typescript
+ * interface User {
+ *   name: string;
+ *   age: number;
+ * }
+ *
+ * type UserKeyArray = Keys<User>;
+ * // Result: ('name' | 'age')[]
+ *
+ * const keys: UserKeyArray = ['name', 'age']; // OK
+ * const mixed: UserKeyArray = ['name', 'name', 'age']; // OK (allows duplicates)
+ * // const invalid: UserKeyArray = ['name', 'email']; // Error: 'email' is not assignable
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Default usage with unknown
+ * type AnyKeys = Keys;
+ * // Result: (string | number | symbol)[]
+ *
+ * const anyKeys: AnyKeys = ['a', 1, 'b']; // OK
+ * ```
+ */
+export type Keys<T = unknown> = KeyOf<T>[];
+//# sourceMappingURL=keys.d.ts.map

package/dist/lib/utils/keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/keys.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,GAAG,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC"}

package/dist/lib/utils/keys.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=keys.js.map

package/dist/lib/utils/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/utils/keys.ts"],"names":[],"mappings":""}

package/dist/lib/utils/set-optional.d.ts

@@ -0,0 +1,47 @@
+import type { KeyOf } from './key-of.js';
+/**
+ * Creates a type that makes specific keys of `T` optional while preserving the rest.
+ * This utility type takes an object type `T` and a subset of its keys `R`, ensuring
+ * that the properties specified in `R` become optional, while other properties retain
+ * their original required or optional status.
+ *
+ * @template T - The original object type to modify.
+ * @template R - The keys of `T` that should be made optional. Must extend `KeyOf<T>`.
+ *
+ * @remarks
+ * - Uses `Omit<T, R>` to exclude the keys in `R` from `T`.
+ * - Intersects with `Partial<Pick<T, R>>` to make the picked keys optional.
+ * - Relies on `KeyOf<T>` (assumed to be `keyof T`) for keyof inference.
+ *
+ * @example
+ * ```typescript
+ * interface User {
+ *   name: string;
+ *   age: number;
+ *   email?: string;
+ * }
+ *
+ * // Make 'name' and 'age' optional, keep 'email' as-is
+ * type OptionalUser = SetOptional<User, 'name' | 'age'>;
+ *
+ * const valid1: OptionalUser = { email: 'alice@example.com' }; // OK
+ * const valid2: OptionalUser = { name: 'Alice', age: 30, email: 'alice@example.com' }; // OK
+ * const valid3: OptionalUser = { name: 'Bob' }; // OK
+ * ```
+ *
+ * @example
+ * ```typescript
+ * interface Config {
+ *   host: string;
+ *   port: number;
+ * }
+ *
+ * // Make 'port' optional
+ * type PartialConfig = SetOptional<Config, 'port'>;
+ *
+ * const config1: PartialConfig = { host: 'localhost' }; // OK
+ * const config2: PartialConfig = { host: 'localhost', port: 8080 }; // OK
+ * ```
+ */
+export type SetOptional<T, R extends KeyOf<T>> = Omit<T, R> & Partial<Pick<T, R>>;
+//# sourceMappingURL=set-optional.d.ts.map

package/dist/lib/utils/set-optional.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-optional.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/set-optional.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GACzD,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC"}

package/dist/lib/utils/set-optional.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=set-optional.js.map

package/dist/lib/utils/set-optional.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/utils/set-optional.ts"],"names":[],"mappings":""}

package/dist/lib/utils/set-required.d.ts

@@ -0,0 +1,47 @@
+import type { KeyOf } from './key-of.js';
+/**
+ * Creates a type that makes specific keys of `T` required while preserving the rest.
+ * This utility type takes an object type `T` and a subset of its keys `R`, ensuring
+ * that the properties specified in `R` are always required, while other properties
+ * remain optional or unchanged.
+ *
+ * @template T - The original object type to modify.
+ * @template R - The keys of `T` that should be made required. Must extend `KeyOf<T>`.
+ *
+ * @remarks
+ * - Uses `Omit<T, R>` to exclude the keys in `R` from `T`.
+ * - Intersects with `Required<Pick<T, R>>` to make the picked keys required.
+ * - Relies on `KeyOf<T>` (assumed to be `keyof T`) for keyof inference.
+ *
+ * @example
+ * ```typescript
+ * interface User {
+ *   name?: string;
+ *   age?: number;
+ *   email?: string;
+ * }
+ *
+ * // Make 'name' and 'age' required, keep 'email' optional
+ * type RequiredUser = SetRequired<User, 'name' | 'age'>;
+ *
+ * const valid: RequiredUser = { name: 'Alice', age: 30 }; // OK
+ * const validWithEmail: RequiredUser = { name: 'Bob', age: 25, email: 'bob@example.com' }; // OK
+ * // const invalid: RequiredUser = { name: 'Charlie' }; // Error: 'age' is required
+ * ```
+ *
+ * @example
+ * ```typescript
+ * interface Config {
+ *   host: string;
+ *   port?: number;
+ * }
+ *
+ * // Make 'port' required
+ * type FullConfig = SetRequired<Config, 'port'>;
+ *
+ * const config: FullConfig = { host: 'localhost', port: 8080 }; // OK
+ * // const incomplete: FullConfig = { host: 'localhost' }; // Error: 'port' is required
+ * ```
+ */
+export type SetRequired<T, R extends KeyOf<T>> = Omit<T, R> & Required<Pick<T, R>>;
+//# sourceMappingURL=set-required.d.ts.map

package/dist/lib/utils/set-required.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-required.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/set-required.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GACzD,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC"}

package/dist/lib/utils/set-required.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=set-required.js.map

package/dist/lib/utils/set-required.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/lib/utils/set-required.ts"],"names":[],"mappings":""}

package/dist/lib/utils/type.d.ts

@@ -1,3 +1,20 @@
+/**
+ * Represents a constructor function that creates instances of type `T`.
+ * @template T - The type of the instance created by the constructor. Defaults to `unknown`.
+ * @extends Function - Inherits from the base `Function` type.
+ * @example
+ * ```typescript
+ * class User {
+ *   constructor(name: string) {
+ *     this.name = name;
+ *   }
+ *   name: string;
+ * }
+ * const UserConstructor: Type<User> = User;
+ * const user = new UserConstructor('Alice');
+ * console.log(user.name); // 'Alice'
+ * ```
+ */
 export interface Type<T = any> extends Function {
     new (...args: any[]): T;
 }

package/dist/lib/utils/type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/type.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,IAAI,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,QAAQ;IAC7C,KAAI,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;CACxB"}
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/type.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,IAAI,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,QAAQ;IAC7C,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;CACzB"}

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@puq/type",
-  "version": "0.4.8",
+  "version": "0.4.50",
   "license": "MIT",
   "publishConfig": {
     "access": "public",

package/package.json

@@ -1,87 +1,87 @@
-{
-  "name": "@puq/type",
-  "version": "0.4.11",
-  "license": "MIT",
-  "publishConfig": {
-    "access": "public",
-    "tag": "latest"
-  },
-  "description": "Common model and utility types",
-  "author": {
-    "email": "robert.brightline@gmail.com",
-    "name": "Robert Brightline",
-    "url": "https://rbrightline.github.io"
-  },
-  "keywords": [
-    "type",
-    "model",
-    "type-utility"
-  ],
-  "repository": {
-    "directory": "libs/type",
-    "url": "https://github.com/rbrightline/puq/tree/main",
-    "type": "github"
-  },
-  "homepage": "https://rbrightline.github.io/puq/type",
-  "bugs": {
-    "email": "robert.brightline@gmail.com",
-    "url": "https://rbrightline.github.io"
-  },
-  "categories": [
-    "Other"
-  ],
-  "contributors": [
-    {
-      "email": "robert.brightline@gmail.com",
-      "name": "Robert Brightline",
-      "url": "https://rbrightline.github.io"
-    }
-  ],
-  "funding": [
-    "https://cash.app/$puqlib"
-  ],
-  "icon": "https://raw.githubusercontent.com/rbrightline/puq/refs/heads/main/libs/type/favicon.png",
-  "type": "module",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "default": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist",
-    "!**/*.tsbuildinfo"
-  ],
-  "nx": {
-    "sourceRoot": "libs/type/src",
-    "targets": {
-      "build": {
-        "executor": "@nx/js:swc",
-        "outputs": [
-          "{options.outputPath}"
-        ],
-        "options": {
-          "outputPath": "libs/type/dist",
-          "main": "libs/type/src/index.ts",
-          "tsConfig": "libs/type/tsconfig.lib.json",
-          "skipTypeCheck": false,
-          "stripLeadingPaths": true
-        },
-        "dependsOn": [
-          "lint"
-        ]
-      },
-      "doc": {
-        "command": "cd libs/type &&  npx compodoc -d ../../public/type  -p tsconfig.lib.json -n type"
-      }
-    }
-  },
-  "dependencies": {
-    "@swc/helpers": "^0.5.15"
-  }
+{
+    "name": "@puq/type",
+    "version": "0.4.50",
+    "license": "MIT",
+    "publishConfig": {
+        "access": "public",
+        "tag": "latest"
+    },
+    "description": "Common model and utility types",
+    "author": {
+        "email": "robert.brightline@gmail.com",
+        "name": "Robert Brightline",
+        "url": "https://rbrightline.github.io"
+    },
+    "keywords": [
+        "type",
+        "model",
+        "type-utility"
+    ],
+    "repository": {
+        "directory": "libs/type",
+        "url": "https://github.com/rbrightline/puq/tree/main",
+        "type": "github"
+    },
+    "homepage": "https://rbrightline.github.io/puq/type",
+    "bugs": {
+        "email": "robert.brightline@gmail.com",
+        "url": "https://rbrightline.github.io"
+    },
+    "categories": [
+        "Other"
+    ],
+    "contributors": [
+        {
+            "email": "robert.brightline@gmail.com",
+            "name": "Robert Brightline",
+            "url": "https://rbrightline.github.io"
+        }
+    ],
+    "funding": [
+        "https://cash.app/$puqlib"
+    ],
+    "icon": "https://raw.githubusercontent.com/rbrightline/puq/refs/heads/main/libs/type/favicon.png",
+    "type": "module",
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "default": "./dist/index.js"
+        }
+    },
+    "files": [
+        "dist",
+        "!**/*.tsbuildinfo"
+    ],
+    "nx": {
+        "sourceRoot": "libs/type/src",
+        "targets": {
+            "build": {
+                "executor": "@nx/js:swc",
+                "outputs": [
+                    "{options.outputPath}"
+                ],
+                "options": {
+                    "outputPath": "libs/type/dist",
+                    "main": "libs/type/src/index.ts",
+                    "tsConfig": "libs/type/tsconfig.lib.json",
+                    "skipTypeCheck": false,
+                    "stripLeadingPaths": true
+                },
+                "dependsOn": [
+                    "lint"
+                ]
+            },
+            "doc": {
+                "command": "cd libs/type &&  npx compodoc -d ../../public/type  -p tsconfig.lib.json -n type"
+            }
+        }
+    },
+    "dependencies": {
+        "@swc/helpers": "^0.5.15"
+    }
 }

package/dist/lib/utils/optional.d.ts

@@ -1,6 +0,0 @@
-/**
- * Make the type nullable and undefinedable.
- * - T -> T | undefined | null
- */
-export type Optional<T> = T | undefined | null;
-//# sourceMappingURL=optional.d.ts.map

package/dist/lib/utils/optional.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"optional.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/optional.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC"}

package/dist/lib/utils/optional.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/lib/utils/optional.ts"],"names":[],"mappings":""}

package/dist/lib/utils/pick-optional.d.ts

@@ -1,3 +0,0 @@
-import { KeyOf } from './key-of.js';
-export type PickOptional<T, R extends KeyOf<T>> = Omit<T, R> & Partial<Pick<T, R>>;
-//# sourceMappingURL=pick-optional.d.ts.map

package/dist/lib/utils/pick-optional.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pick-optional.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/pick-optional.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC"}

package/dist/lib/utils/pick-optional.js

@@ -1,3 +0,0 @@
-export { };
-
-//# sourceMappingURL=pick-optional.js.map

package/dist/lib/utils/pick-optional.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/lib/utils/pick-optional.ts"],"names":[],"mappings":""}

package/dist/lib/utils/pick-required.d.ts

@@ -1,3 +0,0 @@
-import { KeyOf } from './key-of.js';
-export type PickRequired<T, R extends KeyOf<T>> = Omit<T, R> & Required<Pick<T, R>>;
-//# sourceMappingURL=pick-required.d.ts.map

package/dist/lib/utils/pick-required.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pick-required.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/pick-required.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAC1D,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC"}

package/dist/lib/utils/pick-required.js

@@ -1,3 +0,0 @@
-export { };
-
-//# sourceMappingURL=pick-required.js.map

package/dist/lib/utils/pick-required.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/lib/utils/pick-required.ts"],"names":[],"mappings":""}