@baeta/extension-complexity 2.0.0-next.0 → 2.0.0-next.2

package/CHANGELOG.md

@@ -0,0 +1,104 @@
+# @baeta/extension-complexity
+
+## 2.0.0-next.2
+
+### Patch Changes
+
+- Fix broken types
+
+- Updated dependencies []:
+  - @baeta/core@2.0.0-next.2
+
+## 2.0.0-next.1
+
+### Patch Changes
+
+- Fix release version
+
+- Updated dependencies []:
+  - @baeta/core@2.0.0-next.1
+
+## 2.0.0-next.0
+
+### Major Changes
+
+- [#214](https://github.com/andreisergiu98/baeta/pull/214) [`31d1a50`](https://github.com/andreisergiu98/baeta/commit/31d1a509f96535b43ae85d19c770eb1a5f09dc94) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - Baeta v2 – major refactor
+  - **Side-effect-free type generation & resolver definitions.**
+    The types generator and resolver definitions were reworked to be side-effect free, improving type safety.
+  - **Stricter type safety.**
+    You must now **explicitly define resolvers for every field** during development—breakages that used to surface at runtime are now caught at compile time.
+  - **Removed `@baeta/compiler`.**
+    Since modern runtimes can execute TypeScript natively, the separate compiler package is no longer needed. Use your runtime’s native TS support or your existing build setup.
+  - **Subscriptions update.**
+    `@baeta/subscriptions-pubsub` now targets **`graphql-subscriptions` v3**.
+
+### Patch Changes
+
+- Updated dependencies [[`31d1a50`](https://github.com/andreisergiu98/baeta/commit/31d1a509f96535b43ae85d19c770eb1a5f09dc94)]:
+  - @baeta/core@2.0.0-next.0
+
+## 1.0.11
+
+### Patch Changes
+
+- Updated dependencies [[`7f3d5ff`](https://github.com/andreisergiu98/baeta/commit/7f3d5ff7cd0871e2f017c86dd29ac7bc02647154)]:
+  - @baeta/core@1.0.11
+
+## 1.0.9
+
+### Patch Changes
+
+- [`583014f`](https://github.com/andreisergiu98/baeta/commit/583014f0bac810b25d9a8226bda2df4c9039f5e3) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - Update dependencies
+
+- Updated dependencies [[`583014f`](https://github.com/andreisergiu98/baeta/commit/583014f0bac810b25d9a8226bda2df4c9039f5e3)]:
+  - @baeta/core@1.0.9
+
+## 0.0.5
+
+### Patch Changes
+
+- [#189](https://github.com/andreisergiu98/baeta/pull/189) [`d500378`](https://github.com/andreisergiu98/baeta/commit/d500378198e0a9c48298c4242913bca8ad348228) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - add jsdocs
+
+- Updated dependencies [[`d500378`](https://github.com/andreisergiu98/baeta/commit/d500378198e0a9c48298c4242913bca8ad348228), [`1334c2a`](https://github.com/andreisergiu98/baeta/commit/1334c2a866676c88f0f3d380b22133d81c4e98bc)]:
+  - @baeta/core@1.0.8
+
+## 0.0.4
+
+### Patch Changes
+
+- [`b59db50`](https://github.com/andreisergiu98/baeta/commit/b59db501a83275ab2d964933080e688a3a5d8820) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - add readme
+
+- Updated dependencies [[`b59db50`](https://github.com/andreisergiu98/baeta/commit/b59db501a83275ab2d964933080e688a3a5d8820)]:
+  - @baeta/core@0.1.5
+  - @baeta/errors@0.1.4
+
+## 0.0.3
+
+### Patch Changes
+
+- [#180](https://github.com/andreisergiu98/baeta/pull/180) [`483c709`](https://github.com/andreisergiu98/baeta/commit/483c70932f815fd114732c00b74f9488d7924c72) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - Raise minimum required NodeJS version to 22.12.0. Drop CommonJS builds in favor of the require_esm feature from NodeJS 22.12.0 onwards.
+
+- [`de6e89c`](https://github.com/andreisergiu98/baeta/commit/de6e89c1b592e280967c73a4137d24ee56ef1857) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - raise es target to 2024
+
+- Updated dependencies [[`483c709`](https://github.com/andreisergiu98/baeta/commit/483c70932f815fd114732c00b74f9488d7924c72), [`de6e89c`](https://github.com/andreisergiu98/baeta/commit/de6e89c1b592e280967c73a4137d24ee56ef1857)]:
+  - @baeta/core@0.1.4
+  - @baeta/errors@0.1.3
+
+## 0.0.2
+
+### Patch Changes
+
+- [`c8dea0c`](https://github.com/andreisergiu98/baeta/commit/c8dea0c6a7824039cf4de13a8d2c0b1682ea3d02) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - maintain order of prepended middlewares
+
+- Updated dependencies [[`c8dea0c`](https://github.com/andreisergiu98/baeta/commit/c8dea0c6a7824039cf4de13a8d2c0b1682ea3d02)]:
+  - @baeta/core@0.1.3
+
+## 0.0.1
+
+### Patch Changes
+
+- [#176](https://github.com/andreisergiu98/baeta/pull/176) [`d77cd8a`](https://github.com/andreisergiu98/baeta/commit/d77cd8a1810fdf72cfbbb08d05c207bbc893c822) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - feat: add complexity extension
+
+- Updated dependencies [[`59bbb9c`](https://github.com/andreisergiu98/baeta/commit/59bbb9c4baaf716f27dc251fe7aeb0231e6c5321), [`d77cd8a`](https://github.com/andreisergiu98/baeta/commit/d77cd8a1810fdf72cfbbb08d05c207bbc893c822), [`cf9f094`](https://github.com/andreisergiu98/baeta/commit/cf9f09468f84d99b069eb0f55e1fc207e2a41dd8)]:
+  - @baeta/core@0.1.2
+  - @baeta/errors@0.1.2

package/dist/index.d.ts

@@ -0,0 +1,200 @@
+import { FieldBuilder, TypeBuilder, SubscriptionBuilder, Extension, ModuleCompiler } from '@baeta/core/sdk';
+import { GraphQLError, GraphQLErrorOptions } from 'graphql';
+
+/**
+ * Configuration for field complexity calculation.
+ */
+type FieldSettings = {
+    complexity?: number;
+    multiplier?: number;
+};
+/**
+ * Arguments passed to field settings functions.
+ */
+type GetFieldSettingsArgs<Context, Args> = {
+    /** Arguments passed to the GraphQL field */
+    args: Args;
+    /** Request context */
+    ctx: Context;
+};
+/**
+ * Function to determine complexity settings for a field.
+ * Returns either field settings or false to disable complexity calculation.
+ *
+ * @param params - Object containing field arguments and context
+ * @returns Field settings object or false
+ */
+type GetFieldSettings<Context, Args> = (params: GetFieldSettingsArgs<Context, Args>) => FieldSettings | false;
+
+/** biome-ignore-all lint/correctness/noUnusedVariables: arguments used for inference */
+
+declare global {
+    export namespace BaetaExtensions {
+        interface FieldExtensions<Result, Source, Context, Args, Info, Builder extends FieldBuilder<Result, Source, Context, Args, Info>> {
+            /**
+             * Configures complexity calculation for a type field.
+             *
+             * @param fn - Function to determine complexity settings
+             *
+             * @example
+             * ```typescript
+             * Query.users.$complexity((_, args) => ({
+             *   complexity: 1,
+             *   multiplier: args.limit || 10
+             * })).resolve(...);
+             *
+             * // Disable complexity calculation
+             * Query.simple.$complexity(() => false);
+             * ```
+             */
+            $complexity: (fn: GetFieldSettings<Context, Args>) => ReturnType<Builder['toMethods']>;
+        }
+        interface TypeExtensions<Source, Context, Info, Builder extends TypeBuilder<Source, Context, Info>> {
+            /**
+             * Configures complexity calculation for a type field.
+             *
+             * @param fn - Function to determine complexity settings
+             *
+             * @example
+             * ```typescript
+             * Query.users.$complexity((_, args) => ({
+             *   complexity: 1,
+             *   multiplier: args.limit || 10
+             * })).resolve(...);
+             *
+             * // Disable complexity calculation
+             * Query.simple.$complexity(() => false);
+             * ```
+             */
+            $complexity: (fn: GetFieldSettings<Context, unknown>) => ReturnType<Builder['toMethods']>;
+        }
+        interface SubscriptionExtensions<Result, Source, Context, Args, Info, Builder extends SubscriptionBuilder<Result, Source, Context, Args, Info>> {
+            /**
+             * Configures complexity calculation for a type field.
+             *
+             * @param fn - Function to determine complexity settings
+             *
+             * @example
+             * ```typescript
+             * Query.users.$complexity((_, args) => ({
+             *   complexity: 1,
+             *   multiplier: args.limit || 10
+             * })).resolve(...);
+             *
+             * // Disable complexity calculation
+             * Query.simple.$complexity(() => false);
+             * ```
+             */
+            $complexity: (fn: GetFieldSettings<Context, Args>) => ReturnType<Builder['toMethods']>;
+        }
+    }
+}
+
+/** Complexity error code */
+declare const ComplexityErrorCode = "COMPLEXITY_ERROR";
+/**
+ * Thrown when a query exceeds the complexity limits.
+ */
+declare class ComplexityError extends GraphQLError {
+    constructor(message?: string, options?: GraphQLErrorOptions);
+}
+/**
+ * Types of complexity validation errors that can occur during query analysis.
+ */
+declare const ComplexityErrorKind: {
+    /** Query exceeds maximum allowed depth */
+    Depth: string;
+    /** Query exceeds maximum allowed breadth (fields per level) */
+    Breadth: string;
+    /** Query exceeds total complexity score limit */
+    Complexity: string;
+};
+type ComplexityErrorKind = (typeof ComplexityErrorKind)[keyof typeof ComplexityErrorKind];
+/**
+ * Function type for creating custom complexity error messages.
+ *
+ * @param kind - The type of complexity limit that was exceeded
+ * @param limits - The maximum allowed value
+ * @param results - The actual value that exceeded the limit
+ * @returns A GraphQL error with a custom message
+ */
+type GetComplexityError = (kind: ComplexityErrorKind, limits: number, results: number) => GraphQLError;
+
+/**
+ * Configuration for query complexity limits.
+ */
+interface ComplexityLimit {
+    /** Maximum allowed query depth */
+    depth?: number;
+    /** Maximum allowed fields per level */
+    breadth?: number;
+    /** Maximum allowed total complexity score */
+    complexity?: number;
+}
+/**
+ * Function to determine complexity limits, can be static or context-based.
+ */
+type GetComplexityLimit<Context> = ComplexityLimit | ((ctx: Context) => ComplexityLimit | PromiseLike<ComplexityLimit>);
+
+/**
+ * Configuration options for the complexity extension.
+ */
+interface ComplexityExtensionOptions<Context> {
+    /** Static limits or function to determine limits based on context */
+    limit?: GetComplexityLimit<Context>;
+    /**
+     * Base complexity score for fields
+     * @defaultValue 1
+     */
+    defaultComplexity?: number;
+    /**
+     * Multiplier applied to list fields
+     * @defaultValue 10
+     */
+    defaultListMultiplier?: number;
+    /** Custom error message generator */
+    complexityError?: GetComplexityError;
+}
+
+interface ComplexityState {
+    fieldSettings: GetFieldSettings<unknown, unknown>;
+}
+declare global {
+    export namespace BaetaExtensions {
+        interface Extensions {
+            complexityExtension: ComplexityExtension<unknown>;
+        }
+    }
+}
+declare class ComplexityExtension<Ctx> extends Extension<ComplexityState> {
+    readonly stateKey: symbol;
+    private readonly options;
+    constructor(options?: ComplexityExtensionOptions<Ctx>);
+    getTypeExtensions: <Source, Context, Info>(builder: TypeBuilder<Source, Context, Info>) => BaetaExtensions.TypeExtensions<Source, Context, Info, TypeBuilder<Source, Context, Info>>;
+    getFieldExtensions: <Result, Source, Context, Args, Info>(builder: FieldBuilder<Result, Source, Context, Args, Info>) => BaetaExtensions.FieldExtensions<Result, Source, Context, Args, Info, FieldBuilder<Result, Source, Context, Args, Info>>;
+    getSubscriptionExtensions: <Result, Source, Context, Args, Info>(builder: SubscriptionBuilder<Result, Source, Context, Args, Info>) => BaetaExtensions.SubscriptionExtensions<Result, Source, Context, Args, Info, SubscriptionBuilder<Result, Source, Context, Args, Info>>;
+    mutate(compilers: ModuleCompiler[]): void;
+}
+
+/**
+ * Creates a complexity analysis extension for GraphQL queries.
+ *
+ * @param options - Configuration options for complexity analysis
+ * @returns Extension factory function
+ *
+ * @example
+ * ```typescript
+ * const complexity = complexityExtension<Context>({
+ *   defaultComplexity: 1,
+ *   defaultListMultiplier: 10,
+ *   limit: {
+ *     depth: 5,
+ *     breadth: 10,
+ *     complexity: 100
+ *   }
+ * });
+ * ```
+ */
+declare function complexityExtension<Ctx>(options?: ComplexityExtensionOptions<Ctx>): ComplexityExtension<Ctx>;
+
+export { ComplexityError, ComplexityErrorCode, ComplexityErrorKind, type ComplexityExtensionOptions, type ComplexityLimit, type FieldSettings, type GetComplexityError, type GetComplexityLimit, type GetFieldSettings, type GetFieldSettingsArgs, complexityExtension };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baeta/extension-complexity",
-  "version": "2.0.0-next.0",
+  "version": "2.0.0-next.2",
   "keywords": [
     "baeta",
     "graphql",
@@ -27,8 +27,8 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./index.ts",
-      "default": "./index.ts"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     }
   },
   "types": "dist/index.d.ts",
@@ -44,15 +44,15 @@
     "types": "tsc --noEmit"
   },
   "devDependencies": {
-    "@baeta/builder": "workspace:^",
-    "@baeta/core": "workspace:^",
-    "@baeta/testing": "workspace:^",
-    "@baeta/tsconfig": "workspace:^",
+    "@baeta/builder": "^0.0.0",
+    "@baeta/core": "^2.0.0-next.2",
+    "@baeta/testing": "^0.0.0",
+    "@baeta/tsconfig": "^0.0.0",
     "graphql": "^16.11.0",
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@baeta/core": "workspace:^",
+    "@baeta/core": "^2.0.0-next.2",
     "graphql": "^16.6.0"
   },
   "engines": {
@@ -89,4 +89,4 @@
       "alphabetical-ignoring-documents"
     ]
   }
-}
+}