@deepbounty/sdk 1.2.10 → 1.2.12

package/README.md

@@ -1,15 +1,15 @@
-# DeepBounty SDK
-
-The official SDK for developing modules for the DeepBounty project.
-
-## 📦 Installation
-
-```bash
-npm install @deepbounty/sdk
-```
-
-## 📤 Publish
-
-```bash
-npm publish --access public
-```
+# DeepBounty SDK
+
+The official SDK for developing modules for the DeepBounty project.
+
+## 📦 Installation
+
+```bash
+npm install @deepbounty/sdk
+```
+
+## 📤 Publish
+
+```bash
+npm publish --access public
+```

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export interface Logger {
     info: (message: string) => void;
     warn: (message: string) => void;
     error: (message: string, error?: any) => void;
+    debug: (message: string) => void;
 }
 export interface ConfigAPI {
     /** Get a configuration value by key
@@ -65,6 +66,24 @@ export interface StorageAPI {
         changes: number | bigint;
         lastInsertRowid: number | bigint;
     };
+    /**
+     * Run a function inside a single database transaction (BEGIN/COMMIT, with
+     * automatic ROLLBACK if the function throws).
+     *
+     * Wrapping bulk work in one transaction is fast (thousands of
+     * inserts in tens of ms).
+     * @param fn The work to run inside the transaction
+     * @returns Whatever the function returns
+     */
+    transaction<T>(fn: () => T): T;
+    /**
+     * Execute the same SQL statement for many parameter rows inside a single
+     * transaction. The statement is prepared once and reused for every row.
+     * Use this for bulk INSERT/UPDATE/DELETE instead of calling execute() in a loop.
+     * @param sql The SQL statement to execute for each row
+     * @param rows An array of parameter arrays, one per execution
+     */
+    executeMany(sql: string, rows: any[][]): void;
     /**
      * Helper method to create a table if it doesn't exist
      * @param tableName The name of the table to create
@@ -217,6 +236,20 @@ export interface TargetAPI {
      */
     getTargetsForTask(taskTemplateId: number): Promise<Target[]>;
 }
+/**
+ * A synchronous scope checker bound to a snapshot of the current scope.
+ *
+ * Hot loops that process many hostnames (e.g. thousands of discovered subdomains)
+ * should call `api.getScopeChecker()` ONCE before the loop and then use these
+ * synchronous methods per item, instead of awaiting `api.isHostnameInScope()`
+ * per item.
+ */
+export interface ScopeChecker {
+    /** Whether the hostname is within scope of an active target. */
+    isInScope(hostname: string): boolean;
+    /** The owning target ID for the hostname, or null if none matches. */
+    detectTargetId(hostname: string): number | null;
+}
 export interface ServerAPI {
     version: string;
     logger: Logger;
@@ -228,6 +261,12 @@ export interface ServerAPI {
     targets: TargetAPI;
     /** Check if a hostname is in scope based on targets_subdomains */
     isHostnameInScope(hostname: string): Promise<boolean>;
+    /**
+     * Get a synchronous scope checker bound to a snapshot of the current scope.
+     * Await this once before a hot loop, then call its methods synchronously per
+     * item instead of awaiting isHostnameInScope() per item.
+     */
+    getScopeChecker(): Promise<ScopeChecker>;
     /**
      * Register a task template that can be scheduled for all targets
      * @param uniqueKey Unique identifier for this task within the module (e.g., "subdomain-scan")

package/dist/types/tasks.d.ts

@@ -37,6 +37,8 @@ export interface TaskExecution {
     workerId?: number;
     status: "pending" | "running" | "completed" | "failed";
     createdAt: Date;
+    startedAt?: Date;
+    completedAt?: Date;
     content: TaskContent;
     targetId?: number;
     customData?: Record<string, any>;
@@ -48,6 +50,7 @@ export interface TaskResult {
     output?: string;
     error?: string;
     targetId?: number;
+    durationMs?: number;
     customData?: Record<string, any>;
 }
 export interface TargetTaskOverride {

package/package.json

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