@twin.org/federated-catalogue-models 0.0.1-next.9 → 0.0.1

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 (15) hide show
  1. package/dist/cjs/index.cjs +1 -1
  2. package/dist/esm/index.mjs +1 -1
  3. package/dist/types/models/IComplianceCredential.d.ts +1 -1
  4. package/dist/types/models/api/IDataResourceListRequest.d.ts +2 -2
  5. package/dist/types/models/api/IDataSpaceConnectorListRequest.d.ts +2 -2
  6. package/dist/types/models/api/IParticipantListRequest.d.ts +2 -2
  7. package/dist/types/models/api/IServiceOfferingListRequest.d.ts +2 -2
  8. package/dist/types/models/federatedCatalogueContextType.d.ts +1 -1
  9. package/docs/changelog.md +22 -0
  10. package/docs/reference/interfaces/IDataResourceListRequest.md +3 -3
  11. package/docs/reference/interfaces/IDataSpaceConnectorListRequest.md +3 -3
  12. package/docs/reference/interfaces/IParticipantListRequest.md +3 -3
  13. package/docs/reference/interfaces/IServiceOfferingListRequest.md +3 -3
  14. package/docs/reference/type-aliases/FederatedCatalogueContextType.md +1 -1
  15. package/package.json +10 -10
package/dist/cjs/index.cjs CHANGED
@@ -82,7 +82,7 @@ class FederatedCatalogueContextInstances {
82
82
  */
83
83
  static DEFAULT_LD_CONTEXT_ENTRY_LIST = [
84
84
  standardsSchemaOrg.SchemaOrgContexts.ContextRoot,
85
- standardsGaiaX.GaiaXContexts.GaiaXLdContext,
85
+ standardsGaiaX.GaiaXContexts.ContextRoot,
86
86
  FederatedCatalogueContexts.ContextRoot
87
87
  ];
88
88
  /**
package/dist/esm/index.mjs CHANGED
@@ -80,7 +80,7 @@ class FederatedCatalogueContextInstances {
80
80
  */
81
81
  static DEFAULT_LD_CONTEXT_ENTRY_LIST = [
82
82
  SchemaOrgContexts.ContextRoot,
83
- GaiaXContexts.GaiaXLdContext,
83
+ GaiaXContexts.ContextRoot,
84
84
  FederatedCatalogueContexts.ContextRoot
85
85
  ];
86
86
  /**
package/dist/types/models/IComplianceCredential.d.ts CHANGED
@@ -13,7 +13,7 @@ export interface IComplianceCredential extends ICredential {
13
13
  */
14
14
  "@context": [
15
15
  typeof DidContexts.ContextVCv2,
16
- typeof GaiaXContexts.GaiaXLdContext,
16
+ typeof GaiaXContexts.ContextRoot,
17
17
  typeof DidContexts.ContextSecurityJws2020,
18
18
  ...IJsonLdContextDefinitionElement[]
19
19
  ];
package/dist/types/models/api/IDataResourceListRequest.d.ts CHANGED
@@ -6,7 +6,7 @@ export interface IDataResourceListRequest extends IFederatedCatalogueGetRequest
6
6
  /**
7
7
  * The query parameters.
8
8
  */
9
- query: {
9
+ query?: {
10
10
  /**
11
11
  * The Id of the Data Resource.
12
12
  */
@@ -22,6 +22,6 @@ export interface IDataResourceListRequest extends IFederatedCatalogueGetRequest
22
22
  /**
23
23
  * The maximum number of entities in a page.
24
24
  */
25
- pageSize?: number;
25
+ pageSize?: number | string;
26
26
  };
27
27
  }
package/dist/types/models/api/IDataSpaceConnectorListRequest.d.ts CHANGED
@@ -6,7 +6,7 @@ export interface IDataSpaceConnectorListRequest extends IFederatedCatalogueGetRe
6
6
  /**
7
7
  * The query parameters.
8
8
  */
9
- query: {
9
+ query?: {
10
10
  /**
11
11
  * The id of the Data Space Connector.
12
12
  */
@@ -22,6 +22,6 @@ export interface IDataSpaceConnectorListRequest extends IFederatedCatalogueGetRe
22
22
  /**
23
23
  * The maximum number of entities in a page.
24
24
  */
25
- pageSize?: number;
25
+ pageSize?: number | string;
26
26
  };
27
27
  }
package/dist/types/models/api/IParticipantListRequest.d.ts CHANGED
@@ -6,7 +6,7 @@ export interface IParticipantListRequest extends IFederatedCatalogueGetRequest {
6
6
  /**
7
7
  * The query parameters.
8
8
  */
9
- query: {
9
+ query?: {
10
10
  /**
11
11
  * The participant Id.
12
12
  */
@@ -26,6 +26,6 @@ export interface IParticipantListRequest extends IFederatedCatalogueGetRequest {
26
26
  /**
27
27
  * The maximum number of entities in a page.
28
28
  */
29
- pageSize?: number;
29
+ pageSize?: number | string;
30
30
  };
31
31
  }
package/dist/types/models/api/IServiceOfferingListRequest.d.ts CHANGED
@@ -6,7 +6,7 @@ export interface IServiceOfferingListRequest extends IFederatedCatalogueGetReque
6
6
  /**
7
7
  * The query parameters.
8
8
  */
9
- query: {
9
+ query?: {
10
10
  /**
11
11
  * The Service Offering Id.
12
12
  */
@@ -22,6 +22,6 @@ export interface IServiceOfferingListRequest extends IFederatedCatalogueGetReque
22
22
  /**
23
23
  * The maximum number of entities in a page.
24
24
  */
25
- pageSize?: number;
25
+ pageSize?: number | string;
26
26
  };
27
27
  }
package/dist/types/models/federatedCatalogueContextType.d.ts CHANGED
@@ -6,6 +6,6 @@ import type { FederatedCatalogueContexts } from "./federatedCatalogueContexts";
6
6
  */
7
7
  export type FederatedCatalogueContextType = [
8
8
  typeof SchemaOrgContexts.ContextRoot,
9
- typeof GaiaXContexts.GaiaXLdContext,
9
+ typeof GaiaXContexts.ContextRoot,
10
10
  typeof FederatedCatalogueContexts.ContextRoot
11
11
  ];
package/docs/changelog.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # @twin.org/federated-catalogue-models - Changelog
2
2
 
3
+ ## 0.0.1 (2025-07-10)
4
+
5
+
6
+ ### Features
7
+
8
+ * release to production ([c9b5702](https://github.com/twinfoundation/federated-catalogue/commit/c9b570207fae4b31d43fa99e4df99be4baa34db2))
9
+ * version 0 federated catalogue ([#2](https://github.com/twinfoundation/federated-catalogue/issues/2)) ([93fb8bd](https://github.com/twinfoundation/federated-catalogue/commit/93fb8bdbb03aa781ef9e8dc4053beea1b397cc36))
10
+
11
+ ## [0.0.1-next.11](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.10...federated-catalogue-models-v0.0.1-next.11) (2025-06-20)
12
+
13
+
14
+ ### Bug Fixes
15
+
16
+ * query params force coercion ([a532329](https://github.com/twinfoundation/federated-catalogue/commit/a532329089b2b95c7f18cd8bd56ee47482755dc0))
17
+
18
+ ## [0.0.1-next.10](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.9...federated-catalogue-models-v0.0.1-next.10) (2025-06-18)
19
+
20
+
21
+ ### Features
22
+
23
+ * update schemas ([58d8581](https://github.com/twinfoundation/federated-catalogue/commit/58d85813231f6576490937d4394e7be0f6d8c58d))
24
+
3
25
  ## [0.0.1-next.9](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.8...federated-catalogue-models-v0.0.1-next.9) (2025-06-12)
4
26
 
5
27
 
package/docs/reference/interfaces/IDataResourceListRequest.md CHANGED
@@ -8,9 +8,9 @@ Get the a list of the data resource entries.
8
8
 
9
9
  ## Properties
10
10
 
11
- ### query
11
+ ### query?
12
12
 
13
- > **query**: `object`
13
+ > `optional` **query**: `object`
14
14
 
15
15
  The query parameters.
16
16
 
@@ -34,7 +34,7 @@ The optional cursor to get next chunk.
34
34
 
35
35
  #### pageSize?
36
36
 
37
- > `optional` **pageSize**: `number`
37
+ > `optional` **pageSize**: `string` \| `number`
38
38
 
39
39
  The maximum number of entities in a page.
40
40
 
package/docs/reference/interfaces/IDataSpaceConnectorListRequest.md CHANGED
@@ -8,9 +8,9 @@ Get the a list of the data space connector entries.
8
8
 
9
9
  ## Properties
10
10
 
11
- ### query
11
+ ### query?
12
12
 
13
- > **query**: `object`
13
+ > `optional` **query**: `object`
14
14
 
15
15
  The query parameters.
16
16
 
@@ -34,7 +34,7 @@ The optional cursor to get next chunk.
34
34
 
35
35
  #### pageSize?
36
36
 
37
- > `optional` **pageSize**: `number`
37
+ > `optional` **pageSize**: `string` \| `number`
38
38
 
39
39
  The maximum number of entities in a page.
40
40
 
package/docs/reference/interfaces/IParticipantListRequest.md CHANGED
@@ -24,9 +24,9 @@ The headers which can be used to determine the response data type.
24
24
 
25
25
  ***
26
26
 
27
- ### query
27
+ ### query?
28
28
 
29
- > **query**: `object`
29
+ > `optional` **query**: `object`
30
30
 
31
31
  The query parameters.
32
32
 
@@ -56,6 +56,6 @@ The optional cursor to get next chunk.
56
56
 
57
57
  #### pageSize?
58
58
 
59
- > `optional` **pageSize**: `number`
59
+ > `optional` **pageSize**: `string` \| `number`
60
60
 
61
61
  The maximum number of entities in a page.
package/docs/reference/interfaces/IServiceOfferingListRequest.md CHANGED
@@ -24,9 +24,9 @@ The headers which can be used to determine the response data type.
24
24
 
25
25
  ***
26
26
 
27
- ### query
27
+ ### query?
28
28
 
29
- > **query**: `object`
29
+ > `optional` **query**: `object`
30
30
 
31
31
  The query parameters.
32
32
 
@@ -50,6 +50,6 @@ The optional cursor to get next chunk.
50
50
 
51
51
  #### pageSize?
52
52
 
53
- > `optional` **pageSize**: `number`
53
+ > `optional` **pageSize**: `string` \| `number`
54
54
 
55
55
  The maximum number of entities in a page.
package/docs/reference/type-aliases/FederatedCatalogueContextType.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # Type Alias: FederatedCatalogueContextType
2
2
 
3
- > **FederatedCatalogueContextType** = \[*typeof* `SchemaOrgContexts.ContextRoot`, *typeof* `GaiaXContexts.GaiaXLdContext`, *typeof* [`ContextRoot`](../variables/FederatedCatalogueContexts.md#contextroot)\]
3
+ > **FederatedCatalogueContextType** = \[*typeof* `SchemaOrgContexts.ContextRoot`, *typeof* `GaiaXContexts.ContextRoot`, *typeof* [`ContextRoot`](../variables/FederatedCatalogueContexts.md#contextroot)\]
4
4
 
5
5
  Type that defines the LD Context for the Federated Catalogue entities and entries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/federated-catalogue-models",
3
- "version": "0.0.1-next.9",
3
+ "version": "0.0.1",
4
4
  "description": "Models which define the structure of the Federated Catalogue Service",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,15 +14,15 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "next",
18
- "@twin.org/data-core": "next",
19
- "@twin.org/data-json-ld": "next",
20
- "@twin.org/entity": "next",
21
- "@twin.org/nameof": "next",
22
- "@twin.org/standards-gaia-x": "next",
23
- "@twin.org/standards-schema-org": "next",
24
- "@twin.org/standards-w3c-did": "next",
25
- "@twin.org/standards-w3c-odrl": "next"
17
+ "@twin.org/core": "^0.0.1",
18
+ "@twin.org/data-core": "^0.0.1",
19
+ "@twin.org/data-json-ld": "^0.0.1",
20
+ "@twin.org/entity": "^0.0.1",
21
+ "@twin.org/nameof": "^0.0.1",
22
+ "@twin.org/standards-gaia-x": "^0.0.1",
23
+ "@twin.org/standards-schema-org": "^0.0.1",
24
+ "@twin.org/standards-w3c-did": "^0.0.1",
25
+ "@twin.org/standards-w3c-odrl": "^0.0.1"
26
26
  },
27
27
  "main": "./dist/cjs/index.cjs",
28
28
  "module": "./dist/esm/index.mjs",