@grafserv/persisted 0.0.0-beta.13 → 0.0.0-beta.15
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.
- package/CHANGELOG.md +30 -0
- package/README.md +1 -2
- package/dist/index.d.ts +75 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/interfaces.d.ts +0 -74
- package/dist/interfaces.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +7 -7
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# @grafserv/persisted
|
|
2
2
|
|
|
3
|
+
## 0.0.0-beta.15
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
[[`0df5511ac`](https://github.com/graphile/crystal/commit/0df5511ac8b79ea34f8d12ebf8feeb421f8fe971)]:
|
|
9
|
+
- graphile-config@0.0.1-beta.6
|
|
10
|
+
- grafast@0.1.1-beta.3
|
|
11
|
+
- grafserv@0.1.1-beta.5
|
|
12
|
+
|
|
13
|
+
## 0.0.0-beta.14
|
|
14
|
+
|
|
15
|
+
### Patch Changes
|
|
16
|
+
|
|
17
|
+
- [#1877](https://github.com/graphile/crystal/pull/1877)
|
|
18
|
+
[`8a0cdb95f`](https://github.com/graphile/crystal/commit/8a0cdb95f200b28b0ea1ab5caa12b23dce5f374f)
|
|
19
|
+
Thanks [@benjie](https://github.com/benjie)! - Move 'declare global' out of
|
|
20
|
+
'interfaces.ts' and into 'index.ts' or equivalent. Should make TypeScript more
|
|
21
|
+
aware of these types.
|
|
22
|
+
- Updated dependencies
|
|
23
|
+
[[`3fdc2bce4`](https://github.com/graphile/crystal/commit/3fdc2bce42418773f808c5b8309dfb361cd95ce9),
|
|
24
|
+
[`aeef362b5`](https://github.com/graphile/crystal/commit/aeef362b5744816f01e4a6f714bbd77f92332bc5),
|
|
25
|
+
[`8a76db07f`](https://github.com/graphile/crystal/commit/8a76db07f4c110cecc6225504f9a05ccbcbc7b92),
|
|
26
|
+
[`8a0cdb95f`](https://github.com/graphile/crystal/commit/8a0cdb95f200b28b0ea1ab5caa12b23dce5f374f),
|
|
27
|
+
[`995e25035`](https://github.com/graphile/crystal/commit/995e250352217fdf8f036b8ed6cad3fab520817f),
|
|
28
|
+
[`1c9f1c0ed`](https://github.com/graphile/crystal/commit/1c9f1c0edf4e621a5b6345d3a41527a18143c6ae)]:
|
|
29
|
+
- grafast@0.1.1-beta.2
|
|
30
|
+
- graphile-config@0.0.1-beta.5
|
|
31
|
+
- grafserv@0.1.1-beta.4
|
|
32
|
+
|
|
3
33
|
## 0.0.0-beta.13
|
|
4
34
|
|
|
5
35
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -33,9 +33,8 @@ And please give some love to our featured sponsors 🤩:
|
|
|
33
33
|
<td align="center"><a href="https://www.the-guild.dev/"><img src="https://graphile.org/images/sponsors/theguild.png" width="90" height="90" alt="The Guild" /><br />The Guild</a> *</td>
|
|
34
34
|
<td align="center"><a href="https://dovetailapp.com/"><img src="https://graphile.org/images/sponsors/dovetail.png" width="90" height="90" alt="Dovetail" /><br />Dovetail</a> *</td>
|
|
35
35
|
<td align="center"><a href="https://www.netflix.com/"><img src="https://graphile.org/images/sponsors/Netflix.png" width="90" height="90" alt="Netflix" /><br />Netflix</a> *</td>
|
|
36
|
-
<td align="center"><a href=""><img src="https://graphile.org/images/sponsors/chadf.png" width="90" height="90" alt="Chad Furman" /><br />Chad Furman</a> *</td>
|
|
37
|
-
</tr><tr>
|
|
38
36
|
<td align="center"><a href="https://stellate.co/"><img src="https://graphile.org/images/sponsors/Stellate.png" width="90" height="90" alt="Stellate" /><br />Stellate</a> *</td>
|
|
37
|
+
</tr><tr>
|
|
39
38
|
<td align="center"><a href="https://www.accenture.com/"><img src="https://graphile.org/images/sponsors/accenture.svg" width="90" height="90" alt="Accenture" /><br />Accenture</a> *</td>
|
|
40
39
|
<td align="center"><a href="https://microteam.io/"><img src="https://graphile.org/images/sponsors/micro.png" width="90" height="90" alt="We Love Micro" /><br />We Love Micro</a> *</td>
|
|
41
40
|
</tr></table>
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,79 @@
|
|
|
1
|
+
import type { ParsedGraphQLBody, ProcessGraphQLRequestBodyEvent } from "grafserv";
|
|
1
2
|
export type { PersistedOperationGetter } from "./interfaces.js";
|
|
3
|
+
import type { PersistedOperationGetter } from "./interfaces.js";
|
|
2
4
|
declare const PersistedPlugin: GraphileConfig.Plugin;
|
|
3
5
|
export default PersistedPlugin;
|
|
6
|
+
declare global {
|
|
7
|
+
namespace GraphileConfig {
|
|
8
|
+
interface GrafservOptions {
|
|
9
|
+
/**
|
|
10
|
+
* This function will be passed a GraphQL request object (normally
|
|
11
|
+
* `{query: string, variables?: any, operationName?: string, extensions?: any}`,
|
|
12
|
+
* but in the case of persisted operations it likely won't have a `query`
|
|
13
|
+
* property), and must extract the hash to use to identify the persisted
|
|
14
|
+
* operation. For Apollo Client, this might be something like:
|
|
15
|
+
* `request?.extensions?.persistedQuery?.sha256Hash`; for Relay something
|
|
16
|
+
* like: `request?.documentId`.
|
|
17
|
+
*/
|
|
18
|
+
hashFromPayload?(request: ParsedGraphQLBody): string | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* We can read persisted operations from a folder (they must be named
|
|
21
|
+
* `<hash>.graphql`). When used in this way, the first request for a hash
|
|
22
|
+
* will read the file, and then the result will be cached such that the
|
|
23
|
+
* **filesystem read** will only impact the first use of that hash. We
|
|
24
|
+
* periodically scan the folder for new files, requests for hashes that
|
|
25
|
+
* were not present in our last scan of the folder will be rejected to
|
|
26
|
+
* mitigate denial of service attacks asking for non-existent hashes.
|
|
27
|
+
*/
|
|
28
|
+
persistedOperationsDirectory?: string;
|
|
29
|
+
/**
|
|
30
|
+
* How many milliseconds should we leave it between scans of the persisted
|
|
31
|
+
* operations folder, checking for new files?
|
|
32
|
+
*
|
|
33
|
+
* Set this to the string "watch" to use `fs.watch` to monitor for changes. [EXPERIMENTAL].
|
|
34
|
+
*
|
|
35
|
+
* Set to `-1` to disable.
|
|
36
|
+
*
|
|
37
|
+
* Default: -1
|
|
38
|
+
*/
|
|
39
|
+
persistedOperationsDirectoryScanInterval?: number | "watch";
|
|
40
|
+
/**
|
|
41
|
+
* An optional string-string key-value object defining the persisted
|
|
42
|
+
* operations, where the keys are the hashes, and the values are the
|
|
43
|
+
* operation document strings to use.
|
|
44
|
+
*/
|
|
45
|
+
persistedOperations?: {
|
|
46
|
+
[hash: string]: string;
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
* If your known persisted operations may change over time, or you'd rather
|
|
50
|
+
* load them on demand, you may supply this function. Note this function is
|
|
51
|
+
* **performance critical** so you should use caching to improve
|
|
52
|
+
* performance of any follow-up requests for the same hash.
|
|
53
|
+
*/
|
|
54
|
+
persistedOperationsGetter?: PersistedOperationGetter;
|
|
55
|
+
/**
|
|
56
|
+
* There are situations where you may want to allow arbitrary operations
|
|
57
|
+
* (for example using GraphiQL in development, or allowing an admin to
|
|
58
|
+
* make arbitrary requests in production) whilst enforcing Persisted
|
|
59
|
+
* Operations for the application and non-admin users. This function
|
|
60
|
+
* allows you to determine under which circumstances persisted operations
|
|
61
|
+
* may be bypassed.
|
|
62
|
+
*
|
|
63
|
+
* IMPORTANT: this function must not throw!
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
*
|
|
67
|
+
* ```
|
|
68
|
+
* app.use(postgraphile(DATABASE_URL, SCHEMAS, {
|
|
69
|
+
* allowUnpersistedOperation(event) {
|
|
70
|
+
* return process.env.NODE_ENV === "development" && event.request?.getHeader('referer')?.endsWith("/graphiql");
|
|
71
|
+
* }
|
|
72
|
+
* });
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
allowUnpersistedOperation?: boolean | ((event: ProcessGraphQLRequestBodyEvent) => boolean);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
4
79
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,iBAAiB,EACjB,8BAA8B,EAC/B,MAAM,UAAU,CAAC;AAGlB,YAAY,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAGhE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAGhE,QAAA,MAAM,eAAe,EAAE,cAAc,CAAC,MA8CrC,CAAC;AAEF,eAAe,eAAe,CAAC;AAoR/B,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,cAAc,CAAC;QACvB,UAAU,eAAe;YACvB;;;;;;;;eAQG;YACH,eAAe,CAAC,CAAC,OAAO,EAAE,iBAAiB,GAAG,MAAM,GAAG,SAAS,CAAC;YAEjE;;;;;;;;eAQG;YACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;YAEtC;;;;;;;;;eASG;YACH,wCAAwC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;YAE5D;;;;eAIG;YACH,mBAAmB,CAAC,EAAE;gBAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAEjD;;;;;eAKG;YACH,yBAAyB,CAAC,EAAE,wBAAwB,CAAC;YAErD;;;;;;;;;;;;;;;;;;;eAmBG;YACH,yBAAyB,CAAC,EACtB,OAAO,GACP,CAAC,CAAC,KAAK,EAAE,8BAA8B,KAAK,OAAO,CAAC,CAAC;SAC1D;KACF;CACF"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,wEAAmC;AAGnC,qCAAoC;AAQpC,gEAAgC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,wEAAmC;AAGnC,qCAAoC;AAQpC,gEAAgC;AAGhC,6CAAuC;AAEvC,MAAM,eAAe,GAA0B;IAC7C,IAAI,EAAE,iBAAiB;IACvB,WAAW,EAAE,0CAA0C;IACvD,OAAO,EAAP,oBAAO;IAEP,QAAQ,EAAE;QACR,KAAK,EAAE;YACL,yBAAyB,CAAC,IAAI,EAAE,KAAK;gBACnC,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;gBACvB,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;gBAC7C,IAAI,CAAC,OAAO,EAAE;oBACZ,MAAM,IAAI,mBAAS,CACjB,yDAAyD,EACzD,EAAE,UAAU,EAAE,GAAG,EAAE,CACpB,CAAC;iBACH;gBACD,MAAM,SAAS,GAAG,6BAA6B,CAC7C,IAAI,EACJ,OAAO,EACP,+BAA+B,CAAC,OAAO,EAAE,KAAK,CAAC,CAChD,CAAC;gBACF,mBAAmB;gBACnB,IAAI,SAAS,IAAI,IAAI,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;oBACtD,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;wBAC1B,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;4BACzB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;yBAChB;6BAAM;4BACL,MAAM,IAAI,mBAAS,CACjB,0FAA0F,EAC1F,EAAE,UAAU,EAAE,GAAG,EAAE,CACpB,CAAC;yBACH;oBACH,CAAC,CAAC,CAAC;iBACJ;qBAAM;oBACL,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;wBACjC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;qBACxB;yBAAM;wBACL,MAAM,IAAI,mBAAS,CACjB,0FAA0F,EAC1F,EAAE,UAAU,EAAE,GAAG,EAAE,CACpB,CAAC;qBACH;iBACF;YACH,CAAC;SACF;KACF;CACF,CAAC;AAEF,kBAAe,eAAe,CAAC;AAE/B;;;GAGG;AACH,SAAS,sBAAsB,CAAC,OAAuB;IACrD,OAAO;IACL,0EAA0E;IAC1E,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU;QAC/C,oEAAoE;QACpE,OAAO,EAAE,UAAU;QACnB,kBAAkB;QAClB,OAAO,EAAE,EAAE,CACZ,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,gCAAgC,CAAC,KAAgC;IACxE,OAAO,CAAC,GAAW,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,sBAAsB,CAC7B,SAAiB,EACjB,eAAiC,CAAC,CAAC;IAEnC,8DAA8D;IAC9D,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAC9C,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;IAEnC,yEAAyE;IACzE,yEAAyE;IACzE,qDAAqD;IAErD,IAAI,KAAK,GAAoB,IAAI,CAAC;IAClC,+BAA+B;IAC/B,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,qFAAqF;IACrF,IAAI,SAAS,GAAG,KAAK,CAAC;IAEtB;;OAEG;IACH,KAAK,UAAU,aAAa;QAC1B,IAAI,QAAQ,EAAE;YACZ,SAAS,GAAG,IAAI,CAAC;YACjB,OAAO;SACR;QACD,QAAQ,GAAG,IAAI,CAAC;QAChB,SAAS,GAAG,KAAK,CAAC;QAClB,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,kBAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC9C,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;SAC9D;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,mCAAmC,SAAS,GAAG,CAAC,CAAC;YAC/D,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAClB;gBAAS;YACR,QAAQ,GAAG,KAAK,CAAC;YACjB,IAAI,YAAY,KAAK,OAAO,EAAE;gBAC5B,IAAI,SAAS,EAAE;oBACb,aAAa,EAAE,CAAC;iBACjB;aACF;iBAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,IAAI,CAAC,EAAE;gBAChE,uEAAuE;gBACvE,uEAAuE;gBACvE,OAAO;gBACP,UAAU,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;aACzC;SACF;IACH,CAAC;IAED,aAAa,EAAE,CAAC;IAChB,IAAI,YAAY,KAAK,OAAO,EAAE;QAC5B,CAAC,KAAK,IAAI,EAAE;YACV,IAAI;gBACF,MAAM,OAAO,GAAG,kBAAG,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;gBACnE,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,OAAO,EAAE;oBAClC,aAAa,EAAE,CAAC;iBACjB;aACF;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY;oBAAE,OAAO;gBACtC,OAAO,CAAC,KAAK,CACX,uLAAuL,CACxL,CAAC;gBACF,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aACpB;QACH,CAAC,CAAC,EAAE,CAAC;KACN;IAED,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAG9B,CAAC;IACJ,SAAS,oBAAoB,CAAC,IAAY;QACxC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;SACjC;QACD,IAAI,SAAS,GAAG,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,QAAQ,GAAG,GAAG,IAAI,UAAU,CAAC;YACnC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;gBACtC,MAAM,IAAI,KAAK,CAAC,iCAAiC,IAAI,GAAG,CAAC,CAAC;aAC3D;YACD,SAAS,GAAG,kBAAG;iBACZ,QAAQ,CAAC,GAAG,SAAS,IAAI,QAAQ,EAAE,EAAE,MAAM,CAAC;iBAC5C,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;YACrB,iBAAiB,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACvC,wEAAwE;YACxE,SAAS,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;gBAC/B,iBAAiB,CAAC,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,oBAAoB,EAAE,eAAe,EAAE,CAAC;AAC3D,CAAC;AAED,MAAM,0BAA0B,GAAG,IAAI,GAAG,EAGvC,CAAC;AAEJ;;GAEG;AACH,SAAS,kBAAkB,CACzB,SAAiB,EACjB,YAA0C;IAE1C,MAAM,GAAG,GAAG,GAAG,YAAY,IAAI,SAAS,EAAE,CAAC;IAC3C,IAAI,MAAM,GAAG,0BAA0B,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjD,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,GAAG,sBAAsB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACzD,0BAA0B,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;KAC7C;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,qBAAqB,CAAC,OAAuC;IACpE,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAC3D;QACE,2BAA2B;QAC3B,8BAA8B;QAC9B,qBAAqB;KACtB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAChB,CAAC;IACF,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;QAC/B,uEAAuE;QACvE,MAAM,IAAI,KAAK,CACb,IAAI,gBAAgB,CAAC,IAAI,CACvB,SAAS,CACV,qEAAqE,CACvE,CAAC;KACH;IACD,IAAI,OAAO,CAAC,yBAAyB,EAAE;QACrC,OAAO,OAAO,CAAC,yBAAyB,CAAC;KAC1C;SAAM,IAAI,OAAO,CAAC,mBAAmB,EAAE;QACtC,OAAO,gCAAgC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;KACtE;SAAM,IAAI,OAAO,CAAC,4BAA4B,EAAE;QAC/C,mEAAmE;QACnE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,gBAAgB,EAAE,GAAG,kBAAkB,CACtE,OAAO,CAAC,4BAA4B,EACpC,OAAO,CAAC,wCAAwC,CACjD,CAAC;QACF,OAAO,MAAM,CAAC;KACf;SAAM;QACL,MAAM,IAAI,KAAK,CACb,oOAAoO,CACrO,CAAC;KACH;AACH,CAAC;AAED,MAAM,sBAAsB,GAAG,IAAI,aAAG,CAGpC;IACA,SAAS,EAAE,GAAG;CACf,CAAC,CAAC;AAEH;;GAEG;AACH,SAAS,iBAAiB,CAAC,OAAuC;IAChE,IAAI,MAAM,GAAG,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACjD,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;QACxC,sBAAsB,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;KAC7C;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAoCD,SAAS,+BAA+B,CACtC,OAAuC,EACvC,KAAqC;IAErC,MAAM,EAAE,yBAAyB,EAAE,GAAG,OAAO,CAAC;IAC9C,IAAI,OAAO,yBAAyB,KAAK,UAAU,EAAE;QACnD,OAAO,yBAAyB,CAAC,KAAK,CAAC,CAAC;KACzC;IACD,OAAO,CAAC,CAAC,yBAAyB,CAAC;AACrC,CAAC;AAED;;;GAGG;AACH,SAAS,6BAA6B,CACpC,OAA0B,EAC1B,OAAuC,EACvC,yBAAkC;IAElC,IAAI;QACF,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,sBAAsB,CAAC;QAC1E,MAAM,IAAI,GAAG,eAAe,CAAC,OAAyB,CAAC,CAAC;QACxD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,IAAI,yBAAyB,IAAI,OAAO,OAAO,EAAE,KAAK,KAAK,QAAQ,EAAE;gBACnE,OAAO,OAAO,CAAC,KAAK,CAAC;aACtB;YAED,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAC;SACH;QACD,MAAM,MAAM,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC1C,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;KACrB;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,gDAAgD,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAE5E,2EAA2E;QAC3E,6BAA6B;QAC7B,OAAO,IAAI,CAAC;KACb;AACH,CAAC"}
|
package/dist/interfaces.d.ts
CHANGED
|
@@ -1,81 +1,7 @@
|
|
|
1
1
|
import type { PromiseOrDirect } from "grafast";
|
|
2
|
-
import type { ParsedGraphQLBody, ProcessGraphQLRequestBodyEvent } from "grafserv";
|
|
3
2
|
/**
|
|
4
3
|
* Given a persisted operation hash, return the associated GraphQL operation
|
|
5
4
|
* document.
|
|
6
5
|
*/
|
|
7
6
|
export type PersistedOperationGetter = (hash: string) => PromiseOrDirect<string>;
|
|
8
|
-
declare global {
|
|
9
|
-
namespace GraphileConfig {
|
|
10
|
-
interface GrafservOptions {
|
|
11
|
-
/**
|
|
12
|
-
* This function will be passed a GraphQL request object (normally
|
|
13
|
-
* `{query: string, variables?: any, operationName?: string, extensions?: any}`,
|
|
14
|
-
* but in the case of persisted operations it likely won't have a `query`
|
|
15
|
-
* property), and must extract the hash to use to identify the persisted
|
|
16
|
-
* operation. For Apollo Client, this might be something like:
|
|
17
|
-
* `request?.extensions?.persistedQuery?.sha256Hash`; for Relay something
|
|
18
|
-
* like: `request?.documentId`.
|
|
19
|
-
*/
|
|
20
|
-
hashFromPayload?(request: ParsedGraphQLBody): string | undefined;
|
|
21
|
-
/**
|
|
22
|
-
* We can read persisted operations from a folder (they must be named
|
|
23
|
-
* `<hash>.graphql`). When used in this way, the first request for a hash
|
|
24
|
-
* will read the file, and then the result will be cached such that the
|
|
25
|
-
* **filesystem read** will only impact the first use of that hash. We
|
|
26
|
-
* periodically scan the folder for new files, requests for hashes that
|
|
27
|
-
* were not present in our last scan of the folder will be rejected to
|
|
28
|
-
* mitigate denial of service attacks asking for non-existent hashes.
|
|
29
|
-
*/
|
|
30
|
-
persistedOperationsDirectory?: string;
|
|
31
|
-
/**
|
|
32
|
-
* How many milliseconds should we leave it between scans of the persisted
|
|
33
|
-
* operations folder, checking for new files?
|
|
34
|
-
*
|
|
35
|
-
* Set this to the string "watch" to use `fs.watch` to monitor for changes. [EXPERIMENTAL].
|
|
36
|
-
*
|
|
37
|
-
* Set to `-1` to disable.
|
|
38
|
-
*
|
|
39
|
-
* Default: -1
|
|
40
|
-
*/
|
|
41
|
-
persistedOperationsDirectoryScanInterval?: number | "watch";
|
|
42
|
-
/**
|
|
43
|
-
* An optional string-string key-value object defining the persisted
|
|
44
|
-
* operations, where the keys are the hashes, and the values are the
|
|
45
|
-
* operation document strings to use.
|
|
46
|
-
*/
|
|
47
|
-
persistedOperations?: {
|
|
48
|
-
[hash: string]: string;
|
|
49
|
-
};
|
|
50
|
-
/**
|
|
51
|
-
* If your known persisted operations may change over time, or you'd rather
|
|
52
|
-
* load them on demand, you may supply this function. Note this function is
|
|
53
|
-
* **performance critical** so you should use caching to improve
|
|
54
|
-
* performance of any follow-up requests for the same hash.
|
|
55
|
-
*/
|
|
56
|
-
persistedOperationsGetter?: PersistedOperationGetter;
|
|
57
|
-
/**
|
|
58
|
-
* There are situations where you may want to allow arbitrary operations
|
|
59
|
-
* (for example using GraphiQL in development, or allowing an admin to
|
|
60
|
-
* make arbitrary requests in production) whilst enforcing Persisted
|
|
61
|
-
* Operations for the application and non-admin users. This function
|
|
62
|
-
* allows you to determine under which circumstances persisted operations
|
|
63
|
-
* may be bypassed.
|
|
64
|
-
*
|
|
65
|
-
* IMPORTANT: this function must not throw!
|
|
66
|
-
*
|
|
67
|
-
* @example
|
|
68
|
-
*
|
|
69
|
-
* ```
|
|
70
|
-
* app.use(postgraphile(DATABASE_URL, SCHEMAS, {
|
|
71
|
-
* allowUnpersistedOperation(event) {
|
|
72
|
-
* return process.env.NODE_ENV === "development" && event.request?.getHeader('referer')?.endsWith("/graphiql");
|
|
73
|
-
* }
|
|
74
|
-
* });
|
|
75
|
-
* ```
|
|
76
|
-
*/
|
|
77
|
-
allowUnpersistedOperation?: boolean | ((event: ProcessGraphQLRequestBodyEvent) => boolean);
|
|
78
|
-
}
|
|
79
|
-
}
|
|
80
|
-
}
|
|
81
7
|
//# sourceMappingURL=interfaces.d.ts.map
|
package/dist/interfaces.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAG/C;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,CACrC,IAAI,EAAE,MAAM,KACT,eAAe,CAAC,MAAM,CAAC,CAAC"}
|
package/dist/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const version = "0.0.0-beta.
|
|
1
|
+
export declare const version = "0.0.0-beta.15";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@grafserv/persisted",
|
|
3
|
-
"version": "0.0.0-beta.
|
|
3
|
+
"version": "0.0.0-beta.15",
|
|
4
4
|
"description": "Persisted operations support for Grafserv",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -46,9 +46,9 @@
|
|
|
46
46
|
"node": ">=16.10"
|
|
47
47
|
},
|
|
48
48
|
"peerDependencies": {
|
|
49
|
-
"grafast": "^0.1.1-beta.
|
|
50
|
-
"grafserv": "^0.1.1-beta.
|
|
51
|
-
"graphile-config": "^0.0.1-beta.
|
|
49
|
+
"grafast": "^0.1.1-beta.3",
|
|
50
|
+
"grafserv": "^0.1.1-beta.5",
|
|
51
|
+
"graphile-config": "^0.0.1-beta.6"
|
|
52
52
|
},
|
|
53
53
|
"peerDependenciesMeta": {
|
|
54
54
|
"graphile-config": {
|
|
@@ -56,9 +56,9 @@
|
|
|
56
56
|
}
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|
|
59
|
-
"grafast": "^0.1.1-beta.
|
|
60
|
-
"grafserv": "^0.1.1-beta.
|
|
61
|
-
"graphile-config": "^0.0.1-beta.
|
|
59
|
+
"grafast": "^0.1.1-beta.3",
|
|
60
|
+
"grafserv": "^0.1.1-beta.5",
|
|
61
|
+
"graphile-config": "^0.0.1-beta.6",
|
|
62
62
|
"jest": "^29.6.4",
|
|
63
63
|
"jest-serializer-graphql-schema": "^5.0.0-beta.3",
|
|
64
64
|
"ts-node": "^10.9.1",
|