Graphql codegen typescript effect

.changeset/eight-ants-flow.md

@@ -0,0 +1,5 @@
+---
+'@graphql-codegen/typescript-effect': minor
+---
+
+Introduces a graphql-codegen plugin for generating a client SDK using Effect

package.json

@@ -11,6 +11,7 @@
     "packages/plugins/other/*",
     "packages/presets/*"
   ],
+  "packageManager": "yarn@1.22.22",
   "scripts": {
     "build": "bob build",
     "ci:lint": "eslint --ext .ts . --output-file eslint_report.json --format json",

packages/plugins/typescript/effect/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('../../../../jest.project')({ dirname: __dirname });

packages/plugins/typescript/effect/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@graphql-codegen/typescript-effect",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "GraphQL Code Generator plugin for generating Effect Platform HTTP Client requests for GraphQL operations",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dotansimha/graphql-code-generator-community.git",
+    "directory": "packages/plugins/typescript/effect"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">= 16.0.0"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/typings/index.d.cts",
+        "default": "./dist/cjs/index.js"
+      },
+      "import": {
+        "types": "./dist/typings/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "default": {
+        "types": "./dist/typings/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "typings": "dist/typings/index.d.ts",
+  "scripts": {
+    "lint": "eslint **/*.ts",
+    "test": "jest --no-watchman --config ../../../../jest.config.js"
+  },
+  "peerDependencies": {
+    "@effect/platform": "~0.48.12",
+    "effect": "^2.4.9",
+    "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0",
+    "graphql-tag": "^2.0.0"
+  },
+  "dependencies": {
+    "@graphql-codegen/plugin-helpers": "^3.0.0",
+    "@graphql-codegen/visitor-plugin-common": "2.13.1",
+    "auto-bind": "~4.0.0",
+    "tslib": "~2.6.0"
+  },
+  "devDependencies": {
+    "@effect/platform": "~0.48.12",
+    "@effect/platform-node": "~0.45.14",
+    "@effect/schema": "^0.64.8",
+    "@graphql-codegen/testing": "1.18.0",
+    "@graphql-tools/schema": "10.0.3",
+    "effect": "2.4.9",
+    "fast-check": "^3.16.0"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "access": "public"
+  },
+  "typescript": {
+    "definition": "dist/typings/index.d.ts"
+  }
+}

packages/plugins/typescript/effect/src/config.ts

@@ -0,0 +1,44 @@
+import { RawClientSideBasePluginConfig } from '@graphql-codegen/visitor-plugin-common';
+
+/**
+ * @description This plugin generates a fully-typed, ready-to-use SDK written with [`effect`](https://effect.website).
+ */
+
+export interface RawEffectPluginConfig extends RawClientSideBasePluginConfig {
+  /**
+   * @description Allows you to override the output mode of the `typescript-effect` codegen plugin. To generate the GraphQL client in a separate file, use the `client-only` and `operations-only` modes, respectively.
+   * @default 'mixed'
+   *
+   * @exampleMarkdown
+   * ```ts filename="codegen.ts"
+   *  import type { CodegenConfig } from '@graphql-codegen/cli';
+   *
+   *  const config: CodegenConfig = {
+   *    // ...
+   *    generates: {
+   *      'path/to/client.ts': {
+   *        plugins: ['typescript-effect'],
+   *        config: {
+   *          mode: 'client-only'
+   *        },
+   *      },
+   *      'path/to/sdk.ts': {
+   *        plugins: ['typescript', 'typescript-operations', 'typescript-effect'],
+   *        config: {
+   *          mode: 'operations-only',
+   *          relativeClientImportPath: './client.js',
+   *        },
+   *      },
+   *    },
+   *  };
+   *  export default config;
+   * ```
+   */
+  mode?: 'client-only' | 'operations-only' | 'mixed';
+
+  /**
+   * @description Specifies the relative import path of the graphql client file. A required config when the mode is set to `operations-only`, ignored in all other cases.
+   * @default undefined
+   */
+  relativeClientImportPath?: string;
+}

packages/plugins/typescript/effect/src/index.ts

@@ -0,0 +1,60 @@
+import { concatAST, type FragmentDefinitionNode, type GraphQLSchema, Kind } from 'graphql';
+import {
+  oldVisit,
+  type PluginFunction,
+  type PluginValidateFn,
+  type Types,
+} from '@graphql-codegen/plugin-helpers';
+import type { LoadedFragment } from '@graphql-codegen/visitor-plugin-common';
+import type { RawEffectPluginConfig } from './config.js';
+import { EffectVisitor } from './visitor.js';
+
+export const plugin: PluginFunction<RawEffectPluginConfig> = (
+  schema: GraphQLSchema,
+  documents: Types.DocumentFile[],
+  config: RawEffectPluginConfig,
+) => {
+  if (config.mode === 'client-only') return EffectVisitor.clientContent();
+
+  const allAst = concatAST(documents.map(v => v.document));
+  const allFragments: LoadedFragment[] = [
+    ...(
+      allAst.definitions.filter(
+        d => d.kind === Kind.FRAGMENT_DEFINITION,
+      ) as FragmentDefinitionNode[]
+    ).map(fragmentDef => ({
+      node: fragmentDef,
+      name: fragmentDef.name.value,
+      onType: fragmentDef.typeCondition.name.value,
+      isExternal: false,
+    })),
+    ...(config.externalFragments || []),
+  ];
+  const visitor = new EffectVisitor(schema, allFragments, config);
+  const visitorResult = oldVisit(allAst, { leave: visitor });
+
+  return {
+    prepend: visitor.getImports(),
+    content: [
+      visitor.fragments,
+      ...visitorResult.definitions.filter(t => typeof t === 'string'),
+      visitor.sdkContent,
+    ].join('\n'),
+  };
+};
+
+export const validate: PluginValidateFn<any> = async (
+  schema: GraphQLSchema,
+  documents: Types.DocumentFile[],
+  config: RawEffectPluginConfig,
+  outputFile: string,
+) => {
+  if (
+    config.mode === 'operations-only' &&
+    (!config.relativeClientImportPath || config.relativeClientImportPath.length === 0)
+  ) {
+    throw new Error(
+      `Plugin "typescript-effect" requires the "relativeClientImportPath" configuration option to be a non-empty string when "mode" is set to "operations-only"!`,
+    );
+  }
+};