@cheqd/studio 3.16.0-develop.9 → 3.16.0

package/dist/controllers/api/received-credential.d.ts

@@ -0,0 +1,375 @@
+import type { Request, Response } from 'express';
+export declare class ReceivedCredentialController {
+    static listOffersValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdCredentials" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    static getOfferValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdCredentials" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    static acceptOfferValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdCredentials" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    static rejectOfferValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdCredentials" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    static importValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdCredentials" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    static listReceivedValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdCredentials" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    static getReceivedValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdCredentials" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    /**
+     * @openapi
+     *
+     * /credentials/offers:
+     *   get:
+     *     tags: [ Credential Offers ]
+     *     summary: List pending credential offers
+     *     description: Retrieves a list of pending credential offers. If holderDid is not provided, returns all offers for all DIDs owned by the customer.
+     *     parameters:
+     *       - in: query
+     *         name: holderDid
+     *         required: false
+     *         schema:
+     *           type: string
+     *         description: Optional DID of the credential holder. If not provided, returns offers for all customer DIDs.
+     *       - in: query
+     *         name: category
+     *         required: false
+     *         schema:
+     *           type: string
+     *           enum: [credential, accreditation]
+     *         description: Optional category to filter by credential type
+     *       - in: query
+     *         name: page
+     *         schema:
+     *           type: integer
+     *           minimum: 1
+     *           default: 1
+     *         description: Page number for pagination
+     *       - in: query
+     *         name: limit
+     *         schema:
+     *           type: integer
+     *           minimum: 1
+     *           maximum: 100
+     *           default: 10
+     *         description: Number of results per page
+     *     responses:
+     *       200:
+     *         description: List of pending credential offers
+     *         content:
+     *           application/json:
+     *             schema:
+     *               type: object
+     *               properties:
+     *                 total:
+     *                   type: integer
+     *                 offers:
+     *                   type: array
+     *                   items:
+     *                     $ref: '#/components/schemas/IssuedCredentialResponse'
+     *                 page:
+     *                   type: integer
+     *                 limit:
+     *                   type: integer
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    listOffers(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /credentials/offers/{credentialId}:
+     *   get:
+     *     tags: [ Credential Offers ]
+     *     summary: Get credential offer details
+     *     description: Retrieves detailed information about a specific credential offer
+     *     parameters:
+     *       - in: path
+     *         name: credentialId
+     *         required: true
+     *         schema:
+     *           type: string
+     *           format: uuid
+     *         description: ID of the credential offer
+     *       - in: query
+     *         name: holderDid
+     *         required: true
+     *         schema:
+     *           type: string
+     *         description: DID of the credential holder
+     *     responses:
+     *       200:
+     *         description: Credential offer details
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/IssuedCredentialResponse'
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       404:
+     *         description: Credential offer not found
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    getOfferDetails(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /credentials/offers/{credentialId}/accept:
+     *   post:
+     *     tags: [ Credential Offers ]
+     *     summary: Accept a credential offer
+     *     description: Accepts a pending credential offer. The credential is verified and status is updated to issued.
+     *     parameters:
+     *       - in: path
+     *         name: credentialId
+     *         required: true
+     *         schema:
+     *           type: string
+     *           format: uuid
+     *         description: ID of the credential offer to accept
+     *     requestBody:
+     *       required: true
+     *       content:
+     *         application/json:
+     *           schema:
+     *             type: object
+     *             required:
+     *               - holderDid
+     *             properties:
+     *               holderDid:
+     *                 type: string
+     *                 description: DID of the credential holder
+     *               createPresentation:
+     *                 type: boolean
+     *                 default: false
+     *                 description: Whether to create a verifiable presentation
+     *               presentationDomain:
+     *                 type: string
+     *                 description: Optional domain for the presentation
+     *     responses:
+     *       200:
+     *         description: Credential offer accepted successfully
+     *         content:
+     *           application/json:
+     *             schema:
+     *               type: object
+     *               properties:
+     *                 success:
+     *                   type: boolean
+     *                 credential:
+     *                   type: object
+     *                 presentation:
+     *                   type: string
+     *                   description: JWT presentation (if createPresentation was true)
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       404:
+     *         description: Credential offer not found
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    acceptOffer(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /credentials/offers/{credentialId}/reject:
+     *   post:
+     *     tags: [ Credential Offers ]
+     *     summary: Reject a credential offer
+     *     description: Rejects a pending credential offer. The credential is deleted and status is updated to rejected.
+     *     parameters:
+     *       - in: path
+     *         name: credentialId
+     *         required: true
+     *         schema:
+     *           type: string
+     *           format: uuid
+     *         description: ID of the credential offer to reject
+     *     requestBody:
+     *       required: true
+     *       content:
+     *         application/json:
+     *           schema:
+     *             type: object
+     *             required:
+     *               - holderDid
+     *             properties:
+     *               holderDid:
+     *                 type: string
+     *                 description: DID of the credential holder
+     *     responses:
+     *       200:
+     *         description: Credential offer rejected successfully
+     *         content:
+     *           application/json:
+     *             schema:
+     *               type: object
+     *               properties:
+     *                 success:
+     *                   type: boolean
+     *                 message:
+     *                   type: string
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       404:
+     *         description: Credential offer not found
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    rejectOffer(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /credentials/import:
+     *   post:
+     *     tags: [ Verifiable Credentials ]
+     *     summary: Import an externally issued credential
+     *     description: Imports a credential issued by a third party (not in Studio) and stores it in the holder's dataStore
+     *     requestBody:
+     *       required: true
+     *       content:
+     *         application/json:
+     *           schema:
+     *             type: object
+     *             required:
+     *               - credential
+     *               - holderDid
+     *             properties:
+     *               credential:
+     *                 oneOf:
+     *                   - type: object
+     *                     description: Verifiable credential as JSON object
+     *                   - type: string
+     *                     description: Verifiable credential as JWT string
+     *               holderDid:
+     *                 type: string
+     *                 description: DID of the credential holder
+     *     responses:
+     *       200:
+     *         description: Credential imported successfully
+     *         content:
+     *           application/json:
+     *             schema:
+     *               type: object
+     *               properties:
+     *                 success:
+     *                   type: boolean
+     *                 credentialHash:
+     *                   type: string
+     *                   description: Hash of the stored credential
+     *                 credential:
+     *                   type: object
+     *                   description: The imported credential
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    importCredential(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /credentials/received:
+     *   get:
+     *     tags: [ Verifiable Credentials ]
+     *     summary: List received credentials
+     *     description: Retrieves all credentials stored in the holder's dataStore (accepted offers + imported credentials)
+     *     parameters:
+     *       - in: query
+     *         name: holderDid
+     *         schema:
+     *           type: string
+     *         description: Optional DID to filter credentials by subject
+     *       - in: query
+     *         name: category
+     *         required: false
+     *         schema:
+     *           type: string
+     *           enum: [credential, accreditation]
+     *         description: Optional category to filter by credential type. Note that imported credentials without IssuedCredentialEntity will be excluded when filtering by category.
+     *       - in: query
+     *         name: page
+     *         schema:
+     *           type: integer
+     *           minimum: 1
+     *           default: 1
+     *         description: Page number for pagination
+     *       - in: query
+     *         name: limit
+     *         schema:
+     *           type: integer
+     *           minimum: 1
+     *           maximum: 100
+     *           default: 10
+     *         description: Number of results per page
+     *     responses:
+     *       200:
+     *         description: List of received credentials
+     *         content:
+     *           application/json:
+     *             schema:
+     *               type: object
+     *               properties:
+     *                 total:
+     *                   type: integer
+     *                   description: Total number of credentials
+     *                 credentials:
+     *                   type: array
+     *                   items:
+     *                     type: object
+     *                     properties:
+     *                       hash:
+     *                         type: string
+     *                         description: Hash of the credential
+     *                       credential:
+     *                         type: object
+     *                         description: Verifiable Credential
+     *                 page:
+     *                   type: integer
+     *                   description: Current page number
+     *                 limit:
+     *                   type: integer
+     *                   description: Number of results per page
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    listReceivedCredentials(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /credentials/received/{credentialHash}:
+     *   get:
+     *     tags: [ Verifiable Credentials ]
+     *     summary: Get a specific received credential
+     *     description: Retrieves a specific credential from the holder's dataStore by its hash
+     *     parameters:
+     *       - in: path
+     *         name: credentialHash
+     *         required: true
+     *         schema:
+     *           type: string
+     *         description: Hash of the credential
+     *     responses:
+     *       200:
+     *         description: Received credential
+     *         content:
+     *           application/json:
+     *             schema:
+     *               type: object
+     *               description: Verifiable Credential
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       404:
+     *         description: Credential not found
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    getReceivedCredential(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+}
+//# sourceMappingURL=received-credential.d.ts.map

package/dist/controllers/api/received-credential.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"received-credential.d.ts","sourceRoot":"","sources":["../../../src/controllers/api/received-credential.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAMjD,qBAAa,4BAA4B;IACxC,OAAc,mBAAmB,yTAc/B;IAEF,OAAc,iBAAiB,yTAe7B;IAEF,OAAc,oBAAoB,yTAsBhC;IAEF,OAAc,oBAAoB,yTAehC;IACF,OAAc,eAAe,yTAwB3B;IACF,OAAc,qBAAqB,yTAcjC;IACF,OAAc,oBAAoB,yTAQhC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6DG;IAEU,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IAuB5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEU,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IA0BjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IAEU,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IA8B7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IAEU,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IAsB7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IAEU,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IA0BlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEG;IAEU,uBAAuB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IAqBzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IAEU,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;CAoBvE"}