drizzle-graphql-plus 0.8.14 → 0.8.16

package/index.d.cts

@@ -1,4 +1,4 @@
-import { Table, Column, TablesRelationalConfig, TableRelationalConfig, Relations, Relation, One, Many } from 'drizzle-orm';
+import { Table, Column, TablesRelationalConfig, TableRelationalConfig, Relations, Relation, One, Many, InferSelectModel, getTableColumns } from 'drizzle-orm';
 import { MySqlDatabase } from 'drizzle-orm/mysql-core';
 import { RelationalQueryBuilder as RelationalQueryBuilder$1 } from 'drizzle-orm/mysql-core/query-builders/query';
 import { PgDatabase } from 'drizzle-orm/pg-core';
@@ -82,7 +82,7 @@ type ExtractTableByName<TTableSchema extends Record<string, Table>, TName extend
 type MutationReturnlessResult = {
     isSuccess: boolean;
 };
-type QueryArgs<TTable extends Table, isSingle extends boolean> = Partial<(isSingle extends true ? {
+type QueryArgs$1<TTable extends Table, isSingle extends boolean> = Partial<(isSingle extends true ? {
     offset: number;
 } : {
     offset: number;
@@ -103,10 +103,10 @@ type UpdateArgs<TTable extends Table> = Partial<{
 type DeleteArgs<TTable extends Table> = {
     where?: Filters<TTable>;
 };
-type SelectResolver<TTable extends Table, TTables extends Record<string, Table>, TRelations extends Record<string, Relation>> = (source: any, args: Partial<QueryArgs<TTable, false>>, context: any, info: GraphQLResolveInfo) => Promise<keyof TRelations extends infer RelKey ? RelKey extends string ? Array<GetRemappedTableDataType<TTable> & {
+type SelectResolver<TTable extends Table, TTables extends Record<string, Table>, TRelations extends Record<string, Relation>> = (source: any, args: Partial<QueryArgs$1<TTable, false>>, context: any, info: GraphQLResolveInfo) => Promise<keyof TRelations extends infer RelKey ? RelKey extends string ? Array<GetRemappedTableDataType<TTable> & {
     [K in RelKey]: TRelations[K] extends One<string> ? GetRemappedTableDataType<ExtractTableByName<TTables, TRelations[K]["referencedTableName"]> extends infer T ? T[keyof T] : never> | null : TRelations[K] extends Many<string> ? Array<GetRemappedTableDataType<ExtractTableByName<TTables, TRelations[K]["referencedTableName"]> extends infer T ? T[keyof T] : never>> : never;
 }> : Array<GetRemappedTableDataType<TTable>> : Array<GetRemappedTableDataType<TTable>>>;
-type SelectSingleResolver<TTable extends Table, TTables extends Record<string, Table>, TRelations extends Record<string, Relation>> = (source: any, args: Partial<QueryArgs<TTable, true>>, context: any, info: GraphQLResolveInfo) => Promise<(keyof TRelations extends infer RelKey ? RelKey extends string ? GetRemappedTableDataType<TTable> & {
+type SelectSingleResolver<TTable extends Table, TTables extends Record<string, Table>, TRelations extends Record<string, Relation>> = (source: any, args: Partial<QueryArgs$1<TTable, true>>, context: any, info: GraphQLResolveInfo) => Promise<(keyof TRelations extends infer RelKey ? RelKey extends string ? GetRemappedTableDataType<TTable> & {
     [K in RelKey]: TRelations[K] extends One<string> ? GetRemappedTableDataType<ExtractTableByName<TTables, TRelations[K]["referencedTableName"]> extends infer T ? T[keyof T] : never> | null : TRelations[K] extends Many<string> ? Array<GetRemappedTableDataType<ExtractTableByName<TTables, TRelations[K]["referencedTableName"]> extends infer T ? T[keyof T] : never>> : never;
 } : GetRemappedTableDataType<TTable> : GetRemappedTableDataType<TTable>) | null>;
 type InsertResolver<TTable extends Table, IsReturnless extends boolean> = (source: any, args: Partial<InsertArgs<TTable, false>>, context: any, info: GraphQLResolveInfo) => Promise<IsReturnless extends false ? Array<GetRemappedTableDataType<TTable>> : MutationReturnlessResult>;
@@ -248,4 +248,135 @@ type BuildSchemaConfig = {
 
 declare const buildSchema: <TDbClient extends AnyDrizzleDB<any>>(db: TDbClient, config?: BuildSchemaConfig) => GeneratedData<TDbClient>;
 
-export { type AnyDrizzleDB, type AnyQueryBuiler, type BuildSchemaConfig, type DeleteArgs, type DeleteResolver, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedInterfaces, type GeneratedOutputs, type InsertArgs, type InsertArrResolver, type InsertResolver, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type QueryArgs, type SelectResolver, type SelectSingleResolver, type UpdateArgs, type UpdateResolver, buildSchema };
+type Capitalize$1<S extends string> = S extends `${infer F}${infer R}` ? `${Uppercase<F>}${R}` : S;
+type ColumnFilter<T = any> = {
+    eq?: T;
+    ne?: T;
+    gt?: T;
+    gte?: T;
+    lt?: T;
+    lte?: T;
+    like?: string;
+    notLike?: string;
+    ilike?: string;
+    notIlike?: string;
+    inArray?: T[];
+    notInArray?: T[];
+    isNull?: boolean;
+    isNotNull?: boolean;
+    OR?: ColumnFilter<T>[];
+};
+type WhereInput<TTable> = TTable extends {
+    $inferSelect: infer S;
+} ? {
+    [K in keyof S]?: ColumnFilter<S[K]>;
+} & {
+    OR?: WhereInput<TTable>[];
+} : never;
+type OrderByInput<TTable> = TTable extends {
+    $inferSelect: infer S;
+} ? {
+    [K in keyof S]?: {
+        direction: "asc" | "desc";
+        priority: number;
+    };
+} : never;
+type QueryArgs<TTable> = {
+    where?: WhereInput<TTable>;
+    orderBy?: OrderByInput<TTable>;
+    limit?: number;
+    offset?: number;
+};
+type InsertInput<TTable> = TTable extends {
+    $inferInsert: infer I;
+} ? I : never;
+type UpdateInput<TTable> = TTable extends {
+    $inferInsert: infer I;
+} ? Partial<I> : never;
+type BuildSchemaSDLResult<TSchema extends Record<string, any> = Record<string, any>> = {
+    typeDefs: string;
+    resolvers: {
+        Query: {
+            [K in keyof TSchema as TSchema[K] extends {
+                $inferSelect: any;
+            } ? K : never]: (parent: any, args: QueryArgs<TSchema[K]>, context: any, info: any) => Promise<InferSelectModel<TSchema[K]>[]>;
+        };
+        Mutation: {
+            [K in keyof TSchema as TSchema[K] extends {
+                $inferSelect: any;
+            } ? `insert${Capitalize$1<K & string>}` : never]: (parent: any, args: {
+                data: InsertInput<TSchema[K]> | InsertInput<TSchema[K]>[];
+            }, context: any, info: any) => Promise<InferSelectModel<TSchema[K]>[]>;
+        } & {
+            [K in keyof TSchema as TSchema[K] extends {
+                $inferSelect: any;
+            } ? `update${Capitalize$1<K & string>}` : never]: (parent: any, args: {
+                data: UpdateInput<TSchema[K]>;
+                where: WhereInput<TSchema[K]>;
+            }, context: any, info: any) => Promise<InferSelectModel<TSchema[K]>[]>;
+        } & {
+            [K in keyof TSchema as TSchema[K] extends {
+                $inferSelect: any;
+            } ? `delete${Capitalize$1<K & string>}` : never]: (parent: any, args: {
+                where: WhereInput<TSchema[K]>;
+            }, context: any, info: any) => Promise<InferSelectModel<TSchema[K]>[]>;
+        };
+        [key: string]: any;
+    };
+};
+declare const buildSchemaSDL: <TDbClient extends AnyDrizzleDB<any>, TSchema extends Record<string, any> = TDbClient extends {
+    _: {
+        fullSchema: infer S;
+    };
+} ? S : Record<string, any>>(db: TDbClient, config?: BuildSchemaConfig) => BuildSchemaSDLResult<TSchema>;
+
+interface GraphQLFieldConfig {
+    type: string;
+    description?: string;
+}
+/**
+ * Helper function to customize GraphQL schema generation for specific columns.
+ * Allows you to override the default type mapping and add field descriptions.
+ *
+ * @example
+ * ```typescript
+ * import { setCustomGraphQL } from 'drizzle-graphql-plus';
+ *
+ * export const user = sqliteTable("user", {
+ *   id: text("id").primaryKey(),
+ *   email: text("email").notNull(),
+ *   createdAt: integer("created_at"),
+ * });
+ *
+ * // Customize GraphQL fields - TypeScript will autocomplete column names!
+ * setCustomGraphQL(user, {
+ *   id: { type: "ULID", description: "Unique identifier using ULID format" },
+ *   email: { type: "String", description: "User's email address" },
+ *   createdAt: { type: "DateTime", description: "Account creation timestamp" },
+ * });
+ * ```
+ *
+ * You can also use shorthand for type-only config:
+ * ```typescript
+ * setCustomGraphQL(user, {
+ *   id: "ULID",
+ *   createdAt: "DateTime",
+ * });
+ * ```
+ *
+ * Then in your server, define the custom types:
+ * ```typescript
+ * const customTypes = `
+ *   scalar ULID
+ *   scalar DateTime
+ * `;
+ * const typeDefs = customTypes + "\n" + generatedTypeDefs;
+ * ```
+ */
+declare function setCustomGraphQL<T extends Table, TColumns = ReturnType<typeof getTableColumns<T>>>(table: T, columnConfig: Partial<Record<keyof TColumns, string | GraphQLFieldConfig>>): void;
+/**
+ * @deprecated Use setCustomGraphQL instead
+ */
+declare function setCustomGraphQLTypes<T extends Table, TColumns = ReturnType<typeof getTableColumns<T>>>(table: T, columnTypes: Partial<Record<keyof TColumns, string>>): void;
+
+export { type AnyDrizzleDB, type AnyQueryBuiler, type BuildSchemaConfig, type BuildSchemaSDLResult, type DeleteArgs, type DeleteResolver, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedInterfaces, type GeneratedOutputs, type GraphQLFieldConfig, type InsertArgs, type InsertArrResolver, type InsertResolver, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type QueryArgs$1 as QueryArgs, type SelectResolver, type SelectSingleResolver, type UpdateArgs, type UpdateResolver, buildSchema, buildSchemaSDL, setCustomGraphQL, setCustomGraphQLTypes };

package/index.d.ts

@@ -1,4 +1,4 @@
-import { Table, Column, TablesRelationalConfig, TableRelationalConfig, Relations, Relation, One, Many } from 'drizzle-orm';
+import { Table, Column, TablesRelationalConfig, TableRelationalConfig, Relations, Relation, One, Many, InferSelectModel, getTableColumns } from 'drizzle-orm';
 import { MySqlDatabase } from 'drizzle-orm/mysql-core';
 import { RelationalQueryBuilder as RelationalQueryBuilder$1 } from 'drizzle-orm/mysql-core/query-builders/query';
 import { PgDatabase } from 'drizzle-orm/pg-core';
@@ -82,7 +82,7 @@ type ExtractTableByName<TTableSchema extends Record<string, Table>, TName extend
 type MutationReturnlessResult = {
     isSuccess: boolean;
 };
-type QueryArgs<TTable extends Table, isSingle extends boolean> = Partial<(isSingle extends true ? {
+type QueryArgs$1<TTable extends Table, isSingle extends boolean> = Partial<(isSingle extends true ? {
     offset: number;
 } : {
     offset: number;
@@ -103,10 +103,10 @@ type UpdateArgs<TTable extends Table> = Partial<{
 type DeleteArgs<TTable extends Table> = {
     where?: Filters<TTable>;
 };
-type SelectResolver<TTable extends Table, TTables extends Record<string, Table>, TRelations extends Record<string, Relation>> = (source: any, args: Partial<QueryArgs<TTable, false>>, context: any, info: GraphQLResolveInfo) => Promise<keyof TRelations extends infer RelKey ? RelKey extends string ? Array<GetRemappedTableDataType<TTable> & {
+type SelectResolver<TTable extends Table, TTables extends Record<string, Table>, TRelations extends Record<string, Relation>> = (source: any, args: Partial<QueryArgs$1<TTable, false>>, context: any, info: GraphQLResolveInfo) => Promise<keyof TRelations extends infer RelKey ? RelKey extends string ? Array<GetRemappedTableDataType<TTable> & {
     [K in RelKey]: TRelations[K] extends One<string> ? GetRemappedTableDataType<ExtractTableByName<TTables, TRelations[K]["referencedTableName"]> extends infer T ? T[keyof T] : never> | null : TRelations[K] extends Many<string> ? Array<GetRemappedTableDataType<ExtractTableByName<TTables, TRelations[K]["referencedTableName"]> extends infer T ? T[keyof T] : never>> : never;
 }> : Array<GetRemappedTableDataType<TTable>> : Array<GetRemappedTableDataType<TTable>>>;
-type SelectSingleResolver<TTable extends Table, TTables extends Record<string, Table>, TRelations extends Record<string, Relation>> = (source: any, args: Partial<QueryArgs<TTable, true>>, context: any, info: GraphQLResolveInfo) => Promise<(keyof TRelations extends infer RelKey ? RelKey extends string ? GetRemappedTableDataType<TTable> & {
+type SelectSingleResolver<TTable extends Table, TTables extends Record<string, Table>, TRelations extends Record<string, Relation>> = (source: any, args: Partial<QueryArgs$1<TTable, true>>, context: any, info: GraphQLResolveInfo) => Promise<(keyof TRelations extends infer RelKey ? RelKey extends string ? GetRemappedTableDataType<TTable> & {
     [K in RelKey]: TRelations[K] extends One<string> ? GetRemappedTableDataType<ExtractTableByName<TTables, TRelations[K]["referencedTableName"]> extends infer T ? T[keyof T] : never> | null : TRelations[K] extends Many<string> ? Array<GetRemappedTableDataType<ExtractTableByName<TTables, TRelations[K]["referencedTableName"]> extends infer T ? T[keyof T] : never>> : never;
 } : GetRemappedTableDataType<TTable> : GetRemappedTableDataType<TTable>) | null>;
 type InsertResolver<TTable extends Table, IsReturnless extends boolean> = (source: any, args: Partial<InsertArgs<TTable, false>>, context: any, info: GraphQLResolveInfo) => Promise<IsReturnless extends false ? Array<GetRemappedTableDataType<TTable>> : MutationReturnlessResult>;
@@ -248,4 +248,135 @@ type BuildSchemaConfig = {
 
 declare const buildSchema: <TDbClient extends AnyDrizzleDB<any>>(db: TDbClient, config?: BuildSchemaConfig) => GeneratedData<TDbClient>;
 
-export { type AnyDrizzleDB, type AnyQueryBuiler, type BuildSchemaConfig, type DeleteArgs, type DeleteResolver, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedInterfaces, type GeneratedOutputs, type InsertArgs, type InsertArrResolver, type InsertResolver, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type QueryArgs, type SelectResolver, type SelectSingleResolver, type UpdateArgs, type UpdateResolver, buildSchema };
+type Capitalize$1<S extends string> = S extends `${infer F}${infer R}` ? `${Uppercase<F>}${R}` : S;
+type ColumnFilter<T = any> = {
+    eq?: T;
+    ne?: T;
+    gt?: T;
+    gte?: T;
+    lt?: T;
+    lte?: T;
+    like?: string;
+    notLike?: string;
+    ilike?: string;
+    notIlike?: string;
+    inArray?: T[];
+    notInArray?: T[];
+    isNull?: boolean;
+    isNotNull?: boolean;
+    OR?: ColumnFilter<T>[];
+};
+type WhereInput<TTable> = TTable extends {
+    $inferSelect: infer S;
+} ? {
+    [K in keyof S]?: ColumnFilter<S[K]>;
+} & {
+    OR?: WhereInput<TTable>[];
+} : never;
+type OrderByInput<TTable> = TTable extends {
+    $inferSelect: infer S;
+} ? {
+    [K in keyof S]?: {
+        direction: "asc" | "desc";
+        priority: number;
+    };
+} : never;
+type QueryArgs<TTable> = {
+    where?: WhereInput<TTable>;
+    orderBy?: OrderByInput<TTable>;
+    limit?: number;
+    offset?: number;
+};
+type InsertInput<TTable> = TTable extends {
+    $inferInsert: infer I;
+} ? I : never;
+type UpdateInput<TTable> = TTable extends {
+    $inferInsert: infer I;
+} ? Partial<I> : never;
+type BuildSchemaSDLResult<TSchema extends Record<string, any> = Record<string, any>> = {
+    typeDefs: string;
+    resolvers: {
+        Query: {
+            [K in keyof TSchema as TSchema[K] extends {
+                $inferSelect: any;
+            } ? K : never]: (parent: any, args: QueryArgs<TSchema[K]>, context: any, info: any) => Promise<InferSelectModel<TSchema[K]>[]>;
+        };
+        Mutation: {
+            [K in keyof TSchema as TSchema[K] extends {
+                $inferSelect: any;
+            } ? `insert${Capitalize$1<K & string>}` : never]: (parent: any, args: {
+                data: InsertInput<TSchema[K]> | InsertInput<TSchema[K]>[];
+            }, context: any, info: any) => Promise<InferSelectModel<TSchema[K]>[]>;
+        } & {
+            [K in keyof TSchema as TSchema[K] extends {
+                $inferSelect: any;
+            } ? `update${Capitalize$1<K & string>}` : never]: (parent: any, args: {
+                data: UpdateInput<TSchema[K]>;
+                where: WhereInput<TSchema[K]>;
+            }, context: any, info: any) => Promise<InferSelectModel<TSchema[K]>[]>;
+        } & {
+            [K in keyof TSchema as TSchema[K] extends {
+                $inferSelect: any;
+            } ? `delete${Capitalize$1<K & string>}` : never]: (parent: any, args: {
+                where: WhereInput<TSchema[K]>;
+            }, context: any, info: any) => Promise<InferSelectModel<TSchema[K]>[]>;
+        };
+        [key: string]: any;
+    };
+};
+declare const buildSchemaSDL: <TDbClient extends AnyDrizzleDB<any>, TSchema extends Record<string, any> = TDbClient extends {
+    _: {
+        fullSchema: infer S;
+    };
+} ? S : Record<string, any>>(db: TDbClient, config?: BuildSchemaConfig) => BuildSchemaSDLResult<TSchema>;
+
+interface GraphQLFieldConfig {
+    type: string;
+    description?: string;
+}
+/**
+ * Helper function to customize GraphQL schema generation for specific columns.
+ * Allows you to override the default type mapping and add field descriptions.
+ *
+ * @example
+ * ```typescript
+ * import { setCustomGraphQL } from 'drizzle-graphql-plus';
+ *
+ * export const user = sqliteTable("user", {
+ *   id: text("id").primaryKey(),
+ *   email: text("email").notNull(),
+ *   createdAt: integer("created_at"),
+ * });
+ *
+ * // Customize GraphQL fields - TypeScript will autocomplete column names!
+ * setCustomGraphQL(user, {
+ *   id: { type: "ULID", description: "Unique identifier using ULID format" },
+ *   email: { type: "String", description: "User's email address" },
+ *   createdAt: { type: "DateTime", description: "Account creation timestamp" },
+ * });
+ * ```
+ *
+ * You can also use shorthand for type-only config:
+ * ```typescript
+ * setCustomGraphQL(user, {
+ *   id: "ULID",
+ *   createdAt: "DateTime",
+ * });
+ * ```
+ *
+ * Then in your server, define the custom types:
+ * ```typescript
+ * const customTypes = `
+ *   scalar ULID
+ *   scalar DateTime
+ * `;
+ * const typeDefs = customTypes + "\n" + generatedTypeDefs;
+ * ```
+ */
+declare function setCustomGraphQL<T extends Table, TColumns = ReturnType<typeof getTableColumns<T>>>(table: T, columnConfig: Partial<Record<keyof TColumns, string | GraphQLFieldConfig>>): void;
+/**
+ * @deprecated Use setCustomGraphQL instead
+ */
+declare function setCustomGraphQLTypes<T extends Table, TColumns = ReturnType<typeof getTableColumns<T>>>(table: T, columnTypes: Partial<Record<keyof TColumns, string>>): void;
+
+export { type AnyDrizzleDB, type AnyQueryBuiler, type BuildSchemaConfig, type BuildSchemaSDLResult, type DeleteArgs, type DeleteResolver, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedInterfaces, type GeneratedOutputs, type GraphQLFieldConfig, type InsertArgs, type InsertArrResolver, type InsertResolver, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type QueryArgs$1 as QueryArgs, type SelectResolver, type SelectSingleResolver, type UpdateArgs, type UpdateResolver, buildSchema, buildSchemaSDL, setCustomGraphQL, setCustomGraphQLTypes };