commit 4b4225738597157d1f4e8911f22d28c96e5333fe · kitten.sh/graphql-web-lite

+305

README.md

···

       1
       1
       +
       <div align="center">

     

       2
       2
       +
         <h2 align="center">graphql-web-lite</h2>

     

       3
       3
       +
         <p align="center"><strong>The small sibling of the <code>graphql</code> package, slimmed down for client-side libraries</strong></p>

     

       4
       4
       +
         <br />

     

       5
       5
       +
         <a href="https://npmjs.com/package/graphql-web-lite">

     

       6
       6
       +
           <img alt="NPM Version" src="https://img.shields.io/npm/v/graphql-web-lite.svg" />

     

       7
       7
       +
         </a>

     

       8
       8
       +
         <a href="https://npmjs.com/package/use-interactions">

     

       9
       9
       +
           <img alt="License" src="https://img.shields.io/npm/l/graphql-web-lite.svg" />

     

       10
       10
       +
         </a>

     

       11
       11
       +
         <a href="https://bundlephobia.com/result?p=graphql-web-lite">

     

       12
       12
       +
           <img alt="Minified gzip size" src="https://img.shields.io/bundlephobia/minzip/graphql-web-lite.svg?label=gzip%20size" />

     

       13
       13
       +
         </a>

     

       14
       14
       +
         <br />

     

       15
       15
       +
         <br />

     

       16
       16
       +
       </div>

     

       17
       17
       +
       

     

       18
       18
       +
       The `graphql` package serves two purposes in being the reference implementation of the

     

       19
       19
       +
       [GraphQL specification](https://spec.graphql.org/) and being used as the shared toolkit

     

       20
       20
       +
       for implementing GraphQL in client-side and server-side JavaScript applications. This

     

       21
       21
       +
       can cause bloat for client-side apps, where we'd rather choose lower bundlesize impact

     

       22
       22
       +
       over fidelity.

     

       23
       23
       +
       

     

       24
       24
       +
       `graphql-web-lite` is an **experimental** library, providing an alias package that can

     

       25
       25
       +
       be swapped in for the standard `graphql` package in client-side applications.

     

       26
       26
       +
       It aims to reduce the size of imports that are in common use by GraphQL clients and

     

       27
       27
       +
       users, while still providing most `graphql` exports that are used in other contexts.

     

       28
       28
       +
       

     

       29
       29
       +
       ## Installation

     

       30
       30
       +
       

     

       31
       31
       +
       `graphql-web-lite` mirrors the folder structure of the regular `graphql` package and

     

       32
       32
       +
       includes mostly the same files and imports as the `graphql` package, minus a couple

     

       33
       33
       +
       that aren't commonly used for client-side GraphQL.

     

       34
       34
       +
       This offers us several installation options, depending on how the package is aliased

     

       35
       35
       +
       to the regular `"graphql"` import.

     

       36
       36
       +
       

     

       37
       37
       +
       <details>

     

       38
       38
       +
       <summary><strong>Installation with <code>package.json</code> aliases</strong></summary>

     

       39
       39
       +
       

     

       40
       40
       +
       When your dependencies and `node_modules` folder isn't used by a _GraphQL server_ and

     

       41
       41
       +
       only used by a _GraphQL clients_, you can use a quick and easy npm installation alias.

     

       42
       42
       +
       In your `package.json` file you can define your `graphql` installation to use

     

       43
       43
       +
       `graphql-web-lite` instead, which is supported by both Yarn and npm:

     

       44
       44
       +
       

     

       45
       45
       +
       ```diff

     

       46
       46
       +
       {

     

       47
       47
       +
         "dependencies": {

     

       48
       48
       +
       -    "graphql": "^15.5.0"

     

       49
       49
       +
       +    "graphql": "npm:graphql-web-lite@^15.5.1000"

     

       50
       50
       +
         }

     

       51
       51
       +
       }

     

       52
       52
       +
       ```

     

       53
       53
       +
       

     

       54
       54
       +
       Alternatively, you can run an installation command to alias the package:<br />

     

       55
       55
       +
       

     

       56
       56
       +
       ```sh

     

       57
       57
       +
       npm install --save graphql@npm:graphql-web-lite

     

       58
       58
       +
       # or

     

       59
       59
       +
       yarn add graphql@npm:graphql-web-lite

     

       60
       60
       +
       ```

     

       61
       61
       +
       

     

       62
       62
       +
       When this isn't suitable — for instance, because the same dependencies are shared

     

       63
       63
       +
       with an API or server-side GraphQL consumer, or you're working inside a monorepo —

     

       64
       64
       +
       you can try one of the other aliasing techniques below.

     

       65
       65
       +
       

     

       66
       66
       +
       </details>

     

       67
       67
       +
       

     

       68
       68
       +
       <details>

     

       69
       69
       +
       <summary><strong>Installation with Webpack aliases</strong></summary>

     

       70
       70
       +
       

     

       71
       71
       +
       First, we'll need to install `graphql-web-lite` _alongside_ the regular `graphql`

     

       72
       72
       +
       package.

     

       73
       73
       +
       

     

       74
       74
       +
       ```sh

     

       75
       75
       +
       npm install --save graphql-web-lite

     

       76
       76
       +
       # or

     

       77
       77
       +
       yarn add graphql-web-lite

     

       78
       78
       +
       ```

     

       79
       79
       +
       

     

       80
       80
       +
       To alias a package in Webpack, an entry must be added to your Webpack

     

       81
       81
       +
       configuration's `resolve.alias` section. Depending on your implementation,

     

       82
       82
       +
       the configuration may already contain some keys inside `resolve.alias`, and

     

       83
       83
       +
       you'd want to add another entry for `"graphql"`.

     

       84
       84
       +
       

     

       85
       85
       +
       ```js

     

       86
       86
       +
       const webpackConfig = {

     

       87
       87
       +
         // ...

     

       88
       88
       +
         resolve: {

     

       89
       89
       +
           alias: {

     

       90
       90
       +
             graphql: 'graphql-web-lite',

     

       91
       91
       +
           },

     

       92
       92
       +
         },

     

       93
       93
       +
       };

     

       94
       94
       +
       ```

     

       95
       95
       +
       

     

       96
       96
       +
       </details>

     

       97
       97
       +
       

     

       98
       98
       +
       <details>

     

       99
       99
       +
       <summary><strong>Installation with Next.js</strong></summary>

     

       100
       100
       +
       

     

       101
       101
       +
       First, we'll need to install `graphql-web-lite` _alongside_ the regular `graphql`

     

       102
       102
       +
       package.

     

       103
       103
       +
       

     

       104
       104
       +
       ```sh

     

       105
       105
       +
       npm install --save graphql-web-lite

     

       106
       106
       +
       # or

     

       107
       107
       +
       yarn add graphql-web-lite

     

       108
       108
       +
       ```

     

       109
       109
       +
       

     

       110
       110
       +
       In your [Next.js configuration file](https://nextjs.org/docs/api-reference/next.config.js/introduction),

     

       111
       111
       +
       under `next.config.js`, you can add an additional `webpack()` function that is

     

       112
       112
       +
       able to modify Next's Webpack configuration to add an alias for `graphql`.

     

       113
       113
       +
       

     

       114
       114
       +
       ```js

     

       115
       115
       +
       module.exports = {

     

       116
       116
       +
         webpack(config, { isServer }) {

     

       117
       117
       +
           if (!isServer) {

     

       118
       118
       +
             config.resolve.alias = {

     

       119
       119
       +
               ...config.resolve.alias,

     

       120
       120
       +
               graphql: 'graphql-web-lite',

     

       121
       121
       +
             };

     

       122
       122
       +
           }

     

       123
       123
       +
           return config;

     

       124
       124
       +
         },

     

       125
       125
       +
       };

     

       126
       126
       +
       ```

     

       127
       127
       +
       

     

       128
       128
       +
       Here we're also ensuring that the alias isn't applied on the server-side, in case

     

       129
       129
       +
       an API route is using `graphql` for a server-side GraphQL schema.

     

       130
       130
       +
       

     

       131
       131
       +
       </details>

     

       132
       132
       +
       

     

       133
       133
       +
       <details>

     

       134
       134
       +
       <summary><strong>Installation with Rollup's alias plugin</strong></summary>

     

       135
       135
       +
       

     

       136
       136
       +
       First, we'll need to install `graphql-web-lite` _alongside_ the regular `graphql`

     

       137
       137
       +
       package.

     

       138
       138
       +
       

     

       139
       139
       +
       ```sh

     

       140
       140
       +
       npm install --save graphql-web-lite

     

       141
       141
       +
       # or

     

       142
       142
       +
       yarn add graphql-web-lite

     

       143
       143
       +
       ```

     

       144
       144
       +
       

     

       145
       145
       +
       In Rollup, the easiest way to add a new alias is to use `@rollup/plugin-alias`.

     

       146
       146
       +
       We'll have to install this plugin and ensure that every import and deep import

     

       147
       147
       +
       to `graphql` is aliased to `graphql-web-lite`.

     

       148
       148
       +
       

     

       149
       149
       +
       Any Rollup-based build will fail when the import name of the package does not

     

       150
       150
       +
       match the `name` field in the module's `package.json` file, so this step is

     

       151
       151
       +
       necessary.

     

       152
       152
       +
       

     

       153
       153
       +
       ```js

     

       154
       154
       +
       import alias from '@rollup/plugin-alias';

     

       155
       155
       +
       

     

       156
       156
       +
       module.exports = {

     

       157
       157
       +
         plugins: [

     

       158
       158
       +
           alias({

     

       159
       159
       +
             entries: [{ find: 'graphql', replacement: 'graphql-web-lite' }],

     

       160
       160
       +
           }),

     

       161
       161
       +
         ],

     

       162
       162
       +
       };

     

       163
       163
       +
       ```

     

       164
       164
       +
       

     

       165
       165
       +
       </details>

     

       166
       166
       +
       

     

       167
       167
       +
       <details>

     

       168
       168
       +
       <summary><strong>Installation with Vite</strong></summary>

     

       169
       169
       +
       

     

       170
       170
       +
       First, we'll need to install `graphql-web-lite` _alongside_ the regular `graphql`

     

       171
       171
       +
       package.

     

       172
       172
       +
       

     

       173
       173
       +
       ```sh

     

       174
       174
       +
       npm install --save graphql-web-lite

     

       175
       175
       +
       # or

     

       176
       176
       +
       yarn add graphql-web-lite

     

       177
       177
       +
       ```

     

       178
       178
       +
       

     

       179
       179
       +
       In your [Vite configuration file](https://vitejs.dev/config/#config-file-resolving)

     

       180
       180
       +
       you may add a new entry for its `resolve.alias` entries. This entry works the same

     

       181
       181
       +
       as Rollup's alias plugin.

     

       182
       182
       +
       

     

       183
       183
       +
       ```js

     

       184
       184
       +
       import { defineConfig } from 'vite';

     

       185
       185
       +
       

     

       186
       186
       +
       export default defineConfig({

     

       187
       187
       +
         resolve: {

     

       188
       188
       +
           alias: {

     

       189
       189
       +
             graphql: 'graphql-web-lite',

     

       190
       190
       +
           },

     

       191
       191
       +
         },

     

       192
       192
       +
       });

     

       193
       193
       +
       ```

     

       194
       194
       +
       

     

       195
       195
       +
       Here we're also ensuring that the alias isn't applied on the server-side, in case

     

       196
       196
       +
       an API route is using `graphql` for a server-side GraphQL schema.

     

       197
       197
       +
       

     

       198
       198
       +
       </details>

     

       199
       199
       +
       

     

       200
       200
       +
       <details>

     

       201
       201
       +
       <summary><strong>Installation with Parcel</strong></summary>

     

       202
       202
       +
       

     

       203
       203
       +
       First, we'll need to install `graphql-web-lite` _alongside_ the regular `graphql`

     

       204
       204
       +
       package.

     

       205
       205
       +
       

     

       206
       206
       +
       ```sh

     

       207
       207
       +
       npm install --save graphql-web-lite

     

       208
       208
       +
       # or

     

       209
       209
       +
       yarn add graphql-web-lite

     

       210
       210
       +
       ```

     

       211
       211
       +
       

     

       212
       212
       +
       In Parcel, we can add an entry in our `package.json` file for an alias. Specifically,

     

       213
       213
       +
       the `alias` property may contain an object that maps packages to their aliases.

     

       214
       214
       +
       

     

       215
       215
       +
       ```diff

     

       216
       216
       +
       {

     

       217
       217
       +
         "alias": {

     

       218
       218
       +
       +    "graphql": "graphql-web-lite"

     

       219
       219
       +
         }

     

       220
       220
       +
       }

     

       221
       221
       +
       ```

     

       222
       222
       +
       

     

       223
       223
       +
       </details>

     

       224
       224
       +
       

     

       225
       225
       +
       <details>

     

       226
       226
       +
       <summary><strong>Installation with Jest's module mapping</strong></summary>

     

       227
       227
       +
       

     

       228
       228
       +
       First, we'll need to install `graphql-web-lite` _alongside_ the regular `graphql`

     

       229
       229
       +
       package.

     

       230
       230
       +
       

     

       231
       231
       +
       ```sh

     

       232
       232
       +
       npm install --save graphql-web-lite

     

       233
       233
       +
       # or

     

       234
       234
       +
       yarn add graphql-web-lite

     

       235
       235
       +
       ```

     

       236
       236
       +
       

     

       237
       237
       +
       Jest allows any module names to be remapped using regular expression-based

     

       238
       238
       +
       mappings. In your Jest config you'll need to add an entry for `graphql` that

     

       239
       239
       +
       remaps all imports and deep imports to `graphql-web-lite`.

     

       240
       240
       +
       

     

       241
       241
       +
       ```json

     

       242
       242
       +
       {

     

       243
       243
       +
         "moduleNameMapper": {

     

       244
       244
       +
           "graphql(.*)": "graphql-web-lite$1"

     

       245
       245
       +
         }

     

       246
       246
       +
       }

     

       247
       247
       +
       ```

     

       248
       248
       +
       

     

       249
       249
       +
       </details>

     

       250
       250
       +
       

     

       251
       251
       +
       ## Impact & Changes

     

       252
       252
       +
       

     

       253
       253
       +
       In short, most utilities, functions, and classes exported by the `graphql`

     

       254
       254
       +
       package are only used for server-side GraphQL. Some of them have been removed

     

       255
       255
       +
       in `graphql-web-lite` to discourage its server-side usage, and help bundlers

     

       256
       256
       +
       exlude them if tree-shaking were to fail.

     

       257
       257
       +
       

     

       258
       258
       +
       Most GraphQL clients rely on importing the parser, printer, visitor, and the

     

       259
       259
       +
       `GraphQLError` class. These have all been modified to reduce their bundlesize

     

       260
       260
       +
       impact and to remove any support for

     

       261
       261
       +
       [GraphQL's schema language and type system](https://spec.graphql.org/June2018/#sec-Type-System).

     

       262
       262
       +
       

     

       263
       263
       +
       Any debugging calls, development-time warnings, and other non-production code

     

       264
       264
       +
       is also being transpiled away, and `process.env.NODE_ENV` has been compiled

     

       265
       265
       +
       away.

     

       266
       266
       +
       

     

       267
       267
       +
       <details>

     

       268
       268
       +
       <summary><strong>Full List of Changes</strong></summary>

     

       269
       269
       +
       

     

       270
       270
       +
       | Export                     | Changes     | Notes                                                               |

     

       271
       271
       +
       | -------------------------- | ----------- | ------------------------------------------------------------------- |

     

       272
       272
       +
       | `getVisitFn`               | _unchanged_ | n/a                                                                 |

     

       273
       273
       +
       | `visitInParallel`          | _unchanged_ | n/a                                                                 |

     

       274
       274
       +
       | `BREAK`                    | _unchanged_ | n/a                                                                 |

     

       275
       275
       +
       | `visit`                    | _modified_  | works recursively and does not detect invalid AST nodes             |

     

       276
       276
       +
       | `print`                    | _modified_  | won't output any schema nodes and does not detect invalid AST nodes |

     

       277
       277
       +
       | `printLocation`            | _modified_  | won't output source snippets                                        |

     

       278
       278
       +
       | `printSourceLocation`      | _modified_  | won't output source snippets                                        |

     

       279
       279
       +
       | `parse`                    | _modified_  | won't parse schema nodes or throw precise syntax errors             |

     

       280
       280
       +
       | `parseType`                | _modified_  | won't throw precise syntax errors                                   |

     

       281
       281
       +
       | `parseValue`               | _modified_  | won't throw precise syntax errors                                   |

     

       282
       282
       +
       | `GraphQLError`             | _modified_  | doesn't handle locations and Error stacks                           |

     

       283
       283
       +
       | `syntaxError`              | _removed_   | n/a                                                                 |

     

       284
       284
       +
       | `printType`                | _removed_   | n/a                                                                 |

     

       285
       285
       +
       | `printSchema`              | _removed_   | n/a                                                                 |

     

       286
       286
       +
       | `printIntrospectionSchema` | _removed_   | n/a                                                                 |

     

       287
       287
       +
       | `lexicographicSortSchema`  | _removed_   | n/a                                                                 |

     

       288
       288
       +
       | `isSchema`                 | _removed_   | n/a                                                                 |

     

       289
       289
       +
       | `isInterfaceType`          | _removed_   | n/a                                                                 |

     

       290
       290
       +
       | `getDescription`           | _removed_   | n/a                                                                 |

     

       291
       291
       +
       | `findDeprecatedUsages`     | _removed_   | n/a                                                                 |

     

       292
       292
       +
       | `buildSchema`              | _removed_   | n/a                                                                 |

     

       293
       293
       +
       | `buildASTSchema`           | _removed_   | n/a                                                                 |

     

       294
       294
       +
       | `assertSchema`             | _removed_   | n/a                                                                 |

     

       295
       295
       +
       | `assertInterfaceType`      | _removed_   | n/a                                                                 |

     

       296
       296
       +
       | `assertCompositeType`      | _removed_   | n/a                                                                 |

     

       297
       297
       +
       | `assertAbstractType`       | _removed_   | n/a                                                                 |

     

       298
       298
       +
       | `TokenKind`                | _removed_   | n/a                                                                 |

     

       299
       299
       +
       | `Token`                    | _removed_   | n/a                                                                 |

     

       300
       300
       +
       | `Lexer`                    | _removed_   | n/a                                                                 |

     

       301
       301
       +
       | `GraphQLUnionType`         | _removed_   | n/a                                                                 |

     

       302
       302
       +
       | `GraphQLInterfaceType`     | _removed_   | n/a                                                                 |

     

       303
       303
       +
       | `GraphQLInputObjectType`   | _removed_   | n/a                                                                 |

     

       304
       304
       +
       

     

       305
       305
       +
       </details>

+2 -2

package.json

···

       1
       1
        
       {

     

       2
       2
        
         "name": "graphql-web-lite",

     

       3
       3
       +
         "description": "graphql npm package slimmed down for client-side libraries",

     

       3
       4
        
         "version": "15.5.1000",

     

       4
       5
        
         "license": "MIT",

     

       5
       6
        
         "private": true,

     
···

       18
       19
        
           "graphql-js",

     

       19
       20
        
           "lite"

     

       20
       21
        
         ],

     

       21
       21
       -
         "private": true,

     

       22
       22
        
         "homepage": "https://github.com/kitten/graphql-web-lite",

     

       23
       23
        
         "bugs": {

     

       24
       24
        
           "url": "https://github.com/kitten/graphql-web-lite/issues"

     

       25
       25
        
         },

     

       26
       26
        
         "repository": {

     

       27
       27
        
           "type": "git",

     

       28
       28
       -
           "url": "https://github.com/kitte/graphql-web-lite.git"

     

       28
       28
       +
           "url": "https://github.com/kitten/graphql-web-lite.git"

     

       29
       29
        
         },

     

       30
       30
        
         "devDependencies": {

     

       31
       31
        
           "@babel/core": "^7.15.0",