@vantreeseba/drizzle-graphql 14.0.0 → 15.1.0

package/dist/index.d.cts

@@ -6,7 +6,7 @@ import "drizzle-orm/pg-core/query-builders/query";
 import { SQLiteAsyncDatabase } from "drizzle-orm/sqlite-core";
 import "drizzle-orm/sqlite-core/query-builders/query";
 import { ASTNode, GraphQLEnumType, GraphQLError, GraphQLFieldResolver, GraphQLInputObjectType, GraphQLInputType, GraphQLList, GraphQLNonNull, GraphQLObjectType, GraphQLOutputType, GraphQLResolveInfo, GraphQLScalarType, GraphQLSchema } from "graphql";
-import { GraphQLDate, GraphQLDateTime, GraphQLJSON, GraphQLUUID } from "graphql-scalars";
+import { GraphQLDateTime, GraphQLJSON, GraphQLUUID } from "graphql-scalars";
 //#region src/util/type-naming.d.ts
 /** A word the rules decline to decide. Widens the keys derived from it rather than guessing. */
 type Unresolved = string;
@@ -458,7 +458,9 @@ type DrizzleErrorCode =
 /** A stored value could not be represented by the scalar that transports it. */
 'DRIZZLE_UNREPRESENTABLE_VALUE' |
 /** The request's shared mutation transaction was rolled back, so this field never ran. */
-'DRIZZLE_TRANSACTION_ABORTED';
+'DRIZZLE_TRANSACTION_ABORTED' |
+/** A relation was read on a path it cannot be loaded through (see the message). */
+'DRIZZLE_UNSUPPORTED_RELATION';
 /**
  * What an error was about, published as `extensions.drizzle` beside the code — the runtime
  * half of the `extensions.drizzle` markers a generated field carries.
@@ -607,8 +609,11 @@ type ColumnDescriber = (column: Column, info: ColumnDocInfo) => string | undefin
  * `BuildSchemaConfig.deprecateColumn`.
  */
 type ColumnDeprecator = (column: Column, info: ColumnDocInfo) => string | undefined;
-/** Supplies the GraphQL `description` for a table's object type. See `BuildSchemaConfig.describeTable`. */
-type TableDescriber = (tableName: string) => string | undefined;
+/**
+ * Supplies the GraphQL `description` for a table's object type. Receives the Drizzle table
+ * itself as well as its schema key. See `BuildSchemaConfig.describeTable`.
+ */
+type TableDescriber = (tableName: string, table: Table) => string | undefined;
 /**
  * Supplies the GraphQL `description` for a relation field. See
  * `BuildSchemaConfig.describeRelation`.
@@ -2444,6 +2449,17 @@ type BuildSchemaConfig = {
    * ```ts
    * buildSchema(db, { describeTable: (tableName) => tableDocs[tableName] });
    * ```
+   *
+   * The second argument is the Drizzle table itself, so documentation attached to the table
+   * where it is declared can be read straight off it:
+   *
+   * ```ts
+   * const tableDocs = new WeakMap<object, string>();
+   * export const Users = pgTable('users', { ... });
+   * tableDocs.set(Users, 'A person who can sign in.');
+   *
+   * buildSchema(db, { describeTable: (_tableName, table) => tableDocs.get(table) });
+   * ```
    */
   describeTable?: TableDescriber;
   /**
@@ -2570,6 +2586,18 @@ declare const GraphQLBigIntString: GraphQLScalarType<string, string>;
  * non-numeric strings (including 'NaN' and 'Infinity').
  */
 declare const GraphQLDecimalString: GraphQLScalarType<string, string>;
+/**
+ * A calendar day — `date` columns, whichever `mode` drizzle reads them in. Always transported
+ * as an RFC 3339 `full-date` string (`YYYY-MM-DD`), in both directions: it has no time and no
+ * offset, so there is nothing for a client's timezone to shift. `graphql-scalars`' own
+ * `GraphQLDate` is deliberately not used: its `parseValue` returns a JS `Date`, so the same
+ * scalar would be a string on the way out and an instant on the way in.
+ *
+ * Input accepts only a `YYYY-MM-DD` string naming a real day (`2026-02-30` and datetime
+ * strings are rejected) and hands it on unchanged. Output also accepts a JS `Date`, read as
+ * the UTC day it encodes.
+ */
+declare const GraphQLDate: GraphQLScalarType<string, string>;
 //#endregion
 //#region src/util/selection.d.ts
 /** Options shared by {@link selectionToWith} and {@link resolveSelection}. */

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { MySqlAsyncDatabase } from "drizzle-orm/mysql-core";
 import { PgAsyncDatabase } from "drizzle-orm/pg-core";
 import { SQLiteAsyncDatabase } from "drizzle-orm/sqlite-core";
 import { ASTNode, GraphQLEnumType, GraphQLError, GraphQLFieldResolver, GraphQLInputObjectType, GraphQLInputType, GraphQLList, GraphQLNonNull, GraphQLObjectType, GraphQLOutputType, GraphQLResolveInfo, GraphQLScalarType, GraphQLSchema } from "graphql";
-import { GraphQLDate, GraphQLDateTime, GraphQLJSON, GraphQLUUID } from "graphql-scalars";
+import { GraphQLDateTime, GraphQLJSON, GraphQLUUID } from "graphql-scalars";
 import "drizzle-orm/mysql-core/query-builders/query";
 import "drizzle-orm/pg-core/query-builders/query";
 import "drizzle-orm/sqlite-core/query-builders/query";
@@ -458,7 +458,9 @@ type DrizzleErrorCode =
 /** A stored value could not be represented by the scalar that transports it. */
 'DRIZZLE_UNREPRESENTABLE_VALUE' |
 /** The request's shared mutation transaction was rolled back, so this field never ran. */
-'DRIZZLE_TRANSACTION_ABORTED';
+'DRIZZLE_TRANSACTION_ABORTED' |
+/** A relation was read on a path it cannot be loaded through (see the message). */
+'DRIZZLE_UNSUPPORTED_RELATION';
 /**
  * What an error was about, published as `extensions.drizzle` beside the code — the runtime
  * half of the `extensions.drizzle` markers a generated field carries.
@@ -607,8 +609,11 @@ type ColumnDescriber = (column: Column, info: ColumnDocInfo) => string | undefin
  * `BuildSchemaConfig.deprecateColumn`.
  */
 type ColumnDeprecator = (column: Column, info: ColumnDocInfo) => string | undefined;
-/** Supplies the GraphQL `description` for a table's object type. See `BuildSchemaConfig.describeTable`. */
-type TableDescriber = (tableName: string) => string | undefined;
+/**
+ * Supplies the GraphQL `description` for a table's object type. Receives the Drizzle table
+ * itself as well as its schema key. See `BuildSchemaConfig.describeTable`.
+ */
+type TableDescriber = (tableName: string, table: Table) => string | undefined;
 /**
  * Supplies the GraphQL `description` for a relation field. See
  * `BuildSchemaConfig.describeRelation`.
@@ -2444,6 +2449,17 @@ type BuildSchemaConfig = {
    * ```ts
    * buildSchema(db, { describeTable: (tableName) => tableDocs[tableName] });
    * ```
+   *
+   * The second argument is the Drizzle table itself, so documentation attached to the table
+   * where it is declared can be read straight off it:
+   *
+   * ```ts
+   * const tableDocs = new WeakMap<object, string>();
+   * export const Users = pgTable('users', { ... });
+   * tableDocs.set(Users, 'A person who can sign in.');
+   *
+   * buildSchema(db, { describeTable: (_tableName, table) => tableDocs.get(table) });
+   * ```
    */
   describeTable?: TableDescriber;
   /**
@@ -2570,6 +2586,18 @@ declare const GraphQLBigIntString: GraphQLScalarType<string, string>;
  * non-numeric strings (including 'NaN' and 'Infinity').
  */
 declare const GraphQLDecimalString: GraphQLScalarType<string, string>;
+/**
+ * A calendar day — `date` columns, whichever `mode` drizzle reads them in. Always transported
+ * as an RFC 3339 `full-date` string (`YYYY-MM-DD`), in both directions: it has no time and no
+ * offset, so there is nothing for a client's timezone to shift. `graphql-scalars`' own
+ * `GraphQLDate` is deliberately not used: its `parseValue` returns a JS `Date`, so the same
+ * scalar would be a string on the way out and an instant on the way in.
+ *
+ * Input accepts only a `YYYY-MM-DD` string naming a real day (`2026-02-30` and datetime
+ * strings are rejected) and hands it on unchanged. Output also accepts a JS `Date`, read as
+ * the UTC day it encodes.
+ */
+declare const GraphQLDate: GraphQLScalarType<string, string>;
 //#endregion
 //#region src/util/selection.d.ts
 /** Options shared by {@link selectionToWith} and {@link resolveSelection}. */