@vantreeseba/drizzle-graphql 4.0.0 → 4.1.0

package/dist/index.d.cts

@@ -419,6 +419,26 @@ type SchemaFeatures = {
      */
     upsert?: boolean;
 };
+/**
+ * Per-field cost hints for `graphql-query-complexity` (or any estimator that reads
+ * `extensions.complexity`). See {@link BuildSchemaConfig.complexity}.
+ */
+type ComplexityConfig = {
+    /**
+     * Rows a list field is assumed to return when the query passes no `limit`. Raise it if your
+     * tables are large and clients routinely omit `limit`.
+     *
+     * @default 10
+     */
+    defaultListSize?: number;
+    /**
+     * Flat cost charged for an aggregate field, on top of whatever is selected inside it. An
+     * aggregate returns one row but reads however many match, so it is priced as a scan.
+     *
+     * @default 10
+     */
+    aggregateCost?: number;
+};
 type BuildSchemaConfig = {
     /**
      * Determines whether generated mutations will be passed to returned schema.
@@ -487,6 +507,31 @@ type BuildSchemaConfig = {
      * until the next major.
      */
     conflictDoNothing?: boolean;
+    /**
+     * Cost hints published as `extensions.complexity` on the generated fields, for
+     * `graphql-query-complexity`'s `fieldExtensionsEstimator`.
+     *
+     * The generator knows which fields are paginated and which are aggregates, so a list field is
+     * priced at `(limit ?? defaultListSize) * childComplexity` and an aggregate at
+     * `aggregateCost + childComplexity`. Everything else is left alone and falls through to your
+     * estimator's default. The hints are inert until you install a complexity rule, so they are on
+     * by default; pass `false` to omit them.
+     *
+     * Cost is not a depth bound — a cyclic relation graph still lets a client nest arbitrarily
+     * deep. Put a depth limit in front of a publicly exposed schema as well.
+     *
+     * ```ts
+     * import { createComplexityRule, fieldExtensionsEstimator, simpleEstimator } from 'graphql-query-complexity';
+     *
+     * const rule = createComplexityRule({
+     *   maximumComplexity: 1000,
+     *   estimators: [fieldExtensionsEstimator(), simpleEstimator({ defaultComplexity: 1 })],
+     * });
+     * ```
+     *
+     * @default true
+     */
+    complexity?: boolean | ComplexityConfig;
     /**
      * Turns individual generated features off.
      *
@@ -594,4 +639,4 @@ declare const GraphQLBigIntString: GraphQLScalarType<string, string>;
 
 declare const buildSchema: <TDbClient extends AnyDrizzleDB<any>>(db: TDbClient, config?: BuildSchemaConfig) => GeneratedData<TDbClient>;
 
-export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type DeleteResolver, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, type InsertArrResolver, type InsertResolver, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationResolverFactory, type SchemaFeatures, type SelectResolver, type SelectSingleResolver, type TableNamedRelations, type UpdateResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleExecutorKey, extractFilters, extractOrderBy, extractRelationJoinColumns };
+export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ComplexityConfig, type DeleteResolver, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, type InsertArrResolver, type InsertResolver, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationResolverFactory, type SchemaFeatures, type SelectResolver, type SelectSingleResolver, type TableNamedRelations, type UpdateResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleExecutorKey, extractFilters, extractOrderBy, extractRelationJoinColumns };

package/dist/index.d.ts

@@ -419,6 +419,26 @@ type SchemaFeatures = {
      */
     upsert?: boolean;
 };
+/**
+ * Per-field cost hints for `graphql-query-complexity` (or any estimator that reads
+ * `extensions.complexity`). See {@link BuildSchemaConfig.complexity}.
+ */
+type ComplexityConfig = {
+    /**
+     * Rows a list field is assumed to return when the query passes no `limit`. Raise it if your
+     * tables are large and clients routinely omit `limit`.
+     *
+     * @default 10
+     */
+    defaultListSize?: number;
+    /**
+     * Flat cost charged for an aggregate field, on top of whatever is selected inside it. An
+     * aggregate returns one row but reads however many match, so it is priced as a scan.
+     *
+     * @default 10
+     */
+    aggregateCost?: number;
+};
 type BuildSchemaConfig = {
     /**
      * Determines whether generated mutations will be passed to returned schema.
@@ -487,6 +507,31 @@ type BuildSchemaConfig = {
      * until the next major.
      */
     conflictDoNothing?: boolean;
+    /**
+     * Cost hints published as `extensions.complexity` on the generated fields, for
+     * `graphql-query-complexity`'s `fieldExtensionsEstimator`.
+     *
+     * The generator knows which fields are paginated and which are aggregates, so a list field is
+     * priced at `(limit ?? defaultListSize) * childComplexity` and an aggregate at
+     * `aggregateCost + childComplexity`. Everything else is left alone and falls through to your
+     * estimator's default. The hints are inert until you install a complexity rule, so they are on
+     * by default; pass `false` to omit them.
+     *
+     * Cost is not a depth bound — a cyclic relation graph still lets a client nest arbitrarily
+     * deep. Put a depth limit in front of a publicly exposed schema as well.
+     *
+     * ```ts
+     * import { createComplexityRule, fieldExtensionsEstimator, simpleEstimator } from 'graphql-query-complexity';
+     *
+     * const rule = createComplexityRule({
+     *   maximumComplexity: 1000,
+     *   estimators: [fieldExtensionsEstimator(), simpleEstimator({ defaultComplexity: 1 })],
+     * });
+     * ```
+     *
+     * @default true
+     */
+    complexity?: boolean | ComplexityConfig;
     /**
      * Turns individual generated features off.
      *
@@ -594,4 +639,4 @@ declare const GraphQLBigIntString: GraphQLScalarType<string, string>;
 
 declare const buildSchema: <TDbClient extends AnyDrizzleDB<any>>(db: TDbClient, config?: BuildSchemaConfig) => GeneratedData<TDbClient>;
 
-export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type DeleteResolver, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, type InsertArrResolver, type InsertResolver, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationResolverFactory, type SchemaFeatures, type SelectResolver, type SelectSingleResolver, type TableNamedRelations, type UpdateResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleExecutorKey, extractFilters, extractOrderBy, extractRelationJoinColumns };
+export { type AggregateResolver, type AnyDrizzleDB, type BuildSchemaConfig, type ComplexityConfig, type DeleteResolver, type ExtractRelations, type ExtractTableByName, type ExtractTableRelations, type ExtractTables, type GeneratedData, type GeneratedEntities, type GeneratedInputs, type GeneratedOutputs, GraphQLBigIntString, type InsertArrResolver, type InsertResolver, type MutationReturnlessResult, type MutationsCore, type QueriesCore, type RelationResolverFactory, type SchemaFeatures, type SelectResolver, type SelectSingleResolver, type TableNamedRelations, type UpdateResolver, type UpsertArgs, type UpsertArrResolver, type UpsertConflictArgs, type UpsertResolver, buildSchema, createRelationResolverFactory, defaultErrorMapper, drizzleExecutorKey, extractFilters, extractOrderBy, extractRelationJoinColumns };

package/dist/index.js

@@ -655,6 +655,12 @@ var createRelationResolverFactory = (db, tables, filterCtx) => ({ tableName, rel
     return loader.load(localValue);
   };
 };
+var listFieldComplexity = (options) => ({ args, childComplexity }) => {
+  const limit = args["limit"];
+  const rows = typeof limit === "number" && limit > 0 ? limit : options.defaultListSize;
+  return rows * Math.max(childComplexity, 1);
+};
+var aggregateFieldComplexity = (options) => ({ childComplexity }) => options.aggregateCost + childComplexity;
 var AGGREGATE_FIELD_SUFFIX = "Aggregate";
 var relationAggregateJoinColumns = (tree, table, selectionCtx) => {
   const relations = selectionCtx?.relationMap[selectionCtx.tableName];
@@ -1076,7 +1082,8 @@ var generateSelectFields = (tables, tableName, relationMap, fromTableName, fromR
             offset: { type: GraphQLInt2 },
             limit: { type: GraphQLInt2 }
           },
-          resolve
+          resolve,
+          ...cacheCtx.complexity ? { extensions: { complexity: listFieldComplexity(cacheCtx.complexity) } } : {}
         }
       ]);
       const aggregateFieldName = `${relationName}Aggregate`;
@@ -1094,7 +1101,8 @@ var generateSelectFields = (tables, tableName, relationMap, fromTableName, fromR
               args: {
                 where: { type: relSelectData.filters }
               },
-              resolve: relationAggregate.resolve
+              resolve: relationAggregate.resolve,
+              ...cacheCtx.complexity ? { extensions: { complexity: aggregateFieldComplexity(cacheCtx.complexity) } } : {}
             }
           ]);
         }
@@ -2394,7 +2402,7 @@ var generateDelete = (db, tableName, table, filterArgs, fieldName, filterCtx) =>
 };
 var mysqlPrimaryKeyPropNames = (table) => getPrimaryKeyPropNamesFromConfig(table, getTableConfig);
 var generateSchemaData = (db, schema, relations, options) => {
-  const { relationsDepthLimit, prefixes, suffixes, typeNameMapper, shouldEagerLoad, features } = options;
+  const { relationsDepthLimit, prefixes, suffixes, typeNameMapper, shouldEagerLoad, features, complexity } = options;
   const rawSchema = schema;
   const schemaEntries = Object.entries(rawSchema);
   const tableEntries = schemaEntries.filter(([_key, value]) => is4(value, MySqlTable));
@@ -2418,7 +2426,8 @@ var generateSchemaData = (db, schema, relations, options) => {
     orderTypeCache: /* @__PURE__ */ new WeakMap(),
     filterTypeCache: /* @__PURE__ */ new WeakMap(),
     listRelationFilterCache: /* @__PURE__ */ new Map(),
-    aggregateTypeCache: /* @__PURE__ */ new Map()
+    aggregateTypeCache: /* @__PURE__ */ new Map(),
+    complexity
   };
   const relationAggregateFactory = features.relationAggregates ? createRelationAggregateFactory(db, tables, cacheCtx, typeNameMapper, filterCtx) : void 0;
   const queries = {};
@@ -2528,7 +2537,8 @@ var generateSchemaData = (db, schema, relations, options) => {
     queries[selectArrGenerated.name] = {
       type: selectArrOutput,
       args: selectArrGenerated.args,
-      resolve: selectArrGenerated.resolver
+      resolve: selectArrGenerated.resolver,
+      ...complexity ? { extensions: { complexity: listFieldComplexity(complexity) } } : {}
     };
     queries[selectSingleGenerated.name] = {
       type: selectSingleOutput,
@@ -2539,7 +2549,8 @@ var generateSchemaData = (db, schema, relations, options) => {
       queries[aggregateGenerated.name] = {
         type: new GraphQLNonNull4(aggregateType),
         args: aggregateGenerated.args,
-        resolve: aggregateGenerated.resolver
+        resolve: aggregateGenerated.resolver,
+        ...complexity ? { extensions: { complexity: aggregateFieldComplexity(complexity) } } : {}
       };
     }
     for (const generated of [
@@ -2970,7 +2981,16 @@ var generateDelete2 = (db, tableName, table, filterArgs, fieldName, typeName, fi
   };
 };
 function generateSchemaData2(db, schema, relations, options) {
-  const { relationsDepthLimit, prefixes, suffixes, conflictDoNothing, typeNameMapper, shouldEagerLoad, features } = options;
+  const {
+    relationsDepthLimit,
+    prefixes,
+    suffixes,
+    conflictDoNothing,
+    typeNameMapper,
+    shouldEagerLoad,
+    features,
+    complexity
+  } = options;
   const schemaEntries = Object.entries(schema);
   const tableEntries = schemaEntries.filter(([_key, value]) => is5(value, PgTable));
   const tables = Object.fromEntries(tableEntries);
@@ -2993,7 +3013,8 @@ function generateSchemaData2(db, schema, relations, options) {
     orderTypeCache: /* @__PURE__ */ new WeakMap(),
     filterTypeCache: /* @__PURE__ */ new WeakMap(),
     listRelationFilterCache: /* @__PURE__ */ new Map(),
-    aggregateTypeCache: /* @__PURE__ */ new Map()
+    aggregateTypeCache: /* @__PURE__ */ new Map(),
+    complexity
   };
   const relationAggregateFactory = features.relationAggregates ? createRelationAggregateFactory(db, tables, cacheCtx, typeNameMapper, filterCtx) : void 0;
   const queries = {};
@@ -3156,7 +3177,8 @@ function generateSchemaData2(db, schema, relations, options) {
     queries[selectArrGenerated.name] = {
       type: selectArrOutput,
       args: selectArrGenerated.args,
-      resolve: selectArrGenerated.resolver
+      resolve: selectArrGenerated.resolver,
+      ...complexity ? { extensions: { complexity: listFieldComplexity(complexity) } } : {}
     };
     queries[selectSingleGenerated.name] = {
       type: selectSingleOutput,
@@ -3167,7 +3189,8 @@ function generateSchemaData2(db, schema, relations, options) {
       queries[aggregateGenerated.name] = {
         type: new GraphQLNonNull5(aggregateType),
         args: aggregateGenerated.args,
-        resolve: aggregateGenerated.resolver
+        resolve: aggregateGenerated.resolver,
+        ...complexity ? { extensions: { complexity: aggregateFieldComplexity(complexity) } } : {}
       };
     }
     if (insertArrGenerated) {
@@ -3563,7 +3586,16 @@ var generateDelete3 = (db, tableName, table, filterArgs, fieldName, typeName, fi
   };
 };
 var generateSchemaData3 = (db, schema, relations, options) => {
-  const { relationsDepthLimit, prefixes, suffixes, conflictDoNothing, typeNameMapper, shouldEagerLoad, features } = options;
+  const {
+    relationsDepthLimit,
+    prefixes,
+    suffixes,
+    conflictDoNothing,
+    typeNameMapper,
+    shouldEagerLoad,
+    features,
+    complexity
+  } = options;
   const rawSchema = schema;
   const schemaEntries = Object.entries(rawSchema);
   const tableEntries = schemaEntries.filter(([_key, value]) => is6(value, SQLiteTable));
@@ -3587,7 +3619,8 @@ var generateSchemaData3 = (db, schema, relations, options) => {
     orderTypeCache: /* @__PURE__ */ new WeakMap(),
     filterTypeCache: /* @__PURE__ */ new WeakMap(),
     listRelationFilterCache: /* @__PURE__ */ new Map(),
-    aggregateTypeCache: /* @__PURE__ */ new Map()
+    aggregateTypeCache: /* @__PURE__ */ new Map(),
+    complexity
   };
   const relationAggregateFactory = features.relationAggregates ? createRelationAggregateFactory(db, tables, cacheCtx, typeNameMapper, filterCtx) : void 0;
   const queries = {};
@@ -3750,7 +3783,8 @@ var generateSchemaData3 = (db, schema, relations, options) => {
     queries[selectArrGenerated.name] = {
       type: selectArrOutput,
       args: selectArrGenerated.args,
-      resolve: selectArrGenerated.resolver
+      resolve: selectArrGenerated.resolver,
+      ...complexity ? { extensions: { complexity: listFieldComplexity(complexity) } } : {}
     };
     queries[selectSingleGenerated.name] = {
       type: selectSingleOutput,
@@ -3761,7 +3795,8 @@ var generateSchemaData3 = (db, schema, relations, options) => {
       queries[aggregateGenerated.name] = {
         type: new GraphQLNonNull6(aggregateType),
         args: aggregateGenerated.args,
-        resolve: aggregateGenerated.resolver
+        resolve: aggregateGenerated.resolver,
+        ...complexity ? { extensions: { complexity: aggregateFieldComplexity(complexity) } } : {}
       };
     }
     if (insertArrGenerated) {
@@ -3871,6 +3906,11 @@ var buildSchema = (db, config) => {
     delete: config?.features?.delete ?? true,
     upsert: config?.features?.upsert ?? false
   };
+  const complexityConfig = config?.complexity ?? true;
+  const complexity = complexityConfig === false ? void 0 : {
+    defaultListSize: (complexityConfig === true ? void 0 : complexityConfig.defaultListSize) ?? 10,
+    aggregateCost: (complexityConfig === true ? void 0 : complexityConfig.aggregateCost) ?? 10
+  };
   const eagerOpt = config?.eagerLoadRelations;
   const shouldEagerLoad = eagerOpt === void 0 || eagerOpt === true ? () => true : eagerOpt === false ? () => false : eagerOpt;
   if (!typeNameMapper && suffixes.list === suffixes.single) {
@@ -3897,7 +3937,8 @@ var buildSchema = (db, config) => {
     conflictDoNothing: config?.conflictDoNothing ?? false,
     typeNameMapper,
     shouldEagerLoad,
-    features
+    features,
+    complexity
   };
   let generatorOutput;
   if (is7(db, MySqlDatabase)) {