@ldo/subscribable-dataset 0.0.1-alpha.17 → 0.0.1-alpha.19

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 (52) hide show
  1. package/dist/ProxyTransactionalDataset.d.ts +2 -2
  2. package/dist/ProxyTransactionalDataset.js +2 -1
  3. package/dist/ProxyTransactionalDataset.js.map +1 -1
  4. package/dist/SubscribableDataset.d.ts +37 -0
  5. package/dist/SubscribableDataset.js +180 -0
  6. package/dist/SubscribableDataset.js.map +1 -0
  7. package/dist/SubscribableDatasetFactory.d.ts +9 -0
  8. package/dist/SubscribableDatasetFactory.js +15 -0
  9. package/dist/SubscribableDatasetFactory.js.map +1 -0
  10. package/dist/TransactionDataset.d.ts +25 -0
  11. package/dist/TransactionDataset.js +124 -0
  12. package/dist/TransactionDataset.js.map +1 -0
  13. package/dist/TransactionDatasetFactory.d.ts +9 -0
  14. package/dist/TransactionDatasetFactory.js +15 -0
  15. package/dist/TransactionDatasetFactory.js.map +1 -0
  16. package/dist/WrapperSubscribableDataset.d.ts +1 -1
  17. package/dist/WrapperSubscribableDataset.js +4 -6
  18. package/dist/WrapperSubscribableDataset.js.map +1 -1
  19. package/dist/WrapperSubscribableDatasetFactory.d.ts +2 -2
  20. package/dist/WrapperSubscribableDatasetFactory.js +4 -6
  21. package/dist/WrapperSubscribableDatasetFactory.js.map +1 -1
  22. package/dist/createSubscribableDataset.d.ts +5 -0
  23. package/dist/createSubscribableDataset.js +25 -0
  24. package/dist/createSubscribableDataset.js.map +1 -0
  25. package/dist/createSubscribableDatasetFromSerializedInput.d.ts +4 -0
  26. package/dist/createSubscribableDatasetFromSerializedInput.js +11 -0
  27. package/dist/createSubscribableDatasetFromSerializedInput.js.map +1 -0
  28. package/dist/createWrapperSubscribableDataset.d.ts +3 -3
  29. package/dist/createWrapperSubscribableDataset.js +4 -7
  30. package/dist/createWrapperSubscribableDataset.js.map +1 -1
  31. package/dist/createWrapperSubscribableDatasetFromSerializedInput.d.ts +2 -2
  32. package/dist/createWrapperSubscribableDatasetFromSerializedInput.js +3 -2
  33. package/dist/createWrapperSubscribableDatasetFromSerializedInput.js.map +1 -1
  34. package/dist/index.d.ts +7 -5
  35. package/dist/index.js +9 -15
  36. package/dist/index.js.map +1 -1
  37. package/dist/types.d.ts +14 -9
  38. package/dist/util.d.ts +3 -0
  39. package/dist/util.js +20 -0
  40. package/dist/util.js.map +1 -0
  41. package/package.json +2 -2
  42. package/src/{WrapperSubscribableDataset.ts → SubscribableDataset.ts} +42 -234
  43. package/src/SubscribableDatasetFactory.ts +31 -0
  44. package/src/{ProxyTransactionalDataset.ts → TransactionDataset.ts} +10 -43
  45. package/src/TransactionDatasetFactory.ts +27 -0
  46. package/src/createSubscribableDataset.ts +46 -0
  47. package/src/{createWrapperSubscribableDatasetFromSerializedInput.ts → createSubscribableDatasetFromSerializedInput.ts} +6 -6
  48. package/src/index.ts +7 -8
  49. package/src/types.ts +35 -12
  50. package/src/util.ts +27 -0
  51. package/src/WrapperSubscribableDatasetFactory.ts +0 -27
  52. package/src/createWrapperSubscribableDataset.ts +0 -30
@@ -0,0 +1,31 @@
1
+ import type { DatasetFactory, BaseQuad, Dataset } from "@rdfjs/types";
2
+ import type { ITransactionDatasetFactory } from "./types";
3
+ import { SubscribableDataset } from "./SubscribableDataset";
4
+
5
+ /**
6
+ * A DatasetFactory that returns a SubscribableDataset given a generic DatasetFactory.
7
+ */
8
+ export class SubscribableDatasetFactory<
9
+ InAndOutQuad extends BaseQuad = BaseQuad,
10
+ > implements DatasetFactory<InAndOutQuad, InAndOutQuad>
11
+ {
12
+ protected datasetFactory: DatasetFactory<InAndOutQuad, InAndOutQuad>;
13
+ protected transactionDatasetFactory: ITransactionDatasetFactory<InAndOutQuad>;
14
+ constructor(
15
+ datasetFactory: DatasetFactory<InAndOutQuad, InAndOutQuad>,
16
+ transactionDatasetFactory: ITransactionDatasetFactory<InAndOutQuad>,
17
+ ) {
18
+ this.datasetFactory = datasetFactory;
19
+ this.transactionDatasetFactory = transactionDatasetFactory;
20
+ }
21
+
22
+ dataset(
23
+ quads?: Dataset<InAndOutQuad, InAndOutQuad> | InAndOutQuad[],
24
+ ): SubscribableDataset<InAndOutQuad> {
25
+ return new SubscribableDataset(
26
+ this.datasetFactory,
27
+ this.transactionDatasetFactory,
28
+ quads ? this.datasetFactory.dataset(quads) : undefined,
29
+ );
30
+ }
31
+ }
@@ -1,31 +1,23 @@
1
1
  import type { Dataset, BaseQuad, Term, DatasetFactory } from "@rdfjs/types";
2
2
  import type { DatasetChanges } from "@ldo/rdf-utils";
3
- import type { BulkEditableDataset, TransactionalDataset } from "./types";
4
- import { ExtendedDataset } from "@ldo/dataset";
3
+ import type { ITransactionDataset, ITransactionDatasetFactory } from "./types";
5
4
  import { mergeDatasetChanges } from "./mergeDatasetChanges";
5
+ import { SubscribableDataset } from "./SubscribableDataset";
6
+ import { updateDatasetInBulk } from "./util";
6
7
 
7
8
  /**
8
9
  * Proxy Transactional Dataset is a transactional dataset that does not duplicate
9
10
  * the parent dataset, it will dynamically determine the correct return value for
10
11
  * methods in real time when the method is called.
11
12
  */
12
- export default class ProxyTransactionalDataset<
13
- InAndOutQuad extends BaseQuad = BaseQuad,
14
- >
15
- extends ExtendedDataset<InAndOutQuad>
16
- implements
17
- BulkEditableDataset<InAndOutQuad>,
18
- TransactionalDataset<InAndOutQuad>
13
+ export class TransactionDataset<InAndOutQuad extends BaseQuad = BaseQuad>
14
+ extends SubscribableDataset<InAndOutQuad>
15
+ implements ITransactionDataset<InAndOutQuad>
19
16
  {
20
17
  /**
21
18
  * The parent dataset that will be updated upon commit
22
19
  */
23
- private parentDataset: Dataset<InAndOutQuad, InAndOutQuad>;
24
-
25
- /**
26
- * A factory for creating new datasets to be added to the update method
27
- */
28
- private datasetFactory: DatasetFactory<InAndOutQuad, InAndOutQuad>;
20
+ public readonly parentDataset: Dataset<InAndOutQuad, InAndOutQuad>;
29
21
 
30
22
  /**
31
23
  * The changes made that are ready to commit
@@ -48,10 +40,10 @@ export default class ProxyTransactionalDataset<
48
40
  constructor(
49
41
  parentDataset: Dataset<InAndOutQuad, InAndOutQuad>,
50
42
  datasetFactory: DatasetFactory<InAndOutQuad, InAndOutQuad>,
43
+ transactionDatasetFactory: ITransactionDatasetFactory<InAndOutQuad>,
51
44
  ) {
52
- super(datasetFactory.dataset(), datasetFactory);
45
+ super(datasetFactory, transactionDatasetFactory, datasetFactory.dataset());
53
46
  this.parentDataset = parentDataset;
54
- this.datasetFactory = datasetFactory;
55
47
  this.datasetChanges = {};
56
48
  }
57
49
 
@@ -255,21 +247,7 @@ export default class ProxyTransactionalDataset<
255
247
  * Helper method to update the parent dataset or any other provided dataset
256
248
  */
257
249
  private updateParentDataset(datasetChanges: DatasetChanges<InAndOutQuad>) {
258
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
259
- if ((this.parentDataset as any).bulk) {
260
- (this.parentDataset as BulkEditableDataset<InAndOutQuad>).bulk(
261
- datasetChanges,
262
- );
263
- } else {
264
- if (datasetChanges.added) {
265
- this.parentDataset.addAll(datasetChanges.added);
266
- }
267
- if (datasetChanges.removed) {
268
- datasetChanges.removed.forEach((curQuad) => {
269
- this.parentDataset.delete(curQuad);
270
- });
271
- }
272
- }
250
+ return updateDatasetInBulk(this.parentDataset, datasetChanges);
273
251
  }
274
252
 
275
253
  /**
@@ -300,17 +278,6 @@ export default class ProxyTransactionalDataset<
300
278
  this.committedDatasetChanges = undefined;
301
279
  }
302
280
 
303
- /**
304
- * Starts a new transaction with this transactional dataset as the parent
305
- * @returns
306
- */
307
- public startTransaction(): TransactionalDataset<InAndOutQuad> {
308
- // This is caused by the typings being incorrect for the intersect method
309
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
310
- // @ts-ignore
311
- return new ProxyTransactionalDataset(this, this.datasetFactory);
312
- }
313
-
314
281
  public getChanges(): DatasetChanges<InAndOutQuad> {
315
282
  return this.datasetChanges;
316
283
  }
@@ -0,0 +1,27 @@
1
+ import type { BaseQuad, DatasetFactory } from "@rdfjs/types";
2
+ import type { ISubscribableDataset, ITransactionDatasetFactory } from "./types";
3
+ import { TransactionDataset } from "./TransactionDataset";
4
+
5
+ export class TransactionDatasetFactory<InAndOutQuad extends BaseQuad>
6
+ implements ITransactionDatasetFactory<InAndOutQuad>
7
+ {
8
+ private datasetFactory: DatasetFactory<InAndOutQuad, InAndOutQuad>;
9
+ private transactionDatasetFactory: ITransactionDatasetFactory<InAndOutQuad>;
10
+ constructor(
11
+ datasetFactory: DatasetFactory<InAndOutQuad, InAndOutQuad>,
12
+ transactionDatasetFactory?: ITransactionDatasetFactory<InAndOutQuad>,
13
+ ) {
14
+ this.datasetFactory = datasetFactory;
15
+ this.transactionDatasetFactory = transactionDatasetFactory || this;
16
+ }
17
+
18
+ transactionDataset(
19
+ parentDataset: ISubscribableDataset<InAndOutQuad>,
20
+ ): TransactionDataset<InAndOutQuad> {
21
+ return new TransactionDataset<InAndOutQuad>(
22
+ parentDataset,
23
+ this.datasetFactory,
24
+ this.transactionDatasetFactory,
25
+ );
26
+ }
27
+ }
@@ -0,0 +1,46 @@
1
+ import type { Dataset, DatasetFactory, Quad } from "@rdfjs/types";
2
+ import { createDataset } from "@ldo/dataset";
3
+ import { SubscribableDatasetFactory } from "./SubscribableDatasetFactory";
4
+ import type {
5
+ ISubscribableDataset,
6
+ ISubscribableDatasetFactory,
7
+ ITransactionDatasetFactory,
8
+ } from "./types";
9
+ import { TransactionDatasetFactory } from "./TransactionDatasetFactory";
10
+
11
+ const datasetFactory: DatasetFactory<Quad> = {
12
+ dataset: (quads?: Dataset<Quad> | Quad[]): Dataset<Quad> => {
13
+ return createDataset(quads);
14
+ },
15
+ };
16
+
17
+ /**
18
+ * Creates a factory that generates TransactionDatasets
19
+ * @returns TransactionDatasetFactory
20
+ */
21
+ export function createTransactionDatasetFactory(): ITransactionDatasetFactory<Quad> {
22
+ return new TransactionDatasetFactory(datasetFactory);
23
+ }
24
+
25
+ /**
26
+ * Creates a dataset factory that generates a SubscribableDataset
27
+ * @returns DatasetFactory for SubscribableDataset
28
+ */
29
+ export function createSubscribableDatasetFactory(): ISubscribableDatasetFactory<Quad> {
30
+ return new SubscribableDatasetFactory(
31
+ datasetFactory,
32
+ createTransactionDatasetFactory(),
33
+ );
34
+ }
35
+
36
+ /**
37
+ * Creates a SubscribableDataset
38
+ * @param quads: A dataset or array of Quads to initialize the dataset.
39
+ * @returns Dataset
40
+ */
41
+ export function createSubscribableDataset(
42
+ quads?: Dataset<Quad> | Quad[],
43
+ ): ISubscribableDataset<Quad> {
44
+ const subscribableDatasetFactory = createSubscribableDatasetFactory();
45
+ return subscribableDatasetFactory.dataset(quads);
46
+ }
@@ -1,8 +1,8 @@
1
1
  import type { Quad } from "@rdfjs/types";
2
2
  import type { ParserOptions } from "@ldo/rdf-utils";
3
3
  import { createDatasetFromSerializedInput } from "@ldo/dataset";
4
- import { createWrapperSubscribableDatasetFactory } from "./createWrapperSubscribableDataset";
5
- import type WrapperSubscribableDataset from "./WrapperSubscribableDataset";
4
+ import { createSubscribableDatasetFactory } from "./createSubscribableDataset";
5
+ import type { ISubscribableDataset } from "./types";
6
6
 
7
7
  /**
8
8
  * Creates a SubscribableDataset with a string input that could be JSON-LD, Turtle, N-Triples, TriG, RDF*, or N3.
@@ -15,12 +15,12 @@ import type WrapperSubscribableDataset from "./WrapperSubscribableDataset";
15
15
  * }
16
16
  * @returns A dataset
17
17
  */
18
- export default async function createWrapperSubscribableDatasetDataserFromSerializedInput(
18
+ export async function createWrapperSubscribableDatasetFromSerializedInput(
19
19
  data: string,
20
20
  options?: ParserOptions,
21
- ): Promise<WrapperSubscribableDataset<Quad>> {
22
- const datasetFactory = createWrapperSubscribableDatasetFactory();
23
- return createDatasetFromSerializedInput<WrapperSubscribableDataset<Quad>>(
21
+ ): Promise<ISubscribableDataset<Quad>> {
22
+ const datasetFactory = createSubscribableDatasetFactory();
23
+ return createDatasetFromSerializedInput<ISubscribableDataset<Quad>>(
24
24
  datasetFactory,
25
25
  data,
26
26
  options,
package/src/index.ts CHANGED
@@ -1,10 +1,9 @@
1
- export {
2
- default as createSubscribableDataset,
3
- createWrapperSubscribableDatasetFactory as createSubscribableDatasetFactory,
4
- } from "./createWrapperSubscribableDataset";
5
- export { default as serializedToSubscribableDataset } from "./createWrapperSubscribableDatasetFromSerializedInput";
6
- export { default as ProxyTransactionalDataset } from "./ProxyTransactionalDataset";
7
- export { default as WrapperSubscribableDataset } from "./WrapperSubscribableDataset";
8
- export { default as WrapperSubscribableDatasetFactory } from "./WrapperSubscribableDatasetFactory";
1
+ export * from "./createSubscribableDataset";
2
+ export { createWrapperSubscribableDatasetFromSerializedInput as serializedToSubscribableDataset } from "./createSubscribableDatasetFromSerializedInput";
3
+ export * from "./TransactionDataset";
4
+ export * from "./TransactionDatasetFactory";
5
+ export * from "./SubscribableDataset";
6
+ export * from "./SubscribableDatasetFactory";
9
7
  export * from "./types";
10
8
  export * from "./mergeDatasetChanges";
9
+ export * from "./util";
package/src/types.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { DatasetChanges, QuadMatch } from "@ldo/rdf-utils";
2
- import type { Dataset, BaseQuad } from "@rdfjs/types";
2
+ import type { Dataset, BaseQuad, DatasetFactory } from "@rdfjs/types";
3
3
 
4
4
  /**
5
5
  * An event listeners for nodes
@@ -11,28 +11,29 @@ export type nodeEventListener<InAndOutQuad extends BaseQuad = BaseQuad> = (
11
11
  /**
12
12
  * Adds the bulk method for add and remove
13
13
  */
14
- export interface BulkEditableDataset<InAndOutQuad extends BaseQuad = BaseQuad>
14
+ export interface IBulkEditableDataset<InAndOutQuad extends BaseQuad = BaseQuad>
15
15
  extends Dataset<InAndOutQuad, InAndOutQuad> {
16
16
  bulk(changes: DatasetChanges<InAndOutQuad>): this;
17
17
  }
18
18
 
19
19
  /**
20
- * A dataset that allows you to modify the dataset and
20
+ * Factory for creating SubscribableDatasets
21
21
  */
22
- export interface TransactionalDataset<InAndOutQuad extends BaseQuad = BaseQuad>
23
- extends Dataset<InAndOutQuad, InAndOutQuad> {
24
- rollback(): void;
25
- commit(): void;
26
- getChanges(): DatasetChanges<InAndOutQuad>;
27
- }
22
+ export type ISubscribableDatasetFactory<
23
+ InAndOutQuad extends BaseQuad = BaseQuad,
24
+ > = DatasetFactory<
25
+ InAndOutQuad,
26
+ InAndOutQuad,
27
+ ISubscribableDataset<InAndOutQuad>
28
+ >;
28
29
 
29
30
  /**
30
31
  * Dataset that allows developers to subscribe to a sepecific term and be alerted
31
32
  * if a quad is added or removed containing that term. It's methods follow the
32
33
  * EventEmitter interface except take in namedNodes as keys.
33
34
  */
34
- export interface SubscribableDataset<InAndOutQuad extends BaseQuad = BaseQuad>
35
- extends BulkEditableDataset<InAndOutQuad> {
35
+ export interface ISubscribableDataset<InAndOutQuad extends BaseQuad = BaseQuad>
36
+ extends IBulkEditableDataset<InAndOutQuad> {
36
37
  /**
37
38
  * Alias for emitter.on(eventName, listener).
38
39
  * @param eventName
@@ -140,5 +141,27 @@ export interface SubscribableDataset<InAndOutQuad extends BaseQuad = BaseQuad>
140
141
  /**
141
142
  * Returns a transactional dataset that will update this dataset when its transaction is committed.
142
143
  */
143
- startTransaction(): TransactionalDataset<InAndOutQuad>;
144
+ startTransaction(): ITransactionDataset<InAndOutQuad>;
145
+ }
146
+
147
+ /**
148
+ * Creates a TransactionDataset
149
+ */
150
+ export interface ITransactionDatasetFactory<
151
+ InAndOutQuad extends BaseQuad = BaseQuad,
152
+ > {
153
+ transactionDataset(
154
+ parent: Dataset<InAndOutQuad, InAndOutQuad>,
155
+ ): ITransactionDataset<InAndOutQuad>;
156
+ }
157
+
158
+ /**
159
+ * A dataset that allows you to modify the dataset and
160
+ */
161
+ export interface ITransactionDataset<InAndOutQuad extends BaseQuad = BaseQuad>
162
+ extends ISubscribableDataset<InAndOutQuad> {
163
+ readonly parentDataset: Dataset<InAndOutQuad, InAndOutQuad>;
164
+ rollback(): void;
165
+ commit(): void;
166
+ getChanges(): DatasetChanges<InAndOutQuad>;
144
167
  }
package/src/util.ts ADDED
@@ -0,0 +1,27 @@
1
+ import type { DatasetChanges } from "@ldo/rdf-utils";
2
+ import type { BaseQuad, Dataset } from "@rdfjs/types";
3
+ import type { IBulkEditableDataset } from "./types";
4
+
5
+ /**
6
+ * Performs a bulk update for a dataset even if it doesn't have a bulk method.
7
+ * @param dataset - the input dataset
8
+ * @param datasetChanges - changes to be applied
9
+ */
10
+ export function updateDatasetInBulk<InAndOutQuad extends BaseQuad = BaseQuad>(
11
+ dataset: Dataset<InAndOutQuad>,
12
+ datasetChanges: DatasetChanges<InAndOutQuad>,
13
+ ) {
14
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
15
+ if ((dataset as any).bulk) {
16
+ (dataset as IBulkEditableDataset<InAndOutQuad>).bulk(datasetChanges);
17
+ } else {
18
+ if (datasetChanges.added) {
19
+ dataset.addAll(datasetChanges.added);
20
+ }
21
+ if (datasetChanges.removed) {
22
+ datasetChanges.removed.forEach((curQuad) => {
23
+ dataset.delete(curQuad);
24
+ });
25
+ }
26
+ }
27
+ }
@@ -1,27 +0,0 @@
1
- import type { DatasetFactory, BaseQuad, Dataset } from "@rdfjs/types";
2
- import WrapperSubscribableDataset from "./WrapperSubscribableDataset";
3
-
4
- /**
5
- * A DatasetFactory that returns a WrapperSubscribableDataset given a generic DatasetFactory.
6
- */
7
- export default class WrapperSubscribableDatasetFactory<
8
- InAndOutQuad extends BaseQuad = BaseQuad,
9
- > implements DatasetFactory<InAndOutQuad, InAndOutQuad>
10
- {
11
- private datasetFactory: DatasetFactory<InAndOutQuad, InAndOutQuad>;
12
- constructor(datasetFactory: DatasetFactory<InAndOutQuad, InAndOutQuad>) {
13
- this.datasetFactory = datasetFactory;
14
- }
15
-
16
- dataset(
17
- quads?: Dataset<InAndOutQuad, InAndOutQuad> | InAndOutQuad[],
18
- ): WrapperSubscribableDataset<InAndOutQuad> {
19
- // Typings are wrong
20
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
21
- // @ts-ignore
22
- return new WrapperSubscribableDataset(
23
- this.datasetFactory,
24
- quads ? this.datasetFactory.dataset(quads) : undefined,
25
- );
26
- }
27
- }
@@ -1,30 +0,0 @@
1
- import type { Dataset, DatasetFactory, Quad } from "@rdfjs/types";
2
- import type { WrapperSubscribableDataset } from ".";
3
- import { createDataset } from "@ldo/dataset";
4
- import WrapperSubscribableDatasetFactory from "./WrapperSubscribableDatasetFactory";
5
-
6
- /**
7
- * Creates a dataset factory that generates a SubscribableDataset
8
- * @returns DatasetFactory for SubscribableDataset
9
- */
10
- export function createWrapperSubscribableDatasetFactory(): WrapperSubscribableDatasetFactory<Quad> {
11
- const datasetFactory: DatasetFactory<Quad> = {
12
- dataset: (quads?: Dataset<Quad> | Quad[]): Dataset<Quad> => {
13
- return createDataset(quads);
14
- },
15
- };
16
- return new WrapperSubscribableDatasetFactory(datasetFactory);
17
- }
18
-
19
- /**
20
- * Creates a SubscribableDataset
21
- * @param quads: A dataset or array of Quads to initialize the dataset.
22
- * @returns Dataset
23
- */
24
- export default function createWrapperSubscribableDataset(
25
- quads?: Dataset<Quad> | Quad[],
26
- ): WrapperSubscribableDataset<Quad> {
27
- const wrapperSubscribableDatasetFactory =
28
- createWrapperSubscribableDatasetFactory();
29
- return wrapperSubscribableDatasetFactory.dataset(quads);
30
- }