@type32/tauri-sqlite-orm 0.1.2 → 0.1.4

package/dist/index.d.mts

@@ -1,18 +1,5 @@
 import Database from '@tauri-apps/plugin-sql';
 
-/**
- * Initializes the database connection. This must be called once at the start of your application.
- * @param dbPath The path to the database file, e.g., 'sqlite:mydatabase.db'
- * @returns The database instance.
- */
-declare function initDb(dbPath: string): Promise<Database>;
-/**
- * Gets the singleton database instance.
- * @throws If `initDb` has not been called.
- * @returns The database instance.
- */
-declare function getDb(): Database;
-
 type UpdateDeleteAction = "cascade" | "restrict" | "no action" | "set null" | "set default";
 interface SQLExpression {
     raw: string;
@@ -26,6 +13,7 @@ interface Column<T = any> {
     isNotNull?: boolean;
     defaultValue?: T | SQLExpression;
     defaultFn?: () => any;
+    onUpdateFn?: () => any;
     references?: {
         table: string;
         column: string;
@@ -48,29 +36,49 @@ type ColumnBuilder<T> = Column<T> & {
     default: (value: T | SQLExpression) => ColumnBuilder<T>;
     $type: <U>() => ColumnBuilder<U>;
     $defaultFn: (fn: () => any) => ColumnBuilder<T>;
+    $default: (fn: () => any) => ColumnBuilder<T>;
+    $onUpdate: (fn: () => any) => ColumnBuilder<T>;
+    $onUpdateFn: (fn: () => any) => ColumnBuilder<T>;
     references: (target: () => Column<any>, actions?: {
         onDelete?: UpdateDeleteAction;
         onUpdate?: UpdateDeleteAction;
     }) => ColumnBuilder<T>;
 };
-declare function text<TEnum extends string>(name: string, config?: {
-    isPrimaryKey?: boolean;
+type TextConfig<TEnum extends string> = {
     enum?: readonly TEnum[];
-}): ColumnBuilder<TEnum extends string ? TEnum : string>;
+    mode?: "json";
+};
+declare function text<TEnum extends string>(name: string, config?: TextConfig<TEnum>): ColumnBuilder<TEnum extends string ? TEnum : string>;
+declare function text<TEnum extends string>(config?: TextConfig<TEnum>): ColumnBuilder<TEnum extends string ? TEnum : string>;
+type IntegerMode = "number" | "boolean" | "timestamp" | "timestamp_ms";
 declare function integer(name: string, config?: {
-    isPrimaryKey?: boolean;
-    mode?: "number" | "boolean" | "timestamp";
-    autoIncrement?: boolean;
+    mode?: IntegerMode;
+}): ColumnBuilder<number | boolean | Date>;
+declare function integer(config?: {
+    mode?: IntegerMode;
 }): ColumnBuilder<number | boolean | Date>;
 declare function real(name: string): ColumnBuilder<number>;
+declare function real(): ColumnBuilder<number>;
+type BlobMode = "json" | "bigint" | "buffer";
 declare function blob(name: string, config?: {
-    mode?: "json" | "bigint";
+    mode?: BlobMode;
+}): ColumnBuilder<unknown | bigint | Uint8Array>;
+declare function blob(config?: {
+    mode?: BlobMode;
 }): ColumnBuilder<unknown | bigint | Uint8Array>;
+type NumericMode = "string" | "number" | "bigint";
 declare function numeric(name: string, config?: {
-    mode?: "string" | "number" | "bigint";
+    mode?: NumericMode;
 }): ColumnBuilder<string | number | bigint>;
-declare const boolean: (name: string) => ColumnBuilder<boolean>;
-declare const timestamp: (name: string) => ColumnBuilder<Date>;
+declare function numeric(config?: {
+    mode?: NumericMode;
+}): ColumnBuilder<string | number | bigint>;
+declare function boolean(name: string): ColumnBuilder<boolean>;
+declare function boolean(): ColumnBuilder<boolean>;
+declare function timestamp(name: string): ColumnBuilder<Date>;
+declare function timestamp(): ColumnBuilder<Date>;
+declare function increments(name: string): ColumnBuilder<number>;
+declare function increments(): ColumnBuilder<number>;
 type SchemaDefinition = Record<string, Column<any>>;
 type InferModel<T extends SchemaDefinition> = {
     [K in keyof T]: T[K]["_dataType"];
@@ -103,7 +111,8 @@ declare class SelectQueryBuilder<T> {
     private _limit;
     private _offset;
     private _eager;
-    constructor(fields?: Record<string, Column<any>>);
+    private _dbProvider;
+    constructor(dbProvider: () => Promise<Database>, fields?: Record<string, Column<any>>);
     from(table: Table<any>): this;
     where(...conditions: SQL[]): this;
     leftJoin(otherTable: Table<any>, on: SQL): this;
@@ -116,6 +125,9 @@ declare class TauriORM {
     query: Record<string, any>;
     private _tables;
     private _relations;
+    private _dbPromise;
+    constructor(dbUri: string);
+    private getDb;
     configureQuery(tables: Record<string, Table<any>>, relations: Record<string, Record<string, RelationConfig>>): void;
     select<T>(fields?: Record<string, Column<any>>): SelectQueryBuilder<T>;
     insert(table: Table<any>): {
@@ -154,8 +166,61 @@ declare class TauriORM {
         name?: string;
         track?: boolean;
     }): Promise<void>;
+    diffSchema(): Promise<{
+        extraTables: string[];
+        missingTables: string[];
+        tables: Record<string, {
+            missingColumns: string[];
+            extraColumns: string[];
+            changedColumns: Array<{
+                name: string;
+                diffs: {
+                    type?: boolean;
+                    pk?: boolean;
+                    notNull?: boolean;
+                    default?: boolean;
+                };
+            }>;
+        }>;
+    }>;
+    generate(): Promise<{
+        statements: string[];
+    }>;
+    migrateCli(opts?: {
+        name?: string;
+        track?: boolean;
+    }): Promise<void>;
+    push(opts?: {
+        dropExtraColumns?: boolean;
+        preserveData?: boolean;
+    }): Promise<void>;
+    pull(): Promise<Record<string, any>>;
+    studio(): Promise<{
+        driver: string;
+        path: any;
+    }>;
+    private ensureSchemaMeta;
+    private getSchemaMeta;
+    private setSchemaMeta;
+    private normalizeColumn;
+    private computeModelSignature;
+    isSchemaDirty(): Promise<{
+        dirty: boolean;
+        current: string;
+        stored: string | null;
+    }>;
+    migrateIfDirty(options?: {
+        name?: string;
+        track?: boolean;
+    }): Promise<boolean>;
+    pullSchema(): Promise<Record<string, any>>;
+    private buildCreateTableSQL;
+    private tableExists;
+    forcePush(options?: {
+        dropExtraColumns?: boolean;
+        preserveData?: boolean;
+    }): Promise<void>;
 }
-declare const db: TauriORM;
 type OneConfig = {
     fields?: Column[];
     references?: Column[];
@@ -184,12 +249,17 @@ type WithSpec = Record<string, boolean | {
     with?: WithSpec;
     columns?: string[];
 }>;
-declare function makeQueryAPI(tables: Record<string, Table<any>>, relDefs: Record<string, Record<string, RelationConfig>>): { [K in keyof typeof tables]: {
+declare function makeQueryAPI(tables: Record<string, Table<any>>, relDefs: Record<string, Record<string, RelationConfig>>, dbProvider: () => Promise<Database>): { [K in keyof typeof tables]: {
     findMany: (opts?: {
         with?: WithSpec;
         join?: boolean;
         columns?: string[];
     }) => Promise<any[]>;
+    findFirst: (opts?: {
+        with?: WithSpec;
+        join?: boolean;
+        columns?: string[];
+    }) => Promise<any | null>;
 }; };
 
-export { type Column, type ManyRelation, type OneRelation, type SQL, type SQLExpression, type Table, TauriORM, type UpdateDeleteAction, asc, blob, boolean, db, defineTable, desc, eq, getDb, gt, gte, initDb, integer, like, lt, lte, makeQueryAPI, ne, numeric, real, relations, sql, text, timestamp };
+export { type BlobMode, type Column, type ColumnBuilder, type IntegerMode, type ManyRelation, type NumericMode, type OneRelation, type SQL, type SQLExpression, type Table, TauriORM, type UpdateDeleteAction, asc, blob, boolean, defineTable, desc, eq, gt, gte, increments, integer, like, lt, lte, makeQueryAPI, ne, numeric, real, relations, sql, text, timestamp };

package/dist/index.d.ts

@@ -1,18 +1,5 @@
 import Database from '@tauri-apps/plugin-sql';
 
-/**
- * Initializes the database connection. This must be called once at the start of your application.
- * @param dbPath The path to the database file, e.g., 'sqlite:mydatabase.db'
- * @returns The database instance.
- */
-declare function initDb(dbPath: string): Promise<Database>;
-/**
- * Gets the singleton database instance.
- * @throws If `initDb` has not been called.
- * @returns The database instance.
- */
-declare function getDb(): Database;
-
 type UpdateDeleteAction = "cascade" | "restrict" | "no action" | "set null" | "set default";
 interface SQLExpression {
     raw: string;
@@ -26,6 +13,7 @@ interface Column<T = any> {
     isNotNull?: boolean;
     defaultValue?: T | SQLExpression;
     defaultFn?: () => any;
+    onUpdateFn?: () => any;
     references?: {
         table: string;
         column: string;
@@ -48,29 +36,49 @@ type ColumnBuilder<T> = Column<T> & {
     default: (value: T | SQLExpression) => ColumnBuilder<T>;
     $type: <U>() => ColumnBuilder<U>;
     $defaultFn: (fn: () => any) => ColumnBuilder<T>;
+    $default: (fn: () => any) => ColumnBuilder<T>;
+    $onUpdate: (fn: () => any) => ColumnBuilder<T>;
+    $onUpdateFn: (fn: () => any) => ColumnBuilder<T>;
     references: (target: () => Column<any>, actions?: {
         onDelete?: UpdateDeleteAction;
         onUpdate?: UpdateDeleteAction;
     }) => ColumnBuilder<T>;
 };
-declare function text<TEnum extends string>(name: string, config?: {
-    isPrimaryKey?: boolean;
+type TextConfig<TEnum extends string> = {
     enum?: readonly TEnum[];
-}): ColumnBuilder<TEnum extends string ? TEnum : string>;
+    mode?: "json";
+};
+declare function text<TEnum extends string>(name: string, config?: TextConfig<TEnum>): ColumnBuilder<TEnum extends string ? TEnum : string>;
+declare function text<TEnum extends string>(config?: TextConfig<TEnum>): ColumnBuilder<TEnum extends string ? TEnum : string>;
+type IntegerMode = "number" | "boolean" | "timestamp" | "timestamp_ms";
 declare function integer(name: string, config?: {
-    isPrimaryKey?: boolean;
-    mode?: "number" | "boolean" | "timestamp";
-    autoIncrement?: boolean;
+    mode?: IntegerMode;
+}): ColumnBuilder<number | boolean | Date>;
+declare function integer(config?: {
+    mode?: IntegerMode;
 }): ColumnBuilder<number | boolean | Date>;
 declare function real(name: string): ColumnBuilder<number>;
+declare function real(): ColumnBuilder<number>;
+type BlobMode = "json" | "bigint" | "buffer";
 declare function blob(name: string, config?: {
-    mode?: "json" | "bigint";
+    mode?: BlobMode;
+}): ColumnBuilder<unknown | bigint | Uint8Array>;
+declare function blob(config?: {
+    mode?: BlobMode;
 }): ColumnBuilder<unknown | bigint | Uint8Array>;
+type NumericMode = "string" | "number" | "bigint";
 declare function numeric(name: string, config?: {
-    mode?: "string" | "number" | "bigint";
+    mode?: NumericMode;
 }): ColumnBuilder<string | number | bigint>;
-declare const boolean: (name: string) => ColumnBuilder<boolean>;
-declare const timestamp: (name: string) => ColumnBuilder<Date>;
+declare function numeric(config?: {
+    mode?: NumericMode;
+}): ColumnBuilder<string | number | bigint>;
+declare function boolean(name: string): ColumnBuilder<boolean>;
+declare function boolean(): ColumnBuilder<boolean>;
+declare function timestamp(name: string): ColumnBuilder<Date>;
+declare function timestamp(): ColumnBuilder<Date>;
+declare function increments(name: string): ColumnBuilder<number>;
+declare function increments(): ColumnBuilder<number>;
 type SchemaDefinition = Record<string, Column<any>>;
 type InferModel<T extends SchemaDefinition> = {
     [K in keyof T]: T[K]["_dataType"];
@@ -103,7 +111,8 @@ declare class SelectQueryBuilder<T> {
     private _limit;
     private _offset;
     private _eager;
-    constructor(fields?: Record<string, Column<any>>);
+    private _dbProvider;
+    constructor(dbProvider: () => Promise<Database>, fields?: Record<string, Column<any>>);
     from(table: Table<any>): this;
     where(...conditions: SQL[]): this;
     leftJoin(otherTable: Table<any>, on: SQL): this;
@@ -116,6 +125,9 @@ declare class TauriORM {
     query: Record<string, any>;
     private _tables;
     private _relations;
+    private _dbPromise;
+    constructor(dbUri: string);
+    private getDb;
     configureQuery(tables: Record<string, Table<any>>, relations: Record<string, Record<string, RelationConfig>>): void;
     select<T>(fields?: Record<string, Column<any>>): SelectQueryBuilder<T>;
     insert(table: Table<any>): {
@@ -154,8 +166,61 @@ declare class TauriORM {
         name?: string;
         track?: boolean;
     }): Promise<void>;
+    diffSchema(): Promise<{
+        extraTables: string[];
+        missingTables: string[];
+        tables: Record<string, {
+            missingColumns: string[];
+            extraColumns: string[];
+            changedColumns: Array<{
+                name: string;
+                diffs: {
+                    type?: boolean;
+                    pk?: boolean;
+                    notNull?: boolean;
+                    default?: boolean;
+                };
+            }>;
+        }>;
+    }>;
+    generate(): Promise<{
+        statements: string[];
+    }>;
+    migrateCli(opts?: {
+        name?: string;
+        track?: boolean;
+    }): Promise<void>;
+    push(opts?: {
+        dropExtraColumns?: boolean;
+        preserveData?: boolean;
+    }): Promise<void>;
+    pull(): Promise<Record<string, any>>;
+    studio(): Promise<{
+        driver: string;
+        path: any;
+    }>;
+    private ensureSchemaMeta;
+    private getSchemaMeta;
+    private setSchemaMeta;
+    private normalizeColumn;
+    private computeModelSignature;
+    isSchemaDirty(): Promise<{
+        dirty: boolean;
+        current: string;
+        stored: string | null;
+    }>;
+    migrateIfDirty(options?: {
+        name?: string;
+        track?: boolean;
+    }): Promise<boolean>;
+    pullSchema(): Promise<Record<string, any>>;
+    private buildCreateTableSQL;
+    private tableExists;
+    forcePush(options?: {
+        dropExtraColumns?: boolean;
+        preserveData?: boolean;
+    }): Promise<void>;
 }
-declare const db: TauriORM;
 type OneConfig = {
     fields?: Column[];
     references?: Column[];
@@ -184,12 +249,17 @@ type WithSpec = Record<string, boolean | {
     with?: WithSpec;
     columns?: string[];
 }>;
-declare function makeQueryAPI(tables: Record<string, Table<any>>, relDefs: Record<string, Record<string, RelationConfig>>): { [K in keyof typeof tables]: {
+declare function makeQueryAPI(tables: Record<string, Table<any>>, relDefs: Record<string, Record<string, RelationConfig>>, dbProvider: () => Promise<Database>): { [K in keyof typeof tables]: {
     findMany: (opts?: {
         with?: WithSpec;
         join?: boolean;
         columns?: string[];
     }) => Promise<any[]>;
+    findFirst: (opts?: {
+        with?: WithSpec;
+        join?: boolean;
+        columns?: string[];
+    }) => Promise<any | null>;
 }; };
 
-export { type Column, type ManyRelation, type OneRelation, type SQL, type SQLExpression, type Table, TauriORM, type UpdateDeleteAction, asc, blob, boolean, db, defineTable, desc, eq, getDb, gt, gte, initDb, integer, like, lt, lte, makeQueryAPI, ne, numeric, real, relations, sql, text, timestamp };
+export { type BlobMode, type Column, type ColumnBuilder, type IntegerMode, type ManyRelation, type NumericMode, type OneRelation, type SQL, type SQLExpression, type Table, TauriORM, type UpdateDeleteAction, asc, blob, boolean, defineTable, desc, eq, gt, gte, increments, integer, like, lt, lte, makeQueryAPI, ne, numeric, real, relations, sql, text, timestamp };