@twin.org/federated-catalogue-service 0.0.3-next.2 → 0.0.3-next.21

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/README.md +1 -1
  2. package/dist/es/entities/dataset.js +12 -4
  3. package/dist/es/entities/dataset.js.map +1 -1
  4. package/dist/es/federatedCatalogueRoutes.js +241 -53
  5. package/dist/es/federatedCatalogueRoutes.js.map +1 -1
  6. package/dist/es/index.js +2 -0
  7. package/dist/es/index.js.map +1 -1
  8. package/dist/es/models/IFederatedCatalogueServiceConfig.js +4 -0
  9. package/dist/es/models/IFederatedCatalogueServiceConfig.js.map +1 -0
  10. package/dist/es/models/IFederatedCatalogueServiceConstructorOptions.js.map +1 -1
  11. package/dist/es/services/federatedCatalogueService.js +344 -131
  12. package/dist/es/services/federatedCatalogueService.js.map +1 -1
  13. package/dist/es/utils/catalogErrorUtils.js +49 -0
  14. package/dist/es/utils/catalogErrorUtils.js.map +1 -0
  15. package/dist/es/utils/datasetConverters.js +23 -10
  16. package/dist/es/utils/datasetConverters.js.map +1 -1
  17. package/dist/types/entities/dataset.d.ts +37 -33
  18. package/dist/types/index.d.ts +2 -0
  19. package/dist/types/models/IFederatedCatalogueServiceConfig.d.ts +5 -0
  20. package/dist/types/models/IFederatedCatalogueServiceConstructorOptions.d.ts +14 -4
  21. package/dist/types/services/federatedCatalogueService.d.ts +37 -21
  22. package/dist/types/utils/catalogErrorUtils.d.ts +15 -0
  23. package/dist/types/utils/datasetConverters.d.ts +10 -10
  24. package/docs/changelog.md +271 -3
  25. package/docs/examples.md +126 -1
  26. package/docs/open-api/spec.json +256 -2513
  27. package/docs/reference/classes/Dataset.md +70 -62
  28. package/docs/reference/classes/FederatedCatalogueService.md +77 -40
  29. package/docs/reference/functions/datasetEntityToModel.md +7 -7
  30. package/docs/reference/functions/datasetModelToEntity.md +11 -6
  31. package/docs/reference/functions/transformErrorToStatusCode.md +19 -0
  32. package/docs/reference/functions/transformToCatalogError.md +20 -0
  33. package/docs/reference/index.md +3 -0
  34. package/docs/reference/interfaces/IFederatedCatalogueServiceConfig.md +3 -0
  35. package/docs/reference/interfaces/IFederatedCatalogueServiceConstructorOptions.md +33 -5
  36. package/locales/en.json +12 -6
  37. package/package.json +10 -5
@@ -4,16 +4,44 @@ Options for the FederatedCatalogueService constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### datasetStorageConnectorType?
7
+ ### datasetEntityStorageType? {#datasetentitystoragetype}
8
8
 
9
- > `optional` **datasetStorageConnectorType**: `string`
9
+ > `optional` **datasetEntityStorageType?**: `string`
10
10
 
11
- The type of the entity storage connector for datasets.
11
+ The entity storage for datasets.
12
+
13
+ #### Default
14
+
15
+ ```ts
16
+ dataset
17
+ ```
12
18
 
13
19
  ***
14
20
 
15
- ### loggingComponent?
21
+ ### loggingComponentType? {#loggingcomponenttype}
16
22
 
17
- > `optional` **loggingComponent**: `ILoggingComponent`
23
+ > `optional` **loggingComponentType?**: `string`
18
24
 
19
25
  The logging component for the service.
26
+
27
+ ***
28
+
29
+ ### trustComponentType? {#trustcomponenttype}
30
+
31
+ > `optional` **trustComponentType?**: `string`
32
+
33
+ Trust component type for trust verification.
34
+
35
+ #### Default
36
+
37
+ ```ts
38
+ trust
39
+ ```
40
+
41
+ ***
42
+
43
+ ### config? {#config}
44
+
45
+ > `optional` **config?**: [`IFederatedCatalogueServiceConfig`](IFederatedCatalogueServiceConfig.md)
46
+
47
+ Configuration for the federated catalogue service.
package/locales/en.json CHANGED
@@ -2,18 +2,24 @@
2
2
  "error": {
3
3
  "federatedCatalogueService": {
4
4
  "datasetNotFound": "Dataset with ID \"{notFoundId}\" not found in the catalogue",
5
- "filterIndexCreationFailed": "Failed to create filter index for dataset \"{dataSetId}\" using filter \"{filterType}\"",
6
- "multipleFiltersNotSupported": "Multiple filters are not supported in a single query"
5
+ "datasetIdInvalidUri": "Dataset @id \"{datasetId}\" must be a valid URI (URN or URL) per DS Protocol",
6
+ "datasetMissingPublisher": "Dataset \"{datasetId}\" is missing required dcterms:publisher property (needed for participant identification)",
7
+ "filterIndexCreationFailed": "Failed to create filter index for dataset \"{datasetId}\" using filter \"{filterType}\"",
8
+ "multipleFiltersNotSupported": "Multiple filters are not supported in a single query",
9
+ "filterMustBeArray": "Filter must be an array per DS Protocol specification",
10
+ "noDatasetsFound": "No datasets found in the catalogue",
11
+ "datasetOwnerMismatch": "Dataset \"{datasetId}\" already exists and is owned by a different identity",
12
+ "datasetRemoveNotOwner": "Dataset \"{datasetId}\" can only be removed by its owner"
7
13
  }
8
14
  },
9
15
  "info": {
10
16
  "federatedCatalogueService": {
11
- "datasetRetrieve": "Retrieving dataset \"{dataSetId}\" from catalogue",
12
- "datasetSet": "Storing dataset \"{dataSetId}\" in catalogue",
13
- "datasetRemove": "Removing dataset \"{dataSetId}\" from catalogue",
17
+ "datasetRetrieve": "Retrieving dataset \"{datasetId}\" from catalogue",
18
+ "datasetSet": "Storing dataset \"{datasetId}\" in catalogue",
19
+ "datasetRemove": "Removing dataset \"{datasetId}\" from catalogue",
14
20
  "catalogQuery": "Executing catalogue query",
15
21
  "catalogQueryComplete": "Catalogue query complete, found {resultCount} results",
16
- "filterIndexPersisted": "Filter indexes persisted for dataset \"{dataSetId}\" using filter \"{filterType}\", {indexCount} entries"
22
+ "filterIndexPersisted": "Filter indexes persisted for dataset \"{datasetId}\" using filter \"{filterType}\", {indexCount} entries"
17
23
  }
18
24
  }
19
25
  }
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@twin.org/federated-catalogue-service",
3
- "version": "0.0.3-next.2",
3
+ "version": "0.0.3-next.21",
4
4
  "description": "Federated Catalogue contract implementation and REST endpoint definitions",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "https://github.com/twinfoundation/federated-catalogue.git",
7
+ "url": "git+https://github.com/iotaledger/twin-federated-catalogue.git",
8
8
  "directory": "packages/federated-catalogue-service"
9
9
  },
10
- "author": "jose.cantera@iota.org",
10
+ "author": "cornel.filip@iota.org",
11
11
  "license": "Apache-2.0",
12
12
  "type": "module",
13
13
  "engines": {
@@ -15,16 +15,21 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@twin.org/api-models": "next",
18
+ "@twin.org/context": "next",
18
19
  "@twin.org/core": "next",
19
20
  "@twin.org/crypto": "next",
20
21
  "@twin.org/data-json-ld": "next",
21
22
  "@twin.org/entity": "next",
22
23
  "@twin.org/entity-storage-models": "next",
23
- "@twin.org/federated-catalogue-models": "0.0.3-next.2",
24
+ "@twin.org/federated-catalogue-models": "0.0.3-next.21",
24
25
  "@twin.org/logging-models": "next",
25
26
  "@twin.org/nameof": "next",
26
27
  "@twin.org/standards-dataspace-protocol": "next",
28
+ "@twin.org/standards-dublin-core": "next",
29
+ "@twin.org/standards-foaf": "next",
27
30
  "@twin.org/standards-w3c-dcat": "next",
31
+ "@twin.org/trust-models": "next",
32
+ "@twin.org/vault-models": "next",
28
33
  "@twin.org/web": "next"
29
34
  },
30
35
  "main": "./dist/es/index.js",
@@ -55,7 +60,7 @@
55
60
  "business-logic"
56
61
  ],
57
62
  "bugs": {
58
- "url": "git+https://github.com/twinfoundation/federated-catalogue/issues"
63
+ "url": "git+https://github.com/iotaledger/twin-federated-catalogue/issues"
59
64
  },
60
65
  "homepage": "https://twindev.org"
61
66
  }