@cheqd/studio 3.7.0 → 3.8.0-develop.1

package/dist/controllers/api/credential-status.js

@@ -8,8 +8,8 @@ import { check, query } from '../validator/index.js';
 import { fromString } from 'uint8arrays';
 import { StatusCodes } from 'http-status-codes';
 import { IdentityServiceStrategySetup } from '../../services/identity/index.js';
-import { DefaultStatusActionPurposeMap, DefaultStatusActions, } from '../../types/credential-status.js';
-import { DefaultStatusList2021Encodings, DefaultStatusList2021StatusPurposeTypes, } from '@cheqd/did-provider-cheqd';
+import { DefaultStatusActionPurposeMap, DefaultStatusActions, StatusListType, } from '../../types/credential-status.js';
+import { DefaultStatusListEncodings, DefaultStatusList2021StatusPurposeTypes, BitstringStatusPurposeTypes, } from '@cheqd/did-provider-cheqd';
 import { toNetwork } from '../../helpers/helpers.js';
 import { eventTracker } from '../../services/track/tracker.js';
 import { OperationCategoryNameEnum, OperationNameEnum } from '../../types/constants.js';
@@ -18,15 +18,69 @@ import { validate } from '../validator/decorator.js';
 export class CredentialStatusController {
     static createUnencryptedValidator = [
         check('did').exists().withMessage('did: required').bail().isDID(),
-        check('statusPurpose')
+        check('listType')
             .exists()
-            .withMessage('statusPurpose: required')
+            .withMessage('listType: required')
             .bail()
             .isString()
-            .withMessage('statusPurpose: should be a string')
+            .withMessage('listType: should be a string')
             .bail()
-            .isIn(Object.keys(DefaultStatusList2021StatusPurposeTypes))
-            .withMessage(`statusPurpose: invalid statusPurpose, should be one of ${Object.keys(DefaultStatusList2021StatusPurposeTypes).join(', ')}`)
+            .isIn([StatusListType.Bitstring, StatusListType.StatusList2021])
+            .withMessage(`listType: invalid listType, should be one of [${Object.values(StatusListType)
+            .map((v) => `'${v}'`)
+            .join(', ')}]`)
+            .bail(),
+        check('statusPurpose')
+            .exists()
+            .withMessage('statusPurpose: required')
+            .bail()
+            .custom((value, { req }) => {
+            const listType = req.query?.listType || req.body.listType;
+            let purposes = [];
+            // Normalize input to array
+            if (typeof value === 'string') {
+                purposes = value
+                    .split(',')
+                    .map((p) => p.trim())
+                    .filter((p) => p);
+            }
+            else if (Array.isArray(value)) {
+                purposes = value;
+            }
+            else {
+                throw new Error('statusPurpose: should be a string or array');
+            }
+            // Check if multiple purposes are allowed for this listType
+            if (purposes.length > 1 && listType === StatusListType.StatusList2021) {
+                throw new Error('statusPurpose: multiple values only allowed for BitstringStatusList');
+            }
+            // Validate array is not empty
+            if (purposes.length === 0) {
+                throw new Error('statusPurpose: cannot be empty');
+            }
+            if (listType === StatusListType.StatusList2021) {
+                const validPurposes = Object.keys(DefaultStatusList2021StatusPurposeTypes);
+                // Check for valid purposes
+                const invalidPurposes = purposes.filter((purpose) => !validPurposes.includes(purpose));
+                if (invalidPurposes.length > 0) {
+                    throw new Error(`statusPurpose: invalid statusPurpose(s) "${invalidPurposes.join(', ')}", should be one of ${validPurposes.join(', ')}`);
+                }
+            }
+            else {
+                const validPurposes = Object.keys(BitstringStatusPurposeTypes);
+                // Check for valid purposes
+                const invalidPurposes = purposes.filter((purpose) => !validPurposes.includes(purpose));
+                if (invalidPurposes.length > 0) {
+                    throw new Error(`statusPurpose: invalid statusPurpose(s) "${invalidPurposes.join(', ')}", should be one of ${validPurposes.join(', ')}`);
+                }
+            }
+            // Check for duplicates
+            const uniquePurposes = [...new Set(purposes)];
+            if (uniquePurposes.length !== purposes.length) {
+                throw new Error('statusPurpose: duplicate values not allowed');
+            }
+            return true;
+        })
             .bail(),
         check('statusListName')
             .exists()
@@ -70,8 +124,56 @@ export class CredentialStatusController {
             .bail(),
         check('encoding')
             .optional()
-            .isIn(Object.keys(DefaultStatusList2021Encodings))
-            .withMessage(`encoding: invalid encoding, should be one of ${Object.keys(DefaultStatusList2021Encodings).join(', ')}`)
+            .custom((value, { req }) => {
+            const listType = req.query?.listType || req.body.listType;
+            if (listType === StatusListType.StatusList2021) {
+                if (!Object.values(DefaultStatusListEncodings).includes(value)) {
+                    throw new Error(`encoding: invalid encoding, should be one of ${Object.keys(DefaultStatusListEncodings).join(', ')}`);
+                }
+            }
+            else {
+                if (value !== DefaultStatusListEncodings.base64url) {
+                    throw new Error(`encoding: invalid encoding, should be base64url for BitstringStatusList`);
+                }
+            }
+            return true;
+        })
+            .bail(),
+        check('statusSize')
+            .optional()
+            .isNumeric()
+            .withMessage('statusSize: should be a number')
+            .bail()
+            .custom((value) => {
+            const val = parseInt(value.toString(), 10);
+            return !isNaN(val) && isFinite(val) && Number.isInteger(val);
+        })
+            .custom((value) => {
+            const val = parseInt(value.toString(), 10);
+            return val >= 1 && val <= 8;
+        })
+            .withMessage('statusSize: should be an integer between 1 and 8')
+            .bail(),
+        check('statusMessages')
+            .optional()
+            .isArray()
+            .withMessage('statusMessages: should be an array')
+            .bail()
+            .custom((value) => Array.isArray(value) && value.length > 0)
+            .withMessage('statusMessages: should be a non-empty array')
+            .bail()
+            .custom((value) => value.every((item) => typeof item?.status === 'string' && typeof item?.message === 'string'))
+            .withMessage('statusMessages: should be an array of objects with `status` and `message` properties of type string')
+            .bail()
+            .custom((value, { req }) => {
+            const sizeRaw = req.query?.statusSize || req.body?.statusSize;
+            const size = parseInt(sizeRaw?.toString(), 10);
+            if (isNaN(size) || size <= 1) {
+                return true; // If size is 1 or undefined, skip this check
+            }
+            return value.length === Math.pow(2, size);
+        })
+            .withMessage('statusMessages: array size must be 2^statusSize when statusSize > 1')
             .bail(),
         check('encodedList').optional().isString().withMessage('encodedList: should be a string').bail(),
     ];
@@ -160,6 +262,18 @@ export class CredentialStatusController {
     ];
     static updateUnencryptedValidator = [
         check('did').exists().withMessage('did: required').bail().isDID().bail(),
+        check('listType')
+            .exists()
+            .withMessage('listType: required')
+            .bail()
+            .isString()
+            .withMessage('listType: should be a string')
+            .bail()
+            .isIn([StatusListType.Bitstring, StatusListType.StatusList2021])
+            .withMessage(`listType: invalid listType, should be one of [${Object.values(StatusListType)
+            .map((v) => `'${v}'`)
+            .join(', ')}]`)
+            .bail(),
         check('statusAction')
             .exists()
             .withMessage('statusAction: required')
@@ -343,6 +457,17 @@ export class CredentialStatusController {
             .notEmpty()
             .withMessage('statusListName: should be a non-empty string')
             .bail(),
+        query('listType')
+            .exists()
+            .withMessage('listType: required')
+            .bail()
+            .isString()
+            .withMessage('listType: should be a string')
+            .bail()
+            .isIn([StatusListType.Bitstring, StatusListType.StatusList2021])
+            .withMessage(`listType: invalid listType, should be one of [${Object.values(StatusListType)
+            .map((v) => `'${v}'`)
+            .join(', ')}]`),
         query('statusPurpose')
             .exists()
             .withMessage('statusPurpose: required')
@@ -363,18 +488,47 @@ export class CredentialStatusController {
      * /credential-status/create/unencrypted:
      *   post:
      *     tags: [ Credential Status ]
-     *     summary: Create an unencrypted StatusList2021 credential status list.
-     *     description: This endpoint creates an unencrypted StatusList2021 credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted; and with purpose as either revocation or suspension.
+     *     summary: Create an unencrypted StatusList2021 or BitstringStatusList credential status list.
+     *     description: This endpoint creates an unencrypted StatusList2021 or BitstringStatusList credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted.
      *     parameters:
      *       - in: query
-     *         name: statusPurpose
-     *         description: The purpose of the status list. Can be either revocation or suspension. Once this is set, it cannot be changed. A new status list must be created to change the purpose.
+     *         name: listType
+     *         description: The type of Status List.
      *         required: true
      *         schema:
      *           type: string
      *           enum:
-     *             - revocation
-     *             - suspension
+     *             - StatusList2021
+     *             - BitstringStatusList
+     *       - in: query
+     *         name: statusPurpose
+     *         description: |
+     *           The purpose of the status list.
+     *           - For StatusList2021: Single value (revocation or suspension)
+     *           - For BitstringStatusList: Can accept multiple values as array of strings
+     *
+     *           Once this is set, it cannot be changed. A new status list must be created to change the purpose.
+     *         required: true
+     *         schema:
+     *           oneOf:
+     *             - type: string
+     *               enum:
+     *                 - revocation
+     *                 - suspension
+     *             - type: array
+     *               items:
+     *                 type: string
+     *                 enum: [revocation, suspension, message, refresh]
+     *         examples:
+     *           single_value:
+     *             summary: Single purpose (StatusList2021)
+     *             value: "revocation"
+     *           multiple_values_array:
+     *             summary: Multiple purposes as array (BitstringStatusList)
+     *             value: ["revocation", "suspension", "message"]
+     *           with_message:
+     *             summary: Including message purpose
+     *             value: ["revocation", "message"]
      *     requestBody:
      *       content:
      *         application/x-www-form-urlencoded:
@@ -399,9 +553,9 @@ export class CredentialStatusController {
      */
     async createUnencryptedStatusList(request, response) {
         // collect request parameters - case: body
-        const { did, encodedList, statusListName, alsoKnownAs, statusListVersion, length, encoding } = request.body;
+        const { did, encodedList, statusListName, alsoKnownAs, statusListVersion, length, encoding, statusSize: size, ttl, statusMessages, } = request.body;
         // collect request parameters - case: query
-        const { statusPurpose } = request.query;
+        const { listType, statusPurpose } = request.query;
         // define broadcast mode
         const data = encodedList ? fromString(encodedList, encoding) : undefined;
         // create agent
@@ -409,19 +563,44 @@ export class CredentialStatusController {
         try {
             // broadcast, if applicable
             if (data) {
-                const result = await identityServiceStrategySetup.agent.broadcastStatusList2021(did, { data, name: statusListName, alsoKnownAs, version: statusListVersion }, { encoding, statusPurpose }, response.locals.customer);
+                let result;
+                if (listType === StatusListType.Bitstring) {
+                    result = await identityServiceStrategySetup.agent.broadcastBitstringStatusList(did, { data, name: statusListName, alsoKnownAs, version: statusListVersion }, response.locals.customer);
+                }
+                else {
+                    result = await identityServiceStrategySetup.agent.broadcastStatusList2021(did, { data, name: statusListName, alsoKnownAs, version: statusListVersion }, { encoding, statusPurpose }, response.locals.customer);
+                }
                 return response.status(StatusCodes.OK).json(result);
             }
+            let result;
             // create unencrypted status list
-            const result = (await identityServiceStrategySetup.agent.createUnencryptedStatusList2021(did, {
-                name: statusListName,
-                alsoKnownAs,
-                version: statusListVersion,
-            }, {
-                length,
-                encoding,
-                statusPurpose,
-            }, response.locals.customer));
+            if (listType === StatusListType.Bitstring) {
+                // create BitstringStatusList
+                result = (await identityServiceStrategySetup.agent.createUnencryptedBitstringStatusList(did, {
+                    name: statusListName,
+                    alsoKnownAs,
+                    version: statusListVersion,
+                }, {
+                    length,
+                    size,
+                    statusMessages,
+                    ttl,
+                    encoding,
+                    statusPurpose,
+                }, response.locals.customer));
+            }
+            else {
+                // create StatusList2021
+                result = (await identityServiceStrategySetup.agent.createUnencryptedStatusList2021(did, {
+                    name: statusListName,
+                    alsoKnownAs,
+                    version: statusListVersion,
+                }, {
+                    length,
+                    encoding,
+                    statusPurpose,
+                }, response.locals.customer));
+            }
             // handle error
             if (result.error) {
                 return response.status(StatusCodes.BAD_REQUEST).json({
@@ -460,18 +639,47 @@ export class CredentialStatusController {
      * /credential-status/create/encrypted:
      *   post:
      *     tags: [ Credential Status ]
-     *     summary: Create an encrypted StatusList2021 credential status list.
-     *     description: This endpoint creates an encrypted StatusList2021 credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted; and with purpose as either revocation or suspension.
+     *     summary: Create an encrypted StatusList2021 or BitstringStatusList credential status list.
+     *     description: This endpoint creates an encrypted StatusList2021 or BitstringStatusList credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted.
      *     parameters:
      *       - in: query
-     *         name: statusPurpose
-     *         description: The purpose of the status list. Can be either revocation or suspension. Once this is set, it cannot be changed. A new status list must be created to change the purpose.
+     *         name: listType
+     *         description: The type of Status List.
      *         required: true
      *         schema:
      *           type: string
      *           enum:
-     *             - revocation
-     *             - suspension
+     *             - StatusList2021
+     *             - BitstringStatusList
+     *       - in: query
+     *         name: statusPurpose
+     *         description: |
+     *           The purpose of the status list.
+     *           - For StatusList2021: Single value (revocation or suspension)
+     *           - For BitstringStatusList: Can accept multiple values as array of strings
+     *
+     *           Once this is set, it cannot be changed. A new status list must be created to change the purpose.
+     *         required: true
+     *         schema:
+     *           oneOf:
+     *             - type: string
+     *               enum:
+     *                 - revocation
+     *                 - suspension
+     *             - type: array
+     *               items:
+     *                 type: string
+     *                 enum: [revocation, suspension, message, refresh]
+     *         examples:
+     *           single_value:
+     *             summary: Single purpose (StatusList2021)
+     *             value: "revocation"
+     *           multiple_values_array:
+     *             summary: Multiple purposes as array (BitstringStatusList)
+     *             value: ["revocation", "suspension", "message"]
+     *           with_message:
+     *             summary: Including message purpose
+     *             value: ["revocation", "message"]
      *     requestBody:
      *       content:
      *         application/x-www-form-urlencoded:
@@ -496,25 +704,48 @@ export class CredentialStatusController {
      */
     async createEncryptedStatusList(request, response) {
         // collect request parameters - case: body
-        const { did, statusListName, alsoKnownAs, statusListVersion, length, encoding, paymentConditions, feePaymentAddress, feePaymentAmount, feePaymentWindow, } = request.body;
+        const { did, statusListName, alsoKnownAs, statusListVersion, length, statusSize: size, ttl, statusMessages, encoding, paymentConditions, feePaymentAddress, feePaymentAmount, feePaymentWindow, } = request.body;
         // collect request parameters - case: query
-        const { statusPurpose } = request.query;
+        const { listType, statusPurpose } = request.query;
         const identityServiceStrategySetup = new IdentityServiceStrategySetup(response.locals.customer.customerId);
+        let result;
         try {
             // create encrypted status list
-            const result = (await identityServiceStrategySetup.agent.createEncryptedStatusList2021(did, {
-                name: statusListName,
-                alsoKnownAs,
-                version: statusListVersion,
-            }, {
-                length,
-                encoding,
-                statusPurpose,
-                paymentConditions,
-                feePaymentAddress,
-                feePaymentAmount,
-                feePaymentWindow,
-            }, response.locals.customer));
+            if (listType === StatusListType.Bitstring) {
+                // create BitstringStatusList
+                result = (await identityServiceStrategySetup.agent.createEncryptedBitstringStatusList(did, {
+                    name: statusListName,
+                    alsoKnownAs,
+                    version: statusListVersion,
+                }, {
+                    length,
+                    size,
+                    statusMessages,
+                    ttl,
+                    encoding,
+                    statusPurpose,
+                    paymentConditions,
+                    feePaymentAddress,
+                    feePaymentAmount,
+                    feePaymentWindow,
+                }, response.locals.customer));
+            }
+            else {
+                // create StatusList2021
+                result = (await identityServiceStrategySetup.agent.createEncryptedStatusList2021(did, {
+                    name: statusListName,
+                    alsoKnownAs,
+                    version: statusListVersion,
+                }, {
+                    length,
+                    encoding,
+                    statusPurpose,
+                    paymentConditions,
+                    feePaymentAddress,
+                    feePaymentAmount,
+                    feePaymentWindow,
+                }, response.locals.customer));
+            }
             // handle error
             if (result.error) {
                 return response.status(StatusCodes.BAD_REQUEST).json({
@@ -555,9 +786,18 @@ export class CredentialStatusController {
      * /credential-status/update/unencrypted:
      *   post:
      *     tags: [ Credential Status ]
-     *     summary: Update an existing unencrypted StatusList2021 credential status list.
+     *     summary: Update an existing unencrypted StatusList2021 or BitstringStatusList credential status list.
      *     parameters:
      *       - in: query
+     *         name: listType
+     *         description: The type of Status List.
+     *         required: true
+     *         schema:
+     *           type: string
+     *           enum:
+     *             - StatusList2021
+     *             - BitstringStatusList
+     *       - in: query
      *         name: statusAction
      *         description: The update action to be performed on the unencrypted status list, can be revoke, suspend or reinstate
      *         required: true
@@ -593,11 +833,11 @@ export class CredentialStatusController {
         // collect request parameters - case: body
         const { did, statusListName, statusListVersion, indices } = request.body;
         // collect request parameters - case: query
-        const { statusAction } = request.query;
+        const { statusAction, listType } = request.query;
         // define identity service strategy setup
         const identityServiceStrategySetup = new IdentityServiceStrategySetup(response.locals.customer.customerId);
         // ensure unencrypted status list
-        const unencrypted = await identityServiceStrategySetup.agent.searchStatusList2021(did, statusListName, DefaultStatusActionPurposeMap[statusAction]);
+        const unencrypted = await identityServiceStrategySetup.agent.searchStatusList(did, statusListName, listType, DefaultStatusActionPurposeMap[statusAction]);
         // handle error
         if (unencrypted.error) {
             // handle notFound error
@@ -621,7 +861,7 @@ export class CredentialStatusController {
             });
         try {
             // update unencrypted status list
-            const result = (await identityServiceStrategySetup.agent.updateUnencryptedStatusList2021(did, {
+            const result = (await identityServiceStrategySetup.agent.updateUnencryptedStatusList(did, listType, {
                 indices: typeof indices === 'number' ? [indices] : indices,
                 statusListName,
                 statusListVersion,
@@ -692,9 +932,18 @@ export class CredentialStatusController {
      * /credential-status/update/encrypted:
      *   post:
      *     tags: [ Credential Status ]
-     *     summary: Update an existing encrypted StatusList2021 credential status list.
+     *     summary: Update an existing encrypted StatusList2021 or BitstringStatusList credential status list.
      *     parameters:
      *       - in: query
+     *         name: listType
+     *         description: The type of Status List.
+     *         required: true
+     *         schema:
+     *           type: string
+     *           enum:
+     *             - StatusList2021
+     *             - BitstringStatusList
+     *       - in: query
      *         name: statusAction
      *         description: The update action to be performed on the encrypted status list, can be revoke, suspend or reinstate
      *         required: true
@@ -730,11 +979,11 @@ export class CredentialStatusController {
         // collect request parameters - case: body
         const { did, statusListName, statusListVersion, indices, symmetricKey, paymentConditions, feePaymentAddress, feePaymentAmount, feePaymentWindow, } = request.body;
         // collect request parameters - case: query
-        const { statusAction } = request.query;
+        const { statusAction, listType } = request.query;
         // define identity service strategy setup
         const identityServiceStrategySetup = new IdentityServiceStrategySetup(response.locals.customer.customerId);
         // ensure encrypted status list
-        const encrypted = await identityServiceStrategySetup.agent.searchStatusList2021(did, statusListName, DefaultStatusActionPurposeMap[statusAction]);
+        const encrypted = await identityServiceStrategySetup.agent.searchStatusList(did, statusListName, listType, DefaultStatusActionPurposeMap[statusAction]);
         // handle error
         if (encrypted.error) {
             // handle notFound error
@@ -758,7 +1007,7 @@ export class CredentialStatusController {
             });
         try {
             // update encrypted status list
-            const result = (await identityServiceStrategySetup.agent.updateEncryptedStatusList2021(did, {
+            const result = (await identityServiceStrategySetup.agent.updateEncryptedStatusList(did, listType, {
                 indices: typeof indices === 'number' ? [indices] : indices,
                 statusListName,
                 statusListVersion,
@@ -886,7 +1135,7 @@ export class CredentialStatusController {
         // define identity service strategy setup
         const identityServiceStrategySetup = new IdentityServiceStrategySetup(response.locals.customer.customerId);
         // ensure status list
-        const statusList = await identityServiceStrategySetup.agent.searchStatusList2021(did, statusListName, statusPurpose);
+        const statusList = await identityServiceStrategySetup.agent.searchStatusList(did, statusListName, StatusListType.StatusList2021, statusPurpose);
         // handle error
         if (statusList.error) {
             // handle notFound error
@@ -991,7 +1240,7 @@ export class CredentialStatusController {
      * /credential-status/search:
      *   get:
      *     tags: [ Credential Status ]
-     *     summary: Fetch StatusList2021 DID-Linked Resource based on search criteria.
+     *     summary: Fetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.
      *     parameters:
      *       - in: query
      *         name: did
@@ -1000,8 +1249,18 @@ export class CredentialStatusController {
      *         schema:
      *           type: string
      *       - in: query
+     *         name: listType
+     *         description: The type of Status List.
+     *         required: true
+     *         schema:
+     *           type: string
+     *           enum:
+     *             - StatusList2021
+     *             - BitstringStatusList
+     *       - in: query
      *         name: statusPurpose
      *         description: The purpose of the status list. Can be either revocation or suspension.
+     *         required: true
      *         schema:
      *           type: string
      *           enum:
@@ -1009,7 +1268,8 @@ export class CredentialStatusController {
      *             - suspension
      *       - in: query
      *         name: statusListName
-     *         description: The name of the StatusList2021 DID-Linked Resource.
+     *         description: The name of the Status List DID-Linked Resource.
+     *         required: true
      *         schema:
      *           type: string
      *     responses:
@@ -1028,10 +1288,10 @@ export class CredentialStatusController {
      */
     async searchStatusList(request, response) {
         // collect request parameters - case: query
-        const { did, statusListName, statusPurpose } = request.query;
+        const { did, statusListName, listType, statusPurpose } = request.query;
         try {
             // search status list
-            const result = await new IdentityServiceStrategySetup().agent.searchStatusList2021(did, statusListName, statusPurpose);
+            const result = await new IdentityServiceStrategySetup().agent.searchStatusList(did, statusListName, listType, statusPurpose);
             // handle error
             if (result.error) {
                 // handle notFound error