@twin.org/document-management-models 0.0.3-next.13 → 0.0.3-next.15

package/dist/es/index.js

@@ -16,4 +16,6 @@ export * from "./models/IDocument.js";
 export * from "./models/IDocumentAttestation.js";
 export * from "./models/IDocumentList.js";
 export * from "./models/IDocumentManagementComponent.js";
+export * from "./models/documentManagementMetricIds.js";
+export * from "./models/documentManagementMetrics.js";
 //# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,4CAA4C,CAAC;AAC3D,cAAc,kDAAkD,CAAC;AACjE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,iDAAiD,CAAC;AAChE,cAAc,kDAAkD,CAAC;AACjE,cAAc,kDAAkD,CAAC;AACjE,cAAc,kDAAkD,CAAC;AACjE,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0CAA0C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/documentManagementDataTypes.js\";\nexport * from \"./models/api/IDocumentManagementCreateRequest.js\";\nexport * from \"./models/api/IDocumentManagementGetRequest.js\";\nexport * from \"./models/api/IDocumentManagementGetResponse.js\";\nexport * from \"./models/api/IDocumentManagementGetRevisionRequest.js\";\nexport * from \"./models/api/IDocumentManagementGetRevisionResponse.js\";\nexport * from \"./models/api/IDocumentManagementQueryRequest.js\";\nexport * from \"./models/api/IDocumentManagementQueryResponse.js\";\nexport * from \"./models/api/IDocumentManagementRemoveRequest.js\";\nexport * from \"./models/api/IDocumentManagementUpdateRequest.js\";\nexport * from \"./models/documentContexts.js\";\nexport * from \"./models/documentTypes.js\";\nexport * from \"./models/IDocument.js\";\nexport * from \"./models/IDocumentAttestation.js\";\nexport * from \"./models/IDocumentList.js\";\nexport * from \"./models/IDocumentManagementComponent.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,4CAA4C,CAAC;AAC3D,cAAc,kDAAkD,CAAC;AACjE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,iDAAiD,CAAC;AAChE,cAAc,kDAAkD,CAAC;AACjE,cAAc,kDAAkD,CAAC;AACjE,cAAc,kDAAkD,CAAC;AACjE,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0CAA0C,CAAC;AACzD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/documentManagementDataTypes.js\";\nexport * from \"./models/api/IDocumentManagementCreateRequest.js\";\nexport * from \"./models/api/IDocumentManagementGetRequest.js\";\nexport * from \"./models/api/IDocumentManagementGetResponse.js\";\nexport * from \"./models/api/IDocumentManagementGetRevisionRequest.js\";\nexport * from \"./models/api/IDocumentManagementGetRevisionResponse.js\";\nexport * from \"./models/api/IDocumentManagementQueryRequest.js\";\nexport * from \"./models/api/IDocumentManagementQueryResponse.js\";\nexport * from \"./models/api/IDocumentManagementRemoveRequest.js\";\nexport * from \"./models/api/IDocumentManagementUpdateRequest.js\";\nexport * from \"./models/documentContexts.js\";\nexport * from \"./models/documentTypes.js\";\nexport * from \"./models/IDocument.js\";\nexport * from \"./models/IDocumentAttestation.js\";\nexport * from \"./models/IDocumentList.js\";\nexport * from \"./models/IDocumentManagementComponent.js\";\nexport * from \"./models/documentManagementMetricIds.js\";\nexport * from \"./models/documentManagementMetrics.js\";\n"]}

package/dist/es/models/documentManagementMetricIds.js

@@ -0,0 +1,29 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Metric IDs for the document management service.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const DocumentManagementMetricIds = {
+    /**
+     * Number of documents created.
+     */
+    DocumentsCreated: "dm_documents_created",
+    /**
+     * Number of documents updated.
+     */
+    DocumentsUpdated: "dm_documents_updated",
+    /**
+     * Number of document revisions created.
+     */
+    RevisionsCreated: "dm_revisions_created",
+    /**
+     * Number of document revisions removed.
+     */
+    RevisionsRemoved: "dm_revisions_removed",
+    /**
+     * Number of document attestations created.
+     */
+    AttestationsCreated: "dm_attestations_created"
+};
+//# sourceMappingURL=documentManagementMetricIds.js.map

package/dist/es/models/documentManagementMetricIds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentManagementMetricIds.js","sourceRoot":"","sources":["../../../src/models/documentManagementMetricIds.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GAAG;IAC1C;;OAEG;IACH,gBAAgB,EAAE,sBAAsB;IACxC;;OAEG;IACH,gBAAgB,EAAE,sBAAsB;IACxC;;OAEG;IACH,gBAAgB,EAAE,sBAAsB;IACxC;;OAEG;IACH,gBAAgB,EAAE,sBAAsB;IACxC;;OAEG;IACH,mBAAmB,EAAE,yBAAyB;CACrC,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Metric IDs for the document management service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DocumentManagementMetricIds = {\n\t/**\n\t * Number of documents created.\n\t */\n\tDocumentsCreated: \"dm_documents_created\",\n\t/**\n\t * Number of documents updated.\n\t */\n\tDocumentsUpdated: \"dm_documents_updated\",\n\t/**\n\t * Number of document revisions created.\n\t */\n\tRevisionsCreated: \"dm_revisions_created\",\n\t/**\n\t * Number of document revisions removed.\n\t */\n\tRevisionsRemoved: \"dm_revisions_removed\",\n\t/**\n\t * Number of document attestations created.\n\t */\n\tAttestationsCreated: \"dm_attestations_created\"\n} as const;\n\n/**\n * Metric IDs for the document management service.\n */\nexport type DocumentManagementMetricIds =\n\t(typeof DocumentManagementMetricIds)[keyof typeof DocumentManagementMetricIds];\n"]}

package/dist/es/models/documentManagementMetrics.js

@@ -0,0 +1,36 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { MetricType } from "@twin.org/telemetry-models";
+import { DocumentManagementMetricIds } from "./documentManagementMetricIds.js";
+/**
+ * Metrics registered by the document management service.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const DocumentManagementMetrics = [
+    {
+        id: DocumentManagementMetricIds.DocumentsCreated,
+        label: "Documents created",
+        type: MetricType.Counter
+    },
+    {
+        id: DocumentManagementMetricIds.DocumentsUpdated,
+        label: "Documents updated",
+        type: MetricType.Counter
+    },
+    {
+        id: DocumentManagementMetricIds.RevisionsCreated,
+        label: "Document revisions created",
+        type: MetricType.Counter
+    },
+    {
+        id: DocumentManagementMetricIds.RevisionsRemoved,
+        label: "Document revisions removed",
+        type: MetricType.Counter
+    },
+    {
+        id: DocumentManagementMetricIds.AttestationsCreated,
+        label: "Document attestations created",
+        type: MetricType.Counter
+    }
+];
+//# sourceMappingURL=documentManagementMetrics.js.map

package/dist/es/models/documentManagementMetrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentManagementMetrics.js","sourceRoot":"","sources":["../../../src/models/documentManagementMetrics.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,gBAAgB;QAChD,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,gBAAgB;QAChD,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,gBAAgB;QAChD,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,gBAAgB;QAChD,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,mBAAmB;QACnD,KAAK,EAAE,+BAA+B;QACtC,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;CACD,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { type ITelemetryMetric, MetricType } from \"@twin.org/telemetry-models\";\nimport { DocumentManagementMetricIds } from \"./documentManagementMetricIds.js\";\n\n/**\n * Metrics registered by the document management service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DocumentManagementMetrics: ITelemetryMetric[] = [\n\t{\n\t\tid: DocumentManagementMetricIds.DocumentsCreated,\n\t\tlabel: \"Documents created\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DocumentManagementMetricIds.DocumentsUpdated,\n\t\tlabel: \"Documents updated\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DocumentManagementMetricIds.RevisionsCreated,\n\t\tlabel: \"Document revisions created\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DocumentManagementMetricIds.RevisionsRemoved,\n\t\tlabel: \"Document revisions removed\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: DocumentManagementMetricIds.AttestationsCreated,\n\t\tlabel: \"Document attestations created\",\n\t\ttype: MetricType.Counter\n\t}\n];\n"]}

package/dist/types/index.d.ts

@@ -14,3 +14,5 @@ export * from "./models/IDocument.js";
 export * from "./models/IDocumentAttestation.js";
 export * from "./models/IDocumentList.js";
 export * from "./models/IDocumentManagementComponent.js";
+export * from "./models/documentManagementMetricIds.js";
+export * from "./models/documentManagementMetrics.js";

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

@@ -0,0 +1,29 @@
+/**
+ * Metric IDs for the document management service.
+ */
+export declare const DocumentManagementMetricIds: {
+    /**
+     * Number of documents created.
+     */
+    readonly DocumentsCreated: "dm_documents_created";
+    /**
+     * Number of documents updated.
+     */
+    readonly DocumentsUpdated: "dm_documents_updated";
+    /**
+     * Number of document revisions created.
+     */
+    readonly RevisionsCreated: "dm_revisions_created";
+    /**
+     * Number of document revisions removed.
+     */
+    readonly RevisionsRemoved: "dm_revisions_removed";
+    /**
+     * Number of document attestations created.
+     */
+    readonly AttestationsCreated: "dm_attestations_created";
+};
+/**
+ * Metric IDs for the document management service.
+ */
+export type DocumentManagementMetricIds = (typeof DocumentManagementMetricIds)[keyof typeof DocumentManagementMetricIds];

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

@@ -0,0 +1,5 @@
+import { type ITelemetryMetric } from "@twin.org/telemetry-models";
+/**
+ * Metrics registered by the document management service.
+ */
+export declare const DocumentManagementMetrics: ITelemetryMetric[];

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.0.3-next.15](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.14...document-management-models-v0.0.3-next.15) (2026-05-22)
+
+
+### Features
+
+* add event-driven telemetry metrics ([#46](https://github.com/iotaledger/twin-document-management/issues/46)) ([2cc4933](https://github.com/iotaledger/twin-document-management/commit/2cc49338a05972279ee8e68027506a796e96766e))
+
+## [0.0.3-next.14](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.13...document-management-models-v0.0.3-next.14) (2026-05-20)
+
+
+### Miscellaneous Chores
+
+* **document-management-models:** Synchronize repo versions
+
 ## [0.0.3-next.13](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.12...document-management-models-v0.0.3-next.13) (2026-05-12)
 
 

package/docs/reference/index.md

@@ -23,9 +23,12 @@
 ## Type Aliases
 
 - [DocumentContexts](type-aliases/DocumentContexts.md)
+- [DocumentManagementMetricIds](type-aliases/DocumentManagementMetricIds.md)
 - [DocumentTypes](type-aliases/DocumentTypes.md)
 
 ## Variables
 
 - [DocumentContexts](variables/DocumentContexts.md)
+- [DocumentManagementMetricIds](variables/DocumentManagementMetricIds.md)
+- [DocumentManagementMetrics](variables/DocumentManagementMetrics.md)
 - [DocumentTypes](variables/DocumentTypes.md)

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

@@ -0,0 +1,5 @@
+# Type Alias: DocumentManagementMetricIds
+
+> **DocumentManagementMetricIds** = *typeof* [`DocumentManagementMetricIds`](../variables/DocumentManagementMetricIds.md)\[keyof *typeof* [`DocumentManagementMetricIds`](../variables/DocumentManagementMetricIds.md)\]
+
+Metric IDs for the document management service.

package/docs/reference/variables/DocumentManagementMetricIds.md

@@ -0,0 +1,37 @@
+# Variable: DocumentManagementMetricIds
+
+> `const` **DocumentManagementMetricIds**: `object`
+
+Metric IDs for the document management service.
+
+## Type Declaration
+
+### DocumentsCreated {#documentscreated}
+
+> `readonly` **DocumentsCreated**: `"dm_documents_created"` = `"dm_documents_created"`
+
+Number of documents created.
+
+### DocumentsUpdated {#documentsupdated}
+
+> `readonly` **DocumentsUpdated**: `"dm_documents_updated"` = `"dm_documents_updated"`
+
+Number of documents updated.
+
+### RevisionsCreated {#revisionscreated}
+
+> `readonly` **RevisionsCreated**: `"dm_revisions_created"` = `"dm_revisions_created"`
+
+Number of document revisions created.
+
+### RevisionsRemoved {#revisionsremoved}
+
+> `readonly` **RevisionsRemoved**: `"dm_revisions_removed"` = `"dm_revisions_removed"`
+
+Number of document revisions removed.
+
+### AttestationsCreated {#attestationscreated}
+
+> `readonly` **AttestationsCreated**: `"dm_attestations_created"` = `"dm_attestations_created"`
+
+Number of document attestations created.

package/docs/reference/variables/DocumentManagementMetrics.md

@@ -0,0 +1,5 @@
+# Variable: DocumentManagementMetrics
+
+> `const` **DocumentManagementMetrics**: `ITelemetryMetric`[]
+
+Metrics registered by the document management service.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.3-next.13",
+	"version": "0.0.3-next.15",
 	"description": "Shared data models, schemas, and context definitions for document lifecycle records.",
 	"repository": {
 		"type": "git",
@@ -22,7 +22,8 @@
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-schema-org": "next",
-		"@twin.org/standards-unece": "next"
+		"@twin.org/standards-unece": "next",
+		"@twin.org/telemetry-models": "next"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",