@vantreeseba/drizzle-graphql 4.0.0 → 4.2.0

package/dist/index.d.cts

@@ -400,6 +400,13 @@ type GeneratedData<TDatabase extends AnyDrizzleDB<any>> = {
 type SchemaFeatures = {
     /** `<plural>Aggregate` root queries and the aggregate output types. @default true */
     aggregates?: boolean;
+    /**
+     * `<plural>GroupBy` root queries — the same aggregates, one row per group. Requires
+     * `aggregates`, whose output types the grouped result reuses.
+     *
+     * @default true
+     */
+    groupBy?: boolean;
     /** `<relation>Aggregate` fields on object types, for to-many relations. @default true */
     relationAggregates?: boolean;
     /** The `distinct` argument on list queries. @default true */
@@ -419,6 +426,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 +514,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 +646,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

@@ -400,6 +400,13 @@ type GeneratedData<TDatabase extends AnyDrizzleDB<any>> = {
 type SchemaFeatures = {
     /** `<plural>Aggregate` root queries and the aggregate output types. @default true */
     aggregates?: boolean;
+    /**
+     * `<plural>GroupBy` root queries — the same aggregates, one row per group. Requires
+     * `aggregates`, whose output types the grouped result reuses.
+     *
+     * @default true
+     */
+    groupBy?: boolean;
     /** `<relation>Aggregate` fields on object types, for to-many relations. @default true */
     relationAggregates?: boolean;
     /** The `distinct` argument on list queries. @default true */
@@ -419,6 +426,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 +514,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 +646,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 };