@twin.org/standards-dataspace-protocol 0.0.3-next.3 → 0.0.3-next.5

package/docs/reference/interfaces/IEndpointProperty.md

@@ -0,0 +1,28 @@
+# Interface: IEndpointProperty
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
+
+## Properties
+
+### @type
+
+> **@type**: `string`
+
+LD Type.
+
+***
+
+### name
+
+> **name**: `string`
+
+Property name.
+
+***
+
+### value
+
+> **value**: `string`
+
+Property value.

package/docs/reference/interfaces/ITransferCompletionMessage.md

@@ -0,0 +1,36 @@
+# Interface: ITransferCompletionMessage
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.

package/docs/reference/interfaces/ITransferError.md

@@ -0,0 +1,52 @@
+# Interface: ITransferError
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.
+
+***
+
+### code?
+
+> `optional` **code**: `string`
+
+The error code.
+
+***
+
+### reason?
+
+> `optional` **reason**: `any`[]
+
+The error reason(s).

package/docs/reference/interfaces/ITransferProcess.md

@@ -0,0 +1,74 @@
+# Interface: ITransferProcess
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.
+
+***
+
+### state
+
+> **state**: `object`
+
+The transfer process state.
+
+#### COMPLETED
+
+> **COMPLETED**: `string` = `"COMPLETED"`
+
+Completed
+
+#### REQUESTED
+
+> **REQUESTED**: `string` = `"REQUESTED"`
+
+Requested
+
+#### STARTED
+
+> **STARTED**: `string` = `"STARTED"`
+
+Started
+
+#### SUSPENDED
+
+> **SUSPENDED**: `string` = `"SUSPENDED"`
+
+Suspended
+
+#### TERMINATED
+
+> **TERMINATED**: `string` = `"TERMINATED"`
+
+Terminated

package/docs/reference/interfaces/ITransferRequestMessage.md

@@ -0,0 +1,62 @@
+# Interface: ITransferRequestMessage
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### agreementId
+
+> **agreementId**: `string`
+
+MUST refer to an existing Agreement between the Consumer and Provider.
+
+***
+
+### callbackAddress
+
+> **callbackAddress**: `string`
+
+MUST be a URI indicating where messages to the Consumer SHOULD be sent.
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### format
+
+> **format**: `string`
+
+The format property is a format specified by a Distribution for the Dataset associated with the Agreement.
+This is generally obtained from the Provider's Catalog.
+
+***
+
+### dataAddress?
+
+> `optional` **dataAddress**: [`IDataAddress`](IDataAddress.md)
+
+If defined MUST contain a transport-specific set of properties for pushing the data.
+It MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType.

package/docs/reference/interfaces/ITransferStartMessage.md

@@ -0,0 +1,45 @@
+# Interface: ITransferStartMessage
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.
+
+***
+
+### dataAddress?
+
+> `optional` **dataAddress**: [`IDataAddress`](IDataAddress.md)
+
+MUST be provided if the current transfer is a pull transfer and
+contains a transport-specific endpoint address for obtaining the data.

package/docs/reference/interfaces/ITransferSuspensionMessage.md

@@ -0,0 +1,52 @@
+# Interface: ITransferSuspensionMessage
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.
+
+***
+
+### code?
+
+> `optional` **code**: `string`
+
+The suspension code.
+
+***
+
+### reason?
+
+> `optional` **reason**: `any`[]
+
+The suspension reason(s).

package/docs/reference/interfaces/ITransferTerminationMessage.md

@@ -0,0 +1,52 @@
+# Interface: ITransferTerminationMessage
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.
+
+***
+
+### code?
+
+> `optional` **code**: `string`
+
+The termination code.
+
+***
+
+### reason?
+
+> `optional` **reason**: `any`[]
+
+The termination reason(s).

package/docs/reference/type-aliases/CatalogTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: CatalogTypes
+
+> **CatalogTypes** = *typeof* [`CatalogTypes`](../variables/CatalogTypes.md)\[keyof *typeof* [`CatalogTypes`](../variables/CatalogTypes.md)\]
+
+The types for Dataspace Protocol Catalog Protocol.

package/docs/reference/type-aliases/DataspaceProtocolContextType.md

@@ -0,0 +1,5 @@
+# Type Alias: DataspaceProtocolContextType
+
+> **DataspaceProtocolContextType** = \[*typeof* [`ContextRoot`](../variables/DataspaceProtocolContexts.md#contextroot)\] \| \[`...IJsonLdContextDefinitionElement[]`, *typeof* [`ContextRoot`](../variables/DataspaceProtocolContexts.md#contextroot), `IJsonLdContextDefinitionElement`\] \| \[`IJsonLdContextDefinitionElement`, *typeof* [`ContextRoot`](../variables/DataspaceProtocolContexts.md#contextroot), `...IJsonLdContextDefinitionElement[]`\]
+
+The Dataspace Protocol Protocol JSON-LD context type.

package/docs/reference/type-aliases/DataspaceProtocolContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: DataspaceProtocolContexts
+
+> **DataspaceProtocolContexts** = *typeof* [`DataspaceProtocolContexts`](../variables/DataspaceProtocolContexts.md)\[keyof *typeof* [`DataspaceProtocolContexts`](../variables/DataspaceProtocolContexts.md)\]
+
+The contexts for Dataspace Protocol Protocol.

package/docs/reference/type-aliases/TransferProcessStateType.md

@@ -0,0 +1,5 @@
+# Type Alias: TransferProcessStateType
+
+> **TransferProcessStateType** = *typeof* [`TransferProcessStateType`](../variables/TransferProcessStateType.md)\[keyof *typeof* [`TransferProcessStateType`](../variables/TransferProcessStateType.md)\]
+
+The types for Dataspace Protocol Transfer.

package/docs/reference/type-aliases/TransferProcessTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: TransferProcessTypes
+
+> **TransferProcessTypes** = *typeof* [`TransferProcessTypes`](../variables/TransferProcessTypes.md)\[keyof *typeof* [`TransferProcessTypes`](../variables/TransferProcessTypes.md)\]
+
+The types for Dataspace Protocol Transfer.

package/docs/reference/variables/CatalogTypes.md

@@ -0,0 +1,26 @@
+# Variable: CatalogTypes
+
+> `const` **CatalogTypes**: `object`
+
+The types for Dataspace Protocol Catalog Protocol.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-protocol
+
+## Type Declaration
+
+### CatalogRequestMessage
+
+> `readonly` **CatalogRequestMessage**: `"CatalogRequestMessage"` = `"CatalogRequestMessage"`
+
+Catalog Request Message.
+
+### DatasetRequestMessage
+
+> `readonly` **DatasetRequestMessage**: `"DatasetRequestMessage"` = `"DatasetRequestMessage"`
+
+Dataset Request Message.
+
+### CatalogError
+
+> `readonly` **CatalogError**: `"CatalogError"` = `"CatalogError"`
+
+Catalog Error.

package/docs/reference/variables/DataspaceProtocolContexts.md

@@ -0,0 +1,19 @@
+# Variable: DataspaceProtocolContexts
+
+> `const` **DataspaceProtocolContexts**: `object`
+
+The contexts for Dataspace Protocol Protocol.
+
+## Type Declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://w3id.org/dspace/2025/1/context.json"` = `"https://w3id.org/dspace/2025/1/context.json"`
+
+The context root for Dataspace Protocol Protocol.
+
+### ContextRedirect
+
+> `readonly` **ContextRedirect**: `"https://w3id.org/dspace/2025/1/context.jsonld"` = `"https://w3id.org/dspace/2025/1/context.jsonld"`
+
+The context redirect for Dataspace Protocol Protocol.

package/docs/reference/variables/TransferProcessStateType.md

@@ -0,0 +1,38 @@
+# Variable: TransferProcessStateType
+
+> `const` **TransferProcessStateType**: `object`
+
+The states for Dataspace Protocol Transfer Process.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#ack-transfer-process
+
+## Type Declaration
+
+### COMPLETED
+
+> **COMPLETED**: `string` = `"COMPLETED"`
+
+Completed
+
+### REQUESTED
+
+> **REQUESTED**: `string` = `"REQUESTED"`
+
+Requested
+
+### STARTED
+
+> **STARTED**: `string` = `"STARTED"`
+
+Started
+
+### SUSPENDED
+
+> **SUSPENDED**: `string` = `"SUSPENDED"`
+
+Suspended
+
+### TERMINATED
+
+> **TERMINATED**: `string` = `"TERMINATED"`
+
+Terminated

package/docs/reference/variables/TransferProcessTypes.md

@@ -0,0 +1,62 @@
+# Variable: TransferProcessTypes
+
+> `const` **TransferProcessTypes**: `object`
+
+The types for Dataspace Protocol Transfer Process.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#message-types-1
+
+## Type Declaration
+
+### TransferRequestMessage
+
+> **TransferRequestMessage**: `string` = `"TransferRequestMessage"`
+
+Transfer Request Message.
+
+### TransferStartMessage
+
+> **TransferStartMessage**: `string` = `"TransferStartMessage"`
+
+Transfer Start Message.
+
+### TransferSuspensionMessage
+
+> **TransferSuspensionMessage**: `string` = `"TransferSuspensionMessage"`
+
+Transfer Suspension Message.
+
+### TransferCompletionMessage
+
+> **TransferCompletionMessage**: `string` = `"TransferCompletionMessage"`
+
+Transfer Completion Message.
+
+### TransferTerminationMessage
+
+> **TransferTerminationMessage**: `string` = `"TransferTerminationMessage"`
+
+Transfer Termination Message.
+
+### DataAddress
+
+> **DataAddress**: `string` = `"DataAddress"`
+
+Data Address
+
+### EndpointProperty
+
+> **EndpointProperty**: `string` = `"EndpointProperty"`
+
+Endpoint property.
+
+### TransferProcess
+
+> **TransferProcess**: `string` = `"TransferProcess"`
+
+Transfer Process
+
+### TransferError
+
+> **TransferError**: `string` = `"TransferError"`
+
+Transfer Error.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/standards-dataspace-protocol",
-	"version": "0.0.3-next.3",
+	"version": "0.0.3-next.5",
 	"description": "Models which define the structure of Dataspace Protocol",
 	"repository": {
 		"type": "git",
@@ -17,7 +17,8 @@
 		"@twin.org/core": "next",
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/standards-w3c-odrl": "0.0.3-next.3",
+		"@twin.org/standards-w3c-dcat": "0.0.3-next.5",
+		"@twin.org/standards-w3c-odrl": "0.0.3-next.5",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",

package/dist/es/models/contractNegotiation/contractNegotiationContextType.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=contractNegotiationContextType.js.map

package/dist/es/models/contractNegotiation/contractNegotiationContextType.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"contractNegotiationContextType.js","sourceRoot":"","sources":["../../../../src/models/contractNegotiation/contractNegotiationContextType.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { ContractNegotiationContexts } from \"./contractNegotiationContexts.js\";\n\n/**\n * The Dataspace Protocol Contract Negotiation JSON-LD context type.\n */\nexport type ContractNegotiationContextType =\n\t| typeof ContractNegotiationContexts.ContextRoot\n\t| [\n\t\t\t...IJsonLdContextDefinitionElement[],\n\t\t\ttypeof ContractNegotiationContexts.ContextRoot,\n\t\t\tIJsonLdContextDefinitionElement\n\t  ]\n\t| [\n\t\t\tIJsonLdContextDefinitionElement,\n\t\t\ttypeof ContractNegotiationContexts.ContextRoot,\n\t\t\t...IJsonLdContextDefinitionElement[]\n\t  ];\n"]}

package/dist/es/models/contractNegotiation/contractNegotiationContexts.js

@@ -1,17 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The contexts for Dataspace Protocol Contract Negotiation Protocol.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const ContractNegotiationContexts = {
-    /**
-     * The context root for Dataspace Protocol Contract Negotiation Protocol.
-     */
-    ContextRoot: "https://w3id.org/dspace/2024/1/context.json",
-    /**
-     * The context redirect for Dataspace Protocol Contract Negotiation Protocol.
-     */
-    ContextRedirect: "https://w3id.org/dspace/2025/1/context.jsonld"
-};
-//# sourceMappingURL=contractNegotiationContexts.js.map

package/dist/es/models/contractNegotiation/contractNegotiationContexts.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"contractNegotiationContexts.js","sourceRoot":"","sources":["../../../../src/models/contractNegotiation/contractNegotiationContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GAAG;IAC1C;;OAEG;IACH,WAAW,EAAE,6CAA6C;IAE1D;;OAEG;IACH,eAAe,EAAE,+CAA+C;CACvD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts for Dataspace Protocol Contract Negotiation Protocol.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ContractNegotiationContexts = {\n\t/**\n\t * The context root for Dataspace Protocol Contract Negotiation Protocol.\n\t */\n\tContextRoot: \"https://w3id.org/dspace/2024/1/context.json\",\n\n\t/**\n\t * The context redirect for Dataspace Protocol Contract Negotiation Protocol.\n\t */\n\tContextRedirect: \"https://w3id.org/dspace/2025/1/context.jsonld\"\n} as const;\n\n/**\n * The contexts for Dataspace Protocol Contract Negotiation Protocol.\n */\nexport type ContractNegotiationContexts =\n\t(typeof ContractNegotiationContexts)[keyof typeof ContractNegotiationContexts];\n"]}

package/dist/types/models/contractNegotiation/contractNegotiationContextType.d.ts

@@ -1,14 +0,0 @@
-import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
-import type { ContractNegotiationContexts } from "./contractNegotiationContexts.js";
-/**
- * The Dataspace Protocol Contract Negotiation JSON-LD context type.
- */
-export type ContractNegotiationContextType = typeof ContractNegotiationContexts.ContextRoot | [
-    ...IJsonLdContextDefinitionElement[],
-    typeof ContractNegotiationContexts.ContextRoot,
-    IJsonLdContextDefinitionElement
-] | [
-    IJsonLdContextDefinitionElement,
-    typeof ContractNegotiationContexts.ContextRoot,
-    ...IJsonLdContextDefinitionElement[]
-];

package/dist/types/models/contractNegotiation/contractNegotiationContexts.d.ts

@@ -1,17 +0,0 @@
-/**
- * The contexts for Dataspace Protocol Contract Negotiation Protocol.
- */
-export declare const ContractNegotiationContexts: {
-    /**
-     * The context root for Dataspace Protocol Contract Negotiation Protocol.
-     */
-    readonly ContextRoot: "https://w3id.org/dspace/2024/1/context.json";
-    /**
-     * The context redirect for Dataspace Protocol Contract Negotiation Protocol.
-     */
-    readonly ContextRedirect: "https://w3id.org/dspace/2025/1/context.jsonld";
-};
-/**
- * The contexts for Dataspace Protocol Contract Negotiation Protocol.
- */
-export type ContractNegotiationContexts = (typeof ContractNegotiationContexts)[keyof typeof ContractNegotiationContexts];

package/docs/reference/type-aliases/ContractNegotiationContextType.md

@@ -1,5 +0,0 @@
-# Type Alias: ContractNegotiationContextType
-
-> **ContractNegotiationContextType** = *typeof* [`ContextRoot`](../variables/ContractNegotiationContexts.md#contextroot) \| \[`...IJsonLdContextDefinitionElement[]`, *typeof* [`ContextRoot`](../variables/ContractNegotiationContexts.md#contextroot), `IJsonLdContextDefinitionElement`\] \| \[`IJsonLdContextDefinitionElement`, *typeof* [`ContextRoot`](../variables/ContractNegotiationContexts.md#contextroot), `...IJsonLdContextDefinitionElement[]`\]
-
-The Dataspace Protocol Contract Negotiation JSON-LD context type.