@twin.org/immutable-proof-service 0.0.1-next.11 → 0.0.1-next.12

package/dist/cjs/index.cjs

@@ -177,13 +177,6 @@ function generateRestRoutesImmutableProof(baseRouteName, componentName) {
                     request: {
                         pathParams: {
                             id: "ais:1234567890"
-                        },
-                        body: {
-                            proofObject: {
-                                "@context": "http://schema.org",
-                                type: "Person",
-                                name: "John Smith"
-                            }
                         }
                     }
                 }
@@ -279,10 +272,9 @@ async function immutableProofVerify(httpRequestContext, componentName, request)
     core.Guards.object(ROUTES_SOURCE, "request", request);
     core.Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     core.Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
-    core.Guards.object(ROUTES_SOURCE, "request.body.proofObject", request.body.proofObject);
     const mimeType = request.headers?.[web.HeaderTypes.Accept] === web.MimeTypes.JsonLd ? "jsonld" : "json";
     const component = core.ComponentFactory.get(componentName);
-    const result = await component.verify(request.pathParams.id, request.body.proofObject);
+    const result = await component.verify(request.pathParams.id);
     return {
         headers: {
             [web.HeaderTypes.ContentType]: mimeType === "json" ? web.MimeTypes.Json : web.MimeTypes.JsonLd
@@ -434,7 +426,7 @@ class ImmutableProofService {
             });
         }
         try {
-            const { immutableProof } = await this.internalGet(id);
+            const { immutableProof } = await this.internalGet(id, false);
             const compacted = await dataJsonLd.JsonLdProcessor.compact(immutableProof, immutableProof["@context"]);
             return compacted;
         }
@@ -445,11 +437,10 @@ class ImmutableProofService {
     /**
      * Verify an authentication proof.
      * @param id The id of the proof to verify.
-     * @param proofObject The object to verify as JSON-LD.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.
      */
-    async verify(id, proofObject) {
+    async verify(id) {
         core.Guards.stringValue(this.CLASS_NAME, "id", id);
         const urnParsed = core.Urn.fromValidString(id);
         if (urnParsed.namespaceIdentifier() !== ImmutableProofService.NAMESPACE) {
@@ -459,7 +450,7 @@ class ImmutableProofService {
             });
         }
         try {
-            const { verified, failure } = await this.internalGet(id, proofObject);
+            const { verified, failure } = await this.internalGet(id, true);
             return {
                 "@context": immutableProofModels.ImmutableProofTypes.ContextRoot,
                 type: immutableProofModels.ImmutableProofTypes.ImmutableProofVerification,
@@ -565,12 +556,12 @@ class ImmutableProofService {
     /**
      * Verify an authentication proof.
      * @param id The id of the proof to verify.
-     * @param proofObject The object to verify as JSON-LD.
+     * @param verify Validate the proof.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.
      * @internal
      */
-    async internalGet(id, proofObject) {
+    async internalGet(id, verify) {
         const urnParsed = core.Urn.fromValidString(id);
         const proofId = urnParsed.namespaceSpecific(0);
         const proofEntity = await this._proofStorage.get(proofId);
@@ -590,7 +581,7 @@ class ImmutableProofService {
                 if (core.Is.array(proofModel["@context"])) {
                     proofModel["@context"].push(immutableStorageModels.ImmutableStorageTypes.ContextRoot);
                 }
-                if (core.Is.object(proofModel.proof) && core.Is.object(proofObject)) {
+                if (verify && core.Is.object(proofModel.proof)) {
                     if (proofModel.proof.cryptosuite !== standardsW3cDid.DidCryptoSuites.EdDSAJcs2022) {
                         failure = immutableProofModels.ImmutableProofFailure.CryptoSuiteMismatch;
                     }

package/dist/esm/index.mjs

@@ -175,13 +175,6 @@ function generateRestRoutesImmutableProof(baseRouteName, componentName) {
                     request: {
                         pathParams: {
                             id: "ais:1234567890"
-                        },
-                        body: {
-                            proofObject: {
-                                "@context": "http://schema.org",
-                                type: "Person",
-                                name: "John Smith"
-                            }
                         }
                     }
                 }
@@ -277,10 +270,9 @@ async function immutableProofVerify(httpRequestContext, componentName, request)
     Guards.object(ROUTES_SOURCE, "request", request);
     Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
-    Guards.object(ROUTES_SOURCE, "request.body.proofObject", request.body.proofObject);
     const mimeType = request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? "jsonld" : "json";
     const component = ComponentFactory.get(componentName);
-    const result = await component.verify(request.pathParams.id, request.body.proofObject);
+    const result = await component.verify(request.pathParams.id);
     return {
         headers: {
             [HeaderTypes.ContentType]: mimeType === "json" ? MimeTypes.Json : MimeTypes.JsonLd
@@ -432,7 +424,7 @@ class ImmutableProofService {
             });
         }
         try {
-            const { immutableProof } = await this.internalGet(id);
+            const { immutableProof } = await this.internalGet(id, false);
             const compacted = await JsonLdProcessor.compact(immutableProof, immutableProof["@context"]);
             return compacted;
         }
@@ -443,11 +435,10 @@ class ImmutableProofService {
     /**
      * Verify an authentication proof.
      * @param id The id of the proof to verify.
-     * @param proofObject The object to verify as JSON-LD.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.
      */
-    async verify(id, proofObject) {
+    async verify(id) {
         Guards.stringValue(this.CLASS_NAME, "id", id);
         const urnParsed = Urn.fromValidString(id);
         if (urnParsed.namespaceIdentifier() !== ImmutableProofService.NAMESPACE) {
@@ -457,7 +448,7 @@ class ImmutableProofService {
             });
         }
         try {
-            const { verified, failure } = await this.internalGet(id, proofObject);
+            const { verified, failure } = await this.internalGet(id, true);
             return {
                 "@context": ImmutableProofTypes.ContextRoot,
                 type: ImmutableProofTypes.ImmutableProofVerification,
@@ -563,12 +554,12 @@ class ImmutableProofService {
     /**
      * Verify an authentication proof.
      * @param id The id of the proof to verify.
-     * @param proofObject The object to verify as JSON-LD.
+     * @param verify Validate the proof.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.
      * @internal
      */
-    async internalGet(id, proofObject) {
+    async internalGet(id, verify) {
         const urnParsed = Urn.fromValidString(id);
         const proofId = urnParsed.namespaceSpecific(0);
         const proofEntity = await this._proofStorage.get(proofId);
@@ -588,7 +579,7 @@ class ImmutableProofService {
                 if (Is.array(proofModel["@context"])) {
                     proofModel["@context"].push(ImmutableStorageTypes.ContextRoot);
                 }
-                if (Is.object(proofModel.proof) && Is.object(proofObject)) {
+                if (verify && Is.object(proofModel.proof)) {
                     if (proofModel.proof.cryptosuite !== DidCryptoSuites.EdDSAJcs2022) {
                         failure = ImmutableProofFailure.CryptoSuiteMismatch;
                     }

package/dist/types/immutableProofService.d.ts

@@ -49,11 +49,10 @@ export declare class ImmutableProofService implements IImmutableProofComponent {
     /**
      * Verify an authentication proof.
      * @param id The id of the proof to verify.
-     * @param proofObject The object to verify as JSON-LD.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.
      */
-    verify(id: string, proofObject: IJsonLdNodeObject): Promise<IImmutableProofVerification>;
+    verify(id: string): Promise<IImmutableProofVerification>;
     /**
      * Remove the immutable storage for the proof.
      * @param id The id of the proof to remove the storage from.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/immutable-proof-service - Changelog
 
-## v0.0.1-next.11
+## v0.0.1-next.12
 
 - Initial Release

package/docs/open-api/spec.json

@@ -360,28 +360,6 @@
                         "jwtBearerAuthScheme": []
                     }
                 ],
-                "requestBody": {
-                    "description": "Verify a proof.",
-                    "required": true,
-                    "content": {
-                        "application/json": {
-                            "schema": {
-                                "$ref": "#/components/schemas/ImmutableProofVerifyRequest"
-                            },
-                            "examples": {
-                                "immutableProofVerifyRequestExample": {
-                                    "value": {
-                                        "proofObject": {
-                                            "@context": "http://schema.org",
-                                            "type": "Person",
-                                            "name": "John Smith"
-                                        }
-                                    }
-                                }
-                            }
-                        }
-                    }
-                },
                 "responses": {
                     "200": {
                         "description": "Response to verifying an immutable proof.",
@@ -669,19 +647,6 @@
                 "additionalProperties": false,
                 "description": "The parameters from the body."
             },
-            "ImmutableProofVerifyRequest": {
-                "type": "object",
-                "properties": {
-                    "proofObject": {
-                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-                    }
-                },
-                "required": [
-                    "proofObject"
-                ],
-                "additionalProperties": false,
-                "description": "The parameters from the body."
-            },
             "NotFoundResponse": {
                 "type": "object",
                 "additionalProperties": false,

package/docs/reference/classes/ImmutableProofService.md

@@ -132,7 +132,7 @@ NotFoundError if the proof is not found.
 
 ### verify()
 
-> **verify**(`id`, `proofObject`): `Promise`\<`IImmutableProofVerification`\>
+> **verify**(`id`): `Promise`\<`IImmutableProofVerification`\>
 
 Verify an authentication proof.
 
@@ -142,10 +142,6 @@ Verify an authentication proof.
 
 The id of the proof to verify.
 
-• **proofObject**: `IJsonLdNodeObject`
-
-The object to verify as JSON-LD.
-
 #### Returns
 
 `Promise`\<`IImmutableProofVerification`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-service",
-	"version": "0.0.1-next.11",
+	"version": "0.0.1-next.12",
 	"description": "Immutable proof contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -23,8 +23,8 @@
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/identity-models": "next",
-		"@twin.org/immutable-proof-models": "0.0.1-next.11",
-		"@twin.org/immutable-proof-task": "0.0.1-next.11",
+		"@twin.org/immutable-proof-models": "0.0.1-next.12",
+		"@twin.org/immutable-proof-task": "0.0.1-next.12",
 		"@twin.org/immutable-storage-models": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",