@twin.org/immutable-proof-models 0.9.2-next.4 → 0.9.2-next.5
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/index.js +2 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/immutableProofMetricIds.js +29 -0
- package/dist/es/models/immutableProofMetricIds.js.map +1 -0
- package/dist/es/models/immutableProofMetrics.js +36 -0
- package/dist/es/models/immutableProofMetrics.js.map +1 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/models/immutableProofMetricIds.d.ts +29 -0
- package/dist/types/models/immutableProofMetrics.d.ts +5 -0
- package/docs/changelog.md +7 -0
- package/docs/reference/index.md +3 -0
- package/docs/reference/type-aliases/ImmutableProofMetricIds.md +5 -0
- package/docs/reference/variables/ImmutableProofMetricIds.md +37 -0
- package/docs/reference/variables/ImmutableProofMetrics.md +5 -0
- package/package.json +2 -1
package/dist/es/index.js
CHANGED
|
@@ -16,6 +16,8 @@ export * from "./models/IImmutableProofDataIntegrity.js";
|
|
|
16
16
|
export * from "./models/IImmutableProofVerification.js";
|
|
17
17
|
export * from "./models/immutableProofContexts.js";
|
|
18
18
|
export * from "./models/immutableProofFailure.js";
|
|
19
|
+
export * from "./models/immutableProofMetricIds.js";
|
|
20
|
+
export * from "./models/immutableProofMetrics.js";
|
|
19
21
|
export * from "./models/immutableProofTopics.js";
|
|
20
22
|
export * from "./models/immutableProofTypes.js";
|
|
21
23
|
//# sourceMappingURL=index.js.map
|
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;AACvC,cAAc,wCAAwC,CAAC;AACvD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,0DAA0D,CAAC;AACzE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0DAA0D,CAAC;AACzE,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,0CAA0C,CAAC;AACzD,cAAc,yCAAyC,CAAC;AACxD,cAAc,oCAAoC,CAAC;AACnD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/immutableProofDataTypes.js\";\nexport * from \"./models/api/IImmutableProofCreateRequest.js\";\nexport * from \"./models/api/IImmutableProofGetRequest.js\";\nexport * from \"./models/api/IImmutableProofGetResponse.js\";\nexport * from \"./models/api/IImmutableProofRemoveNotarizationRequest.js\";\nexport * from \"./models/api/IImmutableProofRemoveRequest.js\";\nexport * from \"./models/api/IImmutableProofVerifyRequest.js\";\nexport * from \"./models/api/IImmutableProofVerifyResponse.js\";\nexport * from \"./models/eventBus/IImmutableProofEventBusProofCreated.js\";\nexport * from \"./models/IImmutableProof.js\";\nexport * from \"./models/IImmutableProofComponent.js\";\nexport * from \"./models/IImmutableProofCredential.js\";\nexport * from \"./models/IImmutableProofDataIntegrity.js\";\nexport * from \"./models/IImmutableProofVerification.js\";\nexport * from \"./models/immutableProofContexts.js\";\nexport * from \"./models/immutableProofFailure.js\";\nexport * from \"./models/immutableProofTopics.js\";\nexport * from \"./models/immutableProofTypes.js\";\n"]}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,wCAAwC,CAAC;AACvD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,0DAA0D,CAAC;AACzE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0DAA0D,CAAC;AACzE,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,0CAA0C,CAAC;AACzD,cAAc,yCAAyC,CAAC;AACxD,cAAc,oCAAoC,CAAC;AACnD,cAAc,mCAAmC,CAAC;AAClD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/immutableProofDataTypes.js\";\nexport * from \"./models/api/IImmutableProofCreateRequest.js\";\nexport * from \"./models/api/IImmutableProofGetRequest.js\";\nexport * from \"./models/api/IImmutableProofGetResponse.js\";\nexport * from \"./models/api/IImmutableProofRemoveNotarizationRequest.js\";\nexport * from \"./models/api/IImmutableProofRemoveRequest.js\";\nexport * from \"./models/api/IImmutableProofVerifyRequest.js\";\nexport * from \"./models/api/IImmutableProofVerifyResponse.js\";\nexport * from \"./models/eventBus/IImmutableProofEventBusProofCreated.js\";\nexport * from \"./models/IImmutableProof.js\";\nexport * from \"./models/IImmutableProofComponent.js\";\nexport * from \"./models/IImmutableProofCredential.js\";\nexport * from \"./models/IImmutableProofDataIntegrity.js\";\nexport * from \"./models/IImmutableProofVerification.js\";\nexport * from \"./models/immutableProofContexts.js\";\nexport * from \"./models/immutableProofFailure.js\";\nexport * from \"./models/immutableProofMetricIds.js\";\nexport * from \"./models/immutableProofMetrics.js\";\nexport * from \"./models/immutableProofTopics.js\";\nexport * from \"./models/immutableProofTypes.js\";\n"]}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
// Copyright 2026 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
/**
|
|
4
|
+
* Metric IDs for the immutable proof service.
|
|
5
|
+
*/
|
|
6
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
7
|
+
export const ImmutableProofMetricIds = {
|
|
8
|
+
/**
|
|
9
|
+
* Number of proofs created.
|
|
10
|
+
*/
|
|
11
|
+
ProofsCreated: "ip_proofs_created",
|
|
12
|
+
/**
|
|
13
|
+
* Number of proof verifications succeeded.
|
|
14
|
+
*/
|
|
15
|
+
VerificationsSucceeded: "ip_verifications_succeeded",
|
|
16
|
+
/**
|
|
17
|
+
* Number of proof verifications failed.
|
|
18
|
+
*/
|
|
19
|
+
VerificationsFailed: "ip_verifications_failed",
|
|
20
|
+
/**
|
|
21
|
+
* Number of proofs removed.
|
|
22
|
+
*/
|
|
23
|
+
ProofsRemoved: "ip_proofs_removed",
|
|
24
|
+
/**
|
|
25
|
+
* Number of notarizations removed.
|
|
26
|
+
*/
|
|
27
|
+
NotarizationsRemoved: "ip_notarizations_removed"
|
|
28
|
+
};
|
|
29
|
+
//# sourceMappingURL=immutableProofMetricIds.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"immutableProofMetricIds.js","sourceRoot":"","sources":["../../../src/models/immutableProofMetricIds.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACtC;;OAEG;IACH,aAAa,EAAE,mBAAmB;IAElC;;OAEG;IACH,sBAAsB,EAAE,4BAA4B;IAEpD;;OAEG;IACH,mBAAmB,EAAE,yBAAyB;IAE9C;;OAEG;IACH,aAAa,EAAE,mBAAmB;IAElC;;OAEG;IACH,oBAAoB,EAAE,0BAA0B;CACvC,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Metric IDs for the immutable proof service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofMetricIds = {\n\t/**\n\t * Number of proofs created.\n\t */\n\tProofsCreated: \"ip_proofs_created\",\n\n\t/**\n\t * Number of proof verifications succeeded.\n\t */\n\tVerificationsSucceeded: \"ip_verifications_succeeded\",\n\n\t/**\n\t * Number of proof verifications failed.\n\t */\n\tVerificationsFailed: \"ip_verifications_failed\",\n\n\t/**\n\t * Number of proofs removed.\n\t */\n\tProofsRemoved: \"ip_proofs_removed\",\n\n\t/**\n\t * Number of notarizations removed.\n\t */\n\tNotarizationsRemoved: \"ip_notarizations_removed\"\n} as const;\n\n/**\n * Union type of all immutable proof service metric ID string values.\n */\nexport type ImmutableProofMetricIds =\n\t(typeof ImmutableProofMetricIds)[keyof typeof ImmutableProofMetricIds];\n"]}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
// Copyright 2026 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
import { MetricType } from "@twin.org/telemetry-models";
|
|
4
|
+
import { ImmutableProofMetricIds } from "./immutableProofMetricIds.js";
|
|
5
|
+
/**
|
|
6
|
+
* Metrics registered by the immutable proof service.
|
|
7
|
+
*/
|
|
8
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
9
|
+
export const ImmutableProofMetrics = [
|
|
10
|
+
{
|
|
11
|
+
id: ImmutableProofMetricIds.ProofsCreated,
|
|
12
|
+
label: "Proofs created",
|
|
13
|
+
type: MetricType.Counter
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
id: ImmutableProofMetricIds.VerificationsSucceeded,
|
|
17
|
+
label: "Proof verifications succeeded",
|
|
18
|
+
type: MetricType.Counter
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
id: ImmutableProofMetricIds.VerificationsFailed,
|
|
22
|
+
label: "Proof verifications failed",
|
|
23
|
+
type: MetricType.Counter
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
id: ImmutableProofMetricIds.ProofsRemoved,
|
|
27
|
+
label: "Proofs removed",
|
|
28
|
+
type: MetricType.Counter
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
id: ImmutableProofMetricIds.NotarizationsRemoved,
|
|
32
|
+
label: "Notarizations removed",
|
|
33
|
+
type: MetricType.Counter
|
|
34
|
+
}
|
|
35
|
+
];
|
|
36
|
+
//# sourceMappingURL=immutableProofMetrics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"immutableProofMetrics.js","sourceRoot":"","sources":["../../../src/models/immutableProofMetrics.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAyB,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,qBAAqB,GAAuB;IACxD;QACC,EAAE,EAAE,uBAAuB,CAAC,aAAa;QACzC,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,uBAAuB,CAAC,sBAAsB;QAClD,KAAK,EAAE,+BAA+B;QACtC,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,uBAAuB,CAAC,mBAAmB;QAC/C,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,uBAAuB,CAAC,aAAa;QACzC,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,uBAAuB,CAAC,oBAAoB;QAChD,KAAK,EAAE,uBAAuB;QAC9B,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 { ImmutableProofMetricIds } from \"./immutableProofMetricIds.js\";\n\n/**\n * Metrics registered by the immutable proof service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofMetrics: ITelemetryMetric[] = [\n\t{\n\t\tid: ImmutableProofMetricIds.ProofsCreated,\n\t\tlabel: \"Proofs created\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: ImmutableProofMetricIds.VerificationsSucceeded,\n\t\tlabel: \"Proof verifications succeeded\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: ImmutableProofMetricIds.VerificationsFailed,\n\t\tlabel: \"Proof verifications failed\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: ImmutableProofMetricIds.ProofsRemoved,\n\t\tlabel: \"Proofs removed\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: ImmutableProofMetricIds.NotarizationsRemoved,\n\t\tlabel: \"Notarizations removed\",\n\t\ttype: MetricType.Counter\n\t}\n];\n"]}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -14,5 +14,7 @@ export * from "./models/IImmutableProofDataIntegrity.js";
|
|
|
14
14
|
export * from "./models/IImmutableProofVerification.js";
|
|
15
15
|
export * from "./models/immutableProofContexts.js";
|
|
16
16
|
export * from "./models/immutableProofFailure.js";
|
|
17
|
+
export * from "./models/immutableProofMetricIds.js";
|
|
18
|
+
export * from "./models/immutableProofMetrics.js";
|
|
17
19
|
export * from "./models/immutableProofTopics.js";
|
|
18
20
|
export * from "./models/immutableProofTypes.js";
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Metric IDs for the immutable proof service.
|
|
3
|
+
*/
|
|
4
|
+
export declare const ImmutableProofMetricIds: {
|
|
5
|
+
/**
|
|
6
|
+
* Number of proofs created.
|
|
7
|
+
*/
|
|
8
|
+
readonly ProofsCreated: "ip_proofs_created";
|
|
9
|
+
/**
|
|
10
|
+
* Number of proof verifications succeeded.
|
|
11
|
+
*/
|
|
12
|
+
readonly VerificationsSucceeded: "ip_verifications_succeeded";
|
|
13
|
+
/**
|
|
14
|
+
* Number of proof verifications failed.
|
|
15
|
+
*/
|
|
16
|
+
readonly VerificationsFailed: "ip_verifications_failed";
|
|
17
|
+
/**
|
|
18
|
+
* Number of proofs removed.
|
|
19
|
+
*/
|
|
20
|
+
readonly ProofsRemoved: "ip_proofs_removed";
|
|
21
|
+
/**
|
|
22
|
+
* Number of notarizations removed.
|
|
23
|
+
*/
|
|
24
|
+
readonly NotarizationsRemoved: "ip_notarizations_removed";
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Union type of all immutable proof service metric ID string values.
|
|
28
|
+
*/
|
|
29
|
+
export type ImmutableProofMetricIds = (typeof ImmutableProofMetricIds)[keyof typeof ImmutableProofMetricIds];
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.9.2-next.5](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.9.2-next.4...immutable-proof-models-v0.9.2-next.5) (2026-08-09)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add event-driven telemetry metrics ([#99](https://github.com/iotaledger/twin-immutable-proof/issues/99)) ([9ceb5dc](https://github.com/iotaledger/twin-immutable-proof/commit/9ceb5dcea75dcd239f5c551208c68d756ecf89a2))
|
|
9
|
+
|
|
3
10
|
## [0.9.2-next.4](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.9.2-next.3...immutable-proof-models-v0.9.2-next.4) (2026-08-07)
|
|
4
11
|
|
|
5
12
|
|
package/docs/reference/index.md
CHANGED
|
@@ -24,6 +24,7 @@
|
|
|
24
24
|
|
|
25
25
|
- [ImmutableProofContexts](type-aliases/ImmutableProofContexts.md)
|
|
26
26
|
- [ImmutableProofFailure](type-aliases/ImmutableProofFailure.md)
|
|
27
|
+
- [ImmutableProofMetricIds](type-aliases/ImmutableProofMetricIds.md)
|
|
27
28
|
- [ImmutableProofTopics](type-aliases/ImmutableProofTopics.md)
|
|
28
29
|
- [ImmutableProofTypes](type-aliases/ImmutableProofTypes.md)
|
|
29
30
|
|
|
@@ -31,5 +32,7 @@
|
|
|
31
32
|
|
|
32
33
|
- [ImmutableProofContexts](variables/ImmutableProofContexts.md)
|
|
33
34
|
- [ImmutableProofFailure](variables/ImmutableProofFailure.md)
|
|
35
|
+
- [ImmutableProofMetricIds](variables/ImmutableProofMetricIds.md)
|
|
36
|
+
- [ImmutableProofMetrics](variables/ImmutableProofMetrics.md)
|
|
34
37
|
- [ImmutableProofTopics](variables/ImmutableProofTopics.md)
|
|
35
38
|
- [ImmutableProofTypes](variables/ImmutableProofTypes.md)
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: ImmutableProofMetricIds
|
|
2
|
+
|
|
3
|
+
> **ImmutableProofMetricIds** = *typeof* [`ImmutableProofMetricIds`](../variables/ImmutableProofMetricIds.md)\[keyof *typeof* [`ImmutableProofMetricIds`](../variables/ImmutableProofMetricIds.md)\]
|
|
4
|
+
|
|
5
|
+
Union type of all immutable proof service metric ID string values.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Variable: ImmutableProofMetricIds
|
|
2
|
+
|
|
3
|
+
> `const` **ImmutableProofMetricIds**: `object`
|
|
4
|
+
|
|
5
|
+
Metric IDs for the immutable proof service.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### ProofsCreated {#proofscreated}
|
|
10
|
+
|
|
11
|
+
> `readonly` **ProofsCreated**: `"ip_proofs_created"` = `"ip_proofs_created"`
|
|
12
|
+
|
|
13
|
+
Number of proofs created.
|
|
14
|
+
|
|
15
|
+
### VerificationsSucceeded {#verificationssucceeded}
|
|
16
|
+
|
|
17
|
+
> `readonly` **VerificationsSucceeded**: `"ip_verifications_succeeded"` = `"ip_verifications_succeeded"`
|
|
18
|
+
|
|
19
|
+
Number of proof verifications succeeded.
|
|
20
|
+
|
|
21
|
+
### VerificationsFailed {#verificationsfailed}
|
|
22
|
+
|
|
23
|
+
> `readonly` **VerificationsFailed**: `"ip_verifications_failed"` = `"ip_verifications_failed"`
|
|
24
|
+
|
|
25
|
+
Number of proof verifications failed.
|
|
26
|
+
|
|
27
|
+
### ProofsRemoved {#proofsremoved}
|
|
28
|
+
|
|
29
|
+
> `readonly` **ProofsRemoved**: `"ip_proofs_removed"` = `"ip_proofs_removed"`
|
|
30
|
+
|
|
31
|
+
Number of proofs removed.
|
|
32
|
+
|
|
33
|
+
### NotarizationsRemoved {#notarizationsremoved}
|
|
34
|
+
|
|
35
|
+
> `readonly` **NotarizationsRemoved**: `"ip_notarizations_removed"` = `"ip_notarizations_removed"`
|
|
36
|
+
|
|
37
|
+
Number of notarizations removed.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/immutable-proof-models",
|
|
3
|
-
"version": "0.9.2-next.
|
|
3
|
+
"version": "0.9.2-next.5",
|
|
4
4
|
"description": "Shared model contracts, schema types, and context constants for immutable proof workflows",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
"@twin.org/entity": "next",
|
|
21
21
|
"@twin.org/nameof": "next",
|
|
22
22
|
"@twin.org/standards-w3c-did": "next",
|
|
23
|
+
"@twin.org/telemetry-models": "next",
|
|
23
24
|
"@twin.org/web": "next"
|
|
24
25
|
},
|
|
25
26
|
"main": "./dist/es/index.js",
|