@application-kit/graphql 0.4.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @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
+
+- a3e984e: Вход `/client`: фабрика `createApolloClient` с колбэком ошибки (флаг `SKIP_GLOBAL_ERROR_TOAST` проверяет сама) и `requireApolloData`.
+
 ## 0.4.0
 
 ### Minor Changes

package/README.md

@@ -19,7 +19,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/client` | браузер и SSR: сборка клиента, чтение `extensions` ответа | только `@apollo/client`, `graphql` (типы) |
 | `@application-kit/graphql/nest` | периметр Mercurius-сервера: опции драйвера, окружение, конфиг | `mercurius`, `@nestjs/mercurius` (типы), `@libs-for-dev/nestjs-config-module` |
 | `@application-kit/graphql/testing` | спеки потребителя: фейк клиента и ошибки ответа | только `@apollo/client` |
 
@@ -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,33 @@ Peer-зависимости: `@nestjs/common`, `@nestjs/graphql`, `class-transfo
 
 ### Словарь кодов сообщений — у приложения
 
-Пакет не знает кодов сообщений: тип кода — параметр без значения по умолчанию. Приложение один раз связывает его
-со своим объединением, и неизвестный код перестаёт компилироваться:
+Пакет не знает кодов сообщений: реестр `BusinessMessageCodeRegistryInterface` пуст, и без записи приложения тип кода —
+`never`. Приложение объявляет коды один раз, и неизвестный код перестаёт компилироваться в `BusinessGraphQLError`,
+`BusinessErrorOptionsInterface` и `BusinessErrorTable`:
 
 ```ts
-type MessageCode = 'signIn.invalidCredentials' | 'profile.notFound'
+declare module '@application-kit/graphql' {
+  interface BusinessMessageCodeRegistryInterface {
+    'profile.notFound': true
+    'signIn.invalidCredentials': true
+  }
+}
+```
+
+## Клиент (`/client`)
+
+- `createApolloClient({ http, onError })` — клиент Apollo с `InMemoryCache`, `ErrorLink` и `HttpLink`. `http` — опции
+  `HttpLink` как есть. `onError(error)` зовётся на каждую ошибку операции, кроме помеченных флагом
+  `SKIP_GLOBAL_ERROR_TOAST` в контексте: их показывает сам вызывающий. Вызывающий получает ошибку в любом случае.
+- `requireApolloData(result)` — данные ответа query; `undefined` вместо них — ошибка транспорта.
 
-export class BusinessGraphQLError extends BaseBusinessGraphQLError<MessageCode> {}
-export type BusinessErrorOptions = BusinessErrorOptionsInterface<MessageCode>
+```ts
+export const apolloClient = createApolloClient({
+  http: { uri: '/graphql' },
+  onError: (error) => {
+    showToast(messageCodeFromError(error), supportIdFromError(error))
+  },
+})
 ```
 
 ## Сервер Mercurius (`/nest`)

package/dist/cjs/client/create-apollo-client.d.ts

@@ -0,0 +1,8 @@
+import type { ErrorLike } from '@apollo/client/core';
+import { ApolloClient } from '@apollo/client/core';
+import { HttpLink } from '@apollo/client/link/http';
+export interface ApolloClientOptionsInterface {
+    http: HttpLink.Options;
+    onError(error: ErrorLike): void;
+}
+export declare const createApolloClient: (options: ApolloClientOptionsInterface) => ApolloClient;

package/dist/cjs/client/create-apollo-client.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createApolloClient = void 0;
+const core_1 = require("@apollo/client/core");
+const error_1 = require("@apollo/client/link/error");
+const http_1 = require("@apollo/client/link/http");
+const request_error_js_1 = require("./request-error.js");
+const createApolloClient = (options) => {
+    const errorLink = new error_1.ErrorLink(({ error, operation }) => {
+        if (!(0, request_error_js_1.shouldSkipGlobalErrorToast)(operation.getContext())) {
+            options.onError(error);
+        }
+    });
+    return new core_1.ApolloClient({
+        cache: new core_1.InMemoryCache(),
+        link: core_1.ApolloLink.from([errorLink, new http_1.HttpLink(options.http)]),
+    });
+};
+exports.createApolloClient = createApolloClient;

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

@@ -1,4 +1,6 @@
+export * from './create-apollo-client.js';
 export * from './message-code-from-error.js';
 export * from './rejected-characters-from-error.js';
 export * from './request-error.js';
+export * from './require-apollo-data.js';
 export * from './support-id-from-error.js';

package/dist/cjs/client/index.js

@@ -14,7 +14,9 @@ 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("./create-apollo-client.js"), exports);
 __exportStar(require("./message-code-from-error.js"), exports);
 __exportStar(require("./rejected-characters-from-error.js"), exports);
 __exportStar(require("./request-error.js"), exports);
+__exportStar(require("./require-apollo-data.js"), exports);
 __exportStar(require("./support-id-from-error.js"), exports);

package/dist/cjs/client/require-apollo-data.d.ts

@@ -0,0 +1,3 @@
+export declare const requireApolloData: <Data>(result: {
+    data: Data | undefined;
+}) => Data;

package/dist/cjs/client/require-apollo-data.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireApolloData = void 0;
+const requireApolloData = (result) => {
+    if (result.data === undefined) {
+        throw new Error('No data returned from Apollo Client');
+    }
+    return result.data;
+};
+exports.requireApolloData = requireApolloData;

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/client/create-apollo-client.d.ts

@@ -0,0 +1,8 @@
+import type { ErrorLike } from '@apollo/client/core';
+import { ApolloClient } from '@apollo/client/core';
+import { HttpLink } from '@apollo/client/link/http';
+export interface ApolloClientOptionsInterface {
+    http: HttpLink.Options;
+    onError(error: ErrorLike): void;
+}
+export declare const createApolloClient: (options: ApolloClientOptionsInterface) => ApolloClient;

package/dist/esm/client/create-apollo-client.js

@@ -0,0 +1,15 @@
+import { ApolloClient, ApolloLink, InMemoryCache } from '@apollo/client/core';
+import { ErrorLink } from '@apollo/client/link/error';
+import { HttpLink } from '@apollo/client/link/http';
+import { shouldSkipGlobalErrorToast } from './request-error.js';
+export const createApolloClient = (options) => {
+    const errorLink = new ErrorLink(({ error, operation }) => {
+        if (!shouldSkipGlobalErrorToast(operation.getContext())) {
+            options.onError(error);
+        }
+    });
+    return new ApolloClient({
+        cache: new InMemoryCache(),
+        link: ApolloLink.from([errorLink, new HttpLink(options.http)]),
+    });
+};

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

@@ -1,4 +1,6 @@
+export * from './create-apollo-client.js';
 export * from './message-code-from-error.js';
 export * from './rejected-characters-from-error.js';
 export * from './request-error.js';
+export * from './require-apollo-data.js';
 export * from './support-id-from-error.js';

package/dist/esm/client/index.js

@@ -1,4 +1,6 @@
+export * from './create-apollo-client.js';
 export * from './message-code-from-error.js';
 export * from './rejected-characters-from-error.js';
 export * from './request-error.js';
+export * from './require-apollo-data.js';
 export * from './support-id-from-error.js';

package/dist/esm/client/require-apollo-data.d.ts

@@ -0,0 +1,3 @@
+export declare const requireApolloData: <Data>(result: {
+    data: Data | undefined;
+}) => Data;

package/dist/esm/client/require-apollo-data.js

@@ -0,0 +1,6 @@
+export const requireApolloData = (result) => {
+    if (result.data === undefined) {
+        throw new Error('No data returned from Apollo Client');
+    }
+    return result.data;
+};

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.4.0",
+  "version": "0.6.0",
   "description": "Контракт ошибок GraphQL (сервер и клиент) и типы курсорного листинга для NestJS",
   "keywords": [
     "apollo",