@peers-app/peers-device 0.15.4 → 0.16.0

package/dist/tool-loader.d.ts

@@ -0,0 +1,41 @@
+import { type ITool, type IToolInstance, type IWorkflowRunContext } from "@peers-app/peers-sdk";
+/**
+ * Injects the function that returns the root application data directory
+ * (where tool code is cached on disk).  Must be called once during app
+ * initialisation before any tool is loaded via {@link initTool}.
+ */
+export declare function setPeersAppDir(fn: () => string): void;
+/**
+ * Derives a unique filesystem-safe identifier for a tool, combining its
+ * human-readable name with the last 5 characters of its ID.
+ */
+export declare function getToolUniqueIdentifier(tool: ITool): string;
+/**
+ * Resolves an {@link ITool} definition into a runnable {@link IToolInstance}.
+ *
+ * Resolution order:
+ * 1. System-tool registry ({@link systemToolInstances})
+ * 2. Package-registered tool factory (`getRegisteredTool` from peers-sdk)
+ * 3. Write the tool's `code` to disk, `require()` it, and cache the result
+ *
+ * @param tool - The tool definition to initialise.
+ * @param opts - Pass `{ refresh: true }` to force a reload even when the
+ *   code hash has not changed.
+ */
+export declare function initTool(tool: ITool, opts?: {
+    refresh: boolean;
+}): Promise<IToolInstance>;
+/**
+ * Loads a tool via {@link initTool} and wraps its `toolFn` so that every
+ * invocation is automatically logged to the {@link WorkflowLogs} table
+ * with timing, arguments, result, and error state.
+ *
+ * @param tool - The tool definition.
+ * @param context - The current workflow-run context (provides the logger).
+ */
+export declare function initWrappedTool(tool: ITool, context: IWorkflowRunContext): Promise<IToolInstance>;
+/**
+ * Parses tool mention markup (`<$tool:name:id>`) out of a markdown string
+ * and returns the corresponding {@link ITool} records.
+ */
+export declare function getLinkedTools(markdown: string): Promise<ITool[]>;

package/dist/tool-loader.js

@@ -0,0 +1,186 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setPeersAppDir = setPeersAppDir;
+exports.getToolUniqueIdentifier = getToolUniqueIdentifier;
+exports.initTool = initTool;
+exports.initWrappedTool = initWrappedTool;
+exports.getLinkedTools = getLinkedTools;
+const node_crypto_1 = require("node:crypto");
+const promises_1 = require("node:fs/promises");
+const node_path_1 = __importDefault(require("node:path"));
+const peers_sdk_1 = require("@peers-app/peers-sdk");
+const lodash_1 = require("lodash");
+const system_tools_1 = require("./system-tools");
+let _getPeersAppDir;
+/**
+ * Injects the function that returns the root application data directory
+ * (where tool code is cached on disk).  Must be called once during app
+ * initialisation before any tool is loaded via {@link initTool}.
+ */
+function setPeersAppDir(fn) {
+    _getPeersAppDir = fn;
+}
+/**
+ * Derives a unique filesystem-safe identifier for a tool, combining its
+ * human-readable name with the last 5 characters of its ID.
+ */
+function getToolUniqueIdentifier(tool) {
+    // TODO there is probably a better way to solve name collisions
+    return `${tool.name}_${tool.toolId.slice(20)}`;
+}
+const toolCodeCache = {};
+const toolCodeCacheSha = {};
+/**
+ * Resolves an {@link ITool} definition into a runnable {@link IToolInstance}.
+ *
+ * Resolution order:
+ * 1. System-tool registry ({@link systemToolInstances})
+ * 2. Package-registered tool factory (`getRegisteredTool` from peers-sdk)
+ * 3. Write the tool's `code` to disk, `require()` it, and cache the result
+ *
+ * @param tool - The tool definition to initialise.
+ * @param opts - Pass `{ refresh: true }` to force a reload even when the
+ *   code hash has not changed.
+ */
+async function initTool(tool, opts = { refresh: false }) {
+    const sysToolInstance = (0, system_tools_1.systemToolInstances)(tool.toolId);
+    if (sysToolInstance) {
+        return sysToolInstance;
+    }
+    const registeredToolInstance = (0, peers_sdk_1.getRegisteredTool)(tool.toolId);
+    if (registeredToolInstance) {
+        return registeredToolInstance;
+    }
+    const toolUID = getToolUniqueIdentifier(tool);
+    const codeHash = (0, node_crypto_1.createHash)("sha256").update(tool.code).digest("hex");
+    const refresh = opts.refresh || toolCodeCacheSha[toolUID] !== codeHash;
+    if (toolCodeCache[toolUID] && !refresh) {
+        return toolCodeCache[toolUID];
+    }
+    delete toolCodeCache[toolUID];
+    delete toolCodeCacheSha[toolUID];
+    if (!_getPeersAppDir) {
+        throw new Error("setPeersAppDir must be called before initTool");
+    }
+    const rootDir = _getPeersAppDir();
+    const toolDir = node_path_1.default.join(rootDir, "tools", toolUID);
+    const cacheKeys = Object.keys(require.cache);
+    for (const cacheKey of cacheKeys) {
+        const requireCache = require.cache[cacheKey];
+        const cachePath = requireCache?.path;
+        if (cachePath) {
+            if (cachePath.toLowerCase().startsWith(toolDir.toLowerCase())) {
+                delete require.cache[cacheKey];
+            }
+        }
+    }
+    await (0, promises_1.mkdir)(toolDir, { recursive: true });
+    const toolFilePath = node_path_1.default.join(toolDir, "index.js");
+    let toolCode = tool.code;
+    toolCode = toolCode.trim();
+    if (toolCode.startsWith("```") && toolCode.endsWith("```")) {
+        toolCode = toolCode.slice(3, -3);
+    }
+    await (0, promises_1.writeFile)(toolFilePath, toolCode);
+    let toolModule = require(toolFilePath);
+    let toolInstance = {
+        tool,
+        toolFn: (...args) => "Error: toolFn was not set",
+    };
+    if (toolModule.default) {
+        toolInstance = {
+            ...toolInstance,
+            ...toolModule,
+        };
+        toolModule = toolModule.default;
+    }
+    if (typeof toolModule === "function") {
+        toolInstance.toolFn = toolModule;
+    }
+    else {
+        toolInstance = {
+            ...toolInstance,
+            toolFn: () => `Error: the module built from the tool code did not return a tool function.  The module should export a function named "toolFn" or make the default export a function.`,
+            ...toolModule,
+            tool,
+        };
+    }
+    toolCodeCacheSha[toolUID] = codeHash;
+    toolCodeCache[toolUID] = toolInstance;
+    return toolCodeCache[toolUID];
+}
+/**
+ * Loads a tool via {@link initTool} and wraps its `toolFn` so that every
+ * invocation is automatically logged to the {@link WorkflowLogs} table
+ * with timing, arguments, result, and error state.
+ *
+ * @param tool - The tool definition.
+ * @param context - The current workflow-run context (provides the logger).
+ */
+async function initWrappedTool(tool, context) {
+    const { logger } = context;
+    let toolInstance = {
+        toolFn: (...args) => "toolFn placeholder",
+        tool,
+    };
+    try {
+        toolInstance = await initTool(tool);
+    }
+    catch (err) {
+        toolInstance.toolFn = () => `Error loading tool: ${tool.name}\n${err}\n\nTell the user there is an error with the tool that needs to be fixed before it can be loaded.`;
+        logger(`Error loading tool: ${tool.name}: ${String(err)}`);
+    }
+    const wrappedToolInstance = {
+        ...toolInstance,
+        toolFn: async (args) => {
+            const logEntry = await logger({
+                toolId: tool.toolId,
+                toolArgs: args,
+            });
+            let result;
+            let isResultError = false;
+            const startTime = Date.now();
+            try {
+                const toolFn = toolInstance.toolFn ?? (() => "Error: toolFn was not set, check the tool code");
+                result = await toolFn(args, context);
+            }
+            catch (err) {
+                isResultError = true;
+                result = `Error in tool: \`${tool.name}\`: ${err}`;
+            }
+            logEntry.isError = isResultError;
+            if ((0, lodash_1.isObject)(result)) {
+                logEntry.result = JSON.stringify(result, null, 2);
+                logEntry.resultObject = result;
+            }
+            else {
+                logEntry.result = String(result);
+            }
+            logEntry.toolRunTimeMs = Date.now() - startTime;
+            await (0, peers_sdk_1.WorkflowLogs)().update(logEntry);
+            return result;
+        },
+    };
+    return wrappedToolInstance;
+}
+/**
+ * Parses tool mention markup (`<$tool:name:id>`) out of a markdown string
+ * and returns the corresponding {@link ITool} records.
+ */
+async function getLinkedTools(markdown) {
+    const matchedToolIds = markdown.match(/<\$tool:([a-zA-Z0-9_-]+):[a-zA-Z0-9]{25}>/g);
+    if (!matchedToolIds) {
+        return [];
+    }
+    const toolIds = matchedToolIds.map((id) => {
+        return id.split(":")[2].slice(0, -1);
+    });
+    const fixedTools = await (0, peers_sdk_1.Tools)().list({
+        toolId: { $in: toolIds },
+    });
+    return fixedTools;
+}
+//# sourceMappingURL=tool-loader.js.map

package/dist/tool-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool-loader.js","sourceRoot":"","sources":["../src/tool-loader.ts"],"names":[],"mappings":";;;;;AAsBA,wCAEC;AAMD,0DAGC;AAiBD,4BA2EC;AAUD,0CAgDC;AAMD,wCAaC;AA1MD,6CAAyC;AACzC,+CAAoD;AACpD,0DAA6B;AAC7B,oDAQ8B;AAC9B,mCAAkC;AAClC,iDAAqD;AAErD,IAAI,eAA2C,CAAC;AAEhD;;;;GAIG;AACH,SAAgB,cAAc,CAAC,EAAgB;IAC7C,eAAe,GAAG,EAAE,CAAC;AACvB,CAAC;AAED;;;GAGG;AACH,SAAgB,uBAAuB,CAAC,IAAW;IACjD,+DAA+D;IAC/D,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;AACjD,CAAC;AAED,MAAM,aAAa,GAAkC,EAAE,CAAC;AACxD,MAAM,gBAAgB,GAA2B,EAAE,CAAC;AAEpD;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,QAAQ,CAAC,IAAW,EAAE,IAAI,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE;IACnE,MAAM,eAAe,GAAG,IAAA,kCAAmB,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzD,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,MAAM,sBAAsB,GAAG,IAAA,6BAAiB,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9D,IAAI,sBAAsB,EAAE,CAAC;QAC3B,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAED,MAAM,OAAO,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,IAAA,wBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACtE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,gBAAgB,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;IAEvE,IAAI,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACvC,OAAO,aAAa,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,aAAa,CAAC,OAAO,CAAC,CAAC;IAC9B,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAEjC,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IACD,MAAM,OAAO,GAAG,eAAe,EAAE,CAAC;IAClC,MAAM,OAAO,GAAG,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAErD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,SAAS,GAAG,YAAY,EAAE,IAAI,CAAC;QACrC,IAAI,SAAS,EAAE,CAAC;YACd,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;gBAC9D,OAAO,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,IAAA,gBAAK,EAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1C,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACpD,IAAI,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;IACzB,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC3B,IAAI,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3D,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,MAAM,IAAA,oBAAS,EAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAExC,IAAI,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACvC,IAAI,YAAY,GAAkB;QAChC,IAAI;QACJ,MAAM,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,2BAA2B;KACxD,CAAC;IACF,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;QACvB,YAAY,GAAG;YACb,GAAG,YAAY;YACf,GAAG,UAAU;SACd,CAAC;QACF,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC;IAClC,CAAC;IACD,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE,CAAC;QACrC,YAAY,CAAC,MAAM,GAAG,UAAU,CAAC;IACnC,CAAC;SAAM,CAAC;QACN,YAAY,GAAG;YACb,GAAG,YAAY;YACf,MAAM,EAAE,GAAG,EAAE,CACX,uKAAuK;YACzK,GAAG,UAAU;YACb,IAAI;SACL,CAAC;IACJ,CAAC;IAED,gBAAgB,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC;IACrC,aAAa,CAAC,OAAO,CAAC,GAAG,YAAY,CAAC;IAEtC,OAAO,aAAa,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,eAAe,CACnC,IAAW,EACX,OAA4B;IAE5B,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC3B,IAAI,YAAY,GAAkB;QAChC,MAAM,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,oBAAoB;QAChD,IAAI;KACL,CAAC;IACF,IAAI,CAAC;QACH,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,YAAY,CAAC,MAAM,GAAG,GAAG,EAAE,CACzB,uBAAuB,IAAI,CAAC,IAAI,KAAK,GAAG,mGAAmG,CAAC;QAC9I,MAAM,CAAC,uBAAuB,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,mBAAmB,GAAkB;QACzC,GAAG,YAAY;QACf,MAAM,EAAE,KAAK,EAAE,IAAS,EAAE,EAAE;YAC1B,MAAM,QAAQ,GAAiB,MAAM,MAAM,CAAC;gBAC1C,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;YACH,IAAI,MAAW,CAAC;YAChB,IAAI,aAAa,GAAG,KAAK,CAAC;YAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACH,MAAM,MAAM,GACV,YAAY,CAAC,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC,gDAAgD,CAAC,CAAC;gBAClF,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACvC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,aAAa,GAAG,IAAI,CAAC;gBACrB,MAAM,GAAG,oBAAoB,IAAI,CAAC,IAAI,OAAO,GAAG,EAAE,CAAC;YACrD,CAAC;YACD,QAAQ,CAAC,OAAO,GAAG,aAAa,CAAC;YACjC,IAAI,IAAA,iBAAQ,EAAC,MAAM,CAAC,EAAE,CAAC;gBACrB,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;gBAClD,QAAQ,CAAC,YAAY,GAAG,MAAM,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;YACnC,CAAC;YACD,QAAQ,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;YAChD,MAAM,IAAA,wBAAY,GAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACtC,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC;IACF,OAAO,mBAAmB,CAAC;AAC7B,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,cAAc,CAAC,QAAgB;IACnD,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;IACpF,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,OAAO,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;QACxC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,MAAM,IAAA,iBAAK,GAAE,CAAC,IAAI,CAAC;QACpC,MAAM,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE;KACzB,CAAC,CAAC;IACH,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/workflow-processor.d.ts

@@ -0,0 +1,41 @@
+import { type DataContext, type ITool, type IWorkflowRunContext, type UserContext } from "@peers-app/peers-sdk";
+/**
+ * Injects the decryption function used by {@link getVariable} when a
+ * persistent variable is marked as a secret.  Must be called once during
+ * app initialisation before any workflow or tool accesses secret variables.
+ */
+export declare function setDecryptData(fn: (value: string, groupId: string) => Promise<any>): void;
+/**
+ * Injects the function that returns the current user's home directory.
+ * Used as the default `currentWorkingDirectory` for new workflow runs.
+ * Must be called once during app initialisation.
+ */
+export declare function setUserHomeDirectory(fn: () => string): void;
+type SimilarToolsFn = (args: {
+    context: IWorkflowRunContext;
+    text: string;
+    similarityThreshold?: number;
+    maxCount?: number;
+}) => Promise<ITool[]>;
+/**
+ * Injects the embedding-based tool similarity function used when an
+ * assistant's {@link ToolInclusionStrategy} is `Relevant`.  This is
+ * optional -- when unset, the "Relevant" strategy simply skips the
+ * similarity search.
+ */
+export declare function setSimilarToolsFn(fn: SimilarToolsFn): void;
+/**
+ * Sets up the WorkflowRuns change subscription and the 60-second polling
+ * interval.  Pass a `UserContext` directly (e.g. in tests) or omit it to
+ * fall back to `getUserContext()`.
+ */
+export declare function initializeWorkflowProcessor(userContext?: UserContext): void;
+/** Scans for incomplete workflow runs and schedules them for processing. */
+export declare function checkForWorkflowsToProcess(): Promise<void>;
+/**
+ * Attempts to process the next instruction for a workflow run.  Applies
+ * CPU-based throttling, schedule gating, sub-workflow checks, and an
+ * in-process per-run lock before delegating to {@link processNextInstruction}.
+ */
+export declare function tryProcessingWorkflowRun(dataContext: DataContext, workflowRunId: string): Promise<void>;
+export {};