@type32/tauri-sqlite-orm 0.1.18-0 → 0.1.18-10

package/dist/index.d.ts

@@ -18,6 +18,123 @@ interface ColumnOptions<TData> {
     $onUpdateFn?: () => TData;
 }
 type ExtractColumnType<T extends AnySQLiteColumn> = T extends SQLiteColumn<infer _, infer TType, infer TMode, infer TNotNull, infer THasDefault> ? THasDefault extends true ? TNotNull extends true ? ColumnValueTypes<TType, TMode> : ColumnValueTypes<TType, TMode> | null | undefined : TNotNull extends true ? ColumnValueTypes<TType, TMode> : ColumnValueTypes<TType, TMode> | null | undefined : never;
+type AnySQLiteColumn = SQLiteColumn<any, any, any, any, any, any>;
+type AnyTable = Table<Record<string, AnySQLiteColumn>, string>;
+type InferSelectModel<T extends AnyTable> = {
+    [K in keyof T["_"]["columns"]]: ExtractColumnType<T["_"]["columns"][K]>;
+};
+type RelationType = "one" | "many";
+interface RelationConfig {
+    type: RelationType;
+    foreignTable: AnyTable;
+    fields?: AnySQLiteColumn[];
+    references?: AnySQLiteColumn[];
+}
+
+declare class BaseQueryBuilder {
+    protected db: Database;
+    protected query: string;
+    protected params: any[];
+    constructor(db: Database);
+    where(condition: SQLCondition): this;
+    orderBy(column: AnySQLiteColumn | {
+        sql: string;
+        params: any[];
+    }, direction?: "ASC" | "DESC"): this;
+    limit(count: number): this;
+    offset(count: number): this;
+    build(): {
+        sql: string;
+        params: any[];
+    };
+}
+
+declare class SelectQueryBuilder<TTable extends AnyTable, TSelectedColumns extends (keyof TTable["_"]["columns"])[] | undefined = undefined> extends BaseQueryBuilder {
+    private table;
+    private columns?;
+    private isDistinct;
+    private groupByColumns;
+    private havingCondition;
+    private joins;
+    private includeRelations;
+    constructor(db: Database, table: TTable, columns?: TSelectedColumns | undefined);
+    distinct(): this;
+    groupBy(...columns: AnySQLiteColumn[]): this;
+    having(condition: SQLCondition): this;
+    leftJoin<T extends AnyTable>(table: T, condition: SQLCondition, alias?: string): this;
+    innerJoin<T extends AnyTable>(table: T, condition: SQLCondition, alias?: string): this;
+    include(relations: Record<string, boolean>): this;
+    private buildJoins;
+    execute(): Promise<any[]>;
+    all(): Promise<any[]>;
+    get(): Promise<any | undefined>;
+}
+
+declare class UpdateQueryBuilder<T extends AnyTable> extends BaseQueryBuilder {
+    private table;
+    private updateData;
+    private returningColumns;
+    constructor(db: Database, table: T);
+    set(data: Partial<InferInsertModel<T>>): this;
+    returning(...columns: (keyof T["_"]["columns"])[]): this;
+    private buildUpdateClause;
+    execute(): Promise<T extends AnyTable ? (InferSelectModel<T> & Record<string, any>)[] : never>;
+    returningAll(): Promise<InferSelectModel<T>[]>;
+}
+
+declare class InsertQueryBuilder<T extends AnyTable> extends BaseQueryBuilder {
+    private table;
+    private dataSets;
+    private returningColumns;
+    private onConflictAction;
+    private conflictTarget;
+    private updateSet;
+    constructor(db: Database, table: T);
+    values(data: InferInsertModel<T> | InferInsertModel<T>[]): this;
+    returning(...columns: (keyof T["_"]["columns"])[]): this;
+    onConflictDoNothing(target?: AnySQLiteColumn | AnySQLiteColumn[]): this;
+    onConflictDoUpdate(config: {
+        target: AnySQLiteColumn | AnySQLiteColumn[];
+        set: Partial<InferInsertModel<T>>;
+    }): this;
+    private processDefaultValues;
+    private buildConflictClause;
+    execute(): Promise<T extends AnyTable ? (InferSelectModel<T> & Record<string, any>)[] : never>;
+    returningAll(): Promise<InferSelectModel<T>[]>;
+}
+
+declare class DeleteQueryBuilder<T extends AnyTable> extends BaseQueryBuilder {
+    private table;
+    private returningColumns;
+    constructor(db: Database, table: T);
+    returning(...columns: (keyof T["_"]["columns"])[]): this;
+    execute(): Promise<T extends AnyTable ? (InferSelectModel<T> & Record<string, any>)[] : never>;
+    returningAll(): Promise<InferSelectModel<T>[]>;
+}
+
+declare class WithQueryBuilder {
+    private db;
+    private ctes;
+    constructor(db: Database);
+    with(alias: string, query: {
+        sql: string;
+        params: any[];
+    }): this;
+    select<T extends AnyTable, C extends (keyof T["_"]["columns"])[] | undefined = undefined>(table: T, columns?: C): SelectQueryBuilder<T, C>;
+    insert<T extends AnyTable>(table: T): InsertQueryBuilder<T>;
+    update<T extends AnyTable>(table: T): UpdateQueryBuilder<T>;
+    delete<T extends AnyTable>(table: T): DeleteQueryBuilder<T>;
+    private applyWithClause;
+}
+
+type RelationsBuilder = {
+    one: <U extends AnyTable>(table: U, config?: {
+        fields: AnySQLiteColumn[];
+        references: AnySQLiteColumn[];
+    }) => OneRelation<U>;
+    many: <U extends AnyTable>(table: U) => ManyRelation<U>;
+};
+
 declare class SQLiteColumn<TName extends string = string, TType extends ColumnDataType = ColumnDataType, TMode extends Mode = "default", TNotNull extends boolean = false, THasDefault extends boolean = false, TAutoincrement extends boolean = false> {
     type: TType;
     options: ColumnOptions<ColumnValueTypes<TType, TMode>>;
@@ -33,29 +150,19 @@ 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>;
     $onUpdateFn(fn: () => ColumnValueTypes<TType, TMode>): SQLiteColumn<TName, TType, TMode, TNotNull, THasDefault, TAutoincrement>;
+    as(alias: string): SQLiteColumn<TName, TType, TMode, TNotNull, THasDefault, TAutoincrement>;
 }
-declare const text: <TName extends string>(name: TName) => SQLiteColumn<TName, "TEXT", "default", false, false, false>;
-declare const integer: <TName extends string, TMode extends Mode = "default">(name: TName, config?: {
-    mode?: TMode;
-}) => SQLiteColumn<TName, "INTEGER", "default" | TMode, false, false, false>;
-declare const real: <TName extends string>(name: TName) => SQLiteColumn<TName, "REAL", "default", false, false, false>;
-declare const blob: <TName extends string>(name: TName) => SQLiteColumn<TName, "BLOB", "default", false, false, false>;
-declare const boolean: <TName extends string>(name: TName) => SQLiteColumn<TName, "BOOLEAN", "default", false, false, false>;
-type AnySQLiteColumn = SQLiteColumn<any, any, any, any, any, any>;
-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]>;
@@ -67,6 +174,7 @@ declare class Table<TColumns extends Record<string, AnySQLiteColumn>, TTableName
         name: TTableName;
         columns: TColumns;
     };
+    relations: Record<string, RelationConfig>;
     constructor(name: TTableName, columns: TColumns);
 }
 declare const sqliteTable: <TTableName extends string, TColumns extends Record<string, AnySQLiteColumn>>(tableName: TTableName, columns: TColumns) => Table<TColumns, TTableName>;
@@ -74,66 +182,37 @@ type SQLCondition = {
     sql: string;
     params: any[];
 };
-declare const eq: <T>(column: AnySQLiteColumn, value: T) => SQLCondition;
-declare const and: (...conditions: SQLCondition[]) => SQLCondition;
-declare const or: (...conditions: SQLCondition[]) => SQLCondition;
-declare const gt: <T>(column: AnySQLiteColumn, value: T) => SQLCondition;
-declare const gte: <T>(column: AnySQLiteColumn, value: T) => SQLCondition;
-declare const lt: <T>(column: AnySQLiteColumn, value: T) => SQLCondition;
-declare const lte: <T>(column: AnySQLiteColumn, value: T) => SQLCondition;
-declare const like: (column: AnySQLiteColumn, pattern: string) => SQLCondition;
-declare const isNull: (column: AnySQLiteColumn) => SQLCondition;
-declare const isNotNull: (column: AnySQLiteColumn) => SQLCondition;
-declare const inArray: <T>(column: AnySQLiteColumn, values: T[]) => SQLCondition;
-declare class BaseQueryBuilder {
-    protected db: Database;
-    protected query: string;
-    protected params: any[];
-    constructor(db: Database);
-    where(condition: SQLCondition): this;
-    orderBy(column: AnySQLiteColumn, direction?: "ASC" | "DESC"): this;
-    limit(count: number): this;
-    offset(count: number): this;
-    build(): {
-        sql: string;
-        params: any[];
-    };
-}
-declare class SelectQueryBuilder<TTable extends AnyTable, TSelectedColumns extends (keyof TTable["_"]["columns"])[] | undefined = undefined> extends BaseQueryBuilder {
-    private table;
-    private columns?;
-    constructor(db: Database, table: TTable, columns?: TSelectedColumns | undefined);
-    execute(): Promise<TSelectedColumns extends (keyof TTable["_"]["columns"])[] ? Pick<InferSelectModel<TTable>, TSelectedColumns[number]>[] : InferSelectModel<TTable>[]>;
-}
-declare class InsertQueryBuilder<T extends AnyTable> extends BaseQueryBuilder {
-    private table;
-    private dataSets;
-    constructor(db: Database, table: T);
-    values(data: Partial<InferInsertModel<T>> | Partial<InferInsertModel<T>>[]): this;
-    execute(): Promise<number>;
-}
-declare class UpdateQueryBuilder<T extends AnyTable> extends BaseQueryBuilder {
-    private table;
-    private updateData;
-    constructor(db: Database, table: T);
-    set(data: Partial<InferInsertModel<T>>): this;
-    execute(): Promise<number>;
-}
-declare class DeleteQueryBuilder<T extends AnyTable> extends BaseQueryBuilder {
-    private table;
-    constructor(db: Database, table: T);
-    execute(): Promise<number>;
-}
+declare const asc: (column: AnySQLiteColumn) => {
+    sql: string;
+    params: never[];
+};
+declare const desc: (column: AnySQLiteColumn) => {
+    sql: string;
+    params: never[];
+};
+declare const sql: <T = unknown>(strings: TemplateStringsArray, ...values: any[]) => {
+    sql: string;
+    params: any[];
+    mapWith?: (value: any) => T;
+};
 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>;
     insert<T extends AnyTable>(table: T): InsertQueryBuilder<T>;
     update<T extends AnyTable>(table: T): UpdateQueryBuilder<T>;
     delete<T extends AnyTable>(table: T): DeleteQueryBuilder<T>;
+    $with(alias: string): {
+        as: (query: {
+            sql: string;
+            params: any[];
+        }) => WithQueryBuilder;
+    };
     transaction<T>(callback: (tx: TauriORM) => Promise<T>): Promise<T>;
+    rollback(): never;
     private ensureSchemaMeta;
     private getSchemaMeta;
     private setSchemaMeta;
@@ -147,9 +226,52 @@ 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);
+}
+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"]>;
+
+declare const eq: <T>(column: AnySQLiteColumn, value: T) => SQLCondition;
+declare const and: (...conditions: SQLCondition[]) => SQLCondition;
+declare const or: (...conditions: SQLCondition[]) => SQLCondition;
+declare const not: (condition: SQLCondition) => SQLCondition;
+declare const gt: <T>(column: AnySQLiteColumn, value: T) => SQLCondition;
+declare const gte: <T>(column: AnySQLiteColumn, value: T) => SQLCondition;
+declare const lt: <T>(column: AnySQLiteColumn, value: T) => SQLCondition;
+declare const lte: <T>(column: AnySQLiteColumn, value: T) => SQLCondition;
+declare const like: (column: AnySQLiteColumn, pattern: string) => SQLCondition;
+declare const isNull: (column: AnySQLiteColumn) => SQLCondition;
+declare const isNotNull: (column: AnySQLiteColumn) => SQLCondition;
+declare const inArray: <T>(column: AnySQLiteColumn, values: T[]) => SQLCondition;
+declare const count: (column?: AnySQLiteColumn) => SQLCondition;
+declare const countDistinct: (column: AnySQLiteColumn) => SQLCondition;
+declare const sum: (column: AnySQLiteColumn) => SQLCondition;
+declare const avg: (column: AnySQLiteColumn) => SQLCondition;
+declare const max: (column: AnySQLiteColumn) => SQLCondition;
+declare const min: (column: AnySQLiteColumn) => SQLCondition;
+
+declare const columnHelpers: <TName extends string>(name: TName) => SQLiteColumn<TName, "TEXT", "default", false, false, false>;
+declare const integer: <TName extends string, TMode extends Mode = "default">(name: TName, config?: {
+    mode?: TMode;
+}) => SQLiteColumn<TName, "INTEGER", "default" | TMode, false, false, false>;
+declare const real: <TName extends string>(name: TName) => SQLiteColumn<TName, "REAL", "default", false, false, false>;
+declare const blob: <TName extends string>(name: TName) => SQLiteColumn<TName, "BLOB", "default", false, false, false>;
+declare const boolean: <TName extends string>(name: TName) => SQLiteColumn<TName, "BOOLEAN", "default", false, false, false>;
 
-export { type AnySQLiteColumn, type AnyTable, type ColumnDataType, type ColumnOptions, DeleteQueryBuilder, type InferInsertModel, type InferSelectModel, InsertQueryBuilder, type Mode, type SQLCondition, SQLiteColumn, SelectQueryBuilder, Table, TauriORM, UpdateQueryBuilder, and, blob, boolean, eq, gt, gte, inArray, integer, isNotNull, isNull, like, lt, lte, or, real, relations, sqliteTable, text };
+export { type AnySQLiteColumn, type AnyTable, BaseQueryBuilder, type ColumnDataType, type ColumnOptions, type ColumnValueTypes, DeleteQueryBuilder, type ExtractColumnType, type InferInsertModel, type InferSelectModel, InsertQueryBuilder, ManyRelation, type Mode, OneRelation, Relation, type RelationConfig, type RelationType, type RelationsBuilder, type SQLCondition, SQLiteColumn, SelectQueryBuilder, Table, TauriORM, UpdateQueryBuilder, WithQueryBuilder, alias, and, asc, avg, blob, boolean, columnHelpers, count, countDistinct, desc, eq, getTableColumns, gt, gte, inArray, integer, isNotNull, isNull, like, lt, lte, max, min, not, or, real, relations, sql, sqliteTable, sum };