@newmo/graphql-codegen-fake-server-client 0.9.0 → 0.9.7

package/README.md

@@ -80,6 +80,10 @@ it("register fake response for query", async () => {
 
 - `typesFile` (required): Path to the generated client's graphql file.
 - `fakeServerEndpoint` (optional): Fake server endpoint. Default is `http://127.0.0.1:4000/fake`.
+- `namingConvention` (optional): Naming convention for the generated types. Default is `change-case#pascalCase`.
+  - [Naming Convention](https://the-guild.dev/graphql/codegen/docs/config-reference/naming-convention)
+- `typesPrefix` (optional): Prefix for the generated types.
+- `typesSuffix` (optional): Suffix for the generated types.
 
 ## License
 

package/dist/config.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeConfig = void 0;
+function normalizeConfig(rawConfig) {
+    return {
+        typesFile: rawConfig.typesFile,
+        fakeServerEndpoint: rawConfig.fakeServerEndpoint ?? "http://127.0.0.1:4000/fake",
+        typesPrefix: rawConfig.typesPrefix ?? "",
+        typesSuffix: rawConfig.typesSuffix ?? "",
+        namingConvention: rawConfig.namingConvention ?? "",
+    };
+}
+exports.normalizeConfig = normalizeConfig;

package/dist/convertName.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertName = void 0;
+const visitor_plugin_common_1 = require("@graphql-codegen/visitor-plugin-common");
+function convertName(node, config) {
+    const convert = config.namingConvention
+        ? (0, visitor_plugin_common_1.convertFactory)({ namingConvention: config.namingConvention })
+        : (0, visitor_plugin_common_1.convertFactory)({});
+    let convertedName = "";
+    convertedName += config.typesPrefix;
+    convertedName += convert(node);
+    convertedName += config.typesSuffix;
+    return convertedName;
+}
+exports.convertName = convertName;

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

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("./config");
+const convertName_1 = require("./convertName");
 const plugin = {
-    plugin(schema, documents, config, _info) {
-        console.log(config);
-        const fakeEndpoint = config.fakeServerEndpoint || "http://127.0.0.1:4000/fake";
+    plugin(schema, documents, rawConfig, _info) {
+        const config = (0, config_1.normalizeConfig)(rawConfig);
+        const fakeEndpoint = config.fakeServerEndpoint;
         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}> {
@@ -72,10 +74,10 @@ const plugin = {
 }`;
         };
         const importQueryIdentifierName = (documentName) => {
-            return `import type { ${documentName}Query } from '${config.typesFile}';`;
+            return `import type { ${(0, convertName_1.convertName)(documentName, config)}Query } from '${config.typesFile}';`;
         };
         const importMutationIdentifierName = (documentName) => {
-            return `import type { ${documentName}Mutation } from '${config.typesFile}';`;
+            return `import type { ${(0, convertName_1.convertName)(documentName, config)}Mutation } from '${config.typesFile}';`;
         };
         return `/* eslint-disable */
 // This file was generated by a @newmo/graphql-codegen-fake-server-operation
@@ -105,16 +107,16 @@ ${documents
                     definition.operation === "query" &&
                     definition.name) {
                     return [
-                        generateRegisterOperation(definition.name.value),
-                        generateRegisterOperationError(definition.name.value),
+                        generateRegisterOperation((0, convertName_1.convertName)(definition.name.value, config)),
+                        generateRegisterOperationError((0, convertName_1.convertName)(definition.name.value, config)),
                     ];
                 }
                 if (definition.kind === "OperationDefinition" &&
                     definition.operation === "mutation" &&
                     definition.name) {
                     return [
-                        generateRegisterMutation(definition.name.value),
-                        generateRegisterMutationError(definition.name.value),
+                        generateRegisterMutation((0, convertName_1.convertName)(definition.name.value, config)),
+                        generateRegisterMutationError((0, convertName_1.convertName)(definition.name.value, config)),
                     ];
                 }
                 return [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newmo/graphql-codegen-fake-server-client",
-  "version": "0.9.0",
+  "version": "0.9.7",
   "private": false,
   "description": "GraphQL Codegen plugin for generating a fake server client",
   "keywords": [
@@ -32,11 +32,12 @@
     "prepare": "npm run build",
     "build": "tsc",
     "lint": "tsc --noEmit",
-    "test": "npm run build && npm run codege",
+    "test": "npm run build && npm run codegen",
     "codegen": "graphql-codegen --config graphql-codegen.ts"
   },
   "dependencies": {
-    "@graphql-codegen/plugin-helpers": "^5.0.3"
+    "@graphql-codegen/plugin-helpers": "^5.0.3",
+    "@graphql-codegen/visitor-plugin-common": "^5.2.0"
   },
   "devDependencies": {
     "@graphql-codegen/cli": "^5.0.0",
@@ -58,5 +59,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "94e485d0fd79df45ca57fb8cd8f650ac878e4888"
+  "gitHead": "35f4b493d4d352571fcd9b224df5d42c155fdf55"
 }

package/src/config.ts

@@ -0,0 +1,41 @@
+import type { RawTypesConfig } from "@graphql-codegen/visitor-plugin-common";
+
+export type RawPluginConfig = {
+    /**
+     * 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;
+    /**
+     * Naming convention for the generated types
+     * GraphQL Codegen Plugin Common Options
+     **/
+    namingConvention?: RawTypesConfig["namingConvention"];
+    /**
+     * Prefix for the generated types
+     * GraphQL Codegen Plugin Common Options
+     **/
+    typesPrefix?: RawTypesConfig["typesPrefix"];
+    /**
+     * Suffix for the generated types
+     * GraphQL Codegen Plugin Common Options
+     **/
+    typesSuffix?: RawTypesConfig["typesSuffix"];
+};
+export type PluginConfig = Required<RawPluginConfig>;
+
+export function normalizeConfig(rawConfig: RawPluginConfig): PluginConfig {
+    return {
+        typesFile: rawConfig.typesFile,
+        fakeServerEndpoint: rawConfig.fakeServerEndpoint ?? "http://127.0.0.1:4000/fake",
+        typesPrefix: rawConfig.typesPrefix ?? "",
+        typesSuffix: rawConfig.typesSuffix ?? "",
+        namingConvention: rawConfig.namingConvention ?? "",
+    };
+}

package/src/convertName.ts

@@ -0,0 +1,14 @@
+import { convertFactory } from "@graphql-codegen/visitor-plugin-common";
+import type { ASTNode } from "graphql/index.js";
+import type { PluginConfig } from "./config";
+
+export function convertName(node: ASTNode | string, config: PluginConfig): string {
+    const convert = config.namingConvention
+        ? convertFactory({ namingConvention: config.namingConvention })
+        : convertFactory({});
+    let convertedName = "";
+    convertedName += config.typesPrefix;
+    convertedName += convert(node);
+    convertedName += config.typesSuffix;
+    return convertedName;
+}

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

@@ -1,22 +1,11 @@
 import type { CodegenPlugin } from "@graphql-codegen/plugin-helpers";
+import { type RawPluginConfig, normalizeConfig } from "./config";
+import { convertName } from "./convertName";
 
-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 plugin: CodegenPlugin<RawPluginConfig> = {
+    plugin(schema, documents, rawConfig, _info) {
+        const config = normalizeConfig(rawConfig);
+        const fakeEndpoint = config.fakeServerEndpoint;
         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}> {
@@ -85,10 +74,14 @@ const plugin: CodegenPlugin<PluginConfig> = {
 }`;
         };
         const importQueryIdentifierName = (documentName: string) => {
-            return `import type { ${documentName}Query } from '${config.typesFile}';`;
+            return `import type { ${convertName(documentName, config)}Query } from '${
+                config.typesFile
+            }';`;
         };
         const importMutationIdentifierName = (documentName: string) => {
-            return `import type { ${documentName}Mutation } from '${config.typesFile}';`;
+            return `import type { ${convertName(documentName, config)}Mutation } from '${
+                config.typesFile
+            }';`;
         };
         return `/* eslint-disable */
 // This file was generated by a @newmo/graphql-codegen-fake-server-operation
@@ -124,8 +117,8 @@ ${documents
                 definition.name
             ) {
                 return [
-                    generateRegisterOperation(definition.name.value),
-                    generateRegisterOperationError(definition.name.value),
+                    generateRegisterOperation(convertName(definition.name.value, config)),
+                    generateRegisterOperationError(convertName(definition.name.value, config)),
                 ];
             }
             if (
@@ -134,8 +127,8 @@ ${documents
                 definition.name
             ) {
                 return [
-                    generateRegisterMutation(definition.name.value),
-                    generateRegisterMutationError(definition.name.value),
+                    generateRegisterMutation(convertName(definition.name.value, config)),
+                    generateRegisterMutationError(convertName(definition.name.value, config)),
                 ];
             }
             return [];