autobuilder-ts 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mark Manley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,33 @@
+# autobuilder-ts
+
+A "mad science", strongly-typed AutoBuilder for TypeScript. It automatically 
+collapses into your final object as soon as your planned keys are fulfilled, 
+eliminating the need for a trailing `.build()` method.
+
+## Installation
+
+```bash
+npm install autobuilder-ts
+```
+
+## Usage
+
+```ts
+import { autoBuilder } from "autobuilder-ts";
+
+interface User {
+  id: number;
+  username: string;
+  age?: number;
+}
+
+// 1. Define your target schema and plan your required/optional keys
+const builder = autoBuilder.returns<User>().plan("id", "username");
+
+// 2. Start chaining!
+// The moment the final planned key is provided, the builder returns 
+// the finalized object.
+const user = builder.with("id", 1).with("username", "admin");
+
+console.log(user.username); // "admin"
+```

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+type RequiredKeys<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? never : K;
+}[keyof T];
+type MissingKeysError<Missing> = {
+    "ERROR: Missing required keys in plan": Missing;
+};
+type Remaining<ExpectedKeys extends PropertyKey, Current extends object> = Exclude<ExpectedKeys, keyof Current>;
+type Compute<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type StepResult<Target extends object, ExpectedKeys extends keyof Target, NextState extends object> = Remaining<ExpectedKeys, NextState> extends never ? Compute<NextState> : AutoBuilderType<Target, ExpectedKeys, NextState>;
+export interface AutoBuilderType<Target extends object, ExpectedKeys extends keyof Target, Current extends object> {
+    with<K extends Remaining<ExpectedKeys, Current>>(key: K, value: Target[K]): StepResult<Target, ExpectedKeys, Compute<Current & Record<K, Target[K]>>>;
+}
+export declare const autoBuilder: {
+    returns: <Target extends object>() => {
+        plan: <K extends keyof Target>(...keys: K[]) => [RequiredKeys<Target>] extends [K] ? AutoBuilderType<Target, K, {}> : MissingKeysError<Exclude<RequiredKeys<Target>, K>>;
+    };
+};
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,KAAK,YAAY,CAAC,CAAC,IAAI;KACpB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC;CACpD,CAAC,MAAM,CAAC,CAAC,CAAC;AAGX,KAAK,gBAAgB,CAAC,OAAO,IAAI;IAC/B,sCAAsC,EAAE,OAAO,CAAC;CACjD,CAAC;AAGF,KAAK,SAAS,CAAC,YAAY,SAAS,WAAW,EAAE,OAAO,SAAS,MAAM,IAAI,OAAO,CAChF,YAAY,EACZ,MAAM,OAAO,CACd,CAAC;AAGF,KAAK,OAAO,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AAMhD,KAAK,UAAU,CACb,MAAM,SAAS,MAAM,EACrB,YAAY,SAAS,MAAM,MAAM,EACjC,SAAS,SAAS,MAAM,IAExB,SAAS,CAAC,YAAY,EAAE,SAAS,CAAC,SAAS,KAAK,GAC5C,OAAO,CAAC,SAAS,CAAC,GAClB,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;AAIvD,MAAM,WAAW,eAAe,CAC9B,MAAM,SAAS,MAAM,EACrB,YAAY,SAAS,MAAM,MAAM,EACjC,OAAO,SAAS,MAAM;IAEtB,IAAI,CAAC,CAAC,SAAS,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,EAC7C,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,GACf,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC9E;AA+BD,eAAO,MAAM,WAAW;cAEZ,MAAM,SAAS,MAAM;eAEtB,CAAC,SAAS,MAAM,MAAM,WAClB,CAAC,EAAE,KACX,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GACjC,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,GAC9B,gBAAgB,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;;CAKzD,CAAC"}

package/dist/index.js

@@ -0,0 +1,30 @@
+// --- Advanced Utility Types ---
+class AutoBuilderImpl {
+    targetKeys;
+    state;
+    constructor(targetKeys, state) {
+        this.targetKeys = targetKeys;
+        this.state = state;
+    }
+    with(key, value) {
+        const newState = { ...this.state, [key]: value };
+        // Check if every key in our plan has been provided
+        const hasAllKeys = this.targetKeys.every((k) => k in newState);
+        if (hasAllKeys) {
+            return newState; // Auto-build triggers!
+        }
+        return new AutoBuilderImpl(this.targetKeys, newState);
+    }
+}
+// --- Entry Point ---
+export const autoBuilder = {
+    // Step 1: Explicitly define the target interface (Schema)
+    returns: () => ({
+        // Step 2: Dynamically infer the chosen keys (The Plan)
+        plan: (...keys) => {
+            // ^ If required keys are missing, we return a custom Error Interface
+            return new AutoBuilderImpl(keys, {});
+        },
+    }),
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,iCAAiC;AA+CjC,MAAM,eAAe;IAMT;IACA;IAFV,YACU,UAA0B,EAC1B,KAAc;QADd,eAAU,GAAV,UAAU,CAAgB;QAC1B,UAAK,GAAL,KAAK,CAAS;IACrB,CAAC;IAEJ,IAAI,CACF,GAAM,EACN,KAAgB;QAEhB,MAAM,QAAQ,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAS,CAAC;QAExD,mDAAmD;QACnD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC;QAE/D,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,QAAQ,CAAC,CAAC,uBAAuB;QAC1C,CAAC;QAED,OAAO,IAAI,eAAe,CAA4B,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAQ,CAAC;IAC1F,CAAC;CACF;AAED,sBAAsB;AAEtB,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,0DAA0D;IAC1D,OAAO,EAAE,GAA0B,EAAE,CAAC,CAAC;QACrC,uDAAuD;QACvD,IAAI,EAAE,CACJ,GAAG,IAAS,EAGyC,EAAE;YACvD,qEAAqE;YACrE,OAAO,IAAI,eAAe,CAAgB,IAAI,EAAE,EAAS,CAAQ,CAAC;QACpE,CAAC;KACF,CAAC;CACH,CAAC"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "autobuilder-ts",
+  "version": "1.0.0",
+  "description": "A strongly-typed, auto-building Builder Pattern for TypeScript",
+  "main": "dist/index.js",
+  "type": "module",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "typescript",
+    "builder",
+    "builder-pattern",
+    "fluent-api",
+    "type-safe",
+    "auto",
+    "design",
+    "pattern",
+    "autobuilder",
+    "autobuilder-ts"
+  ],
+  "homepage": "https://github.com/Xs-and-10s/autobuilder-ts#readme",
+  "bugs": {
+    "url": "https://github.com/Xs-and-10s/autobuilder-ts/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Xs-and-10s/autobuilder-ts.git"
+  },
+  "license": "MIT",
+  "author": "Mark Manley",
+  "scripts": {
+    "build": "tsc",
+    "format": "oxfmt --write src tests",
+    "lint": "oxlint",
+    "lint:fix": "oxlint --fix",
+    "lint:watch": "oxlint --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run format && npm run lint && npm run test && npm run build"
+  },
+  "devDependencies": {
+    "oxfmt": "^0.34.0",
+    "oxlint": "^1.49.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  }
+}