Merge pull request #119 from katayama8000/remove-star

Add `Remove star`

Author: mmktomato

dist/backlog.js

@@ -676,6 +676,13 @@ var Backlog = /** @class */ (function (_super) {
     Backlog.prototype.postStar = function (params) {
         return this.post('stars', params);
     };
+    /**
+     * https://developer.nulab.com/docs/backlog/api/2/remove-star/
+     */
+    Backlog.prototype.removeStar = function (starId) {
+        var endpoint = "stars/".concat(starId);
+        return this.delete(endpoint);
+    };
     /**
      * https://developer.nulab.com/docs/backlog/api/2/get-notification/
      */

dist/backlog.min.js

@@ -444,6 +444,10 @@ export default class Backlog extends Request {
      * https://developer.nulab.com/docs/backlog/api/2/add-star/
      */
     postStar(params: Option.Project.PostStarParams): Promise<void>;
+    /**
+     * https://developer.nulab.com/docs/backlog/api/2/remove-star/
+     */
+    removeStar(starId: number): Promise<void>;
     /**
      * https://developer.nulab.com/docs/backlog/api/2/get-notification/
      */

dist/types/backlog.d.ts

@@ -874,6 +874,14 @@ export default class Backlog extends Request {
     return this.post('stars', params);
   }
 
+  /**
+   * https://developer.nulab.com/docs/backlog/api/2/remove-star/
+   */
+  public removeStar(starId: number): Promise<void> {
+    const endpoint = `stars/${starId}`;
+    return this.delete(endpoint);
+  }
+
   /**
    * https://developer.nulab.com/docs/backlog/api/2/get-notification/
    */

src/backlog.ts

@@ -10,7 +10,7 @@ let undiciInterceptable: Interceptable;
 type BodyMatcher = (body: string | Record<string, any>) => boolean;
 
 interface MockParams {
-  method: "GET" | "POST";
+  method: "GET" | "POST" | "DELETE";
   path: string;
   query?: Record<string, any>;
   body?: BodyMatcher;
@@ -42,6 +42,8 @@ export const mockRequest = ({
       interceptor = nockScope.get(newPath);
     } else if (method === "POST" ) {
       interceptor = nockScope.post(newPath, body);
+    } else if (method === "DELETE") {
+      interceptor = nockScope.delete(newPath);
     }
 
     interceptor

test/mock.ts

@@ -299,4 +299,23 @@ describe("Backlog API", () => {
       throw err
     });
   });
+
+  it('should remove star.', (done) => {
+    const starId = 123;
+    mockRequest({
+      method: "DELETE",
+      path: `/api/v2/stars/${starId}`,
+      query: { apiKey },
+      status: 204,
+      data: [],
+      times: 1,
+    });
+    backlog.removeStar(starId).then(data => {
+      // Should resolve without error and without any value
+      assert(data === undefined);
+      done();
+    }).catch(err => {
+      throw err;
+    });
+  });
 });