@twin.org/dataspace-models 0.0.3-next.15

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

@@ -0,0 +1,29 @@
+/**
+ * The details related to the processing of an Activity
+ */
+export interface IActivityLogDetails {
+    /**
+     * The Id of the Activity Log entry.
+     */
+    id: string;
+    /**
+     * The activity Id that this entry refers to.
+     */
+    activityId?: string;
+    /**
+     * The identity of the Activity's generator.
+     */
+    generator: string;
+    /**
+     * The creation date of this object.
+     */
+    dateCreated: string;
+    /**
+     * The last update date of this object.
+     */
+    dateModified: string;
+    /**
+     * Number of times this activity has been retried.
+     */
+    retryCount?: number;
+}

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

@@ -0,0 +1,40 @@
+import type { IError } from "@twin.org/core";
+import type { ActivityProcessingStatus } from "./activityProcessingStatus.js";
+import type { IActivityLogDates } from "./IActivityLogDates.js";
+import type { IActivityLogDetails } from "./IActivityLogDetails.js";
+import type { ITaskApp } from "./ITaskApp.js";
+/**
+ * The details related to the processing of an Activity
+ */
+export interface IActivityLogEntry extends IActivityLogDetails {
+    /**
+     * Status of the Activity Processing.
+     */
+    status: ActivityProcessingStatus;
+    /**
+     * The pending tasks that have to be run to process the Activity.
+     */
+    pendingTasks?: ITaskApp[];
+    /**
+     * The running tasks that are processing the Activity.
+     */
+    runningTasks?: (ITaskApp & IActivityLogDates)[];
+    /**
+     * The tasks that have already finalized.
+     */
+    finalizedTasks?: (ITaskApp & IActivityLogDates & {
+        /**
+         * The task result.
+         */
+        result: string;
+    })[];
+    /**
+     * The tasks that are in error.
+     */
+    inErrorTasks?: (ITaskApp & {
+        /**
+         * The error that happened
+         */
+        error: IError;
+    })[];
+}

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

@@ -0,0 +1,31 @@
+import type { TaskStatus } from "@twin.org/background-task-models";
+/**
+ * The status supplied to clients of the Dataspace Data Plane
+ */
+export interface IActivityLogStatusNotification {
+    /**
+     * The activity log entry id.
+     */
+    activityLogEntryId: string;
+    /**
+     * The activity Id.
+     */
+    activityId?: string;
+    /**
+     * The activity processing status through the associated tasks.
+     */
+    taskProcessingStatus: {
+        /**
+         * The task reported.
+         */
+        taskId: string;
+        /**
+         * The Dataspace App.
+         */
+        dataspaceAppId: string;
+        /**
+         * The status of the task reported. Only terminated and error are reported.
+         */
+        taskStatus: TaskStatus;
+    };
+}

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

@@ -0,0 +1,14 @@
+import type { ITaskApp } from "./ITaskApp.js";
+/**
+ * Denotes a task associated with an Activity
+ */
+export interface IActivityTask {
+    /**
+     * The activity log entry.
+     */
+    activityLogEntryId: string;
+    /**
+     * The associated tasks
+     */
+    associatedTasks: ITaskApp[];
+}

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

@@ -0,0 +1,21 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
+/**
+ * Interface describing a list of entities that are within a Data Asset.
+ * Pagination is handled via HTTP Link headers.
+ */
+export interface IDataAssetItemList {
+    /**
+     * The LD Context.
+     */
+    "@context": typeof SchemaOrgContexts.Context;
+    /**
+     * The type
+     */
+    type: typeof SchemaOrgTypes.ItemList;
+    /**
+     * The components of the Collection
+     *
+     */
+    [SchemaOrgTypes.ItemListElement]: IJsonLdNodeObject[];
+}

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

@@ -0,0 +1,16 @@
+import type { IDataAssetItemList } from "./IDataAssetItemList.js";
+/**
+ * Result containing the data asset item list and optional pagination cursor.
+ * The cursor is returned via HTTP Link headers (RFC 8288), not in the response body.
+ */
+export interface IDataAssetItemListResult {
+    /**
+     * The item list data.
+     */
+    itemList: IDataAssetItemList;
+    /**
+     * Pagination cursor for retrieving the next page.
+     * This is used to generate the Link header, not included in the response body.
+     */
+    cursor?: string;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Part of the Data Request interface to represent a set of entities either by id or by type
+ */
+export interface IEntitySet {
+    /**
+     * Entity Id.
+     */
+    entityId?: string[];
+    /**
+     * The entity type.
+     */
+    entityType: string;
+}

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

@@ -0,0 +1,18 @@
+import type { IActivityStreamsActivity } from "@twin.org/standards-w3c-activity-streams";
+/**
+ * Execution payload.
+ */
+export interface IExecutionPayload {
+    /**
+     * The Activity Log Entry Id.
+     */
+    activityLogEntryId: string;
+    /**
+     * The activity
+     */
+    activity: IActivityStreamsActivity;
+    /**
+     * The executor App.
+     */
+    executorApp: string;
+}

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

@@ -0,0 +1,18 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+/**
+ * A query over a data asset that to be processed by a Dataspace Data Plane App.
+ */
+export interface IFilteringQuery {
+    /**
+     * The query type.
+     */
+    type: string;
+    /**
+     * The representation of the query.
+     */
+    q: unknown;
+    /**
+     * The JSON-LD context to be applied over the query terms.
+     */
+    jsonLdContext?: IJsonLdContextDefinitionElement[];
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Denotes a task associated with a Dataspace App
+ */
+export interface ITaskApp {
+    /**
+     * Task Id.
+     */
+    taskId: string;
+    /**
+     * Dataspace App Id.
+     */
+    dataspaceAppId: string;
+}

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

@@ -0,0 +1,29 @@
+/**
+ * Activity processing statuses.
+ */
+export declare const ActivityProcessingStatus: {
+    /**
+     * Pending: Activity Processing has not started yet.
+     */
+    readonly Pending: "pending";
+    /**
+     * Running Activity processing is running.
+     */
+    readonly Running: "running";
+    /**
+     * Completed: Activity processing completed without error.
+     */
+    readonly Completed: "completed";
+    /**
+     * Error: Activity processing cannot be performed and marked as in error. (Depends on application).
+     */
+    readonly Error: "error";
+    /**
+     * Transient state. The background tasks associated with the activity are still being registered.
+     */
+    readonly Registering: "registering";
+};
+/**
+ * The type exported.
+ */
+export type ActivityProcessingStatus = (typeof ActivityProcessingStatus)[keyof typeof ActivityProcessingStatus];

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

@@ -0,0 +1,14 @@
+/**
+ * Get Request for an Activity Log Entry.
+ */
+export interface IActivityLogEntryGetRequest {
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The ID of the entry to get.
+         */
+        id: string;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IActivityLogEntry } from "../IActivityLogEntry.js";
+/**
+ * Service Offering response
+ */
+export interface IActivityLogEntryGetResponse {
+    /**
+     * The response payload.
+     */
+    body: IActivityLogEntry;
+}

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

@@ -0,0 +1,10 @@
+import type { IActivityLogStatusNotification } from "../IActivityLogStatusNotification.js";
+/**
+ * The status supplied to clients of the Dataspace Data Plane
+ */
+export interface IActivityLogStatusNotificationPayload {
+    /**
+     * Body
+     */
+    body: IActivityLogStatusNotification;
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Activity log status
+ */
+export interface IActivityLogStatusRequest {
+    /**
+     * Empty body.
+     */
+    body: {
+        /**
+         * The operation to perform.
+         */
+        operation: "subscribe" | "unsubscribe";
+        /**
+         * The subscription Id.
+         */
+        subscriptionId: string;
+    };
+}

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

@@ -0,0 +1,10 @@
+import type { IActivityStreamsActivity } from "@twin.org/standards-w3c-activity-streams";
+/**
+ * Activity Stream Notify Request.
+ */
+export interface IActivityStreamNotifyRequest {
+    /**
+     * The Activity sent to the Stream.
+     */
+    body: IActivityStreamsActivity;
+}

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

@@ -0,0 +1,17 @@
+import type { HeaderTypes } from "@twin.org/web";
+import type { IDataAssetItemList } from "../IDataAssetItemList.js";
+/**
+ * Response containing data asset entities with optional pagination Link header.
+ */
+export interface IDataAssetEntitiesResponse {
+    /**
+     * Optional headers.
+     */
+    headers?: {
+        [HeaderTypes.Link]?: string | string[];
+    };
+    /**
+     * The response payload.
+     */
+    body: IDataAssetItemList;
+}

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

@@ -0,0 +1,43 @@
+import type { HeaderTypes } from "@twin.org/web";
+/**
+ * Get Request Data Asset Entities
+ */
+export interface IDataAssetGetEntitiesRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Authorization]?: string;
+    };
+    /**
+     * The parameters from the query.
+     */
+    query: {
+        /**
+         * The ID of the entity(ies) to get. (comma separated list)
+         */
+        id?: string;
+        /**
+         * The type of the entity to get.
+         */
+        type: string;
+        /**
+         * The consumer Process ID from the DSP Transfer Process.
+         * Mandatory - used to determine the Dataset, Distribution, and Agreement.
+         * The datasetId is resolved from the Transfer Process using this ID.
+         */
+        consumerPid: string;
+        /**
+         * The Id of the data service that offers the data asset
+         */
+        dataServiceId?: string;
+        /**
+         * The maximum number of entities to retrieve.
+         */
+        limit?: string;
+        /**
+         * Cursor to control pagination.
+         */
+        cursor?: string;
+    };
+}

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

@@ -0,0 +1,42 @@
+import type { HeaderTypes } from "@twin.org/web";
+import type { IFilteringQuery } from "../IFilteringQuery.js";
+/**
+ * Request to query data asset entities.
+ */
+export interface IDataAssetQueryRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Authorization]?: string;
+    };
+    /**
+     * Request body containing the data asset and query criteria.
+     */
+    body: {
+        /**
+         * The consumer Process ID from the DSP Transfer Process.
+         * Mandatory - used to determine the Dataset, Distribution, and Agreement.
+         * The datasetId is resolved from the Transfer Process using this ID.
+         */
+        consumerPid: string;
+        /**
+         * The filtering query.
+         */
+        query: IFilteringQuery;
+    };
+    /**
+     * Optional query parameters for pagination.
+     * Used when following Link header URLs.
+     */
+    query?: {
+        /**
+         * Opaque cursor token for pagination.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of items to return.
+         */
+        limit?: string;
+    };
+}

package/dist/types/models/api/control-plane/ICompleteTransferRequest.d.ts

@@ -0,0 +1,26 @@
+import type { IDataspaceProtocolTransferCompletionMessage } from "@twin.org/standards-dataspace-protocol";
+import type { HeaderTypes } from "@twin.org/web";
+/**
+ * API request for completing a transfer process.
+ */
+export interface ICompleteTransferRequest {
+    /**
+     * Path parameters containing the process ID.
+     */
+    pathParams: {
+        /**
+         * Process ID (consumerPid).
+         */
+        pid: string;
+    };
+    /**
+     * Authorization header containing the Base64-encoded trust payload.
+     */
+    headers: {
+        [HeaderTypes.Authorization]: string;
+    };
+    /**
+     * Transfer completion message (DSP compliant).
+     */
+    body: IDataspaceProtocolTransferCompletionMessage;
+}

package/dist/types/models/api/control-plane/ICompleteTransferResponse.d.ts

@@ -0,0 +1,15 @@
+import type { IDataspaceProtocolTransferProcess, IDataspaceProtocolTransferError } from "@twin.org/standards-dataspace-protocol";
+import type { HttpStatusCode } from "@twin.org/web";
+/**
+ * API response for completing a transfer process.
+ */
+export interface ICompleteTransferResponse {
+    /**
+     * Transfer Process (DSP compliant) with state COMPLETED, or error.
+     */
+    body: IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError;
+    /**
+     * HTTP status code for the response.
+     */
+    statusCode?: HttpStatusCode;
+}

package/dist/types/models/api/control-plane/IGetTransferProcessRequest.d.ts

@@ -0,0 +1,21 @@
+import type { HeaderTypes } from "@twin.org/web";
+/**
+ * API request for getting a transfer process state.
+ */
+export interface IGetTransferProcessRequest {
+    /**
+     * Path parameters containing the process ID.
+     */
+    pathParams: {
+        /**
+         * Process ID (consumerPid or providerPid).
+         */
+        pid: string;
+    };
+    /**
+     * Authorization header containing the Base64-encoded trust payload.
+     */
+    headers: {
+        [HeaderTypes.Authorization]: string;
+    };
+}

package/dist/types/models/api/control-plane/IGetTransferProcessResponse.d.ts

@@ -0,0 +1,15 @@
+import type { IDataspaceProtocolTransferProcess, IDataspaceProtocolTransferError } from "@twin.org/standards-dataspace-protocol";
+import type { HttpStatusCode } from "@twin.org/web";
+/**
+ * API response for getting a transfer process state.
+ */
+export interface IGetTransferProcessResponse {
+    /**
+     * Transfer Process (DSP compliant) with current state, or error.
+     */
+    body: IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError;
+    /**
+     * HTTP status code for the response.
+     */
+    statusCode?: HttpStatusCode;
+}

package/dist/types/models/api/control-plane/IRequestTransferRequest.d.ts

@@ -0,0 +1,17 @@
+import type { IDataspaceProtocolTransferRequestMessage } from "@twin.org/standards-dataspace-protocol";
+import type { HeaderTypes } from "@twin.org/web";
+/**
+ * API request for requesting a transfer process.
+ */
+export interface IRequestTransferRequest {
+    /**
+     * Authorization header containing the Base64-encoded trust payload.
+     */
+    headers: {
+        [HeaderTypes.Authorization]: string;
+    };
+    /**
+     * Transfer request message (DSP compliant).
+     */
+    body: IDataspaceProtocolTransferRequestMessage;
+}

package/dist/types/models/api/control-plane/IRequestTransferResponse.d.ts

@@ -0,0 +1,15 @@
+import type { IDataspaceProtocolTransferProcess, IDataspaceProtocolTransferError } from "@twin.org/standards-dataspace-protocol";
+import type { HttpStatusCode } from "@twin.org/web";
+/**
+ * API response for requesting a transfer process.
+ */
+export interface IRequestTransferResponse {
+    /**
+     * Transfer Process (DSP compliant) with state REQUESTED, or error.
+     */
+    body: IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError;
+    /**
+     * HTTP status code for the response.
+     */
+    statusCode?: HttpStatusCode;
+}

package/dist/types/models/api/control-plane/IStartTransferRequest.d.ts

@@ -0,0 +1,26 @@
+import type { IDataspaceProtocolTransferStartMessage } from "@twin.org/standards-dataspace-protocol";
+import type { HeaderTypes } from "@twin.org/web";
+/**
+ * API request for starting a transfer process.
+ */
+export interface IStartTransferRequest {
+    /**
+     * Path parameters containing the process ID.
+     */
+    pathParams: {
+        /**
+         * Process ID (consumerPid).
+         */
+        pid: string;
+    };
+    /**
+     * Authorization header containing the Base64-encoded trust payload.
+     */
+    headers: {
+        [HeaderTypes.Authorization]: string;
+    };
+    /**
+     * Transfer start message (DSP compliant).
+     */
+    body: IDataspaceProtocolTransferStartMessage;
+}

package/dist/types/models/api/control-plane/IStartTransferResponse.d.ts

@@ -0,0 +1,15 @@
+import type { IDataspaceProtocolTransferStartMessage, IDataspaceProtocolTransferError } from "@twin.org/standards-dataspace-protocol";
+import type { HttpStatusCode } from "@twin.org/web";
+/**
+ * API response for starting a transfer process.
+ */
+export interface IStartTransferResponse {
+    /**
+     * Transfer Start Message (DSP compliant) with dataAddress for PULL transfers, or error.
+     */
+    body: IDataspaceProtocolTransferStartMessage | IDataspaceProtocolTransferError;
+    /**
+     * HTTP status code for the response.
+     */
+    statusCode?: HttpStatusCode;
+}

package/dist/types/models/api/control-plane/ISuspendTransferRequest.d.ts

@@ -0,0 +1,26 @@
+import type { IDataspaceProtocolTransferSuspensionMessage } from "@twin.org/standards-dataspace-protocol";
+import type { HeaderTypes } from "@twin.org/web";
+/**
+ * API request for suspending a transfer process.
+ */
+export interface ISuspendTransferRequest {
+    /**
+     * Path parameters containing the process ID.
+     */
+    pathParams: {
+        /**
+         * Process ID (consumerPid).
+         */
+        pid: string;
+    };
+    /**
+     * Authorization header containing the Base64-encoded trust payload.
+     */
+    headers: {
+        [HeaderTypes.Authorization]: string;
+    };
+    /**
+     * Transfer suspension message (DSP compliant).
+     */
+    body: IDataspaceProtocolTransferSuspensionMessage;
+}

package/dist/types/models/api/control-plane/ISuspendTransferResponse.d.ts

@@ -0,0 +1,15 @@
+import type { IDataspaceProtocolTransferProcess, IDataspaceProtocolTransferError } from "@twin.org/standards-dataspace-protocol";
+import type { HttpStatusCode } from "@twin.org/web";
+/**
+ * API response for suspending a transfer process.
+ */
+export interface ISuspendTransferResponse {
+    /**
+     * Transfer Process (DSP compliant) with state SUSPENDED, or error.
+     */
+    body: IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError;
+    /**
+     * HTTP status code for the response.
+     */
+    statusCode?: HttpStatusCode;
+}

package/dist/types/models/api/control-plane/ITerminateTransferRequest.d.ts

@@ -0,0 +1,26 @@
+import type { IDataspaceProtocolTransferTerminationMessage } from "@twin.org/standards-dataspace-protocol";
+import type { HeaderTypes } from "@twin.org/web";
+/**
+ * API request for terminating a transfer process.
+ */
+export interface ITerminateTransferRequest {
+    /**
+     * Path parameters containing the process ID.
+     */
+    pathParams: {
+        /**
+         * Process ID (consumerPid).
+         */
+        pid: string;
+    };
+    /**
+     * Authorization header containing the Base64-encoded trust payload.
+     */
+    headers: {
+        [HeaderTypes.Authorization]: string;
+    };
+    /**
+     * Transfer termination message (DSP compliant).
+     */
+    body: IDataspaceProtocolTransferTerminationMessage;
+}