@3sixty/immutable-proof-models 0.0.0-stage → 0.20.0-next.0

package/dist/es/index.js

@@ -0,0 +1,24 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./compiled/validators.js";
+export * from "./dataTypes/immutableProofDataTypes.js";
+export * from "./models/api/IImmutableProofCreateRequest.js";
+export * from "./models/api/IImmutableProofGetRequest.js";
+export * from "./models/api/IImmutableProofGetResponse.js";
+export * from "./models/api/IImmutableProofRemoveNotarizationRequest.js";
+export * from "./models/api/IImmutableProofRemoveRequest.js";
+export * from "./models/api/IImmutableProofVerifyRequest.js";
+export * from "./models/api/IImmutableProofVerifyResponse.js";
+export * from "./models/eventBus/IImmutableProofEventBusProofCreated.js";
+export * from "./models/IImmutableProof.js";
+export * from "./models/IImmutableProofComponent.js";
+export * from "./models/IImmutableProofCredential.js";
+export * from "./models/IImmutableProofDataIntegrity.js";
+export * from "./models/IImmutableProofVerification.js";
+export * from "./models/immutableProofContexts.js";
+export * from "./models/immutableProofFailure.js";
+export * from "./models/immutableProofMetricIds.js";
+export * from "./models/immutableProofMetrics.js";
+export * from "./models/immutableProofTopics.js";
+export * from "./models/immutableProofTypes.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,0BAA0B,CAAC;AACzC,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 \"./compiled/validators.js\";\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"]}

package/dist/es/models/IImmutableProof.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProof.js","sourceRoot":"","sources":["../../../src/models/IImmutableProof.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ImmutableProofContexts } from \"./immutableProofContexts.js\";\nimport type { ImmutableProofTypes } from \"./immutableProofTypes.js\";\n\n/**\n * Interface describing an immutable proof state.\n */\nexport interface IImmutableProof {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\"?: [typeof ImmutableProofContexts.Context, typeof ImmutableProofContexts.ContextCommon];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype?: typeof ImmutableProofTypes.ImmutableProof;\n\n\t/**\n\t * The id of the object associated with the proof.\n\t */\n\tid?: string;\n\n\t/**\n\t * The integrity hash of the object associated with the proof.\n\t * @json-ld namespace:twin-common\n\t */\n\tproofIntegrity: string;\n}\n"]}

package/dist/es/models/IImmutableProofComponent.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofComponent.js","sourceRoot":"","sources":["../../../src/models/IImmutableProofComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { IJsonLdNodeObject } from \"@3sixty/data-json-ld\";\nimport type { IImmutableProofCredential } from \"./IImmutableProofCredential.js\";\nimport type { IImmutableProofVerification } from \"./IImmutableProofVerification.js\";\n\n/**\n * Interface describing an immutable proof contract.\n */\nexport interface IImmutableProofComponent extends IComponent {\n\t/**\n\t * Create a new proof.\n\t * @param document The document to create the proof for.\n\t * @param options Optional settings for the proof.\n\t * @param options.deleteLock An ISO 8601 date-time string specifying when the notarization lock expires; if omitted no lock is applied.\n\t * @returns The id of the new proof.\n\t */\n\tcreate(document: IJsonLdNodeObject, options?: { deleteLock?: string }): Promise<string>;\n\n\t/**\n\t * Get a proof.\n\t * @param id The id of the proof to get.\n\t * @returns The proof.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tget(id: string): Promise<IImmutableProofCredential>;\n\n\t/**\n\t * Verify a proof.\n\t * @param id The id of the proof to verify.\n\t * @returns The result of the verification and any failures.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tverify(id: string): Promise<IImmutableProofVerification>;\n\n\t/**\n\t * Remove the proof and its notarization.\n\t * @param id The id of the proof to remove.\n\t * @returns A promise that resolves when the proof and its notarization have been removed.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tremove(id: string): Promise<void>;\n\n\t/**\n\t * Remove only the notarization for the proof, keeping the proof entity.\n\t * @param id The id of the proof to remove the notarization from.\n\t * @returns A promise that resolves when the notarization has been removed.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tremoveNotarization(id: string): Promise<void>;\n}\n"]}

package/dist/es/models/IImmutableProofCredential.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofCredential.js","sourceRoot":"","sources":["../../../src/models/IImmutableProofCredential.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDidVerifiableCredential, IProof } from \"@3sixty/standards-w3c-did\";\nimport type { IImmutableProofDataIntegrity } from \"./IImmutableProofDataIntegrity.js\";\n\n/**\n * Interface describing an immutable proof credential.\n */\nexport interface IImmutableProofCredential extends Omit<IDidVerifiableCredential, \"proof\"> {\n\t/**\n\t * The proof of the verifiable credential, which includes the data integrity information.\n\t */\n\tproof?: IProof & IImmutableProofDataIntegrity;\n}\n"]}

package/dist/es/models/IImmutableProofDataIntegrity.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IImmutableProofDataIntegrity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofDataIntegrity.js","sourceRoot":"","sources":["../../../src/models/IImmutableProofDataIntegrity.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface describing additional data integrity fields attached.\n */\nexport interface IImmutableProofDataIntegrity {\n\t/**\n\t * The notarization id.\n\t * @json-ld id\n\t */\n\tnotarizationId?: string;\n}\n"]}

package/dist/es/models/IImmutableProofVerification.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofVerification.js","sourceRoot":"","sources":["../../../src/models/IImmutableProofVerification.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ImmutableProofContexts } from \"./immutableProofContexts.js\";\nimport type { ImmutableProofFailure } from \"./immutableProofFailure.js\";\nimport type { ImmutableProofTypes } from \"./immutableProofTypes.js\";\n\n/**\n * Interface describing an immutable proof verification.\n */\nexport interface IImmutableProofVerification {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": typeof ImmutableProofContexts.Context;\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof ImmutableProofTypes.ImmutableProofVerification;\n\n\t/**\n\t * Was the verification successful.\n\t * @json-ld namespace:twin-common\n\t */\n\tverified: boolean;\n\n\t/**\n\t * If the verification was unsuccessful the failure reason.\n\t * @json-ld type:schema:Text\n\t */\n\tfailure?: ImmutableProofFailure;\n}\n"]}

package/dist/es/models/api/IImmutableProofCreateRequest.js

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

package/dist/es/models/api/IImmutableProofCreateRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@3sixty/data-json-ld\";\n\n/**\n * Create a proof.\n */\nexport interface IImmutableProofCreateRequest {\n\t/**\n\t * The parameters from the body.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The document to create the proof for.\n\t\t */\n\t\tdocument: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * Optional settings for the proof.\n\t\t */\n\t\toptions?: {\n\t\t\t/**\n\t\t\t * An ISO 8601 date-time string specifying when the notarization lock expires.\n\t\t\t * If omitted, no deletion lock is applied.\n\t\t\t */\n\t\t\tdeleteLock?: string;\n\t\t};\n\t};\n}\n"]}

package/dist/es/models/api/IImmutableProofGetRequest.js

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

package/dist/es/models/api/IImmutableProofGetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofGetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@3sixty/web\";\n\n/**\n * Get a proof.\n */\nexport interface IImmutableProofGetRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the immutable proof to get.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IImmutableProofGetResponse.js

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

package/dist/es/models/api/IImmutableProofGetResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@3sixty/web\";\nimport type { IImmutableProofCredential } from \"../IImmutableProofCredential.js\";\n\n/**\n * Response to getting an immutable proof.\n */\nexport interface IImmutableProofGetResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The response body.\n\t */\n\tbody: IImmutableProofCredential;\n}\n"]}

package/dist/es/models/api/IImmutableProofRemoveNotarizationRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IImmutableProofRemoveNotarizationRequest.js.map

package/dist/es/models/api/IImmutableProofRemoveNotarizationRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofRemoveNotarizationRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofRemoveNotarizationRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove the notarization for a proof.\n */\nexport interface IImmutableProofRemoveNotarizationRequest {\n\t/**\n\t * The parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the immutable proof to remove the notarization from.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IImmutableProofRemoveRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IImmutableProofRemoveRequest.js.map

package/dist/es/models/api/IImmutableProofRemoveRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove a proof.\n */\nexport interface IImmutableProofRemoveRequest {\n\t/**\n\t * The parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the immutable proof to remove.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IImmutableProofVerifyRequest.js

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

package/dist/es/models/api/IImmutableProofVerifyRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofVerifyRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofVerifyRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@3sixty/web\";\n\n/**\n * Verify a proof.\n */\nexport interface IImmutableProofVerifyRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the immutable proof to verify.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IImmutableProofVerifyResponse.js

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

package/dist/es/models/api/IImmutableProofVerifyResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofVerifyResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IImmutableProofVerifyResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@3sixty/web\";\nimport type { IImmutableProofVerification } from \"../IImmutableProofVerification.js\";\n\n/**\n * Response to verifying an immutable proof.\n */\nexport interface IImmutableProofVerifyResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The response body.\n\t */\n\tbody: IImmutableProofVerification;\n}\n"]}

package/dist/es/models/eventBus/IImmutableProofEventBusProofCreated.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IImmutableProofEventBusProofCreated.js.map

package/dist/es/models/eventBus/IImmutableProofEventBusProofCreated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofEventBusProofCreated.js","sourceRoot":"","sources":["../../../../src/models/eventBus/IImmutableProofEventBusProofCreated.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Event bus payload for proof created.\n */\nexport interface IImmutableProofEventBusProofCreated {\n\t/**\n\t * The id of the proof created.\n\t */\n\tid: string;\n}\n"]}

package/dist/es/models/immutableProofContexts.js

@@ -0,0 +1,33 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of immutable proof data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ImmutableProofContexts = {
+    /**
+     * The canonical RDF namespace URI for Immutable Proof.
+     */
+    Namespace: "https://schema.3sixty.global/immutable-proof/",
+    /**
+     * The value to use in context for Immutable Proof.
+     */
+    Context: "https://schema.3sixty.global/immutable-proof/",
+    /**
+     * The JSON-LD Context URL for Immutable Proof.
+     */
+    JsonLdContext: "https://schema.3sixty.global/immutable-proof/types.jsonld",
+    /**
+     * The canonical RDF namespace URI for TWIN Common.
+     */
+    NamespaceCommon: "https://schema.3sixty.global/common/",
+    /**
+     * The value to use in JSON-LD context for TWIN Common.
+     */
+    ContextCommon: "https://schema.3sixty.global/common/",
+    /**
+     * The JSON-LD Context URL for TWIN Common.
+     */
+    JsonLdContextCommon: "https://schema.3sixty.global/common/types.jsonld"
+};
+//# sourceMappingURL=immutableProofContexts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"immutableProofContexts.js","sourceRoot":"","sources":["../../../src/models/immutableProofContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,+CAA+C;IAE1D;;OAEG;IACH,OAAO,EAAE,+CAA+C;IAExD;;OAEG;IACH,aAAa,EAAE,2DAA2D;IAE1E;;OAEG;IACH,eAAe,EAAE,sCAAsC;IAEvD;;OAEG;IACH,aAAa,EAAE,sCAAsC;IAErD;;OAEG;IACH,mBAAmB,EAAE,kDAAkD;CAC9D,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of immutable proof data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofContexts = {\n\t/**\n\t * The canonical RDF namespace URI for Immutable Proof.\n\t */\n\tNamespace: \"https://schema.3sixty.global/immutable-proof/\",\n\n\t/**\n\t * The value to use in context for Immutable Proof.\n\t */\n\tContext: \"https://schema.3sixty.global/immutable-proof/\",\n\n\t/**\n\t * The JSON-LD Context URL for Immutable Proof.\n\t */\n\tJsonLdContext: \"https://schema.3sixty.global/immutable-proof/types.jsonld\",\n\n\t/**\n\t * The canonical RDF namespace URI for TWIN Common.\n\t */\n\tNamespaceCommon: \"https://schema.3sixty.global/common/\",\n\n\t/**\n\t * The value to use in JSON-LD context for TWIN Common.\n\t */\n\tContextCommon: \"https://schema.3sixty.global/common/\",\n\n\t/**\n\t * The JSON-LD Context URL for TWIN Common.\n\t */\n\tJsonLdContextCommon: \"https://schema.3sixty.global/common/types.jsonld\"\n} as const;\n\n/**\n * The contexts of immutable proof data.\n */\nexport type ImmutableProofContexts =\n\t(typeof ImmutableProofContexts)[keyof typeof ImmutableProofContexts];\n"]}

package/dist/es/models/immutableProofFailure.js

@@ -0,0 +1,25 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The failure reason of the proof.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ImmutableProofFailure = {
+    /**
+     * Proof not yet issued.
+     */
+    NotIssued: "notIssued",
+    /**
+     * Proof missing.
+     */
+    ProofMissing: "proofMissing",
+    /**
+     * Verification failure.
+     */
+    VerificationFailure: "verificationFailure",
+    /**
+     * Revoked.
+     */
+    Revoked: "revoked"
+};
+//# sourceMappingURL=immutableProofFailure.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"immutableProofFailure.js","sourceRoot":"","sources":["../../../src/models/immutableProofFailure.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACpC;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,mBAAmB,EAAE,qBAAqB;IAE1C;;OAEG;IACH,OAAO,EAAE,SAAS;CACT,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The failure reason of the proof.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofFailure = {\n\t/**\n\t * Proof not yet issued.\n\t */\n\tNotIssued: \"notIssued\",\n\n\t/**\n\t * Proof missing.\n\t */\n\tProofMissing: \"proofMissing\",\n\n\t/**\n\t * Verification failure.\n\t */\n\tVerificationFailure: \"verificationFailure\",\n\n\t/**\n\t * Revoked.\n\t */\n\tRevoked: \"revoked\"\n} as const;\n\n/**\n * The failure reason of the proof.\n */\nexport type ImmutableProofFailure =\n\t(typeof ImmutableProofFailure)[keyof typeof ImmutableProofFailure];\n"]}

package/dist/es/models/immutableProofMetricIds.js

@@ -0,0 +1,33 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Metric IDs for the immutable proof service.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ImmutableProofMetricIds = {
+    /**
+     * Number of proofs created.
+     */
+    ProofsCreated: "ip_proofs_created",
+    /**
+     * Number of proof verifications succeeded.
+     */
+    VerificationsSucceeded: "ip_verifications_succeeded",
+    /**
+     * Number of proof verifications failed.
+     */
+    VerificationsFailed: "ip_verifications_failed",
+    /**
+     * Number of proofs removed.
+     */
+    ProofsRemoved: "ip_proofs_removed",
+    /**
+     * Number of notarizations removed.
+     */
+    NotarizationsRemoved: "ip_notarizations_removed",
+    /**
+     * Time in milliseconds from a proof being requested to its notarization completing.
+     */
+    ProofCompletionLag: "ip_proof_completion_lag"
+};
+//# sourceMappingURL=immutableProofMetricIds.js.map

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

@@ -0,0 +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;IAEhD;;OAEG;IACH,kBAAkB,EAAE,yBAAyB;CACpC,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\n\t/**\n\t * Time in milliseconds from a proof being requested to its notarization completing.\n\t */\n\tProofCompletionLag: \"ip_proof_completion_lag\"\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"]}

package/dist/es/models/immutableProofMetrics.js

@@ -0,0 +1,42 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { MetricType } from "@3sixty/telemetry-models";
+import { ImmutableProofMetricIds } from "./immutableProofMetricIds.js";
+/**
+ * Metrics registered by the immutable proof service.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ImmutableProofMetrics = [
+    {
+        id: ImmutableProofMetricIds.ProofsCreated,
+        label: "Proofs created",
+        type: MetricType.Counter
+    },
+    {
+        id: ImmutableProofMetricIds.VerificationsSucceeded,
+        label: "Proof verifications succeeded",
+        type: MetricType.Counter
+    },
+    {
+        id: ImmutableProofMetricIds.VerificationsFailed,
+        label: "Proof verifications failed",
+        type: MetricType.Counter
+    },
+    {
+        id: ImmutableProofMetricIds.ProofsRemoved,
+        label: "Proofs removed",
+        type: MetricType.Counter
+    },
+    {
+        id: ImmutableProofMetricIds.NotarizationsRemoved,
+        label: "Notarizations removed",
+        type: MetricType.Counter
+    },
+    {
+        id: ImmutableProofMetricIds.ProofCompletionLag,
+        label: "Proof completion lag",
+        type: MetricType.Gauge,
+        unit: "ms"
+    }
+];
+//# sourceMappingURL=immutableProofMetrics.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"immutableProofMetrics.js","sourceRoot":"","sources":["../../../src/models/immutableProofMetrics.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAyB,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC7E,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;IACD;QACC,EAAE,EAAE,uBAAuB,CAAC,kBAAkB;QAC9C,KAAK,EAAE,sBAAsB;QAC7B,IAAI,EAAE,UAAU,CAAC,KAAK;QACtB,IAAI,EAAE,IAAI;KACV;CACD,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { type ITelemetryMetric, MetricType } from \"@3sixty/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\t{\n\t\tid: ImmutableProofMetricIds.ProofCompletionLag,\n\t\tlabel: \"Proof completion lag\",\n\t\ttype: MetricType.Gauge,\n\t\tunit: \"ms\"\n\t}\n];\n"]}

package/dist/es/models/immutableProofTopics.js

@@ -0,0 +1,13 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The topics for immutable proof event bus notifications.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ImmutableProofTopics = {
+    /**
+     * A proof was created.
+     */
+    ProofCreated: "immutable-proof:proof-created"
+};
+//# sourceMappingURL=immutableProofTopics.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"immutableProofTopics.js","sourceRoot":"","sources":["../../../src/models/immutableProofTopics.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,oBAAoB,GAAG;IACnC;;OAEG;IACH,YAAY,EAAE,+BAA+B;CACpC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The topics for immutable proof event bus notifications.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofTopics = {\n\t/**\n\t * A proof was created.\n\t */\n\tProofCreated: \"immutable-proof:proof-created\"\n} as const;\n\n/**\n * The topics for immutable proof event bus notifications.\n */\nexport type ImmutableProofTopics = (typeof ImmutableProofTopics)[keyof typeof ImmutableProofTopics];\n"]}

package/dist/es/models/immutableProofTypes.js

@@ -0,0 +1,21 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of immutable proof data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ImmutableProofTypes = {
+    /**
+     * Represents Immutable Proof.
+     */
+    ImmutableProof: "ImmutableProof",
+    /**
+     * Represents Immutable Proof Verification.
+     */
+    ImmutableProofVerification: "ImmutableProofVerification",
+    /**
+     * Represents Immutable Proof Failure.
+     */
+    ImmutableProofFailure: "ImmutableProofFailure"
+};
+//# sourceMappingURL=immutableProofTypes.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"immutableProofTypes.js","sourceRoot":"","sources":["../../../src/models/immutableProofTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC;;OAEG;IACH,cAAc,EAAE,gBAAgB;IAEhC;;OAEG;IACH,0BAA0B,EAAE,4BAA4B;IAExD;;OAEG;IACH,qBAAqB,EAAE,uBAAuB;CACrC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of immutable proof data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ImmutableProofTypes = {\n\t/**\n\t * Represents Immutable Proof.\n\t */\n\tImmutableProof: \"ImmutableProof\",\n\n\t/**\n\t * Represents Immutable Proof Verification.\n\t */\n\tImmutableProofVerification: \"ImmutableProofVerification\",\n\n\t/**\n\t * Represents Immutable Proof Failure.\n\t */\n\tImmutableProofFailure: \"ImmutableProofFailure\"\n} as const;\n\n/**\n * The types of immutable proof data.\n */\nexport type ImmutableProofTypes = (typeof ImmutableProofTypes)[keyof typeof ImmutableProofTypes];\n"]}

package/dist/es/schemas/ImmutableProof.json

@@ -0,0 +1,39 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.3sixty.global/immutable-proof/ImmutableProof",
+    "title": "ImmutableProof",
+    "description": "Interface describing an immutable proof state.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "type": "array",
+            "prefixItems": [
+                {
+                    "const": "https://schema.3sixty.global/immutable-proof/"
+                },
+                {
+                    "const": "https://schema.3sixty.global/common/"
+                }
+            ],
+            "items": false,
+            "minItems": 2,
+            "maxItems": 2,
+            "description": "JSON-LD Context."
+        },
+        "type": {
+            "const": "ImmutableProof",
+            "description": "JSON-LD Type."
+        },
+        "id": {
+            "type": "string",
+            "description": "The id of the object associated with the proof."
+        },
+        "proofIntegrity": {
+            "type": "string",
+            "description": "The integrity hash of the object associated with the proof."
+        }
+    },
+    "required": [
+        "proofIntegrity"
+    ]
+}

package/dist/es/schemas/ImmutableProofCredential.json

@@ -0,0 +1,25 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.3sixty.global/immutable-proof/ImmutableProofCredential",
+    "title": "ImmutableProofCredential",
+    "description": "Interface describing an immutable proof credential.",
+    "type": "object",
+    "properties": {
+        "proof": {
+            "allOf": [
+                {
+                    "$ref": "https://schema.3sixty.global/w3c-did/Proof"
+                },
+                {
+                    "$ref": "https://schema.3sixty.global/immutable-proof/ImmutableProofDataIntegrity"
+                }
+            ],
+            "description": "The proof of the verifiable credential, which includes the data integrity information."
+        }
+    },
+    "allOf": [
+        {
+            "$ref": "https://schema.3sixty.global/w3c-did/DidVerifiableCredential"
+        }
+    ]
+}

package/dist/es/schemas/ImmutableProofDataIntegrity.json

@@ -0,0 +1,13 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.3sixty.global/immutable-proof/ImmutableProofDataIntegrity",
+    "title": "ImmutableProofDataIntegrity",
+    "description": "Interface describing additional data integrity fields attached.",
+    "type": "object",
+    "properties": {
+        "notarizationId": {
+            "type": "string",
+            "description": "The notarization id."
+        }
+    }
+}

package/dist/es/schemas/ImmutableProofFailure.json

@@ -0,0 +1,24 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.3sixty.global/immutable-proof/ImmutableProofFailure",
+    "title": "ImmutableProofFailure",
+    "description": "The failure reason of the proof.",
+    "anyOf": [
+        {
+            "const": "notIssued",
+            "description": "Proof not yet issued."
+        },
+        {
+            "const": "proofMissing",
+            "description": "Proof missing."
+        },
+        {
+            "const": "verificationFailure",
+            "description": "Verification failure."
+        },
+        {
+            "const": "revoked",
+            "description": "Revoked."
+        }
+    ]
+}

package/dist/es/schemas/ImmutableProofVerification.json

@@ -0,0 +1,30 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.3sixty.global/immutable-proof/ImmutableProofVerification",
+    "title": "ImmutableProofVerification",
+    "description": "Interface describing an immutable proof verification.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "const": "https://schema.3sixty.global/immutable-proof/",
+            "description": "JSON-LD Context."
+        },
+        "type": {
+            "const": "ImmutableProofVerification",
+            "description": "JSON-LD Type."
+        },
+        "verified": {
+            "type": "boolean",
+            "description": "Was the verification successful."
+        },
+        "failure": {
+            "$ref": "https://schema.3sixty.global/immutable-proof/ImmutableProofFailure",
+            "description": "If the verification was unsuccessful the failure reason."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "verified"
+    ]
+}

package/dist/types/compiled/validators.d.ts

@@ -0,0 +1,21 @@
+import type { ICompiledValidator } from "@3sixty/data-core";
+/**
+ * Compiled validator for the ImmutableProof schema.
+ */
+export declare const CompiledImmutableProof: ICompiledValidator;
+/**
+ * Compiled validator for the ImmutableProofCredential schema.
+ */
+export declare const CompiledImmutableProofCredential: ICompiledValidator;
+/**
+ * Compiled validator for the ImmutableProofDataIntegrity schema.
+ */
+export declare const CompiledImmutableProofDataIntegrity: ICompiledValidator;
+/**
+ * Compiled validator for the ImmutableProofVerification schema.
+ */
+export declare const CompiledImmutableProofVerification: ICompiledValidator;
+/**
+ * Compiled validator for the ImmutableProofFailure schema.
+ */
+export declare const CompiledImmutableProofFailure: ICompiledValidator;

package/dist/types/dataTypes/immutableProofDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all the data types for immutable proof.
+ */
+export declare class ImmutableProofDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,21 @@
+export * from "./compiled/validators.js";
+export * from "./dataTypes/immutableProofDataTypes.js";
+export * from "./models/api/IImmutableProofCreateRequest.js";
+export * from "./models/api/IImmutableProofGetRequest.js";
+export * from "./models/api/IImmutableProofGetResponse.js";
+export * from "./models/api/IImmutableProofRemoveNotarizationRequest.js";
+export * from "./models/api/IImmutableProofRemoveRequest.js";
+export * from "./models/api/IImmutableProofVerifyRequest.js";
+export * from "./models/api/IImmutableProofVerifyResponse.js";
+export * from "./models/eventBus/IImmutableProofEventBusProofCreated.js";
+export * from "./models/IImmutableProof.js";
+export * from "./models/IImmutableProofComponent.js";
+export * from "./models/IImmutableProofCredential.js";
+export * from "./models/IImmutableProofDataIntegrity.js";
+export * from "./models/IImmutableProofVerification.js";
+export * from "./models/immutableProofContexts.js";
+export * from "./models/immutableProofFailure.js";
+export * from "./models/immutableProofMetricIds.js";
+export * from "./models/immutableProofMetrics.js";
+export * from "./models/immutableProofTopics.js";
+export * from "./models/immutableProofTypes.js";

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

@@ -0,0 +1,24 @@
+import type { ImmutableProofContexts } from "./immutableProofContexts.js";
+import type { ImmutableProofTypes } from "./immutableProofTypes.js";
+/**
+ * Interface describing an immutable proof state.
+ */
+export interface IImmutableProof {
+    /**
+     * JSON-LD Context.
+     */
+    "@context"?: [typeof ImmutableProofContexts.Context, typeof ImmutableProofContexts.ContextCommon];
+    /**
+     * JSON-LD Type.
+     */
+    type?: typeof ImmutableProofTypes.ImmutableProof;
+    /**
+     * The id of the object associated with the proof.
+     */
+    id?: string;
+    /**
+     * The integrity hash of the object associated with the proof.
+     * @json-ld namespace:twin-common
+     */
+    proofIntegrity: string;
+}