@vantreeseba/graphql-mocks-codegen 2.0.0

package/README.md

@@ -0,0 +1,91 @@
+# @vantreeseba/graphql-mocks-codegen
+
+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.
+
+## Install
+
+```bash
+npm install -D @vantreeseba/graphql-mocks-codegen
+# peer deps you already have for codegen
+npm install -D @graphql-codegen/cli @graphql-codegen/typescript
+# the runtime the type map is used with
+npm install @vantreeseba/graphql-mocks
+```
+
+## Usage
+
+Point the plugin at the same generated types file your `typescript` plugin (or
+the `client` preset) emits — by default it imports from `./graphql`.
+
+```ts
+// codegen.ts
+import type { CodegenConfig } from '@graphql-codegen/cli';
+
+const config: CodegenConfig = {
+  schema: './schema.graphql',
+  generates: {
+    // your existing typed output
+    './src/__generated__/graphql.ts': {
+      plugins: ['typescript'],
+    },
+    // the type map, emitted alongside it
+    './src/__generated__/schema-type-map.ts': {
+      plugins: ['@vantreeseba/graphql-mocks-codegen'],
+    },
+  },
+};
+
+export default config;
+```
+
+Then type your mock pools straight off the generated map:
+
+```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
+mocks.find('Todo', (t) => t.done);   // Todo | undefined — predicate item typed
+```
+
+### Generated output
+
+For a schema with `User` and `Todo` object types, the plugin emits:
+
+```ts
+import type * as Types from './graphql';
+
+export type SchemaTypeMap = {
+  Todo: Types.Todo;
+  User: Types.User;
+};
+```
+
+The map KEY is the raw GraphQL type name (what the mock pools are keyed by at
+runtime); the VALUE references the generated TS type via codegen's own naming
+convention, so it stays correct even if you change `namingConvention`. Root
+operation types (`Query`/`Mutation`/`Subscription`) and introspection types are
+excluded; entries are sorted for deterministic output.
+
+## Configuration
+
+All options are optional strings:
+
+| Option | Default | Description |
+|---|---|---|
+| `typeMapName` | `SchemaTypeMap` | Name of the generated type-map type. |
+| `typesImportPath` | `./graphql` | Module the generated TS types are imported from. |
+| `typesNamespace` | `Types` | Namespace alias the generated types are imported under. |
+
+```ts
+'./src/__generated__/schema-type-map.ts': {
+  plugins: ['@vantreeseba/graphql-mocks-codegen'],
+  config: { typeMapName: 'MockTypes', typesImportPath: '../gen/types' },
+},
+```

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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
+ */
+import type { PluginFunction, PluginValidateFn } from '@graphql-codegen/plugin-helpers';
+import { type NamingConvention } from '@graphql-codegen/visitor-plugin-common';
+/** Configuration for the {@link plugin}. Every field has a sensible default. */
+export interface GraphqlMocksPluginConfig {
+    /** Name of the generated type-map type. Default `SchemaTypeMap`. */
+    typeMapName?: string;
+    /** Module path the generated TS types are imported from. Default `./graphql`. */
+    typesImportPath?: string;
+    /** Namespace alias the generated types are imported under. Default `Types`. */
+    typesNamespace?: string;
+    /**
+     * The codegen naming convention used to derive generated TS type names from
+     * GraphQL type names. Set this to match the convention used by the `typescript`
+     * plugin / `client` preset producing `typesImportPath`. Passed straight to
+     * codegen's `convertFactory`.
+     */
+    namingConvention?: NamingConvention;
+}
+export declare const plugin: PluginFunction<GraphqlMocksPluginConfig>;
+export declare const validate: PluginValidateFn;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACxF,OAAO,EAAE,KAAK,gBAAgB,EAAkB,MAAM,wCAAwC,CAAC;AAG/F,gFAAgF;AAChF,MAAM,WAAW,wBAAwB;IACvC,oEAAoE;IACpE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iFAAiF;IACjF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+EAA+E;IAC/E,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AA2BD,eAAO,MAAM,MAAM,EAAE,cAAc,CAAC,wBAAwB,CAgB3D,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,gBAOtB,CAAC"}

package/dist/index.js

@@ -0,0 +1,70 @@
+/**
+ * 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
+ */
+import { convertFactory } from '@graphql-codegen/visitor-plugin-common';
+import { isObjectType } from '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) => isObjectType(type) && !type.name.startsWith('__') && !roots.has(type.name))
+        .map((type) => type.name)
+        .sort();
+}
+export 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 = 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`,
+    };
+};
+export 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.`);
+        }
+    }
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAGH,OAAO,EAAyB,cAAc,EAAE,MAAM,wCAAwC,CAAC;AAC/F,OAAO,EAAsB,YAAY,EAAE,MAAM,SAAS,CAAC;AAmB3D,MAAM,QAAQ,GAAG;IACf,WAAW,EAAE,eAAe;IAC5B,eAAe,EAAE,WAAW;IAC5B,cAAc,EAAE,OAAO;CAGxB,CAAC;AAEF;;;;GAIG;AACH,SAAS,eAAe,CAAC,MAAqB;IAC5C,MAAM,KAAK,GAAG,IAAI,GAAG,CACnB,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC,eAAe,EAAE,EAAE,MAAM,CAAC,mBAAmB,EAAE,CAAC;SAC5E,MAAM,CAAC,CAAC,IAAI,EAAoC,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC;SAChE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5B,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;SACtC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC5F,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;SACxB,IAAI,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,CAAC,MAAM,MAAM,GAA6C,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE;IAC7F,MAAM,IAAI,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;IACxC,gFAAgF;IAChF,kFAAkF;IAClF,MAAM,OAAO,GAAG,cAAc,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAEtC,MAAM,OAAO,GAAG,KAAK;SAClB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;SACpE,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IAEjD,OAAO;QACL,OAAO,EAAE,CAAC,oBAAoB,IAAI,CAAC,cAAc,UAAU,IAAI,CAAC,eAAe,IAAI,CAAC;QACpF,OAAO,EAAE,eAAe,IAAI,CAAC,WAAW,MAAM,IAAI,KAAK;KACxD,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAqB,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE;IAC9E,KAAK,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,iBAAiB,EAAE,gBAAgB,CAAU,EAAE,CAAC;QAChF,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,0CAA0C,GAAG,sBAAsB,CAAC,CAAC;QACvF,CAAC;IACH,CAAC;AACH,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@vantreeseba/graphql-mocks-codegen",
+  "version": "2.0.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>",
+  "license": "MIT",
+  "homepage": "https://github.com/vantreeseba/graphql-mocks#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vantreeseba/graphql-mocks.git",
+    "directory": "packages/graphql-mocks-codegen"
+  },
+  "bugs": {
+    "url": "https://github.com/vantreeseba/graphql-mocks/issues"
+  },
+  "keywords": [
+    "graphql",
+    "graphql-codegen",
+    "graphql-code-generator",
+    "codegen",
+    "plugin",
+    "mocks",
+    "typescript"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "typecheck:tests": "tsc -p tsconfig.tests.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "@graphql-codegen/visitor-plugin-common": "^5.8.0"
+  },
+  "peerDependencies": {
+    "@graphql-codegen/plugin-helpers": ">=5",
+    "graphql": ">=16"
+  },
+  "devDependencies": {
+    "@graphql-codegen/plugin-helpers": "^5.1.1",
+    "graphql": "^16.14.0"
+  }
+}