@application-kit/graphql 0.2.2 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @application-kit/graphql
 
+## 0.3.0
+
+### Minor Changes
+
+- 1966fa9: Вход `@application-kit/graphql/nest` — периметр Mercurius-сервера: `createMercuriusOptions({ schemaPath, maxDepth,
+  playground, resolveSupportId })` (интроспекция только при включённой консоли, потолок вложенности, `errorFormatter`
+  через `formatGraphQLError` с одним `supportId` на ответ), окружение `GraphqlEnvironment` (`GRAPHQL_PLAYGROUND`,
+  `GRAPHQL_SCHEMA_PATH`) и конфиг `GraphqlConfig`. `@nestjs/mercurius`, `mercurius` и `@libs-for-dev/nestjs-config-module`
+  — optional peers, нужные только этому входу.
+
 ## 0.2.2
 
 ### Patch Changes

package/README.md

@@ -10,7 +10,8 @@ yarn add @application-kit/graphql
 ```
 
 Peer-зависимости: `@nestjs/common`, `@nestjs/graphql`, `class-transformer`, `class-validator`, `graphql`,
-`@apollo/client`. Все обязательные. Зависимость `@application-kit/typeorm` ставится сама (типы листинга
+`@apollo/client` — обязательные; `@nestjs/mercurius`, `mercurius`, `@libs-for-dev/nestjs-config-module` — optional,
+нужны только входу `/nest`. Зависимость `@application-kit/typeorm` ставится сама (типы листинга
 берут оттуда `FiltersMatchMode` и `SortOrder`).
 
 ## Входы
@@ -19,6 +20,7 @@ Peer-зависимости: `@nestjs/common`, `@nestjs/graphql`, `class-transfo
 |------|----------|-------|
 | `@application-kit/graphql` | сервер: ошибки, форматтер, типы листинга | `@nestjs/*`, `class-validator` |
 | `@application-kit/graphql/client` | браузер и SSR: чтение `extensions` ответа | только `@apollo/client`, `graphql` (типы) |
+| `@application-kit/graphql/nest` | периметр Mercurius-сервера: опции драйвера, окружение, конфиг | `mercurius`, `@nestjs/mercurius` (типы), `@libs-for-dev/nestjs-config-module` |
 
 Клиентский вход не содержит импортов серверных зависимостей — его можно собирать в браузерный бандл.
 
@@ -44,6 +46,28 @@ export class BusinessGraphQLError extends BaseBusinessGraphQLError<MessageCode>
 export type BusinessErrorOptions = BusinessErrorOptionsInterface<MessageCode>
 ```
 
+## Сервер Mercurius (`/nest`)
+
+- `createMercuriusOptions({ schemaPath, maxDepth, playground, resolveSupportId })` — опции `MercuriusDriver`:
+  выключена консоль (`playground: false`) — выключена и интроспекция схемы; запрос глубже `maxDepth` отвергается до
+  исполнения; `errorFormatter` прогоняет каждую ошибку через `formatGraphQLError` с одним `supportId` на ответ.
+  Пустой `schemaPath` — схема только в памяти.
+- `GraphqlEnvironment` — `GRAPHQL_PLAYGROUND` (дефолт `false`) и необязательный `GRAPHQL_SCHEMA_PATH`;
+  `GraphqlConfig.createOptions({ schemaPath, maxDepth, resolveSupportId })` берёт флаг консоли из окружения, путь —
+  из окружения, если он задан, иначе из вызова. Регистрацию делает приложение:
+
+```ts
+ConfigsModule.forFeature([GraphqlConfig], [GraphqlEnvironment])
+
+GraphQLModule.forRootAsync({
+  driver: MercuriusDriver,
+  inject: [GraphqlConfig],
+  useFactory: (config: GraphqlConfig) => config.createOptions({ maxDepth: 5, resolveSupportId, schemaPath: 'src/schema.gql' }),
+})
+```
+
+Источник `supportId` (трасса, id запроса) пакет не выбирает: резолвер передаёт приложение.
+
 ## Клиент
 
 - `supportIdFromError`, `rejectedCharactersFromError`, `messageCodeFromError` — читатели полей `extensions` ответа

package/dist/cjs/nest/graphql.config.d.ts

@@ -0,0 +1,7 @@
+import type { GraphqlConfigOptionsInterface, MercuriusPerimeterOptions } from './mercurius-options.interface.js';
+import { GraphqlEnvironment } from './graphql.environment.js';
+export declare class GraphqlConfig {
+    private readonly environment;
+    constructor(environment: GraphqlEnvironment);
+    createOptions(options: GraphqlConfigOptionsInterface): MercuriusPerimeterOptions;
+}

package/dist/cjs/nest/graphql.config.js

@@ -0,0 +1,37 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphqlConfig = void 0;
+const common_1 = require("@nestjs/common");
+const graphql_environment_js_1 = require("./graphql.environment.js");
+const mercurius_options_js_1 = require("./mercurius-options.js");
+let GraphqlConfig = class GraphqlConfig {
+    environment;
+    constructor(environment) {
+        this.environment = environment;
+    }
+    createOptions(options) {
+        return (0, mercurius_options_js_1.createMercuriusOptions)({
+            ...options,
+            playground: this.environment.GRAPHQL_PLAYGROUND,
+            schemaPath: this.environment.GRAPHQL_SCHEMA_PATH ?? options.schemaPath,
+        });
+    }
+};
+exports.GraphqlConfig = GraphqlConfig;
+exports.GraphqlConfig = GraphqlConfig = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(graphql_environment_js_1.GraphqlEnvironment)),
+    __metadata("design:paramtypes", [graphql_environment_js_1.GraphqlEnvironment])
+], GraphqlConfig);

package/dist/cjs/nest/graphql.environment.d.ts

@@ -0,0 +1,4 @@
+export declare class GraphqlEnvironment {
+    GRAPHQL_PLAYGROUND: boolean;
+    GRAPHQL_SCHEMA_PATH?: string;
+}

package/dist/cjs/nest/graphql.environment.js

@@ -0,0 +1,32 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphqlEnvironment = void 0;
+const nestjs_config_module_1 = require("@libs-for-dev/nestjs-config-module");
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+class GraphqlEnvironment {
+    GRAPHQL_PLAYGROUND = false;
+    GRAPHQL_SCHEMA_PATH;
+}
+exports.GraphqlEnvironment = GraphqlEnvironment;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsBoolean)(),
+    (0, nestjs_config_module_1.ParseBoolean)(),
+    __metadata("design:type", Object)
+], GraphqlEnvironment.prototype, "GRAPHQL_PLAYGROUND", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], GraphqlEnvironment.prototype, "GRAPHQL_SCHEMA_PATH", void 0);

package/dist/cjs/nest/index.d.ts

@@ -0,0 +1,4 @@
+export * from './graphql.config.js';
+export * from './graphql.environment.js';
+export * from './mercurius-options.js';
+export * from './mercurius-options.interface.js';

package/dist/cjs/nest/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./graphql.config.js"), exports);
+__exportStar(require("./graphql.environment.js"), exports);
+__exportStar(require("./mercurius-options.js"), exports);
+__exportStar(require("./mercurius-options.interface.js"), exports);

package/dist/cjs/nest/mercurius-options.d.ts

@@ -0,0 +1,2 @@
+import type { MercuriusOptionsInterface, MercuriusPerimeterOptions } from './mercurius-options.interface.js';
+export declare const createMercuriusOptions: ({ maxDepth, playground, resolveSupportId, schemaPath, }: MercuriusOptionsInterface) => MercuriusPerimeterOptions;

package/dist/cjs/nest/mercurius-options.interface.d.ts

@@ -0,0 +1,11 @@
+import type { MercuriusDriverConfig } from '@nestjs/mercurius';
+import type { MercuriusContext } from 'mercurius';
+export type GraphqlConfigOptionsInterface = Omit<MercuriusOptionsInterface, 'playground'>;
+export interface MercuriusOptionsInterface {
+    readonly maxDepth: number;
+    readonly playground: boolean;
+    readonly resolveSupportId: SupportIdResolver;
+    readonly schemaPath: string;
+}
+export type MercuriusPerimeterOptions = Required<Pick<MercuriusDriverConfig, 'autoSchemaFile' | 'errorFormatter' | 'graphiql' | 'queryDepth' | 'sortSchema' | 'validationRules'>>;
+export type SupportIdResolver = (request: MercuriusContext['reply']['request']) => string;

package/dist/cjs/nest/mercurius-options.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/nest/mercurius-options.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMercuriusOptions = void 0;
+const graphql_1 = require("graphql");
+const mercurius_1 = __importDefault(require("mercurius"));
+const format_graphql_error_js_1 = require("../errors/format-graphql-error.js");
+const createMercuriusOptions = ({ maxDepth, playground, resolveSupportId, schemaPath, }) => ({
+    autoSchemaFile: schemaPath || true,
+    errorFormatter: (execution, context) => {
+        const supportId = resolveSupportId(context.reply.request);
+        const errors = execution.errors.map((gqlError) => (0, format_graphql_error_js_1.formatGraphQLError)(gqlError, supportId));
+        return mercurius_1.default.defaultErrorFormatter({ ...execution, errors }, context);
+    },
+    graphiql: playground,
+    queryDepth: maxDepth,
+    sortSchema: true,
+    validationRules: playground ? [] : [graphql_1.NoSchemaIntrospectionCustomRule],
+});
+exports.createMercuriusOptions = createMercuriusOptions;

package/dist/esm/nest/graphql.config.d.ts

@@ -0,0 +1,7 @@
+import type { GraphqlConfigOptionsInterface, MercuriusPerimeterOptions } from './mercurius-options.interface.js';
+import { GraphqlEnvironment } from './graphql.environment.js';
+export declare class GraphqlConfig {
+    private readonly environment;
+    constructor(environment: GraphqlEnvironment);
+    createOptions(options: GraphqlConfigOptionsInterface): MercuriusPerimeterOptions;
+}

package/dist/esm/nest/graphql.config.js

@@ -0,0 +1,34 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { Inject, Injectable } from '@nestjs/common';
+import { GraphqlEnvironment } from './graphql.environment.js';
+import { createMercuriusOptions } from './mercurius-options.js';
+let GraphqlConfig = class GraphqlConfig {
+    environment;
+    constructor(environment) {
+        this.environment = environment;
+    }
+    createOptions(options) {
+        return createMercuriusOptions({
+            ...options,
+            playground: this.environment.GRAPHQL_PLAYGROUND,
+            schemaPath: this.environment.GRAPHQL_SCHEMA_PATH ?? options.schemaPath,
+        });
+    }
+};
+GraphqlConfig = __decorate([
+    Injectable(),
+    __param(0, Inject(GraphqlEnvironment)),
+    __metadata("design:paramtypes", [GraphqlEnvironment])
+], GraphqlConfig);
+export { GraphqlConfig };

package/dist/esm/nest/graphql.environment.d.ts

@@ -0,0 +1,4 @@
+export declare class GraphqlEnvironment {
+    GRAPHQL_PLAYGROUND: boolean;
+    GRAPHQL_SCHEMA_PATH?: string;
+}

package/dist/esm/nest/graphql.environment.js

@@ -0,0 +1,28 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { ParseBoolean } from '@libs-for-dev/nestjs-config-module';
+import { Expose } from 'class-transformer';
+import { IsBoolean, IsOptional, IsString } from 'class-validator';
+export class GraphqlEnvironment {
+    GRAPHQL_PLAYGROUND = false;
+    GRAPHQL_SCHEMA_PATH;
+}
+__decorate([
+    Expose(),
+    IsBoolean(),
+    ParseBoolean(),
+    __metadata("design:type", Object)
+], GraphqlEnvironment.prototype, "GRAPHQL_PLAYGROUND", void 0);
+__decorate([
+    Expose(),
+    IsOptional(),
+    IsString(),
+    __metadata("design:type", String)
+], GraphqlEnvironment.prototype, "GRAPHQL_SCHEMA_PATH", void 0);

package/dist/esm/nest/index.d.ts

@@ -0,0 +1,4 @@
+export * from './graphql.config.js';
+export * from './graphql.environment.js';
+export * from './mercurius-options.js';
+export * from './mercurius-options.interface.js';

package/dist/esm/nest/index.js

@@ -0,0 +1,4 @@
+export * from './graphql.config.js';
+export * from './graphql.environment.js';
+export * from './mercurius-options.js';
+export * from './mercurius-options.interface.js';

package/dist/esm/nest/mercurius-options.d.ts

@@ -0,0 +1,2 @@
+import type { MercuriusOptionsInterface, MercuriusPerimeterOptions } from './mercurius-options.interface.js';
+export declare const createMercuriusOptions: ({ maxDepth, playground, resolveSupportId, schemaPath, }: MercuriusOptionsInterface) => MercuriusPerimeterOptions;

package/dist/esm/nest/mercurius-options.interface.d.ts

@@ -0,0 +1,11 @@
+import type { MercuriusDriverConfig } from '@nestjs/mercurius';
+import type { MercuriusContext } from 'mercurius';
+export type GraphqlConfigOptionsInterface = Omit<MercuriusOptionsInterface, 'playground'>;
+export interface MercuriusOptionsInterface {
+    readonly maxDepth: number;
+    readonly playground: boolean;
+    readonly resolveSupportId: SupportIdResolver;
+    readonly schemaPath: string;
+}
+export type MercuriusPerimeterOptions = Required<Pick<MercuriusDriverConfig, 'autoSchemaFile' | 'errorFormatter' | 'graphiql' | 'queryDepth' | 'sortSchema' | 'validationRules'>>;
+export type SupportIdResolver = (request: MercuriusContext['reply']['request']) => string;

package/dist/esm/nest/mercurius-options.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/nest/mercurius-options.js

@@ -0,0 +1,15 @@
+import { NoSchemaIntrospectionCustomRule } from 'graphql';
+import mercurius from 'mercurius';
+import { formatGraphQLError } from '../errors/format-graphql-error.js';
+export const createMercuriusOptions = ({ maxDepth, playground, resolveSupportId, schemaPath, }) => ({
+    autoSchemaFile: schemaPath || true,
+    errorFormatter: (execution, context) => {
+        const supportId = resolveSupportId(context.reply.request);
+        const errors = execution.errors.map((gqlError) => formatGraphQLError(gqlError, supportId));
+        return mercurius.defaultErrorFormatter({ ...execution, errors }, context);
+    },
+    graphiql: playground,
+    queryDepth: maxDepth,
+    sortSchema: true,
+    validationRules: playground ? [] : [NoSchemaIntrospectionCustomRule],
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@application-kit/graphql",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Контракт ошибок GraphQL (сервер и клиент) и типы курсорного листинга для NestJS",
   "keywords": [
     "apollo",
@@ -45,6 +45,16 @@
         "default": "./dist/cjs/client/index.js"
       }
     },
+    "./nest": {
+      "import": {
+        "types": "./dist/esm/nest/index.d.ts",
+        "default": "./dist/esm/nest/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/nest/index.d.ts",
+        "default": "./dist/cjs/nest/index.js"
+      }
+    },
     "./package.json": "./package.json"
   },
   "main": "./dist/cjs/index.js",
@@ -54,7 +64,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "rm -rf ./dist && node ../../scripts/barrels.mjs create ./src --entry-only=client && tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json && node ../../scripts/barrels.mjs clean ./src && node ../../scripts/mark-cjs.mjs ./dist/cjs",
+    "build": "rm -rf ./dist && node ../../scripts/barrels.mjs create ./src --entry-only=client,nest && tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json && node ../../scripts/barrels.mjs clean ./src && node ../../scripts/mark-cjs.mjs ./dist/cjs",
     "lint:tsc": "tsc --noEmit --pretty --project .",
     "test:mutation": "stryker run",
     "test:unit": "vitest run"
@@ -64,26 +74,44 @@
   },
   "devDependencies": {
     "@apollo/client": "^4.2.12",
+    "@libs-for-dev/nestjs-config-module": "3.0.0",
     "@nestjs/common": "^11.2.7",
     "@nestjs/core": "^11.2.7",
     "@nestjs/graphql": "^13.4.5",
+    "@nestjs/mercurius": "^13.4.5",
     "@stryker-mutator/core": "^10.0.0",
     "@stryker-mutator/vitest-runner": "^10.0.0",
     "@types/node": "^26.2.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.15.1",
+    "fastify": "^5.12.5",
     "graphql": "^16.14.2",
+    "mercurius": "^16.10.0",
     "reflect-metadata": "^0.2.2",
     "typescript": "^6.0.3",
     "vitest": "^4.1.11"
   },
   "peerDependencies": {
     "@apollo/client": "^4.0.0",
+    "@libs-for-dev/nestjs-config-module": "^3.0.0",
     "@nestjs/common": "^11.0.0",
     "@nestjs/graphql": "^13.0.0",
+    "@nestjs/mercurius": "^13.0.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.15.0",
-    "graphql": "^16.0.0"
+    "graphql": "^16.0.0",
+    "mercurius": "^16.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@libs-for-dev/nestjs-config-module": {
+      "optional": true
+    },
+    "@nestjs/mercurius": {
+      "optional": true
+    },
+    "mercurius": {
+      "optional": true
+    }
   },
   "engines": {
     "node": ">=24"