drizzle-graphql-plus 0.8.13 → 0.8.15

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, 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';
@@ -248,4 +248,59 @@ 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 BuildSchemaSDLResult = {
+    typeDefs: string;
+    resolvers: Record<string, any>;
+};
+declare const buildSchemaSDL: <TDbClient extends AnyDrizzleDB<any>>(db: TDbClient, config?: BuildSchemaConfig) => BuildSchemaSDLResult;
+
+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, 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, 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';
@@ -248,4 +248,59 @@ 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 BuildSchemaSDLResult = {
+    typeDefs: string;
+    resolvers: Record<string, any>;
+};
+declare const buildSchemaSDL: <TDbClient extends AnyDrizzleDB<any>>(db: TDbClient, config?: BuildSchemaConfig) => BuildSchemaSDLResult;
+
+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, type SelectResolver, type SelectSingleResolver, type UpdateArgs, type UpdateResolver, buildSchema, buildSchemaSDL, setCustomGraphQL, setCustomGraphQLTypes };