@twin.org/immutable-proof-models 0.0.3-next.9 → 0.9.0-next.1

package/docs/reference/interfaces/IImmutableProofGetRequest.md

@@ -4,9 +4,9 @@ Get a proof.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IImmutableProofGetResponse.md

@@ -4,9 +4,9 @@ Response to getting an immutable proof.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,8 +16,8 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### body
+### body {#body}
 
-> **body**: `IDidVerifiableCredential`
+> **body**: [`IImmutableProofCredential`](IImmutableProofCredential.md)
 
 The response body.

package/docs/reference/interfaces/IImmutableProofRemoveNotarizationRequest.md

@@ -0,0 +1,17 @@
+# Interface: IImmutableProofRemoveNotarizationRequest
+
+Remove the notarization for a proof.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the immutable proof to remove the notarization from.

package/docs/reference/interfaces/IImmutableProofRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IImmutableProofRemoveRequest
+
+Remove a proof.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the immutable proof to remove.

package/docs/reference/interfaces/IImmutableProofVerification.md

@@ -4,7 +4,7 @@ Interface describing an immutable proof verification.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: `"https://schema.twindev.org/immutable-proof/"`
 
@@ -12,7 +12,7 @@ JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"ImmutableProofVerification"`
 
@@ -20,18 +20,16 @@ JSON-LD Type.
 
 ***
 
-### verified
+### verified {#verified}
 
 > **verified**: `boolean`
 
 Was the verification successful.
-json-ld namespace:twin-common
 
 ***
 
-### failure?
+### failure? {#failure}
 
-> `optional` **failure**: [`ImmutableProofFailure`](../type-aliases/ImmutableProofFailure.md)
+> `optional` **failure?**: [`ImmutableProofFailure`](../type-aliases/ImmutableProofFailure.md)
 
 If the verification was unsuccessful the failure reason.
-json-ld type:schema:Text

package/docs/reference/interfaces/IImmutableProofVerifyRequest.md

@@ -4,9 +4,9 @@ Verify a proof.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IImmutableProofVerifyResponse.md

@@ -4,9 +4,9 @@ Response to verifying an immutable proof.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IImmutableProofVerification`](IImmutableProofVerification.md)
 

package/docs/reference/variables/ImmutableProofContexts.md

@@ -6,37 +6,37 @@ The contexts of immutable proof data.
 
 ## Type Declaration
 
-### Namespace
+### Namespace {#namespace}
 
 > `readonly` **Namespace**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
 
 The canonical RDF namespace URI for Immutable Proof.
 
-### Context
+### Context {#context}
 
 > `readonly` **Context**: `"https://schema.twindev.org/immutable-proof/"` = `"https://schema.twindev.org/immutable-proof/"`
 
 The value to use in context for Immutable Proof.
 
-### JsonLdContext
+### JsonLdContext {#jsonldcontext}
 
 > `readonly` **JsonLdContext**: `"https://schema.twindev.org/immutable-proof/types.jsonld"` = `"https://schema.twindev.org/immutable-proof/types.jsonld"`
 
 The JSON-LD Context URL for Immutable Proof.
 
-### NamespaceCommon
+### NamespaceCommon {#namespacecommon}
 
 > `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
 The canonical RDF namespace URI for TWIN Common.
 
-### ContextCommon
+### ContextCommon {#contextcommon}
 
 > `readonly` **ContextCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
 The value to use in JSON-LD context for TWIN Common.
 
-### JsonLdContextCommon
+### JsonLdContextCommon {#jsonldcontextcommon}
 
 > `readonly` **JsonLdContextCommon**: `"https://schema.twindev.org/common/types.jsonld"` = `"https://schema.twindev.org/common/types.jsonld"`
 

package/docs/reference/variables/ImmutableProofFailure.md

@@ -6,25 +6,25 @@ The failure reason of the proof.
 
 ## Type Declaration
 
-### NotIssued
+### NotIssued {#notissued}
 
 > `readonly` **NotIssued**: `"notIssued"` = `"notIssued"`
 
 Proof not yet issued.
 
-### ProofMissing
+### ProofMissing {#proofmissing}
 
 > `readonly` **ProofMissing**: `"proofMissing"` = `"proofMissing"`
 
 Proof missing.
 
-### VerificationFailure
+### VerificationFailure {#verificationfailure}
 
 > `readonly` **VerificationFailure**: `"verificationFailure"` = `"verificationFailure"`
 
 Verification failure.
 
-### Revoked
+### Revoked {#revoked}
 
 > `readonly` **Revoked**: `"revoked"` = `"revoked"`
 

package/docs/reference/variables/ImmutableProofTopics.md

@@ -6,7 +6,7 @@ The topics for immutable proof event bus notifications.
 
 ## Type Declaration
 
-### ProofCreated
+### ProofCreated {#proofcreated}
 
 > `readonly` **ProofCreated**: `"immutable-proof:proof-created"` = `"immutable-proof:proof-created"`
 

package/docs/reference/variables/ImmutableProofTypes.md

@@ -6,20 +6,20 @@ The types of immutable proof data.
 
 ## Type Declaration
 
-### ImmutableProof
+### ImmutableProof {#immutableproof}
 
 > `readonly` **ImmutableProof**: `"ImmutableProof"` = `"ImmutableProof"`
 
 Represents Immutable Proof.
 
-### ImmutableProofReceipt
+### ImmutableProofVerification {#immutableproofverification}
 
-> `readonly` **ImmutableProofReceipt**: `"ImmutableProofReceipt"` = `"ImmutableProofReceipt"`
+> `readonly` **ImmutableProofVerification**: `"ImmutableProofVerification"` = `"ImmutableProofVerification"`
 
-Represents Immutable Proof Receipt.
+Represents Immutable Proof Verification.
 
-### ImmutableProofVerification
+### ImmutableProofFailure {#immutableprooffailure}
 
-> `readonly` **ImmutableProofVerification**: `"ImmutableProofVerification"` = `"ImmutableProofVerification"`
+> `readonly` **ImmutableProofFailure**: `"ImmutableProofFailure"` = `"ImmutableProofFailure"`
 
-Represents Immutable Proof Verification.
+Represents Immutable Proof Failure.

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/immutable-proof-models",
-	"version": "0.0.3-next.9",
-	"description": "Models which define the structure of the immutable proof connectors and services",
+	"version": "0.9.0-next.1",
+	"description": "Shared model contracts, schema types, and context constants for immutable proof workflows",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/immutable-proof.git",
+		"url": "git+https://github.com/iotaledger/twin-immutable-proof.git",
 		"directory": "packages/immutable-proof-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,13 +14,13 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "next",
-		"@twin.org/data-core": "next",
-		"@twin.org/data-json-ld": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/standards-w3c-did": "next",
-		"@twin.org/web": "next"
+		"@twin.org/core": "0.9.0-next.1",
+		"@twin.org/data-core": "0.9.0-next.1",
+		"@twin.org/data-json-ld": "0.9.0-next.1",
+		"@twin.org/entity": "0.9.0-next.1",
+		"@twin.org/nameof": "0.9.0-next.1",
+		"@twin.org/standards-w3c-did": "0.9.0-next.1",
+		"@twin.org/web": "0.9.0-next.1"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -50,7 +50,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/immutable-proof/issues"
+		"url": "git+https://github.com/iotaledger/twin-immutable-proof/issues"
 	},
 	"homepage": "https://twindev.org"
 }

package/dist/es/models/IImmutableProofReceipt.js

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"IImmutableProofReceipt.js","sourceRoot":"","sources":["../../../src/models/IImmutableProofReceipt.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { ImmutableProofContexts } from \"./immutableProofContexts.js\";\nimport type { ImmutableProofTypes } from \"./immutableProofTypes.js\";\n\n/**\n * Interface describing an immutable proof receipt.\n */\nexport interface IImmutableProofReceipt {\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.ImmutableProofReceipt;\n\n\t/**\n\t * The immutable receipt detail for where the proof is stored.\n\t * json-ld id\n\t */\n\timmutableReceipt?: IJsonLdNodeObject;\n\n\t/**\n\t * The verifiable storage id for where the proof is stored.\n\t * json-ld id\n\t */\n\tverifiableStorageId?: string;\n}\n"]}

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

@@ -1,26 +0,0 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { ImmutableProofContexts } from "./immutableProofContexts.js";
-import type { ImmutableProofTypes } from "./immutableProofTypes.js";
-/**
- * Interface describing an immutable proof receipt.
- */
-export interface IImmutableProofReceipt {
-    /**
-     * JSON-LD Context.
-     */
-    "@context"?: [typeof ImmutableProofContexts.Context, typeof ImmutableProofContexts.ContextCommon];
-    /**
-     * JSON-LD Type.
-     */
-    type: typeof ImmutableProofTypes.ImmutableProofReceipt;
-    /**
-     * The immutable receipt detail for where the proof is stored.
-     * json-ld id
-     */
-    immutableReceipt?: IJsonLdNodeObject;
-    /**
-     * The verifiable storage id for where the proof is stored.
-     * json-ld id
-     */
-    verifiableStorageId?: string;
-}

package/docs/reference/interfaces/IImmutableProofReceipt.md

@@ -1,37 +0,0 @@
-# Interface: IImmutableProofReceipt
-
-Interface describing an immutable proof receipt.
-
-## Properties
-
-### @context?
-
-> `optional` **@context**: \[`"https://schema.twindev.org/immutable-proof/"`, `"https://schema.twindev.org/common/"`\]
-
-JSON-LD Context.
-
-***
-
-### type
-
-> **type**: `"ImmutableProofReceipt"`
-
-JSON-LD Type.
-
-***
-
-### immutableReceipt?
-
-> `optional` **immutableReceipt**: `IJsonLdNodeObject`
-
-The immutable receipt detail for where the proof is stored.
-json-ld id
-
-***
-
-### verifiableStorageId?
-
-> `optional` **verifiableStorageId**: `string`
-
-The verifiable storage id for where the proof is stored.
-json-ld id