@twin.org/dataspace-models 0.0.3-next.48 → 0.0.3-next.49
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/es/entities/dataspaceAppDataset.js +0 -2
- package/dist/es/entities/dataspaceAppDataset.js.map +1 -1
- package/dist/es/index.js +4 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/app/IDataAssetQuery.js.map +1 -1
- package/dist/es/models/app/IDataspaceApp.js.map +1 -1
- package/dist/es/models/controlPlane/dataspaceControlPlaneMetricIds.js +49 -0
- package/dist/es/models/controlPlane/dataspaceControlPlaneMetricIds.js.map +1 -0
- package/dist/es/models/controlPlane/dataspaceControlPlaneMetrics.js +61 -0
- package/dist/es/models/controlPlane/dataspaceControlPlaneMetrics.js.map +1 -0
- package/dist/es/models/dataPlane/dataspaceDataPlaneMetricIds.js +33 -0
- package/dist/es/models/dataPlane/dataspaceDataPlaneMetricIds.js.map +1 -0
- package/dist/es/models/dataPlane/dataspaceDataPlaneMetrics.js +41 -0
- package/dist/es/models/dataPlane/dataspaceDataPlaneMetrics.js.map +1 -0
- package/dist/types/entities/dataspaceAppDataset.d.ts +0 -2
- package/dist/types/index.d.ts +4 -0
- package/dist/types/models/app/IDataAssetQuery.d.ts +1 -4
- package/dist/types/models/app/IDataspaceApp.d.ts +2 -12
- package/dist/types/models/controlPlane/dataspaceControlPlaneMetricIds.d.ts +49 -0
- package/dist/types/models/controlPlane/dataspaceControlPlaneMetrics.d.ts +5 -0
- package/dist/types/models/dataPlane/dataspaceDataPlaneMetricIds.d.ts +33 -0
- package/dist/types/models/dataPlane/dataspaceDataPlaneMetrics.d.ts +5 -0
- package/docs/changelog.md +8 -0
- package/docs/reference/classes/DataspaceAppDataset.md +0 -2
- package/docs/reference/index.md +6 -0
- package/docs/reference/interfaces/IDataAssetQuery.md +1 -6
- package/docs/reference/interfaces/IDataspaceApp.md +0 -25
- package/docs/reference/type-aliases/DataspaceControlPlaneMetricIds.md +5 -0
- package/docs/reference/type-aliases/DataspaceDataPlaneMetricIds.md +5 -0
- package/docs/reference/variables/DataspaceControlPlaneMetricIds.md +67 -0
- package/docs/reference/variables/DataspaceControlPlaneMetrics.md +5 -0
- package/docs/reference/variables/DataspaceDataPlaneMetricIds.md +43 -0
- package/docs/reference/variables/DataspaceDataPlaneMetrics.md +5 -0
- package/package.json +3 -2
|
@@ -22,8 +22,6 @@ let DataspaceAppDataset = class DataspaceAppDataset {
|
|
|
22
22
|
/**
|
|
23
23
|
* The dataspace app that this dataset belongs to. Matches the app's
|
|
24
24
|
* registered name in `DataspaceAppFactory` (typically the app's URI).
|
|
25
|
-
* Used as the join key when dispatching to an app's optional
|
|
26
|
-
* `datasetsHandled` override.
|
|
27
25
|
*/
|
|
28
26
|
appId;
|
|
29
27
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataspaceAppDataset.js","sourceRoot":"","sources":["../../../src/entities/dataspaceAppDataset.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEnE;;GAEG;AAEI,IAAM,mBAAmB,GAAzB,MAAM,mBAAmB;IAC/B;;OAEG;IAEI,EAAE,CAAU;IAEnB;;OAEG;IAEI,oBAAoB,CAAU;IAErC;;;;OAIG;IAEI,QAAQ,CAAU;IAEzB
|
|
1
|
+
{"version":3,"file":"dataspaceAppDataset.js","sourceRoot":"","sources":["../../../src/entities/dataspaceAppDataset.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEnE;;GAEG;AAEI,IAAM,mBAAmB,GAAzB,MAAM,mBAAmB;IAC/B;;OAEG;IAEI,EAAE,CAAU;IAEnB;;OAEG;IAEI,oBAAoB,CAAU;IAErC;;;;OAIG;IAEI,QAAQ,CAAU;IAEzB;;;OAGG;IAEI,KAAK,CAAU;IAEtB;;;OAGG;IAEI,OAAO,CAA8B;IAE5C;;OAEG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,YAAY,CAAU;CAC7B,CAAA;AAzCO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;+CAC3B;AAMZ;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;;iEACX;AAQ9B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;qDACpB;AAOlB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;kDACP;AAOf;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;;oDACD;AAMrC;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,CAAC,UAAU,EAAE,CAAC;;wDAC/D;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;;yDACrB;AA7CjB,mBAAmB;IAD/B,MAAM,EAAE;GACI,mBAAmB,CA8C/B","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property, SortDirection } from \"@twin.org/entity\";\n\n/**\n * Tenant-supplied Dataset shape persisted by the Control Plane.\n */\n@entity()\nexport class DataspaceAppDataset {\n\t/**\n\t * The unique identifier for the dataset.\n\t */\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic id!: string;\n\n\t/**\n\t * The identity of the organization that owns this entity.\n\t */\n\t@property({ type: \"string\", isSecondary: true })\n\tpublic organizationIdentity!: string;\n\n\t/**\n\t * The tenant that owns this dataset, captured from the request context at\n\t * write time. Optional — single-tenant nodes (no `TWIN_TENANT_ENABLED`)\n\t * register datasets without a tenant context.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic tenantId?: string;\n\n\t/**\n\t * The dataspace app that this dataset belongs to. Matches the app's\n\t * registered name in `DataspaceAppFactory` (typically the app's URI).\n\t */\n\t@property({ type: \"string\" })\n\tpublic appId!: string;\n\n\t/**\n\t * The user-controlled JSON-LD dataset payload. Stored as an\n\t * opaque object and validated/populated at publish time.\n\t */\n\t@property({ type: \"object\", format: \"json\" })\n\tpublic dataset!: { [key: string]: unknown };\n\n\t/**\n\t * Creation timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\", sortDirection: SortDirection.Descending })\n\tpublic dateCreated!: string;\n\n\t/**\n\t * Last update timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\" })\n\tpublic dateModified!: string;\n}\n"]}
|
package/dist/es/index.js
CHANGED
|
@@ -5,6 +5,8 @@ export * from "./entities/dataspaceAppDataset.js";
|
|
|
5
5
|
export * from "./entities/transferProcess.js";
|
|
6
6
|
// Control Plane exports
|
|
7
7
|
export * from "./models/controlPlane/api/ITransferContextResponse.js";
|
|
8
|
+
export * from "./models/controlPlane/dataspaceControlPlaneMetricIds.js";
|
|
9
|
+
export * from "./models/controlPlane/dataspaceControlPlaneMetrics.js";
|
|
8
10
|
export * from "./models/controlPlane/IDataspaceAppDataset.js";
|
|
9
11
|
export * from "./models/controlPlane/IDataspaceControlPlaneComponent.js";
|
|
10
12
|
export * from "./models/controlPlane/IDataspaceControlPlaneResolverComponent.js";
|
|
@@ -14,6 +16,8 @@ export * from "./models/controlPlane/ITransferContext.js";
|
|
|
14
16
|
export * from "./models/controlPlane/ITransferProcess.js";
|
|
15
17
|
export * from "./models/controlPlane/transferProcessRole.js";
|
|
16
18
|
// Data Plane exports
|
|
19
|
+
export * from "./models/dataPlane/dataspaceDataPlaneMetricIds.js";
|
|
20
|
+
export * from "./models/dataPlane/dataspaceDataPlaneMetrics.js";
|
|
17
21
|
export * from "./models/dataPlane/IDataspaceDataPlaneComponent.js";
|
|
18
22
|
export * from "./models/dataspaceContexts.js";
|
|
19
23
|
export * from "./models/dataspaceTransferFormat.js";
|
package/dist/es/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,iBAAiB;AACjB,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAE9C,wBAAwB;AACxB,cAAc,uDAAuD,CAAC;AACtE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0DAA0D,CAAC;AACzE,cAAc,kEAAkE,CAAC;AACjF,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,8CAA8C,CAAC;AAE7D,qBAAqB;AACrB,cAAc,oDAAoD,CAAC;AAEnE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,mCAAmC,CAAC;AAElD,cAAc;AACd,cAAc,oCAAoC,CAAC;AACnD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yCAAyC,CAAC;AAExD,gBAAgB;AAChB,cAAc,sCAAsC,CAAC;AACrD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,uDAAuD,CAAC;AACtE,cAAc,2CAA2C,CAAC;AAC1D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,wCAAwC,CAAC;AAEvD,wDAAwD;AACxD,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,uDAAuD,CAAC;AACtE,cAAc,oDAAoD,CAAC;AACnE,cAAc,qDAAqD,CAAC;AACpE,cAAc,qDAAqD,CAAC;AACpE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AACxE,cAAc,0DAA0D,CAAC;AACzE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,oDAAoD,CAAC;AACnE,cAAc,qDAAqD,CAAC;AACpE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AAExE,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wCAAwC,CAAC;AACvD,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AAEjD,kBAAkB;AAClB,cAAc,wBAAwB,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n// Entity exports\nexport * from \"./entities/dataspaceAppDataset.js\";\nexport * from \"./entities/transferProcess.js\";\n\n// Control Plane exports\nexport * from \"./models/controlPlane/api/ITransferContextResponse.js\";\nexport * from \"./models/controlPlane/IDataspaceAppDataset.js\";\nexport * from \"./models/controlPlane/IDataspaceControlPlaneComponent.js\";\nexport * from \"./models/controlPlane/IDataspaceControlPlaneResolverComponent.js\";\nexport * from \"./models/controlPlane/INegotiationCallback.js\";\nexport * from \"./models/controlPlane/ITransferCallback.js\";\nexport * from \"./models/controlPlane/ITransferContext.js\";\nexport * from \"./models/controlPlane/ITransferProcess.js\";\nexport * from \"./models/controlPlane/transferProcessRole.js\";\n\n// Data Plane exports\nexport * from \"./models/dataPlane/IDataspaceDataPlaneComponent.js\";\n\nexport * from \"./models/dataspaceContexts.js\";\nexport * from \"./models/dataspaceTransferFormat.js\";\nexport * from \"./models/dataspaceTypes.js\";\nexport * from \"./models/IDataspaceActivity.js\";\n\nexport * from \"./dataTypes/dataspaceDataTypes.js\";\n\n// App exports\nexport * from \"./factories/dataspaceAppFactory.js\";\nexport * from \"./models/app/IDataspaceApp.js\";\nexport * from \"./models/app/IFollowActivity.js\";\nexport * from \"./models/app/IUndoActivity.js\";\nexport * from \"./models/app/IProcessingGroupOptions.js\";\n\n// Other exports\nexport * from \"./models/activityProcessingStatus.js\";\nexport * from \"./models/api/IActivityLogEntryGetRequest.js\";\nexport * from \"./models/api/IActivityLogEntryGetResponse.js\";\nexport * from \"./models/api/IActivityLogStatusNotificationPayload.js\";\nexport * from \"./models/api/IActivityLogStatusRequest.js\";\nexport * from \"./models/api/IActivityStreamNotifyRequest.js\";\nexport * from \"./models/api/IActivityStreamNotifyResponse.js\";\nexport * from \"./models/api/IDataAssetEntitiesResponse.js\";\nexport * from \"./models/api/IDataAssetGetEntitiesRequest.js\";\nexport * from \"./models/api/IDataAssetQueryRequest.js\";\n\n// Control Plane API exports - Transfer Process Protocol\nexport * from \"./models/api/controlPlane/IAppDatasetCreateRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetCreateResponse.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetDeleteRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetGetRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetGetResponse.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetListRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetListResponse.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetUpdateRequest.js\";\nexport * from \"./models/api/controlPlane/ICompleteTransferRequest.js\";\nexport * from \"./models/api/controlPlane/ICompleteTransferResponse.js\";\nexport * from \"./models/api/controlPlane/IGetTransferProcessRequest.js\";\nexport * from \"./models/api/controlPlane/IGetTransferProcessResponse.js\";\nexport * from \"./models/api/controlPlane/IRequestTransferRequest.js\";\nexport * from \"./models/api/controlPlane/IRequestTransferResponse.js\";\nexport * from \"./models/api/controlPlane/IStartTransferRequest.js\";\nexport * from \"./models/api/controlPlane/IStartTransferResponse.js\";\nexport * from \"./models/api/controlPlane/ISuspendTransferRequest.js\";\nexport * from \"./models/api/controlPlane/ISuspendTransferResponse.js\";\nexport * from \"./models/api/controlPlane/ITerminateTransferRequest.js\";\nexport * from \"./models/api/controlPlane/ITerminateTransferResponse.js\";\n\nexport * from \"./models/activityTaskStatus.js\";\nexport * from \"./models/app/dataRequestType.js\";\nexport * from \"./models/app/IActivityQuery.js\";\nexport * from \"./models/app/IDataAssetEntitiesRequest.js\";\nexport * from \"./models/app/IDataAssetQuery.js\";\nexport * from \"./models/app/IDataRequest.js\";\nexport * from \"./models/app/IQueryDataAssetRequest.js\";\nexport * from \"./models/IActivityLogDetails.js\";\nexport * from \"./models/IActivityLogEntry.js\";\nexport * from \"./models/IActivityLogStatusNotification.js\";\nexport * from \"./models/IActivityTask.js\";\nexport * from \"./models/IActivityTaskEntry.js\";\nexport * from \"./models/IDataAssetItemList.js\";\nexport * from \"./models/IDataAssetItemListResult.js\";\nexport * from \"./models/IEntitySet.js\";\nexport * from \"./models/IExecutionPayload.js\";\nexport * from \"./models/IFilteringQuery.js\";\nexport * from \"./models/IPushDeliveryPayload.js\";\n\n// Utility exports\nexport * from \"./utils/jsonLdUtils.js\";\n"]}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,iBAAiB;AACjB,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAE9C,wBAAwB;AACxB,cAAc,uDAAuD,CAAC;AACtE,cAAc,yDAAyD,CAAC;AACxE,cAAc,uDAAuD,CAAC;AACtE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0DAA0D,CAAC;AACzE,cAAc,kEAAkE,CAAC;AACjF,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,8CAA8C,CAAC;AAE7D,qBAAqB;AACrB,cAAc,mDAAmD,CAAC;AAClE,cAAc,iDAAiD,CAAC;AAChE,cAAc,oDAAoD,CAAC;AAEnE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,mCAAmC,CAAC;AAElD,cAAc;AACd,cAAc,oCAAoC,CAAC;AACnD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yCAAyC,CAAC;AAExD,gBAAgB;AAChB,cAAc,sCAAsC,CAAC;AACrD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,uDAAuD,CAAC;AACtE,cAAc,2CAA2C,CAAC;AAC1D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,wCAAwC,CAAC;AAEvD,wDAAwD;AACxD,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,uDAAuD,CAAC;AACtE,cAAc,oDAAoD,CAAC;AACnE,cAAc,qDAAqD,CAAC;AACpE,cAAc,qDAAqD,CAAC;AACpE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AACxE,cAAc,0DAA0D,CAAC;AACzE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,oDAAoD,CAAC;AACnE,cAAc,qDAAqD,CAAC;AACpE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AAExE,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wCAAwC,CAAC;AACvD,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AAEjD,kBAAkB;AAClB,cAAc,wBAAwB,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n// Entity exports\nexport * from \"./entities/dataspaceAppDataset.js\";\nexport * from \"./entities/transferProcess.js\";\n\n// Control Plane exports\nexport * from \"./models/controlPlane/api/ITransferContextResponse.js\";\nexport * from \"./models/controlPlane/dataspaceControlPlaneMetricIds.js\";\nexport * from \"./models/controlPlane/dataspaceControlPlaneMetrics.js\";\nexport * from \"./models/controlPlane/IDataspaceAppDataset.js\";\nexport * from \"./models/controlPlane/IDataspaceControlPlaneComponent.js\";\nexport * from \"./models/controlPlane/IDataspaceControlPlaneResolverComponent.js\";\nexport * from \"./models/controlPlane/INegotiationCallback.js\";\nexport * from \"./models/controlPlane/ITransferCallback.js\";\nexport * from \"./models/controlPlane/ITransferContext.js\";\nexport * from \"./models/controlPlane/ITransferProcess.js\";\nexport * from \"./models/controlPlane/transferProcessRole.js\";\n\n// Data Plane exports\nexport * from \"./models/dataPlane/dataspaceDataPlaneMetricIds.js\";\nexport * from \"./models/dataPlane/dataspaceDataPlaneMetrics.js\";\nexport * from \"./models/dataPlane/IDataspaceDataPlaneComponent.js\";\n\nexport * from \"./models/dataspaceContexts.js\";\nexport * from \"./models/dataspaceTransferFormat.js\";\nexport * from \"./models/dataspaceTypes.js\";\nexport * from \"./models/IDataspaceActivity.js\";\n\nexport * from \"./dataTypes/dataspaceDataTypes.js\";\n\n// App exports\nexport * from \"./factories/dataspaceAppFactory.js\";\nexport * from \"./models/app/IDataspaceApp.js\";\nexport * from \"./models/app/IFollowActivity.js\";\nexport * from \"./models/app/IUndoActivity.js\";\nexport * from \"./models/app/IProcessingGroupOptions.js\";\n\n// Other exports\nexport * from \"./models/activityProcessingStatus.js\";\nexport * from \"./models/api/IActivityLogEntryGetRequest.js\";\nexport * from \"./models/api/IActivityLogEntryGetResponse.js\";\nexport * from \"./models/api/IActivityLogStatusNotificationPayload.js\";\nexport * from \"./models/api/IActivityLogStatusRequest.js\";\nexport * from \"./models/api/IActivityStreamNotifyRequest.js\";\nexport * from \"./models/api/IActivityStreamNotifyResponse.js\";\nexport * from \"./models/api/IDataAssetEntitiesResponse.js\";\nexport * from \"./models/api/IDataAssetGetEntitiesRequest.js\";\nexport * from \"./models/api/IDataAssetQueryRequest.js\";\n\n// Control Plane API exports - Transfer Process Protocol\nexport * from \"./models/api/controlPlane/IAppDatasetCreateRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetCreateResponse.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetDeleteRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetGetRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetGetResponse.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetListRequest.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetListResponse.js\";\nexport * from \"./models/api/controlPlane/IAppDatasetUpdateRequest.js\";\nexport * from \"./models/api/controlPlane/ICompleteTransferRequest.js\";\nexport * from \"./models/api/controlPlane/ICompleteTransferResponse.js\";\nexport * from \"./models/api/controlPlane/IGetTransferProcessRequest.js\";\nexport * from \"./models/api/controlPlane/IGetTransferProcessResponse.js\";\nexport * from \"./models/api/controlPlane/IRequestTransferRequest.js\";\nexport * from \"./models/api/controlPlane/IRequestTransferResponse.js\";\nexport * from \"./models/api/controlPlane/IStartTransferRequest.js\";\nexport * from \"./models/api/controlPlane/IStartTransferResponse.js\";\nexport * from \"./models/api/controlPlane/ISuspendTransferRequest.js\";\nexport * from \"./models/api/controlPlane/ISuspendTransferResponse.js\";\nexport * from \"./models/api/controlPlane/ITerminateTransferRequest.js\";\nexport * from \"./models/api/controlPlane/ITerminateTransferResponse.js\";\n\nexport * from \"./models/activityTaskStatus.js\";\nexport * from \"./models/app/dataRequestType.js\";\nexport * from \"./models/app/IActivityQuery.js\";\nexport * from \"./models/app/IDataAssetEntitiesRequest.js\";\nexport * from \"./models/app/IDataAssetQuery.js\";\nexport * from \"./models/app/IDataRequest.js\";\nexport * from \"./models/app/IQueryDataAssetRequest.js\";\nexport * from \"./models/IActivityLogDetails.js\";\nexport * from \"./models/IActivityLogEntry.js\";\nexport * from \"./models/IActivityLogStatusNotification.js\";\nexport * from \"./models/IActivityTask.js\";\nexport * from \"./models/IActivityTaskEntry.js\";\nexport * from \"./models/IDataAssetItemList.js\";\nexport * from \"./models/IDataAssetItemListResult.js\";\nexport * from \"./models/IEntitySet.js\";\nexport * from \"./models/IExecutionPayload.js\";\nexport * from \"./models/IFilteringQuery.js\";\nexport * from \"./models/IPushDeliveryPayload.js\";\n\n// Utility exports\nexport * from \"./utils/jsonLdUtils.js\";\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IDataAssetQuery.js","sourceRoot":"","sources":["../../../../src/models/app/IDataAssetQuery.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Data Asset query for internal service matching of datasets to apps.\n *\n * This interface is used internally by the Dataspace Data Plane service to match\n * datasets with their corresponding apps
|
|
1
|
+
{"version":3,"file":"IDataAssetQuery.js","sourceRoot":"","sources":["../../../../src/models/app/IDataAssetQuery.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Data Asset query for internal service matching of datasets to apps.\n *\n * This interface is used internally by the Dataspace Data Plane service to match\n * datasets with their corresponding apps.\n */\nexport interface IDataAssetQuery {\n\t/**\n\t * Id of the dataset in the Catalogue (dataset @id).\n\t */\n\tdatasetId: string;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IDataspaceApp.js","sourceRoot":"","sources":["../../../../src/models/app/IDataspaceApp.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\nimport type {
|
|
1
|
+
{"version":3,"file":"IDataspaceApp.js","sourceRoot":"","sources":["../../../../src/models/app/IDataspaceApp.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\nimport type { IDataspaceActivity } from \"../IDataspaceActivity.js\";\nimport type { IActivityQuery } from \"./IActivityQuery.js\";\nimport type { IDataRequest } from \"./IDataRequest.js\";\nimport type { IFollowActivity } from \"./IFollowActivity.js\";\nimport type { IProcessingGroupOptions } from \"./IProcessingGroupOptions.js\";\nimport type { IUndoActivity } from \"./IUndoActivity.js\";\n\n/**\n * Interface describes a Dataspace App.\n */\nexport interface IDataspaceApp extends IComponent {\n\t/**\n\t * The settings for the processing groups for tasks.\n\t * @returns The options for each process group.\n\t */\n\tprocessingGroups?(): { [id: string]: IProcessingGroupOptions };\n\n\t/**\n\t * The activities handled by the App.\n\t * @returns A query that describes the set of activities handled by the App.\n\t */\n\tactivitiesHandled(): IActivityQuery[];\n\n\t/**\n\t * The types of queries supported.\n\t * @returns The types of queries supported by the Dataspace App to retrieve data.\n\t */\n\tsupportedQueryTypes(): string[];\n\n\t/**\n\t * Handles an Activity and report about results through the Dataspace Data Plane Callback\n\t * @param activity The Activity to be handled\n\t * @returns The result of executing the Activity.\n\t */\n\thandleActivity?<T>(activity: IDataspaceActivity): Promise<T>;\n\n\t/**\n\t * Handles a Data Request.\n\t * @param dataRequest The data request.\n\t * @param cursor Cursor that points to the next item in the result set.\n\t * @param limit Maximum number of entries retrieved or to be retrieved.\n\t * @returns Data as JSON-Ld.\n\t */\n\thandleDataRequest?(\n\t\tdataRequest: IDataRequest,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{ data: IJsonLdDocument; cursor?: string }>;\n\n\t/**\n\t * Subscribe the app to produce data for a follower. Called by the\n\t * DS Connector after a push transfer enters STARTED state.\n\t * @param followActivity The Follow activity describing the follower + filter.\n\t * @returns Promise that resolves when the subscription is set up.\n\t */\n\tsubscribeToData?(followActivity: IFollowActivity): Promise<void>;\n\n\t/**\n\t * Undo a previous subscription. Called on transfer complete/terminate.\n\t * @param undoActivity The Undo activity referencing the original Follow.\n\t * @returns Promise that resolves when the subscription is torn down.\n\t */\n\tunsubscribeToData?(undoActivity: IUndoActivity): Promise<void>;\n}\n"]}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
// Copyright 2025 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
/**
|
|
4
|
+
* Metric IDs for the dataspace control plane service.
|
|
5
|
+
*/
|
|
6
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
7
|
+
export const DataspaceControlPlaneMetricIds = {
|
|
8
|
+
/**
|
|
9
|
+
* Number of transfer processes requested.
|
|
10
|
+
*/
|
|
11
|
+
TransfersRequested: "dcp_transfers_requested",
|
|
12
|
+
/**
|
|
13
|
+
* Number of transfer processes prepared by the consumer.
|
|
14
|
+
*/
|
|
15
|
+
TransfersPrepared: "dcp_transfers_prepared",
|
|
16
|
+
/**
|
|
17
|
+
* Number of transfer processes started.
|
|
18
|
+
*/
|
|
19
|
+
TransfersStarted: "dcp_transfers_started",
|
|
20
|
+
/**
|
|
21
|
+
* Number of transfer processes completed.
|
|
22
|
+
*/
|
|
23
|
+
TransfersCompleted: "dcp_transfers_completed",
|
|
24
|
+
/**
|
|
25
|
+
* Number of transfer processes suspended.
|
|
26
|
+
*/
|
|
27
|
+
TransfersSuspended: "dcp_transfers_suspended",
|
|
28
|
+
/**
|
|
29
|
+
* Number of transfer processes terminated.
|
|
30
|
+
*/
|
|
31
|
+
TransfersTerminated: "dcp_transfers_terminated",
|
|
32
|
+
/**
|
|
33
|
+
* Number of contract negotiations initiated.
|
|
34
|
+
*/
|
|
35
|
+
NegotiationsInitiated: "dcp_negotiations_initiated",
|
|
36
|
+
/**
|
|
37
|
+
* Number of app datasets created.
|
|
38
|
+
*/
|
|
39
|
+
AppDatasetsCreated: "dcp_app_datasets_created",
|
|
40
|
+
/**
|
|
41
|
+
* Number of app datasets updated.
|
|
42
|
+
*/
|
|
43
|
+
AppDatasetsUpdated: "dcp_app_datasets_updated",
|
|
44
|
+
/**
|
|
45
|
+
* Number of app datasets deleted.
|
|
46
|
+
*/
|
|
47
|
+
AppDatasetsDeleted: "dcp_app_datasets_deleted"
|
|
48
|
+
};
|
|
49
|
+
//# sourceMappingURL=dataspaceControlPlaneMetricIds.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dataspaceControlPlaneMetricIds.js","sourceRoot":"","sources":["../../../../src/models/controlPlane/dataspaceControlPlaneMetricIds.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC7C;;OAEG;IACH,kBAAkB,EAAE,yBAAyB;IAE7C;;OAEG;IACH,iBAAiB,EAAE,wBAAwB;IAE3C;;OAEG;IACH,gBAAgB,EAAE,uBAAuB;IAEzC;;OAEG;IACH,kBAAkB,EAAE,yBAAyB;IAE7C;;OAEG;IACH,kBAAkB,EAAE,yBAAyB;IAE7C;;OAEG;IACH,mBAAmB,EAAE,0BAA0B;IAE/C;;OAEG;IACH,qBAAqB,EAAE,4BAA4B;IAEnD;;OAEG;IACH,kBAAkB,EAAE,0BAA0B;IAE9C;;OAEG;IACH,kBAAkB,EAAE,0BAA0B;IAE9C;;OAEG;IACH,kBAAkB,EAAE,0BAA0B;CACrC,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Metric IDs for the dataspace control plane service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceControlPlaneMetricIds = {\n\t/**\n\t * Number of transfer processes requested.\n\t */\n\tTransfersRequested: \"dcp_transfers_requested\",\n\n\t/**\n\t * Number of transfer processes prepared by the consumer.\n\t */\n\tTransfersPrepared: \"dcp_transfers_prepared\",\n\n\t/**\n\t * Number of transfer processes started.\n\t */\n\tTransfersStarted: \"dcp_transfers_started\",\n\n\t/**\n\t * Number of transfer processes completed.\n\t */\n\tTransfersCompleted: \"dcp_transfers_completed\",\n\n\t/**\n\t * Number of transfer processes suspended.\n\t */\n\tTransfersSuspended: \"dcp_transfers_suspended\",\n\n\t/**\n\t * Number of transfer processes terminated.\n\t */\n\tTransfersTerminated: \"dcp_transfers_terminated\",\n\n\t/**\n\t * Number of contract negotiations initiated.\n\t */\n\tNegotiationsInitiated: \"dcp_negotiations_initiated\",\n\n\t/**\n\t * Number of app datasets created.\n\t */\n\tAppDatasetsCreated: \"dcp_app_datasets_created\",\n\n\t/**\n\t * Number of app datasets updated.\n\t */\n\tAppDatasetsUpdated: \"dcp_app_datasets_updated\",\n\n\t/**\n\t * Number of app datasets deleted.\n\t */\n\tAppDatasetsDeleted: \"dcp_app_datasets_deleted\"\n} as const;\n\n/**\n * Metric IDs for the dataspace control plane service.\n */\nexport type DataspaceControlPlaneMetricIds =\n\t(typeof DataspaceControlPlaneMetricIds)[keyof typeof DataspaceControlPlaneMetricIds];\n"]}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
// Copyright 2025 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
import { MetricType } from "@twin.org/telemetry-models";
|
|
4
|
+
import { DataspaceControlPlaneMetricIds } from "./dataspaceControlPlaneMetricIds.js";
|
|
5
|
+
/**
|
|
6
|
+
* Metrics registered by the dataspace control plane service.
|
|
7
|
+
*/
|
|
8
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
9
|
+
export const DataspaceControlPlaneMetrics = [
|
|
10
|
+
{
|
|
11
|
+
id: DataspaceControlPlaneMetricIds.TransfersRequested,
|
|
12
|
+
label: "Transfers requested",
|
|
13
|
+
type: MetricType.Counter
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
id: DataspaceControlPlaneMetricIds.TransfersPrepared,
|
|
17
|
+
label: "Transfers prepared",
|
|
18
|
+
type: MetricType.Counter
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
id: DataspaceControlPlaneMetricIds.TransfersStarted,
|
|
22
|
+
label: "Transfers started",
|
|
23
|
+
type: MetricType.Counter
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
id: DataspaceControlPlaneMetricIds.TransfersCompleted,
|
|
27
|
+
label: "Transfers completed",
|
|
28
|
+
type: MetricType.Counter
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
id: DataspaceControlPlaneMetricIds.TransfersSuspended,
|
|
32
|
+
label: "Transfers suspended",
|
|
33
|
+
type: MetricType.Counter
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
id: DataspaceControlPlaneMetricIds.TransfersTerminated,
|
|
37
|
+
label: "Transfers terminated",
|
|
38
|
+
type: MetricType.Counter
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
id: DataspaceControlPlaneMetricIds.NegotiationsInitiated,
|
|
42
|
+
label: "Negotiations initiated",
|
|
43
|
+
type: MetricType.Counter
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
id: DataspaceControlPlaneMetricIds.AppDatasetsCreated,
|
|
47
|
+
label: "App datasets created",
|
|
48
|
+
type: MetricType.Counter
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
id: DataspaceControlPlaneMetricIds.AppDatasetsUpdated,
|
|
52
|
+
label: "App datasets updated",
|
|
53
|
+
type: MetricType.Counter
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
id: DataspaceControlPlaneMetricIds.AppDatasetsDeleted,
|
|
57
|
+
label: "App datasets deleted",
|
|
58
|
+
type: MetricType.Counter
|
|
59
|
+
}
|
|
60
|
+
];
|
|
61
|
+
//# sourceMappingURL=dataspaceControlPlaneMetrics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dataspaceControlPlaneMetrics.js","sourceRoot":"","sources":["../../../../src/models/controlPlane/dataspaceControlPlaneMetrics.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAyB,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAErF;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,4BAA4B,GAAuB;IAC/D;QACC,EAAE,EAAE,8BAA8B,CAAC,kBAAkB;QACrD,KAAK,EAAE,qBAAqB;QAC5B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,8BAA8B,CAAC,iBAAiB;QACpD,KAAK,EAAE,oBAAoB;QAC3B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,8BAA8B,CAAC,gBAAgB;QACnD,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,8BAA8B,CAAC,kBAAkB;QACrD,KAAK,EAAE,qBAAqB;QAC5B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,8BAA8B,CAAC,kBAAkB;QACrD,KAAK,EAAE,qBAAqB;QAC5B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,8BAA8B,CAAC,mBAAmB;QACtD,KAAK,EAAE,sBAAsB;QAC7B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,8BAA8B,CAAC,qBAAqB;QACxD,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,8BAA8B,CAAC,kBAAkB;QACrD,KAAK,EAAE,sBAAsB;QAC7B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,8BAA8B,CAAC,kBAAkB;QACrD,KAAK,EAAE,sBAAsB;QAC7B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,8BAA8B,CAAC,kBAAkB;QACrD,KAAK,EAAE,sBAAsB;QAC7B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;CACD,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { type ITelemetryMetric, MetricType } from \"@twin.org/telemetry-models\";\nimport { DataspaceControlPlaneMetricIds } from \"./dataspaceControlPlaneMetricIds.js\";\n\n/**\n * Metrics registered by the dataspace control plane service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceControlPlaneMetrics: ITelemetryMetric[] = [\n\t{\n\t\tid: DataspaceControlPlaneMetricIds.TransfersRequested,\n\t\tlabel: \"Transfers requested\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceControlPlaneMetricIds.TransfersPrepared,\n\t\tlabel: \"Transfers prepared\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceControlPlaneMetricIds.TransfersStarted,\n\t\tlabel: \"Transfers started\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceControlPlaneMetricIds.TransfersCompleted,\n\t\tlabel: \"Transfers completed\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceControlPlaneMetricIds.TransfersSuspended,\n\t\tlabel: \"Transfers suspended\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceControlPlaneMetricIds.TransfersTerminated,\n\t\tlabel: \"Transfers terminated\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceControlPlaneMetricIds.NegotiationsInitiated,\n\t\tlabel: \"Negotiations initiated\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceControlPlaneMetricIds.AppDatasetsCreated,\n\t\tlabel: \"App datasets created\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceControlPlaneMetricIds.AppDatasetsUpdated,\n\t\tlabel: \"App datasets updated\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceControlPlaneMetricIds.AppDatasetsDeleted,\n\t\tlabel: \"App datasets deleted\",\n\t\ttype: MetricType.Counter\n\t}\n];\n"]}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
// Copyright 2025 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
/**
|
|
4
|
+
* Metric IDs for the dataspace data plane service.
|
|
5
|
+
*/
|
|
6
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
7
|
+
export const DataspaceDataPlaneMetricIds = {
|
|
8
|
+
/**
|
|
9
|
+
* Number of activities notified.
|
|
10
|
+
*/
|
|
11
|
+
ActivitiesNotified: "ddp_activities_notified",
|
|
12
|
+
/**
|
|
13
|
+
* Number of data asset queries executed.
|
|
14
|
+
*/
|
|
15
|
+
DataAssetsQueried: "ddp_data_assets_queried",
|
|
16
|
+
/**
|
|
17
|
+
* Number of data asset entity retrievals.
|
|
18
|
+
*/
|
|
19
|
+
DataAssetsRetrieved: "ddp_data_assets_retrieved",
|
|
20
|
+
/**
|
|
21
|
+
* Number of push subscriptions created.
|
|
22
|
+
*/
|
|
23
|
+
PushSubscriptionsCreated: "ddp_push_subscriptions_created",
|
|
24
|
+
/**
|
|
25
|
+
* Number of push subscriptions removed.
|
|
26
|
+
*/
|
|
27
|
+
PushSubscriptionsRemoved: "ddp_push_subscriptions_removed",
|
|
28
|
+
/**
|
|
29
|
+
* Number of outbound activities scheduled for push delivery.
|
|
30
|
+
*/
|
|
31
|
+
PushActivitiesScheduled: "ddp_push_activities_scheduled"
|
|
32
|
+
};
|
|
33
|
+
//# sourceMappingURL=dataspaceDataPlaneMetricIds.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dataspaceDataPlaneMetricIds.js","sourceRoot":"","sources":["../../../../src/models/dataPlane/dataspaceDataPlaneMetricIds.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GAAG;IAC1C;;OAEG;IACH,kBAAkB,EAAE,yBAAyB;IAE7C;;OAEG;IACH,iBAAiB,EAAE,yBAAyB;IAE5C;;OAEG;IACH,mBAAmB,EAAE,2BAA2B;IAEhD;;OAEG;IACH,wBAAwB,EAAE,gCAAgC;IAE1D;;OAEG;IACH,wBAAwB,EAAE,gCAAgC;IAE1D;;OAEG;IACH,uBAAuB,EAAE,+BAA+B;CAC/C,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Metric IDs for the dataspace data plane service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceDataPlaneMetricIds = {\n\t/**\n\t * Number of activities notified.\n\t */\n\tActivitiesNotified: \"ddp_activities_notified\",\n\n\t/**\n\t * Number of data asset queries executed.\n\t */\n\tDataAssetsQueried: \"ddp_data_assets_queried\",\n\n\t/**\n\t * Number of data asset entity retrievals.\n\t */\n\tDataAssetsRetrieved: \"ddp_data_assets_retrieved\",\n\n\t/**\n\t * Number of push subscriptions created.\n\t */\n\tPushSubscriptionsCreated: \"ddp_push_subscriptions_created\",\n\n\t/**\n\t * Number of push subscriptions removed.\n\t */\n\tPushSubscriptionsRemoved: \"ddp_push_subscriptions_removed\",\n\n\t/**\n\t * Number of outbound activities scheduled for push delivery.\n\t */\n\tPushActivitiesScheduled: \"ddp_push_activities_scheduled\"\n} as const;\n\n/**\n * Metric IDs for the dataspace data plane service.\n */\nexport type DataspaceDataPlaneMetricIds =\n\t(typeof DataspaceDataPlaneMetricIds)[keyof typeof DataspaceDataPlaneMetricIds];\n"]}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
// Copyright 2025 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
import { MetricType } from "@twin.org/telemetry-models";
|
|
4
|
+
import { DataspaceDataPlaneMetricIds } from "./dataspaceDataPlaneMetricIds.js";
|
|
5
|
+
/**
|
|
6
|
+
* Metrics registered by the dataspace data plane service.
|
|
7
|
+
*/
|
|
8
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
9
|
+
export const DataspaceDataPlaneMetrics = [
|
|
10
|
+
{
|
|
11
|
+
id: DataspaceDataPlaneMetricIds.ActivitiesNotified,
|
|
12
|
+
label: "Activities notified",
|
|
13
|
+
type: MetricType.Counter
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
id: DataspaceDataPlaneMetricIds.DataAssetsQueried,
|
|
17
|
+
label: "Data assets queried",
|
|
18
|
+
type: MetricType.Counter
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
id: DataspaceDataPlaneMetricIds.DataAssetsRetrieved,
|
|
22
|
+
label: "Data assets retrieved",
|
|
23
|
+
type: MetricType.Counter
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
id: DataspaceDataPlaneMetricIds.PushSubscriptionsCreated,
|
|
27
|
+
label: "Push subscriptions created",
|
|
28
|
+
type: MetricType.Counter
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
id: DataspaceDataPlaneMetricIds.PushSubscriptionsRemoved,
|
|
32
|
+
label: "Push subscriptions removed",
|
|
33
|
+
type: MetricType.Counter
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
id: DataspaceDataPlaneMetricIds.PushActivitiesScheduled,
|
|
37
|
+
label: "Push activities scheduled",
|
|
38
|
+
type: MetricType.Counter
|
|
39
|
+
}
|
|
40
|
+
];
|
|
41
|
+
//# sourceMappingURL=dataspaceDataPlaneMetrics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dataspaceDataPlaneMetrics.js","sourceRoot":"","sources":["../../../../src/models/dataPlane/dataspaceDataPlaneMetrics.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAyB,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAE/E;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,yBAAyB,GAAuB;IAC5D;QACC,EAAE,EAAE,2BAA2B,CAAC,kBAAkB;QAClD,KAAK,EAAE,qBAAqB;QAC5B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,iBAAiB;QACjD,KAAK,EAAE,qBAAqB;QAC5B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,mBAAmB;QACnD,KAAK,EAAE,uBAAuB;QAC9B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,wBAAwB;QACxD,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,wBAAwB;QACxD,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,uBAAuB;QACvD,KAAK,EAAE,2BAA2B;QAClC,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;CACD,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { type ITelemetryMetric, MetricType } from \"@twin.org/telemetry-models\";\nimport { DataspaceDataPlaneMetricIds } from \"./dataspaceDataPlaneMetricIds.js\";\n\n/**\n * Metrics registered by the dataspace data plane service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceDataPlaneMetrics: ITelemetryMetric[] = [\n\t{\n\t\tid: DataspaceDataPlaneMetricIds.ActivitiesNotified,\n\t\tlabel: \"Activities notified\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceDataPlaneMetricIds.DataAssetsQueried,\n\t\tlabel: \"Data assets queried\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceDataPlaneMetricIds.DataAssetsRetrieved,\n\t\tlabel: \"Data assets retrieved\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceDataPlaneMetricIds.PushSubscriptionsCreated,\n\t\tlabel: \"Push subscriptions created\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceDataPlaneMetricIds.PushSubscriptionsRemoved,\n\t\tlabel: \"Push subscriptions removed\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DataspaceDataPlaneMetricIds.PushActivitiesScheduled,\n\t\tlabel: \"Push activities scheduled\",\n\t\ttype: MetricType.Counter\n\t}\n];\n"]}
|
|
@@ -19,8 +19,6 @@ export declare class DataspaceAppDataset {
|
|
|
19
19
|
/**
|
|
20
20
|
* The dataspace app that this dataset belongs to. Matches the app's
|
|
21
21
|
* registered name in `DataspaceAppFactory` (typically the app's URI).
|
|
22
|
-
* Used as the join key when dispatching to an app's optional
|
|
23
|
-
* `datasetsHandled` override.
|
|
24
22
|
*/
|
|
25
23
|
appId: string;
|
|
26
24
|
/**
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
export * from "./entities/dataspaceAppDataset.js";
|
|
2
2
|
export * from "./entities/transferProcess.js";
|
|
3
3
|
export * from "./models/controlPlane/api/ITransferContextResponse.js";
|
|
4
|
+
export * from "./models/controlPlane/dataspaceControlPlaneMetricIds.js";
|
|
5
|
+
export * from "./models/controlPlane/dataspaceControlPlaneMetrics.js";
|
|
4
6
|
export * from "./models/controlPlane/IDataspaceAppDataset.js";
|
|
5
7
|
export * from "./models/controlPlane/IDataspaceControlPlaneComponent.js";
|
|
6
8
|
export * from "./models/controlPlane/IDataspaceControlPlaneResolverComponent.js";
|
|
@@ -9,6 +11,8 @@ export * from "./models/controlPlane/ITransferCallback.js";
|
|
|
9
11
|
export * from "./models/controlPlane/ITransferContext.js";
|
|
10
12
|
export * from "./models/controlPlane/ITransferProcess.js";
|
|
11
13
|
export * from "./models/controlPlane/transferProcessRole.js";
|
|
14
|
+
export * from "./models/dataPlane/dataspaceDataPlaneMetricIds.js";
|
|
15
|
+
export * from "./models/dataPlane/dataspaceDataPlaneMetrics.js";
|
|
12
16
|
export * from "./models/dataPlane/IDataspaceDataPlaneComponent.js";
|
|
13
17
|
export * from "./models/dataspaceContexts.js";
|
|
14
18
|
export * from "./models/dataspaceTransferFormat.js";
|
|
@@ -2,10 +2,7 @@
|
|
|
2
2
|
* Data Asset query for internal service matching of datasets to apps.
|
|
3
3
|
*
|
|
4
4
|
* This interface is used internally by the Dataspace Data Plane service to match
|
|
5
|
-
* datasets with their corresponding apps.
|
|
6
|
-
* to declare which datasets they handle.
|
|
7
|
-
*
|
|
8
|
-
* @see IDataspaceDataPlaneApp.datasetsHandled
|
|
5
|
+
* datasets with their corresponding apps.
|
|
9
6
|
*/
|
|
10
7
|
export interface IDataAssetQuery {
|
|
11
8
|
/**
|
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
import type { IComponent } from "@twin.org/core";
|
|
2
2
|
import type { IJsonLdDocument } from "@twin.org/data-json-ld";
|
|
3
|
-
import type {
|
|
3
|
+
import type { IDataspaceActivity } from "../IDataspaceActivity.js";
|
|
4
4
|
import type { IActivityQuery } from "./IActivityQuery.js";
|
|
5
5
|
import type { IDataRequest } from "./IDataRequest.js";
|
|
6
6
|
import type { IFollowActivity } from "./IFollowActivity.js";
|
|
7
|
-
import type { IUndoActivity } from "./IUndoActivity.js";
|
|
8
|
-
import type { IDataspaceActivity } from "../IDataspaceActivity.js";
|
|
9
7
|
import type { IProcessingGroupOptions } from "./IProcessingGroupOptions.js";
|
|
8
|
+
import type { IUndoActivity } from "./IUndoActivity.js";
|
|
10
9
|
/**
|
|
11
10
|
* Interface describes a Dataspace App.
|
|
12
11
|
*/
|
|
@@ -23,15 +22,6 @@ export interface IDataspaceApp extends IComponent {
|
|
|
23
22
|
* @returns A query that describes the set of activities handled by the App.
|
|
24
23
|
*/
|
|
25
24
|
activitiesHandled(): IActivityQuery[];
|
|
26
|
-
/**
|
|
27
|
-
* Optional override called by the Control Plane when publishing a stored dataset for this app.
|
|
28
|
-
* The Control Plane always calls `populateDefaults` (e.g. `dcterms:publisher`)
|
|
29
|
-
* on every dataset returned here, so apps don't need to populate publisher themselves.
|
|
30
|
-
* @param payload The user-stored dataset payload.
|
|
31
|
-
* @returns One or more datasets to publish to the catalogue. System-stamped
|
|
32
|
-
* fields like `dcterms:publisher` may be omitted — the Control Plane fills them in.
|
|
33
|
-
*/
|
|
34
|
-
datasetsHandled?(payload: IDataspaceProtocolDataset): Promise<IDataspaceProtocolDataset[]>;
|
|
35
25
|
/**
|
|
36
26
|
* The types of queries supported.
|
|
37
27
|
* @returns The types of queries supported by the Dataspace App to retrieve data.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Metric IDs for the dataspace control plane service.
|
|
3
|
+
*/
|
|
4
|
+
export declare const DataspaceControlPlaneMetricIds: {
|
|
5
|
+
/**
|
|
6
|
+
* Number of transfer processes requested.
|
|
7
|
+
*/
|
|
8
|
+
readonly TransfersRequested: "dcp_transfers_requested";
|
|
9
|
+
/**
|
|
10
|
+
* Number of transfer processes prepared by the consumer.
|
|
11
|
+
*/
|
|
12
|
+
readonly TransfersPrepared: "dcp_transfers_prepared";
|
|
13
|
+
/**
|
|
14
|
+
* Number of transfer processes started.
|
|
15
|
+
*/
|
|
16
|
+
readonly TransfersStarted: "dcp_transfers_started";
|
|
17
|
+
/**
|
|
18
|
+
* Number of transfer processes completed.
|
|
19
|
+
*/
|
|
20
|
+
readonly TransfersCompleted: "dcp_transfers_completed";
|
|
21
|
+
/**
|
|
22
|
+
* Number of transfer processes suspended.
|
|
23
|
+
*/
|
|
24
|
+
readonly TransfersSuspended: "dcp_transfers_suspended";
|
|
25
|
+
/**
|
|
26
|
+
* Number of transfer processes terminated.
|
|
27
|
+
*/
|
|
28
|
+
readonly TransfersTerminated: "dcp_transfers_terminated";
|
|
29
|
+
/**
|
|
30
|
+
* Number of contract negotiations initiated.
|
|
31
|
+
*/
|
|
32
|
+
readonly NegotiationsInitiated: "dcp_negotiations_initiated";
|
|
33
|
+
/**
|
|
34
|
+
* Number of app datasets created.
|
|
35
|
+
*/
|
|
36
|
+
readonly AppDatasetsCreated: "dcp_app_datasets_created";
|
|
37
|
+
/**
|
|
38
|
+
* Number of app datasets updated.
|
|
39
|
+
*/
|
|
40
|
+
readonly AppDatasetsUpdated: "dcp_app_datasets_updated";
|
|
41
|
+
/**
|
|
42
|
+
* Number of app datasets deleted.
|
|
43
|
+
*/
|
|
44
|
+
readonly AppDatasetsDeleted: "dcp_app_datasets_deleted";
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* Metric IDs for the dataspace control plane service.
|
|
48
|
+
*/
|
|
49
|
+
export type DataspaceControlPlaneMetricIds = (typeof DataspaceControlPlaneMetricIds)[keyof typeof DataspaceControlPlaneMetricIds];
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Metric IDs for the dataspace data plane service.
|
|
3
|
+
*/
|
|
4
|
+
export declare const DataspaceDataPlaneMetricIds: {
|
|
5
|
+
/**
|
|
6
|
+
* Number of activities notified.
|
|
7
|
+
*/
|
|
8
|
+
readonly ActivitiesNotified: "ddp_activities_notified";
|
|
9
|
+
/**
|
|
10
|
+
* Number of data asset queries executed.
|
|
11
|
+
*/
|
|
12
|
+
readonly DataAssetsQueried: "ddp_data_assets_queried";
|
|
13
|
+
/**
|
|
14
|
+
* Number of data asset entity retrievals.
|
|
15
|
+
*/
|
|
16
|
+
readonly DataAssetsRetrieved: "ddp_data_assets_retrieved";
|
|
17
|
+
/**
|
|
18
|
+
* Number of push subscriptions created.
|
|
19
|
+
*/
|
|
20
|
+
readonly PushSubscriptionsCreated: "ddp_push_subscriptions_created";
|
|
21
|
+
/**
|
|
22
|
+
* Number of push subscriptions removed.
|
|
23
|
+
*/
|
|
24
|
+
readonly PushSubscriptionsRemoved: "ddp_push_subscriptions_removed";
|
|
25
|
+
/**
|
|
26
|
+
* Number of outbound activities scheduled for push delivery.
|
|
27
|
+
*/
|
|
28
|
+
readonly PushActivitiesScheduled: "ddp_push_activities_scheduled";
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Metric IDs for the dataspace data plane service.
|
|
32
|
+
*/
|
|
33
|
+
export type DataspaceDataPlaneMetricIds = (typeof DataspaceDataPlaneMetricIds)[keyof typeof DataspaceDataPlaneMetricIds];
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.49](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.48...dataspace-models-v0.0.3-next.49) (2026-06-19)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* 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))
|
|
9
|
+
* remove datasetsHandled method from apps ([9fdc950](https://github.com/iotaledger/twin-dataspace/commit/9fdc95018d38ab49c4a1094642be2ee83ee0e4cd))
|
|
10
|
+
|
|
3
11
|
## [0.0.3-next.48](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.0.3-next.47...dataspace-models-v0.0.3-next.48) (2026-06-18)
|
|
4
12
|
|
|
5
13
|
|
|
@@ -46,8 +46,6 @@ register datasets without a tenant context.
|
|
|
46
46
|
|
|
47
47
|
The dataspace app that this dataset belongs to. Matches the app's
|
|
48
48
|
registered name in `DataspaceAppFactory` (typically the app's URI).
|
|
49
|
-
Used as the join key when dispatching to an app's optional
|
|
50
|
-
`datasetsHandled` override.
|
|
51
49
|
|
|
52
50
|
***
|
|
53
51
|
|
package/docs/reference/index.md
CHANGED
|
@@ -73,7 +73,9 @@
|
|
|
73
73
|
- [ActivityTaskStatus](type-aliases/ActivityTaskStatus.md)
|
|
74
74
|
- [IDataRequest](type-aliases/IDataRequest.md)
|
|
75
75
|
- [DataRequestType](type-aliases/DataRequestType.md)
|
|
76
|
+
- [DataspaceControlPlaneMetricIds](type-aliases/DataspaceControlPlaneMetricIds.md)
|
|
76
77
|
- [TransferProcessRole](type-aliases/TransferProcessRole.md)
|
|
78
|
+
- [DataspaceDataPlaneMetricIds](type-aliases/DataspaceDataPlaneMetricIds.md)
|
|
77
79
|
- [DataspaceContexts](type-aliases/DataspaceContexts.md)
|
|
78
80
|
- [DataspaceTransferFormat](type-aliases/DataspaceTransferFormat.md)
|
|
79
81
|
- [DataspaceTypes](type-aliases/DataspaceTypes.md)
|
|
@@ -84,7 +86,11 @@
|
|
|
84
86
|
- [ActivityProcessingStatus](variables/ActivityProcessingStatus.md)
|
|
85
87
|
- [ActivityTaskStatus](variables/ActivityTaskStatus.md)
|
|
86
88
|
- [DataRequestType](variables/DataRequestType.md)
|
|
89
|
+
- [DataspaceControlPlaneMetricIds](variables/DataspaceControlPlaneMetricIds.md)
|
|
90
|
+
- [DataspaceControlPlaneMetrics](variables/DataspaceControlPlaneMetrics.md)
|
|
87
91
|
- [TransferProcessRole](variables/TransferProcessRole.md)
|
|
92
|
+
- [DataspaceDataPlaneMetricIds](variables/DataspaceDataPlaneMetricIds.md)
|
|
93
|
+
- [DataspaceDataPlaneMetrics](variables/DataspaceDataPlaneMetrics.md)
|
|
88
94
|
- [DataspaceContexts](variables/DataspaceContexts.md)
|
|
89
95
|
- [DataspaceTransferFormat](variables/DataspaceTransferFormat.md)
|
|
90
96
|
- [DataspaceTypes](variables/DataspaceTypes.md)
|
|
@@ -3,12 +3,7 @@
|
|
|
3
3
|
Data Asset query for internal service matching of datasets to apps.
|
|
4
4
|
|
|
5
5
|
This interface is used internally by the Dataspace Data Plane service to match
|
|
6
|
-
datasets with their corresponding apps.
|
|
7
|
-
to declare which datasets they handle.
|
|
8
|
-
|
|
9
|
-
## See
|
|
10
|
-
|
|
11
|
-
IDataspaceDataPlaneApp.datasetsHandled
|
|
6
|
+
datasets with their corresponding apps.
|
|
12
7
|
|
|
13
8
|
## Properties
|
|
14
9
|
|
|
@@ -36,31 +36,6 @@ A query that describes the set of activities handled by the App.
|
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
39
|
-
### datasetsHandled()? {#datasetshandled}
|
|
40
|
-
|
|
41
|
-
> `optional` **datasetsHandled**(`payload`): `Promise`\<`IDataspaceProtocolDataset`[]\>
|
|
42
|
-
|
|
43
|
-
Optional override called by the Control Plane when publishing a stored dataset for this app.
|
|
44
|
-
The Control Plane always calls `populateDefaults` (e.g. `dcterms:publisher`)
|
|
45
|
-
on every dataset returned here, so apps don't need to populate publisher themselves.
|
|
46
|
-
|
|
47
|
-
#### Parameters
|
|
48
|
-
|
|
49
|
-
##### payload
|
|
50
|
-
|
|
51
|
-
`IDataspaceProtocolDataset`
|
|
52
|
-
|
|
53
|
-
The user-stored dataset payload.
|
|
54
|
-
|
|
55
|
-
#### Returns
|
|
56
|
-
|
|
57
|
-
`Promise`\<`IDataspaceProtocolDataset`[]\>
|
|
58
|
-
|
|
59
|
-
One or more datasets to publish to the catalogue. System-stamped
|
|
60
|
-
fields like `dcterms:publisher` may be omitted — the Control Plane fills them in.
|
|
61
|
-
|
|
62
|
-
***
|
|
63
|
-
|
|
64
39
|
### supportedQueryTypes() {#supportedquerytypes}
|
|
65
40
|
|
|
66
41
|
> **supportedQueryTypes**(): `string`[]
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: DataspaceControlPlaneMetricIds
|
|
2
|
+
|
|
3
|
+
> **DataspaceControlPlaneMetricIds** = *typeof* [`DataspaceControlPlaneMetricIds`](../variables/DataspaceControlPlaneMetricIds.md)\[keyof *typeof* [`DataspaceControlPlaneMetricIds`](../variables/DataspaceControlPlaneMetricIds.md)\]
|
|
4
|
+
|
|
5
|
+
Metric IDs for the dataspace control plane service.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: DataspaceDataPlaneMetricIds
|
|
2
|
+
|
|
3
|
+
> **DataspaceDataPlaneMetricIds** = *typeof* [`DataspaceDataPlaneMetricIds`](../variables/DataspaceDataPlaneMetricIds.md)\[keyof *typeof* [`DataspaceDataPlaneMetricIds`](../variables/DataspaceDataPlaneMetricIds.md)\]
|
|
4
|
+
|
|
5
|
+
Metric IDs for the dataspace data plane service.
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Variable: DataspaceControlPlaneMetricIds
|
|
2
|
+
|
|
3
|
+
> `const` **DataspaceControlPlaneMetricIds**: `object`
|
|
4
|
+
|
|
5
|
+
Metric IDs for the dataspace control plane service.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### TransfersRequested {#transfersrequested}
|
|
10
|
+
|
|
11
|
+
> `readonly` **TransfersRequested**: `"dcp_transfers_requested"` = `"dcp_transfers_requested"`
|
|
12
|
+
|
|
13
|
+
Number of transfer processes requested.
|
|
14
|
+
|
|
15
|
+
### TransfersPrepared {#transfersprepared}
|
|
16
|
+
|
|
17
|
+
> `readonly` **TransfersPrepared**: `"dcp_transfers_prepared"` = `"dcp_transfers_prepared"`
|
|
18
|
+
|
|
19
|
+
Number of transfer processes prepared by the consumer.
|
|
20
|
+
|
|
21
|
+
### TransfersStarted {#transfersstarted}
|
|
22
|
+
|
|
23
|
+
> `readonly` **TransfersStarted**: `"dcp_transfers_started"` = `"dcp_transfers_started"`
|
|
24
|
+
|
|
25
|
+
Number of transfer processes started.
|
|
26
|
+
|
|
27
|
+
### TransfersCompleted {#transferscompleted}
|
|
28
|
+
|
|
29
|
+
> `readonly` **TransfersCompleted**: `"dcp_transfers_completed"` = `"dcp_transfers_completed"`
|
|
30
|
+
|
|
31
|
+
Number of transfer processes completed.
|
|
32
|
+
|
|
33
|
+
### TransfersSuspended {#transferssuspended}
|
|
34
|
+
|
|
35
|
+
> `readonly` **TransfersSuspended**: `"dcp_transfers_suspended"` = `"dcp_transfers_suspended"`
|
|
36
|
+
|
|
37
|
+
Number of transfer processes suspended.
|
|
38
|
+
|
|
39
|
+
### TransfersTerminated {#transfersterminated}
|
|
40
|
+
|
|
41
|
+
> `readonly` **TransfersTerminated**: `"dcp_transfers_terminated"` = `"dcp_transfers_terminated"`
|
|
42
|
+
|
|
43
|
+
Number of transfer processes terminated.
|
|
44
|
+
|
|
45
|
+
### NegotiationsInitiated {#negotiationsinitiated}
|
|
46
|
+
|
|
47
|
+
> `readonly` **NegotiationsInitiated**: `"dcp_negotiations_initiated"` = `"dcp_negotiations_initiated"`
|
|
48
|
+
|
|
49
|
+
Number of contract negotiations initiated.
|
|
50
|
+
|
|
51
|
+
### AppDatasetsCreated {#appdatasetscreated}
|
|
52
|
+
|
|
53
|
+
> `readonly` **AppDatasetsCreated**: `"dcp_app_datasets_created"` = `"dcp_app_datasets_created"`
|
|
54
|
+
|
|
55
|
+
Number of app datasets created.
|
|
56
|
+
|
|
57
|
+
### AppDatasetsUpdated {#appdatasetsupdated}
|
|
58
|
+
|
|
59
|
+
> `readonly` **AppDatasetsUpdated**: `"dcp_app_datasets_updated"` = `"dcp_app_datasets_updated"`
|
|
60
|
+
|
|
61
|
+
Number of app datasets updated.
|
|
62
|
+
|
|
63
|
+
### AppDatasetsDeleted {#appdatasetsdeleted}
|
|
64
|
+
|
|
65
|
+
> `readonly` **AppDatasetsDeleted**: `"dcp_app_datasets_deleted"` = `"dcp_app_datasets_deleted"`
|
|
66
|
+
|
|
67
|
+
Number of app datasets deleted.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Variable: DataspaceDataPlaneMetricIds
|
|
2
|
+
|
|
3
|
+
> `const` **DataspaceDataPlaneMetricIds**: `object`
|
|
4
|
+
|
|
5
|
+
Metric IDs for the dataspace data plane service.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### ActivitiesNotified {#activitiesnotified}
|
|
10
|
+
|
|
11
|
+
> `readonly` **ActivitiesNotified**: `"ddp_activities_notified"` = `"ddp_activities_notified"`
|
|
12
|
+
|
|
13
|
+
Number of activities notified.
|
|
14
|
+
|
|
15
|
+
### DataAssetsQueried {#dataassetsqueried}
|
|
16
|
+
|
|
17
|
+
> `readonly` **DataAssetsQueried**: `"ddp_data_assets_queried"` = `"ddp_data_assets_queried"`
|
|
18
|
+
|
|
19
|
+
Number of data asset queries executed.
|
|
20
|
+
|
|
21
|
+
### DataAssetsRetrieved {#dataassetsretrieved}
|
|
22
|
+
|
|
23
|
+
> `readonly` **DataAssetsRetrieved**: `"ddp_data_assets_retrieved"` = `"ddp_data_assets_retrieved"`
|
|
24
|
+
|
|
25
|
+
Number of data asset entity retrievals.
|
|
26
|
+
|
|
27
|
+
### PushSubscriptionsCreated {#pushsubscriptionscreated}
|
|
28
|
+
|
|
29
|
+
> `readonly` **PushSubscriptionsCreated**: `"ddp_push_subscriptions_created"` = `"ddp_push_subscriptions_created"`
|
|
30
|
+
|
|
31
|
+
Number of push subscriptions created.
|
|
32
|
+
|
|
33
|
+
### PushSubscriptionsRemoved {#pushsubscriptionsremoved}
|
|
34
|
+
|
|
35
|
+
> `readonly` **PushSubscriptionsRemoved**: `"ddp_push_subscriptions_removed"` = `"ddp_push_subscriptions_removed"`
|
|
36
|
+
|
|
37
|
+
Number of push subscriptions removed.
|
|
38
|
+
|
|
39
|
+
### PushActivitiesScheduled {#pushactivitiesscheduled}
|
|
40
|
+
|
|
41
|
+
> `readonly` **PushActivitiesScheduled**: `"ddp_push_activities_scheduled"` = `"ddp_push_activities_scheduled"`
|
|
42
|
+
|
|
43
|
+
Number of outbound activities scheduled for push delivery.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/dataspace-models",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.49",
|
|
4
4
|
"description": "Defines shared entities, interfaces, and data types used by control plane and data plane components.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -24,7 +24,8 @@
|
|
|
24
24
|
"@twin.org/standards-schema-org": "next",
|
|
25
25
|
"@twin.org/standards-w3c-activity-streams": "next",
|
|
26
26
|
"@twin.org/standards-w3c-dcat": "next",
|
|
27
|
-
"@twin.org/standards-w3c-odrl": "next"
|
|
27
|
+
"@twin.org/standards-w3c-odrl": "next",
|
|
28
|
+
"@twin.org/telemetry-models": "next"
|
|
28
29
|
},
|
|
29
30
|
"main": "./dist/es/index.js",
|
|
30
31
|
"types": "./dist/types/index.d.ts",
|