@verii/server-credentialagent 1.1.0-pre.1765354771 → 1.1.0-pre.1765745740

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verii/server-credentialagent",
-  "version": "1.1.0-pre.1765354771",
+  "version": "1.1.0-pre.1765745740",
   "description": "Credential Agent application",
   "main": "src/index.js",
   "repository": "https://github.com/LFDT-Verii/core",
@@ -40,31 +40,31 @@
     "@fastify/view": "^11.0.0",
     "@spencejs/spence-factories": "^0.10.2",
     "@spencejs/spence-mongo-repos": "^0.10.2",
-    "@verii/auth": "1.1.0-pre.1765354771",
-    "@verii/base-contract-io": "1.1.0-pre.1765354771",
-    "@verii/blockchain-functions": "1.1.0-pre.1765354771",
-    "@verii/common-fetchers": "1.1.0-pre.1765354771",
-    "@verii/common-functions": "1.1.0-pre.1765354771",
-    "@verii/common-schemas": "1.1.0-pre.1765354771",
-    "@verii/config": "1.1.0-pre.1765354771",
-    "@verii/contract-permissions": "1.1.0-pre.1765354771",
-    "@verii/crypto": "1.1.0-pre.1765354771",
-    "@verii/csv-parser": "1.1.0-pre.1765354771",
-    "@verii/db-kms": "1.1.0-pre.1765354771",
-    "@verii/did-doc": "1.1.0-pre.1765354771",
-    "@verii/fastify-plugins": "1.1.0-pre.1765354771",
-    "@verii/http-client": "1.1.0-pre.1765354771",
-    "@verii/jwt": "1.1.0-pre.1765354771",
-    "@verii/metadata-registration": "1.1.0-pre.1765354771",
-    "@verii/organizations-registry": "1.1.0-pre.1765354771",
-    "@verii/rest-queries": "1.1.0-pre.1765354771",
-    "@verii/server-provider": "1.1.0-pre.1765354771",
-    "@verii/spencer-mongo-extensions": "1.1.0-pre.1765354771",
-    "@verii/test-regexes": "1.1.0-pre.1765354771",
-    "@verii/validation": "1.1.0-pre.1765354771",
-    "@verii/vc-checks": "1.1.0-pre.1765354771",
-    "@verii/verii-issuing": "1.1.0-pre.1765354771",
-    "@verii/verii-verification": "1.1.0-pre.1765354771",
+    "@verii/auth": "1.1.0-pre.1765745740",
+    "@verii/base-contract-io": "1.1.0-pre.1765745740",
+    "@verii/blockchain-functions": "1.1.0-pre.1765745740",
+    "@verii/common-fetchers": "1.1.0-pre.1765745740",
+    "@verii/common-functions": "1.1.0-pre.1765745740",
+    "@verii/common-schemas": "1.1.0-pre.1765745740",
+    "@verii/config": "1.1.0-pre.1765745740",
+    "@verii/contract-permissions": "1.1.0-pre.1765745740",
+    "@verii/crypto": "1.1.0-pre.1765745740",
+    "@verii/csv-parser": "1.1.0-pre.1765745740",
+    "@verii/db-kms": "1.1.0-pre.1765745740",
+    "@verii/did-doc": "1.1.0-pre.1765745740",
+    "@verii/fastify-plugins": "1.1.0-pre.1765745740",
+    "@verii/http-client": "1.1.0-pre.1765745740",
+    "@verii/jwt": "1.1.0-pre.1765745740",
+    "@verii/metadata-registration": "1.1.0-pre.1765745740",
+    "@verii/organizations-registry": "1.1.0-pre.1765745740",
+    "@verii/rest-queries": "1.1.0-pre.1765745740",
+    "@verii/server-provider": "1.1.0-pre.1765745740",
+    "@verii/spencer-mongo-extensions": "1.1.0-pre.1765745740",
+    "@verii/test-regexes": "1.1.0-pre.1765745740",
+    "@verii/validation": "1.1.0-pre.1765745740",
+    "@verii/vc-checks": "1.1.0-pre.1765745740",
+    "@verii/verii-issuing": "1.1.0-pre.1765745740",
+    "@verii/verii-verification": "1.1.0-pre.1765745740",
     "ajv": "8.17.1",
     "canonicalize": "^2.1.0",
     "date-fns": "~4.1.0",
@@ -83,10 +83,10 @@
   },
   "devDependencies": {
     "@spencejs/spence-config": "0.10.2",
-    "@verii/endpoints-organizations-registrar": "1.1.0-pre.1765354771",
-    "@verii/sample-data": "1.1.0-pre.1765354771",
+    "@verii/endpoints-organizations-registrar": "1.1.0-pre.1765745740",
+    "@verii/sample-data": "1.1.0-pre.1765745740",
     "@verii/test-regexes": "0.5.0-build",
-    "@verii/tests-helpers": "1.1.0-pre.1765354771",
+    "@verii/tests-helpers": "1.1.0-pre.1765745740",
     "cheerio": "1.1.2",
     "dotenv": "16.6.1",
     "eslint": "8.57.1",
@@ -107,5 +107,5 @@
     "prettier": "2.8.8",
     "qs": "6.14.0"
   },
-  "gitHead": "95b0dfb9c8d00b85e3c0ca240ea38048505a8681"
+  "gitHead": "46b3c80a3277ce91fff1e698ac201602b6141d18"
 }

package/src/controllers/root/controller.js

@@ -1,14 +1,14 @@
 /**
  * Copyright 2023 Velocity Team
  *
- * Licensed under the Apache License, Version 2.0 (the "License");
+ * Licensed under the Apache License, Version 2.0 (the 'License');
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
+ * distributed under the License is distributed on an 'AS IS' BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
@@ -22,6 +22,7 @@ const {
   forEach,
   isEmpty,
   values,
+  identity,
 } = require('lodash/fp');
 const { nanoid } = require('nanoid');
 const fastifyView = require('@fastify/view');
@@ -81,6 +82,10 @@ const appRedirectController = async (fastify) => {
                 items: { type: 'string' },
               },
               inspectorDid: { type: 'array', items: { type: 'string' } },
+              providers: {
+                type: 'array',
+                items: { type: 'string' },
+              },
             },
             required: ['request_uri', 'exchange_type'],
           },
@@ -124,9 +129,13 @@ const appRedirectController = async (fastify) => {
 };
 
 const validateInspectorDid = ({ exchangeType, inspectorDid }) => {
-  if (exchangeType === EXCHANGE_TYPE.inspect && isEmpty(inspectorDid)) {
+  if (
+    (exchangeType === EXCHANGE_TYPE.inspect ||
+      exchangeType === EXCHANGE_TYPE.claim) &&
+    isEmpty(inspectorDid)
+  ) {
     throw new Error.BadRequest(
-      'inspectorDid should be present for exchange_type = "inspect"'
+      `inspectorDid should be present for exchange_type = "${exchangeType}"`
     );
   }
   if (exchangeType === EXCHANGE_TYPE.issue && !isEmpty(inspectorDid)) {
@@ -143,30 +152,101 @@ const processingLinks = (context) => {
       request_uri: requestUriItems,
       inspectorDid: inspectorDidItems = [],
       vendorOriginContext: vendorOriginContextItems = [],
+      providers: providersItems,
     },
   } = context;
 
+  const parsedProviders = parseProviders(providersItems, exchangeType);
+
   const parsedLinks = flow(
     (items) => zip(items, range(0, items.length)),
     map(([value, index]) => ({
       requestUri: value,
       vendorOriginContext: vendorOriginContextItems[index],
       inspectorDid: inspectorDidItems[index],
+      ...(parsedProviders ? { providers: parsedProviders } : {}),
     }))
   )(requestUriItems);
 
   const deeplink = createDeepLinkUrl(exchangeType, context);
-  forEach(({ requestUri, inspectorDid, vendorOriginContext }) => {
-    flow(
-      appendSearchParam('request_uri', requestUri),
-      appendSearchParam('inspectorDid', inspectorDid),
-      appendSearchParam('vendorOriginContext', vendorOriginContext)
-    )(deeplink);
-  }, parsedLinks);
+  forEach(
+    ({
+      requestUri,
+      inspectorDid,
+      vendorOriginContext,
+      providers: providersItem,
+    }) => {
+      const appendParams = flow(
+        appendSearchParam('request_uri', requestUri),
+        appendSearchParam('inspectorDid', inspectorDid),
+        appendSearchParam('vendorOriginContext', vendorOriginContext),
+        providersItem
+          ? appendSearchParam('providers', JSON.stringify(providersItem))
+          : identity
+      );
+
+      appendParams(deeplink);
+    },
+    parsedLinks
+  );
 
   return { deeplink };
 };
 
+const parseProviders = (providersItems, exchangeType) => {
+  if (exchangeType !== EXCHANGE_TYPE.claim) {
+    return null;
+  }
+
+  if (!providersItems) {
+    throw new Error.BadRequest(
+      'providers parameter is required for exchange_type = "claim.wizard"'
+    );
+  }
+
+  const normalizedProviders = Array.isArray(providersItems)
+    ? providersItems
+    : [providersItems];
+
+  let parsedProviders;
+
+  try {
+    parsedProviders = normalizedProviders.map((provider) => {
+      if (typeof provider === 'string') {
+        return JSON.parse(provider);
+      }
+      return provider;
+    });
+  } catch (error) {
+    throw new Error.BadRequest('Invalid JSON format for providers parameter');
+  }
+
+  const PROVIDERS_REQUIRED_PROPS = ['name', 'id', 'logo', 'category'];
+
+  return parsedProviders.map((item, index) => {
+    if (!item || typeof item !== 'object') {
+      throw new Error.BadRequest(
+        `Provider at index ${index} must be an object`
+      );
+    }
+
+    for (const prop of PROVIDERS_REQUIRED_PROPS) {
+      if (!item[prop] || typeof item[prop] !== 'string') {
+        throw new Error.BadRequest(
+          `Provider at index ${index} missing required property: ${prop}`
+        );
+      }
+    }
+
+    return {
+      name: item.name,
+      logo: item.logo,
+      category: item.category,
+      id: item.id,
+    };
+  });
+};
+
 // eslint-disable-next-line better-mutation/no-mutation
 appRedirectController.prefixOverride = '';
 

package/src/entities/exchanges/domains/constants.js

@@ -17,6 +17,7 @@
 const EXCHANGE_TYPE = {
   inspect: 'inspect',
   issue: 'issue',
+  claim: 'claim.wizard',
 };
 
 module.exports = {

package/test/combined/app-redirect.test.js

@@ -126,6 +126,18 @@ describe('app redirect controller test', () => {
     );
   });
 
+  it('should 400 if exchange_type is claim.wizard and inspectorDid not provided', async () => {
+    setupNock();
+    const response = await fastify.injectJson({
+      method: 'GET',
+      url: `${appRedirectUrl}?request_uri=uri&exchange_type=claim.wizard`,
+    });
+    expect(response.statusCode).toEqual(400);
+    expect(response.json.message).toEqual(
+      'inspectorDid should be present for exchange_type = "claim.wizard"'
+    );
+  });
+
   it('should 400 if exchange_type is not one of allowed values', async () => {
     setupNock();
     const response = await fastify.injectJson({
@@ -187,7 +199,7 @@ describe('app redirect controller test', () => {
     expect(scriptTag.attr('nonce')).toEqual(nonceFromCspHeader);
   });
 
-  it('should include vnf wallet selection mount point', async () => {
+  it('should include vnf wallet selection mount point if inspect', async () => {
     const url =
       // eslint-disable-next-line max-len
       'http%3A%2F%2Flocalhost.test%2Fapi%2Fholder%2Fv0.6%2Forg%2Fdid%3Aion%3A4131209321321323123e%2Fissue%2Fget-credential-manifest%3Fexchange_id%3D5f123eab4362bb2e%26credential_types%3DPastEmploymentPosition%26id%3DsecretId';
@@ -205,4 +217,116 @@ describe('app redirect controller test', () => {
     expect(scriptTag.attr('data-deeplink')).toEqual(deeplink);
     expect(scriptTag.attr('data-automode')).toEqual('');
   });
+
+  it('should include vnf wallet selection mount point if claim.wizard with one provider', async () => {
+    setupNock();
+    const url =
+      // eslint-disable-next-line max-len
+      'http%3A%2F%2Flocalhost.test%2Fapi%2Fholder%2Fv0.6%2Forg%2Fdid%3Aion%3A4131209321321323123e%2Fissue%2Fget-credential-manifest%3Fexchange_id%3D5f123eab4362bb2e%26credential_types%3DPastEmploymentPosition%26id%3DsecretId';
+    const response = await fastify.injectJson({
+      method: 'GET',
+      // eslint-disable-next-line max-len
+      url: `${appRedirectUrl}?request_uri=${url}&exchange_type=claim.wizard&inspectorDid=321123&providers=%7B%22logo%22%3A%22https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fa%2Faa%2FLinkedIn_2021.svg%22%2C%22name%22%3A%22LinkedIn%22%2C%22category%22%3A%22Personal%20Records%22%2C%22id%22%3A%22a9f1063c-06b7-476a-8410-9ff6e427e637%22%7D`,
+    });
+
+    expect(response.statusCode).toEqual(200);
+    const $ = cheerio.load(response.body);
+
+    const scriptTag = $('html > body > #vnf-wallet-selection');
+    const deeplink =
+      // eslint-disable-next-line max-len
+      'velocity-test://claim.wizard?request_uri=http%3A%2F%2Flocalhost.test%2Fapi%2Fholder%2Fv0.6%2Forg%2Fdid%3Aion%3A4131209321321323123e%2Fissue%2Fget-credential-manifest%3Fexchange_id%3D5f123eab4362bb2e%26credential_types%3DPastEmploymentPosition%26id%3DsecretId&inspectorDid=321123&providers=%5B%7B%22name%22%3A%22LinkedIn%22%2C%22logo%22%3A%22https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fa%2Faa%2FLinkedIn_2021.svg%22%2C%22category%22%3A%22Personal+Records%22%2C%22id%22%3A%22a9f1063c-06b7-476a-8410-9ff6e427e637%22%7D%5D';
+    expect(scriptTag.attr('data-deeplink')).toEqual(deeplink);
+    expect(scriptTag.attr('data-automode')).toEqual('');
+  });
+
+  it('should throw if claim.wizard and provider is missing required properties: id', async () => {
+    setupNock();
+    const url =
+      // eslint-disable-next-line max-len
+      'http%3A%2F%2Flocalhost.test%2Fapi%2Fholder%2Fv0.6%2Forg%2Fdid%3Aion%3A4131209321321323123e%2Fissue%2Fget-credential-manifest%3Fexchange_id%3D5f123eab4362bb2e%26credential_types%3DPastEmploymentPosition%26id%3DsecretId';
+    const response = await fastify.injectJson({
+      method: 'GET',
+      // eslint-disable-next-line max-len
+      url: `${appRedirectUrl}?request_uri=${url}&exchange_type=claim.wizard&inspectorDid=321123&providers=%7B%22logo%22%3A%22https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fa%2Faa%2FLinkedIn_2021.svg%22%2C%22name%22%3A%22LinkedIn%22%7D`,
+    });
+
+    expect(response.statusCode).toEqual(400);
+    expect(response.json.message).toEqual(
+      'Provider at index 0 missing required property: id'
+    );
+  });
+
+  it('should throw if claim.wizard and provider is missing required properties: name', async () => {
+    setupNock();
+    const url =
+      // eslint-disable-next-line max-len
+      'http%3A%2F%2Flocalhost.test%2Fapi%2Fholder%2Fv0.6%2Forg%2Fdid%3Aion%3A4131209321321323123e%2Fissue%2Fget-credential-manifest%3Fexchange_id%3D5f123eab4362bb2e%26credential_types%3DPastEmploymentPosition%26id%3DsecretId';
+    const response = await fastify.injectJson({
+      method: 'GET',
+      // eslint-disable-next-line max-len
+      url: `${appRedirectUrl}?request_uri=${url}&exchange_type=claim.wizard&inspectorDid=321123&providers=%7B%22logo%22%3A%22https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fa%2Faa%2FLinkedIn_2021.svg%22%2C%22id%22%3A%22LinkedIn%22%7D`,
+    });
+
+    expect(response.statusCode).toEqual(400);
+    expect(response.json.message).toEqual(
+      'Provider at index 0 missing required property: name'
+    );
+  });
+
+  it('should throw if claim.wizard and provider is missing required properties: logo', async () => {
+    setupNock();
+    const url =
+      // eslint-disable-next-line max-len
+      'http%3A%2F%2Flocalhost.test%2Fapi%2Fholder%2Fv0.6%2Forg%2Fdid%3Aion%3A4131209321321323123e%2Fissue%2Fget-credential-manifest%3Fexchange_id%3D5f123eab4362bb2e%26credential_types%3DPastEmploymentPosition%26id%3DsecretId';
+    const response = await fastify.injectJson({
+      method: 'GET',
+      // eslint-disable-next-line max-len
+      url: `${appRedirectUrl}?request_uri=${url}&exchange_type=claim.wizard&inspectorDid=321123&providers=%7B%22name%22%3A%22LinkedIn%22%2C%22category%22%3A%22Personal%20Records%22%2C%22id%22%3A%22a9f1063c-06b7-476a-8410-9ff6e427e637%22%7D`,
+    });
+
+    expect(response.statusCode).toEqual(400);
+    expect(response.json.message).toEqual(
+      'Provider at index 0 missing required property: logo'
+    );
+  });
+
+  it('should include vnf wallet selection mount point if claim.wizard with multiple providers', async () => {
+    setupNock();
+    const url =
+      // eslint-disable-next-line max-len
+      'http%3A%2F%2Flocalhost.test%2Fapi%2Fholder%2Fv0.6%2Forg%2Fdid%3Aion%3A4131209321321323123e%2Fissue%2Fget-credential-manifest%3Fexchange_id%3D5f123eab4362bb2e%26credential_types%3DPastEmploymentPosition%26id%3DsecretId';
+    const response = await fastify.injectJson({
+      method: 'GET',
+      // eslint-disable-next-line max-len
+      url: `${appRedirectUrl}?request_uri=${url}&exchange_type=claim.wizard&inspectorDid=321123&providers=%7B%22logo%22%3A%22https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fa%2Faa%2FLinkedIn_2021.svg%22%2C%22name%22%3A%22LinkedIn%22%2C%22category%22%3A%22Personal%20Records%22%2C%22id%22%3A%22a9f1063c-06b7-476a-8410-9ff6e427e637%22%7D&providers=%7B%22logo%22%3A%22https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fa%2Faa%2FLinkedIn_2021.svg%22%2C%22name%22%3A%22LinkedIn%22%2C%22category%22%3A%22Personal%20Records%22%2C%22id%22%3A%22a9f1063c-06b7-476a-8410-9ff6e427e637%22%7D`,
+    });
+
+    expect(response.statusCode).toEqual(200);
+    const $ = cheerio.load(response.body);
+
+    const scriptTag = $('html > body > #vnf-wallet-selection');
+    const deeplink =
+      // eslint-disable-next-line max-len
+      'velocity-test://claim.wizard?request_uri=http%3A%2F%2Flocalhost.test%2Fapi%2Fholder%2Fv0.6%2Forg%2Fdid%3Aion%3A4131209321321323123e%2Fissue%2Fget-credential-manifest%3Fexchange_id%3D5f123eab4362bb2e%26credential_types%3DPastEmploymentPosition%26id%3DsecretId&inspectorDid=321123&providers=%5B%7B%22name%22%3A%22LinkedIn%22%2C%22logo%22%3A%22https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fa%2Faa%2FLinkedIn_2021.svg%22%2C%22category%22%3A%22Personal+Records%22%2C%22id%22%3A%22a9f1063c-06b7-476a-8410-9ff6e427e637%22%7D%2C%7B%22name%22%3A%22LinkedIn%22%2C%22logo%22%3A%22https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fa%2Faa%2FLinkedIn_2021.svg%22%2C%22category%22%3A%22Personal+Records%22%2C%22id%22%3A%22a9f1063c-06b7-476a-8410-9ff6e427e637%22%7D%5D';
+    expect(scriptTag.attr('data-deeplink')).toEqual(deeplink);
+    expect(scriptTag.attr('data-automode')).toEqual('');
+  });
+
+  it('should throw an error if claim.wizard and empty providers', async () => {
+    setupNock();
+    const url =
+      // eslint-disable-next-line max-len
+      'http%3A%2F%2Flocalhost.test%2Fapi%2Fholder%2Fv0.6%2Forg%2Fdid%3Aion%3A4131209321321323123e%2Fissue%2Fget-credential-manifest%3Fexchange_id%3D5f123eab4362bb2e%26credential_types%3DPastEmploymentPosition%26id%3DsecretId';
+    const response = await fastify.injectJson({
+      method: 'GET',
+      // eslint-disable-next-line max-len
+      url: `${appRedirectUrl}?request_uri=${url}&exchange_type=claim.wizard&inspectorDid=321123`,
+    });
+
+    expect(response.statusCode).toEqual(400);
+    expect(response.json.message).toEqual(
+      'providers parameter is required for exchange_type = "claim.wizard"'
+    );
+  });
 });