@twin.org/identity-service 0.0.3-next.8 → 0.9.0-next.1

package/dist/es/identityRoutes.js

@@ -47,7 +47,7 @@ export function generateRestRoutesIdentity(baseRouteName, componentName) {
                         id: "identityCreateResponseExample",
                         response: {
                             body: {
-                                "@context": DidContexts.Namespace,
+                                "@context": DidContexts.Context,
                                 id: "did:iota:tst:0xe3088ba9aa8c28e1d139708a14e8c0fdff11ee8223baac4aa5bcf3321e4bfc6a",
                                 service: [
                                     {
@@ -251,6 +251,70 @@ export function generateRestRoutesIdentity(baseRouteName, componentName) {
             }
         ]
     };
+    const identityAlsoKnownAsCreateRoute = {
+        operationId: "identityAlsoKnownAsCreate",
+        summary: "Add an alias to the alsoKnownAs property on the document",
+        tag: tagsIdentity[0].name,
+        method: "POST",
+        path: `${baseRouteName}/:identity/alias`,
+        handler: async (httpRequestContext, request) => identityAlsoKnownAsCreate(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IIdentityAlsoKnownAsCreateRequest",
+            examples: [
+                {
+                    id: "identityAlsoKnownAsCreateRequestExample",
+                    request: {
+                        pathParams: {
+                            identity: "did:iota:tst:0xe3088ba9aa8c28e1d139708a14e8c0fdff11ee8223baac4aa5bcf3321e4bfc6a"
+                        },
+                        body: {
+                            alias: "did:example:123"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "INoContentResponse"
+            }
+        ]
+    };
+    const identityAlsoKnownAsRemoveRoute = {
+        operationId: "identityAlsoKnownAsRemove",
+        summary: "Remove an alias from the alsoKnownAs property on the document",
+        tag: tagsIdentity[0].name,
+        method: "DELETE",
+        path: `${baseRouteName}/:identity/alias/:alias`,
+        handler: async (httpRequestContext, request) => identityAlsoKnownAsRemove(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IIdentityAlsoKnownAsRemoveRequest",
+            examples: [
+                {
+                    id: "identityAlsoKnownAsRemoveRequestExample",
+                    request: {
+                        pathParams: {
+                            identity: "did:iota:tst:0xe3088ba9aa8c28e1d139708a14e8c0fdff11ee8223baac4aa5bcf3321e4bfc6a",
+                            alias: "did:example:123"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "INoContentResponse",
+                examples: [
+                    {
+                        id: "identityAlsoKnownAsRemoveResponseExample",
+                        response: {
+                            statusCode: HttpStatusCode.noContent
+                        }
+                    }
+                ]
+            }
+        ]
+    };
     const identityVerifiableCredentialCreateRoute = {
         operationId: "identityVerifiableCredentialCreate",
         summary: "Create an identity verifiable credential",
@@ -364,8 +428,72 @@ export function generateRestRoutesIdentity(baseRouteName, componentName) {
                     }
                 ]
             }
-        ],
-        skipAuth: true
+        ]
+    };
+    const identityVerifiableCredentialVerifyDocumentRoute = {
+        operationId: "identityVerifiableCredentialVerifyDocument",
+        summary: "Verify an identity verifiable credential document",
+        tag: tagsIdentity[0].name,
+        method: "POST",
+        path: `${baseRouteName}/verifiable-credential/verify/document`,
+        handler: async (httpRequestContext, request) => identityVerifiableCredentialVerifyDocument(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IIdentityVerifiableCredentialVerifyDocumentRequest",
+            examples: [
+                {
+                    id: "identityVerifiableCredentialVerifyDocumentRequestExample",
+                    request: {
+                        body: {
+                            "@context": ["https://www.w3.org/2018/credentials/v1", "https://schema.org"],
+                            id: "https://example.com/credentials/3732",
+                            type: ["VerifiableCredential", "Person"],
+                            credentialSubject: {
+                                id: "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
+                                name: "Jane Doe"
+                            },
+                            issuer: "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
+                            issuanceDate: "2025-01-24T09:21:51.500Z",
+                            credentialStatus: {
+                                id: "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
+                                type: "BitstringStatusList",
+                                revocationBitmapIndex: "5"
+                            }
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "IIdentityVerifiableCredentialVerifyResponse",
+                examples: [
+                    {
+                        id: "identityVerifiableCredentialVerifyResponseExample",
+                        response: {
+                            body: {
+                                revoked: false,
+                                verifiableCredential: {
+                                    "@context": ["https://www.w3.org/2018/credentials/v1", "https://schema.org"],
+                                    id: "https://example.com/credentials/3732",
+                                    type: ["VerifiableCredential", "Person"],
+                                    credentialSubject: {
+                                        id: "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
+                                        name: "Jane Doe"
+                                    },
+                                    issuer: "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
+                                    issuanceDate: "2025-01-24T09:21:51.500Z",
+                                    credentialStatus: {
+                                        id: "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
+                                        type: "BitstringStatusList",
+                                        revocationBitmapIndex: "5"
+                                    }
+                                }
+                            }
+                        }
+                    }
+                ]
+            }
+        ]
     };
     const identityVerifiableCredentialRevokeRoute = {
         operationId: "identityVerifiableCredentialRevoke",
@@ -526,8 +654,70 @@ export function generateRestRoutesIdentity(baseRouteName, componentName) {
                     }
                 ]
             }
-        ],
-        skipAuth: true
+        ]
+    };
+    const identityVerifiablePresentationVerifyDocumentRoute = {
+        operationId: "identityVerifiablePresentationVerifyDocument",
+        summary: "Verify an identity verifiable presentation document",
+        tag: tagsIdentity[0].name,
+        method: "POST",
+        path: `${baseRouteName}/verifiable-presentation/verify/document`,
+        handler: async (httpRequestContext, request) => identityVerifiablePresentationVerifyDocument(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IIdentityVerifiablePresentationVerifyDocumentRequest",
+            examples: [
+                {
+                    id: "identityVerifiablePresentationVerifyDocumentRequestExample",
+                    request: {
+                        body: {
+                            "@context": ["https://www.w3.org/2018/credentials/v1", "https://schema.org"],
+                            id: "https://example.com/credentials/3732",
+                            type: ["VerifiableCredential", "Person"],
+                            verifiableCredential: [
+                                {
+                                    "@context": ["https://www.w3.org/2018/credentials/v1", "https://schema.org"],
+                                    id: "https://example.com/credentials/3732",
+                                    type: ["VerifiableCredential", "Person"],
+                                    credentialSubject: {
+                                        id: "did:entity-storage:0x4757993355b921a8229bd780f30921b6a0216a72e6c3f37a09d13b8426a17def",
+                                        name: "Jane Doe"
+                                    },
+                                    issuer: "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a",
+                                    issuanceDate: "2025-01-24T09:21:51.500Z",
+                                    credentialStatus: {
+                                        id: "did:entity-storage:0x879c31386f992cfa29b77fe31e37256d69f6a57653cee4eb60ad4c4613c5515a#revocation",
+                                        type: "BitstringStatusList",
+                                        revocationBitmapIndex: "5"
+                                    }
+                                }
+                            ]
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "IIdentityVerifiablePresentationVerifyResponse",
+                examples: [
+                    {
+                        id: "identityVerifiablePresentationVerifyResponseExample",
+                        response: {
+                            body: {
+                                revoked: false,
+                                verifiablePresentation: {
+                                    "@context": ["https://www.w3.org/2018/credentials/v1", "https://schema.org"],
+                                    id: "presentationId",
+                                    type: ["VerifiablePresentation", "Person"],
+                                    verifiableCredential: ["eyJraWQiOi...D1Z3AQ"],
+                                    holder: "did:entity-storage:0xcea318e06e89f3fb4048160770effd84d0cfa5801fee13dfa6f9413a00429cec"
+                                }
+                            }
+                        }
+                    }
+                ]
+            }
+        ]
     };
     const identityProofCreateRoute = {
         operationId: "identityProofCreate",
@@ -578,7 +768,7 @@ export function generateRestRoutesIdentity(baseRouteName, componentName) {
                         response: {
                             body: {
                                 "@context": [
-                                    "https://www.w3.org/ns/credentials/v2",
+                                    "https://w3id.org/security/data-integrity/v2",
                                     "https://www.w3.org/ns/credentials/examples/v2"
                                 ],
                                 type: "DataIntegrityProof",
@@ -625,7 +815,7 @@ export function generateRestRoutesIdentity(baseRouteName, componentName) {
                                 }
                             },
                             proof: {
-                                "@context": "https://www.w3.org/ns/credentials/v2",
+                                "@context": "https://w3id.org/security/data-integrity/v2",
                                 type: "DataIntegrityProof",
                                 cryptosuite: "eddsa-jcs-2022",
                                 created: "2025-01-24T11:32:13.106Z",
@@ -652,8 +842,7 @@ export function generateRestRoutesIdentity(baseRouteName, componentName) {
                     }
                 ]
             }
-        ],
-        skipAuth: true
+        ]
     };
     return [
         identityCreateRoute,
@@ -662,11 +851,15 @@ export function generateRestRoutesIdentity(baseRouteName, componentName) {
         identityVerificationMethodRemoveRoute,
         identityServiceCreateRoute,
         identityServiceRemoveRoute,
+        identityAlsoKnownAsCreateRoute,
+        identityAlsoKnownAsRemoveRoute,
         identityVerifiableCredentialCreateRoute,
+        identityVerifiableCredentialVerifyDocumentRoute,
         identityVerifiableCredentialVerifyRoute,
         identityVerifiableCredentialRevokeRoute,
         identityVerifiableCredentialUnrevokeRoute,
         identityVerifiablePresentationCreateRoute,
+        identityVerifiablePresentationVerifyDocumentRoute,
         identityVerifiablePresentationVerifyRoute,
         identityProofCreateRoute,
         identityProofVerifyRoute
@@ -785,6 +978,45 @@ export async function identityServiceRemove(httpRequestContext, componentName, r
         statusCode: HttpStatusCode.noContent
     };
 }
+/**
+ * Create an identity alias.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function identityAlsoKnownAsCreate(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
+    Guards.stringValue(ROUTES_SOURCE, "request.pathParams.identity", request.pathParams.identity);
+    const contextIds = await ContextIdStore.getContextIds();
+    ContextIdHelper.guard(contextIds, ContextIdKeys.Organization);
+    const component = ComponentFactory.get(componentName);
+    await component.alsoKnownAsAdd(request.pathParams.identity, request.body.alias, contextIds[ContextIdKeys.Organization]);
+    return {
+        statusCode: HttpStatusCode.noContent
+    };
+}
+/**
+ * Remove an identity alias.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function identityAlsoKnownAsRemove(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
+    Guards.stringValue(ROUTES_SOURCE, "request.pathParams.identity", request.pathParams.identity);
+    Guards.stringValue(ROUTES_SOURCE, "request.pathParams.alias", request.pathParams.alias);
+    const contextIds = await ContextIdStore.getContextIds();
+    ContextIdHelper.guard(contextIds, ContextIdKeys.Organization);
+    const component = ComponentFactory.get(componentName);
+    await component.alsoKnownAsRemove(request.pathParams.identity, request.pathParams.alias, contextIds[ContextIdKeys.Organization]);
+    return {
+        statusCode: HttpStatusCode.noContent
+    };
+}
 /**
  * Create a verifiable credential.
  * @param httpRequestContext The request context for the API.
@@ -802,7 +1034,9 @@ export async function identityVerifiableCredentialCreate(httpRequestContext, com
     const component = ComponentFactory.get(componentName);
     const result = await component.verifiableCredentialCreate(DocumentHelper.joinId(request.pathParams.identity, request.pathParams.verificationMethodId), request.body.credentialId, request.body.subject, {
         revocationIndex: request.body.revocationIndex,
-        expirationDate: Coerce.date(request.body.expirationDate)
+        expirationDate: Coerce.dateTime(request.body.expirationDate),
+        jwtHeaderFields: request.body.jwtHeaderFields,
+        jwtPayloadFields: request.body.jwtPayloadFields
     }, contextIds[ContextIdKeys.Organization]);
     return {
         body: result
@@ -818,9 +1052,25 @@ export async function identityVerifiableCredentialCreate(httpRequestContext, com
 export async function identityVerifiableCredentialVerify(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request", request);
     Guards.object(ROUTES_SOURCE, "request.query", request.query);
-    Guards.stringValue(ROUTES_SOURCE, "request.query.jwt", request.query.jwt);
     const component = ComponentFactory.get(componentName);
-    const result = await component.verifiableCredentialVerify(request.query.jwt);
+    const result = await component.verifiableCredentialVerify(request.query?.jwt);
+    return {
+        body: result
+    };
+}
+/**
+ * Verify a verifiable credential document.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function identityVerifiableCredentialVerifyDocument(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.object(ROUTES_SOURCE, "request.body", request.body);
+    Guards.object(ROUTES_SOURCE, "request.body", request.body);
+    const component = ComponentFactory.get(componentName);
+    const result = await component.verifiableCredentialVerify(request.body);
     return {
         body: result
     };
@@ -882,7 +1132,11 @@ export async function identityVerifiablePresentationCreate(httpRequestContext, c
     const contextIds = await ContextIdStore.getContextIds();
     ContextIdHelper.guard(contextIds, ContextIdKeys.Organization);
     const component = ComponentFactory.get(componentName);
-    const result = await component.verifiablePresentationCreate(DocumentHelper.joinId(request.pathParams.identity, request.pathParams.verificationMethodId), request.body.presentationId, request.body.contexts, request.body.types, request.body.verifiableCredentials, request.body.expiresInMinutes, contextIds[ContextIdKeys.Organization]);
+    const result = await component.verifiablePresentationCreate(DocumentHelper.joinId(request.pathParams.identity, request.pathParams.verificationMethodId), request.body.presentationId, request.body.contexts, request.body.types, request.body.verifiableCredentials, {
+        expirationDate: Coerce.dateTime(request.body.expirationDate),
+        jwtHeaderFields: request.body.jwtHeaderFields,
+        jwtPayloadFields: request.body.jwtPayloadFields
+    }, contextIds[ContextIdKeys.Organization]);
     return {
         body: result
     };
@@ -904,6 +1158,22 @@ export async function identityVerifiablePresentationVerify(httpRequestContext, c
         body: result
     };
 }
+/**
+ * Verify a verifiable presentation document.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function identityVerifiablePresentationVerifyDocument(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.object(ROUTES_SOURCE, "request.body", request.body);
+    const component = ComponentFactory.get(componentName);
+    const result = await component.verifiablePresentationVerify(request.body);
+    return {
+        body: result
+    };
+}
 /**
  * Create an identity proof.
  * @param httpRequestContext The request context for the API.
@@ -920,7 +1190,7 @@ export async function identityProofCreate(httpRequestContext, componentName, req
     const contextIds = await ContextIdStore.getContextIds();
     ContextIdHelper.guard(contextIds, ContextIdKeys.Organization);
     const component = ComponentFactory.get(componentName);
-    const result = await component.proofCreate(request.pathParams.identity, request.body.proofType, request.body.document, contextIds[ContextIdKeys.Organization]);
+    const result = await component.proofCreate(DocumentHelper.joinId(request.pathParams.identity, request.pathParams.verificationMethodId), request.body.proofType, request.body.document, contextIds[ContextIdKeys.Organization]);
     return {
         body: result
     };