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

package/dist/types/entities/dataResourceEntry.d.ts

@@ -0,0 +1,59 @@
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+/**
+ * Data Resource Entry.
+ */
+export declare class DataResourceEntry {
+    /**
+     * The Id.
+     */
+    id: string;
+    /**
+     * The trusted issuer of the compliance credential
+     */
+    issuer: string;
+    /**
+     * The name.
+     */
+    name: string;
+    /**
+     * The description.
+     */
+    description?: string;
+    /**
+     * The Id of the producer of the data described by this Data Resource.
+     */
+    producedBy: string;
+    /**
+     * The copyright owner
+     */
+    copyrightOwnedBy: string;
+    /**
+     * The license
+     */
+    license: string;
+    /**
+     * The data exchange component used to expose the Data Resource.
+     * Only a URL pointing to the resource is stored
+     */
+    exposedThrough: string;
+    /**
+     * The Data Resource policy
+     */
+    resourcePolicy: IOdrlPolicy[];
+    /**
+     * Valid from
+     */
+    validFrom: string;
+    /**
+     * Valid to
+     */
+    validUntil: string;
+    /**
+     * Date created
+     */
+    dateCreated: string;
+    /**
+     * Evidences
+     */
+    evidence: string[];
+}

package/dist/types/entities/dataSpaceConnectorEntry.d.ts

@@ -0,0 +1,66 @@
+import type { IEndpoint } from "@twin.org/standards-gaia-x";
+/**
+ * Data Space Connector Entry.
+ */
+export declare class DataSpaceConnectorEntry {
+    /**
+     * The Id.
+     */
+    id: string;
+    /**
+     * The trusted issuer of the compliance credential.
+     */
+    issuer: string;
+    /**
+     * The name.
+     */
+    name?: string;
+    /**
+     * The description.
+     */
+    description?: string;
+    /**
+     * The identity of the Data Space Connector
+     */
+    identity: string;
+    /**
+     * Who maintains the Data Space Connector
+     */
+    maintainer: string;
+    /**
+     * The default endpoint
+     */
+    defaultEndpoint: IEndpoint;
+    /**
+     * The activity push endpoint
+     */
+    pushActivityEndpoint: IEndpoint;
+    /**
+     * The activity subscribe endpoint
+     */
+    subscriptionActivityEndpoint?: IEndpoint;
+    /**
+     * The pull data endpoint
+     */
+    pullDataEndpoint: IEndpoint;
+    /**
+     * The pull data endpoint
+     */
+    offeredResource: string[];
+    /**
+     * Valid from
+     */
+    validFrom: string;
+    /**
+     * Valid to
+     */
+    validUntil: string;
+    /**
+     * Date created
+     */
+    dateCreated: string;
+    /**
+     * Evidences
+     */
+    evidence: string[];
+}

package/dist/types/entities/participantEntry.d.ts

@@ -0,0 +1,42 @@
+import type { IAddress, IRegistrationNumber } from "@twin.org/standards-gaia-x";
+/**
+ * Participant entry.
+ */
+export declare class ParticipantEntry {
+    /**
+     * The participant Id.
+     */
+    id: string;
+    /**
+     * The trusted issuer of the compliance credential
+     */
+    issuer: string;
+    /**
+     * The legal registration number.
+     */
+    registrationNumber: IRegistrationNumber;
+    /**
+     * The legal name.
+     */
+    legalName: string;
+    /**
+     * Address
+     */
+    legalAddress: IAddress;
+    /**
+     * Valid from
+     */
+    validFrom: string;
+    /**
+     * Valid to
+     */
+    validUntil: string;
+    /**
+     * Date created
+     */
+    dateCreated: string;
+    /**
+     * Evidences
+     */
+    evidence: string[];
+}

package/dist/types/entities/serviceOfferingEntry.d.ts

@@ -0,0 +1,55 @@
+import type { IEndpoint } from "@twin.org/standards-gaia-x";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+/**
+ * Service Offering Entry.
+ */
+export declare class ServiceOfferingEntry {
+    /**
+     * The service Id.
+     */
+    id: string;
+    /**
+     * The trusted issuer of the compliance credential associated with
+     */
+    issuer: string;
+    /**
+     * The service name.
+     */
+    name: string;
+    /**
+     * The service description.
+     */
+    description?: string;
+    /**
+     * The provider Id
+     */
+    providedBy: string;
+    /**
+     * The REST endpoint
+     */
+    endpoint: IEndpoint;
+    /**
+     * The policy
+     */
+    servicePolicy: IOdrlPolicy[];
+    /**
+     * Resources aggregated
+     */
+    aggregationOfResources?: string[];
+    /**
+     * Valid from
+     */
+    validFrom: string;
+    /**
+     * Valid to
+     */
+    validUntil: string;
+    /**
+     * Date created
+     */
+    dateCreated: string;
+    /**
+     * Evidences
+     */
+    evidence: string[];
+}

package/dist/types/federatedCatalogueRoutes.d.ts

@@ -0,0 +1,113 @@
+import type { ICreatedResponse, IHttpRequestContext, INotFoundResponse, IRestRoute, ITag } from "@twin.org/api-models";
+import { type ICatalogueEntryGetRequest, type ICompliancePresentationRequest, type IDataResourceGetResponse, type IDataResourceListRequest, type IDataResourceListResponse, type IDataSpaceConnectorGetResponse, type IDataSpaceConnectorListRequest, type IDataSpaceConnectorListResponse, type IParticipantGetResponse, type IParticipantListRequest, type IParticipantListResponse, type IServiceOfferingGetResponse, type IServiceOfferingListRequest, type IServiceOfferingListResponse } from "@twin.org/federated-catalogue-models";
+/**
+ * The tag to associate with the routes.
+ */
+export declare const tagsFederatedCatalogue: ITag[];
+/**
+ * The REST routes for Federated Catalogue.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param factoryServiceName The name of the service to use in the routes store in the ServiceFactory.
+ * @returns The generated routes.
+ */
+export declare function generateRestRoutesFederatedCatalogue(baseRouteName: string, factoryServiceName: string): IRestRoute[];
+/**
+ * Register a new participant.
+ * @param baseRouteName The base route name.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function complianceCredentialPresentation(baseRouteName: string, httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: ICompliancePresentationRequest): Promise<ICreatedResponse>;
+/**
+ * Get a list of the participant entries.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function participantList(httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: IParticipantListRequest): Promise<IParticipantListResponse>;
+/**
+ * Get a Participant entry.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function participantGet(httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: ICatalogueEntryGetRequest): Promise<IParticipantGetResponse | INotFoundResponse>;
+/**
+ * Register a new service offering.
+ * @param baseRouteName The base route used.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function serviceOfferingCredentialPresentation(baseRouteName: string, httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: ICompliancePresentationRequest): Promise<ICreatedResponse>;
+/**
+ * Get a list of the service offering entries.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function serviceOfferingList(httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: IServiceOfferingListRequest): Promise<IServiceOfferingListResponse>;
+/**
+ * Get a Service Offering entry.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function serviceOfferingGet(httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: ICatalogueEntryGetRequest): Promise<IServiceOfferingGetResponse | INotFoundResponse>;
+/**
+ * Register a new data resource.
+ * @param baseRouteName The base route name.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function dataResourceCredentialPresentation(baseRouteName: string, httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: ICompliancePresentationRequest): Promise<ICreatedResponse>;
+/**
+ * Get a list of the data resource entries.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function dataResourceList(httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: IDataResourceListRequest): Promise<IDataResourceListResponse>;
+/**
+ * Get a Data Resource entry.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function dataResourceGet(httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: ICatalogueEntryGetRequest): Promise<IDataResourceGetResponse | INotFoundResponse>;
+/**
+ * Register a new data space connector.
+ * @param baseRouteName the base route name.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function dataSpaceConnectorCredentialPresentation(baseRouteName: string, httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: ICompliancePresentationRequest): Promise<ICreatedResponse>;
+/**
+ * Get a list of the data space connector entries.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function dataSpaceConnectorList(httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: IDataSpaceConnectorListRequest): Promise<IDataSpaceConnectorListResponse>;
+/**
+ * Get a Data Space Connector entry.
+ * @param httpRequestContext The request context for the API.
+ * @param factoryServiceName The name of the service to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function dataSpaceConnectorGet(httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: ICatalogueEntryGetRequest): Promise<IDataSpaceConnectorGetResponse | INotFoundResponse>;

package/dist/types/federatedCatalogueService.d.ts

@@ -0,0 +1,142 @@
+import { type FederatedCatalogueEntryType, type ICatalogueEntry, type IDataResourceList, type IDataSpaceConnectorList, type IFederatedCatalogueComponent, type IParticipantList, type IServiceOfferingList } from "@twin.org/federated-catalogue-models";
+import type { IFederatedCatalogueServiceConstructorOptions } from "./models/IFederatedCatalogueServiceConstructorOptions";
+/**
+ * Service for performing logging operations to a connector.
+ */
+export declare class FederatedCatalogueService implements IFederatedCatalogueComponent {
+    /**
+     * The namespace for the service.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of FederatedCatalogue service.
+     * @param options The options for the connector.
+     */
+    constructor(options: IFederatedCatalogueServiceConstructorOptions);
+    /**
+     * Registers a Participant's compliance Credential.
+     * @param credentialJwt The credential (wrapped into a presentation) as JWT.
+     * @returns The Id of the Participant (DID usually).
+     */
+    registerComplianceCredential(credentialJwt: string): Promise<string>;
+    /**
+     * Query the federated catalogue.
+     * @param id The identity of the participant.
+     * @param legalRegistrationNumber The legal registration number.
+     * @param lrnType The legal registration number type (EORI, VATID, GLEIF, KENYA_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(id?: string, legalRegistrationNumber?: string, lrnType?: string, cursor?: string, pageSize?: number): Promise<IParticipantList>;
+    /**
+     * 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>;
+    /**
+     * Registers a compliance Credential concerning a Data Space Connector.
+     * @param credentialJwt The credential (wrapped into a presentation) as JWT.
+     * @returns The identifier of the Data Space Connector registered.
+     */
+    registerDataSpaceConnectorCredential(credentialJwt: string): Promise<string>;
+    /**
+     * Registers a data resource Credential concerning a Data Space Connector.
+     * @param credentialJwt The credential (wrapped into a presentation) as JWT.
+     * @returns The list of Data Resources created.
+     */
+    registerDataResourceCredential(credentialJwt: string): Promise<string[]>;
+    /**
+     * Query the federated catalogue.
+     * @param id The identity of the participant.
+     * @param maintainer The DS Connector maintainer.
+     * @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.
+     * @param credentialJwt The credential (wrapped into a presentation) as JWT.
+     * @returns Nothing.
+     */
+    registerServiceOfferingCredential(credentialJwt: string): Promise<string[]>;
+    /**
+     * Query the federated catalogue.
+     * @param id Service Id.
+     * @param providedBy The identity of the participant.
+     * @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 identity of the DataResource.
+     * @param producedBy The identity of the participant.
+     * @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>;
+    /**
+     * Decodes the JWT.
+     * @param jwt JWT.
+     * @returns Decoded.
+     */
+    private decodeJwt;
+    /**
+     * Returns the trusted Issuer id.
+     * @param complianceCredential The compliance credential.
+     * @returns The trusted issuer.
+     */
+    private getTrustedIssuerId;
+    /**
+     * Extracts participant entry from the credentials.
+     * @param complianceCredential Compliance credential
+     * @param participantCredential The Participant credential extracted.
+     * @returns Participant Entry to be saved on the Database.
+     */
+    private extractParticipantEntry;
+    /**
+     * Extracts Data Space Connector description entry from the credentials.
+     * @param complianceCredential Compliance Credential.
+     * @param dataSpaceConnectorCredential Evidence Credential.
+     * @returns Service Description Entry to be saved on the Database.
+     */
+    private extractDataSpaceConnectorEntry;
+    /**
+     * Extracts service offering entry from the credentials.
+     * @param complianceCredential The Compliance Credential.
+     * @param serviceOfferingCredential Service Offering credential (evidence).
+     * @returns Service Offering Entry to be saved on the Database.
+     */
+    private extractServiceOfferingEntry;
+    /**
+     * Extracts data resource entry from the credentials.
+     * @param complianceCredential The Compliance Credential.
+     * @param dataResourceCredential Data Resource credential.
+     * @returns DataResource Entry to be saved on the Database.
+     */
+    private extractDataResourceEntry;
+    /**
+     * Checks whether the Participant exists.
+     * @param participantId The Participant identifier
+     */
+    private checkParticipantExists;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./federatedCatalogueRoutes";
+export * from "./federatedCatalogueService";
+export * from "./restEntryPoints";
+export * from "./models/IFederatedCatalogueServiceConstructorOptions";
+export * from "./models/IFederatedCatalogueServiceConfig";
+export * from "./schema";
+export * from "./entities/dataResourceEntry";
+export * from "./entities/serviceOfferingEntry";
+export * from "./entities/participantEntry";
+export * from "./entities/dataSpaceConnectorEntry";

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

@@ -0,0 +1,15 @@
+/**
+ * Federated Catalogue service configuration
+ */
+export interface IFederatedCatalogueServiceConfig {
+    /**
+     * The number of ms that sub-resources can live in the fetch cache.
+     * 0 means they can live forever.
+     * undefined means they are never cached.
+     */
+    subResourceCacheTtlMs?: number;
+    /**
+     * Clearing House approver list
+     */
+    clearingHouseApproverList: string[];
+}

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

@@ -0,0 +1,38 @@
+import type { IFederatedCatalogueServiceConfig } from "./IFederatedCatalogueServiceConfig";
+/**
+ * Federated Catalogue service options
+ */
+export interface IFederatedCatalogueServiceConstructorOptions {
+    /**
+     * The identity resolver component used.
+     */
+    identityResolverComponentType?: string;
+    /**
+     * Logging connector type
+     */
+    loggingConnectorType?: string;
+    /**
+     * The configuration of the Federated Catalogue service.
+     */
+    config: IFederatedCatalogueServiceConfig;
+    /**
+     * The entity storage for participants.
+     * @default participant-entry
+     */
+    participantEntityStorageType?: string;
+    /**
+     * The entity storage for data resources.
+     * @default data-resource-entry
+     */
+    dataResourceEntityStorageType?: string;
+    /**
+     * The entity storage for service offerings.
+     * @default service-offering-entry
+     */
+    serviceOfferingEntityStorageType?: string;
+    /**
+     * The entity storage for data space connectors.
+     * @default data-space-connector-entry
+     */
+    dataSpaceConnectorStorageType?: string;
+}

package/dist/types/restEntryPoints.d.ts

@@ -0,0 +1,2 @@
+import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+export declare const restEntryPoints: IRestRouteEntryPoint[];

package/dist/types/schema.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Inits schemas.
+ */
+export declare function initSchema(): void;

package/dist/types/verification/complianceCredentialVerificationService.d.ts

@@ -0,0 +1,32 @@
+import { type IComplianceCredential, type IComplianceVerificationResult } from "@twin.org/federated-catalogue-models";
+import { type IIdentityResolverComponent } from "@twin.org/identity-models";
+import type { ILoggingConnector } from "@twin.org/logging-models";
+/**
+ * Compliance Credential Verification Service.
+ */
+export declare class ComplianceCredentialVerificationService {
+    /**
+     * Class name
+     */
+    CLASS_NAME: string;
+    /**
+     * Constructor.
+     * @param clearingHouseApproverList The list of clearing house identities approved.
+     * @param resolver The resolver used for DID.
+     * @param subResourceCacheTtlMs The time to live (in ms) of sub-resource objects in the cache. undefined means no cache. 0 means live in cache forever.
+     * @param logger The Logger Component.
+     */
+    constructor(clearingHouseApproverList: string[], resolver: IIdentityResolverComponent, subResourceCacheTtlMs?: number, logger?: ILoggingConnector);
+    /**
+     * Verifies a Compliance Credential.
+     * @param credential The Credential to be verified
+     * @returns The Verification Result.
+     */
+    verify(credential: IComplianceCredential): Promise<IComplianceVerificationResult>;
+    /**
+     * Verifies the evidence supplied as part of a Compliance Credential.
+     * @param evidence The compliance evidence
+     * @returns The verification result with the original credentials that served as evidence
+     */
+    private verifyEvidence;
+}