@twin.org/federated-catalogue-models 0.0.2-next.4 → 0.0.2-next.5

package/dist/types/models/IFederatedCatalogueComponent.d.ts

@@ -20,13 +20,13 @@ export interface IFederatedCatalogueComponent extends IComponent {
      * @param participant The identity of the participant.
      * @param legalRegistrationNumber The legal registration number.
      * @param lrnType The legal registration number type (EORI, VATID, GLEIF, Kenya's PIN, etc.)
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      * @throws NotImplementedError if the implementation does not support retrieval.
      */
-    queryParticipants(participant?: string, legalRegistrationNumber?: string, lrnType?: string, cursor?: string, pageSize?: number): Promise<IParticipantList>;
+    queryParticipants(participant?: string, legalRegistrationNumber?: string, lrnType?: string, cursor?: string, limit?: number): Promise<IParticipantList>;
     /**
      * Registers a Data Space Connector to the service.
      * @param credential The credential as JWT.
@@ -37,13 +37,13 @@ export interface IFederatedCatalogueComponent extends IComponent {
      * Query the federated catalogue.
      * @param id Data Space Connector Id.
      * @param maintainer The identity of the participant maintaining the Data Space Connector.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      * @throws NotImplementedError if the implementation does not support retrieval.
      */
-    queryDataSpaceConnectors(id?: string, maintainer?: string, cursor?: string, pageSize?: number): Promise<IDataSpaceConnectorList>;
+    queryDataSpaceConnectors(id?: string, maintainer?: string, cursor?: string, limit?: number): Promise<IDataSpaceConnectorList>;
     /**
      * Registers a service offering Credential to the service.
      * @param credential The credential as JWT.
@@ -60,24 +60,24 @@ export interface IFederatedCatalogueComponent extends IComponent {
      * Query the federated catalogue.
      * @param id Service Offering id.
      * @param providedBy The identity of the participant providing the Offering.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      * @throws NotImplementedError if the implementation does not support retrieval.
      */
-    queryServiceOfferings(id?: string, providedBy?: string, cursor?: string, pageSize?: number): Promise<IServiceOfferingList>;
+    queryServiceOfferings(id?: string, providedBy?: string, cursor?: string, limit?: number): Promise<IServiceOfferingList>;
     /**
      * Query the federated catalogue.
      * @param id The id of the Data Resource.
      * @param producedBy The identity of the participant producing the data behind the data resource.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      * @throws NotImplementedError if the implementation does not support retrieval.
      */
-    queryDataResources(id?: string, producedBy?: string, cursor?: string, pageSize?: number): Promise<IDataResourceList>;
+    queryDataResources(id?: string, producedBy?: string, cursor?: string, limit?: number): Promise<IDataResourceList>;
     /**
      * Returns a Federated Catalogue entry.
      * @param entryType The type of entry.

package/dist/types/models/api/IDataResourceListRequest.d.ts

@@ -20,8 +20,8 @@ export interface IDataResourceListRequest extends IFederatedCatalogueGetRequest
          */
         cursor?: string;
         /**
-         * The maximum number of entities in a page.
+         * Limit the number of entities to return.
          */
-        pageSize?: number | string;
+        limit?: string;
     };
 }

package/dist/types/models/api/IDataSpaceConnectorListRequest.d.ts

@@ -20,8 +20,8 @@ export interface IDataSpaceConnectorListRequest extends IFederatedCatalogueGetRe
          */
         cursor?: string;
         /**
-         * The maximum number of entities in a page.
+         * Limit the number of entities to return.
          */
-        pageSize?: number | string;
+        limit?: string;
     };
 }

package/dist/types/models/api/IParticipantListRequest.d.ts

@@ -24,8 +24,8 @@ export interface IParticipantListRequest extends IFederatedCatalogueGetRequest {
          */
         cursor?: string;
         /**
-         * The maximum number of entities in a page.
+         * Limit the number of entities to return.
          */
-        pageSize?: number | string;
+        limit?: string;
     };
 }

package/dist/types/models/api/IServiceOfferingListRequest.d.ts

@@ -20,8 +20,8 @@ export interface IServiceOfferingListRequest extends IFederatedCatalogueGetReque
          */
         cursor?: string;
         /**
-         * The maximum number of entities in a page.
+         * Limit the number of entities to return.
          */
-        pageSize?: number | string;
+        limit?: string;
     };
 }

package/docs/changelog.md

@@ -1,5 +1,13 @@
 # @twin.org/federated-catalogue-models - Changelog
 
+## [0.0.2-next.5](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.2-next.4...federated-catalogue-models-v0.0.2-next.5) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([3d8d60d](https://github.com/twinfoundation/federated-catalogue/commit/3d8d60d9291e5a6f8c6d4562d6a862456a9917bc))
+* simplify node ([e80db0e](https://github.com/twinfoundation/federated-catalogue/commit/e80db0e1b4935daaa7ff7d4343280efaa6250bf8))
+
 ## [0.0.2-next.4](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.2-next.3...federated-catalogue-models-v0.0.2-next.4) (2025-09-29)
 
 

package/docs/reference/interfaces/IComplianceCredential.md

@@ -10,7 +10,7 @@ A Compliance credential.
 
 ### @context
 
-> **@context**: \[`"https://www.w3.org/ns/credentials/v2"`, `"https://w3id.org/gaia-x/development"`, `"https://w3id.org/security/suites/jws-2020/v1"`, `...IJsonLdContextDefinitionElement[]`\]
+> **@context**: \[`"https://www.w3.org/ns/credentials/v2"`, `"https://schema.twindev.org/gaia-x-loire/"`, `"https://w3id.org/security/suites/jws-2020/v1"`, `...IJsonLdContextDefinitionElement[]`\]
 
 The LD Context.
 

package/docs/reference/interfaces/IDataResourceListRequest.md

@@ -32,11 +32,11 @@ The service provider.
 
 The optional cursor to get next chunk.
 
-#### pageSize?
+#### limit?
 
-> `optional` **pageSize**: `string` \| `number`
+> `optional` **limit**: `string`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 ***
 

package/docs/reference/interfaces/IDataSpaceConnectorListRequest.md

@@ -32,11 +32,11 @@ The maintainer
 
 The optional cursor to get next chunk.
 
-#### pageSize?
+#### limit?
 
-> `optional` **pageSize**: `string` \| `number`
+> `optional` **limit**: `string`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 ***
 

package/docs/reference/interfaces/IFederatedCatalogueComponent.md

@@ -6,6 +6,14 @@ Interface describing a Federated Catalogue Contract.
 
 - `IComponent`
 
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+All methods are optional, so we introduce an index signature to allow
+any additional properties or methods, which removes the TypeScript error where
+the class has no properties in common with the type.
+
 ## Methods
 
 ### registerComplianceCredential()
@@ -32,7 +40,7 @@ The participant Id (usually a DID).
 
 ### queryParticipants()
 
-> **queryParticipants**(`participant?`, `legalRegistrationNumber?`, `lrnType?`, `cursor?`, `pageSize?`): `Promise`\<[`IParticipantList`](IParticipantList.md)\>
+> **queryParticipants**(`participant?`, `legalRegistrationNumber?`, `lrnType?`, `cursor?`, `limit?`): `Promise`\<[`IParticipantList`](IParticipantList.md)\>
 
 Query the federated catalogue.
 
@@ -60,13 +68,13 @@ The legal registration number type (EORI, VATID, GLEIF, Kenya's PIN, etc.)
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 #### Returns
 
@@ -105,7 +113,7 @@ The Data Space Connector Id registered.
 
 ### queryDataSpaceConnectors()
 
-> **queryDataSpaceConnectors**(`id?`, `maintainer?`, `cursor?`, `pageSize?`): `Promise`\<[`IDataSpaceConnectorList`](IDataSpaceConnectorList.md)\>
+> **queryDataSpaceConnectors**(`id?`, `maintainer?`, `cursor?`, `limit?`): `Promise`\<[`IDataSpaceConnectorList`](IDataSpaceConnectorList.md)\>
 
 Query the federated catalogue.
 
@@ -127,13 +135,13 @@ The identity of the participant maintaining the Data Space Connector.
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 #### Returns
 
@@ -194,7 +202,7 @@ The Id of the Data Resources registered.
 
 ### queryServiceOfferings()
 
-> **queryServiceOfferings**(`id?`, `providedBy?`, `cursor?`, `pageSize?`): `Promise`\<[`IServiceOfferingList`](IServiceOfferingList.md)\>
+> **queryServiceOfferings**(`id?`, `providedBy?`, `cursor?`, `limit?`): `Promise`\<[`IServiceOfferingList`](IServiceOfferingList.md)\>
 
 Query the federated catalogue.
 
@@ -216,13 +224,13 @@ The identity of the participant providing the Offering.
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 #### Returns
 
@@ -239,7 +247,7 @@ NotImplementedError if the implementation does not support retrieval.
 
 ### queryDataResources()
 
-> **queryDataResources**(`id?`, `producedBy?`, `cursor?`, `pageSize?`): `Promise`\<[`IDataResourceList`](IDataResourceList.md)\>
+> **queryDataResources**(`id?`, `producedBy?`, `cursor?`, `limit?`): `Promise`\<[`IDataResourceList`](IDataResourceList.md)\>
 
 Query the federated catalogue.
 
@@ -261,13 +269,13 @@ The identity of the participant producing the data behind the data resource.
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 #### Returns
 

package/docs/reference/interfaces/IParticipantListRequest.md

@@ -54,8 +54,8 @@ The legal registration number type.
 
 The optional cursor to get next chunk.
 
-#### pageSize?
+#### limit?
 
-> `optional` **pageSize**: `string` \| `number`
+> `optional` **limit**: `string`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.

package/docs/reference/interfaces/IServiceOfferingListRequest.md

@@ -48,8 +48,8 @@ The service provider.
 
 The optional cursor to get next chunk.
 
-#### pageSize?
+#### limit?
 
-> `optional` **pageSize**: `string` \| `number`
+> `optional` **limit**: `string`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/federated-catalogue-models",
-	"version": "0.0.2-next.4",
+	"version": "0.0.2-next.5",
 	"description": "Models which define the structure of the Federated Catalogue Service",
 	"repository": {
 		"type": "git",
@@ -41,5 +41,20 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"federated-catalogue",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/federated-catalogue/issues"
+	},
+	"homepage": "https://twindev.org"
 }