@cheqd/studio 3.0.0-develop.1

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

@@ -0,0 +1,259 @@
+import type { Request, Response } from 'express';
+export declare class DIDController {
+    static createDIDValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    static updateDIDValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    static deactivateDIDValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    static importDIDValidator: import("express-validator").ValidationChainWithExtensions<"isDID" | "isDIDArray" | "isDIDDocument" | "isVerificationMethod" | "isCreateDIDDocumentService" | "isService" | "isCheqdDidLinkedAlsoKnownAs" | "isKeyDID" | "isW3CCheqdCredential" | "isW3CCheqdPresentation" | "isVeridaDID">[];
+    /**
+     * @openapi
+     *
+     * /did/create:
+     *   post:
+     *     tags: [ DID ]
+     *     summary: Create a DID Document.
+     *     description: This endpoint creates a DID and associated DID Document. As input, it can take the DID Document parameters via a form, or the fully-assembled DID Document itself.
+     *     requestBody:
+     *       content:
+     *         application/x-www-form-urlencoded:
+     *           schema:
+     *             $ref: '#/components/schemas/DidCreateRequestFormBased'
+     *         application/json:
+     *           schema:
+     *             $ref: '#/components/schemas/DidCreateRequestJson'
+     *     responses:
+     *       200:
+     *         description: The request was successful.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/DidResult'
+     *       400:
+     *         description: A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/InvalidRequest'
+     *             example:
+     *               error: InvalidRequest
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         description: An internal error has occurred. Additional state information plus metadata may be available in the response body.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/InvalidRequest'
+     *             example:
+     *               error: Internal Error
+     */
+    createDid(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /did/update:
+     *   post:
+     *     tags: [ DID ]
+     *     summary: Update a DID Document.
+     *     description: This endpoint updates a DID Document. As an input, it can take JUST the sections/parameters that need to be updated in the DID Document (in this scenario, it fetches the current DID Document and applies the updated section). Alternatively, it take the fully-assembled DID Document with updated sections as well as unchanged sections.
+     *     requestBody:
+     *       content:
+     *         application/x-www-form-urlencoded:
+     *           schema:
+     *             $ref: '#/components/schemas/DidUpdateRequest'
+     *         application/json:
+     *           schema:
+     *             $ref: '#/components/schemas/DidUpdateRequest'
+     *     responses:
+     *       200:
+     *         description: The request was successful.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/DidUpdateResponse'
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    updateDid(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /did/import:
+     *   post:
+     *     tags: [ DID ]
+     *     summary: Import a DID Document.
+     *     description: This endpoint imports a decentralized identifier associated with the user's account for custodian-mode clients.
+     *     requestBody:
+     *       content:
+     *         application/x-www-form-urlencoded:
+     *           schema:
+     *             $ref: '#/components/schemas/DidImportRequest'
+     *         application/json:
+     *           schema:
+     *             $ref: '#/components/schemas/DidImportRequest'
+     *     responses:
+     *       200:
+     *         description: The request was successful.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/DidResult'
+     *       400:
+     *         description: A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/InvalidRequest'
+     *             example:
+     *               error: InvalidRequest
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         description: An internal error has occurred. Additional state information plus metadata may be available in the response body.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/InvalidRequest'
+     *             example:
+     *               error: Internal Error
+     */
+    importDid(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /did/deactivate/{did}:
+     *   post:
+     *     tags: [ DID ]
+     *     summary: Deactivate a DID Document.
+     *     description: This endpoint deactivates a DID Document by taking the DID identifier as input. Must be called and signed by the DID owner.
+     *     parameters:
+     *       - in: path
+     *         name: did
+     *         description: DID identifier to deactivate.
+     *         schema:
+     *           type: string
+     *         required: true
+     *     requestBody:
+     *       content:
+     *         application/x-www-form-urlencoded:
+     *           schema:
+     *             $ref: '#/components/schemas/DidDeactivateRequest'
+     *         application/json:
+     *           schema:
+     *             $ref: '#/components/schemas/DidDeactivateRequest'
+     *     responses:
+     *       200:
+     *         description: The request was successful.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/DeactivatedDidResolution'
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    deactivateDid(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /did/list:
+     *   get:
+     *     tags: [ DID ]
+     *     summary: Fetch DIDs associated with an account.
+     *     description: This endpoint returns the list of DIDs controlled by the account.
+     *     responses:
+     *       200:
+     *         description: The request was successful.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               type: array
+     *               items:
+     *                 type: string
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    getDids(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * @openapi
+     *
+     * /did/search/{did}:
+     *   get:
+     *     tags: [ DID ]
+     *     summary: Resolve a DID Document.
+     *     description: Resolve a DID Document by DID identifier. Also supports DID Resolution Queries as defined in the <a href="https://w3c-ccg.github.io/did-resolution/">W3C DID Resolution specification</a>.
+     *     parameters:
+     *       - in: path
+     *         name: did
+     *         description: DID identifier to resolve.
+     *         schema:
+     *           type: string
+     *         required: true
+     *         example: did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0
+     *       - in: query
+     *         name: metadata
+     *         description: Return only metadata of DID Document instead of actual DID Document.
+     *         schema:
+     *           type: boolean
+     *       - in: query
+     *         name: versionId
+     *         description: Unique UUID version identifier of DID Document. Allows for fetching a specific version of the DID Document. See <a href="https://docs.cheqd.io/identity/architecture/adr-list/adr-001-cheqd-did-method#did-document-metadata">cheqd DID Method Specification</a> for more details.
+     *         schema:
+     *           type: string
+     *           format: uuid
+     *         example: 3ccde6ba-6ba5-56f2-9f4f-8825561a9860
+     *       - in: query
+     *         name: versionTime
+     *         description: Returns the closest version of the DID Document *at* or *before* specified time. See <a href="https://docs.cheqd.io/identity/architecture/adr-list/adr-005-did-resolution-and-did-url-dereferencing">DID Resolution handling for `did:cheqd`</a> for more details.
+     *         schema:
+     *           type: string
+     *           format: date-time
+     *         example: 1970-01-01T00:00:00Z
+     *       - in: query
+     *         name: transformKeys
+     *         description: This directive transforms the Verification Method key format from the version in the DID Document to the specified format chosen below.
+     *         schema:
+     *           type: string
+     *           enum:
+     *             - Ed25519VerificationKey2018
+     *             - Ed25519VerificationKey2020
+     *             - JsonWebKey2020
+     *       - in: query
+     *         name: service
+     *         description: Query DID Document for a specific Service Endpoint by Service ID (e.g., `service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`). This will typically redirect to the Service Endpoint based on <a href="https://w3c-ccg.github.io/did-resolution/#dereferencing">DID Resolution specification</a> algorithm.
+     *         schema:
+     *           type: string
+     *         example: service-1
+     *       - in: query
+     *         name: relativeRef
+     *         description: Relative reference is a query fragment appended to the Service Endpoint URL. **Must** be used along with the `service` query property above. See <a href="https://w3c-ccg.github.io/did-resolution/#dereferencing">DID Resolution specification</a> algorithm for more details.
+     *         schema:
+     *           type: string
+     *         example: /path/to/file
+     *     responses:
+     *       200:
+     *         description: The request was successful.
+     *         content:
+     *           application/json:
+     *             schema:
+     *               $ref: '#/components/schemas/DidResolution'
+     *       400:
+     *         $ref: '#/components/schemas/InvalidRequest'
+     *       401:
+     *         $ref: '#/components/schemas/UnauthorizedError'
+     *       500:
+     *         $ref: '#/components/schemas/InternalError'
+     */
+    resolveDidUrl(request: Request, response: Response): Promise<Response<any, Record<string, any>>>;
+}
+//# sourceMappingURL=did.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"did.d.ts","sourceRoot":"","sources":["../../../src/controllers/api/did.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AA+CjD,qBAAa,aAAa;IACzB,OAAc,kBAAkB,+RA4B9B;IAEF,OAAc,kBAAkB,+RAyB9B;IAEF,OAAc,sBAAsB,+RAAqD;IAEzF,OAAc,kBAAkB,+RAoB9B;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IAEU,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IAuH3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IAEU,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IA0F3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IAEU,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IA2E3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IAEU,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IA2C/D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;IAuBzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACU,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ;CA8B/D"}