Merge pull request #17 from Mermaid-Chart/fix/setDocument-specify-that-projectID-is-required

fix(sdk): fix the required params of the `setDocument()` command

Author: aloisklink

packages/sdk/src/index.e2e.test.ts

@@ -84,7 +84,7 @@ describe('setDocument', () => {
 
     await client.setDocument({
       documentID: newDocument.documentID,
-      id: newDocument.id, // diagram ID
+      projectID: newDocument.projectID,
       title: "@mermaidchart/sdk E2E test diagram",
       code,
     });
@@ -98,15 +98,14 @@ describe('setDocument', () => {
     });
   });
 
-  // TODO: this function never seems to return an error, see MC-1060
-  it.skip('should throw an error on invalid data', async() => {
+  it('should throw an error on invalid data', async() => {
     const newDocument = await client.createDocument(testProjectId);
     documentsToDelete.add(newDocument.documentID);
 
     await expect(client.setDocument({
       documentID: newDocument.documentID,
-      // @ts-expect-error not setting diagram `id` should throw an error
-      id: null,
+      // @ts-expect-error not setting diagram `projectID` should throw an error
+      projectID: null,
     })).rejects.toThrowError("400"); // should throw HTTP 400 error
   });
 });

packages/sdk/src/index.ts

@@ -210,7 +210,7 @@ export class MermaidChart {
    * @param document The document to update.
    */
   public async setDocument(
-    document: Pick<MCDocument, 'id' | 'documentID'> & Partial<MCDocument>,
+    document: Pick<MCDocument, 'documentID' | 'projectID'> & Partial<MCDocument>,
   ) {
     const {data} = await this.axios.put<{result: "ok"} | {result: "failed", error: any}>(
       URLS.rest.documents.pick(document).self,