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

package/dist/types/models/IFederatedCatalogue.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 IFederatedCatalogue 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;
+}

package/dist/types/models/data-space-connector/IDataSpaceConnector.d.ts

@@ -0,0 +1,77 @@
+import type { IJsonLdKeyword, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { GaiaXContextType, GaiaXTypes, IDataExchangeComponent, IDataResource, IEndpoint } from "@twin.org/standards-gaia-x";
+import type { FederatedCatalogueTypes } from "../federatedCatalogueTypes";
+/**
+ * TWIN Data Space Connector.
+ */
+export interface IDataSpaceConnector extends IDataExchangeComponent {
+    /**
+     * The LD Context.
+     */
+    "@context": GaiaXContextType;
+    /**
+     * A unique identifier given to this Data Space Connector.
+     */
+    id: string;
+    /**
+     * A Connector is a Data Exchange Component
+     */
+    type: [
+        typeof GaiaXTypes.DataExchangeComponent,
+        typeof FederatedCatalogueTypes.DataSpaceConnector,
+        ...IJsonLdKeyword["@type"][]
+    ];
+    /**
+     * Connector's Identity that allows to know public key of this Connector.
+     */
+    identity: string;
+    /**
+     * Who maintains this Data Space Connector.
+     */
+    maintainer: string;
+    /**
+     * The name of this Data Space Connector
+     */
+    name?: string;
+    /**
+     * A description of this Data Space Connector
+     */
+    description?: string;
+    /**
+     * 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.
+     */
+    defaultEndpoint: 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.
+     */
+    subscriptionActivityEndpoint?: 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.
+     */
+    pushActivityEndpoint: 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.
+     */
+    pullDataEndpoint: IEndpoint;
+    /**
+     * 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
+     *
+     */
+    offeredResource: string[] | {
+        [resourceId: string]: IDataResource | (IJsonLdNodeObject & {
+            id: string;
+            type: typeof GaiaXTypes.DataResource;
+        });
+    };
+}

package/dist/types/models/data-space-connector/IDataSpaceConnectorCredential.d.ts

@@ -0,0 +1,11 @@
+import type { IDataSpaceConnector } from "./IDataSpaceConnector";
+import type { ICredential } from "../ICredential";
+/**
+ * Participant Credential.
+ */
+export interface IDataSpaceConnectorCredential extends ICredential {
+    /**
+     * The Credential Subject
+     */
+    credentialSubject: IDataSpaceConnector;
+}

package/dist/types/models/data-space-connector/IDataSpaceConnectorEntry.d.ts

@@ -0,0 +1,18 @@
+import type { ICatalogueBase } from "../ICatalogueBase";
+import type { IDataSpaceConnector } from "./IDataSpaceConnector";
+import type { FederatedCatalogueContextType } from "../federatedCatalogueContextType";
+/**
+ * Interface describing a participant.
+ */
+export interface IDataSpaceConnectorEntry extends IDataSpaceConnector, ICatalogueBase {
+    /**
+     * The LD Context
+     */
+    "@context": FederatedCatalogueContextType;
+    /**
+     * Offered resources. Probably in the future this wll be separated in a different entry so
+     * that a  Data Space Connector entry does not need to be modified when a new Data Resource
+     * is offered.
+     */
+    offeredResource: string[];
+}

package/dist/types/models/data-space-connector/IDataSpaceConnectorList.d.ts

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

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

@@ -0,0 +1,14 @@
+import type { FederatedCatalogueContextType } from "./federatedCatalogueContextType";
+/**
+ * The LD context instances concerning the Federated Catalogue.
+ */
+export declare abstract class FederatedCatalogueContextInstances {
+    /**
+     * The LD Context of a list of Catalogue entries.
+     */
+    static DEFAULT_LD_CONTEXT_ENTRY_LIST: FederatedCatalogueContextType;
+    /**
+     * The LD Context of a Catalogue entry.
+     */
+    static DEFAULT_LD_CONTEXT_ENTRY: FederatedCatalogueContextType;
+}

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

@@ -0,0 +1,11 @@
+import type { GaiaXContexts } from "@twin.org/standards-gaia-x";
+import type { SchemaOrgContexts } from "@twin.org/standards-schema-org";
+import type { FederatedCatalogueContexts } from "./federatedCatalogueContexts";
+/**
+ * Type that defines the LD Context for the Federated Catalogue entities and entries.
+ */
+export type FederatedCatalogueContextType = [
+    typeof SchemaOrgContexts.ContextRoot,
+    typeof GaiaXContexts.GaiaXLdContext,
+    typeof FederatedCatalogueContexts.ContextRoot
+];

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

@@ -0,0 +1,13 @@
+/**
+ * The LD context concerning the Federated Catalogue.
+ */
+export declare const FederatedCatalogueContexts: {
+    /**
+     * A Credential that is compliant.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/federated-catalogue/types.jsonld";
+};
+/**
+ * The Exported types
+ */
+export type FederatedCatalogueContexts = (typeof FederatedCatalogueContexts)[keyof typeof FederatedCatalogueContexts];

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

@@ -0,0 +1,7 @@
+import type { GaiaXTypes } from "@twin.org/standards-gaia-x";
+import type { FederatedCatalogueTypes } from "./federatedCatalogueTypes";
+/**
+ * Types of entries in the Federated Catalogue
+ *
+ */
+export type FederatedCatalogueEntryType = typeof GaiaXTypes.Participant | typeof GaiaXTypes.DataExchangeComponent | typeof GaiaXTypes.DataResource | typeof GaiaXTypes.ServiceOffering | typeof FederatedCatalogueTypes.DataSpaceConnector;

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

@@ -0,0 +1,25 @@
+/**
+ * The types concerning the Federated Catalogue.
+ */
+export declare const FederatedCatalogueTypes: {
+    /**
+     * A Credential that is compliant.
+     */
+    readonly CompliantCredential: "CompliantCredential";
+    /**
+     * A Compliance Credential.
+     */
+    readonly ComplianceCredential: "ComplianceCredential";
+    /**
+     * A Data Space Connector.
+     */
+    readonly DataSpaceConnector: "DataSpaceConnector";
+    /**
+     * Id property.
+     */
+    readonly Id: "id";
+};
+/**
+ * The Exported types
+ */
+export type FederatedCatalogueTypes = (typeof FederatedCatalogueTypes)[keyof typeof FederatedCatalogueTypes];

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

@@ -0,0 +1,11 @@
+import type { IParticipant } from "@twin.org/standards-gaia-x";
+import type { ICredential } from "../ICredential";
+/**
+ * Participant Credential.
+ */
+export interface IParticipantCredential extends ICredential {
+    /**
+     * The Credential Subject
+     */
+    credentialSubject: IParticipant;
+}

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

@@ -0,0 +1,12 @@
+import type { IParticipant } from "@twin.org/standards-gaia-x";
+import type { FederatedCatalogueContextType } from "../federatedCatalogueContextType";
+import type { ICatalogueBase } from "../ICatalogueBase";
+/**
+ * Interface describing a participant.
+ */
+export interface IParticipantEntry extends IParticipant, ICatalogueBase {
+    /**
+     * The LD Context
+     */
+    "@context": FederatedCatalogueContextType;
+}