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

package/docs/changelog.md

@@ -1,11 +1,279 @@
-# @twin.org/federated-catalogue-service - Changelog
+# Changelog
 
-## [0.0.3-next.2](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.1...federated-catalogue-service-v0.0.3-next.2) (2025-11-28)
+## [0.0.3-next.21](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.20...federated-catalogue-service-v0.0.3-next.21) (2026-06-12)
+
+
+### Bug Fixes
+
+* bake organization id into object-form accessService endpoint URLs ([#88](https://github.com/iotaledger/twin-federated-catalogue/issues/88)) ([155d86d](https://github.com/iotaledger/twin-federated-catalogue/commit/155d86de7c416abf3c17a38fc3ac5969fd36449c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.20 to 0.0.3-next.21
+
+## [0.0.3-next.20](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.19...federated-catalogue-service-v0.0.3-next.20) (2026-06-11)
+
+
+### Features
+
+* organization identifiers ([#84](https://github.com/iotaledger/twin-federated-catalogue/issues/84)) ([1e02971](https://github.com/iotaledger/twin-federated-catalogue/commit/1e02971a12e40bd20a0034ee1de0988a689d3dc8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.19 to 0.0.3-next.20
+
+## [0.0.3-next.19](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.18...federated-catalogue-service-v0.0.3-next.19) (2026-06-08)
+
+
+### Features
+
+* replace sync storage with shared DB and trust-token auth ([#79](https://github.com/iotaledger/twin-federated-catalogue/issues/79)) ([3a07f02](https://github.com/iotaledger/twin-federated-catalogue/commit/3a07f02aba8d6f3540a23e5c2cebc7b0e579ef30))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.18 to 0.0.3-next.19
+
+## [0.0.3-next.18](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.17...federated-catalogue-service-v0.0.3-next.18) (2026-06-01)
+
+
+### Bug Fixes
+
+* allow CatalogRequestMessage without filter ([#72](https://github.com/iotaledger/twin-federated-catalogue/issues/72)) ([477343d](https://github.com/iotaledger/twin-federated-catalogue/commit/477343dd590150626c417a16705d5fa8bb96838f))
+* stop double-converting filter results in query, preserving dataset [@id](https://github.com/id) ([#75](https://github.com/iotaledger/twin-federated-catalogue/issues/75)) ([f071eda](https://github.com/iotaledger/twin-federated-catalogue/commit/f071eda0f5fc35270570cac7bd106b2bdf02e6e2))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.17 to 0.0.3-next.18
+
+## [0.0.3-next.17](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.16...federated-catalogue-service-v0.0.3-next.17) (2026-05-20)
+
+
+### Features
+
+* update dependencies ([9534767](https://github.com/iotaledger/twin-federated-catalogue/commit/9534767b6aa85468ab5094512886246814edce9a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.16 to 0.0.3-next.17
+
+## [0.0.3-next.16](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.15...federated-catalogue-service-v0.0.3-next.16) (2026-05-12)
+
+
+### Features
+
+* typescript 6 update ([ead042d](https://github.com/iotaledger/twin-federated-catalogue/commit/ead042d09f4e6b03a2db46ace2ea95d197f0f4b0))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.15 to 0.0.3-next.16
+
+## [0.0.3-next.15](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.14...federated-catalogue-service-v0.0.3-next.15) (2026-05-08)
+
+
+### Features
+
+* publish encrypted `twin:tenantToken` per dataset ([#64](https://github.com/iotaledger/twin-federated-catalogue/issues/64)) ([77e4517](https://github.com/iotaledger/twin-federated-catalogue/commit/77e451782ad8b227b91b4cc8a97bdd6eb90881b6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.14 to 0.0.3-next.15
+
+## [0.0.3-next.14](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.13...federated-catalogue-service-v0.0.3-next.14) (2026-03-20)
+
+
+### Features
+
+* update to use new schemas ([41dae8d](https://github.com/iotaledger/twin-federated-catalogue/commit/41dae8d401dcea830b435aa35590e9c90a11eb1f))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.13 to 0.0.3-next.14
+
+## [0.0.3-next.13](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.12...federated-catalogue-service-v0.0.3-next.13) (2026-03-12)
+
+
+### Features
+
+* update DataspaceProtocolHelper.validate usage ([49eda69](https://github.com/iotaledger/twin-federated-catalogue/commit/49eda69073d0ef4cd88c0e01f5eee8a78e4195e4))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.12 to 0.0.3-next.13
+
+## [0.0.3-next.12](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.11...federated-catalogue-service-v0.0.3-next.12) (2026-03-06)
+
+
+### Features
+
+* add [@id](https://github.com/id) to policy example in federated catalogue route definition ([#58](https://github.com/iotaledger/twin-federated-catalogue/issues/58)) ([c854f16](https://github.com/iotaledger/twin-federated-catalogue/commit/c854f16eac91d23468134bb46e8a2c7a74e854af))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.11 to 0.0.3-next.12
+
+## [0.0.3-next.11](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.10...federated-catalogue-service-v0.0.3-next.11) (2026-03-05)
+
+
+### Bug Fixes
+
+* consistent naming of entity storage component in config ([1c1cb27](https://github.com/iotaledger/twin-federated-catalogue/commit/1c1cb274c5bca8cbe5f1da71b3dd4ddf52487001))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.10 to 0.0.3-next.11
+
+## [0.0.3-next.10](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.9...federated-catalogue-service-v0.0.3-next.10) (2026-02-25)
+
+
+### Features
+
+* update json-ld patterns ([172aff0](https://github.com/iotaledger/twin-federated-catalogue/commit/172aff07d0f0b780f72d1be3a4896bbf12f6173a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.9 to 0.0.3-next.10
+
+## [0.0.3-next.9](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.8...federated-catalogue-service-v0.0.3-next.9) (2026-02-12)
+
+
+### Features
+
+* integrate synchronised storage with federated catalogue ([#53](https://github.com/iotaledger/twin-federated-catalogue/issues/53)) ([d1cdf06](https://github.com/iotaledger/twin-federated-catalogue/commit/d1cdf066adff8fb2266ccaaebcf57da391e03d3f))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.8 to 0.0.3-next.9
+
+## [0.0.3-next.8](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.7...federated-catalogue-service-v0.0.3-next.8) (2026-01-26)
+
+
+### Features
+
+* use new hosting url for cursor links ([e42c934](https://github.com/iotaledger/twin-federated-catalogue/commit/e42c934b9c8748ec5bdd4803c1cdc05c82ccace8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.7 to 0.0.3-next.8
+
+## [0.0.3-next.7](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.6...federated-catalogue-service-v0.0.3-next.7) (2026-01-22)
+
+
+### Bug Fixes
+
+* context usage ([cd51790](https://github.com/iotaledger/twin-federated-catalogue/commit/cd51790ef97e14d21e89ef668b98477c163856bb))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.6 to 0.0.3-next.7
+
+## [0.0.3-next.6](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.5...federated-catalogue-service-v0.0.3-next.6) (2026-01-20)
+
+
+### Bug Fixes
+
+* transform GuardError to CatalogError for DS Protocol compliance ([#49](https://github.com/iotaledger/twin-federated-catalogue/issues/49)) ([d0f1090](https://github.com/iotaledger/twin-federated-catalogue/commit/d0f10900c251b9abc18e58c90562c393c3265727))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.5 to 0.0.3-next.6
+
+## [0.0.3-next.5](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.4...federated-catalogue-service-v0.0.3-next.5) (2026-01-15)
+
+
+### Bug Fixes
+
+* linting ([df034b1](https://github.com/iotaledger/twin-federated-catalogue/commit/df034b11e78fed68f64dfe9406809d2365acdfb8))
+* pagination and ld context ([#45](https://github.com/iotaledger/twin-federated-catalogue/issues/45)) ([e36f096](https://github.com/iotaledger/twin-federated-catalogue/commit/e36f096aa4fdc61eb5b929a0fc4403247dbd41ce))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.4 to 0.0.3-next.5
+
+## [0.0.3-next.4](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.3...federated-catalogue-service-v0.0.3-next.4) (2026-01-06)
+
+
+### Features
+
+* updates standards dependencies ([62f5d9c](https://github.com/iotaledger/twin-federated-catalogue/commit/62f5d9c6180bc27497ac43624ffd714e7ce65ce6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.3 to 0.0.3-next.4
+
+## [0.0.3-next.3](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.2...federated-catalogue-service-v0.0.3-next.3) (2025-11-28)
+
+
+### Bug Fixes
+
+* service logging constructor type ([35e63cc](https://github.com/iotaledger/twin-federated-catalogue/commit/35e63cc6a46769b32c817f43157233d9f05346da))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/federated-catalogue-models bumped from 0.0.3-next.2 to 0.0.3-next.3
+
+## [0.0.3-next.2](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-service-v0.0.3-next.1...federated-catalogue-service-v0.0.3-next.2) (2025-11-28)
 
 
 ### Features
 
-* implement Dataspace Protocol federated catalogue ([#36](https://github.com/twinfoundation/federated-catalogue/issues/36)) ([4765aba](https://github.com/twinfoundation/federated-catalogue/commit/4765aba4485ef8ad61e7ec1affbf0e454d974d36))
+* implement Dataspace Protocol federated catalogue ([#36](https://github.com/iotaledger/twin-federated-catalogue/issues/36)) ([4765aba](https://github.com/iotaledger/twin-federated-catalogue/commit/4765aba4485ef8ad61e7ec1affbf0e454d974d36))
 
 
 ### Dependencies

package/docs/examples.md

@@ -1 +1,126 @@
-# @twin.org/federated-catalogue-service - Examples
+# Federated Catalogue Service Examples
+
+These snippets show a realistic service flow for bootstrapping, storing and querying datasets, then removing records when lifecycle events require cleanup.
+
+## FederatedCatalogueService
+
+```typescript
+import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
+import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
+import { FederatedCatalogueService } from '@twin.org/federated-catalogue-service';
+
+EntityStorageConnectorFactory.register('dataset', () => new MemoryEntityStorageConnector());
+
+const service = new FederatedCatalogueService({
+  datasetEntityStorageType: 'dataset'
+});
+
+console.log(service.className() === FederatedCatalogueService.CLASS_NAME); // true
+```
+
+```typescript
+import { ContextIdKeys, ContextIdStore } from '@twin.org/context';
+import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
+import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
+import { FederatedCatalogueService } from '@twin.org/federated-catalogue-service';
+
+EntityStorageConnectorFactory.register('dataset', () => new MemoryEntityStorageConnector());
+
+const service = new FederatedCatalogueService({
+  datasetEntityStorageType: 'dataset'
+});
+
+await ContextIdStore.set('request-1', {
+  [ContextIdKeys.Node]: 'did:web:node.example',
+  [ContextIdKeys.Organization]: 'did:web:publisher.example'
+});
+
+await service.start();
+
+await service.set({
+  '@context': ['https://w3id.org/dspace/2024/1/context.json', 'https://www.w3.org/ns/dcat3.jsonld'],
+  '@type': 'dcat:Dataset',
+  '@id': 'urn:dataset:air-quality-2026',
+  'dcterms:identifier': 'urn:dataset:air-quality-2026',
+  'dcterms:publisher': {
+    '@id': 'did:web:publisher.example'
+  },
+  'dcterms:title': {
+    '@value': 'Air quality readings'
+  }
+});
+
+const dataset = await service.get('urn:dataset:air-quality-2026');
+
+console.log(dataset['@id']); // urn:dataset:air-quality-2026
+```
+
+```typescript
+import { ContextIdKeys, ContextIdStore } from '@twin.org/context';
+import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
+import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
+import { FederatedCatalogueService } from '@twin.org/federated-catalogue-service';
+
+EntityStorageConnectorFactory.register('dataset', () => new MemoryEntityStorageConnector());
+
+const service = new FederatedCatalogueService({
+  datasetEntityStorageType: 'dataset'
+});
+
+await ContextIdStore.set('request-2', {
+  [ContextIdKeys.Node]: 'did:web:node.example',
+  [ContextIdKeys.Organization]: 'did:web:publisher.example'
+});
+
+await service.start();
+
+const queryResult = await service.query(
+  [
+    {
+      '@type': 'FilterByMetadata',
+      'dcterms:publisher': {
+        '@id': 'did:web:publisher.example'
+      }
+    }
+  ],
+  'cursor-0',
+  20
+);
+
+console.log(queryResult.result['@type']); // Catalog
+console.log(typeof queryResult.cursor === 'string' || queryResult.cursor === undefined); // true
+```
+
+```typescript
+import { MemoryEntityStorageConnector } from '@twin.org/entity-storage-connector-memory';
+import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
+import { FederatedCatalogueService } from '@twin.org/federated-catalogue-service';
+
+EntityStorageConnectorFactory.register('dataset', () => new MemoryEntityStorageConnector());
+
+const service = new FederatedCatalogueService({
+  datasetEntityStorageType: 'dataset'
+});
+
+await service.remove('urn:dataset:air-quality-2026');
+
+console.log('removed'.toUpperCase()); // REMOVED
+```
+
+## Dataset
+
+```typescript
+import { Dataset } from '@twin.org/federated-catalogue-service';
+
+const datasetEntity = new Dataset();
+datasetEntity.id = 'urn:dataset:air-quality-2026';
+datasetEntity.nodeIdentity = 'did:web:node.example';
+datasetEntity.dateModified = '2026-03-10T12:00:00.000Z';
+datasetEntity['@context'] = ['https://www.w3.org/ns/dcat3.jsonld'];
+datasetEntity['@type'] = 'dcat:Dataset';
+datasetEntity['dcterms:title'] = { '@value': 'Air quality readings' };
+datasetEntity['dcterms:publisher'] = { '@id': 'did:web:publisher.example' };
+
+console.log(datasetEntity.id); // urn:dataset:air-quality-2026
+console.log(datasetEntity['@type']); // dcat:Dataset
+```