@twin.org/federated-catalogue-models 0.0.1-next.10

package/docs/reference/interfaces/IParticipantCredential.md

@@ -0,0 +1,43 @@
+# Interface: IParticipantCredential
+
+Participant Credential.
+
+## Extends
+
+- [`ICredential`](ICredential.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The Id of the credential, it is mandatory.
+
+#### Inherited from
+
+[`ICredential`](ICredential.md).[`id`](ICredential.md#id)
+
+***
+
+### issuer
+
+> **issuer**: `string`
+
+The issuer of the credential, it is mandatory.
+
+#### Inherited from
+
+[`ICredential`](ICredential.md).[`issuer`](ICredential.md#issuer)
+
+***
+
+### credentialSubject
+
+> **credentialSubject**: `IParticipant`
+
+The Credential Subject
+
+#### Overrides
+
+[`ICredential`](ICredential.md).[`credentialSubject`](ICredential.md#credentialsubject)

package/docs/reference/interfaces/IParticipantEntry.md

@@ -0,0 +1,83 @@
+# Interface: IParticipantEntry
+
+Interface describing a participant.
+
+## Extends
+
+- `IParticipant`.`ICatalogueBase`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{[`key`: `string`]: `string`; \}
+
+## Properties
+
+### issuer
+
+> **issuer**: `string`
+
+The trusted issuer of the compliance credential
+
+#### Inherited from
+
+`ICatalogueBase.issuer`
+
+***
+
+### validFrom
+
+> **validFrom**: `string`
+
+Valid from (as per W3C VC Data Model v2)
+
+#### Inherited from
+
+`ICatalogueBase.validFrom`
+
+***
+
+### validUntil
+
+> **validUntil**: `string`
+
+Valid until (as per W3C VC Data Model v2)
+
+#### Inherited from
+
+`ICatalogueBase.validUntil`
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The creation date.
+
+#### Inherited from
+
+`ICatalogueBase.dateCreated`
+
+***
+
+### evidence
+
+> **evidence**: `string`[]
+
+The evidences concerning the data resource.
+
+#### Inherited from
+
+`ICatalogueBase.evidence`
+
+***
+
+### @context
+
+> **@context**: [`FederatedCatalogueContextType`](../type-aliases/FederatedCatalogueContextType.md)
+
+The LD Context
+
+#### Overrides
+
+`IParticipant.@context`

package/docs/reference/interfaces/IParticipantGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IParticipantGetResponse
+
+Response for a Participant Entry.
+
+## Properties
+
+### body
+
+> **body**: [`IParticipantEntry`](IParticipantEntry.md)
+
+The response payload.

package/docs/reference/interfaces/IParticipantList.md

@@ -0,0 +1,35 @@
+# Interface: IParticipantList
+
+Interface describing a participant entry list.
+
+## Properties
+
+### @context
+
+> **@context**: [`FederatedCatalogueContextType`](../type-aliases/FederatedCatalogueContextType.md)
+
+The LD Context.
+
+***
+
+### type
+
+> **type**: `"ItemList"`
+
+The type
+
+***
+
+### itemListElement
+
+> **itemListElement**: `Omit`\<[`IParticipantEntry`](IParticipantEntry.md), `"@context"`\>[]
+
+The components of the Collection
+
+***
+
+### nextItem?
+
+> `optional` **nextItem**: `string`
+
+Next item cursor.

package/docs/reference/interfaces/IParticipantListRequest.md

@@ -0,0 +1,61 @@
+# Interface: IParticipantListRequest
+
+Get the a list of the participant entries.
+
+## Extends
+
+- [`IFederatedCatalogueGetRequest`](IFederatedCatalogueGetRequest.md)
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+#### Inherited from
+
+[`IFederatedCatalogueGetRequest`](IFederatedCatalogueGetRequest.md).[`headers`](IFederatedCatalogueGetRequest.md#headers)
+
+***
+
+### query
+
+> **query**: `object`
+
+The query parameters.
+
+#### id?
+
+> `optional` **id**: `string`
+
+The participant Id.
+
+#### registrationNumber?
+
+> `optional` **registrationNumber**: `string`
+
+The legal registration number.
+
+#### lrnType?
+
+> `optional` **lrnType**: `string`
+
+The legal registration number type.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The optional cursor to get next chunk.
+
+#### pageSize?
+
+> `optional` **pageSize**: `number`
+
+The maximum number of entities in a page.

package/docs/reference/interfaces/IParticipantListResponse.md

@@ -0,0 +1,11 @@
+# Interface: IParticipantListResponse
+
+Response for participant list query
+
+## Properties
+
+### body
+
+> **body**: [`IParticipantList`](IParticipantList.md)
+
+The response payload.

package/docs/reference/interfaces/IServiceOfferingCredential.md

@@ -0,0 +1,43 @@
+# Interface: IServiceOfferingCredential
+
+A Service Offering Credential
+
+## Extends
+
+- [`ICredential`](ICredential.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The Id of the credential, it is mandatory.
+
+#### Inherited from
+
+[`ICredential`](ICredential.md).[`id`](ICredential.md#id)
+
+***
+
+### issuer
+
+> **issuer**: `string`
+
+The issuer of the credential, it is mandatory.
+
+#### Inherited from
+
+[`ICredential`](ICredential.md).[`issuer`](ICredential.md#issuer)
+
+***
+
+### credentialSubject
+
+> **credentialSubject**: `IServiceOffering`
+
+The Credential Subject
+
+#### Overrides
+
+[`ICredential`](ICredential.md).[`credentialSubject`](ICredential.md#credentialsubject)

package/docs/reference/interfaces/IServiceOfferingEntry.md

@@ -0,0 +1,119 @@
+# Interface: IServiceOfferingEntry
+
+Interface describing a Service Offering.
+
+## Extends
+
+- `ICatalogueBase`.`IServiceOffering`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{[`key`: `string`]: `string`; \}
+
+## Properties
+
+### issuer
+
+> **issuer**: `string`
+
+The trusted issuer of the compliance credential
+
+#### Inherited from
+
+`ICatalogueBase.issuer`
+
+***
+
+### validFrom
+
+> **validFrom**: `string`
+
+Valid from (as per W3C VC Data Model v2)
+
+#### Inherited from
+
+`ICatalogueBase.validFrom`
+
+***
+
+### validUntil
+
+> **validUntil**: `string`
+
+Valid until (as per W3C VC Data Model v2)
+
+#### Inherited from
+
+`ICatalogueBase.validUntil`
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The creation date.
+
+#### Inherited from
+
+`ICatalogueBase.dateCreated`
+
+***
+
+### evidence
+
+> **evidence**: `string`[]
+
+The evidences concerning the data resource.
+
+#### Inherited from
+
+`ICatalogueBase.evidence`
+
+***
+
+### @context
+
+> **@context**: [`FederatedCatalogueContextType`](../type-aliases/FederatedCatalogueContextType.md)
+
+The LD Context
+
+#### Overrides
+
+`IServiceOffering.@context`
+
+***
+
+### providedBy
+
+> **providedBy**: `string`
+
+Overwrites providedBy as we only store identifier as string
+
+#### Overrides
+
+`IServiceOffering.providedBy`
+
+***
+
+### aggregationOfResources?
+
+> `optional` **aggregationOfResources**: `string`[]
+
+Overwrites aggregationOfResources as we only store identifier as string
+
+#### Overrides
+
+`IServiceOffering.aggregationOfResources`
+
+***
+
+### servicePolicy
+
+> **servicePolicy**: `IOdrlPolicy`[]
+
+The service policy is always stored as an array
+
+#### Overrides
+
+`IServiceOffering.servicePolicy`

package/docs/reference/interfaces/IServiceOfferingGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IServiceOfferingGetResponse
+
+Service Offering response
+
+## Properties
+
+### body
+
+> **body**: [`IServiceOfferingEntry`](IServiceOfferingEntry.md)
+
+The response payload.

package/docs/reference/interfaces/IServiceOfferingList.md

@@ -0,0 +1,35 @@
+# Interface: IServiceOfferingList
+
+Interface describing a list of Service Offering Entries.
+
+## Properties
+
+### @context
+
+> **@context**: [`FederatedCatalogueContextType`](../type-aliases/FederatedCatalogueContextType.md)
+
+The LD Context.
+
+***
+
+### type
+
+> **type**: `"ItemList"`
+
+The type
+
+***
+
+### itemListElement
+
+> **itemListElement**: `Omit`\<[`IServiceOfferingEntry`](IServiceOfferingEntry.md), `"@context"`\>[]
+
+The components of the Collection
+
+***
+
+### nextItem?
+
+> `optional` **nextItem**: `string`
+
+Next item cursor.

package/docs/reference/interfaces/IServiceOfferingListRequest.md

@@ -0,0 +1,55 @@
+# Interface: IServiceOfferingListRequest
+
+Get the a list of the service offering entries.
+
+## Extends
+
+- [`IFederatedCatalogueGetRequest`](IFederatedCatalogueGetRequest.md)
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+#### Inherited from
+
+[`IFederatedCatalogueGetRequest`](IFederatedCatalogueGetRequest.md).[`headers`](IFederatedCatalogueGetRequest.md#headers)
+
+***
+
+### query
+
+> **query**: `object`
+
+The query parameters.
+
+#### id?
+
+> `optional` **id**: `string`
+
+The Service Offering Id.
+
+#### providedBy?
+
+> `optional` **providedBy**: `string`
+
+The service provider.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The optional cursor to get next chunk.
+
+#### pageSize?
+
+> `optional` **pageSize**: `number`
+
+The maximum number of entities in a page.

package/docs/reference/interfaces/IServiceOfferingListResponse.md

@@ -0,0 +1,11 @@
+# Interface: IServiceOfferingListResponse
+
+Response for Service Offering list
+
+## Properties
+
+### body
+
+> **body**: [`IServiceOfferingList`](IServiceOfferingList.md)
+
+The response payload.

package/docs/reference/interfaces/IVerificationResult.md

@@ -0,0 +1,23 @@
+# Interface: IVerificationResult
+
+Verification Result
+
+## Extended by
+
+- [`IComplianceVerificationResult`](IComplianceVerificationResult.md)
+
+## Properties
+
+### verified
+
+> **verified**: `boolean`
+
+True if verified. False the opposite.
+
+***
+
+### verificationFailureReason?
+
+> `optional` **verificationFailureReason**: `string`
+
+Verification failure reason.

package/docs/reference/type-aliases/FederatedCatalogueContextType.md

@@ -0,0 +1,5 @@
+# Type Alias: FederatedCatalogueContextType
+
+> **FederatedCatalogueContextType** = \[*typeof* `SchemaOrgContexts.ContextRoot`, *typeof* `GaiaXContexts.ContextRoot`, *typeof* [`ContextRoot`](../variables/FederatedCatalogueContexts.md#contextroot)\]
+
+Type that defines the LD Context for the Federated Catalogue entities and entries.

package/docs/reference/type-aliases/FederatedCatalogueContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: FederatedCatalogueContexts
+
+> **FederatedCatalogueContexts** = *typeof* [`FederatedCatalogueContexts`](../variables/FederatedCatalogueContexts.md)\[keyof *typeof* [`FederatedCatalogueContexts`](../variables/FederatedCatalogueContexts.md)\]
+
+The Exported types

package/docs/reference/type-aliases/FederatedCatalogueEntryType.md

@@ -0,0 +1,5 @@
+# Type Alias: FederatedCatalogueEntryType
+
+> **FederatedCatalogueEntryType** = *typeof* `GaiaXTypes.Participant` \| *typeof* `GaiaXTypes.DataExchangeComponent` \| *typeof* `GaiaXTypes.DataResource` \| *typeof* `GaiaXTypes.ServiceOffering` \| *typeof* [`DataSpaceConnector`](../variables/FederatedCatalogueTypes.md#dataspaceconnector)
+
+Types of entries in the Federated Catalogue

package/docs/reference/type-aliases/FederatedCatalogueTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: FederatedCatalogueTypes
+
+> **FederatedCatalogueTypes** = *typeof* [`FederatedCatalogueTypes`](../variables/FederatedCatalogueTypes.md)\[keyof *typeof* [`FederatedCatalogueTypes`](../variables/FederatedCatalogueTypes.md)\]
+
+The Exported types

package/docs/reference/type-aliases/ICatalogueEntry.md

@@ -0,0 +1,5 @@
+# Type Alias: ICatalogueEntry
+
+> **ICatalogueEntry** = [`IParticipantEntry`](../interfaces/IParticipantEntry.md) \| [`IDataSpaceConnectorEntry`](../interfaces/IDataSpaceConnectorEntry.md) \| [`IServiceOfferingEntry`](../interfaces/IServiceOfferingEntry.md) \| [`IDataResourceEntry`](../interfaces/IDataResourceEntry.md)
+
+Catalogue entry base fields.

package/docs/reference/type-aliases/VerificationFailureReasons.md

@@ -0,0 +1,5 @@
+# Type Alias: VerificationFailureReasons
+
+> **VerificationFailureReasons** = *typeof* [`VerificationFailureReasons`](../variables/VerificationFailureReasons.md)\[keyof *typeof* [`VerificationFailureReasons`](../variables/VerificationFailureReasons.md)\]
+
+The verification failure Reasons.

package/docs/reference/variables/FederatedCatalogueContexts.md

@@ -0,0 +1,13 @@
+# Variable: FederatedCatalogueContexts
+
+> `const` **FederatedCatalogueContexts**: `object`
+
+The LD context concerning the Federated Catalogue.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/federated-catalogue/"` = `"https://schema.twindev.org/federated-catalogue/"`
+
+The context root for the federated catalogue types.

package/docs/reference/variables/FederatedCatalogueTypes.md

@@ -0,0 +1,73 @@
+# Variable: FederatedCatalogueTypes
+
+> `const` **FederatedCatalogueTypes**: `object`
+
+The types concerning the Federated Catalogue.
+
+## Type declaration
+
+### CompliantCredential
+
+> `readonly` **CompliantCredential**: `"CompliantCredential"` = `"CompliantCredential"`
+
+A Credential that is compliant.
+
+### ComplianceCredential
+
+> `readonly` **ComplianceCredential**: `"ComplianceCredential"` = `"ComplianceCredential"`
+
+A Compliance Credential.
+
+### DataSpaceConnector
+
+> `readonly` **DataSpaceConnector**: `"DataSpaceConnector"` = `"DataSpaceConnector"`
+
+A Data Space Connector.
+
+### DataResourceEntry
+
+> `readonly` **DataResourceEntry**: `"DataResourceEntry"` = `"DataResourceEntry"`
+
+A Data Resource Entry.
+
+### DataResourceList
+
+> `readonly` **DataResourceList**: `"DataResourceList"` = `"DataResourceList"`
+
+A Data Space Connector List.
+
+### DataSpaceConnectorEntry
+
+> `readonly` **DataSpaceConnectorEntry**: `"DataSpaceConnectorEntry"` = `"DataSpaceConnectorEntry"`
+
+A Data Space Connector Entry.
+
+### DataSpaceConnectorList
+
+> `readonly` **DataSpaceConnectorList**: `"DataSpaceConnectorList"` = `"DataSpaceConnectorList"`
+
+A Data Space Connector List.
+
+### ParticipantEntry
+
+> `readonly` **ParticipantEntry**: `"ParticipantEntry"` = `"ParticipantEntry"`
+
+A Participant Entry.
+
+### ParticipantList
+
+> `readonly` **ParticipantList**: `"ParticipantList"` = `"ParticipantList"`
+
+A Participant List.
+
+### ServiceOfferingEntry
+
+> `readonly` **ServiceOfferingEntry**: `"ServiceOfferingEntry"` = `"ServiceOfferingEntry"`
+
+A Service Offering Entry.
+
+### ServiceOfferingList
+
+> `readonly` **ServiceOfferingList**: `"ServiceOfferingList"` = `"ServiceOfferingList"`
+
+A Service Offering List.