altair-express-middleware 5.0.8 → 5.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/.eslintrc.js +4 -0
  2. package/CHANGELOG.md +13 -45
  3. package/README.md +17 -8
  4. package/example/index.ts +22 -19
  5. package/index.ts +7 -2
  6. package/package.json +5 -4
  7. package/tsconfig.json +4 -7
package/.eslintrc.js ADDED
@@ -0,0 +1,4 @@
1
+ module.exports = {
2
+ root: true,
3
+ extends: ['altair'],
4
+ };
package/CHANGELOG.md CHANGED
@@ -4,111 +4,79 @@ All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
6
  <a name="1.0.5"></a>
7
- ## [1.0.5](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.5) (2018-05-12)
8
-
9
-
10
7
 
8
+ ## [1.0.5](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.5) (2018-05-12)
11
9
 
12
10
  **Note:** Version bump only for package altair-express-middleware
13
11
 
14
12
  <a name="1.0.4"></a>
15
- ## [1.0.4](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.4) (2018-05-12)
16
-
17
-
18
13
 
14
+ ## [1.0.4](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.4) (2018-05-12)
19
15
 
20
16
  **Note:** Version bump only for package altair-express-middleware
21
17
 
22
18
  <a name="1.0.3"></a>
23
- ## [1.0.3](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.3) (2018-05-12)
24
-
25
-
26
19
 
20
+ ## [1.0.3](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.3) (2018-05-12)
27
21
 
28
22
  **Note:** Version bump only for package altair-express-middleware
29
23
 
30
24
  <a name="1.0.2"></a>
25
+
31
26
  ## [1.0.2](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.2) (2018-05-12)
32
27
 
33
28
  **Note:** Version bump only for package altair-express-middleware
34
29
 
35
-
36
-
37
-
38
-
39
30
  <a name="1.0.5"></a>
31
+
40
32
  ## [1.0.5](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.5) (2018-05-12)
41
33
 
42
34
  **Note:** Version bump only for package altair-express-middleware
43
35
 
44
-
45
-
46
-
47
-
48
36
  <a name="1.0.4"></a>
37
+
49
38
  ## [1.0.4](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.4) (2018-05-12)
50
39
 
51
40
  **Note:** Version bump only for package altair-express-middleware
52
41
 
53
-
54
-
55
-
56
-
57
42
  <a name="1.0.3"></a>
43
+
58
44
  ## [1.0.3](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.3) (2018-05-12)
59
45
 
60
46
  **Note:** Version bump only for package altair-express-middleware
61
47
 
62
-
63
-
64
-
65
-
66
48
  <a name="1.0.2"></a>
49
+
67
50
  ## [1.0.2](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.2) (2018-05-12)
68
51
 
69
52
  **Note:** Version bump only for package altair-express-middleware
70
53
 
71
-
72
-
73
-
74
-
75
54
  <a name="1.0.3"></a>
55
+
76
56
  ## [1.0.3](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.3) (2018-05-12)
77
57
 
78
58
  **Note:** Version bump only for package altair-express-middleware
79
59
 
80
-
81
-
82
-
83
-
84
60
  <a name="1.0.2"></a>
61
+
85
62
  ## [1.0.2](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.2) (2018-05-12)
86
63
 
87
64
  **Note:** Version bump only for package altair-express-middleware
88
65
 
89
-
90
-
91
-
92
-
93
66
  <a name="1.0.2"></a>
67
+
94
68
  ## [1.0.2](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.2) (2018-05-12)
95
69
 
96
70
  **Note:** Version bump only for package altair-express-middleware
97
71
 
98
-
99
-
100
-
101
-
102
72
  <a name="1.0.4"></a>
73
+
103
74
  ## [1.0.4](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.4) (2018-05-12)
104
75
 
105
76
  **Note:** Version bump only for package altair-express-middleware
106
77
 
107
-
108
-
109
-
110
-
111
78
  <a name="1.0.3"></a>
79
+
112
80
  ## [1.0.3](https://github.com/imolorhe/altair/compare/altair-express-middleware@0.1.0...altair-express-middleware@1.0.3) (2018-05-12)
113
81
 
114
82
  **Note:** Version bump only for package altair-express-middleware
package/README.md CHANGED
@@ -5,6 +5,7 @@
5
5
  This is an express middleware for mounting an instance of altair GraphQL client.
6
6
 
7
7
  ### Installation
8
+
8
9
  This is a node module and can be installed using npm:
9
10
 
10
11
  ```
@@ -29,16 +30,23 @@ import { schema } from './schema';
29
30
  const server = express();
30
31
 
31
32
  // Mount your graphQL server endpoint
32
- server.use('/graphql', bodyParser.json(), graphqlExpress({
33
- schema
34
- }));
33
+ server.use(
34
+ '/graphql',
35
+ bodyParser.json(),
36
+ graphqlExpress({
37
+ schema,
38
+ })
39
+ );
35
40
 
36
41
  // Mount your altair GraphQL client
37
- server.use('/altair', altairExpress({
38
- endpointURL: '/graphql',
39
- subscriptionsEndpoint: `ws://localhost:4000/subscriptions`,
40
- initialQuery: `{ getData { id name surname } }`,
41
- }));
42
+ server.use(
43
+ '/altair',
44
+ altairExpress({
45
+ endpointURL: '/graphql',
46
+ subscriptionsEndpoint: `ws://localhost:4000/subscriptions`,
47
+ initialQuery: `{ getData { id name surname } }`,
48
+ })
49
+ );
42
50
 
43
51
  // ... the rest of your code ...
44
52
  ```
@@ -46,6 +54,7 @@ server.use('/altair', altairExpress({
46
54
  An instance of Altair GraphQL Client would be available at `/altair` of your server.
47
55
 
48
56
  ### Contributing
57
+
49
58
  Everyone is welcome to contribute. See anything that needs improving, create an issue. And if you're up for it, create a PR! :D
50
59
 
51
60
  ### License
package/example/index.ts CHANGED
@@ -4,25 +4,28 @@ import { altairExpress } from '../index';
4
4
  const app = express();
5
5
  const port = 3030;
6
6
 
7
- app.use('/altair', altairExpress({
8
- endpointURL: '/graphql',
9
- subscriptionsEndpoint: `ws://localhost:5400/subscriptions`,
10
- initialQuery: `{ getData { id name surname } }`,
11
- // serveInitialOptionsInSeperateRequest: true,
12
- initialPreRequestScript: `console.log('Hello from pre request!')`,
13
- initialWindows: [
14
- {
15
- initialQuery: '{ myFirst }',
16
- endpointURL: '/test1',
17
- initialName: 'name me',
18
- },
19
- {
20
- initialQuery: '{ mySecond }',
21
- endpointURL: '/test2',
22
- },
23
- ],
24
- preserveState: false,
25
- }));
7
+ app.use(
8
+ '/altair',
9
+ altairExpress({
10
+ endpointURL: '/graphql',
11
+ subscriptionsEndpoint: `ws://localhost:5400/subscriptions`,
12
+ initialQuery: `{ getData { id name surname } }`,
13
+ // serveInitialOptionsInSeperateRequest: true,
14
+ initialPreRequestScript: `console.log('Hello from pre request!')`,
15
+ initialWindows: [
16
+ {
17
+ initialQuery: '{ myFirst }',
18
+ endpointURL: '/test1',
19
+ initialName: 'name me',
20
+ },
21
+ {
22
+ initialQuery: '{ mySecond }',
23
+ endpointURL: '/test2',
24
+ },
25
+ ],
26
+ preserveState: false,
27
+ })
28
+ );
26
29
  app.get('/', (req, res) => res.send('Hello world'));
27
30
 
28
31
  app.listen(port, () => console.log(`Example app listening on port ${port}!`));
package/index.ts CHANGED
@@ -1,13 +1,18 @@
1
1
  'use strict';
2
2
 
3
3
  import * as express from 'express';
4
- import { getDistDirectory, renderAltair, renderInitialOptions, RenderOptions } from 'altair-static';
4
+ import {
5
+ getDistDirectory,
6
+ renderAltair,
7
+ renderInitialOptions,
8
+ RenderOptions,
9
+ } from 'altair-static';
5
10
 
6
11
  export const altairExpress = (opts: RenderOptions): express.Express => {
7
12
  const app = express();
8
13
  // Disable strict routing since we *need* to make sure the route does not end with a trailing slash
9
14
  app.disable('strict routing');
10
-
15
+
11
16
  app.get('/', (req, res) => {
12
17
  // Redirect all trailing slash
13
18
  const path = req.originalUrl.replace(/\?.*/, '');
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "altair-express-middleware",
3
- "version": "5.0.8",
3
+ "version": "5.0.14",
4
4
  "description": "Express middleware for altair graphql client",
5
5
  "main": "./build/index.js",
6
6
  "types": "./build/index.d.ts",
@@ -31,19 +31,20 @@
31
31
  },
32
32
  "homepage": "https://github.com/altair-graphql/altair#readme",
33
33
  "dependencies": {
34
- "altair-static": "^5.0.8",
34
+ "altair-static": "^5.0.14",
35
35
  "express": "^4.16.2"
36
36
  },
37
37
  "devDependencies": {
38
38
  "@types/express": "^4.11.1",
39
39
  "@types/node": "^14.14.41",
40
+ "eslint-config-altair": "^5.0.14",
40
41
  "nodemon": "^2.0.2",
41
42
  "ts-node": "^8.5.4",
42
- "typescript": "4.7.4"
43
+ "typescript": "^4.9.4"
43
44
  },
44
45
  "funding": {
45
46
  "type": "opencollective",
46
47
  "url": "https://opencollective.com/altair"
47
48
  },
48
- "gitHead": "310143550fec47381a0da772b1c7f57bdb454533"
49
+ "gitHead": "973420e96faf2c099c806a26a119659c10c0f4ee"
49
50
  }
package/tsconfig.json CHANGED
@@ -1,17 +1,14 @@
1
1
  {
2
+ "extends": "../../tsconfig.json",
2
3
  "compilerOptions": {
3
4
  "outDir": "build/",
4
5
  "rootDir": "./",
5
6
  "declaration": true,
6
7
  "declarationMap": true,
8
+ "skipLibCheck": true,
7
9
  "target": "es2020",
8
10
  "module": "commonjs",
9
- "lib": [
10
- "dom",
11
- "esnext"
12
- ],
13
- "types": [
14
- "node"
15
- ]
11
+ "lib": ["dom", "esnext"],
12
+ "types": ["node"]
16
13
  }
17
14
  }