@application-kit/graphql 0.3.4 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @application-kit/graphql
 
+## 0.5.0
+
+### Minor Changes
+
+- a3e984e: Вход `/client`: фабрика `createApolloClient` с колбэком ошибки (флаг `SKIP_GLOBAL_ERROR_TOAST` проверяет сама) и `requireApolloData`.
+
+## 0.4.0
+
+### Minor Changes
+
+- c5dab83: Вход `/testing` для спек потребителя: `createFakeApolloClient`, `createFakeGraphQLErrors`, `createFakeBusinessError`.
+
 ## 0.3.4
 
 ### Patch Changes

package/README.md

@@ -19,8 +19,9 @@ 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` |
 
 Клиентский вход не содержит импортов серверных зависимостей — его можно собирать в браузерный бандл.
 
@@ -46,6 +47,22 @@ export class BusinessGraphQLError extends BaseBusinessGraphQLError<MessageCode>
 export type BusinessErrorOptions = BusinessErrorOptionsInterface<MessageCode>
 ```
 
+## Клиент (`/client`)
+
+- `createApolloClient({ http, onError })` — клиент Apollo с `InMemoryCache`, `ErrorLink` и `HttpLink`. `http` — опции
+  `HttpLink` как есть. `onError(error)` зовётся на каждую ошибку операции, кроме помеченных флагом
+  `SKIP_GLOBAL_ERROR_TOAST` в контексте: их показывает сам вызывающий. Вызывающий получает ошибку в любом случае.
+- `requireApolloData(result)` — данные ответа query; `undefined` вместо них — ошибка транспорта.
+
+```ts
+export const apolloClient = createApolloClient({
+  http: { uri: '/graphql' },
+  onError: (error) => {
+    showToast(messageCodeFromError(error), supportIdFromError(error))
+  },
+})
+```
+
 ## Сервер Mercurius (`/nest`)
 
 - `createMercuriusOptions({ schemaPath, maxDepth, playground, resolveSupportId })` — опции `MercuriusDriver`:
@@ -76,3 +93,15 @@ GraphQLModule.forRootAsync({
 
 Перевода в пакете нет: он отдаёт данные из ошибки (код сообщения, код обращения, отклонённые символы), а текст для
 пользователя собирает приложение — код → ключ своего словаря → строка на языке пользователя → строка с кодом обращения.
+
+## Спеки потребителя (`/testing`)
+
+- `createFakeApolloClient(members)` — заглушка с типом настоящего клиента: имена членов проверяет компилятор, поведение
+  определяет спека. Приведение типа и его `eslint-disable` живут в пакете.
+- `createFakeGraphQLErrors(...errors)` — настоящий `CombinedGraphQLErrors`, поля `extensions` — через wire-контракт.
+- `createFakeBusinessError(messageCode, extensions?)` — одна бизнес-ошибка с кодом показываемого текста.
+
+```ts
+provideApolloClient(createFakeApolloClient({ mutate }))
+mutate.mockRejectedValue(createFakeBusinessError('signIn.invalidCredentials'))
+```

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

@@ -0,0 +1,4 @@
+import type { ApolloClient } from '@apollo/client';
+type FakeApolloClientMembersType = Partial<Record<keyof ApolloClient, unknown>>;
+export declare const createFakeApolloClient: (members?: FakeApolloClientMembersType) => ApolloClient;
+export {};

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

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFakeApolloClient = void 0;
+const createFakeApolloClient = (members = {}) => members;
+exports.createFakeApolloClient = createFakeApolloClient;

package/dist/cjs/testing/create-fake-graphql-errors.d.ts

@@ -0,0 +1,9 @@
+import { CombinedGraphQLErrors } from '@apollo/client/errors';
+import type { GraphQLErrorWireExtensions } from '../contract/graphql-error-contract.js';
+interface FakeWireErrorInterface {
+    extensions?: GraphQLErrorWireExtensions;
+    message: string;
+}
+export declare const createFakeGraphQLErrors: (...errors: FakeWireErrorInterface[]) => CombinedGraphQLErrors;
+export declare const createFakeBusinessError: (messageCode: string, extensions?: GraphQLErrorWireExtensions) => CombinedGraphQLErrors;
+export {};

package/dist/cjs/testing/create-fake-graphql-errors.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFakeBusinessError = exports.createFakeGraphQLErrors = void 0;
+const errors_1 = require("@apollo/client/errors");
+const createFakeGraphQLErrors = (...errors) => new errors_1.CombinedGraphQLErrors({ errors });
+exports.createFakeGraphQLErrors = createFakeGraphQLErrors;
+const createFakeBusinessError = (messageCode, extensions = {}) => (0, exports.createFakeGraphQLErrors)({
+    extensions: { ...extensions, messageCode },
+    message: 'technical message',
+});
+exports.createFakeBusinessError = createFakeBusinessError;

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

@@ -0,0 +1,2 @@
+export * from './create-fake-apollo-client.js';
+export * from './create-fake-graphql-errors.js';

package/dist/cjs/testing/index.js

@@ -0,0 +1,18 @@
+"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("./create-fake-apollo-client.js"), exports);
+__exportStar(require("./create-fake-graphql-errors.js"), exports);

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

@@ -0,0 +1,4 @@
+import type { ApolloClient } from '@apollo/client';
+type FakeApolloClientMembersType = Partial<Record<keyof ApolloClient, unknown>>;
+export declare const createFakeApolloClient: (members?: FakeApolloClientMembersType) => ApolloClient;
+export {};

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

@@ -0,0 +1 @@
+export const createFakeApolloClient = (members = {}) => members;

package/dist/esm/testing/create-fake-graphql-errors.d.ts

@@ -0,0 +1,9 @@
+import { CombinedGraphQLErrors } from '@apollo/client/errors';
+import type { GraphQLErrorWireExtensions } from '../contract/graphql-error-contract.js';
+interface FakeWireErrorInterface {
+    extensions?: GraphQLErrorWireExtensions;
+    message: string;
+}
+export declare const createFakeGraphQLErrors: (...errors: FakeWireErrorInterface[]) => CombinedGraphQLErrors;
+export declare const createFakeBusinessError: (messageCode: string, extensions?: GraphQLErrorWireExtensions) => CombinedGraphQLErrors;
+export {};

package/dist/esm/testing/create-fake-graphql-errors.js

@@ -0,0 +1,6 @@
+import { CombinedGraphQLErrors } from '@apollo/client/errors';
+export const createFakeGraphQLErrors = (...errors) => new CombinedGraphQLErrors({ errors });
+export const createFakeBusinessError = (messageCode, extensions = {}) => createFakeGraphQLErrors({
+    extensions: { ...extensions, messageCode },
+    message: 'technical message',
+});

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

@@ -0,0 +1,2 @@
+export * from './create-fake-apollo-client.js';
+export * from './create-fake-graphql-errors.js';

package/dist/esm/testing/index.js

@@ -0,0 +1,2 @@
+export * from './create-fake-apollo-client.js';
+export * from './create-fake-graphql-errors.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@application-kit/graphql",
-  "version": "0.3.4",
+  "version": "0.5.0",
   "description": "Контракт ошибок GraphQL (сервер и клиент) и типы курсорного листинга для NestJS",
   "keywords": [
     "apollo",
@@ -55,7 +55,17 @@
         "default": "./dist/cjs/nest/index.js"
       }
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./testing": {
+      "import": {
+        "types": "./dist/esm/testing/index.d.ts",
+        "default": "./dist/esm/testing/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/testing/index.d.ts",
+        "default": "./dist/cjs/testing/index.js"
+      }
+    }
   },
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -64,7 +74,7 @@
     "dist"
   ],
   "scripts": {
-    "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",
+    "build": "rm -rf ./dist && node ../../scripts/barrels.mjs create ./src --entry-only=client,nest,testing && 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"