@ldo/solid-react 0.0.1-1.0.0-alpha.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.
Files changed (187) hide show
  1. package/LICENSE.txt +21 -0
  2. package/README.md +138 -0
  3. package/dist/BrowserSolidLdoProvider.d.ts +2 -0
  4. package/dist/BrowserSolidLdoProvider.js +63 -0
  5. package/dist/BrowserSolidLdoProvider.js.map +1 -0
  6. package/dist/SolidAuthContext.d.ts +14 -0
  7. package/dist/SolidAuthContext.js +10 -0
  8. package/dist/SolidAuthContext.js.map +1 -0
  9. package/dist/SolidLdoProvider.d.ts +8 -0
  10. package/dist/SolidLdoProvider.js +31 -0
  11. package/dist/SolidLdoProvider.js.map +1 -0
  12. package/dist/UnauthenticatedSolidLdoProvider.d.ts +2 -0
  13. package/dist/UnauthenticatedSolidLdoProvider.js +41 -0
  14. package/dist/UnauthenticatedSolidLdoProvider.js.map +1 -0
  15. package/dist/index.d.ts +9 -0
  16. package/dist/index.js +28 -0
  17. package/dist/index.js.map +1 -0
  18. package/dist/jsonld-dataset-proxy/src/ContextUtil.d.ts +17 -0
  19. package/dist/jsonld-dataset-proxy/src/ContextUtil.js +108 -0
  20. package/dist/jsonld-dataset-proxy/src/ContextUtil.js.map +1 -0
  21. package/dist/jsonld-dataset-proxy/src/LdoJsonldContext.d.ts +8 -0
  22. package/dist/jsonld-dataset-proxy/src/LdoJsonldContext.js +3 -0
  23. package/dist/jsonld-dataset-proxy/src/LdoJsonldContext.js.map +1 -0
  24. package/dist/jsonld-dataset-proxy/src/ProxyContext.d.ts +31 -0
  25. package/dist/jsonld-dataset-proxy/src/ProxyContext.js +63 -0
  26. package/dist/jsonld-dataset-proxy/src/ProxyContext.js.map +1 -0
  27. package/dist/jsonld-dataset-proxy/src/language/languageTypes.d.ts +2 -0
  28. package/dist/jsonld-dataset-proxy/src/language/languageTypes.js +3 -0
  29. package/dist/jsonld-dataset-proxy/src/language/languageTypes.js.map +1 -0
  30. package/dist/jsonld-dataset-proxy/src/language/languageUtils.d.ts +14 -0
  31. package/dist/jsonld-dataset-proxy/src/language/languageUtils.js +73 -0
  32. package/dist/jsonld-dataset-proxy/src/language/languageUtils.js.map +1 -0
  33. package/dist/jsonld-dataset-proxy/src/setProxy/ObjectSetProxy.d.ts +17 -0
  34. package/dist/jsonld-dataset-proxy/src/setProxy/ObjectSetProxy.js +31 -0
  35. package/dist/jsonld-dataset-proxy/src/setProxy/ObjectSetProxy.js.map +1 -0
  36. package/dist/jsonld-dataset-proxy/src/setProxy/SetProxy.d.ts +29 -0
  37. package/dist/jsonld-dataset-proxy/src/setProxy/SetProxy.js +72 -0
  38. package/dist/jsonld-dataset-proxy/src/setProxy/SetProxy.js.map +1 -0
  39. package/dist/jsonld-dataset-proxy/src/setProxy/SubjectSetProxy.d.ts +15 -0
  40. package/dist/jsonld-dataset-proxy/src/setProxy/SubjectSetProxy.js +38 -0
  41. package/dist/jsonld-dataset-proxy/src/setProxy/SubjectSetProxy.js.map +1 -0
  42. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardObjectSetProxy.d.ts +20 -0
  43. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardObjectSetProxy.js +49 -0
  44. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardObjectSetProxy.js.map +1 -0
  45. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardSubjectSetProxy.d.ts +19 -0
  46. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardSubjectSetProxy.js +31 -0
  47. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardSubjectSetProxy.js.map +1 -0
  48. package/dist/jsonld-dataset-proxy/src/setProxy/createNewSetProxy.d.ts +5 -0
  49. package/dist/jsonld-dataset-proxy/src/setProxy/createNewSetProxy.js +27 -0
  50. package/dist/jsonld-dataset-proxy/src/setProxy/createNewSetProxy.js.map +1 -0
  51. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/BasicLdSet.d.ts +36 -0
  52. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/BasicLdSet.js +193 -0
  53. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/BasicLdSet.js.map +1 -0
  54. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/LdSet.d.ts +30 -0
  55. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/LdSet.js +3 -0
  56. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/LdSet.js.map +1 -0
  57. package/dist/jsonld-dataset-proxy/src/subjectProxy/SubjectProxy.d.ts +14 -0
  58. package/dist/jsonld-dataset-proxy/src/subjectProxy/SubjectProxy.js +3 -0
  59. package/dist/jsonld-dataset-proxy/src/subjectProxy/SubjectProxy.js.map +1 -0
  60. package/dist/jsonld-dataset-proxy/src/subjectProxy/createSubjectHandler.d.ts +6 -0
  61. package/dist/jsonld-dataset-proxy/src/subjectProxy/createSubjectHandler.js +75 -0
  62. package/dist/jsonld-dataset-proxy/src/subjectProxy/createSubjectHandler.js.map +1 -0
  63. package/dist/jsonld-dataset-proxy/src/subjectProxy/deleteFromDataset.d.ts +3 -0
  64. package/dist/jsonld-dataset-proxy/src/subjectProxy/deleteFromDataset.js +25 -0
  65. package/dist/jsonld-dataset-proxy/src/subjectProxy/deleteFromDataset.js.map +1 -0
  66. package/dist/jsonld-dataset-proxy/src/subjectProxy/getValueForKey.d.ts +5 -0
  67. package/dist/jsonld-dataset-proxy/src/subjectProxy/getValueForKey.js +41 -0
  68. package/dist/jsonld-dataset-proxy/src/subjectProxy/getValueForKey.js.map +1 -0
  69. package/dist/jsonld-dataset-proxy/src/subjectProxy/isSubjectProxy.d.ts +4 -0
  70. package/dist/jsonld-dataset-proxy/src/subjectProxy/isSubjectProxy.js +25 -0
  71. package/dist/jsonld-dataset-proxy/src/subjectProxy/isSubjectProxy.js.map +1 -0
  72. package/dist/jsonld-dataset-proxy/src/types.d.ts +9 -0
  73. package/dist/jsonld-dataset-proxy/src/types.js +11 -0
  74. package/dist/jsonld-dataset-proxy/src/types.js.map +1 -0
  75. package/dist/jsonld-dataset-proxy/src/util/NodeSet.d.ts +9 -0
  76. package/dist/jsonld-dataset-proxy/src/util/NodeSet.js +35 -0
  77. package/dist/jsonld-dataset-proxy/src/util/NodeSet.js.map +1 -0
  78. package/dist/jsonld-dataset-proxy/src/util/RawObject.d.ts +9 -0
  79. package/dist/jsonld-dataset-proxy/src/util/RawObject.js +3 -0
  80. package/dist/jsonld-dataset-proxy/src/util/RawObject.js.map +1 -0
  81. package/dist/jsonld-dataset-proxy/src/util/addObjectToDataset.d.ts +8 -0
  82. package/dist/jsonld-dataset-proxy/src/util/addObjectToDataset.js +83 -0
  83. package/dist/jsonld-dataset-proxy/src/util/addObjectToDataset.js.map +1 -0
  84. package/dist/jsonld-dataset-proxy/src/util/getNodeFromRaw.d.ts +6 -0
  85. package/dist/jsonld-dataset-proxy/src/util/getNodeFromRaw.js +47 -0
  86. package/dist/jsonld-dataset-proxy/src/util/getNodeFromRaw.js.map +1 -0
  87. package/dist/jsonld-dataset-proxy/src/util/nodeToJsonldRepresentation.d.ts +7 -0
  88. package/dist/jsonld-dataset-proxy/src/util/nodeToJsonldRepresentation.js +75 -0
  89. package/dist/jsonld-dataset-proxy/src/util/nodeToJsonldRepresentation.js.map +1 -0
  90. package/dist/solid-react/src/BrowserSolidLdoProvider.d.ts +2 -0
  91. package/dist/solid-react/src/BrowserSolidLdoProvider.js +63 -0
  92. package/dist/solid-react/src/BrowserSolidLdoProvider.js.map +1 -0
  93. package/dist/solid-react/src/SolidAuthContext.d.ts +14 -0
  94. package/dist/solid-react/src/SolidAuthContext.js +10 -0
  95. package/dist/solid-react/src/SolidAuthContext.js.map +1 -0
  96. package/dist/solid-react/src/SolidLdoProvider.d.ts +8 -0
  97. package/dist/solid-react/src/SolidLdoProvider.js +31 -0
  98. package/dist/solid-react/src/SolidLdoProvider.js.map +1 -0
  99. package/dist/solid-react/src/UnauthenticatedSolidLdoProvider.d.ts +2 -0
  100. package/dist/solid-react/src/UnauthenticatedSolidLdoProvider.js +41 -0
  101. package/dist/solid-react/src/UnauthenticatedSolidLdoProvider.js.map +1 -0
  102. package/dist/solid-react/src/index.d.ts +9 -0
  103. package/dist/solid-react/src/index.js +28 -0
  104. package/dist/solid-react/src/index.js.map +1 -0
  105. package/dist/solid-react/src/useLdoMethods.d.ts +12 -0
  106. package/dist/solid-react/src/useLdoMethods.js +20 -0
  107. package/dist/solid-react/src/useLdoMethods.js.map +1 -0
  108. package/dist/solid-react/src/useMatchObject.d.ts +3 -0
  109. package/dist/solid-react/src/useMatchObject.js +13 -0
  110. package/dist/solid-react/src/useMatchObject.js.map +1 -0
  111. package/dist/solid-react/src/useMatchSubject.d.ts +3 -0
  112. package/dist/solid-react/src/useMatchSubject.js +13 -0
  113. package/dist/solid-react/src/useMatchSubject.js.map +1 -0
  114. package/dist/solid-react/src/useResource.d.ts +12 -0
  115. package/dist/solid-react/src/useResource.js +63 -0
  116. package/dist/solid-react/src/useResource.js.map +1 -0
  117. package/dist/solid-react/src/useRootContainer.d.ts +3 -0
  118. package/dist/solid-react/src/useRootContainer.js +26 -0
  119. package/dist/solid-react/src/useRootContainer.js.map +1 -0
  120. package/dist/solid-react/src/useSubject.d.ts +5 -0
  121. package/dist/solid-react/src/useSubject.js +15 -0
  122. package/dist/solid-react/src/useSubject.js.map +1 -0
  123. package/dist/solid-react/src/useSubscribeToResource.d.ts +1 -0
  124. package/dist/solid-react/src/useSubscribeToResource.js +40 -0
  125. package/dist/solid-react/src/useSubscribeToResource.js.map +1 -0
  126. package/dist/solid-react/src/util/TrackingProxyContext.d.ts +16 -0
  127. package/dist/solid-react/src/util/TrackingProxyContext.js +27 -0
  128. package/dist/solid-react/src/util/TrackingProxyContext.js.map +1 -0
  129. package/dist/solid-react/src/util/TrackingSetProxy.d.ts +4 -0
  130. package/dist/solid-react/src/util/TrackingSetProxy.js +44 -0
  131. package/dist/solid-react/src/util/TrackingSetProxy.js.map +1 -0
  132. package/dist/solid-react/src/util/TrackingSubjectProxy.d.ts +4 -0
  133. package/dist/solid-react/src/util/TrackingSubjectProxy.js +31 -0
  134. package/dist/solid-react/src/util/TrackingSubjectProxy.js.map +1 -0
  135. package/dist/solid-react/src/util/useTrackingProxy.d.ts +3 -0
  136. package/dist/solid-react/src/util/useTrackingProxy.js +34 -0
  137. package/dist/solid-react/src/util/useTrackingProxy.js.map +1 -0
  138. package/dist/useLdoMethods.d.ts +12 -0
  139. package/dist/useLdoMethods.js +20 -0
  140. package/dist/useLdoMethods.js.map +1 -0
  141. package/dist/useMatchObject.d.ts +3 -0
  142. package/dist/useMatchObject.js +13 -0
  143. package/dist/useMatchObject.js.map +1 -0
  144. package/dist/useMatchSubject.d.ts +3 -0
  145. package/dist/useMatchSubject.js +13 -0
  146. package/dist/useMatchSubject.js.map +1 -0
  147. package/dist/useResource.d.ts +12 -0
  148. package/dist/useResource.js +63 -0
  149. package/dist/useResource.js.map +1 -0
  150. package/dist/useRootContainer.d.ts +3 -0
  151. package/dist/useRootContainer.js +26 -0
  152. package/dist/useRootContainer.js.map +1 -0
  153. package/dist/useSubject.d.ts +5 -0
  154. package/dist/useSubject.js +15 -0
  155. package/dist/useSubject.js.map +1 -0
  156. package/dist/useSubscribeToResource.d.ts +1 -0
  157. package/dist/useSubscribeToResource.js +40 -0
  158. package/dist/useSubscribeToResource.js.map +1 -0
  159. package/dist/util/TrackingProxyContext.d.ts +16 -0
  160. package/dist/util/TrackingProxyContext.js +27 -0
  161. package/dist/util/TrackingProxyContext.js.map +1 -0
  162. package/dist/util/TrackingSetProxy.d.ts +4 -0
  163. package/dist/util/TrackingSetProxy.js +44 -0
  164. package/dist/util/TrackingSetProxy.js.map +1 -0
  165. package/dist/util/TrackingSubjectProxy.d.ts +4 -0
  166. package/dist/util/TrackingSubjectProxy.js +31 -0
  167. package/dist/util/TrackingSubjectProxy.js.map +1 -0
  168. package/dist/util/useTrackingProxy.d.ts +3 -0
  169. package/dist/util/useTrackingProxy.js +34 -0
  170. package/dist/util/useTrackingProxy.js.map +1 -0
  171. package/package.json +56 -0
  172. package/src/BrowserSolidLdoProvider.tsx +97 -0
  173. package/src/SolidAuthContext.ts +26 -0
  174. package/src/SolidLdoProvider.tsx +55 -0
  175. package/src/UnauthenticatedSolidLdoProvider.tsx +62 -0
  176. package/src/index.ts +12 -0
  177. package/src/useLdoMethods.ts +84 -0
  178. package/src/useMatchObject.ts +21 -0
  179. package/src/useMatchSubject.ts +21 -0
  180. package/src/useResource.ts +114 -0
  181. package/src/useRootContainer.ts +31 -0
  182. package/src/useSubject.ts +30 -0
  183. package/src/useSubscribeToResource.ts +52 -0
  184. package/src/util/TrackingProxyContext.ts +61 -0
  185. package/src/util/TrackingSetProxy.ts +56 -0
  186. package/src/util/TrackingSubjectProxy.ts +43 -0
  187. package/src/util/useTrackingProxy.ts +55 -0
@@ -0,0 +1,40 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.useSubscribeToResource = void 0;
4
+ const SolidLdoProvider_1 = require("./SolidLdoProvider");
5
+ const react_1 = require("react");
6
+ function useSubscribeToResource(...uris) {
7
+ const { dataset } = (0, SolidLdoProvider_1.useLdo)();
8
+ const currentlySubscribed = (0, react_1.useRef)({});
9
+ (0, react_1.useEffect)(() => {
10
+ const resources = uris.map((uri) => dataset.getResource(uri));
11
+ const previousSubscriptions = { ...currentlySubscribed.current };
12
+ Promise.all(resources.map(async (resource) => {
13
+ if (!previousSubscriptions[resource.uri]) {
14
+ currentlySubscribed.current[resource.uri] = "AWAITING";
15
+ await resource.readIfUnfetched();
16
+ currentlySubscribed.current[resource.uri] =
17
+ await resource.subscribeToNotifications();
18
+ }
19
+ else {
20
+ delete previousSubscriptions[resource.uri];
21
+ }
22
+ })).then(async () => {
23
+ await Promise.all(Object.entries(previousSubscriptions).map(async ([resourceUri, subscriptionId]) => {
24
+ delete currentlySubscribed.current[resourceUri];
25
+ const resource = dataset.getResource(resourceUri);
26
+ await resource.unsubscribeFromNotifications(subscriptionId);
27
+ }));
28
+ });
29
+ }, [uris]);
30
+ (0, react_1.useEffect)(() => {
31
+ return () => {
32
+ Promise.all(Object.entries(currentlySubscribed.current).map(async ([resourceUri, subscriptionId]) => {
33
+ const resource = dataset.getResource(resourceUri);
34
+ await resource.unsubscribeFromNotifications(subscriptionId);
35
+ }));
36
+ };
37
+ }, []);
38
+ }
39
+ exports.useSubscribeToResource = useSubscribeToResource;
40
+ //# sourceMappingURL=useSubscribeToResource.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useSubscribeToResource.js","sourceRoot":"","sources":["../src/useSubscribeToResource.ts"],"names":[],"mappings":";;;AAAA,yDAA4C;AAC5C,iCAA0C;AAE1C,SAAgB,sBAAsB,CAAC,GAAG,IAAc;IACtD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,yBAAM,GAAE,CAAC;IAC7B,MAAM,mBAAmB,GAAG,IAAA,cAAM,EAAyB,EAAE,CAAC,CAAC;IAC/D,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAC9D,MAAM,qBAAqB,GAAG,EAAE,GAAG,mBAAmB,CAAC,OAAO,EAAE,CAAC;QACjE,OAAO,CAAC,GAAG,CACT,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YAC/B,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAGxC,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC;gBAEvD,MAAM,QAAQ,CAAC,eAAe,EAAE,CAAC;gBACjC,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;oBACvC,MAAM,QAAQ,CAAC,wBAAwB,EAAE,CAAC;aAC7C;iBAAM;gBACL,OAAO,qBAAqB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;aAC5C;QACH,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;YAEhB,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,GAAG,CACvC,KAAK,EAAE,CAAC,WAAW,EAAE,cAAc,CAAC,EAAE,EAAE;gBAEtC,OAAO,mBAAmB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBAChD,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;gBAClD,MAAM,QAAQ,CAAC,4BAA4B,CAAC,cAAc,CAAC,CAAC;YAC9D,CAAC,CACF,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAGX,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,GAAG,CACT,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,GAAG,CAC7C,KAAK,EAAE,CAAC,WAAW,EAAE,cAAc,CAAC,EAAE,EAAE;gBACtC,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;gBAClD,MAAM,QAAQ,CAAC,4BAA4B,CAAC,cAAc,CAAC,CAAC;YAC9D,CAAC,CACF,CACF,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAhDD,wDAgDC"}
@@ -0,0 +1,16 @@
1
+ import type { ProxyContextOptions, SubjectProxy, SetProxy } from "@ldo/jsonld-dataset-proxy";
2
+ import { ProxyContext } from "@ldo/jsonld-dataset-proxy";
3
+ import type { QuadMatch } from "@ldo/rdf-utils";
4
+ import type { SubscribableDataset } from "@ldo/subscribable-dataset";
5
+ import type { BlankNode, NamedNode, Quad } from "@rdfjs/types";
6
+ export interface TrackingProxyContextOptions extends ProxyContextOptions {
7
+ dataset: SubscribableDataset<Quad>;
8
+ }
9
+ export declare class TrackingProxyContext extends ProxyContext {
10
+ private listener;
11
+ private subscribableDataset;
12
+ constructor(options: TrackingProxyContextOptions, listener: () => void);
13
+ addListener(eventName: QuadMatch): void;
14
+ protected createNewSubjectProxy(node: NamedNode | BlankNode): SubjectProxy;
15
+ protected createNewSetProxy(quadMatch: QuadMatch, isSubjectOriented?: boolean, isLangStringSet?: boolean): SetProxy;
16
+ }
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.TrackingProxyContext = void 0;
4
+ const jsonld_dataset_proxy_1 = require("@ldo/jsonld-dataset-proxy");
5
+ const TrackingSubjectProxy_1 = require("./TrackingSubjectProxy");
6
+ const TrackingSetProxy_1 = require("./TrackingSetProxy");
7
+ class TrackingProxyContext extends jsonld_dataset_proxy_1.ProxyContext {
8
+ constructor(options, listener) {
9
+ super(options);
10
+ this.subscribableDataset = options.dataset;
11
+ this.listener = listener;
12
+ }
13
+ addListener(eventName) {
14
+ const listeners = this.subscribableDataset.listeners(eventName);
15
+ if (!listeners.includes(this.listener)) {
16
+ this.subscribableDataset.on(eventName, this.listener);
17
+ }
18
+ }
19
+ createNewSubjectProxy(node) {
20
+ return (0, TrackingSubjectProxy_1.createTrackingSubjectProxy)(this, node);
21
+ }
22
+ createNewSetProxy(quadMatch, isSubjectOriented, isLangStringSet) {
23
+ return (0, TrackingSetProxy_1.createTrackingSetProxy)(this, quadMatch, isSubjectOriented, isLangStringSet);
24
+ }
25
+ }
26
+ exports.TrackingProxyContext = TrackingProxyContext;
27
+ //# sourceMappingURL=TrackingProxyContext.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"TrackingProxyContext.js","sourceRoot":"","sources":["../../src/util/TrackingProxyContext.ts"],"names":[],"mappings":";;;AAKA,oEAAyD;AAIzD,iEAAoE;AACpE,yDAA4D;AAgB5D,MAAa,oBAAqB,SAAQ,mCAAY;IAIpD,YAAY,OAAoC,EAAE,QAAoB;QACpE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAGM,WAAW,CAAC,SAAoB;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACtC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;SACvD;IACH,CAAC;IAES,qBAAqB,CAAC,IAA2B;QACzD,OAAO,IAAA,iDAA0B,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAES,iBAAiB,CACzB,SAAoB,EACpB,iBAA2B,EAC3B,eAAyB;QAEzB,OAAO,IAAA,yCAAsB,EAC3B,IAAI,EACJ,SAAS,EACT,iBAAiB,EACjB,eAAe,CAChB,CAAC;IACJ,CAAC;CACF;AAlCD,oDAkCC"}
@@ -0,0 +1,4 @@
1
+ import { type SetProxy } from "@ldo/jsonld-dataset-proxy";
2
+ import type { TrackingProxyContext } from "./TrackingProxyContext";
3
+ import type { QuadMatch } from "@ldo/rdf-utils";
4
+ export declare function createTrackingSetProxy(proxyContext: TrackingProxyContext, quadMatch: QuadMatch, isSubjectOriented?: boolean, isLangStringSet?: boolean): SetProxy;
@@ -0,0 +1,44 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.createTrackingSetProxy = void 0;
4
+ const jsonld_dataset_proxy_1 = require("@ldo/jsonld-dataset-proxy");
5
+ function createTrackingSetProxy(proxyContext, quadMatch, isSubjectOriented, isLangStringSet) {
6
+ const baseSetProxy = (0, jsonld_dataset_proxy_1.createNewSetProxy)(quadMatch, isSubjectOriented ?? false, proxyContext, isLangStringSet);
7
+ return new Proxy(baseSetProxy, {
8
+ get: (target, key, receiver) => {
9
+ if (trackingMethods.has(key)) {
10
+ proxyContext.addListener(quadMatch);
11
+ }
12
+ else if (disallowedMethods.has(key)) {
13
+ console.warn("You've attempted to modify a value on a Linked Data Object from the useSubject, useMatchingSubject, or useMatchingObject hooks. These linked data objects should only be used to render data, not modify it. To modify data, use the `changeData` function.");
14
+ }
15
+ return Reflect.get(target, key, receiver);
16
+ },
17
+ });
18
+ }
19
+ exports.createTrackingSetProxy = createTrackingSetProxy;
20
+ const trackingMethods = new Set([
21
+ "has",
22
+ "size",
23
+ "entries",
24
+ "keys",
25
+ "values",
26
+ Symbol.iterator,
27
+ "every",
28
+ "every",
29
+ "some",
30
+ "forEach",
31
+ "map",
32
+ "reduce",
33
+ "toArray",
34
+ "toJSON",
35
+ "difference",
36
+ "intersection",
37
+ "isDisjointFrom",
38
+ "isSubsetOf",
39
+ "isSupersetOf",
40
+ "symmetricDifference",
41
+ "union",
42
+ ]);
43
+ const disallowedMethods = new Set(["add", "clear", "delete"]);
44
+ //# sourceMappingURL=TrackingSetProxy.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"TrackingSetProxy.js","sourceRoot":"","sources":["../../src/util/TrackingSetProxy.ts"],"names":[],"mappings":";;;AAAA,oEAA6E;AAI7E,SAAgB,sBAAsB,CACpC,YAAkC,EAClC,SAAoB,EACpB,iBAA2B,EAC3B,eAAyB;IAEzB,MAAM,YAAY,GAAG,IAAA,wCAAiB,EACpC,SAAS,EACT,iBAAiB,IAAI,KAAK,EAC1B,YAAY,EACZ,eAAe,CAChB,CAAC;IAEF,OAAO,IAAI,KAAK,CAAC,YAAY,EAAE;QAC7B,GAAG,EAAE,CAAC,MAAgB,EAAE,GAAoB,EAAE,QAAQ,EAAE,EAAE;YACxD,IAAI,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBAC5B,YAAY,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;aACrC;iBAAM,IAAI,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBACrC,OAAO,CAAC,IAAI,CACV,6PAA6P,CAC9P,CAAC;aACH;YACD,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC5C,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAzBD,wDAyBC;AAED,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC;IAC9B,KAAK;IACL,MAAM;IACN,SAAS;IACT,MAAM;IACN,QAAQ;IACR,MAAM,CAAC,QAAQ;IACf,OAAO;IACP,OAAO;IACP,MAAM;IACN,SAAS;IACT,KAAK;IACL,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,YAAY;IACZ,cAAc;IACd,gBAAgB;IAChB,YAAY;IACZ,cAAc;IACd,qBAAqB;IACrB,OAAO;CACR,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC"}
@@ -0,0 +1,4 @@
1
+ import { type SubjectProxy } from "@ldo/jsonld-dataset-proxy";
2
+ import type { BlankNode, NamedNode } from "@rdfjs/types";
3
+ import type { TrackingProxyContext } from "./TrackingProxyContext";
4
+ export declare function createTrackingSubjectProxy(proxyContext: TrackingProxyContext, node: NamedNode | BlankNode): SubjectProxy;
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.createTrackingSubjectProxy = void 0;
4
+ const jsonld_dataset_proxy_1 = require("@ldo/jsonld-dataset-proxy");
5
+ const data_model_1 = require("@rdfjs/data-model");
6
+ function createTrackingSubjectProxy(proxyContext, node) {
7
+ const baseHandler = (0, jsonld_dataset_proxy_1.createSubjectHandler)(proxyContext);
8
+ const oldGetFunction = baseHandler.get;
9
+ const newGetFunction = (target, key, receiver) => {
10
+ const subject = target["@id"];
11
+ const rdfTypes = proxyContext.getRdfType(subject);
12
+ if (typeof key === "symbol") {
13
+ }
14
+ else if (key === "@id") {
15
+ proxyContext.addListener([subject, null, null, null]);
16
+ }
17
+ else if (!proxyContext.contextUtil.isSet(key, rdfTypes)) {
18
+ const predicate = (0, data_model_1.namedNode)(proxyContext.contextUtil.keyToIri(key, rdfTypes));
19
+ proxyContext.addListener([subject, predicate, null, null]);
20
+ }
21
+ return oldGetFunction && oldGetFunction(target, key, receiver);
22
+ };
23
+ baseHandler.get = newGetFunction;
24
+ baseHandler.set = () => {
25
+ console.warn("You've attempted to set a value on a Linked Data Object from the useSubject, useMatchingSubject, or useMatchingObject hooks. These linked data objects should only be used to render data, not modify it. To modify data, use the `changeData` function.");
26
+ return true;
27
+ };
28
+ return new Proxy({ "@id": node }, baseHandler);
29
+ }
30
+ exports.createTrackingSubjectProxy = createTrackingSubjectProxy;
31
+ //# sourceMappingURL=TrackingSubjectProxy.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"TrackingSubjectProxy.js","sourceRoot":"","sources":["../../src/util/TrackingSubjectProxy.ts"],"names":[],"mappings":";;;AACA,oEAGmC;AAGnC,kDAA8C;AAE9C,SAAgB,0BAA0B,CACxC,YAAkC,EAClC,IAA2B;IAE3B,MAAM,WAAW,GAAG,IAAA,2CAAoB,EAAC,YAAY,CAAC,CAAC;IACvD,MAAM,cAAc,GAAG,WAAW,CAAC,GAAG,CAAC;IACvC,MAAM,cAAc,GAA4C,CAC9D,MAA0B,EAC1B,GAAoB,EACpB,QAAQ,EACR,EAAE;QACF,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,MAAM,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;SAE5B;aAAM,IAAI,GAAG,KAAK,KAAK,EAAE;YACxB,YAAY,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;SACvD;aAAM,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE;YACzD,MAAM,SAAS,GAAG,IAAA,sBAAS,EACzB,YAAY,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CACjD,CAAC;YACF,YAAY,CAAC,WAAW,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;SAC5D;QACD,OAAO,cAAc,IAAI,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC,CAAC;IACF,WAAW,CAAC,GAAG,GAAG,cAAc,CAAC;IACjC,WAAW,CAAC,GAAG,GAAG,GAAG,EAAE;QACrB,OAAO,CAAC,IAAI,CACV,0PAA0P,CAC3P,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IACF,OAAO,IAAI,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,WAAW,CAA4B,CAAC;AAC5E,CAAC;AAjCD,gEAiCC"}
@@ -0,0 +1,3 @@
1
+ import { LdoBuilder } from "@ldo/ldo";
2
+ import type { LdoBase, ShapeType } from "@ldo/ldo";
3
+ export declare function useTrackingProxy<Type extends LdoBase, ReturnType>(shapeType: ShapeType<Type>, createLdo: (builder: LdoBuilder<Type>) => ReturnType): ReturnType;
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.useTrackingProxy = void 0;
4
+ const jsonld_dataset_proxy_1 = require("@ldo/jsonld-dataset-proxy");
5
+ const ldo_1 = require("@ldo/ldo");
6
+ const react_1 = require("react");
7
+ const TrackingProxyContext_1 = require("./TrackingProxyContext");
8
+ const data_model_1 = require("@rdfjs/data-model");
9
+ const SolidLdoProvider_1 = require("../SolidLdoProvider");
10
+ function useTrackingProxy(shapeType, createLdo) {
11
+ const { dataset } = (0, SolidLdoProvider_1.useLdo)();
12
+ const [forceUpdateCounter, setForceUpdateCounter] = (0, react_1.useState)(0);
13
+ const forceUpdate = (0, react_1.useCallback)(() => setForceUpdateCounter((val) => val + 1), []);
14
+ const linkedDataObject = (0, react_1.useMemo)(() => {
15
+ dataset.removeListenerFromAllEvents(forceUpdate);
16
+ const contextUtil = new jsonld_dataset_proxy_1.ContextUtil(shapeType.context);
17
+ const proxyContext = new TrackingProxyContext_1.TrackingProxyContext({
18
+ dataset,
19
+ contextUtil,
20
+ writeGraphs: [(0, data_model_1.defaultGraph)()],
21
+ languageOrdering: ["none", "en", "other"],
22
+ }, forceUpdate);
23
+ const builder = new ldo_1.LdoBuilder(new jsonld_dataset_proxy_1.JsonldDatasetProxyBuilder(proxyContext), shapeType);
24
+ return createLdo(builder);
25
+ }, [shapeType, dataset, forceUpdateCounter, forceUpdate, createLdo]);
26
+ (0, react_1.useEffect)(() => {
27
+ return () => {
28
+ dataset.removeListenerFromAllEvents(forceUpdate);
29
+ };
30
+ }, [shapeType]);
31
+ return linkedDataObject;
32
+ }
33
+ exports.useTrackingProxy = useTrackingProxy;
34
+ //# sourceMappingURL=useTrackingProxy.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useTrackingProxy.js","sourceRoot":"","sources":["../../src/util/useTrackingProxy.ts"],"names":[],"mappings":";;;AAAA,oEAGmC;AACnC,kCAAsC;AAEtC,iCAAkE;AAClE,iEAA8D;AAC9D,kDAAiD;AACjD,0DAA6C;AAE7C,SAAgB,gBAAgB,CAC9B,SAA0B,EAC1B,SAAoD;IAEpD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,yBAAM,GAAE,CAAC;IAE7B,MAAM,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,GAAG,IAAA,gBAAQ,EAAC,CAAC,CAAC,CAAC;IAChE,MAAM,WAAW,GAAG,IAAA,mBAAW,EAC7B,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,EAC7C,EAAE,CACH,CAAC;IAGF,MAAM,gBAAgB,GAAG,IAAA,eAAO,EAAC,GAAG,EAAE;QAEpC,OAAO,CAAC,2BAA2B,CAAC,WAAW,CAAC,CAAC;QAGjD,MAAM,WAAW,GAAG,IAAI,kCAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,YAAY,GAAG,IAAI,2CAAoB,CAC3C;YACE,OAAO;YACP,WAAW;YACX,WAAW,EAAE,CAAC,IAAA,yBAAY,GAAE,CAAC;YAC7B,gBAAgB,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC;SAC1C,EACD,WAAW,CACZ,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,gBAAU,CAC5B,IAAI,gDAAyB,CAAC,YAAY,CAAC,EAC3C,SAAS,CACV,CAAC;QACF,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;IAErE,IAAA,iBAAS,EAAC,GAAG,EAAE;QAEb,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,2BAA2B,CAAC,WAAW,CAAC,CAAC;QACnD,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhB,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AA3CD,4CA2CC"}
package/package.json ADDED
@@ -0,0 +1,56 @@
1
+ {
2
+ "name": "@ldo/solid-react",
3
+ "version": "0.0.1-1.0.0-alpha.1.0",
4
+ "description": "A React library for LDO and Solid",
5
+ "main": "dist/index.js",
6
+ "scripts": {
7
+ "build": "tsc --project tsconfig.build.json",
8
+ "watch": "tsc --watch",
9
+ "test": "npm run test:integration",
10
+ "test:watch": "jest --watch",
11
+ "prepublishOnly": "npm run test && npm run build",
12
+ "build:ldo": "ldo build --input src/shapes --output src/ldo",
13
+ "lint": "eslint src/** --fix --no-error-on-unmatched-pattern",
14
+ "test:integration": "start-server-and-test start-test-server http://localhost:3002 start-integration-test",
15
+ "start-test-server": "ts-node ./test/test-server/runServer.ts",
16
+ "start-integration-test": "jest --coverage"
17
+ },
18
+ "repository": {
19
+ "type": "git",
20
+ "url": "git+https://github.com/o-development/ldobjects.git"
21
+ },
22
+ "author": "Jackson Morgan",
23
+ "license": "MIT",
24
+ "bugs": {
25
+ "url": "https://github.com/o-development/ldobjects/issues"
26
+ },
27
+ "homepage": "https://github.com/o-development/ldobjects/tree/main/packages/solid-react#readme",
28
+ "devDependencies": {
29
+ "@ldo/rdf-utils": "^0.0.1-alpha.24",
30
+ "@rdfjs/types": "^1.0.1",
31
+ "@testing-library/react": "^14.1.2",
32
+ "@types/jest": "^27.0.3",
33
+ "jest-environment-jsdom": "^27.0.0",
34
+ "start-server-and-test": "^2.0.3",
35
+ "ts-jest": "^27.1.2",
36
+ "ts-node": "^10.9.2"
37
+ },
38
+ "dependencies": {
39
+ "@inrupt/solid-client-authn-browser": "^2.0.0",
40
+ "@ldo/dataset": "^0.0.1-1.0.0-alpha.1.0",
41
+ "@ldo/jsonld-dataset-proxy": "^0.0.1-1.0.0-alpha.1.0",
42
+ "@ldo/ldo": "^0.0.1-1.0.0-alpha.1.0",
43
+ "@ldo/solid": "^0.0.1-1.0.0-alpha.1.0",
44
+ "@ldo/subscribable-dataset": "^0.0.1-1.0.0-alpha.1.0",
45
+ "@rdfjs/data-model": "^1.2.0",
46
+ "cross-fetch": "^3.1.6"
47
+ },
48
+ "files": [
49
+ "dist",
50
+ "src"
51
+ ],
52
+ "publishConfig": {
53
+ "access": "public"
54
+ },
55
+ "gitHead": "d7b2ebdb3c49c15615dd6c1f6bd170c867191bd3"
56
+ }
@@ -0,0 +1,97 @@
1
+ import React, { useCallback, useEffect, useMemo, useState } from "react";
2
+ import type { FunctionComponent, PropsWithChildren } from "react";
3
+ import type { LoginOptions, SessionInfo } from "./SolidAuthContext";
4
+ import { SolidAuthContext } from "./SolidAuthContext";
5
+ import {
6
+ getDefaultSession,
7
+ handleIncomingRedirect,
8
+ login as libraryLogin,
9
+ logout as libraryLogout,
10
+ fetch as libraryFetch,
11
+ } from "@inrupt/solid-client-authn-browser";
12
+ import { SolidLdoProvider } from "./SolidLdoProvider";
13
+
14
+ const PRE_REDIRECT_URI = "PRE_REDIRECT_URI";
15
+
16
+ export const BrowserSolidLdoProvider: FunctionComponent<PropsWithChildren> = ({
17
+ children,
18
+ }) => {
19
+ const [session, setSession] = useState<SessionInfo>(getDefaultSession().info);
20
+ const [ranInitialAuthCheck, setRanInitialAuthCheck] = useState(false);
21
+
22
+ const runInitialAuthCheck = useCallback(async () => {
23
+ if (!window.localStorage.getItem(PRE_REDIRECT_URI)) {
24
+ window.localStorage.setItem(PRE_REDIRECT_URI, window.location.href);
25
+ }
26
+
27
+ await handleIncomingRedirect({
28
+ restorePreviousSession: true,
29
+ });
30
+ // Set timout to ensure this happens after the redirect
31
+ setTimeout(() => {
32
+ setSession({ ...getDefaultSession().info });
33
+ window.history.replaceState(
34
+ {},
35
+ "",
36
+ window.localStorage.getItem(PRE_REDIRECT_URI),
37
+ );
38
+ window.localStorage.removeItem(PRE_REDIRECT_URI);
39
+
40
+ setRanInitialAuthCheck(true);
41
+ }, 0);
42
+ }, []);
43
+
44
+ const login = useCallback(async (issuer: string, options?: LoginOptions) => {
45
+ const cleanUrl = new URL(window.location.href);
46
+ cleanUrl.hash = "";
47
+ cleanUrl.search = "";
48
+ const fullOptions = {
49
+ redirectUrl: cleanUrl.toString(),
50
+ clientName: "Solid App",
51
+ oidcIssuer: issuer,
52
+ ...options,
53
+ };
54
+ window.localStorage.setItem(PRE_REDIRECT_URI, window.location.href);
55
+ await libraryLogin(fullOptions);
56
+ setSession({ ...getDefaultSession().info });
57
+ }, []);
58
+
59
+ const logout = useCallback(async () => {
60
+ await libraryLogout();
61
+ setSession({ ...getDefaultSession().info });
62
+ }, []);
63
+
64
+ const signUp = useCallback(
65
+ async (issuer: string, options?: LoginOptions) => {
66
+ // The typings on @inrupt/solid-client-authn-core have not yet been updated
67
+ // TODO: remove this ts-ignore when they are updated.
68
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
69
+ // @ts-ignore
70
+ return login(issuer, { ...options, prompt: "create" });
71
+ },
72
+ [login],
73
+ );
74
+
75
+ useEffect(() => {
76
+ runInitialAuthCheck();
77
+ }, []);
78
+
79
+ const solidAuthFunctions = useMemo(
80
+ () => ({
81
+ runInitialAuthCheck,
82
+ login,
83
+ logout,
84
+ signUp,
85
+ session,
86
+ ranInitialAuthCheck,
87
+ fetch: libraryFetch,
88
+ }),
89
+ [login, logout, ranInitialAuthCheck, runInitialAuthCheck, session, signUp],
90
+ );
91
+
92
+ return (
93
+ <SolidAuthContext.Provider value={solidAuthFunctions}>
94
+ <SolidLdoProvider>{children}</SolidLdoProvider>
95
+ </SolidAuthContext.Provider>
96
+ );
97
+ };
@@ -0,0 +1,26 @@
1
+ import type {
2
+ ISessionInfo,
3
+ ILoginInputOptions,
4
+ } from "@inrupt/solid-client-authn-core";
5
+ import { createContext, useContext } from "react";
6
+
7
+ export type SessionInfo = ISessionInfo;
8
+ export type LoginOptions = ILoginInputOptions;
9
+
10
+ export interface SolidAuthFunctions {
11
+ login: (issuer: string, loginOptions?: LoginOptions) => Promise<void>;
12
+ logout: () => Promise<void>;
13
+ signUp: (issuer: string, loginOptions?: LoginOptions) => Promise<void>;
14
+ fetch: typeof fetch;
15
+ session: SessionInfo;
16
+ ranInitialAuthCheck: boolean;
17
+ }
18
+
19
+ // There is no initial value for this context. It will be given in the provider
20
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
21
+ // @ts-ignore
22
+ export const SolidAuthContext = createContext<SolidAuthFunctions>(undefined);
23
+
24
+ export function useSolidAuth(): SolidAuthFunctions {
25
+ return useContext(SolidAuthContext);
26
+ }
@@ -0,0 +1,55 @@
1
+ import React, { createContext, useContext } from "react";
2
+ import {
3
+ useMemo,
4
+ type FunctionComponent,
5
+ type PropsWithChildren,
6
+ useEffect,
7
+ } from "react";
8
+ import { useSolidAuth } from "./SolidAuthContext";
9
+ import type { SolidLdoDataset } from "@ldo/solid";
10
+ import { createSolidLdoDataset } from "@ldo/solid";
11
+ import type { UseLdoMethods } from "./useLdoMethods";
12
+ import { createUseLdoMethods } from "./useLdoMethods";
13
+
14
+ export const SolidLdoReactContext =
15
+ // This will be set in the provider
16
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
17
+ // @ts-ignore
18
+ createContext<UseLdoMethods>(undefined);
19
+
20
+ export function useLdo(): UseLdoMethods {
21
+ return useContext(SolidLdoReactContext);
22
+ }
23
+
24
+ export interface SolidLdoProviderProps extends PropsWithChildren {}
25
+
26
+ export const SolidLdoProvider: FunctionComponent<SolidLdoProviderProps> = ({
27
+ children,
28
+ }) => {
29
+ const { fetch } = useSolidAuth();
30
+
31
+ // Initialize storeDependencies before render
32
+ const solidLdoDataset: SolidLdoDataset = useMemo(() => {
33
+ const ldoDataset = createSolidLdoDataset({
34
+ fetch,
35
+ });
36
+ ldoDataset.setMaxListeners(1000);
37
+ return ldoDataset;
38
+ }, []);
39
+
40
+ // Keep context in sync with props
41
+ useEffect(() => {
42
+ solidLdoDataset.context.fetch = fetch;
43
+ }, [fetch]);
44
+
45
+ const value: UseLdoMethods = useMemo(
46
+ () => createUseLdoMethods(solidLdoDataset),
47
+ [solidLdoDataset],
48
+ );
49
+
50
+ return (
51
+ <SolidLdoReactContext.Provider value={value}>
52
+ {children}
53
+ </SolidLdoReactContext.Provider>
54
+ );
55
+ };
@@ -0,0 +1,62 @@
1
+ /* istanbul ignore file */
2
+ import React, { useCallback, useMemo } from "react";
3
+ import type { FunctionComponent, PropsWithChildren } from "react";
4
+ import type { LoginOptions, SessionInfo } from "./SolidAuthContext";
5
+ import { SolidAuthContext } from "./SolidAuthContext";
6
+ import libraryFetch from "cross-fetch";
7
+ import { SolidLdoProvider } from "./SolidLdoProvider";
8
+
9
+ const DUMMY_SESSION: SessionInfo = {
10
+ isLoggedIn: false,
11
+ webId: undefined,
12
+ clientAppId: undefined,
13
+ sessionId: "no_session",
14
+ expirationDate: undefined,
15
+ };
16
+
17
+ export const UnauthenticatedSolidLdoProvider: FunctionComponent<
18
+ PropsWithChildren
19
+ > = ({ children }) => {
20
+ const login = useCallback(
21
+ async (_issuer: string, _options?: LoginOptions) => {
22
+ throw new Error(
23
+ "login is not available for a UnauthenticatedSolidLdoProvider",
24
+ );
25
+ },
26
+ [],
27
+ );
28
+
29
+ const logout = useCallback(async () => {
30
+ throw new Error(
31
+ "logout is not available for a UnauthenticatedSolidLdoProvider",
32
+ );
33
+ }, []);
34
+
35
+ const signUp = useCallback(
36
+ async (_issuer: string, _options?: LoginOptions) => {
37
+ throw new Error(
38
+ "signUp is not available for a UnauthenticatedSolidLdoProvider",
39
+ );
40
+ },
41
+ [],
42
+ );
43
+
44
+ const solidAuthFunctions = useMemo(
45
+ () => ({
46
+ runInitialAuthCheck: () => {},
47
+ login,
48
+ logout,
49
+ signUp,
50
+ session: DUMMY_SESSION,
51
+ ranInitialAuthCheck: true,
52
+ fetch: libraryFetch,
53
+ }),
54
+ [login, logout, signUp],
55
+ );
56
+
57
+ return (
58
+ <SolidAuthContext.Provider value={solidAuthFunctions}>
59
+ <SolidLdoProvider>{children}</SolidLdoProvider>
60
+ </SolidAuthContext.Provider>
61
+ );
62
+ };
package/src/index.ts ADDED
@@ -0,0 +1,12 @@
1
+ export * from "./BrowserSolidLdoProvider";
2
+ export * from "./UnauthenticatedSolidLdoProvider";
3
+ export * from "./SolidAuthContext";
4
+
5
+ export { useLdo } from "./SolidLdoProvider";
6
+
7
+ // hooks
8
+ export * from "./useResource";
9
+ export * from "./useSubject";
10
+ export * from "./useMatchSubject";
11
+ export * from "./useMatchObject";
12
+ export * from "./useRootContainer";
@@ -0,0 +1,84 @@
1
+ import type { LdoBase, ShapeType } from "@ldo/ldo";
2
+ import type { SubjectNode } from "@ldo/rdf-utils";
3
+ import type {
4
+ Resource,
5
+ SolidLdoDataset,
6
+ SolidLdoTransactionDataset,
7
+ } from "@ldo/solid";
8
+ import { changeData, commitData } from "@ldo/solid";
9
+
10
+ export interface UseLdoMethods {
11
+ dataset: SolidLdoDataset;
12
+ getResource: SolidLdoDataset["getResource"];
13
+ getSubject<Type extends LdoBase>(
14
+ shapeType: ShapeType<Type>,
15
+ subject: string | SubjectNode,
16
+ ): Type;
17
+ createData<Type extends LdoBase>(
18
+ shapeType: ShapeType<Type>,
19
+ subject: string | SubjectNode,
20
+ resource: Resource,
21
+ ...additionalResources: Resource[]
22
+ ): Type;
23
+ changeData<Type extends LdoBase>(
24
+ input: Type,
25
+ resource: Resource,
26
+ ...additionalResources: Resource[]
27
+ ): Type;
28
+ commitData(
29
+ input: LdoBase,
30
+ ): ReturnType<SolidLdoTransactionDataset["commitToPod"]>;
31
+ }
32
+
33
+ export function createUseLdoMethods(dataset: SolidLdoDataset): UseLdoMethods {
34
+ return {
35
+ dataset: dataset,
36
+ /**
37
+ * Gets a resource
38
+ */
39
+ getResource: dataset.getResource.bind(dataset),
40
+ /**
41
+ * Returns a Linked Data Object for a subject
42
+ * @param shapeType The shape type for the data
43
+ * @param subject Subject Node
44
+ * @returns A Linked Data Object
45
+ */
46
+ getSubject<Type extends LdoBase>(
47
+ shapeType: ShapeType<Type>,
48
+ subject: string | SubjectNode,
49
+ ): Type {
50
+ return dataset.usingType(shapeType).fromSubject(subject);
51
+ },
52
+ /**
53
+ * Begins tracking changes to eventually commit for a new subject
54
+ * @param shapeType The shape type that defines the created data
55
+ * @param subject The RDF subject for a Linked Data Object
56
+ * @param resources Any number of resources to which this data should be written
57
+ * @returns A Linked Data Object to modify and commit
58
+ */
59
+ createData<Type extends LdoBase>(
60
+ shapeType: ShapeType<Type>,
61
+ subject: string | SubjectNode,
62
+ resource: Resource,
63
+ ...additionalResources: Resource[]
64
+ ): Type {
65
+ return dataset.createData(
66
+ shapeType,
67
+ subject,
68
+ resource,
69
+ ...additionalResources,
70
+ );
71
+ },
72
+ /**
73
+ * Begins tracking changes to eventually commit
74
+ * @param input A linked data object to track changes on
75
+ * @param resources
76
+ */
77
+ changeData: changeData,
78
+ /**
79
+ * Commits the transaction to the global dataset, syncing all subscribing
80
+ * components and Solid Pods
81
+ */
82
+ commitData: commitData,
83
+ };
84
+ }
@@ -0,0 +1,21 @@
1
+ import type { LdoBase, LdSet, ShapeType } from "@ldo/ldo";
2
+ import type { QuadMatch } from "@ldo/rdf-utils";
3
+ import type { LdoBuilder } from "@ldo/ldo";
4
+ import { useCallback } from "react";
5
+ import { useTrackingProxy } from "./util/useTrackingProxy";
6
+
7
+ export function useMatchObject<Type extends LdoBase>(
8
+ shapeType: ShapeType<Type>,
9
+ subject?: QuadMatch[0] | string,
10
+ predicate?: QuadMatch[1] | string,
11
+ graph?: QuadMatch[3] | string,
12
+ ): LdSet<Type> {
13
+ const matchObject = useCallback(
14
+ (builder: LdoBuilder<Type>) => {
15
+ return builder.matchObject(subject, predicate, graph);
16
+ },
17
+ [subject, predicate, graph],
18
+ );
19
+
20
+ return useTrackingProxy(shapeType, matchObject);
21
+ }