@newmo/graphql-codegen-fake-server-client 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 newmo, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,83 @@
+# @newmo/graphql-codegen-fake-server-client
+
+GraphQL Code Generator plugin for generating a fake server client.
+
+## Installation
+
+```sh
+npm add --save-dev @newmo/graphql-codegen-fake-server-client
+# This plugin depends on @graphql-codegen/client-preset
+npm install @graphql-codegen/cli @graphql-codegen/client-preset --save-dev
+```
+
+GraphQL Code Generator configuration:
+
+```ts
+import type { CodegenConfig } from "@graphql-codegen/cli";
+
+const config: CodegenConfig = {
+    overwrite: true,
+    schema: "./api/graphql/api.graphqls",
+    documents: "./api/graphql/query.graphql",
+    generates: {
+        "./generated/": {
+            preset: "client"
+        },
+        "./generated/fake-client.ts": {
+            plugins: ["@newmo/graphql-codegen-fake-server-client"],
+            config: {
+                // Required: path to the generated client's graphql file
+                typesFile: "./graphql"
+            },
+        },
+    },
+};
+
+export default config;
+```
+
+You can use `./generated/fake-client.ts` to register the fake to the fake server.
+
+```ts
+import { registerFake } from "./generated/fake-client";
+it("register fake response for query", async () => {
+    const sequenceId = crypto.randomUUID();
+    // register fake response for GetBooks query
+    const resRegister = await registerGetBooksQueryResponse(sequenceId, {
+        books: [
+            {
+                id: "new id",
+                title: "new title",
+            },
+        ],
+    });
+    expect(resRegister).toMatchInlineSnapshot(`"{"ok":true}"`);
+    // request to server
+    const client = new GraphQLClient(`${fakeServerUrl}/graphql`, {
+        headers: {
+            "sequence-id": sequenceId,
+        },
+    });
+    // Got fake response
+    const response = await client.request(GetBooksDocument);
+    expect(response).toMatchInlineSnapshot(`
+          {
+            "books": [
+              {
+                "id": "new id",
+                "title": "new title",
+              },
+            ],
+          }
+        `);
+});
+```
+
+## Options
+
+- `typesFile` (required): Path to the generated client's graphql file.
+- `fakeServerEndpoint` (optional): Fake server endpoint. Default is `http://127.0.0.1:4000/fake`.
+
+## License
+
+MIT

package/dist/graphql-codegen-fake-server-client.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const plugin = {
+    plugin(schema, documents, config, _info) {
+        console.log(config);
+        const fakeEndpoint = config.fakeServerEndpoint || "http://127.0.0.1:4000/fake";
+        const registerOperationResponseType = "{ ok: true } | { ok: false; errors: string[] }";
+        const generateRegisterOperation = (name) => {
+            return `export async function register${name}QueryResponse(sequenceId:string, queryResponse: ${name}Query): Promise<${registerOperationResponseType}> {
+    return await fetch('${fakeEndpoint}', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'sequence-id': sequenceId
+        },
+        body: JSON.stringify({
+            type: "operation",
+            operationName: "${name}",
+            data: queryResponse
+        }),
+    }).then((res) => res.json()) as ${registerOperationResponseType};
+}`;
+        };
+        const generateRegisterOperationError = (name) => {
+            return `export async function register${name}QueryErrorResponse(sequenceId:string, { errors, responseStatusCode }: { errors: Record<string, unknown>[]; responseStatusCode: number }): Promise<${registerOperationResponseType}> {
+    return await fetch('${fakeEndpoint}', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'sequence-id': sequenceId
+        },
+        body: JSON.stringify({
+            type: "network-error",
+            operationName: "${name}",
+            responseStatusCode,
+            errors
+        }),
+    }).then((res) => res.json()) as ${registerOperationResponseType};
+}`;
+        };
+        const generateRegisterMutation = (name) => {
+            return `export async function register${name}MutationResponse(sequenceId:string, mutationResponse: ${name}Mutation): Promise<${registerOperationResponseType}> {
+    return await fetch('${fakeEndpoint}', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'sequence-id': sequenceId
+        },
+        body: JSON.stringify({
+            type: "operation",
+            operationName: "${name}",
+            data: mutationResponse
+        }),
+    }).then((res) => res.json()) as ${registerOperationResponseType};
+}`;
+        };
+        const generateRegisterMutationError = (name) => {
+            return `export async function register${name}MutationErrorResponse(sequenceId:string, { errors, responseStatusCode }: { errors: Record<string, unknown>[]; responseStatusCode: number }): Promise<${registerOperationResponseType}> {
+    return await fetch('${fakeEndpoint}', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'sequence-id': sequenceId
+        },
+        body: JSON.stringify({
+            type: "network-error",
+            operationName: "${name}",
+            responseStatusCode,
+            errors
+        }),
+    }).then((res) => res.json()) as ${registerOperationResponseType};
+}`;
+        };
+        const importQueryIdentifierName = (documentName) => {
+            return `import type { ${documentName}Query } from '${config.typesFile}';`;
+        };
+        const importMutationIdentifierName = (documentName) => {
+            return `import type { ${documentName}Mutation } from '${config.typesFile}';`;
+        };
+        return `/* eslint-disable */
+// This file was generated by a @newmo/graphql-codegen-fake-server-operation
+${documents
+            .flatMap((document) => {
+            return document.document?.definitions?.map((definition) => {
+                // query
+                if (definition.kind === "OperationDefinition" &&
+                    definition.operation === "query" &&
+                    definition.name) {
+                    return importQueryIdentifierName(definition.name.value);
+                }
+                if (definition.kind === "OperationDefinition" &&
+                    definition.operation === "mutation" &&
+                    definition.name) {
+                    return importMutationIdentifierName(definition.name.value);
+                }
+                return [];
+            });
+        })
+            .join("\n")}
+${documents
+            .flatMap((document) => {
+            return document.document?.definitions?.flatMap((definition) => {
+                // query
+                if (definition.kind === "OperationDefinition" &&
+                    definition.operation === "query" &&
+                    definition.name) {
+                    return [
+                        generateRegisterOperation(definition.name.value),
+                        generateRegisterOperationError(definition.name.value),
+                    ];
+                }
+                if (definition.kind === "OperationDefinition" &&
+                    definition.operation === "mutation" &&
+                    definition.name) {
+                    return [
+                        generateRegisterMutation(definition.name.value),
+                        generateRegisterMutationError(definition.name.value),
+                    ];
+                }
+                return [];
+            });
+        })
+            .join("\n")}
+`;
+    },
+};
+// GraphQL Codegen Plugin requires CommonJS export
+module.exports = plugin;

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@newmo/graphql-codegen-fake-server-client",
+  "version": "0.4.0",
+  "private": false,
+  "description": "GraphQL Codegen plugin for generating a fake server client",
+  "keywords": [
+    "testing",
+    "mock",
+    "graphql"
+  ],
+  "repository": "https://github.com/newmo-oss/graphql-fake-server.git",
+  "license": "MIT",
+  "author": "newmo, Inc.",
+  "sideEffects": false,
+  "type": "commonjs",
+  "main": "./dist/graphql-codegen-fake-server-client.js",
+  "exports": {
+    ".": {
+      "import": "./dist/graphql-codegen-fake-server-client.js",
+      "require": "./dist/graphql-codegen-fake-server-client.js",
+      "default": "./dist/graphql-codegen-fake-server-client.js"
+    }
+  },
+  "files": [
+    "src/",
+    "!src/test",
+    "!src/**/*.test.ts",
+    "!src/**/__snapshots__",
+    "dist/"
+  ],
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "tsc",
+    "lint": "tsc --noEmit",
+    "test": "npm run build && npm run codege",
+    "codegen": "graphql-codegen --config graphql-codegen.ts"
+  },
+  "dependencies": {
+    "@graphql-codegen/plugin-helpers": "^5.0.3"
+  },
+  "devDependencies": {
+    "@graphql-codegen/cli": "^5.0.0",
+    "@graphql-codegen/typescript": "^4.0.1",
+    "@tsconfig/node18": "^18.2.0",
+    "@tsconfig/strictest": "^2.0.1",
+    "@types/eslint": "^8.44.2",
+    "@types/node": "^20.5.1",
+    "graphql": "^16.8.1",
+    "typescript": "^5.4.2"
+  },
+  "peerDependencies": {
+    "graphql": "^16.8.1"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "gitHead": "bab6c38ebdeffb527923f72106da19456e753ecb"
+}

package/src/graphql-codegen-fake-server-client.ts

@@ -0,0 +1,149 @@
+import type { CodegenPlugin } from "@graphql-codegen/plugin-helpers";
+
+export type PluginConfig = {
+    /**
+     * The path to the generated types file
+     * @example
+     * typeFile: "./graphql.ts"
+     **/
+    typesFile: string;
+    /**
+     * The URL of the fake server
+     * Default: 'http://127.0.0.1:4000/fake'
+     */
+    fakeServerEndpoint: string;
+};
+const plugin: CodegenPlugin<PluginConfig> = {
+    plugin(schema, documents, config, _info) {
+        console.log(config);
+        const fakeEndpoint = config.fakeServerEndpoint || "http://127.0.0.1:4000/fake";
+        const registerOperationResponseType = "{ ok: true } | { ok: false; errors: string[] }";
+        const generateRegisterOperation = (name: string) => {
+            return `export async function register${name}QueryResponse(sequenceId:string, queryResponse: ${name}Query): Promise<${registerOperationResponseType}> {
+    return await fetch('${fakeEndpoint}', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'sequence-id': sequenceId
+        },
+        body: JSON.stringify({
+            type: "operation",
+            operationName: "${name}",
+            data: queryResponse
+        }),
+    }).then((res) => res.json()) as ${registerOperationResponseType};
+}`;
+        };
+        const generateRegisterOperationError = (name: string) => {
+            return `export async function register${name}QueryErrorResponse(sequenceId:string, { errors, responseStatusCode }: { errors: Record<string, unknown>[]; responseStatusCode: number }): Promise<${registerOperationResponseType}> {
+    return await fetch('${fakeEndpoint}', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'sequence-id': sequenceId
+        },
+        body: JSON.stringify({
+            type: "network-error",
+            operationName: "${name}",
+            responseStatusCode,
+            errors
+        }),
+    }).then((res) => res.json()) as ${registerOperationResponseType};
+}`;
+        };
+        const generateRegisterMutation = (name: string) => {
+            return `export async function register${name}MutationResponse(sequenceId:string, mutationResponse: ${name}Mutation): Promise<${registerOperationResponseType}> {
+    return await fetch('${fakeEndpoint}', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'sequence-id': sequenceId
+        },
+        body: JSON.stringify({
+            type: "operation",
+            operationName: "${name}",
+            data: mutationResponse
+        }),
+    }).then((res) => res.json()) as ${registerOperationResponseType};
+}`;
+        };
+        const generateRegisterMutationError = (name: string) => {
+            return `export async function register${name}MutationErrorResponse(sequenceId:string, { errors, responseStatusCode }: { errors: Record<string, unknown>[]; responseStatusCode: number }): Promise<${registerOperationResponseType}> {
+    return await fetch('${fakeEndpoint}', {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'sequence-id': sequenceId
+        },
+        body: JSON.stringify({
+            type: "network-error",
+            operationName: "${name}",
+            responseStatusCode,
+            errors
+        }),
+    }).then((res) => res.json()) as ${registerOperationResponseType};
+}`;
+        };
+        const importQueryIdentifierName = (documentName: string) => {
+            return `import type { ${documentName}Query } from '${config.typesFile}';`;
+        };
+        const importMutationIdentifierName = (documentName: string) => {
+            return `import type { ${documentName}Mutation } from '${config.typesFile}';`;
+        };
+        return `/* eslint-disable */
+// This file was generated by a @newmo/graphql-codegen-fake-server-operation
+${documents
+    .flatMap((document) => {
+        return document.document?.definitions?.map((definition) => {
+            // query
+            if (
+                definition.kind === "OperationDefinition" &&
+                definition.operation === "query" &&
+                definition.name
+            ) {
+                return importQueryIdentifierName(definition.name.value);
+            }
+            if (
+                definition.kind === "OperationDefinition" &&
+                definition.operation === "mutation" &&
+                definition.name
+            ) {
+                return importMutationIdentifierName(definition.name.value);
+            }
+            return [];
+        });
+    })
+    .join("\n")}
+${documents
+    .flatMap((document) => {
+        return document.document?.definitions?.flatMap((definition) => {
+            // query
+            if (
+                definition.kind === "OperationDefinition" &&
+                definition.operation === "query" &&
+                definition.name
+            ) {
+                return [
+                    generateRegisterOperation(definition.name.value),
+                    generateRegisterOperationError(definition.name.value),
+                ];
+            }
+            if (
+                definition.kind === "OperationDefinition" &&
+                definition.operation === "mutation" &&
+                definition.name
+            ) {
+                return [
+                    generateRegisterMutation(definition.name.value),
+                    generateRegisterMutationError(definition.name.value),
+                ];
+            }
+            return [];
+        });
+    })
+    .join("\n")}
+`;
+    },
+};
+// GraphQL Codegen Plugin requires CommonJS export
+module.exports = plugin;