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

package/dist/types/dataTypes/federatedCatalogueDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all the data types for federated catalogue.
+ */
+export declare class FederatedCatalogueDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,42 @@
+export * from "./models/api/IFederatedCatalogueGetRequest";
+export * from "./models/api/ICompliancePresentationRequest";
+export * from "./models/api/IParticipantListRequest";
+export * from "./models/api/IServiceOfferingListRequest";
+export * from "./models/api/IDataResourceListRequest";
+export * from "./models/api/IParticipantListResponse";
+export * from "./models/api/IServiceOfferingListResponse";
+export * from "./models/api/IDataResourceListResponse";
+export * from "./models/api/ICatalogueEntryGetRequest";
+export * from "./models/api/IParticipantGetResponse";
+export * from "./models/api/IServiceOfferingGetResponse";
+export * from "./models/api/IDataResourceGetResponse";
+export * from "./models/api/IDataSpaceConnectorGetResponse";
+export * from "./models/api/IDataSpaceConnectorListRequest";
+export * from "./models/api/IDataSpaceConnectorListResponse";
+export * from "./models/participant/IParticipantEntry";
+export * from "./models/participant/IParticipantList";
+export * from "./models/participant/IParticipantCredential";
+export * from "./models/data-resource/IDataResourceEntry";
+export * from "./models/data-resource/IDataResourceList";
+export * from "./models/data-resource/IDataResourceCredential";
+export * from "./models/service-offering/IServiceOfferingEntry";
+export * from "./models/service-offering/IServiceOfferingList";
+export * from "./models/service-offering/IServiceOfferingCredential";
+export * from "./models/data-space-connector/IDataSpaceConnector";
+export * from "./models/data-space-connector/IDataSpaceConnectorEntry";
+export * from "./models/data-space-connector/IDataSpaceConnectorList";
+export * from "./models/data-space-connector/IDataSpaceConnectorCredential";
+export * from "./models/IFederatedCatalogueComponent";
+export * from "./models/IComplianceCredential";
+export * from "./models/IComplianceEvidence";
+export * from "./models/IVerificationResult";
+export * from "./models/IComplianceVerificationResult";
+export * from "./models/federatedCatalogueTypes";
+export * from "./models/federatedCatalogueContexts";
+export * from "./models/federatedCatalogueContextInstances";
+export * from "./models/ICredential";
+export * from "./models/verificationFailureReasons";
+export * from "./models/federatedCatalogueContextType";
+export * from "./models/federatedCatalogueEntryType";
+export * from "./dataTypes/federatedCatalogueDataTypes";
+export * from "./models/ICatalogueEntry";

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

@@ -0,0 +1,25 @@
+/**
+ * Catalogue entry base fields.
+ */
+export interface ICatalogueBase {
+    /**
+     * The trusted issuer of the compliance credential
+     */
+    issuer: string;
+    /**
+     * Valid from (as per W3C VC Data Model v2)
+     */
+    validFrom: string;
+    /**
+     * Valid until (as per W3C VC Data Model v2)
+     */
+    validUntil: string;
+    /**
+     * The creation date.
+     */
+    dateCreated: string;
+    /**
+     * The evidences concerning the data resource.
+     */
+    evidence: string[];
+}

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

@@ -0,0 +1,8 @@
+import type { IDataResourceEntry } from "./data-resource/IDataResourceEntry";
+import type { IDataSpaceConnectorEntry } from "./data-space-connector/IDataSpaceConnectorEntry";
+import type { IParticipantEntry } from "./participant/IParticipantEntry";
+import type { IServiceOfferingEntry } from "./service-offering/IServiceOfferingEntry";
+/**
+ * Catalogue entry base fields.
+ */
+export type ICatalogueEntry = IParticipantEntry | IDataSpaceConnectorEntry | IServiceOfferingEntry | IDataResourceEntry;

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

@@ -0,0 +1,37 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { GaiaXContexts } from "@twin.org/standards-gaia-x";
+import type { DidContexts, DidTypes } from "@twin.org/standards-w3c-did";
+import type { FederatedCatalogueTypes } from "./federatedCatalogueTypes";
+import type { IComplianceEvidence } from "./IComplianceEvidence";
+import type { ICredential } from "./ICredential";
+/**
+ * A Compliance credential.
+ */
+export interface IComplianceCredential extends ICredential {
+    /**
+     * The LD Context.
+     */
+    "@context": [
+        typeof DidContexts.ContextVCv2,
+        typeof GaiaXContexts.ContextRoot,
+        typeof DidContexts.ContextSecurityJws2020,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * Type of Credential.
+     */
+    type: [typeof DidTypes.VerifiableCredential, typeof FederatedCatalogueTypes.ComplianceCredential];
+    /**
+     * A compliance credential requires a validity period
+     */
+    validFrom: string;
+    /**
+     * A compliance credential requires a validity period
+     */
+    validUntil: string;
+    /**
+     * Compliance evidence. It is mandatory.
+     *
+     */
+    evidence: IComplianceEvidence[];
+}

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

@@ -0,0 +1,26 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { FederatedCatalogueTypes } from "./federatedCatalogueTypes";
+/**
+ * Compliance Evidence.
+ */
+export interface IComplianceEvidence extends IJsonLdNodeObject {
+    /**
+     * Resolvable Id that allows to get access to the credential that serves as evidence.
+     */
+    id: string;
+    /**
+     * Type of evidence.
+     */
+    type: typeof FederatedCatalogueTypes.CompliantCredential;
+    /**
+     * 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.
+     */
+    digestSRI: string;
+    /**
+     * Original type
+     *
+     */
+    credentialType: string | string[];
+}

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

@@ -0,0 +1,19 @@
+import type { ICredential } from "./ICredential";
+import type { IVerificationResult } from "./IVerificationResult";
+/**
+ * Compliance verification result
+ */
+export interface IComplianceVerificationResult extends IVerificationResult {
+    /**
+     * The credentials involved
+     */
+    credentials: ICredential[];
+    /**
+     * Filled in case an evidence cannot be verified to provide the reason
+     */
+    evidenceVerificationResult?: IVerificationResult;
+    /**
+     * The evidences that failed to be verified.
+     */
+    evidenceFailedToVerify?: string[];
+}

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

@@ -0,0 +1,21 @@
+import type { IDidVerifiableCredential } from "@twin.org/standards-w3c-did";
+/**
+ * A credential with subject.
+ */
+export interface ICredential extends IDidVerifiableCredential {
+    /**
+     * The Id of the credential, it is mandatory.
+     */
+    id: string;
+    /**
+     * The issuer of the credential, it is mandatory.
+     */
+    issuer: string;
+    /**
+     * Credential subject must always include id and type
+     */
+    credentialSubject: IDidVerifiableCredential["credentialSubject"] & {
+        id: string;
+        type: string | string[];
+    };
+}

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

@@ -0,0 +1,89 @@
+import type { IComponent } from "@twin.org/core";
+import type { IDataResourceList } from "./data-resource/IDataResourceList";
+import type { IDataSpaceConnectorList } from "./data-space-connector/IDataSpaceConnectorList";
+import type { FederatedCatalogueEntryType } from "./federatedCatalogueEntryType";
+import type { ICatalogueEntry } from "./ICatalogueEntry";
+import type { IParticipantList } from "./participant/IParticipantList";
+import type { IServiceOfferingList } from "./service-offering/IServiceOfferingList";
+/**
+ * Interface describing a Federated Catalogue Contract.
+ */
+export interface IFederatedCatalogueComponent extends IComponent {
+    /**
+     * Registers a Participant's compliance Credential to the service.
+     * @param credential The credential as JWT.
+     * @returns The participant Id (usually a DID).
+     */
+    registerComplianceCredential(credential: string): Promise<string>;
+    /**
+     * Query the federated catalogue.
+     * @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.
+     * @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>;
+    /**
+     * Registers a Data Space Connector to the service.
+     * @param credential The credential as JWT.
+     * @returns The Data Space Connector Id registered.
+     */
+    registerDataSpaceConnectorCredential(credential: string): Promise<string>;
+    /**
+     * 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.
+     * @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>;
+    /**
+     * Registers a service offering Credential to the service.
+     * @param credential The credential as JWT.
+     * @returns The Id of the Service Offerings registered.
+     */
+    registerServiceOfferingCredential(credential: string): Promise<string[]>;
+    /**
+     * Registers a data resource Credential to the service.
+     * @param credential The credential as JWT.
+     * @returns The Id of the Data Resources registered.
+     */
+    registerDataResourceCredential(credential: string): Promise<string[]>;
+    /**
+     * 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.
+     * @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>;
+    /**
+     * 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.
+     * @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>;
+    /**
+     * Returns a Federated Catalogue entry.
+     * @param entryType The type of entry.
+     * @param entryId The entry's id.
+     * @returns Catalogue Entry
+     * @throws NotFoundError if not found.
+     */
+    getEntry(entryType: FederatedCatalogueEntryType, entryId: string): Promise<ICatalogueEntry>;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Verification Result
+ */
+export interface IVerificationResult {
+    /**
+     * True if verified. False the opposite.
+     */
+    verified: boolean;
+    /**
+     * Verification failure reason.
+     */
+    verificationFailureReason?: string;
+}

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

@@ -0,0 +1,15 @@
+import type { IFederatedCatalogueGetRequest } from "./IFederatedCatalogueGetRequest";
+/**
+ * Get a Catalogue Entry.
+ */
+export interface ICatalogueEntryGetRequest extends IFederatedCatalogueGetRequest {
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The ID of the entry (Participant, Service, etc.) to get.
+         */
+        id: string;
+    };
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Register a new Compliance Credential.
+ */
+export interface ICompliancePresentationRequest {
+    /**
+     * The data to be used in the create.
+     */
+    body: string;
+}

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

@@ -0,0 +1,10 @@
+import type { IDataResourceEntry } from "../data-resource/IDataResourceEntry";
+/**
+ * Service Offering response
+ */
+export interface IDataResourceGetResponse {
+    /**
+     * The response payload.
+     */
+    body: IDataResourceEntry;
+}

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

@@ -0,0 +1,27 @@
+import type { IFederatedCatalogueGetRequest } from "./IFederatedCatalogueGetRequest";
+/**
+ * Get the a list of the data resource entries.
+ */
+export interface IDataResourceListRequest extends IFederatedCatalogueGetRequest {
+    /**
+     * The query parameters.
+     */
+    query: {
+        /**
+         * The Id of the Data Resource.
+         */
+        id?: string;
+        /**
+         * The service provider.
+         */
+        producedBy?: string;
+        /**
+         * The optional cursor to get next chunk.
+         */
+        cursor?: string;
+        /**
+         * The maximum number of entities in a page.
+         */
+        pageSize?: number;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IDataResourceList } from "../data-resource/IDataResourceList";
+/**
+ * Response fo data resource list.
+ */
+export interface IDataResourceListResponse {
+    /**
+     * The response payload.
+     */
+    body: IDataResourceList;
+}

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

@@ -0,0 +1,10 @@
+import type { IDataSpaceConnectorEntry } from "../data-space-connector/IDataSpaceConnectorEntry";
+/**
+ * Service Offering response
+ */
+export interface IDataSpaceConnectorGetResponse {
+    /**
+     * The response payload.
+     */
+    body: IDataSpaceConnectorEntry;
+}

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

@@ -0,0 +1,27 @@
+import type { IFederatedCatalogueGetRequest } from "./IFederatedCatalogueGetRequest";
+/**
+ * Get the a list of the data space connector entries.
+ */
+export interface IDataSpaceConnectorListRequest extends IFederatedCatalogueGetRequest {
+    /**
+     * The query parameters.
+     */
+    query: {
+        /**
+         * The id of the Data Space Connector.
+         */
+        id?: string;
+        /**
+         * The maintainer
+         */
+        maintainedBy?: string;
+        /**
+         * The optional cursor to get next chunk.
+         */
+        cursor?: string;
+        /**
+         * The maximum number of entities in a page.
+         */
+        pageSize?: number;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IDataSpaceConnectorList } from "../data-space-connector/IDataSpaceConnectorList";
+/**
+ * Response for Data Space Connector list
+ */
+export interface IDataSpaceConnectorListResponse {
+    /**
+     * The response payload.
+     */
+    body: IDataSpaceConnectorList;
+}

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

@@ -0,0 +1,12 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * Base interface for Federated Catalogue Get Requests
+ */
+export interface IFederatedCatalogueGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IParticipantEntry } from "../participant/IParticipantEntry";
+/**
+ * Response for a Participant Entry.
+ */
+export interface IParticipantGetResponse {
+    /**
+     * The response payload.
+     */
+    body: IParticipantEntry;
+}

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

@@ -0,0 +1,31 @@
+import type { IFederatedCatalogueGetRequest } from "./IFederatedCatalogueGetRequest";
+/**
+ * Get the a list of the participant entries.
+ */
+export interface IParticipantListRequest extends IFederatedCatalogueGetRequest {
+    /**
+     * The query parameters.
+     */
+    query: {
+        /**
+         * The participant Id.
+         */
+        id?: string;
+        /**
+         * The legal registration number.
+         */
+        registrationNumber?: string;
+        /**
+         * The legal registration number type.
+         */
+        lrnType?: string;
+        /**
+         * The optional cursor to get next chunk.
+         */
+        cursor?: string;
+        /**
+         * The maximum number of entities in a page.
+         */
+        pageSize?: number;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IParticipantList } from "../participant/IParticipantList";
+/**
+ * Response for participant list query
+ */
+export interface IParticipantListResponse {
+    /**
+     * The response payload.
+     */
+    body: IParticipantList;
+}

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

@@ -0,0 +1,10 @@
+import type { IServiceOfferingEntry } from "../service-offering/IServiceOfferingEntry";
+/**
+ * Service Offering response
+ */
+export interface IServiceOfferingGetResponse {
+    /**
+     * The response payload.
+     */
+    body: IServiceOfferingEntry;
+}

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

@@ -0,0 +1,27 @@
+import type { IFederatedCatalogueGetRequest } from "./IFederatedCatalogueGetRequest";
+/**
+ * Get the a list of the service offering entries.
+ */
+export interface IServiceOfferingListRequest extends IFederatedCatalogueGetRequest {
+    /**
+     * The query parameters.
+     */
+    query: {
+        /**
+         * The Service Offering Id.
+         */
+        id?: string;
+        /**
+         * The service provider.
+         */
+        providedBy?: string;
+        /**
+         * The optional cursor to get next chunk.
+         */
+        cursor?: string;
+        /**
+         * The maximum number of entities in a page.
+         */
+        pageSize?: number;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IServiceOfferingList } from "../service-offering/IServiceOfferingList";
+/**
+ * Response for Service Offering list
+ */
+export interface IServiceOfferingListResponse {
+    /**
+     * The response payload.
+     */
+    body: IServiceOfferingList;
+}

package/dist/types/models/data-resource/IDataResourceCredential.d.ts

@@ -0,0 +1,11 @@
+import type { IDataResource } from "@twin.org/standards-gaia-x";
+import type { ICredential } from "../ICredential";
+/**
+ * Data Resource Credential
+ */
+export interface IDataResourceCredential extends ICredential {
+    /**
+     * The subject of the Credential
+     */
+    credentialSubject: IDataResource;
+}

package/dist/types/models/data-resource/IDataResourceEntry.d.ts

@@ -0,0 +1,29 @@
+import type { IDataResource } 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 Data Resource entry.
+ */
+export interface IDataResourceEntry extends ICatalogueBase, IDataResource {
+    /**
+     * The LD Context
+     */
+    "@context": FederatedCatalogueContextType;
+    /**
+     * Overwriting producedBy as we only store the identifier
+     */
+    producedBy: string;
+    /**
+     * Overwriting copyrightOwnedBy as we only store the identifier
+     */
+    copyrightOwnedBy: string;
+    /**
+     * Overwriting exposedThrough as we only store the id of the Data Exchange Component
+     */
+    exposedThrough: string;
+    /**
+     * Overwriting to ensure always an array is stored
+     */
+    resourcePolicy: IOdrlPolicy[];
+}

package/dist/types/models/data-resource/IDataResourceList.d.ts

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