fixes and cleanup

break to packages

Author: dotansimha

README.md

@@ -22,10 +22,19 @@ This project works in the following way:
 
 Most libraries supports `DocumentNode` as the type of the query object, but that's not enough to use this library. 
 
+Our goal is to get built-in support in major libraries, in order
+
 In order to extend the behavior, we are using `patch-package` library internally, to add support for `TypedDocumentNode` and add the support for type inference. 
 
 The following patches are currently supported:
 
+## Built-in
+
+- `@apollo/client` (since `v3.2.0`)
+- `apollo-angular` (v2)
+
+## With Patch
+
 - `graphql` (`14.7.0`, `15.0.0`, `15.1.0`, `~15.2.0`)
 - `@apollo/client` (`~3.0.0`, `~3.1.0`)
 - `apollo-client` (`~2.6.10`, including `apollo-cache`)
@@ -69,7 +78,15 @@ generates:
 
 3. Try to run codegen by using: `yarn graphql-codegen`, it should create the `./src/graphql-operations.ts` file for you, with the generated `TypedDocumentNode` objects.
 
-4. Configure the patch CLI to run as `postinstall` script:
+If you are using a library that doesn't support `TypedDocumentNode` yet, you can apply a patch, by doing:
+
+1. Install the patch-cli:
+
+```
+yarn add -D @graphql-typed-document-node/patch-cli
+```
+
+2. Configure the patch CLI to run as `postinstall` script:
 
 ```json
 {
@@ -79,6 +96,8 @@ generates:
 }
 ```
 
+5. Reinstall dependencies (using npm or yarn) - it will now patch the relevant libraries.
+
 Now, after installing your projects' dependencies, it will make sure to patch all relevant packages and make it available for use with `TypedDocumentNode`.
 
 ## How can I support this in my library?

examples/apollo-client-3/package.json

@@ -1,7 +1,7 @@
 {
   "name": "apollo-client-example",
   "private": true,
-  "version": "2.0.0",
+  "version": "2.1.0",
   "scripts": {
     "postinstall": "patch-typed-document-node && yarn generate",
     "generate": "graphql-codegen",
@@ -12,8 +12,9 @@
     "@types/node": "14.0.23",
     "graphql": "15.3.0",
     "typescript": "3.9.7",
-    "@apollo/client": "3.1.0",
-    "@graphql-typed-document-node/core": "2.0.0",
+    "@apollo/client": "3.1.2",
+    "@graphql-typed-document-node/core": "2.1.0",
+    "@graphql-typed-document-node/patch-cli": "2.1.0",
     "@graphql-codegen/typed-document-node": "1.17.7",
     "@graphql-codegen/cli": "1.17.7",
     "@graphql-codegen/typescript": "1.17.7",

examples/graphql/package.json

@@ -1,7 +1,7 @@
 {
   "name": "graphql-example",
   "private": true,
-  "version": "2.0.0",
+  "version": "2.1.0",
   "scripts": {
     "postinstall": "patch-typed-document-node && yarn generate",
     "generate": "graphql-codegen",
@@ -12,7 +12,8 @@
     "@types/node": "14.0.23",
     "graphql": "15.3.0",
     "typescript": "3.9.7",
-    "@graphql-typed-document-node/core": "2.0.0",
+    "@graphql-typed-document-node/core": "2.1.0",
+    "@graphql-typed-document-node/patch-cli": "2.1.0",
     "@graphql-codegen/typed-document-node": "1.17.7",
     "@graphql-codegen/cli": "1.17.7",
     "@graphql-codegen/typescript": "1.17.7",

packages/core/package.json

@@ -11,41 +11,19 @@
   "typescript": {
     "definition": "dist/index.d.ts"
   },
-  "bin": {
-    "patch-typed-document-node": "dist/patch-cli.js"
-  },
   "scripts": {
     "test": "jest",
     "prepack": "bob prepack"
   },
-  "dependencies": {
-    "patch-package": "6.2.2",
-    "semver": "7.3.2"
-  },
   "devDependencies": {
     "bob-the-bundler": "1.1.0",
-    "@types/tmp": "0.2.0",
-    "tmp": "0.2.1",
-    "@types/semver": "7.3.1",
-    "@graphql-codegen/typed-document-node": "1.17.4",
-    "@graphql-codegen/cli": "1.17.4",
-    "@graphql-codegen/typescript": "1.17.4",
-    "@graphql-codegen/typescript-operations": "1.17.4",
     "graphql": "15.3.0",
     "typescript": "3.9.7"
   },
   "peerDependencies": {
     "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"
   },
   "buildOptions": {
-    "copy": [
-      "src/patches/*.patch"
-    ],
-    "bin": {
-      "patch-typed-document-node": {
-        "input": "src/patch-cli.ts"
-      }
-    },
     "input": "./src/index.ts"
   },
   "publishConfig": {

packages/core/src/index.ts

@@ -1,3 +1,3 @@
 import { DocumentNode } from 'graphql';
 
-export interface TypedDocumentNode<Result = {}, Variables = {}> extends DocumentNode {}
+export interface TypedDocumentNode<Result = { [key: string]: any }, Variables = { [key: string]: any }> extends DocumentNode { }

packages/patch-cli/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@graphql-typed-document-node/patch-cli",
+  "version": "2.1.0",
+  "repository": "git@github.com:dotansimha/graphql-typed-document-node.git",
+  "author": "Dotan Simha <dotansimha@gmail.com>",
+  "license": "MIT",
+  "sideEffects": false,
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/index.d.ts",
+  "typescript": {
+    "definition": "dist/index.d.ts"
+  },
+  "bin": {
+    "patch-typed-document-node": "dist/patch-cli.js"
+  },
+  "scripts": {
+    "test": "jest",
+    "prepack": "bob prepack"
+  },
+  "dependencies": {
+    "patch-package": "6.2.2",
+    "semver": "7.3.2"
+  },
+  "devDependencies": {
+    "bob-the-bundler": "1.1.0",
+    "@types/tmp": "0.2.0",
+    "tmp": "0.2.1",
+    "@types/semver": "7.3.1",
+    "@graphql-codegen/typed-document-node": "1.17.4",
+    "@graphql-codegen/cli": "1.17.4",
+    "@graphql-codegen/typescript": "1.17.4",
+    "@graphql-codegen/typescript-operations": "1.17.4",
+    "graphql": "15.3.0",
+    "typescript": "3.9.7"
+  },
+  "peerDependencies": {
+    "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"
+  },
+  "buildOptions": {
+    "copy": [
+      "src/patches/*.patch"
+    ],
+    "bin": {
+      "patch-typed-document-node": {
+        "input": "src/patch-cli.ts"
+      }
+    },
+    "input": "./src/index.ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/patch-cli/src/index.ts

@@ -0,0 +1,2 @@
+export * from './patch';
+export * from './patch-cli';