@aklinker1/zero-factory 0.1.3 → 1.0.0

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  
+
 # @aklinker1/zero-factory
 
 [![JSR](https://jsr.io/badges/@aklinker1/zero-factory)](https://jsr.io/@aklinker1/zero-factory) [![NPM Version](https://img.shields.io/npm/v/%40aklinker1%2Fzero-factory?logo=npm&labelColor=red&color=white)](https://www.npmjs.com/package/@aklinker1/zero-factory) [![Docs](https://img.shields.io/badge/Docs-blue?logo=readme&logoColor=white)](https://jsr.io/@aklinker1/zero-factory) [![API Reference](https://img.shields.io/badge/API%20Reference-blue?logo=readme&logoColor=white)](https://jsr.io/@aklinker1/zero-factory/doc) [![License](https://img.shields.io/npm/l/%40aklinker1%2Fzero-factory)](https://github.com/aklinker1/zero-factory/blob/main/LICENSE)
@@ -35,11 +35,11 @@ npm i @aklinker1/zero-factory
 - ✨ Deeply merge overrides with default values
 - 🔢 Sequence generator for IDs
 - 🎨 "traits" - define multiple variants of default values
+- ⚡ Compatible with all fake data generators (`@ngneat/falso`, `faker-js`, `chance`, `casual`, etc)
 
 **Not Supported:**
 
 - **Class instances**: Only objects can be created. Factories will not create class instances.
-- **Randomized data**: There are already several mature libraries for generating randomized testing data (`@ngneat/falso`, `faker-js`, `chance`, `casual`, etc).
 
 ## Usage
 
@@ -95,6 +95,23 @@ const user = userFactory({
 // }
 ```
 
+> [!IMPORTANT]
+> Arrays are not deeply merged. If a property is an array, overrides will fully replace it, like any other value.
+
+#### Many
+
+You can generate multiple objects using `factory.many(...)`. This method will return an array of objects.
+
+```ts
+userFactory.many(2, { username: "override" })
+// [
+//   { usenrame: "override", ... }
+//   { usenrame: "override", ... }
+// ]
+````
+
+Overridden fields apply to all the returned objects.
+
 #### Traits
 
 If there are common variants or "traits" of an object you want to be able to generate, use `factory.trait(...)`:
@@ -229,16 +246,6 @@ intSequence(); // "prefix-2"
 
 May or may not implement these.
 
-- Generate multiple items:
-  ```ts
-  userFactory.many(4, { username: "override" });
-  // [
-  //   { id: "user-0", username: "override", ... },
-  //   { id: "user-1", username: "override", ... },
-  //   { id: "user-2", username: "override", ... },
-  //   { id: "user-3", username: "override", ... },
-  // ]
-  ```
 - Associations:
 
   ```ts

package/dist/utils.d.ts

@@ -8,7 +8,7 @@ export type DeepPartial<T> = T extends Array<any> ? T : T extends Record<string,
  * Deep merge objects, not arrays. Only override values with `null`, `undefined` does not override the base value.
  */
 export declare function deepMerge<T>(base: T, overrides: DeepPartial<T>): T;
-export type FactoryDefaults<T> = T extends Array<any> ? T | (() => T) : T extends Record<string, any> ? {
-    [key in keyof T]: FactoryDefaults<T[key]>;
-} : T extends Function ? never : T | (() => T);
+export type FactoryDefaults<T extends Record<string, any>> = {
+    [Key in keyof T]: T[Key] extends Array<any> ? T[Key] | (() => T[Key]) : T[Key] extends Record<string, any> ? FactoryDefaults<T[Key]> : T[Key] extends Function ? never : T[Key] | (() => T[Key]);
+};
 export declare function resolveDefaults<T extends Record<string, any>>(val: FactoryDefaults<T>): T;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aklinker1/zero-factory",
   "description": "Zero dependency object factory generator for testing",
-  "version": "0.1.3",
+  "version": "1.0.0",
   "packageManager": "bun@1.2.20",
   "type": "module",
   "license": "MIT",