pgl 5.0.0-beta.43 → 5.0.0-beta.44

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 (2) hide show
  1. package/CHANGELOG.md +108 -0
  2. package/package.json +12 -12
package/CHANGELOG.md CHANGED
@@ -1,5 +1,113 @@
1
1
  # pgl
2
2
 
3
+ ## 5.0.0-beta.44
4
+
5
+ ### Patch Changes
6
+
7
+ - [#2578](https://github.com/graphile/crystal/pull/2578)
8
+ [`1d76d2f`](https://github.com/graphile/crystal/commit/1d76d2f0d19b4d56895ee9988440a35d2c60f9f9)
9
+ Thanks [@benjie](https://github.com/benjie)! - 🚨 **Ruru has been "rebuilt"!
10
+ The loading methods and APIs have changed!**
11
+
12
+ Ruru is now built on top of GraphiQL v5, which moves to using the Monaco
13
+ editor (the same editor used in VSCode) enabling more familiar keybindings and
14
+ more features (e.g. press F1 in the editor to see the command palette, and you
15
+ can now add comments in the variables JSON). This has required a
16
+ rearchitecture to Ruru's previously "single file" approach since Monaco uses
17
+ workers which require additional files.
18
+
19
+ In this release we have embraced the bundle splitting approach. We now bundle
20
+ both `prettier` and `mermaid`, and they are now loaded on-demand.
21
+
22
+ Usage instructions for all environments have had to change since we can no
23
+ longer serve Ruru as a single HTML file. We now include helpers for serving
24
+ Ruru's static files from whatever JS-based webserver you are using.
25
+
26
+ We've also added some additional improvements:
27
+ - Formatting with prettier now maintains the cursor position
28
+ (`Ctrl-Shift-P`/`Meta-Shift-P`/`Cmd-Shift-P` depending on platform)
29
+ - All editors are now formatted, not just the GraphQL editor
30
+ - Prettier and mermaid should now work offline
31
+ - Even more GraphiQL props are now passed through, including
32
+ `inputValueDeprecation` and `schemaDeprecation` which you can set to false
33
+ if your GraphQL server is, _ahem_, a little behind the GraphQL spec draft.
34
+
35
+ 🚨 **Changes you need to make:** 🚨
36
+ - If you are using Ruru directly (i.e. importing from `ruru/server`), please
37
+ see the new Ruru README for setup instructions, you'll want to switch out
38
+ your previous setup. In particular, `ruru/bundle` no longer exists and you
39
+ now need to serve the static files (via `ruru/static`).
40
+ - `defaultHTMLParts` is no more; instead `config.htmlParts` (also
41
+ `preset.ruru.htmlParts` for Graphile Config users) now allows the entries to
42
+ be callback functions reducing boilerplate:
43
+ ```diff
44
+ -import { defaultHTMLParts } from "ruru/server";
45
+ const config = {
46
+ htmlParts: {
47
+ - metaTags: defaultHTMLParts.metaTags + "<!-- local override -->",
48
+ + metaTags: (base) => base + "<!-- local override -->",
49
+ }
50
+ }
51
+ ```
52
+ (alternatively you can use `makeHTMLParts(config)`)
53
+ - Grafserv users: `plugin.grafserv.middleware.ruruHTMLParts` is renamed to
54
+ `ruruHTML` and wraps the generation of the HTML - simply trim `Parts` from
55
+ the name and be sure calling `next()` is the final line of the function
56
+ ```diff
57
+ const plugin = {
58
+ grafserv: {
59
+ middleware: {
60
+ - ruruHTMLParts(next, event) {
61
+ + ruruHTML(next, event) {
62
+ const { htmlParts, request } = event;
63
+ htmlParts.titleTag = `<title>${escapeHTML(
64
+ "Ruru | " + request.getHeader("host"),
65
+ )}</title>`;
66
+ return next();
67
+ },
68
+ },
69
+ },
70
+ };
71
+ ```
72
+
73
+ Additional changes:
74
+ - `RuruConfig.clientConfig` has been added for props to explicitly pass to
75
+ Ruru making it explicit that these will be sent to the client
76
+ - `RuruServerConfig` has deprecated the client options `editorTheme`,
77
+ `debugTools` and `eventSourceInit` at the top level; instead these should be
78
+ passed via `RuruServerConfig.clientConfig` making it explicit these will be
79
+ sent to the client and expanding to cover more props
80
+ ```diff
81
+ const config = {
82
+ endpoint: "/graphql",
83
+ + clientConfig: {
84
+ editorTheme: "dark",
85
+ + },
86
+ }
87
+ ```
88
+
89
+ - Updated dependencies
90
+ [[`6abfd4f`](https://github.com/graphile/crystal/commit/6abfd4fcad7633da3c50b2d3ea82979a3a27e317),
91
+ [`4c8f028`](https://github.com/graphile/crystal/commit/4c8f028a7e5c4388efbab53ea65e7b3018ab6d47),
92
+ [`5451c90`](https://github.com/graphile/crystal/commit/5451c9031e341bdae16dc1b7a3b6b19154056701),
93
+ [`1d76d2f`](https://github.com/graphile/crystal/commit/1d76d2f0d19b4d56895ee9988440a35d2c60f9f9),
94
+ [`c54c6db`](https://github.com/graphile/crystal/commit/c54c6db320b3967ab16784a504770c9b5ef24494),
95
+ [`7147cb0`](https://github.com/graphile/crystal/commit/7147cb07e4d7286bb3b9e949164a2a232d59e28c),
96
+ [`9aa2637`](https://github.com/graphile/crystal/commit/9aa26374758e8489515a70a334c7ea4d345c6369),
97
+ [`7847c0b`](https://github.com/graphile/crystal/commit/7847c0b09aa6be5526df8ccdb3f429e680a2da03),
98
+ [`9d86063`](https://github.com/graphile/crystal/commit/9d86063aacf2d064c35bd62e2cf58ea687910ac8),
99
+ [`a480f6d`](https://github.com/graphile/crystal/commit/a480f6d22605fbb0d0fcdf6845cbdf294d3194b5),
100
+ [`0e6c4e0`](https://github.com/graphile/crystal/commit/0e6c4e062be3ecb79c0ae30c89fad1550a0b5e98),
101
+ [`ad588ec`](https://github.com/graphile/crystal/commit/ad588ecde230359f56800e414b7c5fa1aed14957),
102
+ [`e8bb5be`](https://github.com/graphile/crystal/commit/e8bb5be91df242d3c2b8ed4e7010d48feffdcfe2)]:
103
+ - pg-introspection@0.0.1-beta.12
104
+ - graphile-build-pg@5.0.0-beta.42
105
+ - postgraphile@5.0.0-beta.44
106
+ - @dataplan/pg@0.0.1-beta.35
107
+ - grafserv@0.1.1-beta.27
108
+ - grafast@0.1.1-beta.24
109
+ - graphile-build@5.0.0-beta.36
110
+
3
111
  ## 5.0.0-beta.43
4
112
 
5
113
  ### Patch Changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pgl",
3
- "version": "5.0.0-beta.43",
3
+ "version": "5.0.0-beta.44",
4
4
  "description": "Automatic, high performance, and highly customizable GraphQL API for PostgreSQL",
5
5
  "type": "commonjs",
6
6
  "exports": {
@@ -201,26 +201,26 @@
201
201
  "homepage": "https://graphile.org/graphile-engine/",
202
202
  "dependencies": {
203
203
  "@dataplan/json": "0.0.1-beta.32",
204
- "@dataplan/pg": "0.0.1-beta.34",
204
+ "@dataplan/pg": "0.0.1-beta.35",
205
205
  "@graphile/lru": "^5.0.0-beta.4",
206
- "@types/node": "^22.15.32",
206
+ "@types/node": "^22.16.3",
207
207
  "@types/pg": "^8.15.4",
208
208
  "debug": "^4.4.1",
209
- "grafast": "^0.1.1-beta.23",
210
- "grafserv": "^0.1.1-beta.26",
211
- "graphile-build": "5.0.0-beta.35",
212
- "graphile-build-pg": "5.0.0-beta.41",
209
+ "grafast": "^0.1.1-beta.24",
210
+ "grafserv": "^0.1.1-beta.27",
211
+ "graphile-build": "5.0.0-beta.36",
212
+ "graphile-build-pg": "5.0.0-beta.42",
213
213
  "graphile-config": "^0.0.1-beta.17",
214
214
  "graphql": "16.1.0-experimental-stream-defer.6",
215
215
  "iterall": "^1.3.0",
216
216
  "jsonwebtoken": "^9.0.2",
217
- "pg": "^8.16.0",
218
- "pg-introspection": "^0.0.1-beta.11",
217
+ "pg": "^8.16.3",
218
+ "pg-introspection": "^0.0.1-beta.12",
219
219
  "pg-sql2": "^5.0.0-beta.9",
220
- "postgraphile": "^5.0.0-beta.43",
220
+ "postgraphile": "^5.0.0-beta.44",
221
221
  "tamedevil": "^0.0.0-beta.8",
222
222
  "tslib": "^2.8.1",
223
- "ws": "^8.18.2"
223
+ "ws": "^8.18.3"
224
224
  },
225
225
  "engines": {
226
226
  "node": ">=16"
@@ -236,7 +236,7 @@
236
236
  "@types/jest": "^30.0.0",
237
237
  "@types/jsonwebtoken": "^9.0.10",
238
238
  "@types/nodemon": "3.1.1",
239
- "jest": "^30.0.0",
239
+ "jest": "^30.0.4",
240
240
  "nodemon": "^3.1.10",
241
241
  "ts-node": "^10.9.2",
242
242
  "typescript": "^5.8.3"