@ldo/jsonld-dataset-proxy 0.0.1-alpha.14

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 (126) hide show
  1. package/README.md +809 -0
  2. package/dist/ContextUtil.d.ts +12 -0
  3. package/dist/ContextUtil.js +70 -0
  4. package/dist/ContextUtil.js.map +1 -0
  5. package/dist/JsonldDatasetProxyBuilder.d.ts +15 -0
  6. package/dist/JsonldDatasetProxyBuilder.js +41 -0
  7. package/dist/JsonldDatasetProxyBuilder.js.map +1 -0
  8. package/dist/ProxyContext.d.ts +31 -0
  9. package/dist/ProxyContext.js +65 -0
  10. package/dist/ProxyContext.js.map +1 -0
  11. package/dist/arrayProxy/ArrayProxy.d.ts +12 -0
  12. package/dist/arrayProxy/ArrayProxy.js +3 -0
  13. package/dist/arrayProxy/ArrayProxy.js.map +1 -0
  14. package/dist/arrayProxy/arrayMethods.d.ts +17 -0
  15. package/dist/arrayProxy/arrayMethods.js +161 -0
  16. package/dist/arrayProxy/arrayMethods.js.map +1 -0
  17. package/dist/arrayProxy/createArrayHandler.d.ts +9 -0
  18. package/dist/arrayProxy/createArrayHandler.js +140 -0
  19. package/dist/arrayProxy/createArrayHandler.js.map +1 -0
  20. package/dist/arrayProxy/isArrayProxy.d.ts +2 -0
  21. package/dist/arrayProxy/isArrayProxy.js +17 -0
  22. package/dist/arrayProxy/isArrayProxy.js.map +1 -0
  23. package/dist/arrayProxy/modifyArray.d.ts +12 -0
  24. package/dist/arrayProxy/modifyArray.js +73 -0
  25. package/dist/arrayProxy/modifyArray.js.map +1 -0
  26. package/dist/graphOf.d.ts +3 -0
  27. package/dist/graphOf.js +37 -0
  28. package/dist/graphOf.js.map +1 -0
  29. package/dist/index.d.ts +32 -0
  30. package/dist/index.js +49 -0
  31. package/dist/index.js.map +1 -0
  32. package/dist/jsonldDatasetProxy.d.ts +4 -0
  33. package/dist/jsonldDatasetProxy.js +19 -0
  34. package/dist/jsonldDatasetProxy.js.map +1 -0
  35. package/dist/language/languageMapProxy.d.ts +4 -0
  36. package/dist/language/languageMapProxy.js +55 -0
  37. package/dist/language/languageMapProxy.js.map +1 -0
  38. package/dist/language/languageSet.d.ts +23 -0
  39. package/dist/language/languageSet.js +75 -0
  40. package/dist/language/languageSet.js.map +1 -0
  41. package/dist/language/languageTypes.d.ts +2 -0
  42. package/dist/language/languageTypes.js +3 -0
  43. package/dist/language/languageTypes.js.map +1 -0
  44. package/dist/language/languageUtils.d.ts +14 -0
  45. package/dist/language/languageUtils.js +73 -0
  46. package/dist/language/languageUtils.js.map +1 -0
  47. package/dist/language/languagesOf.d.ts +12 -0
  48. package/dist/language/languagesOf.js +16 -0
  49. package/dist/language/languagesOf.js.map +1 -0
  50. package/dist/setLanguagePreferences.d.ts +3 -0
  51. package/dist/setLanguagePreferences.js +9 -0
  52. package/dist/setLanguagePreferences.js.map +1 -0
  53. package/dist/subjectProxy/SubjectProxy.d.ts +14 -0
  54. package/dist/subjectProxy/SubjectProxy.js +3 -0
  55. package/dist/subjectProxy/SubjectProxy.js.map +1 -0
  56. package/dist/subjectProxy/createSubjectHandler.d.ts +6 -0
  57. package/dist/subjectProxy/createSubjectHandler.js +73 -0
  58. package/dist/subjectProxy/createSubjectHandler.js.map +1 -0
  59. package/dist/subjectProxy/deleteFromDataset.d.ts +3 -0
  60. package/dist/subjectProxy/deleteFromDataset.js +44 -0
  61. package/dist/subjectProxy/deleteFromDataset.js.map +1 -0
  62. package/dist/subjectProxy/getValueForKey.d.ts +5 -0
  63. package/dist/subjectProxy/getValueForKey.js +43 -0
  64. package/dist/subjectProxy/getValueForKey.js.map +1 -0
  65. package/dist/subjectProxy/isSubjectProxy.d.ts +4 -0
  66. package/dist/subjectProxy/isSubjectProxy.js +25 -0
  67. package/dist/subjectProxy/isSubjectProxy.js.map +1 -0
  68. package/dist/types.d.ts +9 -0
  69. package/dist/types.js +12 -0
  70. package/dist/types.js.map +1 -0
  71. package/dist/util/NodeSet.d.ts +11 -0
  72. package/dist/util/NodeSet.js +45 -0
  73. package/dist/util/NodeSet.js.map +1 -0
  74. package/dist/util/RawObject.d.ts +8 -0
  75. package/dist/util/RawObject.js +3 -0
  76. package/dist/util/RawObject.js.map +1 -0
  77. package/dist/util/addObjectToDataset.d.ts +8 -0
  78. package/dist/util/addObjectToDataset.js +83 -0
  79. package/dist/util/addObjectToDataset.js.map +1 -0
  80. package/dist/util/createInteractOptions.d.ts +6 -0
  81. package/dist/util/createInteractOptions.js +37 -0
  82. package/dist/util/createInteractOptions.js.map +1 -0
  83. package/dist/util/getNodeFromRaw.d.ts +6 -0
  84. package/dist/util/getNodeFromRaw.js +41 -0
  85. package/dist/util/getNodeFromRaw.js.map +1 -0
  86. package/dist/util/isProxy.d.ts +5 -0
  87. package/dist/util/isProxy.js +17 -0
  88. package/dist/util/isProxy.js.map +1 -0
  89. package/dist/util/nodeToJsonldRepresentation.d.ts +6 -0
  90. package/dist/util/nodeToJsonldRepresentation.js +74 -0
  91. package/dist/util/nodeToJsonldRepresentation.js.map +1 -0
  92. package/dist/write.d.ts +3 -0
  93. package/dist/write.js +9 -0
  94. package/dist/write.js.map +1 -0
  95. package/package.json +53 -0
  96. package/src/ContextUtil.ts +90 -0
  97. package/src/JsonldDatasetProxyBuilder.ts +106 -0
  98. package/src/ProxyContext.ts +110 -0
  99. package/src/arrayProxy/ArrayProxy.ts +20 -0
  100. package/src/arrayProxy/arrayMethods.ts +219 -0
  101. package/src/arrayProxy/createArrayHandler.ts +177 -0
  102. package/src/arrayProxy/isArrayProxy.ts +23 -0
  103. package/src/arrayProxy/modifyArray.ts +129 -0
  104. package/src/graphOf.ts +63 -0
  105. package/src/index.ts +37 -0
  106. package/src/jsonldDatasetProxy.ts +27 -0
  107. package/src/language/languageMapProxy.ts +75 -0
  108. package/src/language/languageSet.ts +129 -0
  109. package/src/language/languageTypes.ts +3 -0
  110. package/src/language/languageUtils.ts +159 -0
  111. package/src/language/languagesOf.ts +61 -0
  112. package/src/setLanguagePreferences.ts +14 -0
  113. package/src/subjectProxy/SubjectProxy.ts +20 -0
  114. package/src/subjectProxy/createSubjectHandler.ts +106 -0
  115. package/src/subjectProxy/deleteFromDataset.ts +44 -0
  116. package/src/subjectProxy/getValueForKey.ts +62 -0
  117. package/src/subjectProxy/isSubjectProxy.ts +30 -0
  118. package/src/types.ts +11 -0
  119. package/src/util/NodeSet.ts +47 -0
  120. package/src/util/RawObject.ts +13 -0
  121. package/src/util/addObjectToDataset.ts +141 -0
  122. package/src/util/createInteractOptions.ts +55 -0
  123. package/src/util/getNodeFromRaw.ts +45 -0
  124. package/src/util/isProxy.ts +20 -0
  125. package/src/util/nodeToJsonldRepresentation.ts +76 -0
  126. package/src/write.ts +12 -0
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.nodeToJsonldRepresentation = exports.literalToJsonldRepresentation = void 0;
4
+ function literalToJsonldRepresentation(literal) {
5
+ switch (literal.datatype.value) {
6
+ case "http://www.w3.org/2001/XMLSchema#string":
7
+ case "http://www.w3.org/2001/XMLSchema#ENTITIES":
8
+ case "http://www.w3.org/2001/XMLSchema#ENTITY":
9
+ case "http://www.w3.org/2001/XMLSchema#ID":
10
+ case "http://www.w3.org/2001/XMLSchema#IDREF":
11
+ case "http://www.w3.org/2001/XMLSchema#IDREFS":
12
+ case "http://www.w3.org/2001/XMLSchema#language":
13
+ case "http://www.w3.org/2001/XMLSchema#Name":
14
+ case "http://www.w3.org/2001/XMLSchema#NCName":
15
+ case "http://www.w3.org/2001/XMLSchema#NMTOKEN":
16
+ case "http://www.w3.org/2001/XMLSchema#NMTOKENS":
17
+ case "http://www.w3.org/2001/XMLSchema#normalizedString":
18
+ case "http://www.w3.org/2001/XMLSchema#QName":
19
+ case "http://www.w3.org/2001/XMLSchema#token":
20
+ return literal.value;
21
+ case "http://www.w3.org/2001/XMLSchema#date":
22
+ case "http://www.w3.org/2001/XMLSchema#dateTime":
23
+ case "http://www.w3.org/2001/XMLSchema#duration":
24
+ case "http://www.w3.org/2001/XMLSchema#gDay":
25
+ case "http://www.w3.org/2001/XMLSchema#gMonth":
26
+ case "http://www.w3.org/2001/XMLSchema#gMonthDay":
27
+ case "http://www.w3.org/2001/XMLSchema#gYear":
28
+ case "http://www.w3.org/2001/XMLSchema#gYearMonth":
29
+ case "http://www.w3.org/2001/XMLSchema#time":
30
+ return literal.value;
31
+ case "http://www.w3.org/2001/XMLSchema#integer":
32
+ case "http://www.w3.org/2001/XMLSchema#byte":
33
+ case "http://www.w3.org/2001/XMLSchema#decimal":
34
+ case "http://www.w3.org/2001/XMLSchema#int":
35
+ case "http://www.w3.org/2001/XMLSchema#long":
36
+ case "http://www.w3.org/2001/XMLSchema#negativeInteger":
37
+ case "http://www.w3.org/2001/XMLSchema#nonNegativeInteger":
38
+ case "http://www.w3.org/2001/XMLSchema#nonPositiveInteger":
39
+ case "http://www.w3.org/2001/XMLSchema#positiveInteger":
40
+ case "http://www.w3.org/2001/XMLSchema#short":
41
+ case "http://www.w3.org/2001/XMLSchema#unsignedLong":
42
+ case "http://www.w3.org/2001/XMLSchema#unsignedInt":
43
+ case "http://www.w3.org/2001/XMLSchema#unsignedShort":
44
+ case "http://www.w3.org/2001/XMLSchema#unsignedByte":
45
+ return parseFloat(literal.value);
46
+ case "http://www.w3.org/2001/XMLSchema#boolean":
47
+ return literal.value === "true";
48
+ case "http://www.w3.org/2001/XMLSchema#hexBinary":
49
+ return literal.value;
50
+ case "http://www.w3.org/2001/XMLSchema#anyURI":
51
+ return literal.value;
52
+ case "http://www.w3.org/1999/02/22-rdf-syntax-ns#HTML":
53
+ case "http://www.w3.org/1999/02/22-rdf-syntax-ns#PlainLiteral":
54
+ case "http://www.w3.org/1999/02/22-rdf-syntax-ns#XMLLiteral":
55
+ case "http://www.w3.org/1999/02/22-rdf-syntax-ns#JSON":
56
+ return literal.value;
57
+ default:
58
+ return literal.value;
59
+ }
60
+ }
61
+ exports.literalToJsonldRepresentation = literalToJsonldRepresentation;
62
+ function nodeToJsonldRepresentation(node, proxyContext) {
63
+ if (node.termType === "Literal") {
64
+ return literalToJsonldRepresentation(node);
65
+ }
66
+ else if (node.termType === "NamedNode" || node.termType === "BlankNode") {
67
+ return proxyContext.createSubjectProxy(node);
68
+ }
69
+ else {
70
+ throw new Error("Can only convert NamedNodes or Literals or BlankNodes");
71
+ }
72
+ }
73
+ exports.nodeToJsonldRepresentation = nodeToJsonldRepresentation;
74
+ //# sourceMappingURL=nodeToJsonldRepresentation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"nodeToJsonldRepresentation.js","sourceRoot":"","sources":["../../src/util/nodeToJsonldRepresentation.ts"],"names":[],"mappings":";;;AAMA,SAAgB,6BAA6B,CAAC,OAAgB;IAC5D,QAAQ,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE;QAC9B,KAAK,yCAAyC,CAAC;QAC/C,KAAK,2CAA2C,CAAC;QACjD,KAAK,yCAAyC,CAAC;QAC/C,KAAK,qCAAqC,CAAC;QAC3C,KAAK,wCAAwC,CAAC;QAC9C,KAAK,yCAAyC,CAAC;QAC/C,KAAK,2CAA2C,CAAC;QACjD,KAAK,uCAAuC,CAAC;QAC7C,KAAK,yCAAyC,CAAC;QAC/C,KAAK,0CAA0C,CAAC;QAChD,KAAK,2CAA2C,CAAC;QACjD,KAAK,mDAAmD,CAAC;QACzD,KAAK,wCAAwC,CAAC;QAC9C,KAAK,wCAAwC;YAC3C,OAAO,OAAO,CAAC,KAAK,CAAC;QACvB,KAAK,uCAAuC,CAAC;QAC7C,KAAK,2CAA2C,CAAC;QACjD,KAAK,2CAA2C,CAAC;QACjD,KAAK,uCAAuC,CAAC;QAC7C,KAAK,yCAAyC,CAAC;QAC/C,KAAK,4CAA4C,CAAC;QAClD,KAAK,wCAAwC,CAAC;QAC9C,KAAK,6CAA6C,CAAC;QACnD,KAAK,uCAAuC;YAC1C,OAAO,OAAO,CAAC,KAAK,CAAC;QACvB,KAAK,0CAA0C,CAAC;QAChD,KAAK,uCAAuC,CAAC;QAC7C,KAAK,0CAA0C,CAAC;QAChD,KAAK,sCAAsC,CAAC;QAC5C,KAAK,uCAAuC,CAAC;QAC7C,KAAK,kDAAkD,CAAC;QACxD,KAAK,qDAAqD,CAAC;QAC3D,KAAK,qDAAqD,CAAC;QAC3D,KAAK,kDAAkD,CAAC;QACxD,KAAK,wCAAwC,CAAC;QAC9C,KAAK,+CAA+C,CAAC;QACrD,KAAK,8CAA8C,CAAC;QACpD,KAAK,gDAAgD,CAAC;QACtD,KAAK,+CAA+C;YAClD,OAAO,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnC,KAAK,0CAA0C;YAC7C,OAAO,OAAO,CAAC,KAAK,KAAK,MAAM,CAAC;QAClC,KAAK,4CAA4C;YAC/C,OAAO,OAAO,CAAC,KAAK,CAAC;QACvB,KAAK,yCAAyC;YAC5C,OAAO,OAAO,CAAC,KAAK,CAAC;QACvB,KAAK,iDAAiD,CAAC;QACvD,KAAK,yDAAyD,CAAC;QAC/D,KAAK,uDAAuD,CAAC;QAC7D,KAAK,iDAAiD;YACpD,OAAO,OAAO,CAAC,KAAK,CAAC;QACvB;YACE,OAAO,OAAO,CAAC,KAAK,CAAC;KACxB;AACH,CAAC;AAxDD,sEAwDC;AAED,SAAgB,0BAA0B,CACxC,IAAiB,EACjB,YAA0B;IAE1B,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;QAC/B,OAAO,6BAA6B,CAAC,IAAI,CAAC,CAAC;KAC5C;SAAM,IAAI,IAAI,CAAC,QAAQ,KAAK,WAAW,IAAI,IAAI,CAAC,QAAQ,KAAK,WAAW,EAAE;QACzE,OAAO,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;KAC9C;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;KAC1E;AACH,CAAC;AAXD,gEAWC"}
@@ -0,0 +1,3 @@
1
+ import type { GraphNode } from "@ldo/rdf-utils";
2
+ import type { InteractOptions } from "./util/createInteractOptions";
3
+ export declare function write(...graphs: GraphNode[]): InteractOptions;
package/dist/write.js ADDED
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.write = void 0;
4
+ const createInteractOptions_1 = require("./util/createInteractOptions");
5
+ function write(...graphs) {
6
+ return (0, createInteractOptions_1.createInteractOptions)("writeGraphs", graphs);
7
+ }
8
+ exports.write = write;
9
+ //# sourceMappingURL=write.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"write.js","sourceRoot":"","sources":["../src/write.ts"],"names":[],"mappings":";;;AAEA,wEAAqE;AAOrE,SAAgB,KAAK,CAAC,GAAG,MAAmB;IAC1C,OAAO,IAAA,6CAAqB,EAAC,aAAa,EAAE,MAAM,CAAC,CAAC;AACtD,CAAC;AAFD,sBAEC"}
package/package.json ADDED
@@ -0,0 +1,53 @@
1
+ {
2
+ "name": "@ldo/jsonld-dataset-proxy",
3
+ "version": "0.0.1-alpha.14",
4
+ "description": "",
5
+ "main": "dist/index.js",
6
+ "scripts": {
7
+ "build": "tsc --project tsconfig.build.json",
8
+ "build:watch": "tsc-watch",
9
+ "test": "jest --coverage",
10
+ "prepublishOnly": "npm run test && npm run build",
11
+ "start": "ts-node ./example/example.ts",
12
+ "start:lang": "ts-node ./example/languageExample.ts",
13
+ "lint": "eslint src/** --fix --no-error-on-unmatched-pattern"
14
+ },
15
+ "repository": {
16
+ "type": "git",
17
+ "url": "git+https://github.com/o-development/ldobjects.git"
18
+ },
19
+ "author": "Jackson Morgan",
20
+ "license": "MIT",
21
+ "bugs": {
22
+ "url": "https://github.com/o-development/ldobjects/issues"
23
+ },
24
+ "homepage": "https://github.com/o-development/ldobjects/tree/main/packages/jsonld-dataset-proxy#readme",
25
+ "devDependencies": {
26
+ "@rdfjs/types": "^1.1.0",
27
+ "@types/jest": "^27.0.3",
28
+ "@types/jsonld": "^1.5.6",
29
+ "@types/n3": "^1.10.4",
30
+ "@types/rdfjs__dataset": "^1.0.5",
31
+ "@types/shexj": "2.1.4",
32
+ "jest": "^27.4.5",
33
+ "shex-test": "^0.5.5",
34
+ "ts-jest": "^27.1.2",
35
+ "ts-node": "^10.4.0",
36
+ "tsc-watch": "^6.0.0"
37
+ },
38
+ "files": [
39
+ "dist",
40
+ "src"
41
+ ],
42
+ "dependencies": {
43
+ "@ldo/rdf-utils": "^0.0.1-alpha.14",
44
+ "@ldo/subscribable-dataset": "^0.0.1-alpha.14",
45
+ "@rdfjs/data-model": "^1.2.0",
46
+ "@rdfjs/dataset": "^1.1.0",
47
+ "jsonld2graphobject": "^0.0.4"
48
+ },
49
+ "publishConfig": {
50
+ "access": "public"
51
+ },
52
+ "gitHead": "5acfea4c43c07c02df9ed4e9166e61a540e26db8"
53
+ }
@@ -0,0 +1,90 @@
1
+ import type { ContextDefinition, ExpandedTermDefinition } from "jsonld";
2
+
3
+ // Create JSONLD Shorthands
4
+ const shorthandToIriMap: Record<string, string> = {
5
+ "@type": "http://www.w3.org/1999/02/22-rdf-syntax-ns#type",
6
+ };
7
+
8
+ /**
9
+ * Context Util
10
+ * Handles the JSON-LD context and allows conversion between IRIs and terms
11
+ */
12
+ export class ContextUtil {
13
+ public readonly context: ContextDefinition;
14
+ private iriToKeyMap: Record<string, string>;
15
+
16
+ constructor(context: ContextDefinition) {
17
+ this.context = context;
18
+ this.iriToKeyMap = {};
19
+ Object.entries(context).forEach(([contextKey, contextValue]) => {
20
+ if (typeof contextValue === "string") {
21
+ this.iriToKeyMap[this.keyIdToIri(contextValue)] = contextKey;
22
+ } else if (
23
+ typeof contextValue === "object" &&
24
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
25
+ (contextValue as any)["@id"]
26
+ ) {
27
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
28
+ this.iriToKeyMap[this.keyIdToIri((contextValue as any)["@id"])] =
29
+ contextKey;
30
+ }
31
+ });
32
+ }
33
+
34
+ public keyToIri(key: string): string {
35
+ if (!this.context[key]) {
36
+ return key;
37
+ } else if (typeof this.context[key] === "string") {
38
+ return this.keyIdToIri(this.context[key] as string);
39
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
40
+ } else if (this.context[key] && (this.context[key] as any)["@id"]) {
41
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
42
+ return this.keyIdToIri((this.context[key] as any)["@id"]);
43
+ }
44
+ return key;
45
+ }
46
+
47
+ private keyIdToIri(keyId: string) {
48
+ if (shorthandToIriMap[keyId]) {
49
+ return shorthandToIriMap[keyId];
50
+ } else {
51
+ return keyId;
52
+ }
53
+ }
54
+
55
+ public iriToKey(iri: string): string {
56
+ if (this.iriToKeyMap[iri]) {
57
+ return this.iriToKeyMap[iri];
58
+ }
59
+ return iri;
60
+ }
61
+
62
+ public getType(key: string): string {
63
+ if (
64
+ typeof this.context[key] === "object" &&
65
+ (this.context[key] as ExpandedTermDefinition)["@type"]
66
+ ) {
67
+ return (this.context[key] as ExpandedTermDefinition)["@type"] as string;
68
+ }
69
+ return "http://www.w3.org/2001/XMLSchema#string";
70
+ }
71
+
72
+ public isArray(key: string): boolean {
73
+ return !!(
74
+ this.context[key] &&
75
+ typeof this.context[key] === "object" &&
76
+ (this.context[key] as ExpandedTermDefinition)["@container"] &&
77
+ (this.context[key] as ExpandedTermDefinition)["@container"] === "@set"
78
+ );
79
+ }
80
+
81
+ public isLangString(key: string): boolean {
82
+ return !!(
83
+ this.context[key] &&
84
+ typeof this.context[key] === "object" &&
85
+ (this.context[key] as ExpandedTermDefinition)["@type"] &&
86
+ (this.context[key] as ExpandedTermDefinition)["@type"] ===
87
+ "http://www.w3.org/1999/02/22-rdf-syntax-ns#langString"
88
+ );
89
+ }
90
+ }
@@ -0,0 +1,106 @@
1
+ import { blankNode, namedNode } from "@rdfjs/data-model";
2
+ import type { BlankNode, NamedNode } from "@rdfjs/types";
3
+ import type { GraphNode, QuadMatch } from "@ldo/rdf-utils";
4
+ import type { LanguageOrdering } from "./language/languageTypes";
5
+ import type { ProxyContext } from "./ProxyContext";
6
+ import type { ObjectLike } from "./types";
7
+
8
+ /**
9
+ * Helps build JSON LD Dataset Proxies for a specific dataset and context
10
+ */
11
+ export class JsonldDatasetProxyBuilder {
12
+ private proxyContext: ProxyContext;
13
+
14
+ constructor(proxyContext: ProxyContext) {
15
+ this.proxyContext = proxyContext;
16
+ }
17
+
18
+ /**
19
+ * Designates that all Jsonld Dataset Proxies created should write to the
20
+ * specified graphs
21
+ */
22
+ write(...graphs: GraphNode[]): JsonldDatasetProxyBuilder {
23
+ return new JsonldDatasetProxyBuilder(
24
+ this.proxyContext.duplicate({ writeGraphs: graphs }),
25
+ );
26
+ }
27
+
28
+ /**
29
+ * List the language tags in the order they should be used. When a langString
30
+ * is accessed, LDO will search for values in the order of language given.
31
+ * @param languageOrdering The ordering of languages. For example
32
+ * ("en", "fr", "none", "other"). Defaults to
33
+ * ("none", "en", "other")
34
+ */
35
+ setLanguagePreferences(
36
+ ...languageOrdering: LanguageOrdering
37
+ ): JsonldDatasetProxyBuilder {
38
+ return new JsonldDatasetProxyBuilder(
39
+ this.proxyContext.duplicate({ languageOrdering }),
40
+ );
41
+ }
42
+
43
+ /**
44
+ * Creates a JSON LD Dataset Proxy that matches the given subject
45
+ * @param subject The node to match
46
+ */
47
+ fromSubject<T extends ObjectLike>(subject: NamedNode | BlankNode): T {
48
+ return this.proxyContext.createSubjectProxy(subject) as unknown as T;
49
+ }
50
+
51
+ /**
52
+ * Matches Subjects to provided predicates, objects, and graphs. Returns a
53
+ * JSON LD Dataset that can be read an modified.
54
+ * @param predicate The predicate to match
55
+ * @param object The object to match
56
+ * @param graph The graph to match
57
+ */
58
+ matchSubject<T extends ObjectLike>(
59
+ predicate?: QuadMatch[1],
60
+ object?: QuadMatch[2],
61
+ graph?: QuadMatch[3],
62
+ ): T[] {
63
+ return this.proxyContext.createArrayProxy(
64
+ [null, predicate, object, graph],
65
+ true,
66
+ ) as unknown as T[];
67
+ }
68
+
69
+ /**
70
+ * Matches Objects to provided subjects, predicates, and graphs. Returns a
71
+ * JSON LD Dataset that can be read an modified.
72
+ * @param subject The subject to match
73
+ * @param predicate The predicate to match
74
+ * @param graph The graph to match
75
+ */
76
+ matchObject<T extends ObjectLike>(
77
+ subject?: QuadMatch[0],
78
+ predicate?: QuadMatch[1],
79
+ graph?: QuadMatch[3],
80
+ ): T[] {
81
+ return this.proxyContext.createArrayProxy([
82
+ subject,
83
+ predicate,
84
+ null,
85
+ graph,
86
+ ]) as unknown as T[];
87
+ }
88
+
89
+ /**
90
+ * Takes a given object and places it in the dataset while returning a JSON LD
91
+ * Dataset Proxy representing the object.
92
+ *
93
+ * @param inputData Initial Data
94
+ * @param graph Optional graph to save this data to
95
+ */
96
+ fromJson<T extends ObjectLike>(inputData: T): T {
97
+ const entryNode = inputData["@id"]
98
+ ? namedNode(inputData["@id"])
99
+ : blankNode();
100
+ const proxy = this.fromSubject<T>(entryNode);
101
+ Object.entries(inputData).forEach(([key, value]) => {
102
+ proxy[<keyof T>key] = value;
103
+ });
104
+ return proxy;
105
+ }
106
+ }
@@ -0,0 +1,110 @@
1
+ import type { GraphNode, QuadMatch } from "@ldo/rdf-utils";
2
+ import type { BlankNode, Dataset, NamedNode } from "@rdfjs/types";
3
+ import type { ArrayProxyTarget } from "./arrayProxy/createArrayHandler";
4
+ import { createArrayHandler } from "./arrayProxy/createArrayHandler";
5
+ import { createSubjectHandler } from "./subjectProxy/createSubjectHandler";
6
+ import type { SubjectProxy } from "./subjectProxy/SubjectProxy";
7
+ import type { ArrayProxy } from "./arrayProxy/ArrayProxy";
8
+ import { _getUnderlyingArrayTarget } from "./types";
9
+ import type { ContextUtil } from "./ContextUtil";
10
+ import type { LanguageOrdering } from "./language/languageTypes";
11
+
12
+ export interface ProxyContextOptions {
13
+ dataset: Dataset;
14
+ contextUtil: ContextUtil;
15
+ writeGraphs: GraphNode[];
16
+ languageOrdering: LanguageOrdering;
17
+ prefilledArrayTargets?: ArrayProxyTarget[];
18
+ state?: Record<string, unknown>;
19
+ }
20
+
21
+ /**
22
+ * This file keeps track of the target objects used in the proxies.
23
+ * The reason is so that JSON.stringify does not recurse inifinitely
24
+ * when it encounters a circular object.
25
+ */
26
+ export class ProxyContext {
27
+ private subjectMap: Map<string, SubjectProxy> = new Map();
28
+ private arrayMap: Map<string, ArrayProxy> = new Map();
29
+
30
+ readonly dataset: Dataset;
31
+ readonly contextUtil: ContextUtil;
32
+ readonly writeGraphs: GraphNode[];
33
+ readonly languageOrdering: LanguageOrdering;
34
+ public state: Record<string, unknown>;
35
+
36
+ constructor(options: ProxyContextOptions) {
37
+ this.dataset = options.dataset;
38
+ this.contextUtil = options.contextUtil;
39
+ this.writeGraphs = options.writeGraphs;
40
+ this.languageOrdering = options.languageOrdering;
41
+ this.state = options.state || {};
42
+ if (options.prefilledArrayTargets) {
43
+ options.prefilledArrayTargets.forEach((target) => {
44
+ this.createArrayProxy(target[0], target[2], target);
45
+ });
46
+ }
47
+ }
48
+
49
+ public createSubjectProxy(node: NamedNode | BlankNode): SubjectProxy {
50
+ if (!this.subjectMap.has(node.value)) {
51
+ const proxy = new Proxy(
52
+ { "@id": node },
53
+ this.createSubjectHandler(),
54
+ ) as unknown as SubjectProxy;
55
+ this.subjectMap.set(node.value, proxy);
56
+ }
57
+ return this.subjectMap.get(node.value) as SubjectProxy;
58
+ }
59
+
60
+ protected createSubjectHandler() {
61
+ return createSubjectHandler(this);
62
+ }
63
+
64
+ private getArrayKey(...quadMatch: QuadMatch) {
65
+ return `${quadMatch[0]?.value || "undefined"}|${
66
+ quadMatch[1]?.value || "undefined"
67
+ }|${quadMatch[2]?.value || "undefined"}|${
68
+ quadMatch[3]?.value || "undefined"
69
+ }`;
70
+ }
71
+
72
+ public createArrayProxy(
73
+ quadMatch: QuadMatch,
74
+ isSubjectOriented = false,
75
+ initialTarget?: ArrayProxyTarget,
76
+ isLangStringArray?: boolean,
77
+ ): ArrayProxy {
78
+ const key = this.getArrayKey(...quadMatch);
79
+ if (!this.arrayMap.has(key)) {
80
+ const proxy = new Proxy(
81
+ initialTarget || [quadMatch, [], isSubjectOriented, isLangStringArray],
82
+ this.createArrayHandler(),
83
+ ) as unknown as ArrayProxy;
84
+ this.arrayMap.set(key, proxy);
85
+ }
86
+ return this.arrayMap.get(key) as ArrayProxy;
87
+ }
88
+
89
+ protected createArrayHandler() {
90
+ return createArrayHandler(this);
91
+ }
92
+
93
+ public duplicate(alternativeOptions: Partial<ProxyContextOptions>) {
94
+ const prefilledArrayTargets: ArrayProxyTarget[] = [];
95
+ this.arrayMap.forEach((value) => {
96
+ prefilledArrayTargets.push(value[_getUnderlyingArrayTarget]);
97
+ });
98
+ const fullOptions: ProxyContextOptions = {
99
+ ...{
100
+ dataset: this.dataset,
101
+ contextUtil: this.contextUtil,
102
+ writeGraphs: this.writeGraphs,
103
+ languageOrdering: this.languageOrdering,
104
+ prefilledArrayTargets,
105
+ },
106
+ ...alternativeOptions,
107
+ };
108
+ return new ProxyContext(fullOptions);
109
+ }
110
+ }
@@ -0,0 +1,20 @@
1
+ import type { Dataset } from "@rdfjs/types";
2
+ import type { ObjectNode } from "@ldo/rdf-utils";
3
+ import type { ArrayProxyTarget } from "./createArrayHandler";
4
+ import type {
5
+ _getNodeAtIndex,
6
+ _getUnderlyingArrayTarget,
7
+ _getUnderlyingDataset,
8
+ _getUnderlyingMatch,
9
+ _proxyContext,
10
+ } from "../types";
11
+ import { _getUnderlyingNode } from "../types";
12
+ import type { ProxyContext } from "../ProxyContext";
13
+
14
+ export type ArrayProxy = Array<unknown> & {
15
+ readonly [_getUnderlyingDataset]: Dataset;
16
+ readonly [_getUnderlyingMatch]: ArrayProxyTarget[0];
17
+ readonly [_getNodeAtIndex]: (index: number) => ObjectNode | undefined;
18
+ readonly [_getUnderlyingArrayTarget]: ArrayProxyTarget;
19
+ [_proxyContext]: ProxyContext;
20
+ };