@ldo/solid-react 1.0.0-alpha.1 → 1.0.0-alpha.11

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 (220) hide show
  1. package/README.md +3 -6
  2. package/dist/{SolidAuthContext.js → cjs/SolidAuthContext.js} +5 -2
  3. package/dist/cjs/SolidAuthContext.js.map +1 -0
  4. package/dist/{solid-react/src → cjs}/UnauthenticatedSolidLdoProvider.js +6 -3
  5. package/dist/cjs/UnauthenticatedSolidLdoProvider.js.map +1 -0
  6. package/dist/cjs/createBrowserSolidReactMethods.js +88 -0
  7. package/dist/cjs/createBrowserSolidReactMethods.js.map +1 -0
  8. package/dist/cjs/defaultIntance.js +13 -0
  9. package/dist/cjs/defaultIntance.js.map +1 -0
  10. package/dist/{solid-react/src → cjs}/index.js +2 -11
  11. package/dist/cjs/index.js.map +1 -0
  12. package/dist/cjs/useRootContainerFor.js +32 -0
  13. package/dist/cjs/useRootContainerFor.js.map +1 -0
  14. package/dist/esm/SolidAuthContext.js +9 -0
  15. package/dist/esm/SolidAuthContext.js.map +1 -0
  16. package/dist/esm/UnauthenticatedSolidLdoProvider.js +37 -0
  17. package/dist/esm/UnauthenticatedSolidLdoProvider.js.map +1 -0
  18. package/dist/esm/createBrowserSolidReactMethods.js +85 -0
  19. package/dist/esm/createBrowserSolidReactMethods.js.map +1 -0
  20. package/dist/esm/defaultIntance.js +9 -0
  21. package/dist/esm/defaultIntance.js.map +1 -0
  22. package/dist/esm/index.js +3 -0
  23. package/dist/esm/index.js.map +1 -0
  24. package/dist/esm/useRootContainerFor.js +29 -0
  25. package/dist/esm/useRootContainerFor.js.map +1 -0
  26. package/dist/{solid-react/src → types}/SolidAuthContext.d.ts +4 -1
  27. package/dist/types/SolidAuthContext.d.ts.map +1 -0
  28. package/dist/{UnauthenticatedSolidLdoProvider.d.ts → types/UnauthenticatedSolidLdoProvider.d.ts} +4 -0
  29. package/dist/types/UnauthenticatedSolidLdoProvider.d.ts.map +1 -0
  30. package/dist/types/createBrowserSolidReactMethods.d.ts +17 -0
  31. package/dist/types/createBrowserSolidReactMethods.d.ts.map +1 -0
  32. package/dist/types/defaultIntance.d.ts +8 -0
  33. package/dist/types/defaultIntance.d.ts.map +1 -0
  34. package/dist/types/index.d.ts +3 -0
  35. package/dist/types/index.d.ts.map +1 -0
  36. package/dist/types/useRootContainerFor.d.ts +10 -0
  37. package/dist/types/useRootContainerFor.d.ts.map +1 -0
  38. package/package.json +31 -26
  39. package/src/SolidAuthContext.ts +3 -0
  40. package/src/UnauthenticatedSolidLdoProvider.tsx +6 -4
  41. package/src/createBrowserSolidReactMethods.tsx +132 -0
  42. package/src/defaultIntance.ts +20 -0
  43. package/src/index.ts +2 -12
  44. package/src/useRootContainerFor.ts +46 -0
  45. package/dist/BrowserSolidLdoProvider.d.ts +0 -2
  46. package/dist/BrowserSolidLdoProvider.js +0 -63
  47. package/dist/BrowserSolidLdoProvider.js.map +0 -1
  48. package/dist/SolidAuthContext.d.ts +0 -14
  49. package/dist/SolidAuthContext.js.map +0 -1
  50. package/dist/SolidLdoProvider.d.ts +0 -8
  51. package/dist/SolidLdoProvider.js +0 -31
  52. package/dist/SolidLdoProvider.js.map +0 -1
  53. package/dist/UnauthenticatedSolidLdoProvider.js +0 -41
  54. package/dist/UnauthenticatedSolidLdoProvider.js.map +0 -1
  55. package/dist/index.d.ts +0 -9
  56. package/dist/index.js +0 -28
  57. package/dist/index.js.map +0 -1
  58. package/dist/jsonld-dataset-proxy/src/ContextUtil.d.ts +0 -17
  59. package/dist/jsonld-dataset-proxy/src/ContextUtil.js +0 -108
  60. package/dist/jsonld-dataset-proxy/src/ContextUtil.js.map +0 -1
  61. package/dist/jsonld-dataset-proxy/src/LdoJsonldContext.d.ts +0 -8
  62. package/dist/jsonld-dataset-proxy/src/LdoJsonldContext.js +0 -3
  63. package/dist/jsonld-dataset-proxy/src/LdoJsonldContext.js.map +0 -1
  64. package/dist/jsonld-dataset-proxy/src/ProxyContext.d.ts +0 -31
  65. package/dist/jsonld-dataset-proxy/src/ProxyContext.js +0 -63
  66. package/dist/jsonld-dataset-proxy/src/ProxyContext.js.map +0 -1
  67. package/dist/jsonld-dataset-proxy/src/language/languageTypes.d.ts +0 -2
  68. package/dist/jsonld-dataset-proxy/src/language/languageTypes.js +0 -3
  69. package/dist/jsonld-dataset-proxy/src/language/languageTypes.js.map +0 -1
  70. package/dist/jsonld-dataset-proxy/src/language/languageUtils.d.ts +0 -14
  71. package/dist/jsonld-dataset-proxy/src/language/languageUtils.js +0 -73
  72. package/dist/jsonld-dataset-proxy/src/language/languageUtils.js.map +0 -1
  73. package/dist/jsonld-dataset-proxy/src/setProxy/ObjectSetProxy.d.ts +0 -17
  74. package/dist/jsonld-dataset-proxy/src/setProxy/ObjectSetProxy.js +0 -31
  75. package/dist/jsonld-dataset-proxy/src/setProxy/ObjectSetProxy.js.map +0 -1
  76. package/dist/jsonld-dataset-proxy/src/setProxy/SetProxy.d.ts +0 -29
  77. package/dist/jsonld-dataset-proxy/src/setProxy/SetProxy.js +0 -72
  78. package/dist/jsonld-dataset-proxy/src/setProxy/SetProxy.js.map +0 -1
  79. package/dist/jsonld-dataset-proxy/src/setProxy/SubjectSetProxy.d.ts +0 -15
  80. package/dist/jsonld-dataset-proxy/src/setProxy/SubjectSetProxy.js +0 -38
  81. package/dist/jsonld-dataset-proxy/src/setProxy/SubjectSetProxy.js.map +0 -1
  82. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardObjectSetProxy.d.ts +0 -20
  83. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardObjectSetProxy.js +0 -49
  84. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardObjectSetProxy.js.map +0 -1
  85. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardSubjectSetProxy.d.ts +0 -19
  86. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardSubjectSetProxy.js +0 -31
  87. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardSubjectSetProxy.js.map +0 -1
  88. package/dist/jsonld-dataset-proxy/src/setProxy/createNewSetProxy.d.ts +0 -5
  89. package/dist/jsonld-dataset-proxy/src/setProxy/createNewSetProxy.js +0 -27
  90. package/dist/jsonld-dataset-proxy/src/setProxy/createNewSetProxy.js.map +0 -1
  91. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/BasicLdSet.d.ts +0 -36
  92. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/BasicLdSet.js +0 -193
  93. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/BasicLdSet.js.map +0 -1
  94. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/LdSet.d.ts +0 -30
  95. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/LdSet.js +0 -3
  96. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/LdSet.js.map +0 -1
  97. package/dist/jsonld-dataset-proxy/src/subjectProxy/SubjectProxy.d.ts +0 -14
  98. package/dist/jsonld-dataset-proxy/src/subjectProxy/SubjectProxy.js +0 -3
  99. package/dist/jsonld-dataset-proxy/src/subjectProxy/SubjectProxy.js.map +0 -1
  100. package/dist/jsonld-dataset-proxy/src/subjectProxy/createSubjectHandler.d.ts +0 -6
  101. package/dist/jsonld-dataset-proxy/src/subjectProxy/createSubjectHandler.js +0 -75
  102. package/dist/jsonld-dataset-proxy/src/subjectProxy/createSubjectHandler.js.map +0 -1
  103. package/dist/jsonld-dataset-proxy/src/subjectProxy/deleteFromDataset.d.ts +0 -3
  104. package/dist/jsonld-dataset-proxy/src/subjectProxy/deleteFromDataset.js +0 -25
  105. package/dist/jsonld-dataset-proxy/src/subjectProxy/deleteFromDataset.js.map +0 -1
  106. package/dist/jsonld-dataset-proxy/src/subjectProxy/getValueForKey.d.ts +0 -5
  107. package/dist/jsonld-dataset-proxy/src/subjectProxy/getValueForKey.js +0 -41
  108. package/dist/jsonld-dataset-proxy/src/subjectProxy/getValueForKey.js.map +0 -1
  109. package/dist/jsonld-dataset-proxy/src/subjectProxy/isSubjectProxy.d.ts +0 -4
  110. package/dist/jsonld-dataset-proxy/src/subjectProxy/isSubjectProxy.js +0 -25
  111. package/dist/jsonld-dataset-proxy/src/subjectProxy/isSubjectProxy.js.map +0 -1
  112. package/dist/jsonld-dataset-proxy/src/types.d.ts +0 -9
  113. package/dist/jsonld-dataset-proxy/src/types.js +0 -11
  114. package/dist/jsonld-dataset-proxy/src/types.js.map +0 -1
  115. package/dist/jsonld-dataset-proxy/src/util/NodeSet.d.ts +0 -9
  116. package/dist/jsonld-dataset-proxy/src/util/NodeSet.js +0 -35
  117. package/dist/jsonld-dataset-proxy/src/util/NodeSet.js.map +0 -1
  118. package/dist/jsonld-dataset-proxy/src/util/RawObject.d.ts +0 -9
  119. package/dist/jsonld-dataset-proxy/src/util/RawObject.js +0 -3
  120. package/dist/jsonld-dataset-proxy/src/util/RawObject.js.map +0 -1
  121. package/dist/jsonld-dataset-proxy/src/util/addObjectToDataset.d.ts +0 -8
  122. package/dist/jsonld-dataset-proxy/src/util/addObjectToDataset.js +0 -83
  123. package/dist/jsonld-dataset-proxy/src/util/addObjectToDataset.js.map +0 -1
  124. package/dist/jsonld-dataset-proxy/src/util/getNodeFromRaw.d.ts +0 -6
  125. package/dist/jsonld-dataset-proxy/src/util/getNodeFromRaw.js +0 -47
  126. package/dist/jsonld-dataset-proxy/src/util/getNodeFromRaw.js.map +0 -1
  127. package/dist/jsonld-dataset-proxy/src/util/nodeToJsonldRepresentation.d.ts +0 -7
  128. package/dist/jsonld-dataset-proxy/src/util/nodeToJsonldRepresentation.js +0 -75
  129. package/dist/jsonld-dataset-proxy/src/util/nodeToJsonldRepresentation.js.map +0 -1
  130. package/dist/solid-react/src/BrowserSolidLdoProvider.d.ts +0 -2
  131. package/dist/solid-react/src/BrowserSolidLdoProvider.js +0 -63
  132. package/dist/solid-react/src/BrowserSolidLdoProvider.js.map +0 -1
  133. package/dist/solid-react/src/SolidAuthContext.js +0 -10
  134. package/dist/solid-react/src/SolidAuthContext.js.map +0 -1
  135. package/dist/solid-react/src/SolidLdoProvider.d.ts +0 -8
  136. package/dist/solid-react/src/SolidLdoProvider.js +0 -31
  137. package/dist/solid-react/src/SolidLdoProvider.js.map +0 -1
  138. package/dist/solid-react/src/UnauthenticatedSolidLdoProvider.d.ts +0 -2
  139. package/dist/solid-react/src/UnauthenticatedSolidLdoProvider.js.map +0 -1
  140. package/dist/solid-react/src/index.d.ts +0 -9
  141. package/dist/solid-react/src/index.js.map +0 -1
  142. package/dist/solid-react/src/useLdoMethods.d.ts +0 -12
  143. package/dist/solid-react/src/useLdoMethods.js +0 -20
  144. package/dist/solid-react/src/useLdoMethods.js.map +0 -1
  145. package/dist/solid-react/src/useMatchObject.d.ts +0 -3
  146. package/dist/solid-react/src/useMatchObject.js +0 -13
  147. package/dist/solid-react/src/useMatchObject.js.map +0 -1
  148. package/dist/solid-react/src/useMatchSubject.d.ts +0 -3
  149. package/dist/solid-react/src/useMatchSubject.js +0 -13
  150. package/dist/solid-react/src/useMatchSubject.js.map +0 -1
  151. package/dist/solid-react/src/useResource.d.ts +0 -12
  152. package/dist/solid-react/src/useResource.js +0 -63
  153. package/dist/solid-react/src/useResource.js.map +0 -1
  154. package/dist/solid-react/src/useRootContainer.d.ts +0 -3
  155. package/dist/solid-react/src/useRootContainer.js +0 -26
  156. package/dist/solid-react/src/useRootContainer.js.map +0 -1
  157. package/dist/solid-react/src/useSubject.d.ts +0 -5
  158. package/dist/solid-react/src/useSubject.js +0 -15
  159. package/dist/solid-react/src/useSubject.js.map +0 -1
  160. package/dist/solid-react/src/useSubscribeToResource.d.ts +0 -1
  161. package/dist/solid-react/src/useSubscribeToResource.js +0 -40
  162. package/dist/solid-react/src/useSubscribeToResource.js.map +0 -1
  163. package/dist/solid-react/src/util/TrackingProxyContext.d.ts +0 -16
  164. package/dist/solid-react/src/util/TrackingProxyContext.js +0 -27
  165. package/dist/solid-react/src/util/TrackingProxyContext.js.map +0 -1
  166. package/dist/solid-react/src/util/TrackingSetProxy.d.ts +0 -4
  167. package/dist/solid-react/src/util/TrackingSetProxy.js +0 -44
  168. package/dist/solid-react/src/util/TrackingSetProxy.js.map +0 -1
  169. package/dist/solid-react/src/util/TrackingSubjectProxy.d.ts +0 -4
  170. package/dist/solid-react/src/util/TrackingSubjectProxy.js +0 -31
  171. package/dist/solid-react/src/util/TrackingSubjectProxy.js.map +0 -1
  172. package/dist/solid-react/src/util/useTrackingProxy.d.ts +0 -3
  173. package/dist/solid-react/src/util/useTrackingProxy.js +0 -34
  174. package/dist/solid-react/src/util/useTrackingProxy.js.map +0 -1
  175. package/dist/useLdoMethods.d.ts +0 -12
  176. package/dist/useLdoMethods.js +0 -20
  177. package/dist/useLdoMethods.js.map +0 -1
  178. package/dist/useMatchObject.d.ts +0 -3
  179. package/dist/useMatchObject.js +0 -13
  180. package/dist/useMatchObject.js.map +0 -1
  181. package/dist/useMatchSubject.d.ts +0 -3
  182. package/dist/useMatchSubject.js +0 -13
  183. package/dist/useMatchSubject.js.map +0 -1
  184. package/dist/useResource.d.ts +0 -12
  185. package/dist/useResource.js +0 -63
  186. package/dist/useResource.js.map +0 -1
  187. package/dist/useRootContainer.d.ts +0 -3
  188. package/dist/useRootContainer.js +0 -26
  189. package/dist/useRootContainer.js.map +0 -1
  190. package/dist/useSubject.d.ts +0 -5
  191. package/dist/useSubject.js +0 -15
  192. package/dist/useSubject.js.map +0 -1
  193. package/dist/useSubscribeToResource.d.ts +0 -1
  194. package/dist/useSubscribeToResource.js +0 -40
  195. package/dist/useSubscribeToResource.js.map +0 -1
  196. package/dist/util/TrackingProxyContext.d.ts +0 -16
  197. package/dist/util/TrackingProxyContext.js +0 -27
  198. package/dist/util/TrackingProxyContext.js.map +0 -1
  199. package/dist/util/TrackingSetProxy.d.ts +0 -4
  200. package/dist/util/TrackingSetProxy.js +0 -44
  201. package/dist/util/TrackingSetProxy.js.map +0 -1
  202. package/dist/util/TrackingSubjectProxy.d.ts +0 -4
  203. package/dist/util/TrackingSubjectProxy.js +0 -31
  204. package/dist/util/TrackingSubjectProxy.js.map +0 -1
  205. package/dist/util/useTrackingProxy.d.ts +0 -3
  206. package/dist/util/useTrackingProxy.js +0 -34
  207. package/dist/util/useTrackingProxy.js.map +0 -1
  208. package/src/BrowserSolidLdoProvider.tsx +0 -97
  209. package/src/SolidLdoProvider.tsx +0 -55
  210. package/src/useLdoMethods.ts +0 -84
  211. package/src/useMatchObject.ts +0 -21
  212. package/src/useMatchSubject.ts +0 -21
  213. package/src/useResource.ts +0 -114
  214. package/src/useRootContainer.ts +0 -31
  215. package/src/useSubject.ts +0 -30
  216. package/src/useSubscribeToResource.ts +0 -52
  217. package/src/util/TrackingProxyContext.ts +0 -61
  218. package/src/util/TrackingSetProxy.ts +0 -56
  219. package/src/util/TrackingSubjectProxy.ts +0 -43
  220. package/src/util/useTrackingProxy.ts +0 -55
package/src/useSubject.ts DELETED
@@ -1,30 +0,0 @@
1
- import type { SubjectNode } from "@ldo/rdf-utils";
2
- import type { ShapeType } from "@ldo/ldo";
3
- import type { LdoBuilder } from "@ldo/ldo";
4
- import type { LdoBase } from "@ldo/ldo";
5
- import { useCallback } from "react";
6
-
7
- import { useTrackingProxy } from "./util/useTrackingProxy";
8
-
9
- export function useSubject<Type extends LdoBase>(
10
- shapeType: ShapeType<Type>,
11
- subject: string | SubjectNode,
12
- ): Type;
13
- export function useSubject<Type extends LdoBase>(
14
- shapeType: ShapeType<Type>,
15
- subject?: string | SubjectNode,
16
- ): Type | undefined;
17
- export function useSubject<Type extends LdoBase>(
18
- shapeType: ShapeType<Type>,
19
- subject?: string | SubjectNode,
20
- ): Type | undefined {
21
- const fromSubject = useCallback(
22
- (builder: LdoBuilder<Type>) => {
23
- if (!subject) return;
24
- return builder.fromSubject(subject);
25
- },
26
- [subject],
27
- );
28
-
29
- return useTrackingProxy(shapeType, fromSubject);
30
- }
@@ -1,52 +0,0 @@
1
- import { useLdo } from "./SolidLdoProvider";
2
- import { useEffect, useRef } from "react";
3
-
4
- export function useSubscribeToResource(...uris: string[]): void {
5
- const { dataset } = useLdo();
6
- const currentlySubscribed = useRef<Record<string, string>>({});
7
- useEffect(() => {
8
- const resources = uris.map((uri) => dataset.getResource(uri));
9
- const previousSubscriptions = { ...currentlySubscribed.current };
10
- Promise.all<void>(
11
- resources.map(async (resource) => {
12
- if (!previousSubscriptions[resource.uri]) {
13
- // Prevent multiple triggers from created subscriptions while waiting
14
- // for connection
15
- currentlySubscribed.current[resource.uri] = "AWAITING";
16
- // Read and subscribe
17
- await resource.readIfUnfetched();
18
- currentlySubscribed.current[resource.uri] =
19
- await resource.subscribeToNotifications();
20
- } else {
21
- delete previousSubscriptions[resource.uri];
22
- }
23
- }),
24
- ).then(async () => {
25
- // Unsubscribe from all remaining previous subscriptions
26
- await Promise.all(
27
- Object.entries(previousSubscriptions).map(
28
- async ([resourceUri, subscriptionId]) => {
29
- // Unsubscribe
30
- delete currentlySubscribed.current[resourceUri];
31
- const resource = dataset.getResource(resourceUri);
32
- await resource.unsubscribeFromNotifications(subscriptionId);
33
- },
34
- ),
35
- );
36
- });
37
- }, [uris]);
38
-
39
- // Cleanup Subscriptions
40
- useEffect(() => {
41
- return () => {
42
- Promise.all(
43
- Object.entries(currentlySubscribed.current).map(
44
- async ([resourceUri, subscriptionId]) => {
45
- const resource = dataset.getResource(resourceUri);
46
- await resource.unsubscribeFromNotifications(subscriptionId);
47
- },
48
- ),
49
- );
50
- };
51
- }, []);
52
- }
@@ -1,61 +0,0 @@
1
- import type {
2
- ProxyContextOptions,
3
- SubjectProxy,
4
- SetProxy,
5
- } from "@ldo/jsonld-dataset-proxy";
6
- import { ProxyContext } from "@ldo/jsonld-dataset-proxy";
7
- import type { QuadMatch } from "@ldo/rdf-utils";
8
- import type { SubscribableDataset } from "@ldo/subscribable-dataset";
9
- import type { BlankNode, NamedNode, Quad } from "@rdfjs/types";
10
- import { createTrackingSubjectProxy } from "./TrackingSubjectProxy";
11
- import { createTrackingSetProxy } from "./TrackingSetProxy";
12
-
13
- /**
14
- * @internal
15
- * Options to be passed to the tracking proxy
16
- */
17
- export interface TrackingProxyContextOptions extends ProxyContextOptions {
18
- dataset: SubscribableDataset<Quad>;
19
- }
20
-
21
- /**
22
- * @internal
23
- * This proxy exists to ensure react components rerender at the right time. It
24
- * keeps track of every key accessed in a Linked Data Object and only when the
25
- * dataset is updated with that key does it rerender the react component.
26
- */
27
- export class TrackingProxyContext extends ProxyContext {
28
- private listener: () => void;
29
- private subscribableDataset: SubscribableDataset<Quad>;
30
-
31
- constructor(options: TrackingProxyContextOptions, listener: () => void) {
32
- super(options);
33
- this.subscribableDataset = options.dataset;
34
- this.listener = listener;
35
- }
36
-
37
- // Adds the listener to the subscribable dataset while ensuring deduping of the listener
38
- public addListener(eventName: QuadMatch) {
39
- const listeners = this.subscribableDataset.listeners(eventName);
40
- if (!listeners.includes(this.listener)) {
41
- this.subscribableDataset.on(eventName, this.listener);
42
- }
43
- }
44
-
45
- protected createNewSubjectProxy(node: NamedNode | BlankNode): SubjectProxy {
46
- return createTrackingSubjectProxy(this, node);
47
- }
48
-
49
- protected createNewSetProxy(
50
- quadMatch: QuadMatch,
51
- isSubjectOriented?: boolean,
52
- isLangStringSet?: boolean,
53
- ): SetProxy {
54
- return createTrackingSetProxy(
55
- this,
56
- quadMatch,
57
- isSubjectOriented,
58
- isLangStringSet,
59
- );
60
- }
61
- }
@@ -1,56 +0,0 @@
1
- import { createNewSetProxy, type SetProxy } from "@ldo/jsonld-dataset-proxy";
2
- import type { TrackingProxyContext } from "./TrackingProxyContext";
3
- import type { QuadMatch } from "@ldo/rdf-utils";
4
-
5
- export function createTrackingSetProxy(
6
- proxyContext: TrackingProxyContext,
7
- quadMatch: QuadMatch,
8
- isSubjectOriented?: boolean,
9
- isLangStringSet?: boolean,
10
- ): SetProxy {
11
- const baseSetProxy = createNewSetProxy(
12
- quadMatch,
13
- isSubjectOriented ?? false,
14
- proxyContext,
15
- isLangStringSet,
16
- );
17
-
18
- return new Proxy(baseSetProxy, {
19
- get: (target: SetProxy, key: string | symbol, receiver) => {
20
- if (trackingMethods.has(key)) {
21
- proxyContext.addListener(quadMatch);
22
- } else if (disallowedMethods.has(key)) {
23
- console.warn(
24
- "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.",
25
- );
26
- }
27
- return Reflect.get(target, key, receiver);
28
- },
29
- });
30
- }
31
-
32
- const trackingMethods = new Set([
33
- "has",
34
- "size",
35
- "entries",
36
- "keys",
37
- "values",
38
- Symbol.iterator,
39
- "every",
40
- "every",
41
- "some",
42
- "forEach",
43
- "map",
44
- "reduce",
45
- "toArray",
46
- "toJSON",
47
- "difference",
48
- "intersection",
49
- "isDisjointFrom",
50
- "isSubsetOf",
51
- "isSupersetOf",
52
- "symmetricDifference",
53
- "union",
54
- ]);
55
-
56
- const disallowedMethods = new Set<string | symbol>(["add", "clear", "delete"]);
@@ -1,43 +0,0 @@
1
- import type { SubjectProxyTarget } from "@ldo/jsonld-dataset-proxy";
2
- import {
3
- createSubjectHandler,
4
- type SubjectProxy,
5
- } from "@ldo/jsonld-dataset-proxy";
6
- import type { BlankNode, NamedNode } from "@rdfjs/types";
7
- import type { TrackingProxyContext } from "./TrackingProxyContext";
8
- import { namedNode } from "@rdfjs/data-model";
9
-
10
- export function createTrackingSubjectProxy(
11
- proxyContext: TrackingProxyContext,
12
- node: NamedNode | BlankNode,
13
- ): SubjectProxy {
14
- const baseHandler = createSubjectHandler(proxyContext);
15
- const oldGetFunction = baseHandler.get;
16
- const newGetFunction: ProxyHandler<SubjectProxyTarget>["get"] = (
17
- target: SubjectProxyTarget,
18
- key: string | symbol,
19
- receiver,
20
- ) => {
21
- const subject = target["@id"];
22
- const rdfTypes = proxyContext.getRdfType(subject);
23
- if (typeof key === "symbol") {
24
- // Do Nothing
25
- } else if (key === "@id") {
26
- proxyContext.addListener([subject, null, null, null]);
27
- } else if (!proxyContext.contextUtil.isSet(key, rdfTypes)) {
28
- const predicate = namedNode(
29
- proxyContext.contextUtil.keyToIri(key, rdfTypes),
30
- );
31
- proxyContext.addListener([subject, predicate, null, null]);
32
- }
33
- return oldGetFunction && oldGetFunction(target, key, receiver);
34
- };
35
- baseHandler.get = newGetFunction;
36
- baseHandler.set = () => {
37
- console.warn(
38
- "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.",
39
- );
40
- return true;
41
- };
42
- return new Proxy({ "@id": node }, baseHandler) as unknown as SubjectProxy;
43
- }
@@ -1,55 +0,0 @@
1
- import {
2
- ContextUtil,
3
- JsonldDatasetProxyBuilder,
4
- } from "@ldo/jsonld-dataset-proxy";
5
- import { LdoBuilder } from "@ldo/ldo";
6
- import type { LdoBase, ShapeType } from "@ldo/ldo";
7
- import { useCallback, useEffect, useMemo, useState } from "react";
8
- import { TrackingProxyContext } from "./TrackingProxyContext";
9
- import { defaultGraph } from "@rdfjs/data-model";
10
- import { useLdo } from "../SolidLdoProvider";
11
-
12
- export function useTrackingProxy<Type extends LdoBase, ReturnType>(
13
- shapeType: ShapeType<Type>,
14
- createLdo: (builder: LdoBuilder<Type>) => ReturnType,
15
- ): ReturnType {
16
- const { dataset } = useLdo();
17
-
18
- const [forceUpdateCounter, setForceUpdateCounter] = useState(0);
19
- const forceUpdate = useCallback(
20
- () => setForceUpdateCounter((val) => val + 1),
21
- [],
22
- );
23
-
24
- // The main linked data object
25
- const linkedDataObject = useMemo(() => {
26
- // Remove all current subscriptions
27
- dataset.removeListenerFromAllEvents(forceUpdate);
28
-
29
- // Rebuild the LdoBuilder from scratch to inject TrackingProxyContext
30
- const contextUtil = new ContextUtil(shapeType.context);
31
- const proxyContext = new TrackingProxyContext(
32
- {
33
- dataset,
34
- contextUtil,
35
- writeGraphs: [defaultGraph()],
36
- languageOrdering: ["none", "en", "other"],
37
- },
38
- forceUpdate,
39
- );
40
- const builder = new LdoBuilder(
41
- new JsonldDatasetProxyBuilder(proxyContext),
42
- shapeType,
43
- );
44
- return createLdo(builder);
45
- }, [shapeType, dataset, forceUpdateCounter, forceUpdate, createLdo]);
46
-
47
- useEffect(() => {
48
- // Unregister force update listener upon unmount
49
- return () => {
50
- dataset.removeListenerFromAllEvents(forceUpdate);
51
- };
52
- }, [shapeType]);
53
-
54
- return linkedDataObject;
55
- }