bun-query-builder 0.1.11 → 0.1.12

package/dist/orm.d.ts

@@ -1,5 +1,17 @@
 import { Database } from 'bun:sqlite';
-export type { ModelInstance, ModelQueryBuilder };
+import type { Faker } from 'ts-mocker';
+export type {
+  ModelInstance,
+  ModelQueryBuilder,
+  ModelAttributes,
+  InferModelAttributes,
+  InferAttributeType,
+  SystemFields,
+  ColumnName,
+  AttributeKeys,
+  FillableKeys,
+  HiddenKeys,
+};
 export declare function configureOrm(options: { database?: string | Database; verbose?: boolean }): void;
 export declare function getDatabase(): Database;
 /**
@@ -22,7 +34,7 @@ export declare interface TypedAttribute<T = unknown> {
     rule: unknown
     message?: Record<string, string>
   }
-  factory?: (faker: unknown) => InferType<T>
+  factory?: (faker: Faker) => InferType<T>
 }
 // Base model definition
 export declare interface ModelDefinition {
@@ -33,30 +45,68 @@ export declare interface ModelDefinition {
   connection?: string
   traits?: {
     readonly useUuid?: boolean
-    readonly useTimestamps?: boolean
-    readonly useSoftDeletes?: boolean
-    readonly useSearch?: {
+    readonly useTimestamps?: boolean | object
+    readonly timestampable?: boolean | object
+    readonly useSoftDeletes?: boolean | object
+    readonly softDeletable?: boolean | object
+    readonly useSearch?: boolean | {
       readonly displayable?: readonly string[]
       readonly searchable?: readonly string[]
       readonly sortable?: readonly string[]
       readonly filterable?: readonly string[]
     }
-    readonly useSeeder?: {
+    readonly useSeeder?: boolean | {
       readonly count: number
     }
-    readonly useApi?: {
-      readonly uri: string
-      readonly routes: readonly string[]
+    readonly seedable?: boolean | {
+      readonly count: number
+    }
+    readonly useApi?: boolean | {
+      readonly uri?: string
+      readonly routes?: readonly string[]
+      readonly middleware?: readonly string[]
     }
+    readonly useAuth?: boolean | {
+      readonly usePasskey?: boolean
+      readonly useTwoFactor?: boolean
+    }
+    readonly authenticatable?: boolean | object
+    readonly observe?: boolean | readonly string[]
+    readonly billable?: boolean
+    readonly likeable?: boolean | object
+    readonly taggable?: boolean
+    readonly categorizable?: boolean
+    readonly commentables?: boolean
+    readonly useActivityLog?: boolean | object
+    readonly useSocials?: readonly string[]
   }
   belongsTo?: readonly string[]
   hasMany?: readonly string[]
   hasOne?: readonly string[]
+  belongsToMany?: readonly (string | object)[]
+  hasOneThrough?: readonly (string | object)[]
+  hasManyThrough?: readonly (string | object)[]
+  morphOne?: string | object
+  morphMany?: readonly (string | object)[]
+  morphTo?: object
+  morphToMany?: readonly string[]
+  morphedByMany?: readonly string[]
   attributes: {
     readonly [key: string]: TypedAttribute<unknown>
   }
   get?: Record<string, (attributes: Record<string, unknown>) => unknown>
   set?: Record<string, (attributes: Record<string, unknown>) => unknown>
+  scopes?: Record<string, (value: unknown) => unknown>
+  indexes?: readonly object[]
+  dashboard?: { readonly highlight?: boolean | number }
+  hooks?: {
+    readonly beforeCreate?: (data: any) => void | Promise<void>
+    readonly afterCreate?: (model: any) => void | Promise<void>
+    readonly beforeUpdate?: (model: any, data: any) => void | Promise<void>
+    readonly afterUpdate?: (model: any) => void | Promise<void>
+    readonly beforeDelete?: (model: any) => void | Promise<void>
+    readonly afterDelete?: (model: any) => void | Promise<void>
+  }
 }
 // Binding helper type for SQL queries
 declare type Bindings = SQLQueryBindings[]
@@ -77,7 +127,7 @@ declare type InferType<T> = T extends keyof PrimitiveTypeMap ? PrimitiveTypeMap[
 declare type AttributeKeys<TDef extends ModelDefinition> = keyof TDef['attributes'] & string
 // Infer single attribute type
 declare type InferAttributeType<TAttr> = TAttr extends { type: infer T } ? InferType<T> :
-  TAttr extends { factory: (faker: unknown) => infer R } ? R :
+  TAttr extends { factory: (faker: Faker) => infer R } ? R :
   unknown
 // Build the full attributes type from definition
 declare type InferModelAttributes<TDef extends ModelDefinition> = {
@@ -104,6 +154,25 @@ declare type HiddenKeys<TDef extends ModelDefinition> = {
 declare type FillableKeys<TDef extends ModelDefinition> = {
   [K in AttributeKeys<TDef>]: TDef['attributes'][K] extends { fillable: true } ? K : never
 }[AttributeKeys<TDef>]
+// Infer relation names from model definition
+declare type InferBelongsToNames<TDef> = TDef extends { belongsTo: readonly (infer R)[] }
+    ? R extends string ? Lowercase<R> : never : never
+declare type InferHasManyNames<TDef> = TDef extends { hasMany: readonly (infer R)[] }
+    ? R extends string ? Lowercase<R> : never : never
+declare type InferHasOneNames<TDef> = TDef extends { hasOne: readonly (infer R)[] }
+    ? R extends string ? Lowercase<R> : never : never
+declare type InferBelongsToManyNames<TDef> = TDef extends { belongsToMany: readonly (infer R)[] }
+    ? R extends string ? Lowercase<R> : R extends { model: infer M extends string } ? Lowercase<M> : never : never
+declare type InferHasOneThroughNames<TDef> = TDef extends { hasOneThrough: readonly (infer R)[] }
+    ? R extends string ? Lowercase<R> : R extends { model: infer M extends string } ? Lowercase<M> : never : never
+declare type InferHasManyThroughNames<TDef> = TDef extends { hasManyThrough: readonly (infer R)[] }
+    ? R extends string ? Lowercase<R> : R extends { model: infer M extends string } ? Lowercase<M> : never : never
+export type InferRelationNames<TDef> = | InferBelongsToNames<TDef>
+  | InferHasManyNames<TDef>
+  | InferHasOneNames<TDef>
+  | InferBelongsToManyNames<TDef>
+  | InferHasOneThroughNames<TDef>
+  | InferHasManyThroughNames<TDef>
 declare type WhereOperator = '=' | '!=' | '<' | '>' | '<=' | '>=' | 'like' | 'in' | 'not in'
 /**
  * Model instance - represents a single database record
@@ -138,6 +207,7 @@ declare class ModelQueryBuilder<TDef extends ModelDefinition, TSelected extends
   private _limit?: number;
   private _offset?: number;
   private _select: string[];
+  private _withRelations: string[];
   constructor(definition: TDef);
   where<K extends ColumnName<TDef>>(column: K, operatorOrValue: WhereOperator | (K extends keyof ModelAttributes<TDef> ? ModelAttributes<TDef>[K] : unknown), value?: K extends keyof ModelAttributes<TDef> ? ModelAttributes<TDef>[K] : unknown): ModelQueryBuilder<TDef, TSelected>;
   orWhere<K extends ColumnName<TDef>>(column: K, operatorOrValue: WhereOperator | (K extends keyof ModelAttributes<TDef> ? ModelAttributes<TDef>[K] : unknown), value?: K extends keyof ModelAttributes<TDef> ? ModelAttributes<TDef>[K] : unknown): ModelQueryBuilder<TDef, TSelected>;
@@ -154,6 +224,8 @@ declare class ModelQueryBuilder<TDef extends ModelDefinition, TSelected extends
   offset(count: number): ModelQueryBuilder<TDef, TSelected>;
   skip(count: number): ModelQueryBuilder<TDef, TSelected>;
   select<K extends ColumnName<TDef>>(columns: K[]): ModelQueryBuilder<TDef, K>;
+  with<R extends InferRelationNames<TDef>>(relations: R[]): ModelQueryBuilder<TDef, TSelected>;
+  getWithRelations(): string[];
   private buildQuery(): { sql: string; params: unknown[] };
   get(): ModelInstance<TDef, TSelected>[];
   first(): ModelInstance<TDef, TSelected> | undefined;

package/dist/schema.d.ts

@@ -1,3 +1,4 @@
+import type { Faker } from 'ts-mocker';
 /**
  * # `defineModel(model)`
  *
@@ -50,7 +51,7 @@ export declare interface Attribute {
   hidden?: boolean
   fillable?: boolean
   guarded?: boolean
-  factory?: (faker: unknown) => any
+  factory?: (faker: Faker) => any
   validation: {
     rule: ValidationType
     message?: ValidatorMessage

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bun-query-builder",
   "type": "module",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "description": "A simple yet performant query builder for TypeScript. Built with Bun.",
   "author": "Chris Breuer <chris@stacksjs.org>",
   "license": "MIT",