@boostkit/orm 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 BoostKit
+
+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,41 @@
+# @boostkit/orm
+
+ORM contracts and base model abstraction used by Forge ORM adapters.
+
+## Installation
+
+```bash
+pnpm add @boostkit/orm
+```
+
+## Usage
+
+```ts
+import { Model, ModelRegistry } from '@boostkit/orm'
+
+class User extends Model {
+  static override table = 'user'
+}
+
+const db = ModelRegistry.getAdapter()
+const users = await User.all()
+const first = await db.query('user').where('role', 'admin').first()
+```
+
+## API Reference
+
+- Query types: `WhereOperator`, `WhereClause`, `OrderClause`, `QueryState`
+- `QueryBuilder<T>`
+- `PaginatedResult<T>`
+- `Model`
+- `OrmAdapter`, `OrmAdapterProvider`
+- `ModelRegistry`
+
+## Configuration
+
+This package has no runtime config object.
+
+## Notes
+
+- `ModelRegistry.set(adapter)` must be called before using `Model.query()` helpers.
+- `Model.getTable()` defaults to lowercase class name + `s`.

package/dist/index.d.ts

@@ -0,0 +1,86 @@
+export type WhereOperator = '=' | '!=' | '>' | '>=' | '<' | '<=' | 'LIKE' | 'IN' | 'NOT IN';
+export interface WhereClause {
+    column: string;
+    operator: WhereOperator;
+    value: unknown;
+}
+export interface OrderClause {
+    column: string;
+    direction: 'ASC' | 'DESC';
+}
+export interface QueryState {
+    wheres: WhereClause[];
+    orders: OrderClause[];
+    limitN: number | null;
+    offsetN: number | null;
+    withs: string[];
+}
+export interface QueryBuilder<T> {
+    where(column: string, value: unknown): this;
+    where(column: string, operator: WhereOperator, value: unknown): this;
+    orWhere(column: string, value: unknown): this;
+    orderBy(column: string, direction?: 'ASC' | 'DESC'): this;
+    limit(n: number): this;
+    offset(n: number): this;
+    with(...relations: string[]): this;
+    first(): Promise<T | null>;
+    find(id: number | string): Promise<T | null>;
+    get(): Promise<T[]>;
+    all(): Promise<T[]>;
+    count(): Promise<number>;
+    create(data: Partial<T>): Promise<T>;
+    update(id: number | string, data: Partial<T>): Promise<T>;
+    delete(id: number | string): Promise<void>;
+    paginate(page: number, perPage?: number): Promise<PaginatedResult<T>>;
+}
+export interface PaginatedResult<T> {
+    data: T[];
+    total: number;
+    perPage: number;
+    currentPage: number;
+    lastPage: number;
+    from: number;
+    to: number;
+}
+export declare abstract class Model {
+    /** The table name — defaults to lowercase class name + 's' */
+    static table: string;
+    /** Primary key column */
+    static primaryKey: string;
+    /** Columns to hide from JSON output */
+    static hidden: string[];
+    /** Columns that are mass-assignable */
+    static fillable: string[];
+    /** Get the table name, auto-pluralizing if not set */
+    static getTable(this: typeof Model): string;
+    /** Return a query builder for this model */
+    static query<T extends typeof Model>(this: T): QueryBuilder<InstanceType<T>>;
+    private static _q;
+    /** Shorthand — find by primary key */
+    static find<T extends typeof Model>(this: T, id: number | string): Promise<InstanceType<T> | null>;
+    /** Shorthand — get all records */
+    static all<T extends typeof Model>(this: T): Promise<InstanceType<T>[]>;
+    /** Shorthand — where clause */
+    static where<T extends typeof Model>(this: T, column: string, value: unknown): QueryBuilder<InstanceType<T>>;
+    /** Shorthand — create a record */
+    static create<T extends typeof Model>(this: T, data: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
+    /** Shorthand — eager load relations */
+    static with<T extends typeof Model>(this: T, ...relations: string[]): QueryBuilder<InstanceType<T>>;
+    /** Convert model to JSON, respecting hidden fields */
+    toJSON(): Record<string, unknown>;
+}
+export interface OrmAdapter {
+    query<T>(table: string): QueryBuilder<T>;
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+}
+export interface OrmAdapterProvider {
+    create(): OrmAdapter | Promise<OrmAdapter>;
+}
+export declare class ModelRegistry {
+    private static adapter;
+    static set(adapter: OrmAdapter): void;
+    static get(): OrmAdapter | null;
+    static getAdapter(): OrmAdapter;
+}
+//# 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":"AAEA,MAAM,MAAM,aAAa,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAA;AAE3F,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAI,MAAM,CAAA;IAChB,QAAQ,EAAE,aAAa,CAAA;IACvB,KAAK,EAAK,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAK,MAAM,CAAA;IACjB,SAAS,EAAE,KAAK,GAAG,MAAM,CAAA;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAG,WAAW,EAAE,CAAA;IACtB,MAAM,EAAG,WAAW,EAAE,CAAA;IACtB,MAAM,EAAG,MAAM,GAAG,IAAI,CAAA;IACtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,KAAK,EAAI,MAAM,EAAE,CAAA;CAClB;AAID,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IAC3C,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IACpE,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7C,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAA;IACzD,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,IAAI,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAClC,KAAK,IAAI,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IAC1B,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IAC5C,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;IACnB,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;IACnB,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IACxB,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACpC,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACzD,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;CACtE;AAID,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,IAAI,EAAS,CAAC,EAAE,CAAA;IAChB,KAAK,EAAQ,MAAM,CAAA;IACnB,OAAO,EAAM,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAK,MAAM,CAAA;IACnB,IAAI,EAAS,MAAM,CAAA;IACnB,EAAE,EAAW,MAAM,CAAA;CACpB;AAID,8BAAsB,KAAK;IACzB,8DAA8D;IAC9D,MAAM,CAAC,KAAK,EAAE,MAAM,CAAA;IAEpB,yBAAyB;IACzB,MAAM,CAAC,UAAU,SAAO;IAExB,uCAAuC;IACvC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAK;IAE5B,uCAAuC;IACvC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAK;IAE9B,sDAAsD;IACtD,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,KAAK,GAAG,MAAM;IAI3C,4CAA4C;IAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAM5E,OAAO,CAAC,MAAM,CAAC,EAAE;IAIjB,sCAAsC;IACtC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAIlG,kCAAkC;IAClC,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;IAIvE,+BAA+B;IAC/B,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAI5G,kCAAkC;IAClC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAIxG,uCAAuC;IACvC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,OAAO,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAInG,sDAAsD;IACtD,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAMlC;AAID,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAAA;IACxC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,IAAI,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CAC3C;AAID,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,OAAO,CAA0B;IAEhD,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI;IAIrC,MAAM,CAAC,GAAG,IAAI,UAAU,GAAG,IAAI;IAI/B,MAAM,CAAC,UAAU,IAAI,UAAU;CAMhC"}

package/dist/index.js

@@ -0,0 +1,65 @@
+// ─── Types ─────────────────────────────────────────────────
+// ─── Model Base Class ──────────────────────────────────────
+export class Model {
+    /** The table name — defaults to lowercase class name + 's' */
+    static table;
+    /** Primary key column */
+    static primaryKey = 'id';
+    /** Columns to hide from JSON output */
+    static hidden = [];
+    /** Columns that are mass-assignable */
+    static fillable = [];
+    /** Get the table name, auto-pluralizing if not set */
+    static getTable() {
+        return this.table ?? `${this.name.toLowerCase()}s`;
+    }
+    /** Return a query builder for this model */
+    static query() {
+        return ModelRegistry.getAdapter().query(this.getTable());
+    }
+    static _q(self) {
+        return ModelRegistry.getAdapter().query(self.getTable());
+    }
+    /** Shorthand — find by primary key */
+    static find(id) {
+        return Model._q(this).find(id);
+    }
+    /** Shorthand — get all records */
+    static all() {
+        return Model._q(this).all();
+    }
+    /** Shorthand — where clause */
+    static where(column, value) {
+        return Model._q(this).where(column, value);
+    }
+    /** Shorthand — create a record */
+    static create(data) {
+        return Model._q(this).create(data);
+    }
+    /** Shorthand — eager load relations */
+    static with(...relations) {
+        return Model._q(this).with(...relations);
+    }
+    /** Convert model to JSON, respecting hidden fields */
+    toJSON() {
+        const hidden = this.constructor.hidden;
+        return Object.fromEntries(Object.entries(this).filter(([k]) => !hidden.includes(k)));
+    }
+}
+// ─── Global ORM Registry ───────────────────────────────────
+export class ModelRegistry {
+    static adapter = null;
+    static set(adapter) {
+        this.adapter = adapter;
+    }
+    static get() {
+        return this.adapter;
+    }
+    static getAdapter() {
+        if (!this.adapter) {
+            throw new Error('[BoostKit ORM] No ORM adapter registered. Did you configure one in forge.config.ts?');
+        }
+        return this.adapter;
+    }
+}
+//# 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,8DAA8D;AAwD9D,8DAA8D;AAE9D,MAAM,OAAgB,KAAK;IACzB,8DAA8D;IAC9D,MAAM,CAAC,KAAK,CAAQ;IAEpB,yBAAyB;IACzB,MAAM,CAAC,UAAU,GAAG,IAAI,CAAA;IAExB,uCAAuC;IACvC,MAAM,CAAC,MAAM,GAAa,EAAE,CAAA;IAE5B,uCAAuC;IACvC,MAAM,CAAC,QAAQ,GAAa,EAAE,CAAA;IAE9B,sDAAsD;IACtD,MAAM,CAAC,QAAQ;QACb,OAAO,IAAI,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAA;IACpD,CAAC;IAED,4CAA4C;IAC5C,MAAM,CAAC,KAAK;QACV,OAAO,aAAa,CAAC,UAAU,EAAE,CAAC,KAAK,CACpC,IAAqB,CAAC,QAAQ,EAAE,CAClC,CAAA;IACH,CAAC;IAEO,MAAM,CAAC,EAAE,CAAyB,IAAO;QAC/C,OAAO,aAAa,CAAC,UAAU,EAAE,CAAC,KAAK,CAAmB,IAAqB,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC7F,CAAC;IAED,sCAAsC;IACtC,MAAM,CAAC,IAAI,CAAkC,EAAmB;QAC9D,OAAO,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAChC,CAAC;IAED,kCAAkC;IAClC,MAAM,CAAC,GAAG;QACR,OAAO,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAA;IAC7B,CAAC;IAED,+BAA+B;IAC/B,MAAM,CAAC,KAAK,CAAkC,MAAc,EAAE,KAAc;QAC1E,OAAO,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;IAED,kCAAkC;IAClC,MAAM,CAAC,MAAM,CAAkC,IAA8B;QAC3E,OAAO,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC;IAED,uCAAuC;IACvC,MAAM,CAAC,IAAI,CAAkC,GAAG,SAAmB;QACjE,OAAO,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAA;IAC1C,CAAC;IAED,sDAAsD;IACtD,MAAM;QACJ,MAAM,MAAM,GAAI,IAAI,CAAC,WAA4B,CAAC,MAAM,CAAA;QACxD,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAC1D,CAAA;IACH,CAAC;;AAeH,8DAA8D;AAE9D,MAAM,OAAO,aAAa;IAChB,MAAM,CAAC,OAAO,GAAsB,IAAI,CAAA;IAEhD,MAAM,CAAC,GAAG,CAAC,OAAmB;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,GAAG;QACR,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,MAAM,CAAC,UAAU;QACf,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAA;QACxG,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@boostkit/orm",
+  "version": "0.0.1",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/boostkitjs/boostkit",
+    "directory": "packages/orm"
+  },
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@boostkit/core": "0.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.4.0",
+    "tsx": "^4.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "test": "tsc -p tsconfig.test.json && node --test dist-test/index.test.js; rm -rf dist-test"
+  }
+}