@twin.org/dataspace-models 0.0.3-next.25 → 0.0.3-next.27

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

@@ -0,0 +1,42 @@
+/**
+ * Tenant-supplied Dataset shape persisted by the Control Plane.
+ */
+export declare class DataspaceAppDataset {
+    /**
+     * The unique identifier for the dataset.
+     */
+    id: string;
+    /**
+     * The identity of the node that owns this entity (required for sync).
+     */
+    nodeIdentity: string;
+    /**
+     * The tenant that owns this dataset, captured from the request context at
+     * write time. Optional — single-tenant nodes (no `TWIN_TENANT_ENABLED`)
+     * register datasets without a tenant context, in which case federated catalogue stores
+     * the dataset with no `tenantId` and URL-baking is skipped.
+     */
+    tenantId?: string;
+    /**
+     * The dataspace app that this dataset belongs to. Matches the app's
+     * registered name in `DataspaceAppFactory` (typically the app's URI).
+     * Used as the join key when dispatching to an app's optional
+     * `datasetsHandled` override.
+     */
+    appId: string;
+    /**
+     * The user-controlled JSON-LD dataset payload. Stored as an
+     * opaque object and validated/populated at publish time.
+     */
+    dataset: {
+        [key: string]: unknown;
+    };
+    /**
+     * Creation timestamp (ISO string format).
+     */
+    dateCreated: string;
+    /**
+     * Last update timestamp (ISO string format).
+     */
+    dateModified: string;
+}

package/dist/types/index.d.ts

@@ -1,53 +1,66 @@
+export * from "./entities/dataspaceAppDataset.js";
 export * from "./entities/transferProcess.js";
+export * from "./models/controlPlane/api/ITransferContextResponse.js";
+export * from "./models/controlPlane/IDataspaceAppDataset.js";
 export * from "./models/controlPlane/IDataspaceControlPlaneComponent.js";
 export * from "./models/controlPlane/IDataspaceControlPlaneResolverComponent.js";
 export * from "./models/controlPlane/INegotiationCallback.js";
+export * from "./models/controlPlane/ITransferContext.js";
 export * from "./models/controlPlane/ITransferProcess.js";
 export * from "./models/controlPlane/transferProcessRole.js";
-export * from "./models/controlPlane/ITransferContext.js";
-export * from "./models/controlPlane/api/ITransferContextResponse.js";
 export * from "./models/dataPlane/IDataspaceDataPlaneComponent.js";
-export * from "./models/IDataspaceActivity.js";
-export * from "./models/dataspaceTypes.js";
 export * from "./models/dataspaceContexts.js";
+export * from "./models/dataspaceTransferFormat.js";
+export * from "./models/dataspaceTypes.js";
+export * from "./models/IDataspaceActivity.js";
 export * from "./dataTypes/dataspaceDataTypes.js";
 export * from "./factories/dataspaceAppFactory.js";
 export * from "./models/app/IDataspaceApp.js";
+export * from "./models/app/IProcessingGroupOptions.js";
 export * from "./models/activityProcessingStatus.js";
 export * from "./models/api/IActivityLogEntryGetRequest.js";
 export * from "./models/api/IActivityLogEntryGetResponse.js";
 export * from "./models/api/IActivityLogStatusNotificationPayload.js";
 export * from "./models/api/IActivityLogStatusRequest.js";
 export * from "./models/api/IActivityStreamNotifyRequest.js";
+export * from "./models/api/IActivityStreamNotifyResponse.js";
 export * from "./models/api/IDataAssetEntitiesResponse.js";
 export * from "./models/api/IDataAssetGetEntitiesRequest.js";
 export * from "./models/api/IDataAssetQueryRequest.js";
+export * from "./models/api/controlPlane/IAppDatasetCreateRequest.js";
+export * from "./models/api/controlPlane/IAppDatasetCreateResponse.js";
+export * from "./models/api/controlPlane/IAppDatasetDeleteRequest.js";
+export * from "./models/api/controlPlane/IAppDatasetGetRequest.js";
+export * from "./models/api/controlPlane/IAppDatasetGetResponse.js";
+export * from "./models/api/controlPlane/IAppDatasetListRequest.js";
+export * from "./models/api/controlPlane/IAppDatasetListResponse.js";
+export * from "./models/api/controlPlane/IAppDatasetUpdateRequest.js";
+export * from "./models/api/controlPlane/ICompleteTransferRequest.js";
+export * from "./models/api/controlPlane/ICompleteTransferResponse.js";
+export * from "./models/api/controlPlane/IGetTransferProcessRequest.js";
+export * from "./models/api/controlPlane/IGetTransferProcessResponse.js";
 export * from "./models/api/controlPlane/IRequestTransferRequest.js";
 export * from "./models/api/controlPlane/IRequestTransferResponse.js";
 export * from "./models/api/controlPlane/IStartTransferRequest.js";
 export * from "./models/api/controlPlane/IStartTransferResponse.js";
-export * from "./models/api/controlPlane/ICompleteTransferRequest.js";
-export * from "./models/api/controlPlane/ICompleteTransferResponse.js";
 export * from "./models/api/controlPlane/ISuspendTransferRequest.js";
 export * from "./models/api/controlPlane/ISuspendTransferResponse.js";
 export * from "./models/api/controlPlane/ITerminateTransferRequest.js";
 export * from "./models/api/controlPlane/ITerminateTransferResponse.js";
-export * from "./models/api/controlPlane/IGetTransferProcessRequest.js";
-export * from "./models/api/controlPlane/IGetTransferProcessResponse.js";
+export * from "./models/activityTaskStatus.js";
 export * from "./models/app/dataRequestType.js";
 export * from "./models/app/IActivityQuery.js";
 export * from "./models/app/IDataAssetEntitiesRequest.js";
 export * from "./models/app/IDataAssetQuery.js";
-export * from "./models/app/IQueryDataAssetRequest.js";
 export * from "./models/app/IDataRequest.js";
-export * from "./models/IActivityLogDates.js";
+export * from "./models/app/IQueryDataAssetRequest.js";
 export * from "./models/IActivityLogDetails.js";
 export * from "./models/IActivityLogEntry.js";
 export * from "./models/IActivityLogStatusNotification.js";
 export * from "./models/IActivityTask.js";
+export * from "./models/IActivityTaskEntry.js";
 export * from "./models/IDataAssetItemList.js";
 export * from "./models/IDataAssetItemListResult.js";
 export * from "./models/IEntitySet.js";
 export * from "./models/IExecutionPayload.js";
 export * from "./models/IFilteringQuery.js";
-export * from "./models/ITaskApp.js";

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

@@ -22,8 +22,4 @@ export interface IActivityLogDetails {
      * 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

@@ -1,8 +1,6 @@
-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";
+import type { IActivityTaskEntry } from "./IActivityTaskEntry.js";
 /**
  * The details related to the processing of an Activity
  */
@@ -12,29 +10,7 @@ export interface IActivityLogEntry extends IActivityLogDetails {
      */
     status: ActivityProcessingStatus;
     /**
-     * The pending tasks that have to be run to process the Activity.
+     * The 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;
-    })[];
+    tasks?: IActivityTaskEntry[];
 }

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

@@ -1,4 +1,4 @@
-import type { ITaskApp } from "./ITaskApp.js";
+import type { IActivityTaskEntry } from "./IActivityTaskEntry.js";
 /**
  * Denotes a task associated with an Activity
  */
@@ -10,5 +10,5 @@ export interface IActivityTask {
     /**
      * The associated tasks
      */
-    associatedTasks: ITaskApp[];
+    associatedTasks: IActivityTaskEntry[];
 }

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

@@ -0,0 +1,39 @@
+import type { IError } from "@twin.org/core";
+import type { ActivityTaskStatus } from "./activityTaskStatus.js";
+/**
+ * Denotes a task associated with a Dataspace App
+ */
+export interface IActivityTaskEntry {
+    /**
+     * Task Id.
+     */
+    taskId: string;
+    /**
+     * Dataspace App Id.
+     */
+    dataspaceAppId: string;
+    /**
+     * Task status.
+     */
+    status: ActivityTaskStatus;
+    /**
+     * Processing Group Id.
+     */
+    processingGroupId?: string;
+    /**
+     * Task processing start timestamp
+     */
+    startDate?: string;
+    /**
+     * Task processing end timestamp
+     */
+    endDate?: string;
+    /**
+     * The result of the task processing, if completed.
+     */
+    result?: unknown;
+    /**
+     * The error occurred during task processing, if any.
+     */
+    error?: IError;
+}

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

@@ -12,7 +12,7 @@ export interface IExecutionPayload {
      */
     activity: IDataspaceActivity;
     /**
-     * The executor App.
+     * The dataspace App ID.
      */
-    executorApp: string;
+    dataspaceAppId: string;
 }

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

@@ -0,0 +1,25 @@
+/**
+ * Activity task statuses.
+ */
+export declare const ActivityTaskStatus: {
+    /**
+     * Pending.
+     */
+    readonly Pending: "pending";
+    /**
+     * Processing.
+     */
+    readonly Processing: "processing";
+    /**
+     * Success.
+     */
+    readonly Success: "success";
+    /**
+     * Failed.
+     */
+    readonly Failed: "failed";
+};
+/**
+ * Activity task statuses.
+ */
+export type ActivityTaskStatus = (typeof ActivityTaskStatus)[keyof typeof ActivityTaskStatus];

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

@@ -0,0 +1,23 @@
+import type { HeaderTypes, HttpStatusCode } from "@twin.org/web";
+import type { IActivityLogEntry } from "../IActivityLogEntry.js";
+/**
+ * Activity Stream Notify Response.
+ */
+export interface IActivityStreamNotifyResponse {
+    /**
+     * The status code indicating the result of the notification processing. It can be either:
+     * - `201 Created` if the notification was processed inline and a new activity log entry was created.
+     * - `102 Processing` if the notification was accepted for processing but has not been completed yet.
+     */
+    statusCode: typeof HttpStatusCode.created | typeof HttpStatusCode.processing;
+    /**
+     * Optional headers.
+     */
+    headers?: {
+        [HeaderTypes.Location]?: string;
+    };
+    /**
+     * The Activity log entry if the notification was processed inline.
+     */
+    body?: IActivityLogEntry;
+}

package/dist/types/models/api/controlPlane/IAppDatasetCreateRequest.d.ts

@@ -0,0 +1,31 @@
+import type { IDataspaceProtocolDataset } from "@twin.org/standards-dataspace-protocol";
+/**
+ * API request to register an app dataset.
+ *
+ * The owning `tenantId` is captured automatically from the request's tenant
+ * context — callers do not supply it.
+ */
+export interface IAppDatasetCreateRequest {
+    /**
+     * The body of the request.
+     */
+    body: {
+        /**
+         * Optional explicit id for the stored dataset record. If omitted, the
+         * Control Plane derives the id from `dataset["@id"]` if present, or
+         * generates a UUID otherwise. The resolved id is returned via the
+         * `Location` response header.
+         */
+        id?: string;
+        /**
+         * The dataspace app this dataset belongs to. Matches the app's
+         * registered name in `DataspaceAppFactory` (typically the app's URI).
+         */
+        appId: string;
+        /**
+         * The dataset payload. System-stamped fields like `dcterms:publisher`
+         * may be omitted — the Control Plane fills them in at publish time.
+         */
+        dataset: IDataspaceProtocolDataset;
+    };
+}

package/dist/types/models/api/controlPlane/IAppDatasetCreateResponse.d.ts

@@ -0,0 +1,16 @@
+import type { HeaderTypes, HttpStatusCode } from "@twin.org/web";
+/**
+ * API response from registering an app dataset.
+ */
+export interface IAppDatasetCreateResponse {
+    /**
+     * The headers of the response, including the location of the new app dataset.
+     */
+    headers: {
+        [HeaderTypes.Location]: string;
+    };
+    /**
+     * HTTP status code (201 on success).
+     */
+    statusCode: HttpStatusCode;
+}

package/dist/types/models/api/controlPlane/IAppDatasetDeleteRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * API request to delete a stored app dataset record.
+ */
+export interface IAppDatasetDeleteRequest {
+    /**
+     * Path parameters containing the stored dataset id.
+     */
+    pathParams: {
+        /**
+         * The stored dataset id.
+         */
+        id: string;
+    };
+}

package/dist/types/models/api/controlPlane/IAppDatasetGetRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * API request to fetch a single app dataset record.
+ */
+export interface IAppDatasetGetRequest {
+    /**
+     * Path parameters containing the stored app dataset id.
+     */
+    pathParams: {
+        /**
+         * The stored app dataset id (entity primary key).
+         */
+        id: string;
+    };
+}

package/dist/types/models/api/controlPlane/IAppDatasetGetResponse.d.ts

@@ -0,0 +1,10 @@
+import type { IDataspaceAppDataset } from "../../controlPlane/IDataspaceAppDataset.js";
+/**
+ * API response for a single stored app dataset record.
+ */
+export interface IAppDatasetGetResponse {
+    /**
+     * The body of the response.
+     */
+    body: IDataspaceAppDataset;
+}

package/dist/types/models/api/controlPlane/IAppDatasetListRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * API request to list the app datasets owned by the calling tenant.
+ */
+export interface IAppDatasetListRequest {
+    /**
+     * Query parameters for paging. Always strings on the wire.
+     */
+    query?: {
+        /**
+         * Cursor returned from a previous list call to fetch the next page.
+         */
+        cursor?: string;
+        /**
+         * Maximum number of entries to return (string-encoded; parsed on the server).
+         */
+        limit?: string;
+    };
+}

package/dist/types/models/api/controlPlane/IAppDatasetListResponse.d.ts

@@ -0,0 +1,19 @@
+import type { IDataspaceAppDataset } from "../../controlPlane/IDataspaceAppDataset.js";
+/**
+ * API response listing the app datasets owned by the calling tenant.
+ */
+export interface IAppDatasetListResponse {
+    /**
+     * The body of the response.
+     */
+    body: {
+        /**
+         * The stored datasets.
+         */
+        entities: IDataspaceAppDataset[];
+        /**
+         * Cursor to fetch the next page if more entries exist.
+         */
+        cursor?: string;
+    };
+}

package/dist/types/models/api/controlPlane/IAppDatasetUpdateRequest.d.ts

@@ -0,0 +1,29 @@
+import type { IDataspaceProtocolDataset } from "@twin.org/standards-dataspace-protocol";
+/**
+ * API request to update an existing app dataset record.
+ */
+export interface IAppDatasetUpdateRequest {
+    /**
+     * Path parameters containing the stored app dataset id.
+     */
+    pathParams: {
+        /**
+         * The stored app dataset id.
+         */
+        id: string;
+    };
+    /**
+     * The body of the request.
+     */
+    body: {
+        /**
+         * The dataspace app this dataset belongs to. May change appId on
+         * update if the tenant wants to retarget the dataset.
+         */
+        appId: string;
+        /**
+         * The dataset payload.
+         */
+        dataset: IDataspaceProtocolDataset;
+    };
+}

package/dist/types/models/app/IActivityQuery.d.ts

@@ -14,4 +14,8 @@ export interface IActivityQuery {
      * FQN of the target type.
      */
     targetType?: string;
+    /**
+     * The processing group id for this query, used to determine which tasks can be processed in parallel.
+     */
+    processingGroupId?: string;
 }

package/dist/types/models/app/IDataspaceApp.d.ts

@@ -4,20 +4,34 @@ import type { IDataspaceProtocolDataset } from "@twin.org/standards-dataspace-pr
 import type { IActivityQuery } from "./IActivityQuery.js";
 import type { IDataRequest } from "./IDataRequest.js";
 import type { IDataspaceActivity } from "../IDataspaceActivity.js";
+import type { IProcessingGroupOptions } from "./IProcessingGroupOptions.js";
 /**
  * Interface describes a Dataspace App.
  */
 export interface IDataspaceApp extends IComponent {
+    /**
+     * The settings for the processing groups for tasks.
+     * @returns The options for each process group.
+     */
+    processingGroups?(): {
+        [id: string]: IProcessingGroupOptions;
+    };
     /**
      * The activities handled by the App.
      * @returns A query that describes the set of activities handled by the App.
      */
     activitiesHandled(): IActivityQuery[];
     /**
-     * The datasets handled by the App.
-     * @returns The Dataspace Protocol compliant datasets handled by the App.
+     * Optional override called by the Control Plane when publishing a stored dataset for this app.
+     * The Control Plane always calls `populateDefaults` (e.g. `dcterms:publisher`)
+     * on every dataset returned here, so apps don't need to populate publisher themselves.
+     * @param payload The user-stored dataset payload.
+     * @param tenantId The owning tenant for this dataset. Empty string on
+     * single-tenant nodes (no `TWIN_TENANT_ENABLED`).
+     * @returns One or more datasets to publish to the catalogue. System-stamped
+     * fields like `dcterms:publisher` may be omitted — the Control Plane fills them in.
      */
-    datasetsHandled(): Promise<IDataspaceProtocolDataset[]>;
+    datasetsHandled?(payload: IDataspaceProtocolDataset, tenantId: string): Promise<IDataspaceProtocolDataset[]>;
     /**
      * The types of queries supported.
      * @returns The types of queries supported by the Dataspace App to retrieve data.

package/dist/types/models/app/IProcessingGroupOptions.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Interface describes the options for a processing group, which determines how many tasks can be processed in parallel for a given group of activities.
+ */
+export interface IProcessingGroupOptions {
+    /**
+     * The number of concurrent tasks that can be processed for this processing group.
+     */
+    concurrentTasks?: number;
+    /**
+     * Terminate the worker after it has been idle for the specified timeout in milliseconds,
+     * defaults to 0 for immediate shutdown, set to -1 to keep workers alive.
+     */
+    idleShutdownTimeout?: number;
+    /**
+     * The number of times a task in this processing group should be retried in case of failure.
+     */
+    retryCount?: number;
+}

package/dist/types/models/controlPlane/IDataspaceAppDataset.d.ts

@@ -0,0 +1,26 @@
+import type { IDataspaceProtocolDataset } from "@twin.org/standards-dataspace-protocol";
+/**
+ * Stored dataset record returned by the Control Plane's dataset CRUD surface.
+ */
+export interface IDataspaceAppDataset {
+    /**
+     * The stored dataset id (matches the dataset's JSON-LD `@id`).
+     */
+    id: string;
+    /**
+     * The dataspace app this dataset belongs to.
+     */
+    appId: string;
+    /**
+     * The dataset payload.
+     */
+    dataset: IDataspaceProtocolDataset;
+    /**
+     * Creation timestamp (ISO string).
+     */
+    dateCreated: string;
+    /**
+     * Last-modified timestamp (ISO string).
+     */
+    dateModified: string;
+}

package/dist/types/models/controlPlane/IDataspaceControlPlaneComponent.d.ts

@@ -1,5 +1,6 @@
 import type { IComponent } from "@twin.org/core";
-import type { IDataspaceProtocolContractNegotiation, IDataspaceProtocolContractNegotiationError, IDataspaceProtocolTransferCompletionMessage, IDataspaceProtocolTransferError, IDataspaceProtocolTransferProcess, IDataspaceProtocolTransferRequestMessage, IDataspaceProtocolTransferStartMessage, IDataspaceProtocolTransferSuspensionMessage, IDataspaceProtocolTransferTerminationMessage } from "@twin.org/standards-dataspace-protocol";
+import type { IDataspaceProtocolContractNegotiation, IDataspaceProtocolContractNegotiationError, IDataspaceProtocolDataset, IDataspaceProtocolTransferCompletionMessage, IDataspaceProtocolTransferError, IDataspaceProtocolTransferProcess, IDataspaceProtocolTransferRequestMessage, IDataspaceProtocolTransferStartMessage, IDataspaceProtocolTransferSuspensionMessage, IDataspaceProtocolTransferTerminationMessage } from "@twin.org/standards-dataspace-protocol";
+import type { IDataspaceAppDataset } from "./IDataspaceAppDataset.js";
 import type { INegotiationCallback } from "./INegotiationCallback.js";
 /**
  * Dataspace Control Plane Component interface.
@@ -177,4 +178,44 @@ export interface IDataspaceControlPlaneComponent extends IComponent {
      * @returns Transfer Process (DSP compliant) with current state, or TransferError if the operation fails.
      */
     getTransferProcess(pid: string, trustPayload: unknown): Promise<IDataspaceProtocolTransferProcess | IDataspaceProtocolTransferError>;
+    /**
+     * Register an app dataset for a dataspace app, owned by the calling tenant.
+     * @param id Optional explicit id. If omitted, derived from `dataset["@id"]`
+     * or generated.
+     * @param appId The dataspace app this dataset belongs to (matches
+     * `DataspaceAppFactory` registration name).
+     * @param dataset The dataset payload (may omit system-stamped fields).
+     * @returns The resolved dataset id.
+     */
+    createAppDataset(id: string | undefined, appId: string, dataset: IDataspaceProtocolDataset): Promise<string>;
+    /**
+     * Get an app dataset record owned by the calling tenant.
+     * @param id The stored app dataset id.
+     * @returns The stored app dataset record.
+     */
+    getAppDataset(id: string): Promise<IDataspaceAppDataset>;
+    /**
+     * List the app datasets owned by the calling tenant.
+     * @param cursor Optional pagination cursor.
+     * @param limit Optional maximum number of entries to return.
+     * @returns The stored app datasets and the next-page cursor if more exist.
+     */
+    listAppDatasets(cursor?: string, limit?: number): Promise<{
+        entities: IDataspaceAppDataset[];
+        cursor?: string;
+    }>;
+    /**
+     * Update an app dataset record owned by the calling tenant.
+     * @param id The stored app dataset id.
+     * @param appId The dataspace app this dataset belongs to.
+     * @param dataset The dataset payload.
+     * @returns Nothing.
+     */
+    updateAppDataset(id: string, appId: string, dataset: IDataspaceProtocolDataset): Promise<void>;
+    /**
+     * Delete an app dataset record owned by the calling tenant.
+     * @param id The stored app dataset id.
+     * @returns Nothing.
+     */
+    deleteAppDataset(id: string): Promise<void>;
 }

package/dist/types/models/dataPlane/IDataspaceDataPlaneComponent.d.ts

@@ -14,9 +14,9 @@ export interface IDataspaceDataPlaneComponent extends IComponent {
     /**
      * Notify an Activity to the Dataspace Data Plane Activity Stream.
      * @param activity The Activity notified.
-     * @returns The Activity's identifier.
+     * @returns The activity's entry.
      */
-    notifyActivity(activity: IActivityStreamsActivity): Promise<string>;
+    notifyActivity(activity: IActivityStreamsActivity): Promise<string | IActivityLogEntry>;
     /**
      * Subscribes to the activity log.
      * @param callback The callback to be called when Activity Log is called.

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

@@ -0,0 +1,28 @@
+/**
+ * TWIN transfer format identifiers used in TransferRequestMessage.format.
+ * Follows the Eclipse EDC canonical pattern: <DestinationType-FlowType>.
+ * See RFC-007 Data Transfer Profile.
+ */
+export declare const DataspaceTransferFormat: {
+    /**
+     * PULL mode: consumer queries data via a bearer-token-protected endpoint.
+     * Data flows: Consumer GET provider endpoint (with token).
+     */
+    readonly HttpProxyPull: "HttpProxy-PULL";
+    /**
+     * Consumer-initiated PUSH mode: consumer supplies their /inbox endpoint in the
+     * TransferRequestMessage. Provider pushes ActivityStreams objects to that endpoint.
+     * Data flows: Provider POST to consumer's /inbox.
+     */
+    readonly HttpProxyPush: "HttpProxy-PUSH";
+    /**
+     * Provider-initiated PUSH mode (inverted flow): consumer supplies no dataAddress.
+     * Provider returns its own /inbox URL + signed JWT. Consumer then posts data there.
+     * Data flows: Consumer POST to provider's /inbox.
+     */
+    readonly HttpProxyPost: "HttpProxy-POST";
+};
+/**
+ * Type for the DataspaceTransferFormat const values.
+ */
+export type DataspaceTransferFormat = (typeof DataspaceTransferFormat)[keyof typeof DataspaceTransferFormat];

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

@@ -2,6 +2,9 @@
  * The types concerning dataspace
  */
 export declare const DataspaceTypes: {
+    /**
+     * Activity type.
+     */
     readonly Activity: "Activity";
 };
 /**