@vantreeseba/drizzle-graphql 7.1.0 → 7.3.0

package/dist/index.d.cts

@@ -188,6 +188,12 @@ type OrderByArgs<TTable extends Table> = {
          * emulated with an extra `IS NULL` sort key on MySQL.
          */
         nulls?: 'first' | 'last';
+        /**
+         * Sort by the column's position in the `inArray` list the same request's `where` gives
+         * it, rather than by the column's own value. Requires that `inArray` filter; cannot be
+         * combined with `after` or `distinct`.
+         */
+        matchFilterOrder?: boolean;
     };
 };
 
@@ -262,10 +268,13 @@ type LimitPolicyFor = (tableName: string) => ResolvedLimitPolicy | undefined;
  * across relation boundaries. Each entry may also carry `nulls: first | last`
  * (see {@link orderExpressions} for how MySQL emulates it).
  *
+ * An entry may instead set `matchFilterOrder`, which sorts by the column's position in the
+ * `inArray` list the same request's `where` gives it — `whereArgs` is that `where`.
+ *
  * `ctx` supplies the tables and relation map that relation ordering needs; callers whose
  * inputs cannot contain relation keys may omit it.
  */
-declare const extractOrderBy: <TTable extends Table, TArgs extends OrderByArgs<any> = OrderByArgs<TTable>>(table: TTable, orderArgs: TArgs, ctx?: RelationFilterContext) => SQL[];
+declare const extractOrderBy: <TTable extends Table, TArgs extends OrderByArgs<any> = OrderByArgs<TTable>>(table: TTable, orderArgs: TArgs, ctx?: RelationFilterContext, whereArgs?: Record<string, any>) => SQL[];
 /**
  * Everything `extractFilters` needs to turn a relation key in a `where` argument into a
  * correlated subquery. Omitted by callers that don't generate relation filters, in which case
@@ -794,6 +803,21 @@ type LimitsConfig = TableLimitPolicy & {
     /** Per-table overrides, keyed by the table's key in the Drizzle schema. */
     tables?: Record<string, TableLimitPolicy>;
 };
+/**
+ * {@link BuildSchemaConfig.exclude} — tables and columns to keep out of the generated schema.
+ *
+ * Both lists are keyed by the Drizzle schema key, not the database name and not the generated
+ * GraphQL name.
+ */
+type SchemaExclusions = {
+    /**
+     * Tables that generate nothing at all: no object type, no queries, no mutations, and no
+     * relation fields on other tables that point at them.
+     */
+    tables?: string[];
+    /** Per-table column exclusions, keyed by the table's key in the Drizzle schema. */
+    columns?: Record<string, string[]>;
+};
 type BuildSchemaConfig = {
     /**
      * Determines whether generated mutations will be passed to returned schema.
@@ -982,6 +1006,36 @@ type BuildSchemaConfig = {
      *   agree.
      */
     limits?: LimitsConfig;
+    /**
+     * Tables and columns to leave out of the generated schema entirely.
+     *
+     * ```ts
+     * buildSchema(db, {
+     *   exclude: {
+     *     tables: ['magicLinks', 'sessions'],
+     *     columns: { apiKeys: ['keyHash'] },
+     *   },
+     * });
+     * ```
+     *
+     * An excluded **table** generates nothing: no object type, no root queries or mutations, no
+     * aggregates, and no relation field on any other table that points at it. Filtering another
+     * table by a relation to it is gone too, so it is unreachable rather than merely unnamed.
+     *
+     * An excluded **column** disappears from every surface at once — the object type, the
+     * create/update/upsert inputs, the filter type, `orderBy`, the aggregate fields, the
+     * `distinct` and `groupBy` enums, and the upsert conflict targets. The exclusion is
+     * deliberately all-or-nothing: a column you can filter on but not select is an oracle, since
+     * `where: { keyHash: { eq: '…' } }` confirms a value without ever returning it.
+     *
+     * Excluding a `NOT NULL` column that has no default makes that table's inserts impossible to
+     * satisfy — `buildSchema` warns on the console when it sees this, and still builds, since a
+     * read-only table is a reasonable thing to want.
+     *
+     * Names that match nothing throw, so a renamed column fails the build instead of quietly
+     * un-hiding itself.
+     */
+    exclude?: SchemaExclusions;
     /**
      * Optional mapper from table key to singular/plural name pair.
      * When provided for a table, overrides the default (table key) naming for GraphQL type names,
@@ -1210,4 +1264,4 @@ declare const GraphQLDecimalString: GraphQLScalarType<string, string>;
 
 declare const buildSchema: <TDbClient extends AnyDrizzleDB<any>>(db: TDbClient, config?: BuildSchemaConfig) => GeneratedData<TDbClient>;
 
-export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type DeleteResolver, type DeleteSingleResolver, type EnumNameInfo, type EnumNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, GraphQLDecimalString, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaFeatures, type SelectResolver, type SelectSingleResolver, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, type UpdateManyArgs, type UpdateManyEntry, type UpdateManyResolver, type UpdateResolver, type UpdateSingleResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleExecutorKey, extractFilters, extractOrderBy, extractRelationJoinColumns };
+export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type DeleteResolver, type DeleteSingleResolver, type EnumNameInfo, type EnumNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, GraphQLDecimalString, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type SelectResolver, type SelectSingleResolver, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, type UpdateManyArgs, type UpdateManyEntry, type UpdateManyResolver, type UpdateResolver, type UpdateSingleResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleExecutorKey, extractFilters, extractOrderBy, extractRelationJoinColumns };

package/dist/index.d.ts

@@ -188,6 +188,12 @@ type OrderByArgs<TTable extends Table> = {
          * emulated with an extra `IS NULL` sort key on MySQL.
          */
         nulls?: 'first' | 'last';
+        /**
+         * Sort by the column's position in the `inArray` list the same request's `where` gives
+         * it, rather than by the column's own value. Requires that `inArray` filter; cannot be
+         * combined with `after` or `distinct`.
+         */
+        matchFilterOrder?: boolean;
     };
 };
 
@@ -262,10 +268,13 @@ type LimitPolicyFor = (tableName: string) => ResolvedLimitPolicy | undefined;
  * across relation boundaries. Each entry may also carry `nulls: first | last`
  * (see {@link orderExpressions} for how MySQL emulates it).
  *
+ * An entry may instead set `matchFilterOrder`, which sorts by the column's position in the
+ * `inArray` list the same request's `where` gives it — `whereArgs` is that `where`.
+ *
  * `ctx` supplies the tables and relation map that relation ordering needs; callers whose
  * inputs cannot contain relation keys may omit it.
  */
-declare const extractOrderBy: <TTable extends Table, TArgs extends OrderByArgs<any> = OrderByArgs<TTable>>(table: TTable, orderArgs: TArgs, ctx?: RelationFilterContext) => SQL[];
+declare const extractOrderBy: <TTable extends Table, TArgs extends OrderByArgs<any> = OrderByArgs<TTable>>(table: TTable, orderArgs: TArgs, ctx?: RelationFilterContext, whereArgs?: Record<string, any>) => SQL[];
 /**
  * Everything `extractFilters` needs to turn a relation key in a `where` argument into a
  * correlated subquery. Omitted by callers that don't generate relation filters, in which case
@@ -794,6 +803,21 @@ type LimitsConfig = TableLimitPolicy & {
     /** Per-table overrides, keyed by the table's key in the Drizzle schema. */
     tables?: Record<string, TableLimitPolicy>;
 };
+/**
+ * {@link BuildSchemaConfig.exclude} — tables and columns to keep out of the generated schema.
+ *
+ * Both lists are keyed by the Drizzle schema key, not the database name and not the generated
+ * GraphQL name.
+ */
+type SchemaExclusions = {
+    /**
+     * Tables that generate nothing at all: no object type, no queries, no mutations, and no
+     * relation fields on other tables that point at them.
+     */
+    tables?: string[];
+    /** Per-table column exclusions, keyed by the table's key in the Drizzle schema. */
+    columns?: Record<string, string[]>;
+};
 type BuildSchemaConfig = {
     /**
      * Determines whether generated mutations will be passed to returned schema.
@@ -982,6 +1006,36 @@ type BuildSchemaConfig = {
      *   agree.
      */
     limits?: LimitsConfig;
+    /**
+     * Tables and columns to leave out of the generated schema entirely.
+     *
+     * ```ts
+     * buildSchema(db, {
+     *   exclude: {
+     *     tables: ['magicLinks', 'sessions'],
+     *     columns: { apiKeys: ['keyHash'] },
+     *   },
+     * });
+     * ```
+     *
+     * An excluded **table** generates nothing: no object type, no root queries or mutations, no
+     * aggregates, and no relation field on any other table that points at it. Filtering another
+     * table by a relation to it is gone too, so it is unreachable rather than merely unnamed.
+     *
+     * An excluded **column** disappears from every surface at once — the object type, the
+     * create/update/upsert inputs, the filter type, `orderBy`, the aggregate fields, the
+     * `distinct` and `groupBy` enums, and the upsert conflict targets. The exclusion is
+     * deliberately all-or-nothing: a column you can filter on but not select is an oracle, since
+     * `where: { keyHash: { eq: '…' } }` confirms a value without ever returning it.
+     *
+     * Excluding a `NOT NULL` column that has no default makes that table's inserts impossible to
+     * satisfy — `buildSchema` warns on the console when it sees this, and still builds, since a
+     * read-only table is a reasonable thing to want.
+     *
+     * Names that match nothing throw, so a renamed column fails the build instead of quietly
+     * un-hiding itself.
+     */
+    exclude?: SchemaExclusions;
     /**
      * Optional mapper from table key to singular/plural name pair.
      * When provided for a table, overrides the default (table key) naming for GraphQL type names,
@@ -1210,4 +1264,4 @@ declare const GraphQLDecimalString: GraphQLScalarType<string, string>;
 
 declare const buildSchema: <TDbClient extends AnyDrizzleDB<any>>(db: TDbClient, config?: BuildSchemaConfig) => GeneratedData<TDbClient>;
 
-export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type DeleteResolver, type DeleteSingleResolver, type EnumNameInfo, type EnumNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, GraphQLDecimalString, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaFeatures, type SelectResolver, type SelectSingleResolver, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, type UpdateManyArgs, type UpdateManyEntry, type UpdateManyResolver, type UpdateResolver, type UpdateSingleResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleExecutorKey, extractFilters, extractOrderBy, extractRelationJoinColumns };
+export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type DeleteResolver, type DeleteSingleResolver, type EnumNameInfo, type EnumNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, GraphQLDecimalString, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type SelectResolver, type SelectSingleResolver, type TableDescriber, type TableLimitPolicy, type TableNamedRelations, type UpdateManyArgs, type UpdateManyEntry, type UpdateManyResolver, type UpdateResolver, type UpdateSingleResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleExecutorKey, extractFilters, extractOrderBy, extractRelationJoinColumns };