@vantreeseba/graphql-mocks-codegen 2.1.0 → 2.2.0

package/dist/cjs/index.js

@@ -0,0 +1,74 @@
+"use strict";
+/**
+ * A [GraphQL Code Generator](https://the-guild.dev/graphql/codegen) plugin that
+ * emits a `SchemaTypeMap` — a `{ TypeName: GeneratedType }` map of every object
+ * type in your schema — so you can hand it to
+ * [`@vantreeseba/graphql-mocks`](../graphql-mocks)'s `buildMocks<TTypes>` and get
+ * typed mock pools back without a cast:
+ *
+ * ```ts
+ * import { buildMocks } from '@vantreeseba/graphql-mocks';
+ * import type { SchemaTypeMap } from './__generated__/schema-type-map';
+ *
+ * const mocks = buildMocks<SchemaTypeMap>(schema);
+ * mocks.User; // User[] — typed, no cast
+ * ```
+ *
+ * The map KEY is the raw GraphQL type name (what the mock pools are keyed by at
+ * runtime, e.g. `AWS_Address`); the VALUE references the generated TS type, whose
+ * name comes from codegen's own naming convention via `convertFactory`, so the
+ * references stay correct even if the naming convention changes.
+ *
+ * Run it pointed at the same generated types file your `typescript` plugin /
+ * `client` preset emits (default import path `./graphql`).
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = exports.plugin = void 0;
+const visitor_plugin_common_1 = require("@graphql-codegen/visitor-plugin-common");
+const graphql_1 = require("graphql");
+const DEFAULTS = {
+    typeMapName: 'SchemaTypeMap',
+    typesImportPath: './graphql',
+    typesNamespace: 'Types',
+};
+/**
+ * The schema's mockable object type names: every object type, excluding the root
+ * operation types (Query/Mutation/Subscription) — which aren't mocked as pools —
+ * and introspection types (`__*`), sorted for deterministic output.
+ */
+function objectTypeNames(schema) {
+    const roots = new Set([schema.getQueryType(), schema.getMutationType(), schema.getSubscriptionType()]
+        .filter((type) => type != null)
+        .map((type) => type.name));
+    return Object.values(schema.getTypeMap())
+        .filter((type) => (0, graphql_1.isObjectType)(type) && !type.name.startsWith('__') && !roots.has(type.name))
+        .map((type) => type.name)
+        .sort();
+}
+const plugin = (schema, _documents, config) => {
+    const opts = { ...DEFAULTS, ...config };
+    // `convertFactory` maps a GraphQL type name to its generated TS type name using
+    // codegen's own naming convention (read from `config`), so we don't hard-code it.
+    const convert = (0, visitor_plugin_common_1.convertFactory)(config ?? {});
+    const names = objectTypeNames(schema);
+    const entries = names
+        .map((name) => `  ${name}: ${opts.typesNamespace}.${convert(name)};`)
+        .join('\n');
+    const body = entries ? `{\n${entries}\n}` : '{}';
+    return {
+        prepend: [`import type * as ${opts.typesNamespace} from '${opts.typesImportPath}';`],
+        content: `export type ${opts.typeMapName} = ${body};\n`,
+    };
+};
+exports.plugin = plugin;
+const validate = async (_schema, _documents, config) => {
+    for (const key of ['typeMapName', 'typesImportPath', 'typesNamespace']) {
+        const value = config?.[key];
+        if (value !== undefined && typeof value !== 'string') {
+            throw new Error(`graphql-mocks-codegen: config option \`${key}\` must be a string.`);
+        }
+    }
+};
+exports.validate = validate;

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vantreeseba/graphql-mocks-codegen",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "GraphQL Code Generator plugin that emits a SchemaTypeMap for typing @vantreeseba/graphql-mocks pools.",
   "type": "module",
   "author": "Benjamin Van Treese <vantreeseba@gmail.com>",
@@ -26,7 +26,8 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/cjs/index.js"
     }
   },
   "files": [
@@ -36,7 +37,9 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc",
+    "build:cjs": "tsc -p tsconfig.cjs.json && node scripts/finalize-cjs.mjs",
     "typecheck": "tsc --noEmit",
     "typecheck:tests": "tsc -p tsconfig.tests.json",
     "test": "vitest run",
@@ -51,7 +54,9 @@
     "graphql": ">=16"
   },
   "devDependencies": {
+    "@graphql-codegen/cli": "^5.0.0",
     "@graphql-codegen/plugin-helpers": "^5.1.1",
+    "@graphql-codegen/typescript": "^4.0.0",
     "graphql": "^16.14.0"
   }
 }