@deepbounty/sdk 1.0.6 → 1.0.8

package/dist/index.d.ts

@@ -1,26 +1,65 @@
-import { ModuleSetting, TaskContent, TaskResult } from "./types";
+import { ModuleSetting, TaskContent, Tool } from "./types";
 export interface Logger {
     info: (...args: any[]) => void;
     warn: (...args: any[]) => void;
     error: (...args: any[]) => void;
 }
 export interface ConfigAPI {
+    /** Get a configuration value by key
+     * @param key The configuration key
+     * @param defaultValue The default value to return if the key does not exist
+     * @returns The configuration value
+     */
     get<T = any>(key: string, defaultValue?: T): Promise<T>;
+    /** Set a configuration value by key
+     * @param key The configuration key
+     * @param value The configuration value
+     * @returns A promise that resolves when the value is set
+     */
     set<T = any>(key: string, value: T): Promise<void>;
+    /** Remove a configuration value by key
+     * @param key The configuration key
+     * @returns A promise that resolves when the value is removed
+     */
     remove(key: string): Promise<void>;
     getAll(): Promise<Record<string, any>>;
+    /** Get a specific module setting by name
+     * @param name The setting name
+     * @returns The module setting
+     */
     getSetting(name: string): Promise<ModuleSetting>;
+    /** Set a specific module setting by name
+     * @param name The setting name
+     * @param value The setting value
+     * @returns A promise that resolves when the value is set
+     */
     setSetting(name: string, value: any): Promise<void>;
+    /** Get all module settings
+     * @returns An array of all module settings
+     */
     getAllSettings(): Promise<ModuleSetting[]>;
 }
-export interface TasksAPI {
-    submit(taskContent: TaskContent): Promise<TaskResult>;
-}
 export interface ServerAPI {
     version: string;
     logger: Logger;
     config: ConfigAPI;
-    tasks: TasksAPI;
+    /**
+     * Register a scheduled task that runs at a specific interval
+     * @param taskContent The task content including commands and required tools
+     * @param interval Interval in seconds between task executions
+     * @returns The ID of the registered scheduled task
+     */
+    registerScheduledTask(taskContent: TaskContent, interval: number): number;
+    /**
+     * Unregister a scheduled task
+     * @param taskId The ID of the scheduled task to unregister
+     * @returns true if the task was unregistered, false if it didn't exist
+     */
+    unregisterScheduledTask(taskId: number): boolean;
+    /** Register a tool
+     * @param tool The tool to register
+     */
+    registerTool(tool: Tool): void;
 }
 export interface PluginLifecycle {
     run?(api: ServerAPI): Promise<void> | void;

package/dist/types/modules.d.ts

@@ -1,4 +1,3 @@
-import { Tool } from "./tools";
 export interface Module {
     id: string;
     name: string;
@@ -6,7 +5,6 @@ export interface Module {
     entry: string;
     description?: string;
     settings?: ModuleSetting[];
-    tools?: Tool[];
 }
 export interface ModuleSetting {
     name: string;
@@ -18,5 +16,4 @@ export interface ModuleSetting {
 }
 export interface LoadedModule extends Module {
     run: () => Promise<any>;
-    tools?: Tool[];
 }

package/dist/types/tasks.d.ts

@@ -1,19 +1,27 @@
 import { Tool } from "./tools";
 export interface TaskContent {
     commands: string[];
-    requiredTools?: (Tool | string)[];
+    requiredTools?: Tool[];
 }
-export interface Task extends TaskContent {
+export interface ScheduledTask {
     id: number;
+    content: TaskContent;
+    interval: number;
+    moduleId: string;
+    lastExecutedAt?: Date;
+    nextExecutionAt: Date;
 }
-export interface ServerTask extends Task {
+export interface TaskExecution {
+    executionId: number;
+    scheduledTaskId: number;
     workerId?: number;
     status: "pending" | "running" | "completed" | "failed";
     createdAt: Date;
-    requiredTools?: Tool[];
+    content: TaskContent;
 }
 export interface TaskResult {
-    taskId: number;
+    executionId: number;
+    scheduledTaskId: number;
     success: boolean;
     output?: any;
     error?: string;

package/dist/types/workers.d.ts

@@ -1,8 +1,8 @@
-import { ServerTask } from "./tasks";
+import { TaskExecution } from "./tasks";
 import { Tool } from "./tools";
 export interface Worker {
     id: number;
-    currentTasks: ServerTask[];
+    currentTasks: TaskExecution[];
     availableTools: Tool[];
     loadFactor: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@deepbounty/sdk",
-	"version": "1.0.6",
+	"version": "1.0.8",
 	"description": "DeepBounty SDK for module development",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",