@ldo/subscribable-dataset 0.0.1-alpha.18 → 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 (37) hide show
  1. package/dist/SubscribableDataset.d.ts +37 -0
  2. package/dist/SubscribableDataset.js +180 -0
  3. package/dist/SubscribableDataset.js.map +1 -0
  4. package/dist/SubscribableDatasetFactory.d.ts +9 -0
  5. package/dist/SubscribableDatasetFactory.js +15 -0
  6. package/dist/SubscribableDatasetFactory.js.map +1 -0
  7. package/dist/TransactionDataset.d.ts +25 -0
  8. package/dist/TransactionDataset.js +124 -0
  9. package/dist/TransactionDataset.js.map +1 -0
  10. package/dist/TransactionDatasetFactory.d.ts +9 -0
  11. package/dist/TransactionDatasetFactory.js +15 -0
  12. package/dist/TransactionDatasetFactory.js.map +1 -0
  13. package/dist/createSubscribableDataset.d.ts +5 -0
  14. package/dist/createSubscribableDataset.js +25 -0
  15. package/dist/createSubscribableDataset.js.map +1 -0
  16. package/dist/createSubscribableDatasetFromSerializedInput.d.ts +4 -0
  17. package/dist/createSubscribableDatasetFromSerializedInput.js +11 -0
  18. package/dist/createSubscribableDatasetFromSerializedInput.js.map +1 -0
  19. package/dist/index.d.ts +7 -5
  20. package/dist/index.js +9 -9
  21. package/dist/index.js.map +1 -1
  22. package/dist/types.d.ts +14 -9
  23. package/dist/util.d.ts +3 -0
  24. package/dist/util.js +20 -0
  25. package/dist/util.js.map +1 -0
  26. package/package.json +2 -2
  27. package/src/{WrapperSubscribableDataset.ts → SubscribableDataset.ts} +40 -231
  28. package/src/SubscribableDatasetFactory.ts +31 -0
  29. package/src/{ProxyTransactionalDataset.ts → TransactionDataset.ts} +10 -39
  30. package/src/TransactionDatasetFactory.ts +27 -0
  31. package/src/createSubscribableDataset.ts +46 -0
  32. package/src/{createWrapperSubscribableDatasetFromSerializedInput.ts → createSubscribableDatasetFromSerializedInput.ts} +5 -5
  33. package/src/index.ts +7 -8
  34. package/src/types.ts +35 -12
  35. package/src/util.ts +27 -0
  36. package/src/WrapperSubscribableDatasetFactory.ts +0 -27
  37. package/src/createWrapperSubscribableDataset.ts +0 -30
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 BulkEditableDataset<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 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 "./WrapperSubscribableDataset";
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 function createWrapperSubscribableDataset(
25
- quads?: Dataset<Quad> | Quad[],
26
- ): WrapperSubscribableDataset<Quad> {
27
- const wrapperSubscribableDatasetFactory =
28
- createWrapperSubscribableDatasetFactory();
29
- return wrapperSubscribableDatasetFactory.dataset(quads);
30
- }