imdone-api - npm Package Compare versions

Comparing version 1.52.1 to 1.52.2

lib/plugin.js

@@ -23,3 +23,11 @@ "use strict";
     }
+    /**
+     * Destroys the plugin instance.
+     */
     destroy() { }
+    /**
+     * Hook that is called before a task is added.
+     * @param {OnBeforeAddTaskRequest} request - The request object containing task details.
+     * @returns {Promise<OnBeforeAddTaskResponse>} - The response object containing task details.
+     */
     onBeforeAddTask(request) {
@@ -32,5 +40,12 @@ return __awaiter(this, void 0, void 0, function* () {
     }
+    /**
+     * Hook that is called before the board is updated.
+     */
     onBeforeBoardUpdate() {
         this.unimplemented('onBeforeBoardUpdate()');
     }
+    /**
+     * Hook that is called when the board is updated.
+     * @param {Array<List>} lists - The updated lists.
+     */
     onBoardUpdate(lists) {
@@ -41,5 +56,14 @@ return __awaiter(this, void 0, void 0, function* () {
     }
+    /**
+     * Hook that is called when a task is updated.
+     * @param {Task} task - The updated task.
+     */
     onTaskUpdate(task) {
         this.unimplemented('onTaskUpdate(task: Task)');
     }
+    /**
+     * Hook that is called when a task is found.
+     * @param {Task} task - The found task.
+     * @returns {Promise<void>}
+     */
     onTaskFound(task) {
@@ -50,5 +74,14 @@ return __awaiter(this, void 0, void 0, function* () {
     }
+    /**
+     * Hook that is called after a task is deleted.
+     * @param {Task} task - The deleted task.
+     */
     onAfterDeleteTask(task) {
         this.unimplemented('onAfterDeleteTask(task: Task)');
     }
+    /**
+     * Gets the properties of a card.
+     * @param {Task} task - The task associated with the card.
+     * @returns {Object} - The card properties.
+     */
     getCardProperties(task) {
@@ -58,2 +91,7 @@ this.unimplemented('getCardProperties(task: Task)');
     }
+    /**
+     * Gets the actions available for a card.
+     * @param {Task} task - The task associated with the card.
+     * @returns {Array<CardAction>} - The card actions.
+     */
     getCardActions(task) {
@@ -63,2 +101,6 @@ this.unimplemented('getCardActions(task: Task)');
     }
+    /**
+     * Gets the actions available for the board.
+     * @returns {Array<BoardAction>} - The board actions.
+     */
     getBoardActions() {
@@ -68,2 +110,6 @@ this.unimplemented('getBoardActions()');
     }
+    /**
+     * Gets the settings schema.
+     * @returns {Settings} - The settings schema.
+     */
     getSettingsSchema() {
@@ -73,2 +119,6 @@ this.unimplemented('getSettingsSchema()');
     }
+    /**
+     * Gets the settings.
+     * @returns {any} - The settings.
+     */
     getSettings() {
@@ -75,0 +125,0 @@ return null;

package.json

 {
   "name": "imdone-api",
-  "version": "1.52.1",
+  "version": "1.52.2",
   "description": "Plugin API for imdone",
@@ -17,7 +17,9 @@ "main": "./lib/plugin.js",
   "devDependencies": {
-    "typescript": "^4.5.2"
+    "typedoc": "^0.27.6",
+    "typescript": "^5.7"
   },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "docs": "typedoc --out docs src/settings.ts src/project.ts src/plugin.ts"
   }
 }

types/plugin.d.ts

@@ -39,15 +39,65 @@ import { Project, Task, List } from './project';
     init(): Promise<void>;
+    /**
+     * Destroys the plugin instance.
+     */
     destroy(): void;
+    /**
+     * Hook that is called before a task is added.
+     * @param {OnBeforeAddTaskRequest} request - The request object containing task details.
+     * @returns {Promise<OnBeforeAddTaskResponse>} - The response object containing task details.
+     */
     onBeforeAddTask(request: OnBeforeAddTaskRequest): Promise<OnBeforeAddTaskResponse>;
+    /**
+     * Hook that is called before the board is updated.
+     */
     onBeforeBoardUpdate(): void;
+    /**
+     * Hook that is called when the board is updated.
+     * @param {Array<List>} lists - The updated lists.
+     */
     onBoardUpdate(lists: Array<List>): Promise<void>;
+    /**
+     * Hook that is called when a task is updated.
+     * @param {Task} task - The updated task.
+     */
     onTaskUpdate(task: Task): void;
+    /**
+     * Hook that is called when a task is found.
+     * @param {Task} task - The found task.
+     * @returns {Promise<void>}
+     */
     onTaskFound(task: Task): Promise<void>;
+    /**
+     * Hook that is called after a task is deleted.
+     * @param {Task} task - The deleted task.
+     */
     onAfterDeleteTask(task: Task): void;
+    /**
+     * Gets the properties of a card.
+     * @param {Task} task - The task associated with the card.
+     * @returns {Object} - The card properties.
+     */
     getCardProperties(task: Task): Object;
+    /**
+     * Gets the actions available for a card.
+     * @param {Task} task - The task associated with the card.
+     * @returns {Array<CardAction>} - The card actions.
+     */
     getCardActions(task: Task): Array<CardAction>;
+    /**
+     * Gets the actions available for the board.
+     * @returns {Array<BoardAction>} - The board actions.
+     */
     getBoardActions(): Array<BoardAction>;
+    /**
+     * Gets the settings schema.
+     * @returns {Settings} - The settings schema.
+     */
     getSettingsSchema(): Settings;
+    /**
+     * Gets the settings.
+     * @returns {any} - The settings.
+     */
     private getSettings;
     private unimplemented;
 }

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

644559

increased by3324.68%

Number of package files

47

increased by327.27%

Lines of code

2472

increased by346.21%

Worsened metrics

Dev dependency count

2

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes