@deepbounty/sdk 1.0.2 → 1.0.3

package/README.md

@@ -8,13 +8,8 @@ The official SDK for developing modules for the DeepBounty project.
 npm install @deepbounty/sdk
 ```
 
-## 🔧 Build & Publish
+## 📤 Publish
 
-1. Build the SDK:
-   ```bash
-   npm run build
-   ```
-2. Publish to npm:
-   ```bash
-   npm publish --access public
-   ```
+```bash
+npm publish --access public
+```

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ModuleSetting } from "./types";
+import { ModuleSetting, TaskContent, TaskResult } from "./types";
 export interface Logger {
     info: (...args: any[]) => void;
     warn: (...args: any[]) => void;
@@ -13,10 +13,14 @@ export interface ConfigAPI {
     setSetting(name: string, value: any): Promise<void>;
     getAllSettings(): Promise<ModuleSetting[]>;
 }
+export interface TasksAPI {
+    submit(taskContent: TaskContent): Promise<TaskResult>;
+}
 export interface ServerAPI {
     version: string;
     logger: Logger;
     config: ConfigAPI;
+    tasks: TasksAPI;
 }
 export interface PluginLifecycle {
     run?(api: ServerAPI): Promise<void> | void;

package/dist/types/index.d.ts

@@ -4,3 +4,4 @@ export * from "./alerts.js";
 export * from "./workers.js";
 export * from "./websockets.js";
 export * from "./tasks.js";
+export * from "./tools.js";

package/dist/types/index.js

@@ -4,3 +4,4 @@ export * from "./alerts.js";
 export * from "./workers.js";
 export * from "./websockets.js";
 export * from "./tasks.js";
+export * from "./tools.js";

package/dist/types/modules.d.ts

@@ -1,3 +1,13 @@
+import { Tool } from "./tools";
+export interface Module {
+    id: string;
+    name: string;
+    version: string;
+    entry: string;
+    description?: string;
+    settings?: ModuleSetting[];
+    tools?: Tool[];
+}
 export interface ModuleSetting {
     name: string;
     type: "checkbox" | "text" | "select" | "info";
@@ -6,13 +16,7 @@ export interface ModuleSetting {
     value?: string | boolean;
     options?: string[];
 }
-export interface Module {
-    id: string;
-    name: string;
-    version: string;
-    description?: string;
-    settings?: ModuleSetting[];
-}
 export interface LoadedModule extends Module {
     run: () => Promise<any>;
+    tools?: Tool[];
 }

package/dist/types/tasks.d.ts

@@ -1,8 +1,13 @@
-export interface Task {
+import { Tool } from "./tools";
+export interface TaskContent {
+    commands: string[];
+    requiredTools?: Tool[];
+}
+export interface Task extends TaskContent {
     id: number;
-    type: "tool" | "command";
-    payload: Record<string, any>;
-    workerId: number;
+}
+export interface ServerTask extends Task {
+    workerId?: number;
     status: "pending" | "running" | "completed" | "failed";
     createdAt: Date;
 }

package/dist/types/tools.d.ts

@@ -0,0 +1,8 @@
+export interface Tool {
+    name: string;
+    version: string;
+    description?: string;
+    downloadUrl: string;
+    preInstallCommands?: string[];
+    postInstallCommands?: string[];
+}

package/dist/types/tools.js

@@ -0,0 +1 @@
+export {};

package/dist/types/workers.d.ts

@@ -1,13 +1,8 @@
-import { Task } from "./tasks";
+import { ServerTask } from "./tasks";
+import { Tool } from "./tools";
 export interface Worker {
     id: number;
-    currentTasks: Task[];
+    currentTasks: ServerTask[];
     availableTools: Tool[];
     loadFactor: number;
 }
-export interface Tool {
-    name: string;
-    downloadUrl: string;
-    version: string;
-    description?: string;
-}

package/package.json

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