@twin.org/dataspace-models 0.9.1 → 0.9.2-next.10

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

@@ -1,8 +1,9 @@
 import type { IComponent } from "@twin.org/core";
-import type { IDataspaceProtocolContractNegotiation, IDataspaceProtocolContractNegotiationError, IDataspaceProtocolDataset, IDataspaceProtocolTransferCompletionMessage, IDataspaceProtocolTransferError, IDataspaceProtocolTransferProcess, IDataspaceProtocolTransferRequestMessage, IDataspaceProtocolTransferStartMessage, IDataspaceProtocolTransferSuspensionMessage, IDataspaceProtocolTransferTerminationMessage, IDataspaceProtocolVersionResponse } from "@twin.org/standards-dataspace-protocol";
+import type { DataspaceProtocolTransferProcessStateType, IDataspaceProtocolContractNegotiation, IDataspaceProtocolContractNegotiationError, IDataspaceProtocolDataset, IDataspaceProtocolTransferCompletionMessage, IDataspaceProtocolTransferError, IDataspaceProtocolTransferProcess, IDataspaceProtocolTransferRequestMessage, IDataspaceProtocolTransferStartMessage, IDataspaceProtocolTransferSuspensionMessage, IDataspaceProtocolTransferTerminationMessage, IDataspaceProtocolVersionResponse } from "@twin.org/standards-dataspace-protocol";
 import type { IDataspaceAppDataset } from "./IDataspaceAppDataset.js";
 import type { INegotiationCallback } from "./INegotiationCallback.js";
 import type { ITransferCallback } from "./ITransferCallback.js";
+import type { ITransferQueryResult } from "./ITransferQueryResult.js";
 /**
  * Dataspace Control Plane Component interface.
  * Implements Eclipse Dataspace Protocol (DSP) specifications:
@@ -40,7 +41,7 @@ export interface IDataspaceControlPlaneComponent extends IComponent {
      * notified via the registered INegotiationCallback when the negotiation completes.
      * The negotiation follows DSP state machine: REQUESTED → OFFERED → AGREED → VERIFIED → FINALIZED.
      *
-     * The REST client does not support this method and throws a not supported error —
+     * The REST client does not support this method and throws a not supported error -
      * use ComponentFactory.get() for the in-process service.
      *
      * DSP Spec: https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#negotiation-protocol
@@ -98,7 +99,7 @@ export interface IDataspaceControlPlaneComponent extends IComponent {
      * consumer-initiated transfer changes state (STARTED, COMPLETED, SUSPENDED,
      * TERMINATED).
      *
-     * The REST client does not support this method and throws a not supported error —
+     * The REST client does not support this method and throws a not supported error -
      * use ComponentFactory.get() for the in-process service.
      * @param key A unique key identifying this callback registration.
      * @param callback The callback interface to register.
@@ -123,7 +124,7 @@ export interface IDataspaceControlPlaneComponent extends IComponent {
      * via the registered ITransferCallback. The transfer moves to STARTED when the
      * provider POSTs a TransferStartMessage back to this node's callback address.
      *
-     * The REST client does not support this method and throws a not supported error —
+     * The REST client does not support this method and throws a not supported error -
      * use ComponentFactory.get() for the in-process service.
      *
      * @param agreementId The finalized agreement ID (from contract negotiation).
@@ -245,6 +246,25 @@ 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>;
+    /**
+     * Query Transfer Processes by agreement id.
+     * Lets a caller check whether transfers already exist for an agreement
+     * (e.g. before initiating a new one) without knowing any process ids.
+     *
+     * Role Performed: Consumer / Provider
+     * Called by: Consumer orchestration before requesting a new transfer, or either
+     * party inspecting the transfers attached to an agreement on their side.
+     *
+     * Results are limited to transfers where the authenticated caller is a party
+     * (consumer or provider identity). A returned dataAddress is a point-in-time copy;
+     * if its token has expired the data plane rejects it and a new start is required.
+     * @param agreementId The agreement id to look up transfer processes for.
+     * @param state Optional filter to a single transfer process state.
+     * @param cursor Optional pagination cursor from a previous result page.
+     * @param trustPayload Trust payload containing authorization information (JWT, VC, etc.).
+     * @returns The matching transfer processes and a pagination cursor when more pages exist, empty when none match.
+     */
+    queryDataTransfer(agreementId: string, state: DataspaceProtocolTransferProcessStateType | undefined, cursor: string | undefined, trustPayload: unknown): Promise<ITransferQueryResult>;
     /**
      * Register an app dataset for a dataspace app, owned by the calling tenant.
      * @param id Optional explicit id. If omitted, derived from `dataset["@id"]`
@@ -252,9 +272,14 @@ export interface IDataspaceControlPlaneComponent extends IComponent {
      * @param appId The dataspace app this dataset belongs to (matches
      * `DataspaceAppFactory` registration name).
      * @param dataset The dataset payload (may omit system-stamped fields).
+     * @param options Optional dataset settings.
+     * @param options.transferIdleTimeoutMs Optional idle window (ms) overriding the node-level idle
+     * policy for this dataset's PULL transfers; 0 disables it for this dataset.
      * @returns The resolved dataset id.
      */
-    createAppDataset(id: string | undefined, appId: string, dataset: IDataspaceProtocolDataset): Promise<string>;
+    createAppDataset(id: string | undefined, appId: string, dataset: IDataspaceProtocolDataset, options?: {
+        transferIdleTimeoutMs?: number;
+    }): Promise<string>;
     /**
      * Get an app dataset record owned by the calling tenant.
      * @param id The stored app dataset id.
@@ -276,9 +301,14 @@ export interface IDataspaceControlPlaneComponent extends IComponent {
      * @param id The stored app dataset id.
      * @param appId The dataspace app this dataset belongs to.
      * @param dataset The dataset payload.
+     * @param options Optional dataset settings.
+     * @param options.transferIdleTimeoutMs Optional idle window (ms) overriding the node-level idle
+     * policy for this dataset's PULL transfers; 0 disables it for this dataset.
      * @returns A promise that resolves when the dataset has been updated in storage and the catalogue.
      */
-    updateAppDataset(id: string, appId: string, dataset: IDataspaceProtocolDataset): Promise<void>;
+    updateAppDataset(id: string, appId: string, dataset: IDataspaceProtocolDataset, options?: {
+        transferIdleTimeoutMs?: number;
+    }): Promise<void>;
     /**
      * Delete an app dataset record owned by the calling tenant.
      * @param id The stored app dataset id.

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

@@ -49,9 +49,9 @@ export interface ITransferCallback {
      */
     onFailed?(consumerPid: string, reason: string): Promise<void>;
     /**
-     * Called when the transfer times out, i.e. the provider did not progress it (it sat in REQUESTED)
-     * within the configured window. Optional: implement it to be notified specifically of a non-response
-     * (otherwise the control plane falls back to `onFailed(consumerPid, "transferStalled")`).
+     * Called when the transfer times out: a consumer-side REQUESTED transfer the provider never
+     * progressed, or a provider-side STARTED transfer idle beyond the configured window. Optional:
+     * otherwise the control plane falls back to `onFailed` with the timeout reason.
      * @param consumerPid The consumer-side process ID.
      * @returns Nothing.
      */

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

@@ -1,4 +1,3 @@
-import type { IRightsManagementPolicy } from "@twin.org/rights-management-models";
 import type { DataspaceProtocolTransferProcessStateType, IDataspaceProtocolDataAddress } from "@twin.org/standards-dataspace-protocol";
 import type { TransferProcessRole } from "./transferProcessRole.js";
 /**
@@ -28,7 +27,6 @@ export interface ITransferProcess {
     state: DataspaceProtocolTransferProcessStateType;
     /**
      * Agreement ID linking to the rights-management Agreement.
-     * Used to resolve policies and permissions.
      */
     agreementId: string;
     /**
@@ -40,11 +38,6 @@ export interface ITransferProcess {
      * Offer ID from the original Catalog offer.
      */
     offerId: string;
-    /**
-     * Policies from the Agreement.
-     * Used by DSC for runtime policy enforcement.
-     */
-    policies?: IRightsManagementPolicy[];
     /**
      * Consumer identity (DID or URI).
      * Used for auditing and access control.
@@ -76,10 +69,8 @@ export interface ITransferProcess {
      */
     format?: string;
     /**
-     * Data address for consumer-initiated push transfers (HttpData-PUSH).
-     * Contains the consumer's /inbox endpoint as supplied in the TransferRequestMessage.
-     * Absent for PULL (HttpData-PULL) and provider-initiated push (HttpData-POST),
-     * where the consumer deliberately omits a dataAddress.
+     * Data address for the transfer: the consumer's inbox for PUSH, or the
+     * provider-built address persisted at start for PULL/POST; may expire while STARTED.
      */
     dataAddress?: IDataspaceProtocolDataAddress;
     /**

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

@@ -0,0 +1,14 @@
+import type { ITransferProcess } from "./ITransferProcess.js";
+/**
+ * Result of querying Transfer Processes by agreement.
+ */
+export interface ITransferQueryResult {
+    /**
+     * The transfer processes matching the query, empty when none match.
+     */
+    transfers: ITransferProcess[];
+    /**
+     * Pagination cursor for retrieving the next page, omitted when no more results exist.
+     */
+    cursor?: string;
+}

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

@@ -42,6 +42,10 @@ export declare const DataspaceControlPlaneMetricIds: {
      * Number of app datasets deleted.
      */
     readonly AppDatasetsDeleted: "dcp_app_datasets_deleted";
+    /**
+     * Number of agreements removed by the agreement sweep.
+     */
+    readonly AgreementsSwept: "dcp_agreements_swept";
 };
 /**
  * Metric IDs for the dataspace control plane service.

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

@@ -0,0 +1,14 @@
+/**
+ * Machine-readable codes set on provider-initiated TransferTerminationMessages
+ * by the control plane's transfer lifecycle policies.
+ */
+export declare const TransferTerminationCode: {
+    /**
+     * A Provider-side STARTED transfer had no data-plane activity within the configured idle window.
+     */
+    readonly IdleTimeout: "idleTimeout";
+};
+/**
+ * Type for TransferTerminationCode values.
+ */
+export type TransferTerminationCode = (typeof TransferTerminationCode)[keyof typeof TransferTerminationCode];

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

@@ -37,7 +37,7 @@ export interface IDataspaceDataPlaneComponent extends IComponent {
      * @param trustPayload Trust payload to verify the requester's identity.
      * @returns the Activity Log Entry with the processing details.
      * @throws NotFoundError if activity log entry is not known.
-     * @throws UnauthorizedError if trustPayload is absent or the verified identity is not the entry generator.
+     * @throws UnauthorizedError if trustPayload is absent or the verified identity is not authorised for the entry.
      */
     getActivityLogEntry(logEntryId: string, trustPayload?: unknown): Promise<IActivityLogEntry>;
     /**

package/docs/changelog.md

@@ -1,5 +1,115 @@
 # Changelog
 
+## [0.9.2-next.10](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.9...dataspace-models-v0.9.2-next.10) (2026-08-16)
+
+
+### Features
+
+* add unused agreement sweep to the control plane ([#344](https://github.com/iotaledger/twin-dataspace/issues/344)) ([8633642](https://github.com/iotaledger/twin-dataspace/commit/86336424ced7aeab3259c78373447074f4140e90))
+
+## [0.9.2-next.9](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.8...dataspace-models-v0.9.2-next.9) (2026-08-13)
+
+
+### Bug Fixes
+
+* get activity log auth ([#343](https://github.com/iotaledger/twin-dataspace/issues/343)) ([9514679](https://github.com/iotaledger/twin-dataspace/commit/95146790ccf7b54fd5dce923af64fdaa607ca555))
+
+## [0.9.2-next.8](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.7...dataspace-models-v0.9.2-next.8) (2026-08-11)
+
+
+### Features
+
+* transfer process remove inline agreement ([#340](https://github.com/iotaledger/twin-dataspace/issues/340)) ([332eaf6](https://github.com/iotaledger/twin-dataspace/commit/332eaf67e5cf0b13545d013d107658b232ae32ff))
+
+## [0.9.2-next.7](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.6...dataspace-models-v0.9.2-next.7) (2026-08-10)
+
+
+### Miscellaneous Chores
+
+* **dataspace-models:** Synchronize repo versions
+
+## [0.9.2-next.6](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.5...dataspace-models-v0.9.2-next.6) (2026-08-10)
+
+
+### Miscellaneous Chores
+
+* **dataspace-models:** Synchronize repo versions
+
+## [0.9.2-next.5](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.4...dataspace-models-v0.9.2-next.5) (2026-08-07)
+
+
+### Features
+
+* linting and dependency update ([adf8ee0](https://github.com/iotaledger/twin-dataspace/commit/adf8ee04f657f22fb051978591749a4cf19d67a1))
+
+## [0.9.2-next.4](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.3...dataspace-models-v0.9.2-next.4) (2026-08-03)
+
+
+### Miscellaneous Chores
+
+* **dataspace-models:** Synchronize repo versions
+
+## [0.9.2-next.3](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.2...dataspace-models-v0.9.2-next.3) (2026-07-31)
+
+
+### Bug Fixes
+
+* keep one TransferProcess record per role in self transfers ([#321](https://github.com/iotaledger/twin-dataspace/issues/321)) ([91ccc87](https://github.com/iotaledger/twin-dataspace/commit/91ccc87e47d94c6a015e3f974f0dd4cf680c4603))
+
+## [0.9.2-next.2](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.1...dataspace-models-v0.9.2-next.2) (2026-07-30)
+
+
+### Miscellaneous Chores
+
+* **dataspace-models:** Synchronize repo versions
+
+## [0.9.2-next.1](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.0...dataspace-models-v0.9.2-next.1) (2026-07-28)
+
+
+### Features
+
+* add consumer transfer callbacks and startDataTransfer convenience method ([#151](https://github.com/iotaledger/twin-dataspace/issues/151)) ([0ab66c3](https://github.com/iotaledger/twin-dataspace/commit/0ab66c3636fd1f98f89baca1e99764d77c6f91d9))
+* add dataspace transfer format ([#111](https://github.com/iotaledger/twin-dataspace/issues/111)) ([f59ff5e](https://github.com/iotaledger/twin-dataspace/commit/f59ff5ef10d261d1cebbf5c6bb0689e74a10738a))
+* add inline tasks and concurrent options ([#104](https://github.com/iotaledger/twin-dataspace/issues/104)) ([2227a21](https://github.com/iotaledger/twin-dataspace/commit/2227a212d906f58ba77850c79bb20bf2cb7195a8))
+* add telemetry metrics to dataspace control and data plane services ([#212](https://github.com/iotaledger/twin-dataspace/issues/212)) ([b5b0248](https://github.com/iotaledger/twin-dataspace/commit/b5b024899ed12c0f639c5d51aefa3e509753eac6))
+* add transferStarted provider method to start a data transfer ([#206](https://github.com/iotaledger/twin-dataspace/issues/206)) ([3ec2dc8](https://github.com/iotaledger/twin-dataspace/commit/3ec2dc8943c8531cd8d8e4ab07cb970ef7b11090))
+* add well known versions endpoint ([#251](https://github.com/iotaledger/twin-dataspace/issues/251)) ([4b4cbe9](https://github.com/iotaledger/twin-dataspace/commit/4b4cbe91a40980481dad6e0650c1ee73c53ae360))
+* align all config times to ms ([40238d5](https://github.com/iotaledger/twin-dataspace/commit/40238d59a2b45caedc01792b682ce7206815dfd1))
+* cross-node transfer callbacks and DataTransferManager auto-start ([#199](https://github.com/iotaledger/twin-dataspace/issues/199)) ([1089aa3](https://github.com/iotaledger/twin-dataspace/commit/1089aa344e3598e382f37a82ca03230c5cf6cacd))
+* docs update ([8b44c7a](https://github.com/iotaledger/twin-dataspace/commit/8b44c7a75afb8d377a6f606616f8a78d58439ab4))
+* endpoint encryption + getDatasetTargets multi-target fix ([#112](https://github.com/iotaledger/twin-dataspace/issues/112)) ([3288941](https://github.com/iotaledger/twin-dataspace/commit/328894113c19c7402f7d00dfa77b6a97ae40ca91))
+* get activity log add trust payload ([#201](https://github.com/iotaledger/twin-dataspace/issues/201)) ([cdb5486](https://github.com/iotaledger/twin-dataspace/commit/cdb5486942c1b94ddf6435236b9b9d190bea0407))
+* implement DSP push transfer mode ([#109](https://github.com/iotaledger/twin-dataspace/issues/109)) ([71f5fee](https://github.com/iotaledger/twin-dataspace/commit/71f5feec1d92dfec8ed6899c951809818e1bf2a3))
+* improve error handling and component usage ([544e20e](https://github.com/iotaledger/twin-dataspace/commit/544e20e640d6f09266942bfc698aead6227a7769))
+* improve open-api examples ([1368dbe](https://github.com/iotaledger/twin-dataspace/commit/1368dbed5c36e074b4854942304a19b9ce51e088))
+* improve validation ([#82](https://github.com/iotaledger/twin-dataspace/issues/82)) ([8bfaf7b](https://github.com/iotaledger/twin-dataspace/commit/8bfaf7b830f89b63575f8a51ee96bd8ac4da02f4))
+* organization identifiers ([#188](https://github.com/iotaledger/twin-dataspace/issues/188)) ([af643d3](https://github.com/iotaledger/twin-dataspace/commit/af643d3bb7f212d6cbb672e362a9e1bbe886d1a5))
+* provider-side idle lifecycle policy for STARTED data transfers ([#284](https://github.com/iotaledger/twin-dataspace/issues/284)) ([a9312ef](https://github.com/iotaledger/twin-dataspace/commit/a9312ef7573a92805c99cb2a314e8b289a6ab195))
+* provider-side transfer auto-start and negotiation/transfer timeout callbacks ([#227](https://github.com/iotaledger/twin-dataspace/issues/227)) ([619d858](https://github.com/iotaledger/twin-dataspace/commit/619d858e8d44e59744dc8a0f73e06be976932b53))
+* query existing data transfers by agreement to avoid duplicate preparations ([#289](https://github.com/iotaledger/twin-dataspace/issues/289)) ([53fe251](https://github.com/iotaledger/twin-dataspace/commit/53fe2516b2287b6b6a7a6ca6fc6063ea4a446cf0))
+* remove datasetsHandled method from apps ([9fdc950](https://github.com/iotaledger/twin-dataspace/commit/9fdc95018d38ab49c4a1094642be2ee83ee0e4cd))
+* remove hosting component ([#209](https://github.com/iotaledger/twin-dataspace/issues/209)) ([5e19328](https://github.com/iotaledger/twin-dataspace/commit/5e1932823aa8a0f88f559f096610b9df1f3b8615))
+* rename completed callback ([#147](https://github.com/iotaledger/twin-dataspace/issues/147)) ([f62baad](https://github.com/iotaledger/twin-dataspace/commit/f62baad0ff444e2913439b12dcd06d20c9a4f6a4))
+* resolve DSP transfer flow bugs for cross-node communication ([#76](https://github.com/iotaledger/twin-dataspace/issues/76)) ([506a45c](https://github.com/iotaledger/twin-dataspace/commit/506a45c94e63d5f958b1fc7131adfe452c3e2974))
+* shortcut implicit trust ([#215](https://github.com/iotaledger/twin-dataspace/issues/215)) ([f9bcfea](https://github.com/iotaledger/twin-dataspace/commit/f9bcfeab8f069b62017502833c108b4ee3791414))
+* types update ([77c338e](https://github.com/iotaledger/twin-dataspace/commit/77c338e9244dcc7e3d597fdb06229513b1f13eac))
+* typescript 6 update ([340f10e](https://github.com/iotaledger/twin-dataspace/commit/340f10e4767f6285c694938944f7e044474f9aaa))
+* unification of the data exchange and the data space connector ([#57](https://github.com/iotaledger/twin-dataspace/issues/57)) ([df2644d](https://github.com/iotaledger/twin-dataspace/commit/df2644d989471e07dadd83d27bef736179e31bf4))
+* update DataspaceTransferFormat names ([2c9d424](https://github.com/iotaledger/twin-dataspace/commit/2c9d424a07b97346faa2124048c4675514d58109))
+
+
+### Bug Fixes
+
+* always verify trust in notifyActivity, no internal by ([#192](https://github.com/iotaledger/twin-dataspace/issues/192)) ([2cfc160](https://github.com/iotaledger/twin-dataspace/commit/2cfc16082a7c9d417f0b05f90f123e40f47d1e05))
+* avoid compaction of incoming activities ([#77](https://github.com/iotaledger/twin-dataspace/issues/77)) ([ff43d6a](https://github.com/iotaledger/twin-dataspace/commit/ff43d6a3e1563eb9cb185501134b2a53ae88787c))
+* docs ([652f4f2](https://github.com/iotaledger/twin-dataspace/commit/652f4f2fec8601bb3772e054b2c823f599ef68dc))
+* filtering query optional q ([#248](https://github.com/iotaledger/twin-dataspace/issues/248)) ([e9e8ff1](https://github.com/iotaledger/twin-dataspace/commit/e9e8ff1e1bb3b93f0960260c21a46d6f58dbfaa2))
+* implement missing trust check on negotiateAgreement ([#136](https://github.com/iotaledger/twin-dataspace/issues/136)) ([a3589c2](https://github.com/iotaledger/twin-dataspace/commit/a3589c279476d5450b68ea7c2790be7e3125bfe2))
+* missing dependencies ([54e9e9c](https://github.com/iotaledger/twin-dataspace/commit/54e9e9c474b61cce3b9a82f9ccec27c7f8133382))
+* retain cursor after pep enforcement ([#296](https://github.com/iotaledger/twin-dataspace/issues/296)) ([5198cd2](https://github.com/iotaledger/twin-dataspace/commit/5198cd29505ceffa532fa4fa18c97a5c8e78f663))
+* return 422/500 when inline activity processing fails ([#135](https://github.com/iotaledger/twin-dataspace/issues/135)) ([8635187](https://github.com/iotaledger/twin-dataspace/commit/863518724cb90af15edc5f456d9a93c6cad7d661))
+* throw not supported error for in-process only control plane methods ([#185](https://github.com/iotaledger/twin-dataspace/issues/185)) ([130f00a](https://github.com/iotaledger/twin-dataspace/commit/130f00a87412b34defde891855bee7aa3ac34130))
+
 ## [0.9.1](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.1...dataspace-models-v0.9.1) (2026-07-27)
 
 

package/docs/reference/classes/DataspaceAppDataset.md

@@ -35,7 +35,7 @@ The identity of the organization that owns this entity.
 > `optional` **tenantId?**: `string`
 
 The tenant that owns this dataset, captured from the request context at
-write time. Optional — single-tenant nodes (no `TWIN_TENANT_ENABLED`)
+write time. Optional - single-tenant nodes (no `TWIN_TENANT_ENABLED`)
 register datasets without a tenant context.
 
 ***
@@ -62,6 +62,15 @@ opaque object and validated/populated at publish time.
 
 ***
 
+### transferIdleTimeoutMs? {#transferidletimeoutms}
+
+> `optional` **transferIdleTimeoutMs?**: `number`
+
+Idle window (ms) for this dataset's PULL transfers, overriding the node-level
+providerTransferIdleTimeoutMs; 0 disables the idle policy for this dataset.
+
+***
+
 ### dateCreated {#datecreated}
 
 > **dateCreated**: `string`

package/docs/reference/classes/DataspaceAppDatasetV0.md

@@ -0,0 +1,77 @@
+# Class: DataspaceAppDatasetV0
+
+Tenant-supplied Dataset shape persisted by the Control Plane, version 0.
+
+## Constructors
+
+### Constructor
+
+> **new DataspaceAppDatasetV0**(): `DataspaceAppDatasetV0`
+
+#### Returns
+
+`DataspaceAppDatasetV0`
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The unique identifier for the dataset.
+
+***
+
+### organizationIdentity {#organizationidentity}
+
+> **organizationIdentity**: `string`
+
+The identity of the organization that owns this entity.
+
+***
+
+### tenantId? {#tenantid}
+
+> `optional` **tenantId?**: `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.
+
+***
+
+### appId {#appid}
+
+> **appId**: `string`
+
+The dataspace app that this dataset belongs to. Matches the app's
+registered name in `DataspaceAppFactory` (typically the app's URI).
+
+***
+
+### dataset {#dataset}
+
+> **dataset**: `object`
+
+The user-controlled JSON-LD dataset payload. Stored as an
+opaque object and validated/populated at publish time.
+
+#### Index Signature
+
+\[`key`: `string`\]: `unknown`
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+Creation timestamp (ISO string format).
+
+***
+
+### dateModified {#datemodified}
+
+> **dateModified**: `string`
+
+Last update timestamp (ISO string format).

package/docs/reference/classes/TransferProcess.md

@@ -15,20 +15,21 @@ This entity is the persistent representation of ITransferProcess.
 
 ## Properties
 
-### consumerPid {#consumerpid}
+### id {#id}
 
-> **consumerPid**: `string`
+> **id**: `string`
 
-The consumer PID is the primary key.
-Used for direct lookup by consumerPid.
+Internal id, the primary key. Both role records of a self transfer share consumerPid and
+providerPid, so only the internal id is collision-free within one partition.
 
 ***
 
-### id {#id}
+### consumerPid {#consumerpid}
 
-> **id**: `string`
+> **consumerPid**: `string`
 
-Internal UUID for storage (secondary key for providerPid lookup).
+Consumer Process ID from the DSP protocol.
+Indexed for lookup by consumerPid.
 
 ***
 
@@ -95,8 +96,8 @@ Provider identity (DID or URI).
 > `optional` **localRole?**: [`TransferProcessRole`](../type-aliases/TransferProcessRole.md)
 
 This node's role in the transfer, captured at write time so state transitions and async delivery
-can tell which party we are without inferring it from the matched PID (consumerPid is the primary
-key on both nodes). Optional for back-compat with records written before this field existed.
+can tell which party we are without inferring it from the matched PID (a self transfer stores two
+records sharing both pids). Optional for back-compat with records written before this field existed.
 
 ***
 
@@ -140,16 +141,9 @@ Last update timestamp (ISO string format).
 
 ***
 
-### policies? {#policies}
-
-> `optional` **policies?**: `IRightsManagementPolicy`[]
-
-Policies from the Agreement (stored as JSON).
-
-***
-
 ### dataAddress? {#dataaddress}
 
 > `optional` **dataAddress?**: `IDataspaceProtocolDataAddress`
 
-Data address for push mode transfers (stored as JSON).
+Data address for the transfer (stored as JSON): the consumer's inbox for PUSH, or the
+provider-built address persisted at start for PULL/POST; may expire while STARTED.

package/docs/reference/classes/TransferProcessV0.md

@@ -0,0 +1,156 @@
+# Class: TransferProcessV0
+
+Transfer Process for shared storage between Control Plane and Data Plane, version 0.
+Keyed on consumerPid; superseded by the version keyed on the internal id.
+
+## Constructors
+
+### Constructor
+
+> **new TransferProcessV0**(): `TransferProcessV0`
+
+#### Returns
+
+`TransferProcessV0`
+
+## Properties
+
+### consumerPid {#consumerpid}
+
+> **consumerPid**: `string`
+
+The consumer PID is the primary key.
+Used for direct lookup by consumerPid.
+
+***
+
+### id {#id}
+
+> **id**: `string`
+
+Internal UUID for storage (secondary key for providerPid lookup).
+
+***
+
+### providerPid {#providerpid}
+
+> **providerPid**: `string`
+
+Provider Process ID from the DSP protocol.
+Indexed for lookup by providerPid.
+
+***
+
+### agreementId {#agreementid}
+
+> **agreementId**: `string`
+
+Agreement ID linking to the rights-management Agreement.
+
+***
+
+### state {#state}
+
+> **state**: `DataspaceProtocolTransferProcessStateType`
+
+Transfer Process state from the DSP protocol.
+One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.
+
+***
+
+### datasetId {#datasetid}
+
+> **datasetId**: `string`
+
+Dataset ID for DSC resolution.
+
+***
+
+### offerId {#offerid}
+
+> **offerId**: `string`
+
+Offer ID from the original Catalog offer.
+
+***
+
+### consumerIdentity? {#consumeridentity}
+
+> `optional` **consumerIdentity?**: `string`
+
+Consumer identity (DID or URI).
+
+***
+
+### providerIdentity? {#provideridentity}
+
+> `optional` **providerIdentity?**: `string`
+
+Provider identity (DID or URI).
+
+***
+
+### localRole? {#localrole}
+
+> `optional` **localRole?**: [`TransferProcessRole`](../type-aliases/TransferProcessRole.md)
+
+This node's role in the transfer, captured at write time so state transitions and async delivery
+can tell which party we are without inferring it from the matched PID (consumerPid is the primary
+key on both nodes). Optional for back-compat with records written before this field existed.
+
+***
+
+### format? {#format}
+
+> `optional` **format?**: `string`
+
+Data format from the Dataset Distribution.
+
+***
+
+### callbackAddress? {#callbackaddress}
+
+> `optional` **callbackAddress?**: `string`
+
+Callback address for Consumer notifications.
+
+***
+
+### organizationIdentity {#organizationidentity}
+
+> **organizationIdentity**: `string`
+
+The organization that owns this transfer process, captured from the request context at write time.
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+Creation timestamp (ISO string format).
+
+***
+
+### dateModified {#datemodified}
+
+> **dateModified**: `string`
+
+Last update timestamp (ISO string format).
+
+***
+
+### policies? {#policies}
+
+> `optional` **policies?**: `IRightsManagementPolicy`[]
+
+Policies from the Agreement (stored as JSON).
+
+***
+
+### dataAddress? {#dataaddress}
+
+> `optional` **dataAddress?**: `IDataspaceProtocolDataAddress`
+
+Data address for the transfer (stored as JSON): the consumer's inbox for PUSH, or the
+provider-built address persisted at start for PULL/POST; may expire while STARTED.