@ldo/solid-react 0.0.1-alpha.32 → 1.0.0-alpha.2

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 (165) hide show
  1. package/README.md +127 -3
  2. package/dist/SolidAuthContext.js.map +1 -1
  3. package/dist/UnauthenticatedSolidLdoProvider.js +1 -2
  4. package/dist/UnauthenticatedSolidLdoProvider.js.map +1 -1
  5. package/dist/createBrowserSolidReactMethods.d.ts +11 -0
  6. package/dist/createBrowserSolidReactMethods.js +79 -0
  7. package/dist/createBrowserSolidReactMethods.js.map +1 -0
  8. package/dist/defaultIntance.d.ts +5 -0
  9. package/dist/defaultIntance.js +10 -0
  10. package/dist/defaultIntance.js.map +1 -0
  11. package/dist/index.d.ts +2 -9
  12. package/dist/index.js +2 -11
  13. package/dist/index.js.map +1 -1
  14. package/dist/jsonld-dataset-proxy/src/ContextUtil.d.ts +17 -0
  15. package/dist/jsonld-dataset-proxy/src/ContextUtil.js +108 -0
  16. package/dist/jsonld-dataset-proxy/src/ContextUtil.js.map +1 -0
  17. package/dist/jsonld-dataset-proxy/src/LdoJsonldContext.d.ts +8 -0
  18. package/dist/jsonld-dataset-proxy/src/LdoJsonldContext.js +3 -0
  19. package/dist/jsonld-dataset-proxy/src/LdoJsonldContext.js.map +1 -0
  20. package/dist/jsonld-dataset-proxy/src/ProxyContext.d.ts +31 -0
  21. package/dist/jsonld-dataset-proxy/src/ProxyContext.js +63 -0
  22. package/dist/jsonld-dataset-proxy/src/ProxyContext.js.map +1 -0
  23. package/dist/jsonld-dataset-proxy/src/language/languageTypes.d.ts +2 -0
  24. package/dist/jsonld-dataset-proxy/src/language/languageTypes.js +3 -0
  25. package/dist/jsonld-dataset-proxy/src/language/languageTypes.js.map +1 -0
  26. package/dist/jsonld-dataset-proxy/src/language/languageUtils.d.ts +14 -0
  27. package/dist/jsonld-dataset-proxy/src/language/languageUtils.js +73 -0
  28. package/dist/jsonld-dataset-proxy/src/language/languageUtils.js.map +1 -0
  29. package/dist/jsonld-dataset-proxy/src/setProxy/ObjectSetProxy.d.ts +17 -0
  30. package/dist/jsonld-dataset-proxy/src/setProxy/ObjectSetProxy.js +31 -0
  31. package/dist/jsonld-dataset-proxy/src/setProxy/ObjectSetProxy.js.map +1 -0
  32. package/dist/jsonld-dataset-proxy/src/setProxy/SetProxy.d.ts +29 -0
  33. package/dist/jsonld-dataset-proxy/src/setProxy/SetProxy.js +72 -0
  34. package/dist/jsonld-dataset-proxy/src/setProxy/SetProxy.js.map +1 -0
  35. package/dist/jsonld-dataset-proxy/src/setProxy/SubjectSetProxy.d.ts +15 -0
  36. package/dist/jsonld-dataset-proxy/src/setProxy/SubjectSetProxy.js +38 -0
  37. package/dist/jsonld-dataset-proxy/src/setProxy/SubjectSetProxy.js.map +1 -0
  38. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardObjectSetProxy.d.ts +20 -0
  39. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardObjectSetProxy.js +49 -0
  40. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardObjectSetProxy.js.map +1 -0
  41. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardSubjectSetProxy.d.ts +19 -0
  42. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardSubjectSetProxy.js +31 -0
  43. package/dist/jsonld-dataset-proxy/src/setProxy/WildcardSubjectSetProxy.js.map +1 -0
  44. package/dist/jsonld-dataset-proxy/src/setProxy/createNewSetProxy.d.ts +5 -0
  45. package/dist/jsonld-dataset-proxy/src/setProxy/createNewSetProxy.js +27 -0
  46. package/dist/jsonld-dataset-proxy/src/setProxy/createNewSetProxy.js.map +1 -0
  47. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/BasicLdSet.d.ts +36 -0
  48. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/BasicLdSet.js +193 -0
  49. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/BasicLdSet.js.map +1 -0
  50. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/LdSet.d.ts +30 -0
  51. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/LdSet.js +3 -0
  52. package/dist/jsonld-dataset-proxy/src/setProxy/ldSet/LdSet.js.map +1 -0
  53. package/dist/jsonld-dataset-proxy/src/subjectProxy/SubjectProxy.d.ts +14 -0
  54. package/dist/jsonld-dataset-proxy/src/subjectProxy/SubjectProxy.js +3 -0
  55. package/dist/jsonld-dataset-proxy/src/subjectProxy/SubjectProxy.js.map +1 -0
  56. package/dist/jsonld-dataset-proxy/src/subjectProxy/createSubjectHandler.d.ts +6 -0
  57. package/dist/jsonld-dataset-proxy/src/subjectProxy/createSubjectHandler.js +75 -0
  58. package/dist/jsonld-dataset-proxy/src/subjectProxy/createSubjectHandler.js.map +1 -0
  59. package/dist/jsonld-dataset-proxy/src/subjectProxy/deleteFromDataset.d.ts +3 -0
  60. package/dist/jsonld-dataset-proxy/src/subjectProxy/deleteFromDataset.js +25 -0
  61. package/dist/jsonld-dataset-proxy/src/subjectProxy/deleteFromDataset.js.map +1 -0
  62. package/dist/jsonld-dataset-proxy/src/subjectProxy/getValueForKey.d.ts +5 -0
  63. package/dist/jsonld-dataset-proxy/src/subjectProxy/getValueForKey.js +41 -0
  64. package/dist/jsonld-dataset-proxy/src/subjectProxy/getValueForKey.js.map +1 -0
  65. package/dist/jsonld-dataset-proxy/src/subjectProxy/isSubjectProxy.d.ts +4 -0
  66. package/dist/jsonld-dataset-proxy/src/subjectProxy/isSubjectProxy.js +25 -0
  67. package/dist/jsonld-dataset-proxy/src/subjectProxy/isSubjectProxy.js.map +1 -0
  68. package/dist/jsonld-dataset-proxy/src/types.d.ts +9 -0
  69. package/dist/jsonld-dataset-proxy/src/types.js +11 -0
  70. package/dist/jsonld-dataset-proxy/src/types.js.map +1 -0
  71. package/dist/jsonld-dataset-proxy/src/util/NodeSet.d.ts +9 -0
  72. package/dist/jsonld-dataset-proxy/src/util/NodeSet.js +35 -0
  73. package/dist/jsonld-dataset-proxy/src/util/NodeSet.js.map +1 -0
  74. package/dist/jsonld-dataset-proxy/src/util/RawObject.d.ts +9 -0
  75. package/dist/jsonld-dataset-proxy/src/util/RawObject.js +3 -0
  76. package/dist/jsonld-dataset-proxy/src/util/RawObject.js.map +1 -0
  77. package/dist/jsonld-dataset-proxy/src/util/addObjectToDataset.d.ts +8 -0
  78. package/dist/jsonld-dataset-proxy/src/util/addObjectToDataset.js +83 -0
  79. package/dist/jsonld-dataset-proxy/src/util/addObjectToDataset.js.map +1 -0
  80. package/dist/jsonld-dataset-proxy/src/util/getNodeFromRaw.d.ts +6 -0
  81. package/dist/jsonld-dataset-proxy/src/util/getNodeFromRaw.js +47 -0
  82. package/dist/jsonld-dataset-proxy/src/util/getNodeFromRaw.js.map +1 -0
  83. package/dist/jsonld-dataset-proxy/src/util/nodeToJsonldRepresentation.d.ts +7 -0
  84. package/dist/jsonld-dataset-proxy/src/util/nodeToJsonldRepresentation.js +75 -0
  85. package/dist/jsonld-dataset-proxy/src/util/nodeToJsonldRepresentation.js.map +1 -0
  86. package/dist/solid-react/src/BrowserSolidLdoProvider.d.ts +2 -0
  87. package/dist/solid-react/src/BrowserSolidLdoProvider.js +63 -0
  88. package/dist/solid-react/src/BrowserSolidLdoProvider.js.map +1 -0
  89. package/dist/solid-react/src/SolidAuthContext.d.ts +14 -0
  90. package/dist/solid-react/src/SolidAuthContext.js +10 -0
  91. package/dist/solid-react/src/SolidAuthContext.js.map +1 -0
  92. package/dist/solid-react/src/SolidLdoProvider.d.ts +8 -0
  93. package/dist/solid-react/src/SolidLdoProvider.js +31 -0
  94. package/dist/solid-react/src/SolidLdoProvider.js.map +1 -0
  95. package/dist/solid-react/src/UnauthenticatedSolidLdoProvider.d.ts +2 -0
  96. package/dist/solid-react/src/UnauthenticatedSolidLdoProvider.js +41 -0
  97. package/dist/solid-react/src/UnauthenticatedSolidLdoProvider.js.map +1 -0
  98. package/dist/solid-react/src/index.d.ts +9 -0
  99. package/dist/solid-react/src/index.js +28 -0
  100. package/dist/solid-react/src/index.js.map +1 -0
  101. package/dist/solid-react/src/useLdoMethods.d.ts +12 -0
  102. package/dist/solid-react/src/useLdoMethods.js +20 -0
  103. package/dist/solid-react/src/useLdoMethods.js.map +1 -0
  104. package/dist/solid-react/src/useMatchObject.d.ts +3 -0
  105. package/dist/solid-react/src/useMatchObject.js +13 -0
  106. package/dist/solid-react/src/useMatchObject.js.map +1 -0
  107. package/dist/solid-react/src/useMatchSubject.d.ts +3 -0
  108. package/dist/solid-react/src/useMatchSubject.js +13 -0
  109. package/dist/solid-react/src/useMatchSubject.js.map +1 -0
  110. package/dist/solid-react/src/useResource.d.ts +12 -0
  111. package/dist/solid-react/src/useResource.js +63 -0
  112. package/dist/solid-react/src/useResource.js.map +1 -0
  113. package/dist/solid-react/src/useRootContainer.d.ts +3 -0
  114. package/dist/solid-react/src/useRootContainer.js +26 -0
  115. package/dist/solid-react/src/useRootContainer.js.map +1 -0
  116. package/dist/solid-react/src/useSubject.d.ts +5 -0
  117. package/dist/solid-react/src/useSubject.js +15 -0
  118. package/dist/solid-react/src/useSubject.js.map +1 -0
  119. package/dist/solid-react/src/useSubscribeToResource.d.ts +1 -0
  120. package/dist/solid-react/src/useSubscribeToResource.js +40 -0
  121. package/dist/solid-react/src/useSubscribeToResource.js.map +1 -0
  122. package/dist/solid-react/src/util/TrackingProxyContext.d.ts +16 -0
  123. package/dist/solid-react/src/util/TrackingProxyContext.js +27 -0
  124. package/dist/solid-react/src/util/TrackingProxyContext.js.map +1 -0
  125. package/dist/solid-react/src/util/TrackingSetProxy.d.ts +4 -0
  126. package/dist/solid-react/src/util/TrackingSetProxy.js +44 -0
  127. package/dist/solid-react/src/util/TrackingSetProxy.js.map +1 -0
  128. package/dist/solid-react/src/util/TrackingSubjectProxy.d.ts +4 -0
  129. package/dist/solid-react/src/util/TrackingSubjectProxy.js +31 -0
  130. package/dist/solid-react/src/util/TrackingSubjectProxy.js.map +1 -0
  131. package/dist/solid-react/src/util/useTrackingProxy.d.ts +3 -0
  132. package/dist/solid-react/src/util/useTrackingProxy.js +34 -0
  133. package/dist/solid-react/src/util/useTrackingProxy.js.map +1 -0
  134. package/dist/useMatchObject.d.ts +2 -2
  135. package/dist/useMatchSubject.d.ts +2 -2
  136. package/dist/useRootContainerFor.d.ts +4 -0
  137. package/dist/useRootContainerFor.js +25 -0
  138. package/dist/useRootContainerFor.js.map +1 -0
  139. package/dist/util/TrackingProxyContext.d.ts +6 -5
  140. package/dist/util/TrackingProxyContext.js +6 -54
  141. package/dist/util/TrackingProxyContext.js.map +1 -1
  142. package/dist/util/TrackingSetProxy.d.ts +4 -0
  143. package/dist/util/TrackingSetProxy.js +44 -0
  144. package/dist/util/TrackingSetProxy.js.map +1 -0
  145. package/dist/util/TrackingSubjectProxy.d.ts +4 -0
  146. package/dist/util/TrackingSubjectProxy.js +31 -0
  147. package/dist/util/TrackingSubjectProxy.js.map +1 -0
  148. package/package.json +14 -13
  149. package/src/SolidAuthContext.ts +3 -0
  150. package/src/UnauthenticatedSolidLdoProvider.tsx +4 -2
  151. package/src/createBrowserSolidReactMethods.tsx +132 -0
  152. package/src/defaultIntance.ts +19 -0
  153. package/src/index.ts +2 -12
  154. package/src/useRootContainerFor.ts +46 -0
  155. package/src/BrowserSolidLdoProvider.tsx +0 -97
  156. package/src/SolidLdoProvider.tsx +0 -55
  157. package/src/useLdoMethods.ts +0 -84
  158. package/src/useMatchObject.ts +0 -21
  159. package/src/useMatchSubject.ts +0 -21
  160. package/src/useResource.ts +0 -114
  161. package/src/useRootContainer.ts +0 -31
  162. package/src/useSubject.ts +0 -30
  163. package/src/useSubscribeToResource.ts +0 -52
  164. package/src/util/TrackingProxyContext.ts +0 -110
  165. package/src/util/useTrackingProxy.ts +0 -55
@@ -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"}
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@ldo/solid-react",
3
- "version": "0.0.1-alpha.32",
3
+ "version": "1.0.0-alpha.2",
4
4
  "description": "A React library for LDO and Solid",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {
7
7
  "build": "tsc --project tsconfig.build.json",
8
- "watch": "tsc --watch",
8
+ "watch": "tsc --project tsconfig.build.json --watch",
9
9
  "test": "npm run test:integration",
10
10
  "test:watch": "jest --watch",
11
11
  "prepublishOnly": "npm run test && npm run build",
@@ -26,22 +26,23 @@
26
26
  },
27
27
  "homepage": "https://github.com/o-development/ldobjects/tree/main/packages/solid-react#readme",
28
28
  "devDependencies": {
29
- "@ldo/rdf-utils": "^0.0.1-alpha.24",
29
+ "@babel/core": "^7.26.10",
30
+ "@babel/preset-env": "^7.26.9",
31
+ "@inrupt/jest-jsdom-polyfills": "^3.2.6",
32
+ "@ldo/rdf-utils": "^1.0.0-alpha.2",
30
33
  "@rdfjs/types": "^1.0.1",
31
34
  "@testing-library/react": "^14.1.2",
32
- "@types/jest": "^27.0.3",
33
- "jest-environment-jsdom": "^27.0.0",
35
+ "babel-jest": "^29.7.0",
36
+ "jest-environment-jsdom": "^29.7.0",
34
37
  "start-server-and-test": "^2.0.3",
35
- "ts-jest": "^27.1.2",
36
- "ts-node": "^10.9.2"
38
+ "ts-jest": "^29.3.0",
39
+ "ts-node": "^10.9.2",
40
+ "whatwg-fetch": "^3.6.20"
37
41
  },
38
42
  "dependencies": {
39
43
  "@inrupt/solid-client-authn-browser": "^2.0.0",
40
- "@ldo/dataset": "^0.0.1-alpha.24",
41
- "@ldo/jsonld-dataset-proxy": "^0.0.1-alpha.29",
42
- "@ldo/ldo": "^0.0.1-alpha.29",
43
- "@ldo/solid": "^0.0.1-alpha.32",
44
- "@ldo/subscribable-dataset": "^0.0.1-alpha.24",
44
+ "@ldo/connected": "^1.0.0-alpha.2",
45
+ "@ldo/connected-solid": "^1.0.0-alpha.2",
45
46
  "@rdfjs/data-model": "^1.2.0",
46
47
  "cross-fetch": "^3.1.6"
47
48
  },
@@ -52,5 +53,5 @@
52
53
  "publishConfig": {
53
54
  "access": "public"
54
55
  },
55
- "gitHead": "db1622a0660c8a7560726c5f7f9e8ddab6b122c5"
56
+ "gitHead": "ba5cbcfa79af530258cad3b7ae1478a6673befea"
56
57
  }
@@ -7,6 +7,9 @@ import { createContext, useContext } from "react";
7
7
  export type SessionInfo = ISessionInfo;
8
8
  export type LoginOptions = ILoginInputOptions;
9
9
 
10
+ /**
11
+ * Functions for authenticating with Solid
12
+ */
10
13
  export interface SolidAuthFunctions {
11
14
  login: (issuer: string, loginOptions?: LoginOptions) => Promise<void>;
12
15
  logout: () => Promise<void>;
@@ -4,7 +4,6 @@ import type { FunctionComponent, PropsWithChildren } from "react";
4
4
  import type { LoginOptions, SessionInfo } from "./SolidAuthContext";
5
5
  import { SolidAuthContext } from "./SolidAuthContext";
6
6
  import libraryFetch from "cross-fetch";
7
- import { SolidLdoProvider } from "./SolidLdoProvider";
8
7
 
9
8
  const DUMMY_SESSION: SessionInfo = {
10
9
  isLoggedIn: false,
@@ -14,6 +13,9 @@ const DUMMY_SESSION: SessionInfo = {
14
13
  expirationDate: undefined,
15
14
  };
16
15
 
16
+ /**
17
+ * A provider for interacting with Solid Pods without authenticating
18
+ */
17
19
  export const UnauthenticatedSolidLdoProvider: FunctionComponent<
18
20
  PropsWithChildren
19
21
  > = ({ children }) => {
@@ -56,7 +58,7 @@ export const UnauthenticatedSolidLdoProvider: FunctionComponent<
56
58
 
57
59
  return (
58
60
  <SolidAuthContext.Provider value={solidAuthFunctions}>
59
- <SolidLdoProvider>{children}</SolidLdoProvider>
61
+ {children}
60
62
  </SolidAuthContext.Provider>
61
63
  );
62
64
  };
@@ -0,0 +1,132 @@
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, useSolidAuth } 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 type { ConnectedLdoDataset, ConnectedPlugin } from "@ldo/connected";
13
+ import type { SolidConnectedPlugin } from "@ldo/connected-solid";
14
+ import { createUseRootContainerFor } from "./useRootContainerFor";
15
+ import { createUseResource } from "@ldo/react";
16
+
17
+ const PRE_REDIRECT_URI = "PRE_REDIRECT_URI";
18
+
19
+ /**
20
+ * Creates special react methods specific to the Solid
21
+ * @param dataset the connectedLdoDataset with a SolidConnectedPlugin
22
+ * @returns { BrowserSolidLdoProvider, useSolidAuth, useRootContainerFor }
23
+ */
24
+ export function createBrowserSolidReactMethods(
25
+ dataset: ConnectedLdoDataset<(SolidConnectedPlugin | ConnectedPlugin)[]>,
26
+ ) {
27
+ dataset.setContext("solid", { fetch: libraryFetch });
28
+
29
+ const BrowserSolidLdoProvider: FunctionComponent<PropsWithChildren> = ({
30
+ children,
31
+ }) => {
32
+ const [session, setSession] = useState<SessionInfo>(
33
+ getDefaultSession().info,
34
+ );
35
+ const [ranInitialAuthCheck, setRanInitialAuthCheck] = useState(false);
36
+
37
+ const runInitialAuthCheck = useCallback(async () => {
38
+ if (!window.localStorage.getItem(PRE_REDIRECT_URI)) {
39
+ window.localStorage.setItem(PRE_REDIRECT_URI, window.location.href);
40
+ }
41
+
42
+ await handleIncomingRedirect({
43
+ restorePreviousSession: true,
44
+ });
45
+ // Set timout to ensure this happens after the redirect
46
+ setTimeout(() => {
47
+ setSession({ ...getDefaultSession().info });
48
+ window.history.replaceState(
49
+ {},
50
+ "",
51
+ window.localStorage.getItem(PRE_REDIRECT_URI),
52
+ );
53
+ window.localStorage.removeItem(PRE_REDIRECT_URI);
54
+
55
+ setRanInitialAuthCheck(true);
56
+ }, 0);
57
+ }, []);
58
+
59
+ const login = useCallback(
60
+ async (issuer: string, options?: LoginOptions) => {
61
+ const cleanUrl = new URL(window.location.href);
62
+ cleanUrl.hash = "";
63
+ cleanUrl.search = "";
64
+ const fullOptions = {
65
+ redirectUrl: cleanUrl.toString(),
66
+ clientName: "Solid App",
67
+ oidcIssuer: issuer,
68
+ ...options,
69
+ };
70
+ window.localStorage.setItem(PRE_REDIRECT_URI, window.location.href);
71
+ await libraryLogin(fullOptions);
72
+ setSession({ ...getDefaultSession().info });
73
+ },
74
+ [],
75
+ );
76
+
77
+ const logout = useCallback(async () => {
78
+ await libraryLogout();
79
+ setSession({ ...getDefaultSession().info });
80
+ }, []);
81
+
82
+ const signUp = useCallback(
83
+ async (issuer: string, options?: LoginOptions) => {
84
+ // The typings on @inrupt/solid-client-authn-core have not yet been updated
85
+ // TODO: remove this ts-ignore when they are updated.
86
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
87
+ // @ts-ignore
88
+ return login(issuer, { ...options, prompt: "create" });
89
+ },
90
+ [login],
91
+ );
92
+
93
+ useEffect(() => {
94
+ runInitialAuthCheck();
95
+ }, []);
96
+
97
+ const solidAuthFunctions = useMemo(
98
+ () => ({
99
+ runInitialAuthCheck,
100
+ login,
101
+ logout,
102
+ signUp,
103
+ session,
104
+ ranInitialAuthCheck,
105
+ fetch: libraryFetch,
106
+ }),
107
+ [
108
+ login,
109
+ logout,
110
+ ranInitialAuthCheck,
111
+ runInitialAuthCheck,
112
+ session,
113
+ signUp,
114
+ ],
115
+ );
116
+
117
+ return (
118
+ <SolidAuthContext.Provider value={solidAuthFunctions}>
119
+ {children}
120
+ </SolidAuthContext.Provider>
121
+ );
122
+ };
123
+
124
+ return {
125
+ BrowserSolidLdoProvider,
126
+ useSolidAuth: useSolidAuth,
127
+ useRootContainerFor: createUseRootContainerFor(
128
+ dataset as ConnectedLdoDataset<SolidConnectedPlugin[]>,
129
+ createUseResource(dataset as ConnectedLdoDataset<ConnectedPlugin[]>),
130
+ ),
131
+ };
132
+ }
@@ -0,0 +1,19 @@
1
+ import { solidConnectedPlugin } from "@ldo/connected-solid";
2
+ import { createLdoReactMethods } from "@ldo/react";
3
+ import { createBrowserSolidReactMethods } from "./createBrowserSolidReactMethods";
4
+
5
+ /**
6
+ * Default exports for just Solid methods
7
+ */
8
+ export const {
9
+ dataset,
10
+ useLdo,
11
+ useMatchObject,
12
+ useMatchSubject,
13
+ useResource,
14
+ useSubject,
15
+ useSubscribeToResource,
16
+ } = createLdoReactMethods([solidConnectedPlugin]);
17
+
18
+ export const { BrowserSolidLdoProvider, useSolidAuth, useRootContainerFor } =
19
+ createBrowserSolidReactMethods(dataset);
package/src/index.ts CHANGED
@@ -1,12 +1,2 @@
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";
1
+ export * from "./createBrowserSolidReactMethods";
2
+ export * from "./defaultIntance";
@@ -0,0 +1,46 @@
1
+ import { useEffect, useState } from "react";
2
+ import type { ConnectedLdoDataset, ConnectedPlugin } from "@ldo/connected";
3
+ import type {
4
+ SolidConnectedPlugin,
5
+ SolidContainer,
6
+ SolidContainerUri,
7
+ SolidLeafUri,
8
+ } from "@ldo/connected-solid";
9
+ import type { UseResourceOptions, createUseResource } from "@ldo/react";
10
+
11
+ /**
12
+ * @internal
13
+ *
14
+ * Creates a useRootContainerFor function
15
+ */
16
+ export function createUseRootContainerFor(
17
+ dataset: ConnectedLdoDataset<SolidConnectedPlugin[]>,
18
+ useResource: ReturnType<typeof createUseResource<ConnectedPlugin[]>>,
19
+ ) {
20
+ /**
21
+ * Gets the root container for a specific URI
22
+ */
23
+ return function useRootContainerFor(
24
+ uri?: SolidContainerUri | SolidLeafUri,
25
+ options?: UseResourceOptions<"solid">,
26
+ ): SolidContainer | undefined {
27
+ const [rootContainerUri, setRootContainerUri] = useState<
28
+ SolidContainerUri | undefined
29
+ >(undefined);
30
+
31
+ useEffect(() => {
32
+ if (uri) {
33
+ const givenResource = dataset.getResource(uri);
34
+ givenResource.getRootContainer().then((result) => {
35
+ if (!result.isError) {
36
+ setRootContainerUri(result.uri);
37
+ }
38
+ });
39
+ } else {
40
+ setRootContainerUri(undefined);
41
+ }
42
+ }, [uri]);
43
+
44
+ return useResource(rootContainerUri, options) as SolidContainer | undefined;
45
+ };
46
+ }
@@ -1,97 +0,0 @@
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
- };
@@ -1,55 +0,0 @@
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
- };
@@ -1,84 +0,0 @@
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
- }
@@ -1,21 +0,0 @@
1
- import type { LdoBase, 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
- ): 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
- }
@@ -1,21 +0,0 @@
1
- import type { LdoBase, 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 useMatchSubject<Type extends LdoBase>(
8
- shapeType: ShapeType<Type>,
9
- predicate?: QuadMatch[1] | string,
10
- object?: QuadMatch[2] | string,
11
- graph?: QuadMatch[3] | string,
12
- ): Type[] {
13
- const matchSubject = useCallback(
14
- (builder: LdoBuilder<Type>) => {
15
- return builder.matchSubject(predicate, object, graph);
16
- },
17
- [predicate, object, graph],
18
- );
19
-
20
- return useTrackingProxy(shapeType, matchSubject);
21
- }