Initial commit

Author: rubengrill

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+lib

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "plugins": ["./node_modules/prettier-plugin-import-sort"]
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dotan Simha
+
+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.json

@@ -0,0 +1,51 @@
+{
+  "name": "apollo-typed-documents",
+  "version": "0.0.1",
+  "description": "Get type safety for your apollo documents.",
+  "keywords": [
+    "apollo",
+    "graphql",
+    "codegen"
+  ],
+  "homepage": "https://github.com/rubengrill/apollo-typed-documents",
+  "repository": {
+    "url": "https://github.com/rubengrill/apollo-typed-documents",
+    "type": "git"
+  },
+  "author": "Ruben Grill <[email protected]>",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "files": [
+    "src",
+    "lib"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "yarn run build",
+    "postversion": "git push && git push --tags"
+  },
+  "peerDependencies": {
+    "graphql": "^14.6.0",
+    "pascal-case": "^3.1.1"
+  },
+  "devDependencies": {
+    "@apollo/react-common": "^3.1.4",
+    "@apollo/react-hooks": "^3.1.4",
+    "@graphql-codegen/plugin-helpers": "^1.13.2",
+    "@types/node": "^13.11.1",
+    "@types/react": "^16.9.34",
+    "apollo-boost": "^0.4.7",
+    "graphql": "^14.6.0",
+    "import-sort-style-module": "^6.0.0",
+    "pascal-case": "^3.1.1",
+    "prettier": "^2.0.4",
+    "prettier-plugin-import-sort": "^0.0.4",
+    "typescript": "^3.8.3"
+  },
+  "importSort": {
+    ".ts": {
+      "style": "module",
+      "parser": "typescript"
+    }
+  }
+}

src/codegenApolloMock.ts

@@ -0,0 +1,24 @@
+import { PluginFunction } from "@graphql-codegen/plugin-helpers";
+import { visit } from "graphql";
+
+import MockVisitor from "./visitors/MockVisitor";
+import TypedVisitor from "./visitors/TypedVisitor";
+
+export const plugin: PluginFunction = (schema, documents) => {
+  const documentNodes = documents.map((document) => document.document!);
+  const output: String[] = [];
+
+  output.push('import { createApolloMock } from "apollo-typed-documents";');
+  output.push("const operations = {};");
+  output.push("export default createApolloMock(operations);");
+
+  documentNodes.forEach((documentNode) => {
+    const typedVisitor = new TypedVisitor(schema);
+    const mockVisitor = new MockVisitor(output);
+    const typedDocumentNode = visit(documentNode, typedVisitor);
+
+    visit(typedDocumentNode, mockVisitor);
+  });
+
+  return output.join("\n\n");
+};

src/codegenTypedDocuments.ts

@@ -0,0 +1,50 @@
+import path from "path";
+
+import {
+  PluginFunction,
+  PluginValidateFn,
+} from "@graphql-codegen/plugin-helpers";
+import { visit } from "graphql";
+
+import TypedDocumentVisitor from "./visitors/TypedDocumentVisitor";
+import TypedVisitor from "./visitors/TypedVisitor";
+
+export type Config = { typesModule: string };
+
+export const plugin: PluginFunction<Config> = (schema, documents, config) => {
+  const output: String[] = [];
+
+  documents.forEach((document) => {
+    const basename = path.basename(document.location!);
+    const typedVisitor = new TypedVisitor(schema);
+    const typedDocumentVisitor = new TypedDocumentVisitor(
+      output,
+      basename,
+      config
+    );
+    const typedDocumentNode = visit(document.document!, typedVisitor);
+
+    visit(typedDocumentNode, typedDocumentVisitor);
+  });
+
+  return output.join("\n\n");
+};
+
+export const validate: PluginValidateFn<Config> = (
+  _schema,
+  _documents,
+  config
+) => {
+  if (!config.typesModule) {
+    throw new Error(`You must specify "typesModule"!`);
+  }
+
+  if (
+    config.typesModule.startsWith("./") ||
+    config.typesModule.startsWith("../")
+  ) {
+    throw new Error(
+      `You must specify a non relative module for "typesModule"!`
+    );
+  }
+};

src/createApolloMock.ts

@@ -0,0 +1,43 @@
+import { OperationDefinitionNode } from "graphql";
+
+import { OperationVariables, TypedDocumentNode } from "./types";
+
+export interface ApolloMock<TVariables extends OperationVariables, TData> {
+  request: {
+    query: TypedDocumentNode<TVariables, TData>;
+    variables: TVariables;
+  };
+  result: {
+    data: TData;
+  };
+}
+
+export default (operations: any) => <
+  TVariables extends OperationVariables,
+  TData,
+  TInput extends TVariables = TVariables,
+  TOutput extends TData = TData
+>(
+  documentNode: TypedDocumentNode<TVariables, TData>,
+  variables: TInput,
+  data: TOutput
+): ApolloMock<TVariables, TData> => {
+  const definitionNode = documentNode.definitions[0];
+  const operationNode = definitionNode as OperationDefinitionNode;
+  const operationName = operationNode.name!.value;
+  const operation = operations[operationName];
+
+  if (!operation) {
+    throw new Error(`Couldn't find operation "${operationName}"`);
+  }
+
+  return {
+    request: {
+      query: documentNode,
+      variables,
+    },
+    result: {
+      data: operation(data),
+    },
+  };
+};

src/index.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export { default as createApolloMock } from "./createApolloMock";

src/reactHooks.ts

@@ -0,0 +1,32 @@
+declare module "@apollo/react-hooks" {
+  import {
+    OperationVariables,
+    TypedDocumentNode,
+  } from "apollo-typed-documents";
+  import { QueryResult } from "@apollo/react-common";
+  import {
+    MutationHookOptions,
+    MutationTuple,
+    QueryHookOptions,
+  } from "@apollo/react-hooks/lib/types";
+
+  export * from "@apollo/react-hooks/lib/index";
+
+  export function useQuery<
+    TData,
+    TVariables extends OperationVariables,
+    TOptions extends QueryHookOptions<TData, TVariables>
+  >(
+    query: TypedDocumentNode<TVariables, TData>,
+    options?: TOptions
+  ): QueryResult<TData, TVariables>;
+
+  export function useMutation<
+    TData,
+    TVariables extends OperationVariables,
+    TOptions extends MutationHookOptions<TData, TVariables>
+  >(
+    mutation: TypedDocumentNode<TVariables, TData>,
+    options?: TOptions
+  ): MutationTuple<TData, TVariables>;
+}

src/types.ts

@@ -0,0 +1,8 @@
+import { DocumentNode } from "graphql";
+
+export type OperationVariables = Record<string, any>;
+
+export interface TypedDocumentNode<
+  TVariables extends OperationVariables,
+  TData
+> extends DocumentNode {}