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

package/dist/types/models/participant/IParticipantList.d.ts

@@ -0,0 +1,25 @@
+import type { SchemaOrgTypes } from "@twin.org/standards-schema-org";
+import type { IParticipantEntry } from "./IParticipantEntry";
+import type { FederatedCatalogueContextType } from "../federatedCatalogueContextType";
+/**
+ * Interface describing a participant entry list.
+ */
+export interface IParticipantList {
+    /**
+     * The LD Context.
+     */
+    "@context": FederatedCatalogueContextType;
+    /**
+     * The type
+     */
+    type: typeof SchemaOrgTypes.ItemList;
+    /**
+     * The components of the Collection
+     *
+     */
+    [SchemaOrgTypes.ItemListElement]: Omit<IParticipantEntry, "@context">[];
+    /**
+     * Next item cursor.
+     */
+    [SchemaOrgTypes.NextItem]?: string;
+}

package/dist/types/models/service-offering/IServiceOfferingCredential.d.ts

@@ -0,0 +1,11 @@
+import type { IServiceOffering } from "@twin.org/standards-gaia-x";
+import type { ICredential } from "../ICredential";
+/**
+ * A Service Offering Credential
+ */
+export interface IServiceOfferingCredential extends ICredential {
+    /**
+     * The Credential Subject
+     */
+    credentialSubject: IServiceOffering;
+}

package/dist/types/models/service-offering/IServiceOfferingEntry.d.ts

@@ -0,0 +1,25 @@
+import type { IServiceOffering } from "@twin.org/standards-gaia-x";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { FederatedCatalogueContextType } from "../federatedCatalogueContextType";
+import type { ICatalogueBase } from "../ICatalogueBase";
+/**
+ * Interface describing a Service Offering.
+ */
+export interface IServiceOfferingEntry extends ICatalogueBase, IServiceOffering {
+    /**
+     * The LD Context
+     */
+    "@context": FederatedCatalogueContextType;
+    /**
+     * Overwrites providedBy as we only store identifier as string
+     */
+    providedBy: string;
+    /**
+     * Overwrites aggregationOfResources as we only store identifier as string
+     */
+    aggregationOfResources?: string[];
+    /**
+     * The service policy is always stored as an array
+     */
+    servicePolicy: IOdrlPolicy[];
+}

package/dist/types/models/service-offering/IServiceOfferingList.d.ts

@@ -0,0 +1,25 @@
+import type { SchemaOrgTypes } from "@twin.org/standards-schema-org";
+import type { IServiceOfferingEntry } from "./IServiceOfferingEntry";
+import type { FederatedCatalogueContextType } from "../federatedCatalogueContextType";
+/**
+ * Interface describing a list of Service Offering Entries.
+ */
+export interface IServiceOfferingList {
+    /**
+     * The LD Context.
+     */
+    "@context": FederatedCatalogueContextType;
+    /**
+     * The type
+     */
+    type: typeof SchemaOrgTypes.ItemList;
+    /**
+     * The components of the Collection
+     *
+     */
+    [SchemaOrgTypes.ItemListElement]: Omit<IServiceOfferingEntry, "@context">[];
+    /**
+     * Next item cursor.
+     */
+    [SchemaOrgTypes.NextItem]?: string;
+}

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

@@ -0,0 +1,53 @@
+/**
+ * The verification failure reasons.
+ */
+export declare const VerificationFailureReasons: {
+    /**
+     * Credential type is invalid.
+     */
+    readonly InvalidCredentialType: "invalidCredentialType";
+    /**
+     * The issuer is invalid.
+     */
+    readonly InvalidIssuer: "invalidIssuer";
+    /**
+     * Credential is not valid yet.
+     */
+    readonly NotValidYet: "notValidYet";
+    /**
+     * Credential ahs expired.
+     */
+    readonly Expired: "expired";
+    /**
+     * Credential's evidence cannot be verified.
+     */
+    readonly EvidenceCannotBeVerified: "evidenceCannotBeVerified";
+    /**
+     * Credential has no expiration.
+     */
+    readonly NoValidityEndPeriod: "noValidityEndPeriod";
+    /**
+     * Credential's subject is missing.
+     */
+    readonly MissingSubject: "missingSubject";
+    /**
+     * Credential's evidences are missing.
+     */
+    readonly MissingEvidences: "missingEvidences";
+    /**
+     * General error happened while verifying and the credential cannot be deemed as verified.
+     */
+    readonly GeneralVerificationError: "generalVerificationError";
+    /**
+     * Credential's integrity check has failed
+     */
+    readonly IntegrityCheckFailed: "integrityCheckFailed";
+    /**
+     * Credential's Evidence cannot be retrieved.
+     */
+    readonly EvidenceCannotBeRetrieved: "evidenceCannotBeRetrieved";
+};
+/**
+ * The verification failure Reasons.
+ */
+export type VerificationFailureReasons = (typeof VerificationFailureReasons)[keyof typeof VerificationFailureReasons];

package/docs/changelog.md

@@ -0,0 +1,12 @@
+# @twin.org/federated-catalogue-models - Changelog
+
+## [0.0.1-next.2](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.1...federated-catalogue-models-v0.0.1-next.2) (2025-05-22)
+
+
+### Features
+
+* version 0 federated catalogue ([#2](https://github.com/twinfoundation/federated-catalogue/issues/2)) ([93fb8bd](https://github.com/twinfoundation/federated-catalogue/commit/93fb8bdbb03aa781ef9e8dc4053beea1b397cc36))
+
+## v0.0.1
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/federated--models - Examples

package/docs/overview.md

@@ -0,0 +1,21 @@
+# Federated Catalogue Models
+
+Models which define the structure of the models used by the Federated Catalogue.
+
+## Installation
+
+```shell
+npm install @twin.org/federatated-catalogue-models
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [examples.md](examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [reference/globals.md](reference/globals.md)
+
+## Changelog
+
+The changes between each version can be found in [changelog.md](changelog.md)

package/docs/reference/classes/FederatedCatalogueContextInstances.md

@@ -0,0 +1,29 @@
+# Class: `abstract` FederatedCatalogueContextInstances
+
+The LD context instances concerning the Federated Catalogue.
+
+## Constructors
+
+### Constructor
+
+> **new FederatedCatalogueContextInstances**(): `FederatedCatalogueContextInstances`
+
+#### Returns
+
+`FederatedCatalogueContextInstances`
+
+## Properties
+
+### DEFAULT\_LD\_CONTEXT\_ENTRY\_LIST
+
+> `static` **DEFAULT\_LD\_CONTEXT\_ENTRY\_LIST**: [`FederatedCatalogueContextType`](../type-aliases/FederatedCatalogueContextType.md)
+
+The LD Context of a list of Catalogue entries.
+
+***
+
+### DEFAULT\_LD\_CONTEXT\_ENTRY
+
+> `static` **DEFAULT\_LD\_CONTEXT\_ENTRY**: [`FederatedCatalogueContextType`](../type-aliases/FederatedCatalogueContextType.md)
+
+The LD Context of a Catalogue entry.

package/docs/reference/index.md

@@ -0,0 +1,57 @@
+# @twin.org/federated-catalogue-models
+
+## Classes
+
+- [FederatedCatalogueContextInstances](classes/FederatedCatalogueContextInstances.md)
+
+## Interfaces
+
+- [IComplianceCredential](interfaces/IComplianceCredential.md)
+- [IComplianceEvidence](interfaces/IComplianceEvidence.md)
+- [IComplianceVerificationResult](interfaces/IComplianceVerificationResult.md)
+- [ICredential](interfaces/ICredential.md)
+- [IFederatedCatalogue](interfaces/IFederatedCatalogue.md)
+- [IVerificationResult](interfaces/IVerificationResult.md)
+- [ICatalogueEntryGetRequest](interfaces/ICatalogueEntryGetRequest.md)
+- [ICompliancePresentationRequest](interfaces/ICompliancePresentationRequest.md)
+- [IDataResourceGetResponse](interfaces/IDataResourceGetResponse.md)
+- [IDataResourceListRequest](interfaces/IDataResourceListRequest.md)
+- [IDataResourceListResponse](interfaces/IDataResourceListResponse.md)
+- [IDataSpaceConnectorGetResponse](interfaces/IDataSpaceConnectorGetResponse.md)
+- [IDataSpaceConnectorListRequest](interfaces/IDataSpaceConnectorListRequest.md)
+- [IDataSpaceConnectorListResponse](interfaces/IDataSpaceConnectorListResponse.md)
+- [IFederatedCatalogueGetRequest](interfaces/IFederatedCatalogueGetRequest.md)
+- [IParticipantGetResponse](interfaces/IParticipantGetResponse.md)
+- [IParticipantListRequest](interfaces/IParticipantListRequest.md)
+- [IParticipantListResponse](interfaces/IParticipantListResponse.md)
+- [IServiceOfferingGetResponse](interfaces/IServiceOfferingGetResponse.md)
+- [IServiceOfferingListRequest](interfaces/IServiceOfferingListRequest.md)
+- [IServiceOfferingListResponse](interfaces/IServiceOfferingListResponse.md)
+- [IDataResourceCredential](interfaces/IDataResourceCredential.md)
+- [IDataResourceEntry](interfaces/IDataResourceEntry.md)
+- [IDataResourceList](interfaces/IDataResourceList.md)
+- [IDataSpaceConnector](interfaces/IDataSpaceConnector.md)
+- [IDataSpaceConnectorCredential](interfaces/IDataSpaceConnectorCredential.md)
+- [IDataSpaceConnectorEntry](interfaces/IDataSpaceConnectorEntry.md)
+- [IDataSpaceConnectorList](interfaces/IDataSpaceConnectorList.md)
+- [IParticipantCredential](interfaces/IParticipantCredential.md)
+- [IParticipantEntry](interfaces/IParticipantEntry.md)
+- [IParticipantList](interfaces/IParticipantList.md)
+- [IServiceOfferingCredential](interfaces/IServiceOfferingCredential.md)
+- [IServiceOfferingEntry](interfaces/IServiceOfferingEntry.md)
+- [IServiceOfferingList](interfaces/IServiceOfferingList.md)
+
+## Type Aliases
+
+- [ICatalogueEntry](type-aliases/ICatalogueEntry.md)
+- [FederatedCatalogueContextType](type-aliases/FederatedCatalogueContextType.md)
+- [FederatedCatalogueContexts](type-aliases/FederatedCatalogueContexts.md)
+- [FederatedCatalogueEntryType](type-aliases/FederatedCatalogueEntryType.md)
+- [FederatedCatalogueTypes](type-aliases/FederatedCatalogueTypes.md)
+- [VerificationFailureReasons](type-aliases/VerificationFailureReasons.md)
+
+## Variables
+
+- [FederatedCatalogueContexts](variables/FederatedCatalogueContexts.md)
+- [FederatedCatalogueTypes](variables/FederatedCatalogueTypes.md)
+- [VerificationFailureReasons](variables/VerificationFailureReasons.md)

package/docs/reference/interfaces/ICatalogueEntryGetRequest.md

@@ -0,0 +1,37 @@
+# Interface: ICatalogueEntryGetRequest
+
+Get a Catalogue Entry.
+
+## Extends
+
+- [`IFederatedCatalogueGetRequest`](IFederatedCatalogueGetRequest.md)
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The ID of the entry (Participant, Service, etc.) to get.
+
+***
+
+### 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/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`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{[`key`: `string`]: `string`; \} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
+## 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)