@cheqd/studio 3.0.0-develop.1

package/dist/controllers/api/presentation.js

@@ -0,0 +1,264 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { StatusCodes } from 'http-status-codes';
+import { check, query } from '../validator/index.js';
+import { IdentityServiceStrategySetup } from '../../services/identity/index.js';
+import { CheqdW3CVerifiablePresentation } from '../../services/w3c-presentation.js';
+import { isIssuerDidDeactivated } from '../../services/helpers.js';
+import { OperationCategoryNameEnum, OperationNameEnum } from '../../types/constants.js';
+import { eventTracker } from '../../services/track/tracker.js';
+import { validate } from '../validator/decorator.js';
+export class PresentationController {
+    static presentationCreateValidator = [
+        check('credentials')
+            .exists()
+            .withMessage('W3c verifiable credential was not provided')
+            .isW3CCheqdCredential()
+            .bail(),
+        check('holderDid').optional().isDID().bail(),
+        check('verifierDid').optional().isDID().bail(),
+        check('policies').optional().isObject().withMessage('Verification policies should be an object').bail(),
+    ];
+    static presentationVerifyValidator = [
+        check('presentation')
+            .exists()
+            .withMessage('W3c verifiable presentation was not provided')
+            .isW3CCheqdPresentation()
+            .bail(),
+        check('verifierDid').optional().isDID().bail(),
+        check('policies').optional().isObject().withMessage('Verification policies should be an object').bail(),
+        check('makeFeePayment')
+            .optional()
+            .isBoolean()
+            .withMessage('makeFeePayment: should be a boolean')
+            .toBoolean()
+            .bail(),
+        query('verifyStatus')
+            .optional()
+            .isBoolean()
+            .withMessage('verifyStatus should be a boolean value')
+            .toBoolean()
+            .bail(),
+        query('allowDeactivatedDid')
+            .optional()
+            .isBoolean()
+            .withMessage('allowDeactivatedDid should be a boolean value')
+            .toBoolean()
+            .bail(),
+        query('fetchRemoteContexts')
+            .optional()
+            .isBoolean()
+            .withMessage('fetchRemoteContexts should be a boolean value')
+            .toBoolean()
+            .bail(),
+    ];
+    /**
+     * @openapi
+     *
+     * /presentation/create:
+     *   post:
+     *     tags: [ Presentation ]
+     *     summary: "!!! WARN. Such endpoint is made mostly for testing purposes and it is not supposed to be used in production !!! Create a Verifiable Presentation from credential(s)."
+     *     description: "This endpoint creates a Verifiable Presentation from credential(s). As input, it can take the credential(s) as a string or the entire credential(s) itself. \n !!! WARN. Such endpoint is made only for testing purposes !!!"
+     *     requestBody:
+     *       content:
+     *         application/x-www-form-urlencoded:
+     *           schema:
+     *             $ref: '#/components/schemas/PresentationCreateRequest'
+     *         application/json:
+     *           schema:
+     *             $ref: '#/components/schemas/PresentationCreateRequest'
+     *     responses:
+     *       200:
+     *         description: The request was successful.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/PresentationCreateResult'
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    async createPresentation(request, response) {
+        const { credentials, holderDid, verifierDid } = request.body;
+        try {
+            const result = await new IdentityServiceStrategySetup(response.locals.customer.customerId).agent.createPresentation({
+                verifiableCredential: credentials,
+                holder: holderDid,
+            }, {
+                domain: verifierDid,
+            }, response.locals.customer);
+            if (result.error) {
+                return response.status(StatusCodes.BAD_REQUEST).json({
+                    error: result.error,
+                });
+            }
+            return response.status(StatusCodes.OK).json(result);
+        }
+        catch (error) {
+            return response.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
+                error: `Internal error: ${error?.message || error}`,
+            });
+        }
+    }
+    /**
+     * @openapi
+     *
+     * /presentation/verify:
+     *   post:
+     *     tags: [ Presentation ]
+     *     summary: Verify a Verifiable Presentation generated from credential(s).
+     *     description: This endpoint verifies the Verifiable Presentation generated from credential(s). As input, it can take the Verifiable Presentation JWT as a string or the entire Verifiable Presentation itself.
+     *     parameters:
+     *       - in: query
+     *         name: verifyStatus
+     *         description: If set to `true` the verification will also check the status of the presentation. Requires the VP to have a `credentialStatus` property.
+     *         schema:
+     *           type: boolean
+     *           default: false
+     *       - in: query
+     *         name: fetchRemoteContexts
+     *         description: When dealing with JSON-LD you also MUST provide the proper contexts. * Set this to `true` ONLY if you want the `@context` URLs to be fetched in case they are a custom context.
+     *         schema:
+     *           type: boolean
+     *           default: false
+     *       - in: query
+     *         name: allowDeactivatedDid
+     *         description: If set to `true` allow to verify credential which based on deactivated DID.
+     *         schema:
+     *           type: boolean
+     *           default: false
+     *     requestBody:
+     *       content:
+     *         application/x-www-form-urlencoded:
+     *           schema:
+     *             $ref: '#/components/schemas/PresentationVerifyRequest'
+     *         application/json:
+     *           schema:
+     *             $ref: '#/components/schemas/PresentationVerifyRequest'
+     *     responses:
+     *       200:
+     *         description: The request was successful.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/VerifyPresentationResult'
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    async verifyPresentation(request, response) {
+        // Set fee payment options
+        let feePaymentOptions = [];
+        // Make the base body for tracking
+        const trackInfo = {
+            name: OperationNameEnum.PRESENTATION_VERIFY,
+            category: OperationCategoryNameEnum.PRESENTATION,
+            customer: response.locals.customer,
+            user: response.locals.user,
+        };
+        // Extract request parameters from body
+        const { presentation, verifierDid, policies, makeFeePayment } = request.body;
+        // Extract request parameters from query
+        const { verifyStatus, allowDeactivatedDid } = request.query;
+        // Get strategy e.g. postgres or local
+        const identityServiceStrategySetup = new IdentityServiceStrategySetup(response.locals.customer.customerId);
+        // create cheqd presentation from w3c presentation
+        const cheqdPresentation = new CheqdW3CVerifiablePresentation(presentation);
+        try {
+            if (makeFeePayment) {
+                const setResult = await cheqdPresentation.trySetStatusList2021(identityServiceStrategySetup.agent);
+                if (setResult.error) {
+                    return response.status(setResult.status).send({
+                        error: setResult.error,
+                    });
+                }
+                if (cheqdPresentation.isPaymentNeeded()) {
+                    const feePaymentResult = await cheqdPresentation.makeFeePayment(identityServiceStrategySetup.agent, response.locals.customer);
+                    // Track fee payments
+                    feePaymentOptions = feePaymentResult.data;
+                    // handle error
+                    if (feePaymentResult.error) {
+                        // Fill track info
+                        trackInfo.feePaymentOptions = feePaymentOptions;
+                        trackInfo.data = {
+                            holder: cheqdPresentation.holder,
+                        };
+                        trackInfo.successful = false;
+                        // Track operation
+                        eventTracker.emit('track', trackInfo);
+                        // Return error
+                        return response.status(StatusCodes.BAD_REQUEST).json({
+                            error: `verify: payment: error: ${feePaymentResult.error}`,
+                        });
+                    }
+                }
+            }
+            if (!allowDeactivatedDid && (await isIssuerDidDeactivated(cheqdPresentation))) {
+                return response.status(StatusCodes.BAD_REQUEST).json({
+                    error: `Credential issuer DID is deactivated`,
+                });
+            }
+            // verify presentation
+            const result = await identityServiceStrategySetup.agent.verifyPresentation(cheqdPresentation, {
+                verifyStatus,
+                policies,
+                domain: verifierDid,
+            }, response.locals.customer);
+            // handle errors
+            if (result.error) {
+                return response.status(StatusCodes.BAD_REQUEST).json({
+                    verified: result.verified,
+                    error: `verify: ${result.error.message}`,
+                });
+            }
+            // track operation
+            trackInfo.data = {
+                holder: cheqdPresentation.holder,
+            };
+            trackInfo.feePaymentOptions = feePaymentOptions;
+            trackInfo.successful = true;
+            eventTracker.emit('track', trackInfo);
+            return response.status(StatusCodes.OK).json(result);
+        }
+        catch (error) {
+            // define error
+            const errorRef = error;
+            // handle doesn't meet condition
+            if (errorRef?.errorCode === 'NodeAccessControlConditionsReturnedNotAuthorized')
+                return response.status(StatusCodes.UNAUTHORIZED).json({
+                    error: `check: error: ${errorRef?.message
+                        ? 'unauthorised: decryption conditions are not met'
+                        : error.toString()}`,
+                });
+            // handle incorrect access control conditions
+            if (errorRef?.errorCode === 'incorrect_access_control_conditions')
+                return response.status(StatusCodes.BAD_REQUEST).json({
+                    error: `check: error: ${errorRef?.message
+                        ? 'incorrect access control conditions'
+                        : error.toString()}`,
+                });
+            // catch all other unhandled errors
+            return response.status(StatusCodes.INTERNAL_SERVER_ERROR).json({
+                error: `Internal error: ${error?.message || error}`,
+            });
+        }
+    }
+}
+__decorate([
+    validate
+], PresentationController.prototype, "createPresentation", null);
+__decorate([
+    validate
+], PresentationController.prototype, "verifyPresentation", null);
+//# sourceMappingURL=presentation.js.map

package/dist/controllers/api/presentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"presentation.js","sourceRoot":"","sources":["../../../src/controllers/api/presentation.ts"],"names":[],"mappings":";;;;;;AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAChF,OAAO,EAAE,8BAA8B,EAAE,MAAM,oCAAoC,CAAC;AAUpF,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAE/D,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAErD,MAAM,OAAO,sBAAsB;IAC3B,MAAM,CAAC,2BAA2B,GAAG;QAC3C,KAAK,CAAC,aAAa,CAAC;aAClB,MAAM,EAAE;aACR,WAAW,CAAC,4CAA4C,CAAC;aACzD,oBAAoB,EAAE;aACtB,IAAI,EAAE;QACR,KAAK,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE;QAC5C,KAAK,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE;QAC9C,KAAK,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAAC,IAAI,EAAE;KACvG,CAAC;IAEK,MAAM,CAAC,2BAA2B,GAAG;QAC3C,KAAK,CAAC,cAAc,CAAC;aACnB,MAAM,EAAE;aACR,WAAW,CAAC,8CAA8C,CAAC;aAC3D,sBAAsB,EAAE;aACxB,IAAI,EAAE;QACR,KAAK,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE;QAC9C,KAAK,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAAC,IAAI,EAAE;QACvG,KAAK,CAAC,gBAAgB,CAAC;aACrB,QAAQ,EAAE;aACV,SAAS,EAAE;aACX,WAAW,CAAC,qCAAqC,CAAC;aAClD,SAAS,EAAE;aACX,IAAI,EAAE;QACR,KAAK,CAAC,cAAc,CAAC;aACnB,QAAQ,EAAE;aACV,SAAS,EAAE;aACX,WAAW,CAAC,wCAAwC,CAAC;aACrD,SAAS,EAAE;aACX,IAAI,EAAE;QACR,KAAK,CAAC,qBAAqB,CAAC;aAC1B,QAAQ,EAAE;aACV,SAAS,EAAE;aACX,WAAW,CAAC,+CAA+C,CAAC;aAC5D,SAAS,EAAE;aACX,IAAI,EAAE;QACR,KAAK,CAAC,qBAAqB,CAAC;aAC1B,QAAQ,EAAE;aACV,SAAS,EAAE;aACX,WAAW,CAAC,+CAA+C,CAAC;aAC5D,SAAS,EAAE;aACX,IAAI,EAAE;KACR,CAAC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IAEU,AAAN,KAAK,CAAC,kBAAkB,CAAC,OAAgB,EAAE,QAAkB;QACnE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,IAAqC,CAAC;QAE9F,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,IAAI,4BAA4B,CACpD,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CACnC,CAAC,KAAK,CAAC,kBAAkB,CACzB;gBACC,oBAAoB,EAAE,WAAW;gBACjC,MAAM,EAAE,SAAS;aACjB,EACD;gBACC,MAAM,EAAE,WAAW;aACnB,EACD,QAAQ,CAAC,MAAM,CAAC,QAAQ,CACxB,CAAC;YACF,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAClB,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC;oBACpD,KAAK,EAAE,MAAM,CAAC,KAAK;iBACkC,CAAC,CAAC;YACzD,CAAC;YACD,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAA+C,CAAC,CAAC;QAC9F,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC;gBAC9D,KAAK,EAAE,mBAAoB,KAAe,EAAE,OAAO,IAAI,KAAK,EAAE;aACT,CAAC,CAAC;QACzD,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IAEU,AAAN,KAAK,CAAC,kBAAkB,CAAC,OAAgB,EAAE,QAAkB;QACnE,0BAA0B;QAC1B,IAAI,iBAAiB,GAAyB,EAAE,CAAC;QACjD,kCAAkC;QAClC,MAAM,SAAS,GAAG;YACjB,IAAI,EAAE,iBAAiB,CAAC,mBAAmB;YAC3C,QAAQ,EAAE,yBAAyB,CAAC,YAAY;YAChD,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;YAClC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI;SACP,CAAC;QAErB,uCAAuC;QACvC,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,IAAqC,CAAC;QAC9G,wCAAwC;QACxC,MAAM,EAAE,YAAY,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,KAAwC,CAAC;QAE/F,sCAAsC;QACtC,MAAM,4BAA4B,GAAG,IAAI,4BAA4B,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC3G,kDAAkD;QAClD,MAAM,iBAAiB,GAAG,IAAI,8BAA8B,CAAC,YAAY,CAAC,CAAC;QAE3E,IAAI,CAAC;YACJ,IAAI,cAAc,EAAE,CAAC;gBACpB,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAC,oBAAoB,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;gBACnG,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;oBACrB,OAAO,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;wBAC7C,KAAK,EAAE,SAAS,CAAC,KAAK;qBAC6B,CAAC,CAAC;gBACvD,CAAC;gBACD,IAAI,iBAAiB,CAAC,eAAe,EAAE,EAAE,CAAC;oBACzC,MAAM,gBAAgB,GAAG,MAAM,iBAAiB,CAAC,cAAc,CAC9D,4BAA4B,CAAC,KAAK,EAClC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CACxB,CAAC;oBACF,qBAAqB;oBACrB,iBAAiB,GAAG,gBAAgB,CAAC,IAAI,CAAC;oBAC1C,eAAe;oBACf,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;wBAC5B,kBAAkB;wBAClB,SAAS,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;wBAChD,SAAS,CAAC,IAAI,GAAG;4BAChB,MAAM,EAAE,iBAAiB,CAAC,MAAM;yBACH,CAAC;wBAC/B,SAAS,CAAC,UAAU,GAAG,KAAK,CAAC;wBAC7B,kBAAkB;wBAClB,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,SAAmC,CAAC,CAAC;wBAEhE,eAAe;wBACf,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC;4BACpD,KAAK,EAAE,2BAA2B,gBAAgB,CAAC,KAAK,EAAE;yBACP,CAAC,CAAC;oBACvD,CAAC;gBACF,CAAC;YACF,CAAC;YACD,IAAI,CAAC,mBAAmB,IAAI,CAAC,MAAM,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC;gBAC/E,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC;oBACpD,KAAK,EAAE,sCAAsC;iBACM,CAAC,CAAC;YACvD,CAAC;YACD,sBAAsB;YACtB,MAAM,MAAM,GAAG,MAAM,4BAA4B,CAAC,KAAK,CAAC,kBAAkB,CACzE,iBAAiB,EACjB;gBACC,YAAY;gBACZ,QAAQ;gBACR,MAAM,EAAE,WAAW;aACnB,EACD,QAAQ,CAAC,MAAM,CAAC,QAAQ,CACxB,CAAC;YACF,gBAAgB;YAChB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAClB,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC;oBACpD,QAAQ,EAAE,MAAM,CAAC,QAAQ;oBACzB,KAAK,EAAE,WAAW,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE;iBACW,CAAC,CAAC;YACvD,CAAC;YACD,kBAAkB;YAClB,SAAS,CAAC,IAAI,GAAG;gBAChB,MAAM,EAAE,iBAAiB,CAAC,MAAM;aACH,CAAC;YAC/B,SAAS,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;YAChD,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC;YAE5B,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,SAAmC,CAAC,CAAC;YAEhE,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAA+C,CAAC,CAAC;QAC9F,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,eAAe;YACf,MAAM,QAAQ,GAAG,KAAgC,CAAC;YAClD,gCAAgC;YAChC,IAAI,QAAQ,EAAE,SAAS,KAAK,kDAAkD;gBAC7E,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC;oBACrD,KAAK,EAAE,iBACN,QAAQ,EAAE,OAAO;wBAChB,CAAC,CAAC,iDAAiD;wBACnD,CAAC,CAAE,KAAiC,CAAC,QAAQ,EAC/C,EAAE;iBACiD,CAAC,CAAC;YACvD,6CAA6C;YAC7C,IAAI,QAAQ,EAAE,SAAS,KAAK,qCAAqC;gBAChE,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC;oBACpD,KAAK,EAAE,iBACN,QAAQ,EAAE,OAAO;wBAChB,CAAC,CAAC,qCAAqC;wBACvC,CAAC,CAAE,KAAiC,CAAC,QAAQ,EAC/C,EAAE;iBACiD,CAAC,CAAC;YACvD,mCAAmC;YACnC,OAAO,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC;gBAC9D,KAAK,EAAE,mBAAoB,KAAe,EAAE,OAAO,IAAI,KAAK,EAAE;aACX,CAAC,CAAC;QACvD,CAAC;IACF,CAAC;;AA/LY;IADZ,QAAQ;gEA4BR;AAoDY;IADZ,QAAQ;gEAiHR"}

package/dist/controllers/api/resource.d.ts

@@ -0,0 +1,118 @@
+import type { Request, Response } from 'express';
+export declare class ResourceController {
+    static createResourceValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    static searchResourceValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    /**
+     * @openapi
+     *
+     * /resource/create/{did}:
+     *   post:
+     *     tags: [ Resource ]
+     *     summary: Create a DID-Linked Resource.
+     *     description: This endpoint creates a DID-Linked Resource. As input, it can take the DID identifier and the resource parameters via a form, or the fully-assembled resource itself.
+     *     parameters:
+     *       - in: path
+     *         name: did
+     *         description: DID identifier to link the resource to.
+     *         schema:
+     *           type: string
+     *         required: true
+     *     requestBody:
+     *       content:
+     *         application/x-www-form-urlencoded:
+     *             schema:
+     *               $ref: '#/components/schemas/CreateResourceRequest'
+     *         application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/CreateResourceRequest'
+     *     responses:
+     *       200:
+     *         description: The request was successful.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/ResourceMetadata'
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    createResource(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /resource/search/{did}:
+     *   get:
+     *     tags: [ Resource ]
+     *     summary: Get a DID-Linked Resource.
+     *     description: This endpoint returns the DID-Linked Resource for a given DID identifier and resource identifier.
+     *     parameters:
+     *       - in: path
+     *         name: did
+     *         description: DID identifier
+     *         schema:
+     *           type: string
+     *         required: true
+     *         example: did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0
+     *       - in: query
+     *         name: resourceId
+     *         description: Fetch a DID-Linked Resource by Resource ID unique identifier. Since this is a unique identifier, other Resource query parameters are not required. See <a href="https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition">DID-Linked Resources</a> for more details.
+     *         schema:
+     *           type: string
+     *           format: uuid
+     *         example: 3ccde6ba-6ba5-56f2-9f4f-8825561a9860
+     *       - in: query
+     *         name: resourceName
+     *         description: Filter a DID-Linked Resource query by Resource Name. See <a href="https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition">DID-Linked Resources</a> for more details.
+     *         schema:
+     *           type: string
+     *         example: cheqd-issuer-logo
+     *       - in: query
+     *         name: resourceType
+     *         description: Filter a DID-Linked Resource query by Resource Type. See <a href="https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition">DID-Linked Resources</a> for more details.
+     *         schema:
+     *           type: string
+     *         example: CredentialArtwork
+     *       - in: query
+     *         name: resourceVersion
+     *         description: Filter a DID-Linked Resource query by Resource Version, which is an optional free-text field used by issuers (e.g., "v1", "Final Version", "1st January 1970" etc). See <a href="https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition">DID-Linked Resources</a> for more details.
+     *         schema:
+     *           type: string
+     *         example: v1
+     *       - in: query
+     *         name: resourceVersionTime
+     *         description: Filter a DID-Linked Resource query which returns the closest version of the Resource *at* or *before* specified time. See <a href="https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition">DID-Linked Resources</a> for more details.
+     *         schema:
+     *           type: string
+     *           format: date-time
+     *         example: 1970-01-01T00:00:00Z
+     *       - in: query
+     *         name: checksum
+     *         description: Request integrity check against a given DID-Linked Resource by providing a SHA-256 checksum hash. See <a href="https://docs.cheqd.io/identity/credential-service/did-linked-resources/understanding-dlrs/technical-composition">DID-Linked Resources</a> for more details.
+     *         schema:
+     *           type: string
+     *         example: dc64474d062ed750a66bad58cb609928de55ed0d81defd231a4a4bf97358e9ed
+     *       - in: query
+     *         name: resourceMetadata
+     *         description: Return only metadata of DID-Linked Resource instead of actual DID-Linked Resource. Mutually exclusive with some of the other parameters.
+     *         schema:
+     *           type: boolean
+     *     responses:
+     *       200:
+     *         description: The request was successful.
+     *         content:
+     *           any:
+     *             schema:
+     *               type: object
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    searchResource(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+}
+//# sourceMappingURL=resource.d.ts.map

package/dist/controllers/api/resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../../src/controllers/api/resource.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAuBjD,qBAAa,kBAAkB;IAC9B,OAAc,uBAAuB,+RAiCnC;IAEF,OAAc,uBAAuB,+RA8CnC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IAEU,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IAiFhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IAEU,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;CA2BhE"}