@apisr/drizzle-model 0.0.1 → 0.0.2

package/src/model/relation.ts

@@ -1,10 +1,10 @@
 import type {
-  TableRelationalConfig,
-  TablesRelationalConfig,
+	TableRelationalConfig,
+	TablesRelationalConfig,
 } from "drizzle-orm/relations";
+import type { RecursiveBooleanRecord } from "../types.ts";
 import type { ModelIdentifier } from "./model.ts";
 import type { IsTable, TableOutput } from "./table.ts";
-import type { RecursiveBooleanRecord } from "../types.ts";
 
 /**
  * Defines the cardinality of a relation: "one" (hasOne) or "many" (hasMany).
@@ -19,8 +19,8 @@ export type RelationKind = "one" | "many";
  * @typeParam T - The type to potentially wrap
  */
 export type ApplyRelationCardinality<
-  Kind extends RelationKind,
-  T,
+	Kind extends RelationKind,
+	T,
 > = Kind extends "many" ? T[] : T;
 
 /**
@@ -30,8 +30,8 @@ export type ApplyRelationCardinality<
  * @typeParam Key - Name of the relation field
  */
 export type RelationMeta<
-  TTable extends TableRelationalConfig,
-  Key extends string,
+	TTable extends TableRelationalConfig,
+	Key extends string,
 > = TTable["relations"][Key];
 
 /**
@@ -41,8 +41,8 @@ export type RelationMeta<
  * @typeParam Meta - Metadata object containing the target table name
  */
 export type TargetTable<
-  TSchema extends TablesRelationalConfig,
-  Meta extends { targetTableName: string; },
+	TSchema extends TablesRelationalConfig,
+	Meta extends { targetTableName: string },
 > = TSchema[Meta["targetTableName"]];
 
 /**
@@ -53,11 +53,11 @@ export type TargetTable<
  * @typeParam TTable - Relational configuration for the source table
  */
 export type RelationTargetRow<
-  Key extends string,
-  TSchema extends TablesRelationalConfig,
-  TTable extends TableRelationalConfig,
+	Key extends string,
+	TSchema extends TablesRelationalConfig,
+	TTable extends TableRelationalConfig,
 > = TableOutput<
-  IsTable<TargetTable<TSchema, RelationMeta<TTable, Key>>["table"]>
+	IsTable<TargetTable<TSchema, RelationMeta<TTable, Key>>["table"]>
 >;
 
 /**
@@ -73,24 +73,25 @@ export type RelationTargetRow<
  * @typeParam TTable - Relational configuration for the source table
  */
 export type ResolveSingleRelation<
-  Key extends string,
-  Value,
-  TSchema extends TablesRelationalConfig,
-  TTable extends TableRelationalConfig,
-> = Value extends Record<string, any>
-  ? ApplyRelationCardinality<
-    RelationMeta<TTable, Key>["relationType"],
-    ResolveRelationSelection<
-      Value,
-      TSchema,
-      TargetTable<TSchema, RelationMeta<TTable, Key>>
-    > &
-    RelationTargetRow<Key, TSchema, TTable>
-  >
-  : ApplyRelationCardinality<
-    RelationMeta<TTable, Key>["relationType"],
-    RelationTargetRow<Key, TSchema, TTable>
-  >;
+	Key extends string,
+	Value,
+	TSchema extends TablesRelationalConfig,
+	TTable extends TableRelationalConfig,
+> =
+	Value extends Record<string, any>
+		? ApplyRelationCardinality<
+				RelationMeta<TTable, Key>["relationType"],
+				ResolveRelationSelection<
+					Value,
+					TSchema,
+					TargetTable<TSchema, RelationMeta<TTable, Key>>
+				> &
+					RelationTargetRow<Key, TSchema, TTable>
+			>
+		: ApplyRelationCardinality<
+				RelationMeta<TTable, Key>["relationType"],
+				RelationTargetRow<Key, TSchema, TTable>
+			>;
 
 /**
  * Recursively resolves a selection object into a typed result object.
@@ -103,19 +104,19 @@ export type ResolveSingleRelation<
  * @typeParam TTable - Relational configuration for the current table
  */
 export type ResolveRelationSelection<
-  TSelection extends Record<string, any>,
-  TSchema extends TablesRelationalConfig,
-  TTable extends TableRelationalConfig,
+	TSelection extends Record<string, any>,
+	TSchema extends TablesRelationalConfig,
+	TTable extends TableRelationalConfig,
 > = {
-    [Key in keyof TSelection as TSelection[Key] extends
-    | true
-    | RecursiveBooleanRecord
-    | ModelIdentifier<any>
-    ? Key & string
-    : never]: ResolveSingleRelation<
-      Key & string,
-      TSelection[Key],
-      TSchema,
-      TTable
-    >;
-  };
+	[Key in keyof TSelection as TSelection[Key] extends
+		| true
+		| RecursiveBooleanRecord
+		| ModelIdentifier<any>
+		? Key & string
+		: never]: ResolveSingleRelation<
+		Key & string,
+		TSelection[Key],
+		TSchema,
+		TTable
+	>;
+};

package/src/model/result.ts

@@ -1,19 +1,22 @@
 import type {
-  TableRelationalConfig,
-  TablesRelationalConfig,
+	TableRelationalConfig,
+	TablesRelationalConfig,
 } from "drizzle-orm/relations";
-import type { MethodWithResult, MethodWithValue } from "./methods/with.ts";
-import type { MethodSelectResult, MethodSelectValue } from "./methods/select.ts";
+import type { ModelConfig } from "./config.ts";
+import type { ReturningIdDialects } from "./dialect.ts";
+import type { ModelFormatValue } from "./format.ts";
 import type {
-  MethodExcludeResult,
-  MethodExcludeValue,
+	MethodExcludeResult,
+	MethodExcludeValue,
 } from "./methods/exclude.ts";
 import type { MethodReturnResult } from "./methods/return.ts";
-import type { ReturningIdDialects } from "./dialect.ts";
-import type { TableOutput } from "./table.ts";
-import type { ModelConfig } from "./config.ts";
+import type {
+	MethodSelectResult,
+	MethodSelectValue,
+} from "./methods/select.ts";
+import type { MethodWithResult, MethodWithValue } from "./methods/with.ts";
 import type { ResolveOptionsFormat } from "./options.ts";
-import type { ModelFormatValue } from "./format.ts";
+import type { TableOutput } from "./table.ts";
 
 /**
  * Represents the result of a model operation (like findMany or findFirst).
@@ -26,66 +29,79 @@ import type { ModelFormatValue } from "./format.ts";
  * @typeParam TTable - Relational configuration for the current table
  */
 export interface ModelQueryResult<
-  TResult extends Record<string, any>,
-  TConfig extends ModelConfig,
-  TExcludedKeys extends string = string,
-  TSchema extends TablesRelationalConfig = TConfig["schema"],
-  TTable extends TableRelationalConfig = TConfig["table"],
-  TFormat extends Record<string, any> | undefined = ResolveOptionsFormat<TConfig["options"]["format"]>
+	TResult extends Record<string, any>,
+	TConfig extends ModelConfig,
+	TExcludedKeys extends string = string,
+	TSchema extends TablesRelationalConfig = TConfig["schema"],
+	TTable extends TableRelationalConfig = TConfig["table"],
+	TFormat extends Record<string, any> | undefined = ResolveOptionsFormat<
+		TConfig["options"]["format"]
+	>,
 > extends Promise<ModelFormatValue<TResult, TFormat>> {
-  with<TValue extends MethodWithValue<TSchema, TTable["relations"]>, TExcludeKeys extends string = TExcludedKeys | "with">(
-    value: TValue,
-  ): ModelQueryResult<
-    MethodWithResult<TValue, TResult, TSchema, TTable>,
-    TConfig,
-    TExcludeKeys
-  >,
-
-  select<TValue extends MethodSelectValue<TResult>, TExcludeKeys extends string = TExcludedKeys | "select">(
-    value: TValue,
-  ): ModelQueryResult<
-    MethodSelectResult<TValue, TResult>,
-    TConfig,
-    TExcludeKeys
-  >,
+	debug(): any;
 
-  exclude<TValue extends MethodExcludeValue<TResult>, TExcludeKeys extends string = TExcludedKeys | "exclude">(
-    value: TValue,
-  ): ModelQueryResult<
-    MethodExcludeResult<TValue, TResult>,
-    TConfig,
-    TExcludeKeys
-  >,
+	exclude<
+		TValue extends MethodExcludeValue<TResult>,
+		TExcludeKeys extends string = TExcludedKeys | "exclude",
+	>(
+		value: TValue
+	): ModelQueryResult<
+		MethodExcludeResult<TValue, TResult>,
+		TConfig,
+		TExcludeKeys
+	>;
 
-  raw<TExcludeKeys extends string = TExcludedKeys | "raw">(): ModelQueryResult<TResult, TConfig, TExcludeKeys, TSchema, TTable, undefined>;
+	raw<TExcludeKeys extends string = TExcludedKeys | "raw">(): ModelQueryResult<
+		TResult,
+		TConfig,
+		TExcludeKeys,
+		TSchema,
+		TTable,
+		undefined
+	>;
 
-  debug(): any;
+	select<
+		TValue extends MethodSelectValue<TResult>,
+		TExcludeKeys extends string = TExcludedKeys | "select",
+	>(
+		value: TValue
+	): ModelQueryResult<
+		MethodSelectResult<TValue, TResult>,
+		TConfig,
+		TExcludeKeys
+	>;
+	with<
+		TValue extends MethodWithValue<TSchema, TTable["relations"]>,
+		TExcludeKeys extends string = TExcludedKeys | "with",
+	>(
+		value: TValue
+	): ModelQueryResult<
+		MethodWithResult<TValue, TResult, TSchema, TTable>,
+		TConfig,
+		TExcludeKeys
+	>;
 }
 
 export interface ModelMutateResult<
-  TBaseResult extends Record<string, any> | void,
-  TConfig extends ModelConfig,
-  TResultType extends string = "one"
+	TBaseResult extends Record<string, any> | void,
+	TConfig extends ModelConfig,
+	TResultType extends string = "one",
 > extends Promise<TBaseResult> {
-  // TODO: Planned for future
-  // with<TValue extends MethodWithInsertValue<TSchema, TTable["relations"]>>(
-  //   value: TValue,
-  // ): void;
+	// TODO: Planned for future
+	// with<TValue extends MethodWithInsertValue<TSchema, TTable["relations"]>>(
+	//   value: TValue,
+	// ): void;
 
-  return<
-    TValue extends MethodSelectValue<TableOutput<TConfig["table"]>> | undefined,
-    TReturnResult extends MethodReturnResult<TResultType, TConfig> = MethodReturnResult<TResultType, TConfig>,
-    TResult extends Record<string, any> = TValue extends undefined ? TReturnResult : MethodSelectResult<Exclude<TValue, undefined>, TReturnResult>,
-  >(
-    value?: TConfig["dialect"] extends ReturningIdDialects
-      ? never
-      : TValue,
-  ): Omit<
-    ModelMutateResult<
-      TResult,
-      TConfig,
-      TResultType
-    >,
-    "with"
-  >;
+	return<
+		TValue extends MethodSelectValue<TableOutput<TConfig["table"]>> | undefined,
+		TReturnResult extends MethodReturnResult<
+			TResultType,
+			TConfig
+		> = MethodReturnResult<TResultType, TConfig>,
+		TResult extends Record<string, any> = TValue extends undefined
+			? TReturnResult
+			: MethodSelectResult<Exclude<TValue, undefined>, TReturnResult>,
+	>(
+		value?: TConfig["dialect"] extends ReturningIdDialects ? never : TValue
+	): Omit<ModelMutateResult<TResult, TConfig, TResultType>, "with">;
 }

package/src/model/shape.ts

@@ -2,7 +2,8 @@ import type { ModelConfig } from "./config.ts";
 import type { ModelBase, ModelIdentifier } from "./model.ts";
 import type { ResolveOptionsMethods } from "./options.ts";
 
-export type ModelShape<TConfig extends ModelConfig> =
-  ModelIdentifier<TConfig["table"]["name"]> &
-  ModelBase<TConfig> &
-  ResolveOptionsMethods<TConfig["options"]["methods"]>;
+export type ModelShape<TConfig extends ModelConfig> = ModelIdentifier<
+	TConfig["table"]["name"]
+> &
+	ModelBase<TConfig> &
+	ResolveOptionsMethods<TConfig["options"]["methods"]>;

package/src/model/table.ts

@@ -14,7 +14,9 @@ import type { SchemaEntry, TableRelationalConfig } from "drizzle-orm/relations";
  *
  * @typeParam TTable - Relational configuration for the table
  */
-export type TableColumns<TTable extends TableRelationalConfig> = IsTable<TTable["table"]>["_"]["columns"];
+export type TableColumns<TTable extends TableRelationalConfig> = IsTable<
+	TTable["table"]
+>["_"]["columns"];
 
 /**
  * Resolves a single column definition from a table by column name.
@@ -29,8 +31,8 @@ export type TableColumns<TTable extends TableRelationalConfig> = IsTable<TTable[
  * @typeParam TTable - Relational configuration for the table
  */
 export type TableColumn<
-  TColumnName extends string,
-  TTable extends TableRelationalConfig,
+	TColumnName extends string,
+	TTable extends TableRelationalConfig,
 > = TableColumns<TTable>[TColumnName];
 
 /**
@@ -38,8 +40,12 @@ export type TableColumn<
  *
  * @typeParam TTable - Relation config, schema entry, or table
  */
-export type TableOutput<TTable extends TableRelationalConfig | SchemaEntry | Table> =
-  NormalizeTable<TTable> extends Table ? InferSelectModel<NormalizeTable<TTable>> : never;
+export type TableOutput<
+	TTable extends TableRelationalConfig | SchemaEntry | Table,
+> =
+	NormalizeTable<TTable> extends Table
+		? InferSelectModel<NormalizeTable<TTable>>
+		: never;
 // Is relation?
 // (TTable extends TableRelationalConfig
 //   ? InferSelectModel<IsTable<TTable["table"]>>
@@ -56,28 +62,27 @@ export type TableOutput<TTable extends TableRelationalConfig | SchemaEntry | Tab
  *
  * @typeParam TTable - Relation config, schema entry, or table
  */
-export type NormalizeTable<TTable extends TableRelationalConfig | SchemaEntry | Table> =
-  // Is relation?
-  (TTable extends TableRelationalConfig
-    ? IsTable<TTable["table"]>
-    : (TTable extends SchemaEntry
-      // Is schema entry (view/table)?
-      ? IsTable<TTable>
-      : (TTable extends Table
-        // Is Table?
-        ? TTable
-        : never)));
+export type NormalizeTable<
+	TTable extends TableRelationalConfig | SchemaEntry | Table,
+> =
+	// Is relation?
+	TTable extends TableRelationalConfig
+		? IsTable<TTable["table"]>
+		: TTable extends SchemaEntry
+			? // Is schema entry (view/table)?
+				IsTable<TTable>
+			: TTable extends Table
+				? // Is Table?
+					TTable
+				: never;
 
 /**
  * Collects target table names from all relations.
  *
  * @typeParam TTable - Relational configuration for the table
  */
-export type TableRelationsTableName<
-  TTable extends TableRelationalConfig
-> = {
-  [K in keyof TTable["relations"]]:
-  TTable["relations"][K]["targetTableName"]
+export type TableRelationsTableName<TTable extends TableRelationalConfig> = {
+	[K in keyof TTable["relations"]]: TTable["relations"][K]["targetTableName"];
 }[keyof TTable["relations"]];
 
 /**
@@ -86,11 +91,9 @@ export type TableRelationsTableName<
  * @typeParam TTable - Relational configuration for the table
  */
 type TableOneRelationsMap<TTable extends TableRelationalConfig> = {
-  [K in keyof TTable["relations"]as
-  TTable["relations"][K]["relationType"] extends "many"
-  ? never
-  : K
-  ]: TTable["relations"][K]["targetTableName"]
+	[K in keyof TTable["relations"] as TTable["relations"][K]["relationType"] extends "many"
+		? never
+		: K]: TTable["relations"][K]["targetTableName"];
 };
 
 /**
@@ -98,9 +101,8 @@ type TableOneRelationsMap<TTable extends TableRelationalConfig> = {
  *
  * @typeParam TTable - Relational configuration for the table
  */
-export type TableOneRelationsTableName<
-  TTable extends TableRelationalConfig
-> = TableOneRelationsMap<TTable>[keyof TableOneRelationsMap<TTable>];
+export type TableOneRelationsTableName<TTable extends TableRelationalConfig> =
+	TableOneRelationsMap<TTable>[keyof TableOneRelationsMap<TTable>];
 
 /**
  * Narrows a type to a Drizzle table when possible.
@@ -114,8 +116,7 @@ export type IsTable<T> = T extends Table ? T : never;
  *
  * @typeParam TTable - Drizzle table type
  */
-export type TableInsertModel<TTable extends Table> =
-  InferInsertModel<TTable>;
+export type TableInsertModel<TTable extends Table> = InferInsertModel<TTable>;
 
 /**
  * Accepts a single insert payload or a batch of insert payloads.
@@ -123,5 +124,5 @@ export type TableInsertModel<TTable extends Table> =
  * @typeParam TTable - Drizzle table type
  */
 export type TableInsertValues<TTable extends Table> =
-  | InferInsertModel<TTable>
-  | InferInsertModel<TTable>[];
+	| InferInsertModel<TTable>
+	| InferInsertModel<TTable>[];

package/src/types.ts

@@ -4,13 +4,13 @@ export type Replace<T, R> = Omit<T, keyof R> & R;
 export type UnwrapArray<T> = T extends (infer R)[] ? R : T;
 
 export type AddToValues<T extends Record<PropertyKey, any>, A> = {
-  [K in keyof T]: T[K] & A
+	[K in keyof T]: T[K] & A;
 };
 
 export type AddUnionToValues<T extends Record<PropertyKey, any>, A> = {
-  [K in keyof T]: T[K] | A
+	[K in keyof T]: T[K] | A;
 };
 
 export interface RecursiveBooleanRecord {
-  [key: string]: boolean | RecursiveBooleanRecord;
+	[key: string]: boolean | RecursiveBooleanRecord;
 }

package/tests/builder-v2-mysql.type-test.ts

@@ -1,40 +1,51 @@
-import { mysqlDb } from "./db";
-import { modelBuilder } from "src/model";
-import { boolean, int, text, mysqlTable, varchar } from 'drizzle-orm/mysql-core';
 import { defineRelations } from "drizzle-orm";
+import {
+	boolean,
+	int,
+	mysqlTable,
+	text,
+	varchar,
+} from "drizzle-orm/mysql-core";
+import { modelBuilder } from "src/model";
 import { esc } from "@/model/query/operations";
+import { mysqlDb } from "./db";
 
-const usersTable = mysqlTable('users', {
-  id: int('id').primaryKey(),
-  name: text('name').notNull(),
-  verified: boolean('verified').notNull().default(false),
+const usersTable = mysqlTable("users", {
+	id: int("id").primaryKey(),
+	name: text("name").notNull(),
+	verified: boolean("verified").notNull().default(false),
 });
 
-const usersTableDefFn = mysqlTable('users_default_fn', {
-  customId: varchar('id', { length: 256 }).primaryKey().$defaultFn(() => "123"),
-  name: text('name').notNull(),
+const usersTableDefFn = mysqlTable("users_default_fn", {
+	customId: varchar("id", { length: 256 })
+		.primaryKey()
+		.$defaultFn(() => "123"),
+	name: text("name").notNull(),
 });
 
 const schema = {
-  usersTable,
-  usersTableDefFn
+	usersTable,
+	usersTableDefFn,
 };
 
 const relations = defineRelations(schema, (r) => ({
-  usersTable: {}
+	usersTable: {},
 }));
 
 const model = modelBuilder({
-  schema,
-  db: mysqlDb,
-  relations,
-  dialect: "MySQL"
+	schema,
+	db: mysqlDb,
+	relations,
+	dialect: "MySQL",
 });
 
 const userModel = model("usersTableDefFn", {});
 
-const testRaw1 = await userModel.where({
-  customId: esc("123")
-}).delete().return();
+const testRaw1 = await userModel
+	.where({
+		customId: esc("123"),
+	})
+	.delete()
+	.return();
 
 // testRaw1[0].