@isograph/react 0.1.1 → 0.2.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.
Files changed (112) hide show
  1. package/dist/core/FragmentReference.d.ts +15 -0
  2. package/dist/core/FragmentReference.js +17 -0
  3. package/dist/core/IsographEnvironment.d.ts +71 -0
  4. package/dist/core/IsographEnvironment.js +72 -0
  5. package/dist/core/PromiseWrapper.d.ts +27 -0
  6. package/dist/core/PromiseWrapper.js +58 -0
  7. package/dist/core/areEqualWithDeepComparison.d.ts +3 -0
  8. package/dist/core/areEqualWithDeepComparison.js +61 -0
  9. package/dist/core/cache.d.ts +28 -0
  10. package/dist/core/cache.js +452 -0
  11. package/dist/core/componentCache.d.ts +5 -0
  12. package/dist/core/componentCache.js +38 -0
  13. package/dist/core/entrypoint.d.ts +50 -0
  14. package/dist/core/entrypoint.js +8 -0
  15. package/dist/core/garbageCollection.d.ts +11 -0
  16. package/dist/core/garbageCollection.js +74 -0
  17. package/dist/core/makeNetworkRequest.d.ts +6 -0
  18. package/dist/core/makeNetworkRequest.js +62 -0
  19. package/dist/core/read.d.ts +12 -0
  20. package/dist/core/read.js +415 -0
  21. package/dist/core/reader.d.ts +63 -0
  22. package/dist/core/reader.js +2 -0
  23. package/dist/core/util.d.ts +17 -0
  24. package/dist/core/util.js +2 -0
  25. package/dist/index.d.ts +21 -120
  26. package/dist/index.js +49 -306
  27. package/dist/loadable-hooks/useClientSideDefer.d.ts +4 -0
  28. package/dist/loadable-hooks/useClientSideDefer.js +15 -0
  29. package/dist/loadable-hooks/useImperativeExposedMutationField.d.ts +5 -0
  30. package/dist/loadable-hooks/useImperativeExposedMutationField.js +15 -0
  31. package/dist/loadable-hooks/useImperativeLoadableField.d.ts +9 -0
  32. package/dist/loadable-hooks/useImperativeLoadableField.js +15 -0
  33. package/dist/loadable-hooks/useSkipLimitPagination.d.ts +33 -0
  34. package/dist/loadable-hooks/useSkipLimitPagination.js +118 -0
  35. package/dist/react/FragmentReader.d.ts +13 -0
  36. package/dist/{EntrypointReader.js → react/FragmentReader.js} +5 -5
  37. package/dist/react/IsographEnvironmentProvider.d.ts +10 -0
  38. package/dist/{IsographEnvironment.js → react/IsographEnvironmentProvider.js} +2 -20
  39. package/dist/react/useImperativeReference.d.ts +7 -0
  40. package/dist/react/useImperativeReference.js +36 -0
  41. package/dist/react/useLazyReference.d.ts +5 -0
  42. package/dist/react/useLazyReference.js +14 -0
  43. package/dist/react/useReadAndSubscribe.d.ts +11 -0
  44. package/dist/react/useReadAndSubscribe.js +41 -0
  45. package/dist/react/useRerenderOnChange.d.ts +3 -0
  46. package/dist/react/useRerenderOnChange.js +23 -0
  47. package/dist/react/useResult.d.ts +5 -0
  48. package/dist/react/useResult.js +36 -0
  49. package/docs/how-useLazyReference-works.md +117 -0
  50. package/package.json +11 -6
  51. package/src/core/FragmentReference.ts +37 -0
  52. package/src/core/IsographEnvironment.ts +183 -0
  53. package/src/core/PromiseWrapper.ts +86 -0
  54. package/src/core/areEqualWithDeepComparison.ts +78 -0
  55. package/src/core/cache.ts +721 -0
  56. package/src/core/componentCache.ts +61 -0
  57. package/src/core/entrypoint.ts +99 -0
  58. package/src/core/garbageCollection.ts +122 -0
  59. package/src/core/makeNetworkRequest.ts +99 -0
  60. package/src/core/read.ts +615 -0
  61. package/src/core/reader.ts +133 -0
  62. package/src/core/util.ts +23 -0
  63. package/src/index.ts +86 -0
  64. package/src/loadable-hooks/useClientSideDefer.ts +28 -0
  65. package/src/loadable-hooks/useImperativeExposedMutationField.ts +17 -0
  66. package/src/loadable-hooks/useImperativeLoadableField.ts +26 -0
  67. package/src/loadable-hooks/useSkipLimitPagination.ts +211 -0
  68. package/src/react/FragmentReader.tsx +34 -0
  69. package/src/react/IsographEnvironmentProvider.tsx +33 -0
  70. package/src/react/useImperativeReference.ts +57 -0
  71. package/src/react/useLazyReference.ts +22 -0
  72. package/src/react/useReadAndSubscribe.ts +66 -0
  73. package/src/react/useRerenderOnChange.ts +33 -0
  74. package/src/react/useResult.ts +65 -0
  75. package/src/tests/__isograph/Query/meName/entrypoint.ts +47 -0
  76. package/src/tests/__isograph/Query/meName/output_type.ts +3 -0
  77. package/src/tests/__isograph/Query/meName/param_type.ts +6 -0
  78. package/src/tests/__isograph/Query/meName/resolver_reader.ts +32 -0
  79. package/src/tests/__isograph/Query/meNameSuccessor/entrypoint.ts +83 -0
  80. package/src/tests/__isograph/Query/meNameSuccessor/output_type.ts +3 -0
  81. package/src/tests/__isograph/Query/meNameSuccessor/param_type.ts +11 -0
  82. package/src/tests/__isograph/Query/meNameSuccessor/resolver_reader.ts +54 -0
  83. package/src/tests/__isograph/Query/nodeField/entrypoint.ts +46 -0
  84. package/src/tests/__isograph/Query/nodeField/output_type.ts +3 -0
  85. package/src/tests/__isograph/Query/nodeField/param_type.ts +6 -0
  86. package/src/tests/__isograph/Query/nodeField/resolver_reader.ts +37 -0
  87. package/src/tests/__isograph/iso.ts +88 -0
  88. package/src/tests/garbageCollection.test.ts +136 -0
  89. package/src/tests/isograph.config.json +7 -0
  90. package/src/tests/meNameSuccessor.ts +20 -0
  91. package/src/tests/nodeQuery.ts +17 -0
  92. package/src/tests/schema.graphql +16 -0
  93. package/src/tests/tsconfig.json +21 -0
  94. package/tsconfig.json +6 -0
  95. package/tsconfig.pkg.json +2 -1
  96. package/dist/EntrypointReader.d.ts +0 -6
  97. package/dist/IsographEnvironment.d.ts +0 -56
  98. package/dist/PromiseWrapper.d.ts +0 -13
  99. package/dist/PromiseWrapper.js +0 -22
  100. package/dist/cache.d.ts +0 -26
  101. package/dist/cache.js +0 -274
  102. package/dist/componentCache.d.ts +0 -6
  103. package/dist/componentCache.js +0 -31
  104. package/dist/useImperativeReference.d.ts +0 -8
  105. package/dist/useImperativeReference.js +0 -28
  106. package/src/EntrypointReader.tsx +0 -20
  107. package/src/IsographEnvironment.tsx +0 -120
  108. package/src/PromiseWrapper.ts +0 -29
  109. package/src/cache.tsx +0 -484
  110. package/src/componentCache.ts +0 -41
  111. package/src/index.tsx +0 -617
  112. package/src/useImperativeReference.ts +0 -58
package/dist/index.d.ts CHANGED
@@ -1,120 +1,21 @@
1
- import { DataId, IsographEnvironment, Link, StoreRecord } from './IsographEnvironment';
2
- export { type PromiseWrapper } from './PromiseWrapper';
3
- export { makeNetworkRequest, subscribe } from './cache';
4
- export { IsographEnvironmentContext, ROOT_ID, type DataId, type DataTypeValue, type IsographEnvironment, IsographEnvironmentProvider, type IsographEnvironmentProviderProps, type IsographNetworkFunction, type IsographStore, type Link, type StoreRecord, useIsographEnvironment, createIsographEnvironment, createIsographStore, } from './IsographEnvironment';
5
- export { useImperativeReference } from './useImperativeReference';
6
- export { EntrypointReader } from './EntrypointReader';
7
- export type IsographEntrypoint<TReadFromStore extends Object, TResolverResult> = {
8
- kind: 'Entrypoint';
9
- queryText: string;
10
- normalizationAst: NormalizationAst;
11
- readerArtifact: ReaderArtifact<TReadFromStore, TResolverResult>;
12
- nestedRefetchQueries: RefetchQueryArtifactWrapper[];
13
- };
14
- export type ReaderArtifact<TReadFromStore extends Object, TResolverResult> = {
15
- kind: 'ReaderArtifact';
16
- readerAst: ReaderAst<TReadFromStore>;
17
- resolver: (data: TReadFromStore, runtimeProps: any) => TResolverResult;
18
- variant: ReaderResolverVariant;
19
- };
20
- export type ReaderAstNode = ReaderScalarField | ReaderLinkedField | ReaderResolverField | ReaderRefetchField | ReaderMutationField;
21
- export type ReaderAst<TReadFromStore> = ReaderAstNode[];
22
- export type ExtractSecondParam<T extends (arg1: any, arg2: any) => any> = T extends (arg1: any, arg2: infer P) => any ? P : never;
23
- export type ReaderScalarField = {
24
- kind: 'Scalar';
25
- fieldName: string;
26
- alias: string | null;
27
- arguments: Arguments | null;
28
- };
29
- export type ReaderLinkedField = {
30
- kind: 'Linked';
31
- fieldName: string;
32
- alias: string | null;
33
- selections: ReaderAst<unknown>;
34
- arguments: Arguments | null;
35
- };
36
- export type ReaderResolverVariant = {
37
- kind: 'Eager';
38
- } | {
39
- kind: 'Component';
40
- componentName: string;
41
- };
42
- export type ReaderResolverField = {
43
- kind: 'Resolver';
44
- alias: string;
45
- readerArtifact: ReaderArtifact<any, any>;
46
- arguments: Arguments | null;
47
- usedRefetchQueries: number[];
48
- };
49
- export type ReaderRefetchField = {
50
- kind: 'RefetchField';
51
- alias: string;
52
- readerArtifact: ReaderArtifact<any, any>;
53
- refetchQuery: number;
54
- };
55
- export type ReaderMutationField = {
56
- kind: 'MutationField';
57
- alias: string;
58
- readerArtifact: ReaderArtifact<any, any>;
59
- refetchQuery: number;
60
- };
61
- export type NormalizationAstNode = NormalizationScalarField | NormalizationLinkedField;
62
- export type NormalizationAst = NormalizationAstNode[];
63
- export type NormalizationScalarField = {
64
- kind: 'Scalar';
65
- fieldName: string;
66
- arguments: Arguments | null;
67
- };
68
- export type NormalizationLinkedField = {
69
- kind: 'Linked';
70
- fieldName: string;
71
- arguments: Arguments | null;
72
- selections: NormalizationAst;
73
- };
74
- export type RefetchQueryArtifact = {
75
- kind: 'RefetchQuery';
76
- queryText: string;
77
- normalizationAst: NormalizationAst;
78
- };
79
- export type RefetchQueryArtifactWrapper = {
80
- artifact: RefetchQueryArtifact;
81
- allowedVariables: string[];
82
- };
83
- export type Arguments = Argument[];
84
- export type Argument = [ArgumentName, ArgumentValue];
85
- export type ArgumentName = string;
86
- export type ArgumentValue = {
87
- kind: 'Variable';
88
- name: string;
89
- } | {
90
- kind: 'Literal';
91
- value: any;
92
- };
93
- type Variable = any;
94
- export type FragmentReference<TReadFromStore extends Object, TResolverResult> = {
95
- kind: 'FragmentReference';
96
- readerArtifact: ReaderArtifact<TReadFromStore, TResolverResult>;
97
- root: DataId;
98
- variables: {
99
- [index: string]: Variable;
100
- } | null;
101
- nestedRefetchQueries: RefetchQueryArtifactWrapper[];
102
- };
103
- export type ExtractReadFromStore<Type> = Type extends IsographEntrypoint<infer X, any> ? X : never;
104
- export type ExtractResolverResult<Type> = Type extends IsographEntrypoint<any, infer X> ? X : never;
105
- export declare function useLazyReference<TEntrypoint>(entrypoint: TEntrypoint | ((_: any) => any), variables: {
106
- [key: string]: Variable;
107
- }): {
108
- queryReference: FragmentReference<ExtractReadFromStore<TEntrypoint>, ExtractResolverResult<TEntrypoint>>;
109
- };
110
- export declare function useResult<TReadFromStore extends Object, TResolverResult>(fragmentReference: FragmentReference<TReadFromStore, TResolverResult>): TResolverResult;
111
- export declare function read<TReadFromStore extends Object, TResolverResult>(environment: IsographEnvironment, fragmentReference: FragmentReference<TReadFromStore, TResolverResult>): TResolverResult;
112
- export declare function readButDoNotEvaluate<TReadFromStore extends Object>(environment: IsographEnvironment, reference: FragmentReference<TReadFromStore, unknown>): TReadFromStore;
113
- export declare function defaultMissingFieldHandler(_storeRecord: StoreRecord, _root: DataId, fieldName: string, arguments_: {
114
- [index: string]: any;
115
- } | null, variables: {
116
- [index: string]: any;
117
- } | null): Link | undefined;
118
- export type IsographComponentProps<TDataType, TOtherProps = Object> = {
119
- data: TDataType;
120
- } & TOtherProps;
1
+ export { retainQuery, unretainQuery, type RetainedQuery, garbageCollectEnvironment, } from './core/garbageCollection';
2
+ export { type PromiseWrapper, readPromise, getPromiseState, wrapResolvedValue, wrapPromise, } from './core/PromiseWrapper';
3
+ export { subscribe, normalizeData } from './core/cache';
4
+ export { makeNetworkRequest } from './core/makeNetworkRequest';
5
+ export { ROOT_ID, type DataId, type DataTypeValue, type IsographEnvironment, type IsographNetworkFunction, type IsographStore, type Link, type StoreRecord, createIsographEnvironment, createIsographStore, defaultMissingFieldHandler, } from './core/IsographEnvironment';
6
+ export { type EagerReaderArtifact, type ComponentReaderArtifact, type RefetchReaderArtifact, type ReaderAst, type ReaderAstNode, type ReaderLinkedField, type ReaderNonLoadableResolverField, type ReaderScalarField, type TopLevelReaderArtifact, type LoadableField, } from './core/reader';
7
+ export { type NormalizationAst, type NormalizationAstNode, type NormalizationLinkedField, type NormalizationScalarField, type IsographEntrypoint, assertIsEntrypoint, type RefetchQueryNormalizationArtifact, type RefetchQueryNormalizationArtifactWrapper, type ExtractProps, type ExtractReadFromStore, type ExtractResolverResult, } from './core/entrypoint';
8
+ export { readButDoNotEvaluate } from './core/read';
9
+ export { type ExtractSecondParam, type Argument, type ArgumentName, type ArgumentValue, type Arguments, } from './core/util';
10
+ export { type FragmentReference, type Variables, stableIdForFragmentReference, } from './core/FragmentReference';
11
+ export { IsographEnvironmentProvider, useIsographEnvironment, type IsographEnvironmentProviderProps, } from './react/IsographEnvironmentProvider';
12
+ export { useImperativeReference } from './react/useImperativeReference';
13
+ export { FragmentReader } from './react/FragmentReader';
14
+ export { useResult } from './react/useResult';
15
+ export { useReadAndSubscribe, useSubscribeToMultiple, } from './react/useReadAndSubscribe';
16
+ export { useLazyReference } from './react/useLazyReference';
17
+ export { useRerenderOnChange } from './react/useRerenderOnChange';
18
+ export { useClientSideDefer } from './loadable-hooks/useClientSideDefer';
19
+ export { useImperativeExposedMutationField } from './loadable-hooks/useImperativeExposedMutationField';
20
+ export { useSkipLimitPagination } from './loadable-hooks/useSkipLimitPagination';
21
+ export { useImperativeLoadableField } from './loadable-hooks/useImperativeLoadableField';
package/dist/index.js CHANGED
@@ -1,309 +1,52 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.defaultMissingFieldHandler = exports.readButDoNotEvaluate = exports.read = exports.useResult = exports.useLazyReference = exports.EntrypointReader = exports.useImperativeReference = exports.createIsographStore = exports.createIsographEnvironment = exports.useIsographEnvironment = exports.IsographEnvironmentProvider = exports.ROOT_ID = exports.IsographEnvironmentContext = exports.subscribe = exports.makeNetworkRequest = void 0;
4
- const cache_1 = require("./cache");
5
- const react_disposable_state_1 = require("@isograph/react-disposable-state");
6
- const componentCache_1 = require("./componentCache");
7
- const IsographEnvironment_1 = require("./IsographEnvironment");
8
- const react_1 = require("react");
9
- var cache_2 = require("./cache");
10
- Object.defineProperty(exports, "makeNetworkRequest", { enumerable: true, get: function () { return cache_2.makeNetworkRequest; } });
11
- Object.defineProperty(exports, "subscribe", { enumerable: true, get: function () { return cache_2.subscribe; } });
12
- var IsographEnvironment_2 = require("./IsographEnvironment");
13
- Object.defineProperty(exports, "IsographEnvironmentContext", { enumerable: true, get: function () { return IsographEnvironment_2.IsographEnvironmentContext; } });
14
- Object.defineProperty(exports, "ROOT_ID", { enumerable: true, get: function () { return IsographEnvironment_2.ROOT_ID; } });
15
- Object.defineProperty(exports, "IsographEnvironmentProvider", { enumerable: true, get: function () { return IsographEnvironment_2.IsographEnvironmentProvider; } });
16
- Object.defineProperty(exports, "useIsographEnvironment", { enumerable: true, get: function () { return IsographEnvironment_2.useIsographEnvironment; } });
17
- Object.defineProperty(exports, "createIsographEnvironment", { enumerable: true, get: function () { return IsographEnvironment_2.createIsographEnvironment; } });
18
- Object.defineProperty(exports, "createIsographStore", { enumerable: true, get: function () { return IsographEnvironment_2.createIsographStore; } });
19
- var useImperativeReference_1 = require("./useImperativeReference");
3
+ exports.useImperativeLoadableField = exports.useSkipLimitPagination = exports.useImperativeExposedMutationField = exports.useClientSideDefer = exports.useRerenderOnChange = exports.useLazyReference = exports.useSubscribeToMultiple = exports.useReadAndSubscribe = exports.useResult = exports.FragmentReader = exports.useImperativeReference = exports.useIsographEnvironment = exports.IsographEnvironmentProvider = exports.stableIdForFragmentReference = exports.readButDoNotEvaluate = exports.assertIsEntrypoint = exports.defaultMissingFieldHandler = exports.createIsographStore = exports.createIsographEnvironment = exports.ROOT_ID = exports.makeNetworkRequest = exports.normalizeData = exports.subscribe = exports.wrapPromise = exports.wrapResolvedValue = exports.getPromiseState = exports.readPromise = exports.garbageCollectEnvironment = exports.unretainQuery = exports.retainQuery = void 0;
4
+ var garbageCollection_1 = require("./core/garbageCollection");
5
+ Object.defineProperty(exports, "retainQuery", { enumerable: true, get: function () { return garbageCollection_1.retainQuery; } });
6
+ Object.defineProperty(exports, "unretainQuery", { enumerable: true, get: function () { return garbageCollection_1.unretainQuery; } });
7
+ Object.defineProperty(exports, "garbageCollectEnvironment", { enumerable: true, get: function () { return garbageCollection_1.garbageCollectEnvironment; } });
8
+ var PromiseWrapper_1 = require("./core/PromiseWrapper");
9
+ Object.defineProperty(exports, "readPromise", { enumerable: true, get: function () { return PromiseWrapper_1.readPromise; } });
10
+ Object.defineProperty(exports, "getPromiseState", { enumerable: true, get: function () { return PromiseWrapper_1.getPromiseState; } });
11
+ Object.defineProperty(exports, "wrapResolvedValue", { enumerable: true, get: function () { return PromiseWrapper_1.wrapResolvedValue; } });
12
+ Object.defineProperty(exports, "wrapPromise", { enumerable: true, get: function () { return PromiseWrapper_1.wrapPromise; } });
13
+ var cache_1 = require("./core/cache");
14
+ Object.defineProperty(exports, "subscribe", { enumerable: true, get: function () { return cache_1.subscribe; } });
15
+ Object.defineProperty(exports, "normalizeData", { enumerable: true, get: function () { return cache_1.normalizeData; } });
16
+ var makeNetworkRequest_1 = require("./core/makeNetworkRequest");
17
+ Object.defineProperty(exports, "makeNetworkRequest", { enumerable: true, get: function () { return makeNetworkRequest_1.makeNetworkRequest; } });
18
+ var IsographEnvironment_1 = require("./core/IsographEnvironment");
19
+ Object.defineProperty(exports, "ROOT_ID", { enumerable: true, get: function () { return IsographEnvironment_1.ROOT_ID; } });
20
+ Object.defineProperty(exports, "createIsographEnvironment", { enumerable: true, get: function () { return IsographEnvironment_1.createIsographEnvironment; } });
21
+ Object.defineProperty(exports, "createIsographStore", { enumerable: true, get: function () { return IsographEnvironment_1.createIsographStore; } });
22
+ Object.defineProperty(exports, "defaultMissingFieldHandler", { enumerable: true, get: function () { return IsographEnvironment_1.defaultMissingFieldHandler; } });
23
+ var entrypoint_1 = require("./core/entrypoint");
24
+ Object.defineProperty(exports, "assertIsEntrypoint", { enumerable: true, get: function () { return entrypoint_1.assertIsEntrypoint; } });
25
+ var read_1 = require("./core/read");
26
+ Object.defineProperty(exports, "readButDoNotEvaluate", { enumerable: true, get: function () { return read_1.readButDoNotEvaluate; } });
27
+ var FragmentReference_1 = require("./core/FragmentReference");
28
+ Object.defineProperty(exports, "stableIdForFragmentReference", { enumerable: true, get: function () { return FragmentReference_1.stableIdForFragmentReference; } });
29
+ var IsographEnvironmentProvider_1 = require("./react/IsographEnvironmentProvider");
30
+ Object.defineProperty(exports, "IsographEnvironmentProvider", { enumerable: true, get: function () { return IsographEnvironmentProvider_1.IsographEnvironmentProvider; } });
31
+ Object.defineProperty(exports, "useIsographEnvironment", { enumerable: true, get: function () { return IsographEnvironmentProvider_1.useIsographEnvironment; } });
32
+ var useImperativeReference_1 = require("./react/useImperativeReference");
20
33
  Object.defineProperty(exports, "useImperativeReference", { enumerable: true, get: function () { return useImperativeReference_1.useImperativeReference; } });
21
- var EntrypointReader_1 = require("./EntrypointReader");
22
- Object.defineProperty(exports, "EntrypointReader", { enumerable: true, get: function () { return EntrypointReader_1.EntrypointReader; } });
23
- function assertIsEntrypoint(value) {
24
- if (typeof value === 'function')
25
- throw new Error('Not a string');
26
- }
27
- // Note: we cannot write TEntrypoint extends IsographEntrypoint<any, any, any>, or else
28
- // if we do not explicitly pass a type, the read out type will be any.
29
- // We cannot write TEntrypoint extends IsographEntrypoint<never, never, never>, or else
30
- // any actual Entrypoint we pass will not be valid.
31
- function useLazyReference(entrypoint, variables) {
32
- const environment = (0, IsographEnvironment_1.useIsographEnvironment)();
33
- assertIsEntrypoint(entrypoint);
34
- const cache = (0, cache_1.getOrCreateCacheForArtifact)(environment, entrypoint, variables);
35
- // TODO add comment explaining why we never use this value
36
- // @ts-ignore
37
- const data = (0, react_disposable_state_1.useLazyDisposableState)(cache).state;
38
- return {
39
- queryReference: {
40
- kind: 'FragmentReference',
41
- readerArtifact: entrypoint.readerArtifact,
42
- root: IsographEnvironment_1.ROOT_ID,
43
- variables,
44
- nestedRefetchQueries: entrypoint.nestedRefetchQueries,
45
- },
46
- };
47
- }
48
- exports.useLazyReference = useLazyReference;
49
- function useResult(fragmentReference) {
50
- const environment = (0, IsographEnvironment_1.useIsographEnvironment)();
51
- const [, setState] = (0, react_1.useState)();
52
- (0, react_1.useEffect)(() => {
53
- return (0, cache_1.subscribe)(environment, () => {
54
- return setState({});
55
- });
56
- }, []);
57
- return read(environment, fragmentReference);
58
- }
59
- exports.useResult = useResult;
60
- function read(environment, fragmentReference) {
61
- var _a, _b;
62
- const variant = fragmentReference.readerArtifact.variant;
63
- if (variant.kind === 'Eager') {
64
- const data = readData(environment, fragmentReference.readerArtifact.readerAst, fragmentReference.root, (_a = fragmentReference.variables) !== null && _a !== void 0 ? _a : {}, fragmentReference.nestedRefetchQueries);
65
- if (data.kind === 'MissingData') {
66
- throw (0, cache_1.onNextChange)(environment);
67
- }
68
- else {
69
- // @ts-expect-error This not properly typed yet
70
- return fragmentReference.readerArtifact.resolver(data.data);
71
- }
72
- }
73
- else if (variant.kind === 'Component') {
74
- // @ts-ignore
75
- return (0, componentCache_1.getOrCreateCachedComponent)(environment, fragmentReference.root, variant.componentName, fragmentReference.readerArtifact, (_b = fragmentReference.variables) !== null && _b !== void 0 ? _b : {}, fragmentReference.nestedRefetchQueries);
76
- }
77
- // Why can't Typescript realize that this is unreachable??
78
- throw new Error('This is unreachable');
79
- }
80
- exports.read = read;
81
- function readButDoNotEvaluate(environment, reference) {
82
- var _a;
83
- const response = readData(environment, reference.readerArtifact.readerAst, reference.root, (_a = reference.variables) !== null && _a !== void 0 ? _a : {}, reference.nestedRefetchQueries);
84
- if (typeof window !== 'undefined' && window.__LOG) {
85
- console.log('done reading', { response });
86
- }
87
- if (response.kind === 'MissingData') {
88
- throw (0, cache_1.onNextChange)(environment);
89
- }
90
- else {
91
- return response.data;
92
- }
93
- }
94
- exports.readButDoNotEvaluate = readButDoNotEvaluate;
95
- function readData(environment, ast, root, variables, nestedRefetchQueries) {
96
- var _a, _b, _c, _d, _e;
97
- let storeRecord = environment.store[root];
98
- if (storeRecord === undefined) {
99
- return { kind: 'MissingData', reason: 'No record for root ' + root };
100
- }
101
- if (storeRecord === null) {
102
- return { kind: 'Success', data: null };
103
- }
104
- let target = {};
105
- for (const field of ast) {
106
- switch (field.kind) {
107
- case 'Scalar': {
108
- const storeRecordName = (0, cache_1.getParentRecordKey)(field, variables);
109
- const value = storeRecord[storeRecordName];
110
- // TODO consider making scalars into discriminated unions. This probably has
111
- // to happen for when we handle errors.
112
- if (value === undefined) {
113
- return {
114
- kind: 'MissingData',
115
- reason: 'No value for ' + storeRecordName + ' on root ' + root,
116
- };
117
- }
118
- target[(_a = field.alias) !== null && _a !== void 0 ? _a : field.fieldName] = value;
119
- break;
120
- }
121
- case 'Linked': {
122
- const storeRecordName = (0, cache_1.getParentRecordKey)(field, variables);
123
- const value = storeRecord[storeRecordName];
124
- if (Array.isArray(value)) {
125
- const results = [];
126
- for (const item of value) {
127
- const link = assertLink(item);
128
- if (link === undefined) {
129
- return {
130
- kind: 'MissingData',
131
- reason: 'No link for ' +
132
- storeRecordName +
133
- ' on root ' +
134
- root +
135
- '. Link is ' +
136
- JSON.stringify(item),
137
- };
138
- }
139
- else if (link === null) {
140
- results.push(null);
141
- continue;
142
- }
143
- const result = readData(environment, field.selections, link.__link, variables, nestedRefetchQueries);
144
- if (result.kind === 'MissingData') {
145
- return {
146
- kind: 'MissingData',
147
- reason: 'Missing data for ' +
148
- storeRecordName +
149
- ' on root ' +
150
- root +
151
- '. Link is ' +
152
- JSON.stringify(item),
153
- nestedReason: result,
154
- };
155
- }
156
- results.push(result.data);
157
- }
158
- target[(_b = field.alias) !== null && _b !== void 0 ? _b : field.fieldName] = results;
159
- break;
160
- }
161
- let link = assertLink(value);
162
- if (link === undefined) {
163
- // TODO make this configurable, and also generated and derived from the schema
164
- const missingFieldHandler = (_c = environment.missingFieldHandler) !== null && _c !== void 0 ? _c : defaultMissingFieldHandler;
165
- const altLink = missingFieldHandler(storeRecord, root, field.fieldName, field.arguments, variables);
166
- if (altLink === undefined) {
167
- return {
168
- kind: 'MissingData',
169
- reason: 'No link for ' +
170
- storeRecordName +
171
- ' on root ' +
172
- root +
173
- '. Link is ' +
174
- JSON.stringify(value),
175
- };
176
- }
177
- else {
178
- link = altLink;
179
- }
180
- }
181
- else if (link === null) {
182
- target[(_d = field.alias) !== null && _d !== void 0 ? _d : field.fieldName] = null;
183
- break;
184
- }
185
- const targetId = link.__link;
186
- const data = readData(environment, field.selections, targetId, variables, nestedRefetchQueries);
187
- if (data.kind === 'MissingData') {
188
- return {
189
- kind: 'MissingData',
190
- reason: 'Missing data for ' + storeRecordName + ' on root ' + root,
191
- nestedReason: data,
192
- };
193
- }
194
- target[(_e = field.alias) !== null && _e !== void 0 ? _e : field.fieldName] = data.data;
195
- break;
196
- }
197
- case 'RefetchField': {
198
- const data = readData(environment, field.readerArtifact.readerAst, root, variables,
199
- // Refetch fields just read the id, and don't need refetch query artifacts
200
- []);
201
- if (typeof window !== 'undefined' && window.__LOG) {
202
- console.log('refetch field data', data, field);
203
- }
204
- if (data.kind === 'MissingData') {
205
- return {
206
- kind: 'MissingData',
207
- reason: 'Missing data for ' + field.alias + ' on root ' + root,
208
- nestedReason: data,
209
- };
210
- }
211
- else {
212
- const refetchQueryIndex = field.refetchQuery;
213
- if (refetchQueryIndex == null) {
214
- throw new Error('refetchQuery is null in RefetchField');
215
- }
216
- const refetchQuery = nestedRefetchQueries[refetchQueryIndex];
217
- const refetchQueryArtifact = refetchQuery.artifact;
218
- const allowedVariables = refetchQuery.allowedVariables;
219
- target[field.alias] = field.readerArtifact.resolver(environment,
220
- // resolvers for refetch fields take 3 args, and this is not reflected in types
221
- refetchQueryArtifact, Object.assign(Object.assign({}, data.data), filterVariables(variables, allowedVariables)));
222
- }
223
- break;
224
- }
225
- case 'MutationField': {
226
- const data = readData(environment, field.readerArtifact.readerAst, root, variables,
227
- // Refetch fields just read the id, and don't need refetch query artifacts
228
- []);
229
- if (typeof window !== 'undefined' && window.__LOG) {
230
- console.log('refetch field data', data, field);
231
- }
232
- if (data.kind === 'MissingData') {
233
- return {
234
- kind: 'MissingData',
235
- reason: 'Missing data for ' + field.alias + ' on root ' + root,
236
- nestedReason: data,
237
- };
238
- }
239
- else {
240
- const refetchQueryIndex = field.refetchQuery;
241
- if (refetchQueryIndex == null) {
242
- throw new Error('refetchQuery is null in MutationField');
243
- }
244
- const refetchQuery = nestedRefetchQueries[refetchQueryIndex];
245
- const refetchQueryArtifact = refetchQuery.artifact;
246
- const allowedVariables = refetchQuery.allowedVariables;
247
- target[field.alias] = field.readerArtifact.resolver(environment, refetchQueryArtifact,
248
- // @ts-expect-error
249
- data.data, filterVariables(variables, allowedVariables));
250
- }
251
- break;
252
- }
253
- case 'Resolver': {
254
- const usedRefetchQueries = field.usedRefetchQueries;
255
- const resolverRefetchQueries = usedRefetchQueries.map((index) => nestedRefetchQueries[index]);
256
- const variant = field.readerArtifact.variant;
257
- if (variant.kind === 'Eager') {
258
- const data = readData(environment, field.readerArtifact.readerAst, root, variables, resolverRefetchQueries);
259
- if (data.kind === 'MissingData') {
260
- return {
261
- kind: 'MissingData',
262
- reason: 'Missing data for ' + field.alias + ' on root ' + root,
263
- nestedReason: data,
264
- };
265
- }
266
- else {
267
- // @ts-expect-error
268
- target[field.alias] = field.readerArtifact.resolver(data.data);
269
- }
270
- }
271
- else if (variant.kind === 'Component') {
272
- target[field.alias] = (0, componentCache_1.getOrCreateCachedComponent)(environment, root, variant.componentName, field.readerArtifact, variables, resolverRefetchQueries);
273
- }
274
- break;
275
- }
276
- }
277
- }
278
- return { kind: 'Success', data: target };
279
- }
280
- function defaultMissingFieldHandler(_storeRecord, _root, fieldName, arguments_, variables) {
281
- if (fieldName === 'node' || fieldName === 'user') {
282
- const variable = arguments_ === null || arguments_ === void 0 ? void 0 : arguments_['id'];
283
- const value = variables === null || variables === void 0 ? void 0 : variables[variable];
284
- // TODO can we handle explicit nulls here too? Probably, after wrapping in objects
285
- if (value != null) {
286
- return { __link: value };
287
- }
288
- }
289
- }
290
- exports.defaultMissingFieldHandler = defaultMissingFieldHandler;
291
- function assertLink(link) {
292
- if (Array.isArray(link)) {
293
- throw new Error('Unexpected array');
294
- }
295
- if (typeof link === 'object') {
296
- return link;
297
- }
298
- if (link === undefined) {
299
- return undefined;
300
- }
301
- throw new Error('Invalid link');
302
- }
303
- function filterVariables(variables, allowedVariables) {
304
- const result = {};
305
- for (const key of allowedVariables) {
306
- result[key] = variables[key];
307
- }
308
- return result;
309
- }
34
+ var FragmentReader_1 = require("./react/FragmentReader");
35
+ Object.defineProperty(exports, "FragmentReader", { enumerable: true, get: function () { return FragmentReader_1.FragmentReader; } });
36
+ var useResult_1 = require("./react/useResult");
37
+ Object.defineProperty(exports, "useResult", { enumerable: true, get: function () { return useResult_1.useResult; } });
38
+ var useReadAndSubscribe_1 = require("./react/useReadAndSubscribe");
39
+ Object.defineProperty(exports, "useReadAndSubscribe", { enumerable: true, get: function () { return useReadAndSubscribe_1.useReadAndSubscribe; } });
40
+ Object.defineProperty(exports, "useSubscribeToMultiple", { enumerable: true, get: function () { return useReadAndSubscribe_1.useSubscribeToMultiple; } });
41
+ var useLazyReference_1 = require("./react/useLazyReference");
42
+ Object.defineProperty(exports, "useLazyReference", { enumerable: true, get: function () { return useLazyReference_1.useLazyReference; } });
43
+ var useRerenderOnChange_1 = require("./react/useRerenderOnChange");
44
+ Object.defineProperty(exports, "useRerenderOnChange", { enumerable: true, get: function () { return useRerenderOnChange_1.useRerenderOnChange; } });
45
+ var useClientSideDefer_1 = require("./loadable-hooks/useClientSideDefer");
46
+ Object.defineProperty(exports, "useClientSideDefer", { enumerable: true, get: function () { return useClientSideDefer_1.useClientSideDefer; } });
47
+ var useImperativeExposedMutationField_1 = require("./loadable-hooks/useImperativeExposedMutationField");
48
+ Object.defineProperty(exports, "useImperativeExposedMutationField", { enumerable: true, get: function () { return useImperativeExposedMutationField_1.useImperativeExposedMutationField; } });
49
+ var useSkipLimitPagination_1 = require("./loadable-hooks/useSkipLimitPagination");
50
+ Object.defineProperty(exports, "useSkipLimitPagination", { enumerable: true, get: function () { return useSkipLimitPagination_1.useSkipLimitPagination; } });
51
+ var useImperativeLoadableField_1 = require("./loadable-hooks/useImperativeLoadableField");
52
+ Object.defineProperty(exports, "useImperativeLoadableField", { enumerable: true, get: function () { return useImperativeLoadableField_1.useImperativeLoadableField; } });
@@ -0,0 +1,4 @@
1
+ import { FragmentReference } from '../core/FragmentReference';
2
+ import { LoadableField } from '../core/reader';
3
+ export declare function useClientSideDefer<TResult>(loadableField: LoadableField<void, TResult>): FragmentReference<Record<string, never>, TResult>;
4
+ export declare function useClientSideDefer<TArgs extends Object, TResult>(loadableField: LoadableField<TArgs, TResult>, args: TArgs): FragmentReference<TArgs, TResult>;
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.useClientSideDefer = void 0;
4
+ const IsographEnvironmentProvider_1 = require("../react/IsographEnvironmentProvider");
5
+ const cache_1 = require("../core/cache");
6
+ const react_disposable_state_1 = require("@isograph/react-disposable-state");
7
+ function useClientSideDefer(loadableField, args) {
8
+ // @ts-expect-error args is missing iff it has the type void
9
+ const [id, loader] = loadableField(args);
10
+ const environment = (0, IsographEnvironmentProvider_1.useIsographEnvironment)();
11
+ const cache = (0, cache_1.getOrCreateItemInSuspenseCache)(environment, id, loader);
12
+ const fragmentReference = (0, react_disposable_state_1.useLazyDisposableState)(cache).state;
13
+ return fragmentReference;
14
+ }
15
+ exports.useClientSideDefer = useClientSideDefer;
@@ -0,0 +1,5 @@
1
+ type UseImperativeLoadableFieldReturn<TArgs> = {
2
+ loadField: (args: TArgs) => void;
3
+ };
4
+ export declare function useImperativeExposedMutationField<TArgs>(exposedField: (args: TArgs) => [string, () => void]): UseImperativeLoadableFieldReturn<TArgs>;
5
+ export {};
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.useImperativeExposedMutationField = void 0;
4
+ // Note: this function doesn't seem to work if there are additional arguments,
5
+ // e.g. with set_pet_tagline. Why? This seems to straightforwardly call
6
+ // exposedField(args)[1](); Odd.
7
+ function useImperativeExposedMutationField(exposedField) {
8
+ return {
9
+ loadField: (args) => {
10
+ const [_id, loader] = exposedField(args);
11
+ loader();
12
+ },
13
+ };
14
+ }
15
+ exports.useImperativeExposedMutationField = useImperativeExposedMutationField;
@@ -0,0 +1,9 @@
1
+ import { FragmentReference } from '../core/FragmentReference';
2
+ import { UnassignedState } from '@isograph/react-disposable-state';
3
+ import { LoadableField } from '../core/reader';
4
+ type UseImperativeLoadableFieldReturn<TArgs, TResult> = {
5
+ fragmentReference: FragmentReference<any, TResult> | UnassignedState;
6
+ loadField: (args: TArgs) => void;
7
+ };
8
+ export declare function useImperativeLoadableField<TArgs, TResult>(loadableField: LoadableField<TArgs, TResult>): UseImperativeLoadableFieldReturn<TArgs, TResult>;
9
+ export {};
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.useImperativeLoadableField = void 0;
4
+ const react_disposable_state_1 = require("@isograph/react-disposable-state");
5
+ function useImperativeLoadableField(loadableField) {
6
+ const { state, setState } = (0, react_disposable_state_1.useUpdatableDisposableState)();
7
+ return {
8
+ loadField: (args) => {
9
+ const [_id, loader] = loadableField(args);
10
+ setState(loader());
11
+ },
12
+ fragmentReference: state,
13
+ };
14
+ }
15
+ exports.useImperativeLoadableField = useImperativeLoadableField;
@@ -0,0 +1,33 @@
1
+ import { LoadableField } from '../core/reader';
2
+ import { FragmentReference } from '../core/FragmentReference';
3
+ type SkipOrLimit = 'skip' | 'limit';
4
+ type OmitSkipLimit<TArgs> = keyof Omit<TArgs, SkipOrLimit> extends never ? void | Record<string, never> : Omit<TArgs, SkipOrLimit>;
5
+ type UseSkipLimitReturnValue<TArgs, TItem> = {
6
+ readonly kind: 'Complete';
7
+ readonly fetchMore: (args: OmitSkipLimit<TArgs>, count: number) => void;
8
+ readonly results: ReadonlyArray<TItem>;
9
+ } | {
10
+ readonly kind: 'Pending';
11
+ readonly results: ReadonlyArray<TItem>;
12
+ readonly pendingFragment: FragmentReference<any, ReadonlyArray<TItem>>;
13
+ };
14
+ /**
15
+ * accepts a loadableField that accepts skip and limit arguments
16
+ * and returns:
17
+ * - a fetchMore function that, when called, triggers a network
18
+ * request for additional data, and
19
+ * - the data received so far.
20
+ *
21
+ * This hook will suspend if any network request is in flight.
22
+ *
23
+ * Calling fetchMore before the hook mounts is a no-op.
24
+ *
25
+ * NOTE: this hook does not subscribe to changes. This is a known
26
+ * issue. If you are running into this issue, reach out on GitHub/
27
+ * Twitter, and we'll fix the issue.
28
+ */
29
+ export declare function useSkipLimitPagination<TArgs extends {
30
+ skip: number | void | null;
31
+ limit: number | void | null;
32
+ }, TItem>(loadableField: LoadableField<TArgs, Array<TItem>>): UseSkipLimitReturnValue<TArgs, TItem>;
33
+ export {};