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

package/docs/reference/interfaces/IComplianceCredential.md

@@ -0,0 +1,103 @@
+# Interface: IComplianceCredential
+
+A Compliance credential.
+
+## Extends
+
+- [`ICredential`](ICredential.md)
+
+## Properties
+
+### @context
+
+> **@context**: \[`"https://www.w3.org/ns/credentials/v2"`, `"https://w3id.org/gaia-x/development"`, `"https://w3id.org/security/suites/jws-2020/v1"`, `...IJsonLdContextDefinitionElement[]`\]
+
+The LD Context.
+
+#### Overrides
+
+`ICredential.@context`
+
+***
+
+### type
+
+> **type**: \[`"VerifiableCredential"`, `"ComplianceCredential"`\]
+
+Type of Credential.
+
+#### Overrides
+
+`ICredential.type`
+
+***
+
+### validFrom
+
+> **validFrom**: `string`
+
+A compliance credential requires a validity period
+
+#### Overrides
+
+`ICredential.validFrom`
+
+***
+
+### validUntil
+
+> **validUntil**: `string`
+
+A compliance credential requires a validity period
+
+#### Overrides
+
+`ICredential.validUntil`
+
+***
+
+### evidence
+
+> **evidence**: [`IComplianceEvidence`](IComplianceEvidence.md)[]
+
+Compliance evidence. It is mandatory.
+
+#### Overrides
+
+`ICredential.evidence`
+
+***
+
+### 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**: `IJsonLdNodeObject` & `object` \| `IJsonLdNodeObject`[] & `object`
+
+Credential subject must always include id and type
+
+#### Inherited from
+
+[`ICredential`](ICredential.md).[`credentialSubject`](ICredential.md#credentialsubject)

package/docs/reference/interfaces/IComplianceEvidence.md

@@ -0,0 +1,45 @@
+# Interface: IComplianceEvidence
+
+Compliance Evidence.
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## 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
+
+### id
+
+> **id**: `string`
+
+Resolvable Id that allows to get access to the credential that serves as evidence.
+
+***
+
+### type
+
+> **type**: `"CompliantCredential"`
+
+Type of evidence.
+
+***
+
+### digestSRI
+
+> **digestSRI**: `string`
+
+One or more cryptographic digests, as defined by the hash-expression
+ABNF grammar defined in the Sub-resource Integrity specification,
+Section 3.5: The integrity attribute.
+
+***
+
+### credentialType
+
+> **credentialType**: `string` \| `string`[]
+
+Original type

package/docs/reference/interfaces/ICompliancePresentationRequest.md

@@ -0,0 +1,11 @@
+# Interface: ICompliancePresentationRequest
+
+Register a new Compliance Credential.
+
+## Properties
+
+### body
+
+> **body**: `string`
+
+The data to be used in the create.

package/docs/reference/interfaces/IComplianceVerificationResult.md

@@ -0,0 +1,55 @@
+# Interface: IComplianceVerificationResult
+
+Compliance verification result
+
+## Extends
+
+- [`IVerificationResult`](IVerificationResult.md)
+
+## Properties
+
+### credentials
+
+> **credentials**: [`ICredential`](ICredential.md)[]
+
+The credentials involved
+
+***
+
+### evidenceVerificationResult?
+
+> `optional` **evidenceVerificationResult**: [`IVerificationResult`](IVerificationResult.md)
+
+Filled in case an evidence cannot be verified to provide the reason
+
+***
+
+### evidenceFailedToVerify?
+
+> `optional` **evidenceFailedToVerify**: `string`[]
+
+The evidences that failed to be verified.
+
+***
+
+### verified
+
+> **verified**: `boolean`
+
+True if verified. False the opposite.
+
+#### Inherited from
+
+[`IVerificationResult`](IVerificationResult.md).[`verified`](IVerificationResult.md#verified)
+
+***
+
+### verificationFailureReason?
+
+> `optional` **verificationFailureReason**: `string`
+
+Verification failure reason.
+
+#### Inherited from
+
+[`IVerificationResult`](IVerificationResult.md).[`verificationFailureReason`](IVerificationResult.md#verificationfailurereason)

package/docs/reference/interfaces/ICredential.md

@@ -0,0 +1,51 @@
+# Interface: ICredential
+
+A credential with subject.
+
+## Extends
+
+- `IDidVerifiableCredential`
+
+## Extended by
+
+- [`IParticipantCredential`](IParticipantCredential.md)
+- [`IDataResourceCredential`](IDataResourceCredential.md)
+- [`IServiceOfferingCredential`](IServiceOfferingCredential.md)
+- [`IDataSpaceConnectorCredential`](IDataSpaceConnectorCredential.md)
+- [`IComplianceCredential`](IComplianceCredential.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The Id of the credential, it is mandatory.
+
+#### Overrides
+
+`IDidVerifiableCredential.id`
+
+***
+
+### issuer
+
+> **issuer**: `string`
+
+The issuer of the credential, it is mandatory.
+
+#### Overrides
+
+`IDidVerifiableCredential.issuer`
+
+***
+
+### credentialSubject
+
+> **credentialSubject**: `IJsonLdNodeObject` & `object` \| `IJsonLdNodeObject`[] & `object`
+
+Credential subject must always include id and type
+
+#### Overrides
+
+`IDidVerifiableCredential.credentialSubject`

package/docs/reference/interfaces/IDataResourceCredential.md

@@ -0,0 +1,43 @@
+# Interface: IDataResourceCredential
+
+Data Resource 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**: `IDataResource`
+
+The subject of the Credential
+
+#### Overrides
+
+[`ICredential`](ICredential.md).[`credentialSubject`](ICredential.md#credentialsubject)

package/docs/reference/interfaces/IDataResourceEntry.md

@@ -0,0 +1,131 @@
+# Interface: IDataResourceEntry
+
+Interface describing a Data Resource entry.
+
+## Extends
+
+- `ICatalogueBase`.`IDataResource`
+
+## 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
+
+`IDataResource.@context`
+
+***
+
+### producedBy
+
+> **producedBy**: `string`
+
+Overwriting producedBy as we only store the identifier
+
+#### Overrides
+
+`IDataResource.producedBy`
+
+***
+
+### copyrightOwnedBy
+
+> **copyrightOwnedBy**: `string`
+
+Overwriting copyrightOwnedBy as we only store the identifier
+
+#### Overrides
+
+`IDataResource.copyrightOwnedBy`
+
+***
+
+### exposedThrough
+
+> **exposedThrough**: `string`
+
+Overwriting exposedThrough as we only store the id of the Data Exchange Component
+
+#### Overrides
+
+`IDataResource.exposedThrough`
+
+***
+
+### resourcePolicy
+
+> **resourcePolicy**: `IOdrlPolicy`[]
+
+Overwriting to ensure always an array is stored
+
+#### Overrides
+
+`IDataResource.resourcePolicy`

package/docs/reference/interfaces/IDataResourceGetResponse.md

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

package/docs/reference/interfaces/IDataResourceList.md

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

package/docs/reference/interfaces/IDataResourceListRequest.md

@@ -0,0 +1,55 @@
+# Interface: IDataResourceListRequest
+
+Get the a list of the data resource entries.
+
+## Extends
+
+- [`IFederatedCatalogueGetRequest`](IFederatedCatalogueGetRequest.md)
+
+## Properties
+
+### query
+
+> **query**: `object`
+
+The query parameters.
+
+#### id?
+
+> `optional` **id**: `string`
+
+The Id of the Data Resource.
+
+#### producedBy?
+
+> `optional` **producedBy**: `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.
+
+***
+
+### 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)

package/docs/reference/interfaces/IDataResourceListResponse.md

@@ -0,0 +1,11 @@
+# Interface: IDataResourceListResponse
+
+Response fo data resource list.
+
+## Properties
+
+### body
+
+> **body**: [`IDataResourceList`](IDataResourceList.md)
+
+The response payload.

package/docs/reference/interfaces/IDataSpaceConnector.md

@@ -0,0 +1,130 @@
+# Interface: IDataSpaceConnector
+
+TWIN Data Space Connector.
+
+## Extends
+
+- `IDataExchangeComponent`
+
+## Extended by
+
+- [`IDataSpaceConnectorEntry`](IDataSpaceConnectorEntry.md)
+
+## 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
+
+### @context
+
+> **@context**: `GaiaXContextType`
+
+The LD Context.
+
+#### Overrides
+
+`IDataExchangeComponent.@context`
+
+***
+
+### id
+
+> **id**: `string`
+
+A unique identifier given to this Data Space Connector.
+
+***
+
+### type
+
+> **type**: \[`"DataExchangeComponent"`, `"DataSpaceConnector"`, `...string[]`\]
+
+A Connector is a Data Exchange Component
+
+#### Overrides
+
+`IDataExchangeComponent.type`
+
+***
+
+### identity
+
+> **identity**: `string`
+
+Connector's Identity that allows to know public key of this Connector.
+
+***
+
+### maintainer
+
+> **maintainer**: `string`
+
+Who maintains this Data Space Connector.
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+The name of this Data Space Connector
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+A description of this Data Space Connector
+
+***
+
+### defaultEndpoint
+
+> **defaultEndpoint**: `IEndpoint`
+
+The default endpoint of the Connector.
+This endpoint can be used as a base to guess other endpoints in case they are not explicitly declared.
+
+***
+
+### subscriptionActivityEndpoint?
+
+> `optional` **subscriptionActivityEndpoint**: `IEndpoint`
+
+The endpoint used for data subscription by Consumers.
+If the endpoint URL is a relative reference to a URL then it should be resolved using the
+default endpoint URL as a base URL.
+
+***
+
+### pushActivityEndpoint
+
+> **pushActivityEndpoint**: `IEndpoint`
+
+The endpoint used by Providers to push data.
+If the endpoint URL is a relative reference to a URL then it should be resolved using the
+default endpoint URL as a base URL.
+
+***
+
+### pullDataEndpoint
+
+> **pullDataEndpoint**: `IEndpoint`
+
+The endpoint used by Consumers to pull data from.
+If the endpoint URL is a relative reference to a URL then it should be resolved using the
+default endpoint URL as a base URL.
+
+***
+
+### offeredResource
+
+> **offeredResource**: `string`[] \| \{[`resourceId`: `string`]: `IDataResource` \| `IJsonLdNodeObject` & `object`; \}
+
+The resources offered by this Connector.
+A resource index is usually a relative reference to the default endpoint base URL.
+Nonetheless if the resource already declares an endpoint URL that one should be taken.
+It is captured the case where the Data Resource is supplied
+via a list of identifiers or through a map indexed by Id