@remix-relay/server 1.0.0 → 2.1.0
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/dist/index.d.mts +9 -6
- package/dist/index.d.ts +9 -6
- package/dist/index.js +6 -5
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +6 -5
- package/dist/index.mjs.map +1 -1
- package/package.json +14 -16
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
import { TypedResponse, TypedDeferredData } from '@remix-run/node';
|
|
2
|
-
import { JsonFunction, DeferFunction } from '@remix-run/server-runtime/dist/responses';
|
|
3
1
|
import { GraphQLSchema, FormattedExecutionResult, InitialIncrementalExecutionResult, SubsequentIncrementalExecutionResult } from 'graphql';
|
|
4
2
|
import { OperationType, GraphQLTaggedNode, VariablesOf, RequestParameters } from 'relay-runtime';
|
|
5
3
|
import { PayloadExtensions } from 'relay-runtime/lib/network/RelayNetworkTypes';
|
|
@@ -9,12 +7,17 @@ type SerializablePreloadedQuery<TQuery extends OperationType, TResponse> = {
|
|
|
9
7
|
variables: VariablesOf<TQuery>;
|
|
10
8
|
response: TResponse;
|
|
11
9
|
};
|
|
12
|
-
|
|
10
|
+
type LoaderQueryArgs<TQuery extends OperationType> = [
|
|
11
|
+
node: GraphQLTaggedNode,
|
|
12
|
+
variables: VariablesOf<TQuery>
|
|
13
|
+
];
|
|
14
|
+
type LoaderQuery = <TQuery extends OperationType>(...args: LoaderQueryArgs<TQuery>) => Promise<{
|
|
13
15
|
preloadedQuery: SerializablePreloadedQuery<TQuery, FormattedExecutionResult<TQuery["response"], PayloadExtensions>>;
|
|
14
16
|
deferredQueries: null;
|
|
15
|
-
}
|
|
17
|
+
} | {
|
|
16
18
|
preloadedQuery: SerializablePreloadedQuery<TQuery, InitialIncrementalExecutionResult<TQuery["response"], PayloadExtensions>>;
|
|
17
19
|
deferredQueries: Promise<SerializablePreloadedQuery<TQuery, SubsequentIncrementalExecutionResult<TQuery["response"], PayloadExtensions>>[]>;
|
|
18
|
-
}
|
|
20
|
+
}>;
|
|
21
|
+
declare const getLoaderQuery: <TContext>(schema: GraphQLSchema, context?: TContext) => LoaderQuery;
|
|
19
22
|
|
|
20
|
-
export { getLoaderQuery };
|
|
23
|
+
export { type LoaderQueryArgs, getLoaderQuery };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
import { TypedResponse, TypedDeferredData } from '@remix-run/node';
|
|
2
|
-
import { JsonFunction, DeferFunction } from '@remix-run/server-runtime/dist/responses';
|
|
3
1
|
import { GraphQLSchema, FormattedExecutionResult, InitialIncrementalExecutionResult, SubsequentIncrementalExecutionResult } from 'graphql';
|
|
4
2
|
import { OperationType, GraphQLTaggedNode, VariablesOf, RequestParameters } from 'relay-runtime';
|
|
5
3
|
import { PayloadExtensions } from 'relay-runtime/lib/network/RelayNetworkTypes';
|
|
@@ -9,12 +7,17 @@ type SerializablePreloadedQuery<TQuery extends OperationType, TResponse> = {
|
|
|
9
7
|
variables: VariablesOf<TQuery>;
|
|
10
8
|
response: TResponse;
|
|
11
9
|
};
|
|
12
|
-
|
|
10
|
+
type LoaderQueryArgs<TQuery extends OperationType> = [
|
|
11
|
+
node: GraphQLTaggedNode,
|
|
12
|
+
variables: VariablesOf<TQuery>
|
|
13
|
+
];
|
|
14
|
+
type LoaderQuery = <TQuery extends OperationType>(...args: LoaderQueryArgs<TQuery>) => Promise<{
|
|
13
15
|
preloadedQuery: SerializablePreloadedQuery<TQuery, FormattedExecutionResult<TQuery["response"], PayloadExtensions>>;
|
|
14
16
|
deferredQueries: null;
|
|
15
|
-
}
|
|
17
|
+
} | {
|
|
16
18
|
preloadedQuery: SerializablePreloadedQuery<TQuery, InitialIncrementalExecutionResult<TQuery["response"], PayloadExtensions>>;
|
|
17
19
|
deferredQueries: Promise<SerializablePreloadedQuery<TQuery, SubsequentIncrementalExecutionResult<TQuery["response"], PayloadExtensions>>[]>;
|
|
18
|
-
}
|
|
20
|
+
}>;
|
|
21
|
+
declare const getLoaderQuery: <TContext>(schema: GraphQLSchema, context?: TContext) => LoaderQuery;
|
|
19
22
|
|
|
20
|
-
export { getLoaderQuery };
|
|
23
|
+
export { type LoaderQueryArgs, getLoaderQuery };
|
package/dist/index.js
CHANGED
|
@@ -41,8 +41,9 @@ var import_tiny_invariant = __toESM(require("tiny-invariant"));
|
|
|
41
41
|
function isConcreteRequest(node) {
|
|
42
42
|
return node.params !== void 0;
|
|
43
43
|
}
|
|
44
|
-
|
|
45
|
-
return async (
|
|
44
|
+
var getLoaderQuery = (schema, context) => {
|
|
45
|
+
return async (...args) => {
|
|
46
|
+
const [node, variables] = args;
|
|
46
47
|
(0, import_tiny_invariant.default)(isConcreteRequest(node), "Expected a ConcreteRequest");
|
|
47
48
|
const document = (0, import_graphql.parse)(node.params.text);
|
|
48
49
|
const result = await (0, import_executor.execute)({
|
|
@@ -63,7 +64,7 @@ function getLoaderQuery(schema, json, defer, context) {
|
|
|
63
64
|
variables,
|
|
64
65
|
response: result
|
|
65
66
|
};
|
|
66
|
-
return
|
|
67
|
+
return { preloadedQuery: preloadedQuery2, deferredQueries: null };
|
|
67
68
|
}
|
|
68
69
|
const preloadedQuery = {
|
|
69
70
|
params: node.params,
|
|
@@ -84,9 +85,9 @@ function getLoaderQuery(schema, json, defer, context) {
|
|
|
84
85
|
response: { ...rest, ...incremental?.[0] }
|
|
85
86
|
}));
|
|
86
87
|
})();
|
|
87
|
-
return
|
|
88
|
+
return { preloadedQuery, deferredQueries };
|
|
88
89
|
};
|
|
89
|
-
}
|
|
90
|
+
};
|
|
90
91
|
// Annotate the CommonJS export names for ESM import in node:
|
|
91
92
|
0 && (module.exports = {
|
|
92
93
|
getLoaderQuery
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/loader-query.ts"],"sourcesContent":["export { getLoaderQuery } from \"./loader-query\";\n","import { execute } from \"@graphql-tools/executor\";\nimport
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/loader-query.ts"],"sourcesContent":["export { type LoaderQueryArgs, getLoaderQuery } from \"./loader-query\";\n","import { execute } from \"@graphql-tools/executor\";\nimport {\n FormattedExecutionResult,\n GraphQLSchema,\n InitialIncrementalExecutionResult,\n SubsequentIncrementalExecutionResult,\n parse,\n} from \"graphql\";\nimport type {\n ConcreteRequest,\n GraphQLTaggedNode,\n OperationType,\n RequestParameters,\n VariablesOf,\n} from \"relay-runtime\";\nimport { PayloadExtensions } from \"relay-runtime/lib/network/RelayNetworkTypes\";\nimport invariant from \"tiny-invariant\";\n\nfunction isConcreteRequest(node: GraphQLTaggedNode): node is ConcreteRequest {\n return (node as ConcreteRequest).params !== undefined;\n}\n\nexport type SerializablePreloadedQuery<\n TQuery extends OperationType,\n TResponse,\n> = {\n params: RequestParameters;\n variables: VariablesOf<TQuery>;\n response: TResponse;\n};\n\nexport type LoaderQueryArgs<TQuery extends OperationType> = [\n node: GraphQLTaggedNode,\n variables: VariablesOf<TQuery>,\n];\n\ntype LoaderQuery = <TQuery extends OperationType>(\n ...args: LoaderQueryArgs<TQuery>\n) => Promise<\n | {\n preloadedQuery: SerializablePreloadedQuery<\n TQuery,\n FormattedExecutionResult<TQuery[\"response\"], PayloadExtensions>\n >;\n deferredQueries: null;\n }\n | {\n preloadedQuery: SerializablePreloadedQuery<\n TQuery,\n InitialIncrementalExecutionResult<TQuery[\"response\"], PayloadExtensions>\n >;\n deferredQueries: Promise<\n SerializablePreloadedQuery<\n TQuery,\n SubsequentIncrementalExecutionResult<\n TQuery[\"response\"],\n PayloadExtensions\n >\n >[]\n >;\n }\n>;\n\nexport const getLoaderQuery = <TContext>(\n schema: GraphQLSchema,\n context?: TContext,\n): LoaderQuery => {\n return async <TQuery extends OperationType>(\n ...args: LoaderQueryArgs<TQuery>\n ) => {\n const [node, variables] = args;\n invariant(isConcreteRequest(node), \"Expected a ConcreteRequest\");\n\n const document = parse(node.params.text!);\n\n const result = await execute<TQuery[\"response\"], PayloadExtensions>({\n schema,\n document,\n variableValues: variables,\n contextValue: context,\n });\n\n if (!(\"initialResult\" in result)) {\n if (result.errors?.length) {\n throw new Response(null, {\n status: 404,\n statusText: \"Not Found\",\n });\n }\n\n const preloadedQuery = {\n params: node.params,\n variables,\n response: result,\n };\n\n return { preloadedQuery, deferredQueries: null };\n }\n\n const preloadedQuery = {\n params: node.params,\n variables,\n response: result.initialResult,\n };\n\n const deferredQueries = (async () => {\n const chunks = [];\n\n for await (const chunk of result.subsequentResults) {\n chunks.push(chunk);\n }\n\n return chunks.map(({ incremental, ...rest }, index) => ({\n params: {\n ...node.params,\n cacheID: `${node.params.id ?? node.params.cacheID}-${index}`,\n },\n variables,\n response: { ...rest, ...incremental?.[0] },\n }));\n })();\n\n return { preloadedQuery, deferredQueries };\n };\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,sBAAwB;AACxB,qBAMO;AASP,4BAAsB;AAEtB,SAAS,kBAAkB,MAAkD;AAC3E,SAAQ,KAAyB,WAAW;AAC9C;AA2CO,IAAM,iBAAiB,CAC5B,QACA,YACgB;AAChB,SAAO,UACF,SACA;AACH,UAAM,CAAC,MAAM,SAAS,IAAI;AAC1B,8BAAAA,SAAU,kBAAkB,IAAI,GAAG,4BAA4B;AAE/D,UAAM,eAAW,sBAAM,KAAK,OAAO,IAAK;AAExC,UAAM,SAAS,UAAM,yBAA+C;AAAA,MAClE;AAAA,MACA;AAAA,MACA,gBAAgB;AAAA,MAChB,cAAc;AAAA,IAChB,CAAC;AAED,QAAI,EAAE,mBAAmB,SAAS;AAChC,UAAI,OAAO,QAAQ,QAAQ;AACzB,cAAM,IAAI,SAAS,MAAM;AAAA,UACvB,QAAQ;AAAA,UACR,YAAY;AAAA,QACd,CAAC;AAAA,MACH;AAEA,YAAMC,kBAAiB;AAAA,QACrB,QAAQ,KAAK;AAAA,QACb;AAAA,QACA,UAAU;AAAA,MACZ;AAEA,aAAO,EAAE,gBAAAA,iBAAgB,iBAAiB,KAAK;AAAA,IACjD;AAEA,UAAM,iBAAiB;AAAA,MACrB,QAAQ,KAAK;AAAA,MACb;AAAA,MACA,UAAU,OAAO;AAAA,IACnB;AAEA,UAAM,mBAAmB,YAAY;AACnC,YAAM,SAAS,CAAC;AAEhB,uBAAiB,SAAS,OAAO,mBAAmB;AAClD,eAAO,KAAK,KAAK;AAAA,MACnB;AAEA,aAAO,OAAO,IAAI,CAAC,EAAE,aAAa,GAAG,KAAK,GAAG,WAAW;AAAA,QACtD,QAAQ;AAAA,UACN,GAAG,KAAK;AAAA,UACR,SAAS,GAAG,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,IAAI,KAAK;AAAA,QAC5D;AAAA,QACA;AAAA,QACA,UAAU,EAAE,GAAG,MAAM,GAAG,cAAc,CAAC,EAAE;AAAA,MAC3C,EAAE;AAAA,IACJ,GAAG;AAEH,WAAO,EAAE,gBAAgB,gBAAgB;AAAA,EAC3C;AACF;","names":["invariant","preloadedQuery"]}
|
package/dist/index.mjs
CHANGED
|
@@ -7,8 +7,9 @@ import invariant from "tiny-invariant";
|
|
|
7
7
|
function isConcreteRequest(node) {
|
|
8
8
|
return node.params !== void 0;
|
|
9
9
|
}
|
|
10
|
-
|
|
11
|
-
return async (
|
|
10
|
+
var getLoaderQuery = (schema, context) => {
|
|
11
|
+
return async (...args) => {
|
|
12
|
+
const [node, variables] = args;
|
|
12
13
|
invariant(isConcreteRequest(node), "Expected a ConcreteRequest");
|
|
13
14
|
const document = parse(node.params.text);
|
|
14
15
|
const result = await execute({
|
|
@@ -29,7 +30,7 @@ function getLoaderQuery(schema, json, defer, context) {
|
|
|
29
30
|
variables,
|
|
30
31
|
response: result
|
|
31
32
|
};
|
|
32
|
-
return
|
|
33
|
+
return { preloadedQuery: preloadedQuery2, deferredQueries: null };
|
|
33
34
|
}
|
|
34
35
|
const preloadedQuery = {
|
|
35
36
|
params: node.params,
|
|
@@ -50,9 +51,9 @@ function getLoaderQuery(schema, json, defer, context) {
|
|
|
50
51
|
response: { ...rest, ...incremental?.[0] }
|
|
51
52
|
}));
|
|
52
53
|
})();
|
|
53
|
-
return
|
|
54
|
+
return { preloadedQuery, deferredQueries };
|
|
54
55
|
};
|
|
55
|
-
}
|
|
56
|
+
};
|
|
56
57
|
export {
|
|
57
58
|
getLoaderQuery
|
|
58
59
|
};
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/loader-query.ts"],"sourcesContent":["import { execute } from \"@graphql-tools/executor\";\nimport
|
|
1
|
+
{"version":3,"sources":["../src/loader-query.ts"],"sourcesContent":["import { execute } from \"@graphql-tools/executor\";\nimport {\n FormattedExecutionResult,\n GraphQLSchema,\n InitialIncrementalExecutionResult,\n SubsequentIncrementalExecutionResult,\n parse,\n} from \"graphql\";\nimport type {\n ConcreteRequest,\n GraphQLTaggedNode,\n OperationType,\n RequestParameters,\n VariablesOf,\n} from \"relay-runtime\";\nimport { PayloadExtensions } from \"relay-runtime/lib/network/RelayNetworkTypes\";\nimport invariant from \"tiny-invariant\";\n\nfunction isConcreteRequest(node: GraphQLTaggedNode): node is ConcreteRequest {\n return (node as ConcreteRequest).params !== undefined;\n}\n\nexport type SerializablePreloadedQuery<\n TQuery extends OperationType,\n TResponse,\n> = {\n params: RequestParameters;\n variables: VariablesOf<TQuery>;\n response: TResponse;\n};\n\nexport type LoaderQueryArgs<TQuery extends OperationType> = [\n node: GraphQLTaggedNode,\n variables: VariablesOf<TQuery>,\n];\n\ntype LoaderQuery = <TQuery extends OperationType>(\n ...args: LoaderQueryArgs<TQuery>\n) => Promise<\n | {\n preloadedQuery: SerializablePreloadedQuery<\n TQuery,\n FormattedExecutionResult<TQuery[\"response\"], PayloadExtensions>\n >;\n deferredQueries: null;\n }\n | {\n preloadedQuery: SerializablePreloadedQuery<\n TQuery,\n InitialIncrementalExecutionResult<TQuery[\"response\"], PayloadExtensions>\n >;\n deferredQueries: Promise<\n SerializablePreloadedQuery<\n TQuery,\n SubsequentIncrementalExecutionResult<\n TQuery[\"response\"],\n PayloadExtensions\n >\n >[]\n >;\n }\n>;\n\nexport const getLoaderQuery = <TContext>(\n schema: GraphQLSchema,\n context?: TContext,\n): LoaderQuery => {\n return async <TQuery extends OperationType>(\n ...args: LoaderQueryArgs<TQuery>\n ) => {\n const [node, variables] = args;\n invariant(isConcreteRequest(node), \"Expected a ConcreteRequest\");\n\n const document = parse(node.params.text!);\n\n const result = await execute<TQuery[\"response\"], PayloadExtensions>({\n schema,\n document,\n variableValues: variables,\n contextValue: context,\n });\n\n if (!(\"initialResult\" in result)) {\n if (result.errors?.length) {\n throw new Response(null, {\n status: 404,\n statusText: \"Not Found\",\n });\n }\n\n const preloadedQuery = {\n params: node.params,\n variables,\n response: result,\n };\n\n return { preloadedQuery, deferredQueries: null };\n }\n\n const preloadedQuery = {\n params: node.params,\n variables,\n response: result.initialResult,\n };\n\n const deferredQueries = (async () => {\n const chunks = [];\n\n for await (const chunk of result.subsequentResults) {\n chunks.push(chunk);\n }\n\n return chunks.map(({ incremental, ...rest }, index) => ({\n params: {\n ...node.params,\n cacheID: `${node.params.id ?? node.params.cacheID}-${index}`,\n },\n variables,\n response: { ...rest, ...incremental?.[0] },\n }));\n })();\n\n return { preloadedQuery, deferredQueries };\n };\n};\n"],"mappings":";AAAA,SAAS,eAAe;AACxB;AAAA,EAKE;AAAA,OACK;AASP,OAAO,eAAe;AAEtB,SAAS,kBAAkB,MAAkD;AAC3E,SAAQ,KAAyB,WAAW;AAC9C;AA2CO,IAAM,iBAAiB,CAC5B,QACA,YACgB;AAChB,SAAO,UACF,SACA;AACH,UAAM,CAAC,MAAM,SAAS,IAAI;AAC1B,cAAU,kBAAkB,IAAI,GAAG,4BAA4B;AAE/D,UAAM,WAAW,MAAM,KAAK,OAAO,IAAK;AAExC,UAAM,SAAS,MAAM,QAA+C;AAAA,MAClE;AAAA,MACA;AAAA,MACA,gBAAgB;AAAA,MAChB,cAAc;AAAA,IAChB,CAAC;AAED,QAAI,EAAE,mBAAmB,SAAS;AAChC,UAAI,OAAO,QAAQ,QAAQ;AACzB,cAAM,IAAI,SAAS,MAAM;AAAA,UACvB,QAAQ;AAAA,UACR,YAAY;AAAA,QACd,CAAC;AAAA,MACH;AAEA,YAAMA,kBAAiB;AAAA,QACrB,QAAQ,KAAK;AAAA,QACb;AAAA,QACA,UAAU;AAAA,MACZ;AAEA,aAAO,EAAE,gBAAAA,iBAAgB,iBAAiB,KAAK;AAAA,IACjD;AAEA,UAAM,iBAAiB;AAAA,MACrB,QAAQ,KAAK;AAAA,MACb;AAAA,MACA,UAAU,OAAO;AAAA,IACnB;AAEA,UAAM,mBAAmB,YAAY;AACnC,YAAM,SAAS,CAAC;AAEhB,uBAAiB,SAAS,OAAO,mBAAmB;AAClD,eAAO,KAAK,KAAK;AAAA,MACnB;AAEA,aAAO,OAAO,IAAI,CAAC,EAAE,aAAa,GAAG,KAAK,GAAG,WAAW;AAAA,QACtD,QAAQ;AAAA,UACN,GAAG,KAAK;AAAA,UACR,SAAS,GAAG,KAAK,OAAO,MAAM,KAAK,OAAO,OAAO,IAAI,KAAK;AAAA,QAC5D;AAAA,QACA;AAAA,QACA,UAAU,EAAE,GAAG,MAAM,GAAG,cAAc,CAAC,EAAE;AAAA,MAC3C,EAAE;AAAA,IACJ,GAAG;AAEH,WAAO,EAAE,gBAAgB,gBAAgB;AAAA,EAC3C;AACF;","names":["preloadedQuery"]}
|
package/package.json
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@remix-relay/server",
|
|
3
|
-
"version": "1.0
|
|
4
|
-
"description": "Provides Relay integration with
|
|
3
|
+
"version": "2.1.0",
|
|
4
|
+
"description": "Provides Relay integration with React Router (Framework)",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Remix",
|
|
7
7
|
"Relay",
|
|
8
|
-
"React"
|
|
8
|
+
"React",
|
|
9
|
+
"React Router"
|
|
9
10
|
],
|
|
10
11
|
"homepage": "https://github.com/dantrain/remix-relay#readme",
|
|
11
12
|
"repository": {
|
|
@@ -28,8 +29,7 @@
|
|
|
28
29
|
"require": {
|
|
29
30
|
"types": "./dist/index.d.ts",
|
|
30
31
|
"default": "./dist/index.js"
|
|
31
|
-
}
|
|
32
|
-
"default": "./dist/index.js"
|
|
32
|
+
}
|
|
33
33
|
},
|
|
34
34
|
"./package.json": "./package.json"
|
|
35
35
|
},
|
|
@@ -40,22 +40,20 @@
|
|
|
40
40
|
"dist/**"
|
|
41
41
|
],
|
|
42
42
|
"dependencies": {
|
|
43
|
-
"@graphql-tools/executor": "^1.
|
|
43
|
+
"@graphql-tools/executor": "^1.3.10",
|
|
44
44
|
"tiny-invariant": "^1.3.3"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@
|
|
48
|
-
"@
|
|
49
|
-
"@types/
|
|
50
|
-
"@types/node": "^20.12.7",
|
|
51
|
-
"@types/relay-runtime": "^14.1.23",
|
|
47
|
+
"@types/eslint": "^9.6.1",
|
|
48
|
+
"@types/node": "^22.10.3",
|
|
49
|
+
"@types/relay-runtime": "^18.2.3",
|
|
52
50
|
"eslint": "^8.57.0",
|
|
53
51
|
"graphql": "17.0.0-alpha.2",
|
|
54
|
-
"relay-runtime": "^
|
|
55
|
-
"tsup": "^8.
|
|
56
|
-
"typescript": "
|
|
57
|
-
"@remix-relay/
|
|
58
|
-
"@remix-relay/
|
|
52
|
+
"relay-runtime": "^18.2.0",
|
|
53
|
+
"tsup": "^8.3.5",
|
|
54
|
+
"typescript": "~5.7.2",
|
|
55
|
+
"@remix-relay/typescript-config": "0.0.0",
|
|
56
|
+
"@remix-relay/eslint-config": "0.0.0"
|
|
59
57
|
},
|
|
60
58
|
"peerDependencies": {
|
|
61
59
|
"graphql": "17.0.0-alpha.2",
|