@vantreeseba/drizzle-graphql 7.5.0 → 7.6.0

package/dist/index.d.cts

@@ -251,7 +251,7 @@ declare const drizzleExecutorKey: unique symbol;
  * each dialect builder states it: `'nulls-largest'` for PostgreSQL, `'nulls-smallest'` for
  * MySQL and SQLite.
  */
-declare const createRelationResolverFactory: (db: any, tables: Record<string, Table>, nullOrdering: NullOrdering, filterCtx?: RelationFilterBase, limits?: LimitPolicyFor) => RelationResolverFactory;
+declare const createRelationResolverFactory: (db: any, tables: Record<string, Table>, nullOrdering: NullOrdering, filterCtx?: RelationFilterBase, limits?: LimitPolicyFor, scopes?: ScopeFor) => RelationResolverFactory;
 /** {@link BuildSchemaConfig.limits} resolved for one table. `undefined` means no policy. */
 type ResolvedLimitPolicy = {
     defaultLimit: number | undefined;
@@ -307,6 +307,20 @@ interface RelationFilterContext {
  */
 type RelationFilterBase = Pick<RelationFilterContext, 'tables' | 'relationMap'>;
 declare const extractFilters: <TTable extends Table>(table: TTable, tableName: string, filters: Filters<TTable>, relationCtx?: RelationFilterContext) => SQL | undefined;
+/**
+ * A table's row-level scope: the predicate every generated read, update and delete on that
+ * table is narrowed by. See `BuildSchemaConfig.scope`.
+ *
+ * `table` is the table the predicate must be built against. On the relational-query path
+ * drizzle hands its callbacks an *aliased* proxy (`d0`, `d1`, …), so a predicate built from
+ * the imported schema table would reference a name that isn't in the query — always build
+ * from the argument. Returning a filter object instead (the same shape as the field's
+ * `where`) sidesteps aliasing entirely, and is the only form that can reach through a
+ * relation — which is what ownership through a join table needs.
+ */
+type ScopeHook<TContext = any> = (context: TContext, table: any) => SQL | Record<string, any> | undefined | null;
+/** Build-time lookup: the scope configured for a table, if any. */
+type ScopeFor = (tableName: string) => ScopeHook | undefined;
 /**
  * Where a dialect's default sort places NULLs relative to non-NULL values:
  * - `nulls-largest` — PostgreSQL: NULLs sort as the largest values (last in ASC, first in DESC).
@@ -821,6 +835,34 @@ type LimitsConfig = TableLimitPolicy & {
     /** Per-table overrides, keyed by the table's key in the Drizzle schema. */
     tables?: Record<string, TableLimitPolicy>;
 };
+/**
+ * What a {@link RowScope} may return: a Drizzle `SQL` expression, a filter object in the same
+ * shape as the generated `where` argument, or `undefined`/`null` for "no restriction".
+ *
+ * The filter-object form is compiled with the same code that compiles a client `where`, so it
+ * supports relation filters — `{ author: { orgId: { eq: 1 } } }` scopes a table through a join
+ * rather than a column it owns.
+ */
+type RowScopeFilter = Record<string, any> | undefined | null;
+/**
+ * A per-table row scope: given the GraphQL context, the predicate every read and write of that
+ * table is confined to.
+ *
+ * `table` is the table instance the current statement runs against. For a relational read that
+ * is Drizzle's *aliased* copy of the table, so build the predicate from this argument rather
+ * than from the imported table object — `eq(table.orgId, ctx.orgId)` is always correct, while
+ * `eq(users.orgId, ctx.orgId)` refers to the wrong alias inside a nested read.
+ *
+ * See {@link BuildSchemaConfig.scope}.
+ */
+type RowScope<TContext = any> = (context: TContext, table: any) => RowScopeFilter | object;
+/** {@link BuildSchemaConfig.scope} — a row scope per table, keyed by the Drizzle schema key. */
+type ScopeConfig<TContext = any> = Record<string, RowScope<TContext>>;
+/**
+ * {@link BuildSchemaConfig.contextValues} — columns whose value the server derives from the
+ * request context, keyed by Drizzle schema key and then by column property name.
+ */
+type ContextValuesConfig<TContext = any> = Record<string, Record<string, (context: TContext) => any>>;
 /**
  * {@link BuildSchemaConfig.exclude} — tables and columns to keep out of the generated schema.
  *
@@ -1049,6 +1091,66 @@ type BuildSchemaConfig = {
      *   agree.
      */
     limits?: LimitsConfig;
+    /**
+     * Row-level scoping: a predicate, derived from the GraphQL context, that every read and
+     * write of a table is confined to. This is the multi-tenancy / ownership knob — the one
+     * rule a wrapper cannot enforce from outside, because a nested relation field never passes
+     * through a root resolver.
+     *
+     * ```ts
+     * import { and, eq } from 'drizzle-orm';
+     *
+     * buildSchema(db, {
+     *   scope: {
+     *     posts: (ctx, table) => eq(table.orgId, ctx.orgId),
+     *     // A filter object works too, and can scope through a relation:
+     *     comments: (ctx) => ({ post: { orgId: { eq: ctx.orgId } } }),
+     *   },
+     * });
+     * ```
+     *
+     * - The predicate is ANDed on **last**, after the client's `where`, so a client filter can
+     *   only ever narrow the scope, never widen it.
+     * - It applies to every path that reads the table: list and single queries, aggregates and
+     *   `groupBy`, relation fields (batched and eager), relation aggregates, and cursor pages.
+     * - It applies to every path that writes it: `update`, `updateMany`, `delete`, the
+     *   conflict-update half of an upsert (PostgreSQL and SQLite), and the rows a nested
+     *   `connect` / `disconnect` / `set` is allowed to reach. An out-of-scope row is simply not
+     *   matched — a scoped `delete` reports zero rows rather than refusing.
+     * - It cannot apply to a plain `insert`: there is no existing row to filter. Use
+     *   {@link BuildSchemaConfig.contextValues} to stamp the owning column on the way in.
+     * - `table` is the table the current statement runs against, which for a relational read is
+     *   Drizzle's aliased copy — always build the predicate from that argument.
+     * - Returning `undefined` means "no restriction for this context", so a hook can let an
+     *   admin through. A table with no entry is unscoped.
+     * - MySQL's `ON DUPLICATE KEY UPDATE` takes no predicate, so a MySQL upsert cannot be
+     *   scoped on the conflict path; scope the table's `update` and rely on `contextValues`
+     *   for the insert half.
+     */
+    scope?: ScopeConfig;
+    /**
+     * Columns whose value the server derives from the request context rather than accepting
+     * from the client — the write-side half of {@link BuildSchemaConfig.scope}.
+     *
+     * ```ts
+     * buildSchema(db, {
+     *   contextValues: {
+     *     posts: {
+     *       orgId: (ctx) => ctx.orgId,
+     *       authorId: (ctx) => ctx.userId,
+     *     },
+     *   },
+     * });
+     * ```
+     *
+     * - The column is removed from the generated insert and update inputs, so a client cannot
+     *   send it at all — the schema itself documents that it is server-owned.
+     * - Every insert stamps it, including the rows created by a nested `create`.
+     * - Updates never write it: an update cannot hand a row to another owner.
+     * - Keyed by the Drizzle schema key, then by the column's property name (not its database
+     *   name), the same keying {@link BuildSchemaConfig.exclude} uses.
+     */
+    contextValues?: ContextValuesConfig;
     /**
      * Tables and columns to leave out of the generated schema entirely.
      *
@@ -1511,4 +1613,4 @@ declare const resolveSelection: (info: GraphQLResolveInfo | ResolveTree, options
 
 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 DrizzleExtension, type DrizzleFieldExtension, type DrizzleFieldKind, type DrizzleFieldOperation, type DrizzleTargetArg, type DrizzleTypeExtension, type EnumNameInfo, type EnumNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type FeatureSwitch, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, GraphQLDecimalString, type IdentifiedRows, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ResolveSelectionOptions, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type SelectResolver, type SelectSingleResolver, type SelectionOptions, 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, drizzleExtension, extractFilters, extractOrderBy, extractRelationJoinColumns, identifyRows, isDrizzleFieldExtension, resolveSelection, selectionToWith, singularizeMapper };
+export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type ContextValuesConfig, type DeleteResolver, type DeleteSingleResolver, type DrizzleExtension, type DrizzleFieldExtension, type DrizzleFieldKind, type DrizzleFieldOperation, type DrizzleTargetArg, type DrizzleTypeExtension, type EnumNameInfo, type EnumNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type FeatureSwitch, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, GraphQLDecimalString, type IdentifiedRows, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ResolveSelectionOptions, type RowScope, type RowScopeFilter, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type ScopeConfig, type SelectResolver, type SelectSingleResolver, type SelectionOptions, 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, drizzleExtension, extractFilters, extractOrderBy, extractRelationJoinColumns, identifyRows, isDrizzleFieldExtension, resolveSelection, selectionToWith, singularizeMapper };

package/dist/index.d.ts

@@ -251,7 +251,7 @@ declare const drizzleExecutorKey: unique symbol;
  * each dialect builder states it: `'nulls-largest'` for PostgreSQL, `'nulls-smallest'` for
  * MySQL and SQLite.
  */
-declare const createRelationResolverFactory: (db: any, tables: Record<string, Table>, nullOrdering: NullOrdering, filterCtx?: RelationFilterBase, limits?: LimitPolicyFor) => RelationResolverFactory;
+declare const createRelationResolverFactory: (db: any, tables: Record<string, Table>, nullOrdering: NullOrdering, filterCtx?: RelationFilterBase, limits?: LimitPolicyFor, scopes?: ScopeFor) => RelationResolverFactory;
 /** {@link BuildSchemaConfig.limits} resolved for one table. `undefined` means no policy. */
 type ResolvedLimitPolicy = {
     defaultLimit: number | undefined;
@@ -307,6 +307,20 @@ interface RelationFilterContext {
  */
 type RelationFilterBase = Pick<RelationFilterContext, 'tables' | 'relationMap'>;
 declare const extractFilters: <TTable extends Table>(table: TTable, tableName: string, filters: Filters<TTable>, relationCtx?: RelationFilterContext) => SQL | undefined;
+/**
+ * A table's row-level scope: the predicate every generated read, update and delete on that
+ * table is narrowed by. See `BuildSchemaConfig.scope`.
+ *
+ * `table` is the table the predicate must be built against. On the relational-query path
+ * drizzle hands its callbacks an *aliased* proxy (`d0`, `d1`, …), so a predicate built from
+ * the imported schema table would reference a name that isn't in the query — always build
+ * from the argument. Returning a filter object instead (the same shape as the field's
+ * `where`) sidesteps aliasing entirely, and is the only form that can reach through a
+ * relation — which is what ownership through a join table needs.
+ */
+type ScopeHook<TContext = any> = (context: TContext, table: any) => SQL | Record<string, any> | undefined | null;
+/** Build-time lookup: the scope configured for a table, if any. */
+type ScopeFor = (tableName: string) => ScopeHook | undefined;
 /**
  * Where a dialect's default sort places NULLs relative to non-NULL values:
  * - `nulls-largest` — PostgreSQL: NULLs sort as the largest values (last in ASC, first in DESC).
@@ -821,6 +835,34 @@ type LimitsConfig = TableLimitPolicy & {
     /** Per-table overrides, keyed by the table's key in the Drizzle schema. */
     tables?: Record<string, TableLimitPolicy>;
 };
+/**
+ * What a {@link RowScope} may return: a Drizzle `SQL` expression, a filter object in the same
+ * shape as the generated `where` argument, or `undefined`/`null` for "no restriction".
+ *
+ * The filter-object form is compiled with the same code that compiles a client `where`, so it
+ * supports relation filters — `{ author: { orgId: { eq: 1 } } }` scopes a table through a join
+ * rather than a column it owns.
+ */
+type RowScopeFilter = Record<string, any> | undefined | null;
+/**
+ * A per-table row scope: given the GraphQL context, the predicate every read and write of that
+ * table is confined to.
+ *
+ * `table` is the table instance the current statement runs against. For a relational read that
+ * is Drizzle's *aliased* copy of the table, so build the predicate from this argument rather
+ * than from the imported table object — `eq(table.orgId, ctx.orgId)` is always correct, while
+ * `eq(users.orgId, ctx.orgId)` refers to the wrong alias inside a nested read.
+ *
+ * See {@link BuildSchemaConfig.scope}.
+ */
+type RowScope<TContext = any> = (context: TContext, table: any) => RowScopeFilter | object;
+/** {@link BuildSchemaConfig.scope} — a row scope per table, keyed by the Drizzle schema key. */
+type ScopeConfig<TContext = any> = Record<string, RowScope<TContext>>;
+/**
+ * {@link BuildSchemaConfig.contextValues} — columns whose value the server derives from the
+ * request context, keyed by Drizzle schema key and then by column property name.
+ */
+type ContextValuesConfig<TContext = any> = Record<string, Record<string, (context: TContext) => any>>;
 /**
  * {@link BuildSchemaConfig.exclude} — tables and columns to keep out of the generated schema.
  *
@@ -1049,6 +1091,66 @@ type BuildSchemaConfig = {
      *   agree.
      */
     limits?: LimitsConfig;
+    /**
+     * Row-level scoping: a predicate, derived from the GraphQL context, that every read and
+     * write of a table is confined to. This is the multi-tenancy / ownership knob — the one
+     * rule a wrapper cannot enforce from outside, because a nested relation field never passes
+     * through a root resolver.
+     *
+     * ```ts
+     * import { and, eq } from 'drizzle-orm';
+     *
+     * buildSchema(db, {
+     *   scope: {
+     *     posts: (ctx, table) => eq(table.orgId, ctx.orgId),
+     *     // A filter object works too, and can scope through a relation:
+     *     comments: (ctx) => ({ post: { orgId: { eq: ctx.orgId } } }),
+     *   },
+     * });
+     * ```
+     *
+     * - The predicate is ANDed on **last**, after the client's `where`, so a client filter can
+     *   only ever narrow the scope, never widen it.
+     * - It applies to every path that reads the table: list and single queries, aggregates and
+     *   `groupBy`, relation fields (batched and eager), relation aggregates, and cursor pages.
+     * - It applies to every path that writes it: `update`, `updateMany`, `delete`, the
+     *   conflict-update half of an upsert (PostgreSQL and SQLite), and the rows a nested
+     *   `connect` / `disconnect` / `set` is allowed to reach. An out-of-scope row is simply not
+     *   matched — a scoped `delete` reports zero rows rather than refusing.
+     * - It cannot apply to a plain `insert`: there is no existing row to filter. Use
+     *   {@link BuildSchemaConfig.contextValues} to stamp the owning column on the way in.
+     * - `table` is the table the current statement runs against, which for a relational read is
+     *   Drizzle's aliased copy — always build the predicate from that argument.
+     * - Returning `undefined` means "no restriction for this context", so a hook can let an
+     *   admin through. A table with no entry is unscoped.
+     * - MySQL's `ON DUPLICATE KEY UPDATE` takes no predicate, so a MySQL upsert cannot be
+     *   scoped on the conflict path; scope the table's `update` and rely on `contextValues`
+     *   for the insert half.
+     */
+    scope?: ScopeConfig;
+    /**
+     * Columns whose value the server derives from the request context rather than accepting
+     * from the client — the write-side half of {@link BuildSchemaConfig.scope}.
+     *
+     * ```ts
+     * buildSchema(db, {
+     *   contextValues: {
+     *     posts: {
+     *       orgId: (ctx) => ctx.orgId,
+     *       authorId: (ctx) => ctx.userId,
+     *     },
+     *   },
+     * });
+     * ```
+     *
+     * - The column is removed from the generated insert and update inputs, so a client cannot
+     *   send it at all — the schema itself documents that it is server-owned.
+     * - Every insert stamps it, including the rows created by a nested `create`.
+     * - Updates never write it: an update cannot hand a row to another owner.
+     * - Keyed by the Drizzle schema key, then by the column's property name (not its database
+     *   name), the same keying {@link BuildSchemaConfig.exclude} uses.
+     */
+    contextValues?: ContextValuesConfig;
     /**
      * Tables and columns to leave out of the generated schema entirely.
      *
@@ -1511,4 +1613,4 @@ declare const resolveSelection: (info: GraphQLResolveInfo | ResolveTree, options
 
 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 DrizzleExtension, type DrizzleFieldExtension, type DrizzleFieldKind, type DrizzleFieldOperation, type DrizzleTargetArg, type DrizzleTypeExtension, type EnumNameInfo, type EnumNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type FeatureSwitch, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, GraphQLDecimalString, type IdentifiedRows, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ResolveSelectionOptions, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type SelectResolver, type SelectSingleResolver, type SelectionOptions, 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, drizzleExtension, extractFilters, extractOrderBy, extractRelationJoinColumns, identifyRows, isDrizzleFieldExtension, resolveSelection, selectionToWith, singularizeMapper };
+export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ColumnDeprecator, type ColumnDescriber, type ColumnDocInfo, type ColumnTypeMapper, type ColumnTypeMapperInfo, type ComplexityConfig, type ContextValuesConfig, type DeleteResolver, type DeleteSingleResolver, type DrizzleExtension, type DrizzleFieldExtension, type DrizzleFieldKind, type DrizzleFieldOperation, type DrizzleTargetArg, type DrizzleTypeExtension, type EnumNameInfo, type EnumNameMapper, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type FeatureSwitch, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, GraphQLDecimalString, type IdentifiedRows, type InsertArrResolver, type InsertResolver, type LimitsConfig, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationDescriber, type RelationResolverFactory, type ResolveSelectionOptions, type RowScope, type RowScopeFilter, type ScalarOverride, type ScalarOverridesConfig, type SchemaDocs, type SchemaExclusions, type SchemaFeatures, type ScopeConfig, type SelectResolver, type SelectSingleResolver, type SelectionOptions, 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, drizzleExtension, extractFilters, extractOrderBy, extractRelationJoinColumns, identifyRows, isDrizzleFieldExtension, resolveSelection, selectionToWith, singularizeMapper };