@application-kit/graphql 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @application-kit/graphql
 
+## 0.6.0
+
+### Minor Changes
+
+- abb4a67: Реестр кодов сообщений `BusinessMessageCodeRegistryInterface` и тип `BusinessMessageCode`: приложение объявляет коды через `declare module '@application-kit/graphql'`.
+  **Ломающее:** параметр типа у `BusinessGraphQLError` и `BusinessErrorOptionsInterface` снят, `BusinessErrorTable` получил значение параметра по умолчанию. Потребителю — записать коды в реестр и удалить свои привязки параметра; без записи тип кода `never`, и `new BusinessGraphQLError` не компилируется.
+
 ## 0.5.0
 
 ### Minor Changes

package/README.md

@@ -27,7 +27,7 @@ Peer-зависимости: `@nestjs/common`, `@nestjs/graphql`, `class-transfo
 
 ## Сервер
 
-- `BusinessGraphQLError<TMessageCode>` — бизнес-ошибка с транспортным кодом (`BAD_USER_INPUT`, `FORBIDDEN`,
+- `BusinessGraphQLError` — бизнес-ошибка с транспортным кодом (`BAD_USER_INPUT`, `FORBIDDEN`,
   `NOT_FOUND`) и кодом показываемого текста `messageCode`.
 - `matchBusinessError(table, fallback)` — таблица «класс доменной ошибки → опции ответа», первая подходящая строка.
 - `formatGraphQLError(error, supportId)` — единая точка форматирования: `HttpException` → `extensions`,
@@ -37,14 +37,17 @@ Peer-зависимости: `@nestjs/common`, `@nestjs/graphql`, `class-transfo
 
 ### Словарь кодов сообщений — у приложения
 
-Пакет не знает кодов сообщений: тип кода — параметр без значения по умолчанию. Приложение один раз связывает его
-со своим объединением, и неизвестный код перестаёт компилироваться:
+Пакет не знает кодов сообщений: реестр `BusinessMessageCodeRegistryInterface` пуст, и без записи приложения тип кода —
+`never`. Приложение объявляет коды один раз, и неизвестный код перестаёт компилироваться в `BusinessGraphQLError`,
+`BusinessErrorOptionsInterface` и `BusinessErrorTable`:
 
 ```ts
-type MessageCode = 'signIn.invalidCredentials' | 'profile.notFound'
-
-export class BusinessGraphQLError extends BaseBusinessGraphQLError<MessageCode> {}
-export type BusinessErrorOptions = BusinessErrorOptionsInterface<MessageCode>
+declare module '@application-kit/graphql' {
+  interface BusinessMessageCodeRegistryInterface {
+    'profile.notFound': true
+    'signIn.invalidCredentials': true
+  }
+}
 ```
 
 ## Клиент (`/client`)

package/dist/cjs/contract/business-message-code.d.ts

@@ -0,0 +1,3 @@
+export type BusinessMessageCode = keyof BusinessMessageCodeRegistryInterface;
+export interface BusinessMessageCodeRegistryInterface {
+}

package/dist/cjs/contract/business-message-code.js

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

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

@@ -1 +1,2 @@
+export * from './business-message-code.js';
 export * from './graphql-error-contract.js';

package/dist/cjs/contract/index.js

@@ -14,4 +14,5 @@ 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("./business-message-code.js"), exports);
 __exportStar(require("./graphql-error-contract.js"), exports);

package/dist/cjs/errors/business-graphql-error.d.ts

@@ -1,5 +1,6 @@
 import { GraphQLError } from 'graphql';
+import type { BusinessMessageCode } from '../contract/business-message-code.js';
 import type { BusinessGraphQLErrorCode, GraphQLErrorWireExtensions } from '../contract/graphql-error-contract.js';
-export declare class BusinessGraphQLError<TMessageCode extends string> extends GraphQLError {
-    constructor(message: string, code: BusinessGraphQLErrorCode, messageCode: TMessageCode, extensions?: GraphQLErrorWireExtensions);
+export declare class BusinessGraphQLError extends GraphQLError {
+    constructor(message: string, code: BusinessGraphQLErrorCode, messageCode: BusinessMessageCode, extensions?: GraphQLErrorWireExtensions);
 }

package/dist/cjs/errors/match-business-error.d.ts

@@ -1,7 +1,8 @@
+import type { BusinessMessageCode } from '../contract/business-message-code.js';
 import type { BusinessGraphQLErrorCode } from '../contract/graphql-error-contract.js';
-export interface BusinessErrorOptionsInterface<TMessageCode extends string> {
+export interface BusinessErrorOptionsInterface {
     code: BusinessGraphQLErrorCode;
-    messageCode: TMessageCode;
+    messageCode: BusinessMessageCode;
 }
-export type BusinessErrorTable<TOptions> = readonly [new (...arguments_: never[]) => Error, TOptions][];
+export type BusinessErrorTable<TOptions = BusinessErrorOptionsInterface> = readonly [new (...arguments_: never[]) => Error, TOptions][];
 export declare const matchBusinessError: <TOptions>(table: BusinessErrorTable<TOptions>, fallback: TOptions) => (commandError: Error) => TOptions;

package/dist/esm/contract/business-message-code.d.ts

@@ -0,0 +1,3 @@
+export type BusinessMessageCode = keyof BusinessMessageCodeRegistryInterface;
+export interface BusinessMessageCodeRegistryInterface {
+}

package/dist/esm/contract/business-message-code.js

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

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

@@ -1 +1,2 @@
+export * from './business-message-code.js';
 export * from './graphql-error-contract.js';

package/dist/esm/contract/index.js

@@ -1 +1,2 @@
+export * from './business-message-code.js';
 export * from './graphql-error-contract.js';

package/dist/esm/errors/business-graphql-error.d.ts

@@ -1,5 +1,6 @@
 import { GraphQLError } from 'graphql';
+import type { BusinessMessageCode } from '../contract/business-message-code.js';
 import type { BusinessGraphQLErrorCode, GraphQLErrorWireExtensions } from '../contract/graphql-error-contract.js';
-export declare class BusinessGraphQLError<TMessageCode extends string> extends GraphQLError {
-    constructor(message: string, code: BusinessGraphQLErrorCode, messageCode: TMessageCode, extensions?: GraphQLErrorWireExtensions);
+export declare class BusinessGraphQLError extends GraphQLError {
+    constructor(message: string, code: BusinessGraphQLErrorCode, messageCode: BusinessMessageCode, extensions?: GraphQLErrorWireExtensions);
 }

package/dist/esm/errors/match-business-error.d.ts

@@ -1,7 +1,8 @@
+import type { BusinessMessageCode } from '../contract/business-message-code.js';
 import type { BusinessGraphQLErrorCode } from '../contract/graphql-error-contract.js';
-export interface BusinessErrorOptionsInterface<TMessageCode extends string> {
+export interface BusinessErrorOptionsInterface {
     code: BusinessGraphQLErrorCode;
-    messageCode: TMessageCode;
+    messageCode: BusinessMessageCode;
 }
-export type BusinessErrorTable<TOptions> = readonly [new (...arguments_: never[]) => Error, TOptions][];
+export type BusinessErrorTable<TOptions = BusinessErrorOptionsInterface> = readonly [new (...arguments_: never[]) => Error, TOptions][];
 export declare const matchBusinessError: <TOptions>(table: BusinessErrorTable<TOptions>, fallback: TOptions) => (commandError: Error) => TOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@application-kit/graphql",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Контракт ошибок GraphQL (сервер и клиент) и типы курсорного листинга для NestJS",
   "keywords": [
     "apollo",