@twin.org/federated-catalogue-rest-client 0.0.3-next.2 → 0.0.3-next.20

package/README.md

@@ -1,6 +1,6 @@
-# TWIN Federated Catalogue REST Client
+# Federated Catalogue REST Client
 
-Federated Catalogue contract implementation which can connect to REST endpoints.
+This package provides a client interface for calling catalogue REST endpoints and handling paged query and dataset retrieval workflows. It simplifies remote catalogue integration by encapsulating endpoint requests and response parsing.
 
 ## Installation
 

package/dist/es/federatedCatalogueRestClient.js

@@ -1,9 +1,9 @@
 // Copyright 2025 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 import { BaseRestClient } from "@twin.org/api-core";
-import { Guards, NotSupportedError } from "@twin.org/core";
-import { FederatedCatalogueContexts } from "@twin.org/federated-catalogue-models";
-import { CatalogTypes, DataspaceProtocolContexts } from "@twin.org/standards-dataspace-protocol";
+import { Coerce, Guards } from "@twin.org/core";
+import { DataspaceProtocolCatalogTypes, DataspaceProtocolContexts } from "@twin.org/standards-dataspace-protocol";
+import { HeaderHelper, HeaderTypes } from "@twin.org/web";
 /**
  * Client for performing federated catalogue operations through REST endpoints.
  */
@@ -26,32 +26,19 @@ export class FederatedCatalogueRestClient extends BaseRestClient {
     className() {
         return FederatedCatalogueRestClient.CLASS_NAME;
     }
-    /**
-     * Query the federated catalogue with an optional filter.
-     * @param filter Optional filter criteria for querying datasets.
-     * @returns The catalog containing matching datasets.
-     */
-    async query(filter) {
-        const response = await this.fetch("/request", "POST", {
-            body: {
-                "@context": [
-                    DataspaceProtocolContexts.ContextRoot,
-                    FederatedCatalogueContexts.ContextRoot
-                ],
-                "@type": CatalogTypes.CatalogRequestMessage,
-                filter
-            }
-        });
-        return response.body;
-    }
     /**
      * Retrieve a specific dataset by its unique identifier.
      * @param datasetId The unique identifier of the dataset.
-     * @returns The dataset if found.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
+     * @returns The dataset if found, or a CatalogError if not found or an error occurs.
      */
-    async get(datasetId) {
+    async get(datasetId, trustPayload) {
         Guards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, "datasetId", datasetId);
+        Guards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, "trustPayload", trustPayload);
         const response = await this.fetch("/datasets/:datasetId", "GET", {
+            headers: {
+                [HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)
+            },
             pathParams: {
                 datasetId
             }
@@ -61,24 +48,70 @@ export class FederatedCatalogueRestClient extends BaseRestClient {
     /**
      * Insert or update a dataset in the catalogue.
      * This method is internal and is not exposed via REST endpoints.
-     * @param dataSet The dataset to store.
-     * @returns Nothing.
+     * @param dataset The dataset to store.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
+     * @returns The unique identifier of the stored dataset, or a CatalogError if an error occurs.
      */
-    async set(dataSet) {
-        throw new NotSupportedError(FederatedCatalogueRestClient.CLASS_NAME, "notSupportedOnClient", {
-            methodName: "set"
+    async set(dataset, trustPayload) {
+        Guards.object(FederatedCatalogueRestClient.CLASS_NAME, "dataset", dataset);
+        Guards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, "trustPayload", trustPayload);
+        const response = await this.fetch("/datasets", "POST", {
+            headers: {
+                [HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)
+            },
+            body: dataset
         });
+        return response.headers?.[HeaderTypes.Location] ?? response.body ?? "";
     }
     /**
      * Remove a dataset from the catalogue by its unique identifier.
      * This method is internal and is not exposed via REST endpoints.
-     * @param dataSetId The unique identifier of the dataset to remove.
+     * @param datasetId The unique identifier of the dataset to remove.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
      * @returns Nothing.
      */
-    async remove(dataSetId) {
-        throw new NotSupportedError(FederatedCatalogueRestClient.CLASS_NAME, "notSupportedOnClient", {
-            methodName: "remove"
+    async remove(datasetId, trustPayload) {
+        Guards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, "datasetId", datasetId);
+        Guards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, "trustPayload", trustPayload);
+        const result = await this.fetch("/datasets/:datasetId", "DELETE", {
+            headers: {
+                [HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)
+            },
+            pathParams: {
+                datasetId
+            }
+        });
+        return result.body;
+    }
+    /**
+     * Query the federated catalogue with an optional filter.
+     * @param filter Optional filter criteria for querying datasets.
+     * @param cursor Optional cursor for pagination.
+     * @param limit Optional limit for pagination.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
+     * @returns The catalog containing matching datasets (or CatalogError if none found), with cursor if more pages exist.
+     */
+    async query(filter, cursor, limit, trustPayload) {
+        Guards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, "trustPayload", trustPayload);
+        const response = await this.fetch("/request", "POST", {
+            headers: {
+                [HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)
+            },
+            query: {
+                cursor,
+                limit: Coerce.string(limit)
+            },
+            body: {
+                "@context": [DataspaceProtocolContexts.Context],
+                "@type": DataspaceProtocolCatalogTypes.CatalogRequestMessage,
+                filter
+            }
         });
+        return {
+            result: response.body,
+            cursor: HeaderHelper.extractLinkHeaderRelation(response.headers?.[HeaderTypes.Link], "next")
+                ?.urlQueryParams?.cursor
+        };
     }
 }
 //# sourceMappingURL=federatedCatalogueRestClient.js.map

package/dist/es/federatedCatalogueRestClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"federatedCatalogueRestClient.js","sourceRoot":"","sources":["../../src/federatedCatalogueRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EACN,0BAA0B,EAM1B,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AAGjG;;GAEG;AACH,MAAM,OAAO,4BACZ,SAAQ,cAAc;IAGtB;;OAEG;IACI,MAAM,CAAU,UAAU,kCAAkD;IAEnF;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,iCAAyC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,4BAA4B,CAAC,UAAU,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK,CAAC,MAAkB;QACpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,UAAU,EACV,MAAM,EACN;YACC,IAAI,EAAE;gBACL,UAAU,EAAE;oBACX,yBAAyB,CAAC,WAAW;oBACrC,0BAA0B,CAAC,WAAW;iBACtC;gBACD,OAAO,EAAE,YAAY,CAAC,qBAAqB;gBAC3C,MAAM;aACN;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,SAAiB;QACjC,MAAM,CAAC,WAAW,CAAC,4BAA4B,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAE1F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,sBAAsB,EACtB,KAAK,EACL;YACC,UAAU,EAAE;gBACX,SAAS;aACT;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CAAC,OAAiB;QACjC,MAAM,IAAI,iBAAiB,CAAC,4BAA4B,CAAC,UAAU,EAAE,sBAAsB,EAAE;YAC5F,UAAU,EAAE,KAAK;SACjB,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,SAAiB;QACpC,MAAM,IAAI,iBAAiB,CAAC,4BAA4B,CAAC,UAAU,EAAE,sBAAsB,EAAE;YAC5F,UAAU,EAAE,QAAQ;SACpB,CAAC,CAAC;IACJ,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type { IBaseRestClientConfig } from \"@twin.org/api-models\";\nimport { Guards, NotSupportedError } from \"@twin.org/core\";\nimport {\n\tFederatedCatalogueContexts,\n\ttype IFederatedCatalogueComponent,\n\ttype ICatalogRequestRequest,\n\ttype ICatalogRequestResponse,\n\ttype IGetDatasetRequest,\n\ttype IGetDatasetResponse\n} from \"@twin.org/federated-catalogue-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { CatalogTypes, DataspaceProtocolContexts } from \"@twin.org/standards-dataspace-protocol\";\nimport type { ICatalog, IDataset } from \"@twin.org/standards-w3c-dcat\";\n\n/**\n * Client for performing federated catalogue operations through REST endpoints.\n */\nexport class FederatedCatalogueRestClient\n\textends BaseRestClient\n\timplements IFederatedCatalogueComponent\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<FederatedCatalogueRestClient>();\n\n\t/**\n\t * Create a new instance of FederatedCatalogueRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(nameof<FederatedCatalogueRestClient>(), config, \"federated-catalogue\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn FederatedCatalogueRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Query the federated catalogue with an optional filter.\n\t * @param filter Optional filter criteria for querying datasets.\n\t * @returns The catalog containing matching datasets.\n\t */\n\tpublic async query(filter?: unknown[]): Promise<ICatalog> {\n\t\tconst response = await this.fetch<ICatalogRequestRequest, ICatalogRequestResponse>(\n\t\t\t\"/request\",\n\t\t\t\"POST\",\n\t\t\t{\n\t\t\t\tbody: {\n\t\t\t\t\t\"@context\": [\n\t\t\t\t\t\tDataspaceProtocolContexts.ContextRoot,\n\t\t\t\t\t\tFederatedCatalogueContexts.ContextRoot\n\t\t\t\t\t],\n\t\t\t\t\t\"@type\": CatalogTypes.CatalogRequestMessage,\n\t\t\t\t\tfilter\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Retrieve a specific dataset by its unique identifier.\n\t * @param datasetId The unique identifier of the dataset.\n\t * @returns The dataset if found.\n\t */\n\tpublic async get(datasetId: string): Promise<IDataset> {\n\t\tGuards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, nameof(datasetId), datasetId);\n\n\t\tconst response = await this.fetch<IGetDatasetRequest, IGetDatasetResponse>(\n\t\t\t\"/datasets/:datasetId\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tdatasetId\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Insert or update a dataset in the catalogue.\n\t * This method is internal and is not exposed via REST endpoints.\n\t * @param dataSet The dataset to store.\n\t * @returns Nothing.\n\t */\n\tpublic async set(dataSet: IDataset): Promise<void> {\n\t\tthrow new NotSupportedError(FederatedCatalogueRestClient.CLASS_NAME, \"notSupportedOnClient\", {\n\t\t\tmethodName: \"set\"\n\t\t});\n\t}\n\n\t/**\n\t * Remove a dataset from the catalogue by its unique identifier.\n\t * This method is internal and is not exposed via REST endpoints.\n\t * @param dataSetId The unique identifier of the dataset to remove.\n\t * @returns Nothing.\n\t */\n\tpublic async remove(dataSetId: string): Promise<void> {\n\t\tthrow new NotSupportedError(FederatedCatalogueRestClient.CLASS_NAME, \"notSupportedOnClient\", {\n\t\t\tmethodName: \"remove\"\n\t\t});\n\t}\n}\n"]}
+{"version":3,"file":"federatedCatalogueRestClient.js","sourceRoot":"","sources":["../../src/federatedCatalogueRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAahD,OAAO,EACN,6BAA6B,EAC7B,yBAAyB,EAGzB,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,4BACZ,SAAQ,cAAc;IAGtB;;OAEG;IACI,MAAM,CAAU,UAAU,kCAAkD;IAEnF;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,iCAAyC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,4BAA4B,CAAC,UAAU,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACf,SAAiB,EACjB,YAAqB;QAErB,MAAM,CAAC,WAAW,CAAC,4BAA4B,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAC1F,MAAM,CAAC,WAAW,CAAC,4BAA4B,CAAC,UAAU,kBAAwB,YAAY,CAAC,CAAC;QAEhG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,sBAAsB,EACtB,KAAK,EACL;YACC,OAAO,EAAE;gBACR,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC;aACpE;YACD,UAAU,EAAE;gBACX,SAAS;aACT;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACf,OAAqB,EACrB,YAAqB;QAErB,MAAM,CAAC,MAAM,CAAe,4BAA4B,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAC/F,MAAM,CAAC,WAAW,CAAC,4BAA4B,CAAC,UAAU,kBAAwB,YAAY,CAAC,CAAC;QAEhG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,WAAW,EACX,MAAM,EACN;YACC,OAAO,EAAE;gBACR,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC;aACpE;YACD,IAAI,EAAE,OAAO;SACb,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAClB,SAAiB,EACjB,YAAqB;QAErB,MAAM,CAAC,WAAW,CAAC,4BAA4B,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAC1F,MAAM,CAAC,WAAW,CAAC,4BAA4B,CAAC,UAAU,kBAAwB,YAAY,CAAC,CAAC;QAEhG,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAC9B,sBAAsB,EACtB,QAAQ,EACR;YACC,OAAO,EAAE;gBACR,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC;aACpE;YACD,UAAU,EAAE;gBACX,SAAS;aACT;SACD,CACD,CAAC;QAEF,OAAO,MAAM,CAAC,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,KAAK,CACjB,MAA6B,EAC7B,MAA0B,EAC1B,KAAyB,EACzB,YAAqB;QAKrB,MAAM,CAAC,WAAW,CAAC,4BAA4B,CAAC,UAAU,kBAAwB,YAAY,CAAC,CAAC;QAChG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,UAAU,EACV,MAAM,EACN;YACC,OAAO,EAAE;gBACR,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC;aACpE;YACD,KAAK,EAAE;gBACN,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;YACD,IAAI,EAAE;gBACL,UAAU,EAAE,CAAC,yBAAyB,CAAC,OAAO,CAAC;gBAC/C,OAAO,EAAE,6BAA6B,CAAC,qBAAqB;gBAC5D,MAAM;aACN;SACD,CACD,CAAC;QAEF,OAAO;YACN,MAAM,EAAE,QAAQ,CAAC,IAAI;YACrB,MAAM,EAAE,YAAY,CAAC,yBAAyB,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;gBAC3F,EAAE,cAAc,EAAE,MAAM;SACzB,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type { IBaseRestClientConfig } from \"@twin.org/api-models\";\nimport { Coerce, Guards } from \"@twin.org/core\";\nimport type {\n\tICatalogRequestRequest,\n\tICatalogRequestResponse,\n\tIDatasetGetRequest,\n\tIDatasetGetResponse,\n\tIDatasetRemoveRequest,\n\tIDatasetRemoveResponse,\n\tIDatasetSetRequest,\n\tIDatasetSetResponse,\n\tIFederatedCatalogueComponent\n} from \"@twin.org/federated-catalogue-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport {\n\tDataspaceProtocolCatalogTypes,\n\tDataspaceProtocolContexts,\n\ttype IDataspaceProtocolCatalog,\n\ttype IDataspaceProtocolCatalogError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { IDcatDataset } from \"@twin.org/standards-w3c-dcat\";\nimport { HeaderHelper, HeaderTypes } from \"@twin.org/web\";\n\n/**\n * Client for performing federated catalogue operations through REST endpoints.\n */\nexport class FederatedCatalogueRestClient\n\textends BaseRestClient\n\timplements IFederatedCatalogueComponent\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<FederatedCatalogueRestClient>();\n\n\t/**\n\t * Create a new instance of FederatedCatalogueRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(nameof<FederatedCatalogueRestClient>(), config, \"federated-catalogue\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn FederatedCatalogueRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Retrieve a specific dataset by its unique identifier.\n\t * @param datasetId The unique identifier of the dataset.\n\t * @param trustPayload Optional payload for trust evaluation, if applicable.\n\t * @returns The dataset if found, or a CatalogError if not found or an error occurs.\n\t */\n\tpublic async get(\n\t\tdatasetId: string,\n\t\ttrustPayload: unknown\n\t): Promise<IDcatDataset | IDataspaceProtocolCatalogError> {\n\t\tGuards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, nameof(datasetId), datasetId);\n\t\tGuards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, nameof(trustPayload), trustPayload);\n\n\t\tconst response = await this.fetch<IDatasetGetRequest, IDatasetGetResponse>(\n\t\t\t\"/datasets/:datasetId\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t[HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)\n\t\t\t\t},\n\t\t\t\tpathParams: {\n\t\t\t\t\tdatasetId\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Insert or update a dataset in the catalogue.\n\t * This method is internal and is not exposed via REST endpoints.\n\t * @param dataset The dataset to store.\n\t * @param trustPayload Optional payload for trust evaluation, if applicable.\n\t * @returns The unique identifier of the stored dataset, or a CatalogError if an error occurs.\n\t */\n\tpublic async set(\n\t\tdataset: IDcatDataset,\n\t\ttrustPayload: unknown\n\t): Promise<string | IDataspaceProtocolCatalogError> {\n\t\tGuards.object<IDcatDataset>(FederatedCatalogueRestClient.CLASS_NAME, nameof(dataset), dataset);\n\t\tGuards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, nameof(trustPayload), trustPayload);\n\n\t\tconst response = await this.fetch<IDatasetSetRequest, IDatasetSetResponse>(\n\t\t\t\"/datasets\",\n\t\t\t\"POST\",\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t[HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)\n\t\t\t\t},\n\t\t\t\tbody: dataset\n\t\t\t}\n\t\t);\n\n\t\treturn response.headers?.[HeaderTypes.Location] ?? response.body ?? \"\";\n\t}\n\n\t/**\n\t * Remove a dataset from the catalogue by its unique identifier.\n\t * This method is internal and is not exposed via REST endpoints.\n\t * @param datasetId The unique identifier of the dataset to remove.\n\t * @param trustPayload Optional payload for trust evaluation, if applicable.\n\t * @returns Nothing.\n\t */\n\tpublic async remove(\n\t\tdatasetId: string,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolCatalogError | undefined> {\n\t\tGuards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, nameof(datasetId), datasetId);\n\t\tGuards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, nameof(trustPayload), trustPayload);\n\n\t\tconst result = await this.fetch<IDatasetRemoveRequest, IDatasetRemoveResponse>(\n\t\t\t\"/datasets/:datasetId\",\n\t\t\t\"DELETE\",\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t[HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)\n\t\t\t\t},\n\t\t\t\tpathParams: {\n\t\t\t\t\tdatasetId\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn result.body;\n\t}\n\n\t/**\n\t * Query the federated catalogue with an optional filter.\n\t * @param filter Optional filter criteria for querying datasets.\n\t * @param cursor Optional cursor for pagination.\n\t * @param limit Optional limit for pagination.\n\t * @param trustPayload Optional payload for trust evaluation, if applicable.\n\t * @returns The catalog containing matching datasets (or CatalogError if none found), with cursor if more pages exist.\n\t */\n\tpublic async query(\n\t\tfilter: unknown[] | undefined,\n\t\tcursor: string | undefined,\n\t\tlimit: number | undefined,\n\t\ttrustPayload: unknown\n\t): Promise<{\n\t\tresult: IDataspaceProtocolCatalog | IDataspaceProtocolCatalogError;\n\t\tcursor?: string;\n\t}> {\n\t\tGuards.stringValue(FederatedCatalogueRestClient.CLASS_NAME, nameof(trustPayload), trustPayload);\n\t\tconst response = await this.fetch<ICatalogRequestRequest, ICatalogRequestResponse>(\n\t\t\t\"/request\",\n\t\t\t\"POST\",\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t[HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)\n\t\t\t\t},\n\t\t\t\tquery: {\n\t\t\t\t\tcursor,\n\t\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t\t},\n\t\t\t\tbody: {\n\t\t\t\t\t\"@context\": [DataspaceProtocolContexts.Context],\n\t\t\t\t\t\"@type\": DataspaceProtocolCatalogTypes.CatalogRequestMessage,\n\t\t\t\t\tfilter\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn {\n\t\t\tresult: response.body,\n\t\t\tcursor: HeaderHelper.extractLinkHeaderRelation(response.headers?.[HeaderTypes.Link], \"next\")\n\t\t\t\t?.urlQueryParams?.cursor\n\t\t};\n\t}\n}\n"]}

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,cAAc,mCAAmC,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\nexport * from \"./federatedCatalogueRestClient.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,mCAAmC,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./federatedCatalogueRestClient.js\";\n"]}

package/dist/types/federatedCatalogueRestClient.d.ts

@@ -1,7 +1,8 @@
 import { BaseRestClient } from "@twin.org/api-core";
 import type { IBaseRestClientConfig } from "@twin.org/api-models";
-import { type IFederatedCatalogueComponent } from "@twin.org/federated-catalogue-models";
-import type { ICatalog, IDataset } from "@twin.org/standards-w3c-dcat";
+import type { IFederatedCatalogueComponent } from "@twin.org/federated-catalogue-models";
+import { type IDataspaceProtocolCatalog, type IDataspaceProtocolCatalogError } from "@twin.org/standards-dataspace-protocol";
+import type { IDcatDataset } from "@twin.org/standards-w3c-dcat";
 /**
  * Client for performing federated catalogue operations through REST endpoints.
  */
@@ -20,30 +21,39 @@ export declare class FederatedCatalogueRestClient extends BaseRestClient impleme
      * @returns The class name of the component.
      */
     className(): string;
-    /**
-     * Query the federated catalogue with an optional filter.
-     * @param filter Optional filter criteria for querying datasets.
-     * @returns The catalog containing matching datasets.
-     */
-    query(filter?: unknown[]): Promise<ICatalog>;
     /**
      * Retrieve a specific dataset by its unique identifier.
      * @param datasetId The unique identifier of the dataset.
-     * @returns The dataset if found.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
+     * @returns The dataset if found, or a CatalogError if not found or an error occurs.
      */
-    get(datasetId: string): Promise<IDataset>;
+    get(datasetId: string, trustPayload: unknown): Promise<IDcatDataset | IDataspaceProtocolCatalogError>;
     /**
      * Insert or update a dataset in the catalogue.
      * This method is internal and is not exposed via REST endpoints.
-     * @param dataSet The dataset to store.
-     * @returns Nothing.
+     * @param dataset The dataset to store.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
+     * @returns The unique identifier of the stored dataset, or a CatalogError if an error occurs.
      */
-    set(dataSet: IDataset): Promise<void>;
+    set(dataset: IDcatDataset, trustPayload: unknown): Promise<string | IDataspaceProtocolCatalogError>;
     /**
      * Remove a dataset from the catalogue by its unique identifier.
      * This method is internal and is not exposed via REST endpoints.
-     * @param dataSetId The unique identifier of the dataset to remove.
+     * @param datasetId The unique identifier of the dataset to remove.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
      * @returns Nothing.
      */
-    remove(dataSetId: string): Promise<void>;
+    remove(datasetId: string, trustPayload: unknown): Promise<IDataspaceProtocolCatalogError | undefined>;
+    /**
+     * Query the federated catalogue with an optional filter.
+     * @param filter Optional filter criteria for querying datasets.
+     * @param cursor Optional cursor for pagination.
+     * @param limit Optional limit for pagination.
+     * @param trustPayload Optional payload for trust evaluation, if applicable.
+     * @returns The catalog containing matching datasets (or CatalogError if none found), with cursor if more pages exist.
+     */
+    query(filter: unknown[] | undefined, cursor: string | undefined, limit: number | undefined, trustPayload: unknown): Promise<{
+        result: IDataspaceProtocolCatalog | IDataspaceProtocolCatalogError;
+        cursor?: string;
+    }>;
 }

package/docs/changelog.md

@@ -1,11 +1,264 @@
-# @twin.org/federated-catalogue-rest-client - Changelog
+# Changelog
 
-## [0.0.3-next.2](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-rest-client-v0.0.3-next.1...federated-catalogue-rest-client-v0.0.3-next.2) (2025-11-28)
+## [0.0.3-next.20](https://github.com/iotaledger/twin-federated-catalogue/compare/federated-catalogue-rest-client-v0.0.3-next.19...federated-catalogue-rest-client-v0.0.3-next.20) (2026-06-11)
 
 
 ### Features
 
-* implement Dataspace Protocol federated catalogue ([#36](https://github.com/twinfoundation/federated-catalogue/issues/36)) ([4765aba](https://github.com/twinfoundation/federated-catalogue/commit/4765aba4485ef8ad61e7ec1affbf0e454d974d36))
+* 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-rest-client-v0.0.3-next.18...federated-catalogue-rest-client-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-rest-client-v0.0.3-next.17...federated-catalogue-rest-client-v0.0.3-next.18) (2026-06-01)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-rest-client:** Synchronize repo versions
+
+
+### 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-rest-client-v0.0.3-next.16...federated-catalogue-rest-client-v0.0.3-next.17) (2026-05-20)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-rest-client:** Synchronize repo versions
+
+
+### 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-rest-client-v0.0.3-next.15...federated-catalogue-rest-client-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-rest-client-v0.0.3-next.14...federated-catalogue-rest-client-v0.0.3-next.15) (2026-05-08)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-rest-client:** Synchronize repo versions
+
+
+### 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-rest-client-v0.0.3-next.13...federated-catalogue-rest-client-v0.0.3-next.14) (2026-03-20)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-rest-client:** Synchronize repo versions
+
+
+### 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-rest-client-v0.0.3-next.12...federated-catalogue-rest-client-v0.0.3-next.13) (2026-03-12)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-rest-client:** Synchronize repo versions
+
+
+### 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-rest-client-v0.0.3-next.11...federated-catalogue-rest-client-v0.0.3-next.12) (2026-03-06)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-rest-client:** Synchronize repo versions
+
+
+### 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-rest-client-v0.0.3-next.10...federated-catalogue-rest-client-v0.0.3-next.11) (2026-03-05)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-rest-client:** Synchronize repo versions
+
+
+### 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-rest-client-v0.0.3-next.9...federated-catalogue-rest-client-v0.0.3-next.10) (2026-02-25)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-rest-client:** Synchronize repo versions
+
+
+### 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-rest-client-v0.0.3-next.8...federated-catalogue-rest-client-v0.0.3-next.9) (2026-02-12)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-rest-client:** Synchronize repo versions
+
+
+### 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-rest-client-v0.0.3-next.7...federated-catalogue-rest-client-v0.0.3-next.8) (2026-01-26)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-rest-client:** Synchronize repo versions
+
+
+### 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-rest-client-v0.0.3-next.6...federated-catalogue-rest-client-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-rest-client-v0.0.3-next.5...federated-catalogue-rest-client-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-rest-client-v0.0.3-next.4...federated-catalogue-rest-client-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-rest-client-v0.0.3-next.3...federated-catalogue-rest-client-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-rest-client-v0.0.3-next.2...federated-catalogue-rest-client-v0.0.3-next.3) (2025-11-28)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-rest-client:** Synchronize repo versions
+
+
+### 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-rest-client-v0.0.3-next.1...federated-catalogue-rest-client-v0.0.3-next.2) (2025-11-28)
+
+
+### Features
+
+* 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,79 @@
-# @twin.org/federated-catalogue-rest-client - Examples
+# Federated Catalogue REST Client Examples
+
+Use these snippets to call catalogue endpoints consistently, including paged queries, dataset retrieval and unsupported mutation handling.
+
+## FederatedCatalogueRestClient
+
+```typescript
+import { FederatedCatalogueRestClient } from '@twin.org/federated-catalogue-rest-client';
+
+const client = new FederatedCatalogueRestClient({
+  endpoint: 'http://localhost:3000'
+});
+
+console.log(client.className() === FederatedCatalogueRestClient.CLASS_NAME); // true
+```
+
+```typescript
+import { FederatedCatalogueRestClient } from '@twin.org/federated-catalogue-rest-client';
+
+const client = new FederatedCatalogueRestClient({
+  endpoint: 'http://localhost:3000'
+});
+
+const queryResponse = await client.query(
+  [
+    {
+      '@type': 'FilterByMetadata',
+      'dcterms:publisher': {
+        '@id': 'did:web:publisher.example'
+      }
+    }
+  ],
+  'page-1',
+  25
+);
+
+console.log(queryResponse.result['@type']); // Catalog
+console.log(typeof queryResponse.cursor === 'string' || queryResponse.cursor === undefined); // true
+```
+
+```typescript
+import { FederatedCatalogueRestClient } from '@twin.org/federated-catalogue-rest-client';
+
+const client = new FederatedCatalogueRestClient({
+  endpoint: 'http://localhost:3000'
+});
+
+const dataset = await client.get('urn:dataset:air-quality-2026');
+
+console.log(dataset['@id']); // urn:dataset:air-quality-2026
+```
+
+```typescript
+import { FederatedCatalogueRestClient } from '@twin.org/federated-catalogue-rest-client';
+
+const client = new FederatedCatalogueRestClient({
+  endpoint: 'http://localhost:3000'
+});
+
+try {
+  await client.set({
+    '@context': ['https://www.w3.org/ns/dcat3.jsonld'],
+    '@type': 'dcat:Dataset',
+    '@id': 'urn:dataset:air-quality-2026'
+  });
+} catch (error: unknown) {
+  if (error instanceof Error) {
+    console.log(error.name); // NotSupportedError
+  }
+}
+
+try {
+  await client.remove('urn:dataset:air-quality-2026');
+} catch (error: unknown) {
+  if (error instanceof Error) {
+    console.log(error.name); // NotSupportedError
+  }
+}
+```

package/docs/reference/classes/FederatedCatalogueRestClient.md

@@ -36,7 +36,7 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -62,106 +62,142 @@ The class name of the component.
 
 ***
 
-### query()
+### get() {#get}
 
-> **query**(`filter?`): `Promise`\<`ICatalog`\>
+> **get**(`datasetId`, `trustPayload`): `Promise`\<`IDcatDataset` \| `IDataspaceProtocolCatalogError`\>
 
-Query the federated catalogue with an optional filter.
+Retrieve a specific dataset by its unique identifier.
 
 #### Parameters
 
-##### filter?
+##### datasetId
 
-`unknown`[]
+`string`
 
-Optional filter criteria for querying datasets.
+The unique identifier of the dataset.
+
+##### trustPayload
+
+`unknown`
+
+Optional payload for trust evaluation, if applicable.
 
 #### Returns
 
-`Promise`\<`ICatalog`\>
+`Promise`\<`IDcatDataset` \| `IDataspaceProtocolCatalogError`\>
 
-The catalog containing matching datasets.
+The dataset if found, or a CatalogError if not found or an error occurs.
 
 #### Implementation of
 
-`IFederatedCatalogueComponent.query`
+`IFederatedCatalogueComponent.get`
 
 ***
 
-### get()
+### set() {#set}
 
-> **get**(`datasetId`): `Promise`\<`IDataset`\>
+> **set**(`dataset`, `trustPayload`): `Promise`\<`string` \| `IDataspaceProtocolCatalogError`\>
 
-Retrieve a specific dataset by its unique identifier.
+Insert or update a dataset in the catalogue.
+This method is internal and is not exposed via REST endpoints.
 
 #### Parameters
 
-##### datasetId
+##### dataset
 
-`string`
+`IDcatDataset`
 
-The unique identifier of the dataset.
+The dataset to store.
+
+##### trustPayload
+
+`unknown`
+
+Optional payload for trust evaluation, if applicable.
 
 #### Returns
 
-`Promise`\<`IDataset`\>
+`Promise`\<`string` \| `IDataspaceProtocolCatalogError`\>
 
-The dataset if found.
+The unique identifier of the stored dataset, or a CatalogError if an error occurs.
 
 #### Implementation of
 
-`IFederatedCatalogueComponent.get`
+`IFederatedCatalogueComponent.set`
 
 ***
 
-### set()
+### remove() {#remove}
 
-> **set**(`dataSet`): `Promise`\<`void`\>
+> **remove**(`datasetId`, `trustPayload`): `Promise`\<`IDataspaceProtocolCatalogError` \| `undefined`\>
 
-Insert or update a dataset in the catalogue.
+Remove a dataset from the catalogue by its unique identifier.
 This method is internal and is not exposed via REST endpoints.
 
 #### Parameters
 
-##### dataSet
+##### datasetId
+
+`string`
 
-`IDataset`
+The unique identifier of the dataset to remove.
 
-The dataset to store.
+##### trustPayload
+
+`unknown`
+
+Optional payload for trust evaluation, if applicable.
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`IDataspaceProtocolCatalogError` \| `undefined`\>
 
 Nothing.
 
 #### Implementation of
 
-`IFederatedCatalogueComponent.set`
+`IFederatedCatalogueComponent.remove`
 
 ***
 
-### remove()
+### query() {#query}
 
-> **remove**(`dataSetId`): `Promise`\<`void`\>
+> **query**(`filter`, `cursor`, `limit`, `trustPayload`): `Promise`\<\{ `result`: `IDataspaceProtocolCatalogError` \| `IDataspaceProtocolCatalog`; `cursor?`: `string`; \}\>
 
-Remove a dataset from the catalogue by its unique identifier.
-This method is internal and is not exposed via REST endpoints.
+Query the federated catalogue with an optional filter.
 
 #### Parameters
 
-##### dataSetId
+##### filter
 
-`string`
+`unknown`[] \| `undefined`
 
-The unique identifier of the dataset to remove.
+Optional filter criteria for querying datasets.
+
+##### cursor
+
+`string` \| `undefined`
+
+Optional cursor for pagination.
+
+##### limit
+
+`number` \| `undefined`
+
+Optional limit for pagination.
+
+##### trustPayload
+
+`unknown`
+
+Optional payload for trust evaluation, if applicable.
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<\{ `result`: `IDataspaceProtocolCatalogError` \| `IDataspaceProtocolCatalog`; `cursor?`: `string`; \}\>
 
-Nothing.
+The catalog containing matching datasets (or CatalogError if none found), with cursor if more pages exist.
 
 #### Implementation of
 
-`IFederatedCatalogueComponent.remove`
+`IFederatedCatalogueComponent.query`

package/locales/en.json

@@ -1,7 +1 @@
-{
-	"error": {
-		"federatedCatalogueRestClient": {
-			"notSupportedOnClient": "The method \"{methodName}\" is not supported on the REST client, it can only be used on a server side component"
-		}
-	}
-}
+{}

package/package.json

@@ -1,13 +1,13 @@
 {
 	"name": "@twin.org/federated-catalogue-rest-client",
-	"version": "0.0.3-next.2",
+	"version": "0.0.3-next.20",
 	"description": "Federated Catalogue contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/federated-catalogue.git",
+		"url": "git+https://github.com/iotaledger/twin-federated-catalogue.git",
 		"directory": "packages/federated-catalogue-rest-client"
 	},
-	"author": "jose.cantera@iota.org",
+	"author": "cornel.filip@iota.org",
 	"license": "Apache-2.0",
 	"type": "module",
 	"engines": {
@@ -16,12 +16,14 @@
 	"dependencies": {
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/federated-catalogue-models": "0.0.3-next.2",
+		"@twin.org/federated-catalogue-models": "0.0.3-next.20",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-dataspace-protocol": "next",
 		"@twin.org/standards-w3c-dcat": "next",
+		"@twin.org/trust-models": "next",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",
@@ -49,7 +51,7 @@
 		"federated-catalogue"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/federated-catalogue/issues"
+		"url": "git+https://github.com/iotaledger/twin-federated-catalogue/issues"
 	},
 	"homepage": "https://twindev.org"
 }