@ldo/jsonld-dataset-proxy 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 (166) hide show
  1. package/LICENSE.txt +21 -0
  2. package/README.md +830 -0
  3. package/dist/ContextUtil.d.ts +17 -0
  4. package/dist/ContextUtil.js +108 -0
  5. package/dist/ContextUtil.js.map +1 -0
  6. package/dist/JsonldDatasetProxyBuilder.d.ts +16 -0
  7. package/dist/JsonldDatasetProxyBuilder.js +41 -0
  8. package/dist/JsonldDatasetProxyBuilder.js.map +1 -0
  9. package/dist/LdoJsonldContext.d.ts +8 -0
  10. package/dist/LdoJsonldContext.js +3 -0
  11. package/dist/LdoJsonldContext.js.map +1 -0
  12. package/dist/ProxyContext.d.ts +31 -0
  13. package/dist/ProxyContext.js +63 -0
  14. package/dist/ProxyContext.js.map +1 -0
  15. package/dist/arrayProxy/ArrayProxy.d.ts +12 -0
  16. package/dist/arrayProxy/ArrayProxy.js +3 -0
  17. package/dist/arrayProxy/ArrayProxy.js.map +1 -0
  18. package/dist/arrayProxy/arrayMethods.d.ts +17 -0
  19. package/dist/arrayProxy/arrayMethods.js +161 -0
  20. package/dist/arrayProxy/arrayMethods.js.map +1 -0
  21. package/dist/arrayProxy/createArrayHandler.d.ts +9 -0
  22. package/dist/arrayProxy/createArrayHandler.js +140 -0
  23. package/dist/arrayProxy/createArrayHandler.js.map +1 -0
  24. package/dist/arrayProxy/isArrayProxy.d.ts +2 -0
  25. package/dist/arrayProxy/isArrayProxy.js +17 -0
  26. package/dist/arrayProxy/isArrayProxy.js.map +1 -0
  27. package/dist/arrayProxy/modifyArray.d.ts +12 -0
  28. package/dist/arrayProxy/modifyArray.js +73 -0
  29. package/dist/arrayProxy/modifyArray.js.map +1 -0
  30. package/dist/graphOf.d.ts +4 -0
  31. package/dist/graphOf.js +25 -0
  32. package/dist/graphOf.js.map +1 -0
  33. package/dist/index.d.ts +34 -0
  34. package/dist/index.js +51 -0
  35. package/dist/index.js.map +1 -0
  36. package/dist/jsonldDatasetProxy.d.ts +5 -0
  37. package/dist/jsonldDatasetProxy.js +19 -0
  38. package/dist/jsonldDatasetProxy.js.map +1 -0
  39. package/dist/language/languageMapProxy.d.ts +4 -0
  40. package/dist/language/languageMapProxy.js +55 -0
  41. package/dist/language/languageMapProxy.js.map +1 -0
  42. package/dist/language/languageSet.d.ts +23 -0
  43. package/dist/language/languageSet.js +75 -0
  44. package/dist/language/languageSet.js.map +1 -0
  45. package/dist/language/languageTypes.d.ts +2 -0
  46. package/dist/language/languageTypes.js +3 -0
  47. package/dist/language/languageTypes.js.map +1 -0
  48. package/dist/language/languageUtils.d.ts +14 -0
  49. package/dist/language/languageUtils.js +73 -0
  50. package/dist/language/languageUtils.js.map +1 -0
  51. package/dist/language/languagesOf.d.ts +13 -0
  52. package/dist/language/languagesOf.js +17 -0
  53. package/dist/language/languagesOf.js.map +1 -0
  54. package/dist/setLanguagePreferences.d.ts +3 -0
  55. package/dist/setLanguagePreferences.js +9 -0
  56. package/dist/setLanguagePreferences.js.map +1 -0
  57. package/dist/setProxy/ObjectSetProxy.d.ts +17 -0
  58. package/dist/setProxy/ObjectSetProxy.js +31 -0
  59. package/dist/setProxy/ObjectSetProxy.js.map +1 -0
  60. package/dist/setProxy/SetProxy.d.ts +29 -0
  61. package/dist/setProxy/SetProxy.js +72 -0
  62. package/dist/setProxy/SetProxy.js.map +1 -0
  63. package/dist/setProxy/SubjectSetProxy.d.ts +15 -0
  64. package/dist/setProxy/SubjectSetProxy.js +38 -0
  65. package/dist/setProxy/SubjectSetProxy.js.map +1 -0
  66. package/dist/setProxy/WildcardObjectSetProxy.d.ts +20 -0
  67. package/dist/setProxy/WildcardObjectSetProxy.js +49 -0
  68. package/dist/setProxy/WildcardObjectSetProxy.js.map +1 -0
  69. package/dist/setProxy/WildcardSubjectSetProxy.d.ts +19 -0
  70. package/dist/setProxy/WildcardSubjectSetProxy.js +31 -0
  71. package/dist/setProxy/WildcardSubjectSetProxy.js.map +1 -0
  72. package/dist/setProxy/createNewSetProxy.d.ts +5 -0
  73. package/dist/setProxy/createNewSetProxy.js +27 -0
  74. package/dist/setProxy/createNewSetProxy.js.map +1 -0
  75. package/dist/setProxy/isSetProxy.d.ts +2 -0
  76. package/dist/setProxy/isSetProxy.js +13 -0
  77. package/dist/setProxy/isSetProxy.js.map +1 -0
  78. package/dist/setProxy/ldSet/BasicLdSet.d.ts +36 -0
  79. package/dist/setProxy/ldSet/BasicLdSet.js +193 -0
  80. package/dist/setProxy/ldSet/BasicLdSet.js.map +1 -0
  81. package/dist/setProxy/ldSet/LdSet.d.ts +30 -0
  82. package/dist/setProxy/ldSet/LdSet.js +3 -0
  83. package/dist/setProxy/ldSet/LdSet.js.map +1 -0
  84. package/dist/setProxy/set.d.ts +2 -0
  85. package/dist/setProxy/set.js +9 -0
  86. package/dist/setProxy/set.js.map +1 -0
  87. package/dist/subjectProxy/SubjectProxy.d.ts +14 -0
  88. package/dist/subjectProxy/SubjectProxy.js +3 -0
  89. package/dist/subjectProxy/SubjectProxy.js.map +1 -0
  90. package/dist/subjectProxy/createSubjectHandler.d.ts +6 -0
  91. package/dist/subjectProxy/createSubjectHandler.js +75 -0
  92. package/dist/subjectProxy/createSubjectHandler.js.map +1 -0
  93. package/dist/subjectProxy/deleteFromDataset.d.ts +3 -0
  94. package/dist/subjectProxy/deleteFromDataset.js +25 -0
  95. package/dist/subjectProxy/deleteFromDataset.js.map +1 -0
  96. package/dist/subjectProxy/getValueForKey.d.ts +5 -0
  97. package/dist/subjectProxy/getValueForKey.js +41 -0
  98. package/dist/subjectProxy/getValueForKey.js.map +1 -0
  99. package/dist/subjectProxy/isSubjectProxy.d.ts +4 -0
  100. package/dist/subjectProxy/isSubjectProxy.js +25 -0
  101. package/dist/subjectProxy/isSubjectProxy.js.map +1 -0
  102. package/dist/types.d.ts +9 -0
  103. package/dist/types.js +11 -0
  104. package/dist/types.js.map +1 -0
  105. package/dist/util/NodeSet.d.ts +9 -0
  106. package/dist/util/NodeSet.js +35 -0
  107. package/dist/util/NodeSet.js.map +1 -0
  108. package/dist/util/RawObject.d.ts +9 -0
  109. package/dist/util/RawObject.js +3 -0
  110. package/dist/util/RawObject.js.map +1 -0
  111. package/dist/util/addObjectToDataset.d.ts +8 -0
  112. package/dist/util/addObjectToDataset.js +83 -0
  113. package/dist/util/addObjectToDataset.js.map +1 -0
  114. package/dist/util/createInteractOptions.d.ts +6 -0
  115. package/dist/util/createInteractOptions.js +37 -0
  116. package/dist/util/createInteractOptions.js.map +1 -0
  117. package/dist/util/getNodeFromRaw.d.ts +6 -0
  118. package/dist/util/getNodeFromRaw.js +47 -0
  119. package/dist/util/getNodeFromRaw.js.map +1 -0
  120. package/dist/util/isProxy.d.ts +6 -0
  121. package/dist/util/isProxy.js +17 -0
  122. package/dist/util/isProxy.js.map +1 -0
  123. package/dist/util/nodeToJsonldRepresentation.d.ts +7 -0
  124. package/dist/util/nodeToJsonldRepresentation.js +75 -0
  125. package/dist/util/nodeToJsonldRepresentation.js.map +1 -0
  126. package/dist/write.d.ts +3 -0
  127. package/dist/write.js +9 -0
  128. package/dist/write.js.map +1 -0
  129. package/package.json +53 -0
  130. package/src/ContextUtil.ts +173 -0
  131. package/src/JsonldDatasetProxyBuilder.ts +107 -0
  132. package/src/LdoJsonldContext.ts +14 -0
  133. package/src/ProxyContext.ts +118 -0
  134. package/src/graphOf.ts +52 -0
  135. package/src/index.ts +39 -0
  136. package/src/jsonldDatasetProxy.ts +28 -0
  137. package/src/language/languageMapProxy.ts +75 -0
  138. package/src/language/languageSet.ts +129 -0
  139. package/src/language/languageTypes.ts +3 -0
  140. package/src/language/languageUtils.ts +159 -0
  141. package/src/language/languagesOf.ts +65 -0
  142. package/src/setLanguagePreferences.ts +14 -0
  143. package/src/setProxy/ObjectSetProxy.ts +66 -0
  144. package/src/setProxy/SetProxy.ts +141 -0
  145. package/src/setProxy/SubjectSetProxy.ts +85 -0
  146. package/src/setProxy/WildcardObjectSetProxy.ts +89 -0
  147. package/src/setProxy/WildcardSubjectSetProxy.ts +58 -0
  148. package/src/setProxy/createNewSetProxy.ts +47 -0
  149. package/src/setProxy/isSetProxy.ts +7 -0
  150. package/src/setProxy/ldSet/BasicLdSet.ts +266 -0
  151. package/src/setProxy/ldSet/LdSet.ts +189 -0
  152. package/src/setProxy/set.ts +14 -0
  153. package/src/subjectProxy/SubjectProxy.ts +20 -0
  154. package/src/subjectProxy/createSubjectHandler.ts +115 -0
  155. package/src/subjectProxy/deleteFromDataset.ts +33 -0
  156. package/src/subjectProxy/getValueForKey.ts +62 -0
  157. package/src/subjectProxy/isSubjectProxy.ts +30 -0
  158. package/src/types.ts +11 -0
  159. package/src/util/NodeSet.ts +35 -0
  160. package/src/util/RawObject.ts +21 -0
  161. package/src/util/addObjectToDataset.ts +147 -0
  162. package/src/util/createInteractOptions.ts +55 -0
  163. package/src/util/getNodeFromRaw.ts +54 -0
  164. package/src/util/isProxy.ts +21 -0
  165. package/src/util/nodeToJsonldRepresentation.ts +78 -0
  166. package/src/write.ts +12 -0
@@ -0,0 +1,107 @@
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 { LiteralLike, ObjectLike } from "./types";
7
+ import type { LdSet } from "./setProxy/ldSet/LdSet";
8
+
9
+ /**
10
+ * Helps build JSON LD Dataset Proxies for a specific dataset and context
11
+ */
12
+ export class JsonldDatasetProxyBuilder {
13
+ private proxyContext: ProxyContext;
14
+
15
+ constructor(proxyContext: ProxyContext) {
16
+ this.proxyContext = proxyContext;
17
+ }
18
+
19
+ /**
20
+ * Designates that all Jsonld Dataset Proxies created should write to the
21
+ * specified graphs
22
+ */
23
+ write(...graphs: GraphNode[]): JsonldDatasetProxyBuilder {
24
+ return new JsonldDatasetProxyBuilder(
25
+ this.proxyContext.duplicate({ writeGraphs: graphs }),
26
+ );
27
+ }
28
+
29
+ /**
30
+ * List the language tags in the order they should be used. When a langString
31
+ * is accessed, LDO will search for values in the order of language given.
32
+ * @param languageOrdering The ordering of languages. For example
33
+ * ("en", "fr", "none", "other"). Defaults to
34
+ * ("none", "en", "other")
35
+ */
36
+ setLanguagePreferences(
37
+ ...languageOrdering: LanguageOrdering
38
+ ): JsonldDatasetProxyBuilder {
39
+ return new JsonldDatasetProxyBuilder(
40
+ this.proxyContext.duplicate({ languageOrdering }),
41
+ );
42
+ }
43
+
44
+ /**
45
+ * Creates a JSON LD Dataset Proxy that matches the given subject
46
+ * @param subject The node to match
47
+ */
48
+ fromSubject<T extends ObjectLike>(subject: NamedNode | BlankNode): T {
49
+ return this.proxyContext.createSubjectProxy(subject) as unknown as T;
50
+ }
51
+
52
+ /**
53
+ * Matches Subjects to provided predicates, objects, and graphs. Returns a
54
+ * JSON LD Dataset that can be read an modified.
55
+ * @param predicate The predicate to match
56
+ * @param object The object to match
57
+ * @param graph The graph to match
58
+ */
59
+ matchSubject<T extends ObjectLike>(
60
+ predicate?: QuadMatch[1] | undefined | null,
61
+ object?: QuadMatch[2] | undefined | null,
62
+ graph?: QuadMatch[3] | undefined | null,
63
+ ): LdSet<T> {
64
+ return this.proxyContext.createSetProxy(
65
+ [null, predicate, object, graph],
66
+ true,
67
+ ) as unknown as LdSet<T>;
68
+ }
69
+
70
+ /**
71
+ * Matches Objects to provided subjects, predicates, and graphs. Returns a
72
+ * JSON LD Dataset that can be read an modified.
73
+ * @param subject The subject to match
74
+ * @param predicate The predicate to match
75
+ * @param graph The graph to match
76
+ */
77
+ matchObject<T extends ObjectLike | LiteralLike>(
78
+ subject?: QuadMatch[0] | undefined | null,
79
+ predicate?: QuadMatch[1],
80
+ graph?: QuadMatch[3] | undefined | null,
81
+ ): LdSet<T> {
82
+ return this.proxyContext.createSetProxy([
83
+ subject,
84
+ predicate,
85
+ null,
86
+ graph,
87
+ ]) as unknown as LdSet<T>;
88
+ }
89
+
90
+ /**
91
+ * Takes a given object and places it in the dataset while returning a JSON LD
92
+ * Dataset Proxy representing the object.
93
+ *
94
+ * @param inputData Initial Data
95
+ * @param graph Optional graph to save this data to
96
+ */
97
+ fromJson<T extends ObjectLike>(inputData: T): T {
98
+ const entryNode = inputData["@id"]
99
+ ? namedNode(inputData["@id"])
100
+ : blankNode();
101
+ const proxy = this.fromSubject<T>(entryNode);
102
+ Object.entries(inputData).forEach(([key, value]) => {
103
+ proxy[<keyof T>key] = value;
104
+ });
105
+ return proxy;
106
+ }
107
+ }
@@ -0,0 +1,14 @@
1
+ import type { ContextDefinition, ExpandedTermDefinition } from "jsonld";
2
+
3
+ export interface LdoJsonldContext extends ContextDefinition {
4
+ [key: string]:
5
+ | null
6
+ | string
7
+ | LdoJsonldContextExpandedTermDefinition
8
+ | LdoJsonldContext[keyof LdoJsonldContext];
9
+ }
10
+
11
+ export type LdoJsonldContextExpandedTermDefinition = ExpandedTermDefinition & {
12
+ "@context"?: LdoJsonldContext | undefined;
13
+ "@isCollection"?: boolean | undefined;
14
+ };
@@ -0,0 +1,118 @@
1
+ import type { GraphNode, QuadMatch, SubjectNode } from "@ldo/rdf-utils";
2
+ import type { BlankNode, Dataset, NamedNode } from "@rdfjs/types";
3
+ import { createSubjectHandler } from "./subjectProxy/createSubjectHandler";
4
+ import type { SubjectProxy } from "./subjectProxy/SubjectProxy";
5
+ import type { SetProxy } from "./setProxy/SetProxy";
6
+ import type { ContextUtil } from "./ContextUtil";
7
+ import type { LanguageOrdering } from "./language/languageTypes";
8
+ import { namedNode } from "@rdfjs/data-model";
9
+ import type { RawValue } from "./util/RawObject";
10
+ import { createNewSetProxy } from "./setProxy/createNewSetProxy";
11
+
12
+ export interface ProxyContextOptions {
13
+ dataset: Dataset;
14
+ contextUtil: ContextUtil;
15
+ writeGraphs: GraphNode[];
16
+ languageOrdering: LanguageOrdering;
17
+ state?: Record<string, unknown>;
18
+ }
19
+
20
+ const rdfType = namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#type");
21
+
22
+ /**
23
+ * This file keeps track of the target objects used in the proxies.
24
+ * The reason is so that JSON.stringify does not recurse inifinitely
25
+ * when it encounters a circular object.
26
+ */
27
+ export class ProxyContext {
28
+ private subjectMap: Map<string, SubjectProxy> = new Map();
29
+ private setMap: Map<string, SetProxy<NonNullable<RawValue>>> = new Map();
30
+
31
+ readonly dataset: Dataset;
32
+ readonly contextUtil: ContextUtil;
33
+ readonly writeGraphs: GraphNode[];
34
+ readonly languageOrdering: LanguageOrdering;
35
+ public state: Record<string, unknown>;
36
+
37
+ constructor(options: ProxyContextOptions) {
38
+ this.dataset = options.dataset;
39
+ this.contextUtil = options.contextUtil;
40
+ this.writeGraphs = options.writeGraphs;
41
+ this.languageOrdering = options.languageOrdering;
42
+ this.state = options.state || {};
43
+ }
44
+
45
+ public createSubjectProxy(node: NamedNode | BlankNode): SubjectProxy {
46
+ if (!this.subjectMap.has(node.value)) {
47
+ const proxy = this.createNewSubjectProxy(node);
48
+ this.subjectMap.set(node.value, proxy);
49
+ }
50
+ return this.subjectMap.get(node.value) as SubjectProxy;
51
+ }
52
+
53
+ protected createNewSubjectProxy(node: NamedNode | BlankNode): SubjectProxy {
54
+ return new Proxy(
55
+ { "@id": node },
56
+ createSubjectHandler(this),
57
+ ) as unknown as SubjectProxy;
58
+ }
59
+
60
+ private getSetKey(...quadMatch: QuadMatch) {
61
+ return `${quadMatch[0]?.value || "undefined"}|${
62
+ quadMatch[1]?.value || "undefined"
63
+ }|${quadMatch[2]?.value || "undefined"}|${
64
+ quadMatch[3]?.value || "undefined"
65
+ }`;
66
+ }
67
+
68
+ public createSetProxy(
69
+ quadMatch: QuadMatch,
70
+ isSubjectOriented?: boolean,
71
+ isLangStringSet?: boolean,
72
+ ): SetProxy {
73
+ const key = this.getSetKey(...quadMatch);
74
+ if (!this.setMap.has(key)) {
75
+ const proxy = this.createNewSetProxy(
76
+ quadMatch,
77
+ isSubjectOriented,
78
+ isLangStringSet,
79
+ );
80
+ this.setMap.set(key, proxy);
81
+ }
82
+ return this.setMap.get(key)!;
83
+ }
84
+
85
+ protected createNewSetProxy(
86
+ quadMatch: QuadMatch,
87
+ isSubjectOriented?: boolean,
88
+ isLangStringSet?: boolean,
89
+ ) {
90
+ return createNewSetProxy(
91
+ quadMatch,
92
+ isSubjectOriented ?? false,
93
+ this,
94
+ isLangStringSet,
95
+ );
96
+ }
97
+
98
+ public duplicate(alternativeOptions: Partial<ProxyContextOptions>) {
99
+ const fullOptions: ProxyContextOptions = {
100
+ ...{
101
+ dataset: this.dataset,
102
+ contextUtil: this.contextUtil,
103
+ writeGraphs: this.writeGraphs,
104
+ languageOrdering: this.languageOrdering,
105
+ },
106
+ ...alternativeOptions,
107
+ };
108
+ return new ProxyContext(fullOptions);
109
+ }
110
+
111
+ public getRdfType(subjectNode: SubjectNode): NamedNode[] {
112
+ return this.dataset
113
+ .match(subjectNode, rdfType)
114
+ .toArray()
115
+ .map((quad) => quad.object)
116
+ .filter((object): object is NamedNode => object.termType === "NamedNode");
117
+ }
118
+ }
package/src/graphOf.ts ADDED
@@ -0,0 +1,52 @@
1
+ import type { ObjectNode, GraphNode } from "@ldo/rdf-utils";
2
+ import { namedNode } from "@rdfjs/data-model";
3
+ import { getSubjectProxyFromObject } from "./subjectProxy/isSubjectProxy";
4
+ import type { ObjectLike } from "./types";
5
+ import {
6
+ _getUnderlyingDataset,
7
+ _getUnderlyingMatch,
8
+ _getUnderlyingNode,
9
+ _proxyContext,
10
+ } from "./types";
11
+ import type { LdSet } from "./setProxy/ldSet/LdSet";
12
+ import { getNodeFromRawValue } from "./util/getNodeFromRaw";
13
+
14
+ /**
15
+ * Returns the graph for which a defined triple is a member
16
+ * @param subject A JsonldDatasetProxy that represents the subject
17
+ * @param predicate The key on the JsonldDatasetProxy
18
+ * @param object The direct object. This can be a JsonldDatasetProxy. This field
19
+ * is optional.
20
+ * @returns a list of graphs for which the triples are members
21
+ */
22
+ export function graphOf<Subject extends ObjectLike, Key extends keyof Subject>(
23
+ subject: Subject,
24
+ predicate: Key,
25
+ object?: NonNullable<Subject[Key]> extends LdSet<infer T> ? T : Subject[Key],
26
+ ): GraphNode[] {
27
+ const subjectProxy = getSubjectProxyFromObject(subject);
28
+ const proxyContext = subjectProxy[_proxyContext];
29
+ const subjectNode = subjectProxy[_getUnderlyingNode];
30
+ const predicateNode = namedNode(
31
+ proxyContext.contextUtil.keyToIri(
32
+ predicate as string,
33
+ proxyContext.getRdfType(subjectNode),
34
+ ),
35
+ );
36
+ let objectNode: ObjectNode | undefined | null;
37
+ if (object == null) {
38
+ objectNode = null;
39
+ } else {
40
+ const datatype = proxyContext.contextUtil.getDataType(
41
+ predicate as string,
42
+ proxyContext.getRdfType(subjectNode),
43
+ );
44
+ objectNode = getNodeFromRawValue(object, proxyContext, datatype);
45
+ }
46
+ const quads = subjectProxy[_getUnderlyingDataset].match(
47
+ subjectNode,
48
+ predicateNode,
49
+ objectNode,
50
+ );
51
+ return quads.toArray().map((quad): GraphNode => quad.graph as GraphNode);
52
+ }
package/src/index.ts ADDED
@@ -0,0 +1,39 @@
1
+ import { jsonldDatasetProxy } from "./jsonldDatasetProxy";
2
+
3
+ export default jsonldDatasetProxy;
4
+ export * from "./types";
5
+ export * from "./ContextUtil";
6
+ export * from "./ProxyContext";
7
+ export * from "./JsonldDatasetProxyBuilder";
8
+ export * from "./jsonldDatasetProxy";
9
+ export * from "./write";
10
+ export * from "./graphOf";
11
+ export * from "./setLanguagePreferences";
12
+ export * from "./LdoJsonldContext";
13
+
14
+ export * from "./language/languagesOf";
15
+ export * from "./language/languageMapProxy";
16
+ export * from "./language/languageSet";
17
+ export * from "./language/languageTypes";
18
+ export * from "./language/languageUtils";
19
+
20
+ export * from "./setProxy/createNewSetProxy";
21
+ export * from "./setProxy/isSetProxy";
22
+ export * from "./setProxy/SetProxy";
23
+ export * from "./setProxy/set";
24
+ export * from "./setProxy/ldSet/LdSet";
25
+ export * from "./setProxy/ldSet/BasicLdSet";
26
+
27
+ export * from "./subjectProxy/createSubjectHandler";
28
+ export * from "./subjectProxy/SubjectProxy";
29
+ export * from "./subjectProxy/getValueForKey";
30
+ export * from "./subjectProxy/deleteFromDataset";
31
+ export * from "./subjectProxy/isSubjectProxy";
32
+
33
+ export * from "./util/addObjectToDataset";
34
+ export * from "./util/nodeToJsonldRepresentation";
35
+ export * from "./util/RawObject";
36
+ export * from "./util/getNodeFromRaw";
37
+ export * from "./util/NodeSet";
38
+ export * from "./util/isProxy";
39
+ export * from "./util/createInteractOptions";
@@ -0,0 +1,28 @@
1
+ import { defaultGraph } from "@rdfjs/data-model";
2
+ import type { Dataset } from "@rdfjs/types";
3
+ import type { ContextDefinition } from "jsonld";
4
+ import { ContextUtil } from "./ContextUtil";
5
+ import { JsonldDatasetProxyBuilder } from "./JsonldDatasetProxyBuilder";
6
+ import { ProxyContext } from "./ProxyContext";
7
+ import type { LdoJsonldContext } from "./LdoJsonldContext";
8
+
9
+ /**
10
+ * Creates a JSON-LD Dataset Proxy
11
+ *
12
+ * @param inputDataset the source dataset
13
+ * @param context JSON-LD Context
14
+ * @returns a JSON-LD Dataset proxy
15
+ */
16
+ export function jsonldDatasetProxy(
17
+ inputDataset: Dataset,
18
+ context: ContextDefinition | LdoJsonldContext,
19
+ ): JsonldDatasetProxyBuilder {
20
+ const contextUtil = new ContextUtil(context);
21
+ const proxyContext = new ProxyContext({
22
+ dataset: inputDataset,
23
+ contextUtil,
24
+ writeGraphs: [defaultGraph()],
25
+ languageOrdering: ["none", "en", "other"],
26
+ });
27
+ return new JsonldDatasetProxyBuilder(proxyContext);
28
+ }
@@ -0,0 +1,75 @@
1
+ import type { PredicateNode, SubjectNode } from "@ldo/rdf-utils";
2
+ import { literal, quad } from "@rdfjs/data-model";
3
+ import type { ProxyContext } from "../ProxyContext";
4
+ import {
5
+ languageKeyToLiteralLanguage,
6
+ quadsToLanguageQuadMap,
7
+ languageDeleteMatch,
8
+ } from "./languageUtils";
9
+ import type { LanguageMap, LanguageSetMap } from "./languagesOf";
10
+ import LanguageSet from "./languageSet";
11
+
12
+ export function createLanguageMapProxy<
13
+ Target extends LanguageMap | LanguageSetMap,
14
+ >(
15
+ subject: SubjectNode,
16
+ predicate: PredicateNode,
17
+ proxyContext: ProxyContext,
18
+ isArray: boolean,
19
+ ): Target {
20
+ const target: Target = {} as Target;
21
+ // Function to call to update the target to represent what's in the dataset
22
+ const targetSetter = (target: Target) => {
23
+ // Clear the target
24
+ Object.keys(target).forEach((key) => delete target[key]);
25
+ // Add current language map to target
26
+ const allQuads = proxyContext.dataset.match(subject, predicate);
27
+ const languageQuadMap = quadsToLanguageQuadMap(allQuads);
28
+ Object.entries(languageQuadMap).forEach(([language, quads]) => {
29
+ const stringArray = quads.toArray().map((quad) => quad.object.value);
30
+ if (isArray) {
31
+ target[language] = new Set(stringArray);
32
+ } else {
33
+ target[language] = stringArray[0];
34
+ }
35
+ });
36
+ };
37
+
38
+ targetSetter(target);
39
+
40
+ return new Proxy<Target>(target, {
41
+ get: (target, key) => {
42
+ targetSetter(target);
43
+ if (typeof key !== "string") {
44
+ return Reflect.get(target, key);
45
+ }
46
+ if (isArray) {
47
+ return new LanguageSet(subject, predicate, key, proxyContext);
48
+ }
49
+ return Reflect.get(target, key);
50
+ },
51
+ set: (target, key, value) => {
52
+ const language = languageKeyToLiteralLanguage(key);
53
+ // Delete all quads with the language currently
54
+ if (!isArray) {
55
+ languageDeleteMatch(proxyContext.dataset, subject, predicate, language);
56
+ }
57
+ // Add the new quad for the language
58
+ proxyContext.writeGraphs.forEach((writeGraph) => {
59
+ proxyContext.dataset.add(
60
+ quad(subject, predicate, literal(value, language), writeGraph),
61
+ );
62
+ });
63
+ return Reflect.set(target, key, value);
64
+ },
65
+ deleteProperty: (target, key) => {
66
+ languageDeleteMatch(
67
+ proxyContext.dataset,
68
+ subject,
69
+ predicate,
70
+ languageKeyToLiteralLanguage(key),
71
+ );
72
+ return Reflect.deleteProperty(target, key);
73
+ },
74
+ }) as Target;
75
+ }
@@ -0,0 +1,129 @@
1
+ import { literal, quad } from "@rdfjs/data-model";
2
+ import type { PredicateNode, SubjectNode } from "@ldo/rdf-utils";
3
+ import type { Dataset, Literal } from "@rdfjs/types";
4
+ import type { LanguageKey } from "./languageTypes";
5
+ import type { LiteralObjectQuad } from "./languageUtils";
6
+ import { languageDeleteMatch, languageMatch } from "./languageUtils";
7
+ import type { ProxyContext } from "../ProxyContext";
8
+
9
+ export default class LanguageSet implements Set<string> {
10
+ private subject: SubjectNode;
11
+ private predicate: PredicateNode;
12
+ private languageKey: LanguageKey;
13
+ private proxyContext: ProxyContext;
14
+
15
+ constructor(
16
+ subject: SubjectNode,
17
+ predicate: PredicateNode,
18
+ languageKey: LanguageKey,
19
+ proxyContext: ProxyContext,
20
+ ) {
21
+ this.subject = subject;
22
+ this.predicate = predicate;
23
+ this.languageKey = languageKey;
24
+ this.proxyContext = proxyContext;
25
+ }
26
+
27
+ private matchThis(): Dataset<LiteralObjectQuad> {
28
+ return languageMatch(
29
+ this.proxyContext.dataset,
30
+ this.subject,
31
+ this.predicate,
32
+ this.languageKey,
33
+ );
34
+ }
35
+
36
+ private getLiteral(value: string): Literal {
37
+ return this.languageKey === "@none"
38
+ ? literal(value)
39
+ : literal(value, this.languageKey);
40
+ }
41
+
42
+ public get size(): number {
43
+ return this.matchThis().size;
44
+ }
45
+
46
+ add(value: string): this {
47
+ this.proxyContext.writeGraphs.forEach((graph) => {
48
+ this.proxyContext.dataset.add(
49
+ quad(
50
+ this.subject,
51
+ this.predicate,
52
+ literal(value, this.languageKey),
53
+ graph,
54
+ ),
55
+ );
56
+ });
57
+ return this;
58
+ }
59
+
60
+ clear(): void {
61
+ languageDeleteMatch(
62
+ this.proxyContext.dataset,
63
+ this.subject,
64
+ this.predicate,
65
+ this.languageKey,
66
+ );
67
+ }
68
+
69
+ delete(value: string): boolean {
70
+ const hadValue = this.has(value);
71
+ this.proxyContext.dataset.deleteMatches(
72
+ this.subject,
73
+ this.predicate,
74
+ this.getLiteral(value),
75
+ );
76
+ return hadValue;
77
+ }
78
+
79
+ forEach(
80
+ callbackfn: (value: string, value2: string, set: Set<string>) => void,
81
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
82
+ thisArg?: any,
83
+ ): void {
84
+ const quads = this.matchThis();
85
+ quads.forEach((curQuad) => {
86
+ callbackfn(curQuad.object.value, curQuad.object.value, thisArg || this);
87
+ });
88
+ }
89
+
90
+ has(item: string): boolean {
91
+ return (
92
+ this.proxyContext.dataset.match(
93
+ this.subject,
94
+ this.predicate,
95
+ this.getLiteral(item),
96
+ ).size > 0
97
+ );
98
+ }
99
+
100
+ *entries(): IterableIterator<[string, string]> {
101
+ const quads = this.matchThis();
102
+ for (const curQuad of quads) {
103
+ yield [curQuad.object.value, curQuad.object.value];
104
+ }
105
+ }
106
+
107
+ *keys(): IterableIterator<string> {
108
+ const quads = this.matchThis();
109
+ for (const curQuad of quads) {
110
+ yield curQuad.object.value;
111
+ }
112
+ }
113
+
114
+ *values(): IterableIterator<string> {
115
+ const quads = this.matchThis();
116
+ for (const curQuad of quads) {
117
+ yield curQuad.object.value;
118
+ }
119
+ }
120
+
121
+ *[Symbol.iterator](): IterableIterator<string> {
122
+ const quads = this.matchThis();
123
+ for (const curQuad of quads) {
124
+ yield curQuad.object.value;
125
+ }
126
+ }
127
+
128
+ [Symbol.toStringTag] = "LanguageSet";
129
+ }
@@ -0,0 +1,3 @@
1
+ export type LanguageOrdering = ("@none" | "@other" | string)[];
2
+
3
+ export type LanguageKey = "@none" | string;