@type32/tauri-sqlite-orm 0.1.18-6 → 0.1.18-8

package/README.md

@@ -16,159 +16,3 @@ bun add @type32/tauri-sqlite-orm @tauri-apps/plugin-sql
 ```
 
 Make sure the SQL plugin is registered on the Rust side (see Tauri docs).
-
-### Quick Start
-
-Here’s a quick example to get you started:
-
-```typescript
-// src/db/schema.ts
-import { sqliteTable, text, integer } from "@type32/tauri-sqlite-orm";
-
-export const users = sqliteTable("users", {
-  id: integer("id").primaryKey().autoincrement(),
-  name: text("name").notNull(),
-  email: text("email").unique(),
-});
-
-export const posts = sqliteTable("posts", {
-  id: integer("id").primaryKey(),
-  content: text("content"),
-  authorId: integer("author_id").references(() => users.id),
-});
-
-// src/db/index.ts
-import { TauriORM } from "@type32/tauri-sqlite-orm";
-import Database from "@tauri-apps/plugin-sql";
-import * as schema from "./schema";
-
-// Load the database
-const dbInstance = await Database.load("sqlite:app.db");
-
-// Create the ORM instance
-export const db = new TauriORM(dbInstance, schema);
-
-// Migrate the database if the schema has changed
-await db.migrateIfDirty();
-
-// Now you can use the ORM to interact with your database
-const newUser = await db
-  .insert(schema.users)
-  .values({ name: "John Doe", email: "john.doe@example.com" });
-const allUsers = await db.select(schema.users).execute();
-```
-
-### Documentation
-
-- [Getting Started](docs/getting-started.md)
-- [Schema and Types](docs/schema-and-types.md)
-- [CRUD Operations (SELECT)](docs/queries-select.md)
-- [CRUD Operations (INSERT)](docs/crud-insert.md)
-- [CRUD Operations (UPDATE)](docs/crud-update.md)
-- [CRUD Operations (DELETE)](docs/crud-delete.md)
-- [Migrations](docs/migrations.md)
-- [Transactions](docs/transactions.md)
-- [Relations](docs/relations.md)
-
-### Schema Definition
-
-Define your tables and columns using a chainable, Drizzle-style API.
-
-```typescript
-import { sqliteTable, text, integer, boolean } from "@type32/tauri-sqlite-orm";
-
-export const users = sqliteTable("users", {
-  id: integer("id").primaryKey().autoincrement(),
-  name: text("name").notNull(),
-  email: text("email").unique(),
-  isActive: boolean("is_active").default(true),
-  createdAt: integer("created_at", { mode: "timestamp" }).$defaultFn(
-    () => new Date()
-  ),
-});
-```
-
-### CRUD Operations
-
-Perform `CREATE`, `READ`, `UPDATE`, and `DELETE` operations using a type-safe query builder.
-
-**SELECT**
-
-```typescript
-import { eq, and } from "@type32/tauri-sqlite-orm";
-
-// Select all users
-const allUsers = await db.select(users).execute();
-
-// Select specific columns
-const userNames = await db.select(users, ["name"]).execute();
-
-// Use WHERE conditions
-const activeUsers = await db
-  .select(users)
-  .where(eq(users.isActive, true))
-  .execute();
-```
-
-**INSERT**
-
-```typescript
-// Insert a single user
-const newUser = await db
-  .insert(users)
-  .values({ name: "Jane Doe", email: "jane.doe@example.com" });
-
-// Insert multiple users
-await db.insert(users).values([
-  { name: "Alice", email: "alice@example.com" },
-  { name: "Bob", email: "bob@example.com" },
-]);
-```
-
-**UPDATE**
-
-```typescript
-import { eq } from "@type32/tauri-sqlite-orm";
-
-// Update a user's email
-await db
-  .update(users)
-  .set({ email: "new.email@example.com" })
-  .where(eq(users._.columns.id, 1));
-```
-
-**DELETE**
-
-```typescript
-import { eq } from "@type32/tauri-sqlite-orm";
-
-// Delete a user
-await db.delete(users).where(eq(users._.columns.id, 1));
-```
-
-### Migrations
-
-The ORM includes a simple migration system that automatically detects schema changes and applies them to the database.
-
-```typescript
-// This will check if the schema has changed and run migrations if it has
-await db.migrateIfDirty();
-
-// You can also run migrations manually
-await db.migrate();
-```
-
-### Transactions
-
-Run multiple database operations within a transaction to ensure atomicity.
-
-```typescript
-await db.transaction(async (tx) => {
-  await tx.insert(users).values({ name: "From Transaction" });
-  await tx.delete(users).where(eq(users._.columns.id, 1));
-});
-```
-
-### License
-
-MIT

package/dist/index.d.mts

@@ -33,7 +33,7 @@ declare class SQLiteColumn<TName extends string = string, TType extends ColumnDa
     notNull(): SQLiteColumn<TName, TType, TMode, true, THasDefault, TAutoincrement>;
     default(value: ColumnValueTypes<TType, TMode>): SQLiteColumn<TName, TType, TMode, TNotNull, true, TAutoincrement>;
     $defaultFn(fn: () => ColumnValueTypes<TType, TMode>): SQLiteColumn<TName, TType, TMode, TNotNull, true, TAutoincrement>;
-    primaryKey(): SQLiteColumn<TName, TType, TMode, TNotNull, THasDefault, TAutoincrement>;
+    primaryKey(): SQLiteColumn<TName, TType, TMode, true, THasDefault, TAutoincrement>;
     autoincrement(): SQLiteColumn<TName, TType, TMode, TNotNull, THasDefault, true>;
     unique(): SQLiteColumn<TName, TType, TMode, TNotNull, THasDefault, TAutoincrement>;
     references<T extends AnyTable, K extends keyof T["_"]["columns"] & string>(ref: T, column: K): SQLiteColumn<TName, TType, TMode, TNotNull, THasDefault, TAutoincrement>;
@@ -52,11 +52,12 @@ type AnyTable = Table<Record<string, AnySQLiteColumn>, string>;
 type InferSelectModel<T extends AnyTable> = {
     [K in keyof T["_"]["columns"]]: ExtractColumnType<T["_"]["columns"][K]>;
 };
-type RequiredColumns<TColumns extends Record<string, AnySQLiteColumn>> = {
-    [K in keyof TColumns]: TColumns[K]["_"]["notNull"] extends true ? TColumns[K]["_"]["hasDefault"] extends true ? never : K : never;
-}[keyof TColumns];
+type IsOptionalOnInsert<C extends AnySQLiteColumn> = C["_"]["notNull"] extends false ? true : C["_"]["hasDefault"] extends true ? true : C["_"]["autoincrement"] extends true ? true : false;
 type OptionalColumns<TColumns extends Record<string, AnySQLiteColumn>> = {
-    [K in keyof TColumns]: TColumns[K]["_"]["notNull"] extends true ? TColumns[K]["_"]["hasDefault"] extends true ? K : never : K;
+    [K in keyof TColumns]: IsOptionalOnInsert<TColumns[K]> extends true ? K : never;
+}[keyof TColumns];
+type RequiredColumns<TColumns extends Record<string, AnySQLiteColumn>> = {
+    [K in keyof TColumns]: IsOptionalOnInsert<TColumns[K]> extends true ? never : K;
 }[keyof TColumns];
 type InferInsertModel<T extends AnyTable> = {
     [K in RequiredColumns<T["_"]["columns"]>]: ExtractColumnType<T["_"]["columns"][K]>;
@@ -145,7 +146,7 @@ declare class InsertQueryBuilder<T extends AnyTable> extends BaseQueryBuilder {
     private conflictTarget;
     private updateSet;
     constructor(db: Database, table: T);
-    values(data: Partial<InferInsertModel<T>> | Partial<InferInsertModel<T>>[]): this;
+    values(data: InferInsertModel<T> | InferInsertModel<T>[]): this;
     returning(...columns: (keyof T["_"]["columns"])[]): this;
     onConflictDoNothing(target?: AnySQLiteColumn | AnySQLiteColumn[]): this;
     onConflictDoUpdate(config: {
@@ -193,7 +194,7 @@ declare class WithQueryBuilder {
 declare class TauriORM {
     private db;
     private tables;
-    constructor(db: Database, schema?: Record<string, AnyTable> | undefined);
+    constructor(db: Database, schema?: Record<string, AnyTable | Record<string, Relation>> | undefined);
     private buildColumnDefinition;
     migrate(): Promise<void>;
     select<T extends AnyTable, C extends (keyof T["_"]["columns"])[] | undefined = undefined>(table: T, columns?: C): SelectQueryBuilder<T, C>;
@@ -221,11 +222,32 @@ declare class TauriORM {
     }>;
     migrateIfDirty(): Promise<boolean>;
 }
-declare const relations: <T extends AnyTable, R extends Record<string, any>>(table: T, relationsCallback: (helpers: {
-    one: any;
-    many: any;
-}) => R) => R;
+declare class Relation<T extends AnyTable = AnyTable> {
+    foreignTable: T;
+    constructor(foreignTable: T);
+}
+declare class OneRelation<T extends AnyTable = AnyTable> extends Relation<T> {
+    config?: {
+        fields: AnySQLiteColumn[];
+        references: AnySQLiteColumn[];
+    } | undefined;
+    constructor(foreignTable: T, config?: {
+        fields: AnySQLiteColumn[];
+        references: AnySQLiteColumn[];
+    } | undefined);
+}
+declare class ManyRelation<T extends AnyTable = AnyTable> extends Relation<T> {
+    constructor(foreignTable: T);
+}
+type RelationsBuilder = {
+    one: <U extends AnyTable>(table: U, config?: {
+        fields: AnySQLiteColumn[];
+        references: AnySQLiteColumn[];
+    }) => OneRelation<U>;
+    many: <U extends AnyTable>(table: U) => ManyRelation<U>;
+};
+declare const relations: <T extends AnyTable, R extends Record<string, Relation>>(_table: T, relationsCallback: (helpers: RelationsBuilder) => R) => R;
 declare const getTableColumns: <T extends AnyTable>(table: T) => Record<string, AnySQLiteColumn>;
 declare const alias: <T extends AnyTable>(table: T, alias: string) => Table<T["_"]["columns"], T["_"]["name"]>;
 
-export { type AnySQLiteColumn, type AnyTable, type ColumnDataType, type ColumnOptions, DeleteQueryBuilder, type InferInsertModel, type InferSelectModel, InsertQueryBuilder, type Mode, type SQLCondition, SQLiteColumn, SelectQueryBuilder, Table, TauriORM, UpdateQueryBuilder, WithQueryBuilder, alias, and, asc, avg, blob, boolean, count, countDistinct, desc, eq, getTableColumns, gt, gte, inArray, integer, isNotNull, isNull, like, lt, lte, max, min, not, or, real, relations, sql, sqliteTable, sum, text };
+export { type AnySQLiteColumn, type AnyTable, type ColumnDataType, type ColumnOptions, DeleteQueryBuilder, type InferInsertModel, type InferSelectModel, InsertQueryBuilder, ManyRelation, type Mode, OneRelation, Relation, type SQLCondition, SQLiteColumn, SelectQueryBuilder, Table, TauriORM, UpdateQueryBuilder, WithQueryBuilder, alias, and, asc, avg, blob, boolean, count, countDistinct, desc, eq, getTableColumns, gt, gte, inArray, integer, isNotNull, isNull, like, lt, lte, max, min, not, or, real, relations, sql, sqliteTable, sum, text };

package/dist/index.d.ts

@@ -33,7 +33,7 @@ declare class SQLiteColumn<TName extends string = string, TType extends ColumnDa
     notNull(): SQLiteColumn<TName, TType, TMode, true, THasDefault, TAutoincrement>;
     default(value: ColumnValueTypes<TType, TMode>): SQLiteColumn<TName, TType, TMode, TNotNull, true, TAutoincrement>;
     $defaultFn(fn: () => ColumnValueTypes<TType, TMode>): SQLiteColumn<TName, TType, TMode, TNotNull, true, TAutoincrement>;
-    primaryKey(): SQLiteColumn<TName, TType, TMode, TNotNull, THasDefault, TAutoincrement>;
+    primaryKey(): SQLiteColumn<TName, TType, TMode, true, THasDefault, TAutoincrement>;
     autoincrement(): SQLiteColumn<TName, TType, TMode, TNotNull, THasDefault, true>;
     unique(): SQLiteColumn<TName, TType, TMode, TNotNull, THasDefault, TAutoincrement>;
     references<T extends AnyTable, K extends keyof T["_"]["columns"] & string>(ref: T, column: K): SQLiteColumn<TName, TType, TMode, TNotNull, THasDefault, TAutoincrement>;
@@ -52,11 +52,12 @@ type AnyTable = Table<Record<string, AnySQLiteColumn>, string>;
 type InferSelectModel<T extends AnyTable> = {
     [K in keyof T["_"]["columns"]]: ExtractColumnType<T["_"]["columns"][K]>;
 };
-type RequiredColumns<TColumns extends Record<string, AnySQLiteColumn>> = {
-    [K in keyof TColumns]: TColumns[K]["_"]["notNull"] extends true ? TColumns[K]["_"]["hasDefault"] extends true ? never : K : never;
-}[keyof TColumns];
+type IsOptionalOnInsert<C extends AnySQLiteColumn> = C["_"]["notNull"] extends false ? true : C["_"]["hasDefault"] extends true ? true : C["_"]["autoincrement"] extends true ? true : false;
 type OptionalColumns<TColumns extends Record<string, AnySQLiteColumn>> = {
-    [K in keyof TColumns]: TColumns[K]["_"]["notNull"] extends true ? TColumns[K]["_"]["hasDefault"] extends true ? K : never : K;
+    [K in keyof TColumns]: IsOptionalOnInsert<TColumns[K]> extends true ? K : never;
+}[keyof TColumns];
+type RequiredColumns<TColumns extends Record<string, AnySQLiteColumn>> = {
+    [K in keyof TColumns]: IsOptionalOnInsert<TColumns[K]> extends true ? never : K;
 }[keyof TColumns];
 type InferInsertModel<T extends AnyTable> = {
     [K in RequiredColumns<T["_"]["columns"]>]: ExtractColumnType<T["_"]["columns"][K]>;
@@ -145,7 +146,7 @@ declare class InsertQueryBuilder<T extends AnyTable> extends BaseQueryBuilder {
     private conflictTarget;
     private updateSet;
     constructor(db: Database, table: T);
-    values(data: Partial<InferInsertModel<T>> | Partial<InferInsertModel<T>>[]): this;
+    values(data: InferInsertModel<T> | InferInsertModel<T>[]): this;
     returning(...columns: (keyof T["_"]["columns"])[]): this;
     onConflictDoNothing(target?: AnySQLiteColumn | AnySQLiteColumn[]): this;
     onConflictDoUpdate(config: {
@@ -193,7 +194,7 @@ declare class WithQueryBuilder {
 declare class TauriORM {
     private db;
     private tables;
-    constructor(db: Database, schema?: Record<string, AnyTable> | undefined);
+    constructor(db: Database, schema?: Record<string, AnyTable | Record<string, Relation>> | undefined);
     private buildColumnDefinition;
     migrate(): Promise<void>;
     select<T extends AnyTable, C extends (keyof T["_"]["columns"])[] | undefined = undefined>(table: T, columns?: C): SelectQueryBuilder<T, C>;
@@ -221,11 +222,32 @@ declare class TauriORM {
     }>;
     migrateIfDirty(): Promise<boolean>;
 }
-declare const relations: <T extends AnyTable, R extends Record<string, any>>(table: T, relationsCallback: (helpers: {
-    one: any;
-    many: any;
-}) => R) => R;
+declare class Relation<T extends AnyTable = AnyTable> {
+    foreignTable: T;
+    constructor(foreignTable: T);
+}
+declare class OneRelation<T extends AnyTable = AnyTable> extends Relation<T> {
+    config?: {
+        fields: AnySQLiteColumn[];
+        references: AnySQLiteColumn[];
+    } | undefined;
+    constructor(foreignTable: T, config?: {
+        fields: AnySQLiteColumn[];
+        references: AnySQLiteColumn[];
+    } | undefined);
+}
+declare class ManyRelation<T extends AnyTable = AnyTable> extends Relation<T> {
+    constructor(foreignTable: T);
+}
+type RelationsBuilder = {
+    one: <U extends AnyTable>(table: U, config?: {
+        fields: AnySQLiteColumn[];
+        references: AnySQLiteColumn[];
+    }) => OneRelation<U>;
+    many: <U extends AnyTable>(table: U) => ManyRelation<U>;
+};
+declare const relations: <T extends AnyTable, R extends Record<string, Relation>>(_table: T, relationsCallback: (helpers: RelationsBuilder) => R) => R;
 declare const getTableColumns: <T extends AnyTable>(table: T) => Record<string, AnySQLiteColumn>;
 declare const alias: <T extends AnyTable>(table: T, alias: string) => Table<T["_"]["columns"], T["_"]["name"]>;
 
-export { type AnySQLiteColumn, type AnyTable, type ColumnDataType, type ColumnOptions, DeleteQueryBuilder, type InferInsertModel, type InferSelectModel, InsertQueryBuilder, type Mode, type SQLCondition, SQLiteColumn, SelectQueryBuilder, Table, TauriORM, UpdateQueryBuilder, WithQueryBuilder, alias, and, asc, avg, blob, boolean, count, countDistinct, desc, eq, getTableColumns, gt, gte, inArray, integer, isNotNull, isNull, like, lt, lte, max, min, not, or, real, relations, sql, sqliteTable, sum, text };
+export { type AnySQLiteColumn, type AnyTable, type ColumnDataType, type ColumnOptions, DeleteQueryBuilder, type InferInsertModel, type InferSelectModel, InsertQueryBuilder, ManyRelation, type Mode, OneRelation, Relation, type SQLCondition, SQLiteColumn, SelectQueryBuilder, Table, TauriORM, UpdateQueryBuilder, WithQueryBuilder, alias, and, asc, avg, blob, boolean, count, countDistinct, desc, eq, getTableColumns, gt, gte, inArray, integer, isNotNull, isNull, like, lt, lte, max, min, not, or, real, relations, sql, sqliteTable, sum, text };

package/dist/index.js

@@ -22,6 +22,9 @@ var index_exports = {};
 __export(index_exports, {
   DeleteQueryBuilder: () => DeleteQueryBuilder,
   InsertQueryBuilder: () => InsertQueryBuilder,
+  ManyRelation: () => ManyRelation,
+  OneRelation: () => OneRelation,
+  Relation: () => Relation,
   SQLiteColumn: () => SQLiteColumn,
   SelectQueryBuilder: () => SelectQueryBuilder,
   Table: () => Table,
@@ -104,7 +107,7 @@ var SQLiteColumn = class _SQLiteColumn {
     return new _SQLiteColumn(
       this._.name,
       this.type,
-      { ...this.options, primaryKey: true },
+      { ...this.options, primaryKey: true, notNull: true },
       this._.mode
     );
   }
@@ -610,7 +613,9 @@ var TauriORM = class {
     this.db = db;
     if (schema) {
       for (const table of Object.values(schema)) {
-        this.tables.set(table._.name, table);
+        if (table instanceof Table) {
+          this.tables.set(table._.name, table);
+        }
       }
     }
   }
@@ -755,18 +760,30 @@ var TauriORM = class {
     return false;
   }
 };
-var relations = (table, relationsCallback) => {
+var Relation = class {
+  constructor(foreignTable) {
+    this.foreignTable = foreignTable;
+  }
+};
+var OneRelation = class extends Relation {
+  constructor(foreignTable, config) {
+    super(foreignTable);
+    this.config = config;
+  }
+};
+var ManyRelation = class extends Relation {
+  constructor(foreignTable) {
+    super(foreignTable);
+  }
+};
+var relations = (_table, relationsCallback) => {
   return relationsCallback({
-    one: (table2, config) => ({
-      table: table2,
-      type: "one",
-      foreignKey: config.fields[0],
-      localKey: config.references[0]
-    }),
-    many: (table2) => ({
-      table: table2,
-      type: "many"
-    })
+    one: (table, config) => {
+      return new OneRelation(table, config);
+    },
+    many: (table) => {
+      return new ManyRelation(table);
+    }
   });
 };
 var getTableColumns = (table) => {
@@ -779,6 +796,9 @@ var alias = (table, alias2) => {
 0 && (module.exports = {
   DeleteQueryBuilder,
   InsertQueryBuilder,
+  ManyRelation,
+  OneRelation,
+  Relation,
   SQLiteColumn,
   SelectQueryBuilder,
   Table,

package/dist/index.mjs

@@ -41,7 +41,7 @@ var SQLiteColumn = class _SQLiteColumn {
     return new _SQLiteColumn(
       this._.name,
       this.type,
-      { ...this.options, primaryKey: true },
+      { ...this.options, primaryKey: true, notNull: true },
       this._.mode
     );
   }
@@ -547,7 +547,9 @@ var TauriORM = class {
     this.db = db;
     if (schema) {
       for (const table of Object.values(schema)) {
-        this.tables.set(table._.name, table);
+        if (table instanceof Table) {
+          this.tables.set(table._.name, table);
+        }
       }
     }
   }
@@ -692,18 +694,30 @@ var TauriORM = class {
     return false;
   }
 };
-var relations = (table, relationsCallback) => {
+var Relation = class {
+  constructor(foreignTable) {
+    this.foreignTable = foreignTable;
+  }
+};
+var OneRelation = class extends Relation {
+  constructor(foreignTable, config) {
+    super(foreignTable);
+    this.config = config;
+  }
+};
+var ManyRelation = class extends Relation {
+  constructor(foreignTable) {
+    super(foreignTable);
+  }
+};
+var relations = (_table, relationsCallback) => {
   return relationsCallback({
-    one: (table2, config) => ({
-      table: table2,
-      type: "one",
-      foreignKey: config.fields[0],
-      localKey: config.references[0]
-    }),
-    many: (table2) => ({
-      table: table2,
-      type: "many"
-    })
+    one: (table, config) => {
+      return new OneRelation(table, config);
+    },
+    many: (table) => {
+      return new ManyRelation(table);
+    }
   });
 };
 var getTableColumns = (table) => {
@@ -715,6 +729,9 @@ var alias = (table, alias2) => {
 export {
   DeleteQueryBuilder,
   InsertQueryBuilder,
+  ManyRelation,
+  OneRelation,
+  Relation,
   SQLiteColumn,
   SelectQueryBuilder,
   Table,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@type32/tauri-sqlite-orm",
-  "version": "0.1.18-6",
+  "version": "0.1.18-8",
   "description": "A Drizzle-like ORM for Tauri v2's SQL JS API plugin.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",