bruce-models 7.1.86 → 7.1.87

package/dist/bruce-models.es5.js

@@ -16481,27 +16481,19 @@ var Plugin;
     }
     Plugin.Upload = Upload;
     /**
-     * Returns a run function to call that'll load a plugin within your provided container element.
-     * The run function will return a dispose function to call to remove the plugin.
+     * Resolves a plugin record and returns its unwrapped source.
      * @param params
      * @returns
      */
-    function GetRunFunction(params) {
+    function LoadPluginSource(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            let { containerId, container, pluginParams, pluginId, plugin, api, req } = params;
+            let { api, pluginId, plugin, req } = params;
             if (!api) {
                 api = ENVIRONMENT.Api().GetBruceApi({
                     loadConfig: true
                 });
             }
             yield api.Loading;
-            if (!containerId && container) {
-                containerId = container.id;
-                if (!containerId) {
-                    containerId = ObjectUtils.UId();
-                    container.id = containerId;
-                }
-            }
             if (!plugin && pluginId) {
                 plugin = (yield Plugin.Get({
                     pluginId,
@@ -16543,6 +16535,39 @@ var Plugin;
             const start = fileContent.indexOf("{");
             const end = fileContent.lastIndexOf("}");
             fileContent = fileContent.substring(start + 1, end);
+            return {
+                api,
+                pluginId,
+                plugin,
+                fileContent
+            };
+        });
+    }
+    /**
+     * Returns a run function to call that'll load a plugin within your provided container element.
+     * The run function will return a dispose function to call to remove the plugin.
+     * @param params
+     * @returns
+     */
+    function GetRunFunction(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { containerId, container, pluginParams, pluginId, plugin, api, req } = params;
+            if (!containerId && container) {
+                containerId = container.id;
+                if (!containerId) {
+                    containerId = ObjectUtils.UId();
+                    container.id = containerId;
+                }
+            }
+            const loaded = yield LoadPluginSource({
+                api,
+                pluginId,
+                plugin,
+                req
+            });
+            pluginId = loaded.pluginId;
+            plugin = loaded.plugin;
+            const fileContent = loaded.fileContent;
             const paramsId = ObjectUtils.UId();
             window[paramsId] = pluginParams ? pluginParams : {};
             window["PLUGIN_" + pluginId] = plugin;
@@ -16617,6 +16642,64 @@ var Plugin;
         });
     }
     Plugin.GetRunFunction = GetRunFunction;
+    /**
+     * Returns an invoke function that calls an AI_TOOL plugin headlessly.
+     * @param params
+     * @returns
+     */
+    function GetInvokeFunction(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { api, pluginId, plugin, req } = params;
+            const loaded = yield LoadPluginSource({
+                api,
+                pluginId,
+                plugin,
+                req
+            });
+            return {
+                invoke: (args, context) => {
+                    const callId = ObjectUtils.UId();
+                    const argsId = "PLUGIN_ARGS_" + callId;
+                    const contextId = "PLUGIN_CONTEXT_" + callId;
+                    const resultId = "PLUGIN_RESULT_" + callId;
+                    window[argsId] = args ? args : {};
+                    window[contextId] = Object.assign({ config: loaded.plugin.Settings ? loaded.plugin.Settings.config : undefined, plugin: loaded.plugin }, (context ? context : {}));
+                    const script = `
+                    function invoke() {
+                        "use strict";
+                        var Invoke;
+
+                        ${loaded.fileContent}
+
+                        if (typeof Invoke !== "function") {
+                            throw new Error("Plugin " + ${JSON.stringify(loaded.pluginId)}
+                                + " does not declare an Invoke function.");
+                        }
+
+                        window["${resultId}"] = Invoke(window["${argsId}"], window["${contextId}"]);
+                    }
+                    invoke();
+                `;
+                    try {
+                        // 'eval2 = eval' stops the linter from complaining about using eval.
+                        const eval2 = eval;
+                        eval2(script);
+                        // Invoke may hand back a plain value or a promise; normalise both.
+                        return Promise.resolve(window[resultId]);
+                    }
+                    catch (e) {
+                        return Promise.reject(e);
+                    }
+                    finally {
+                        delete window[argsId];
+                        delete window[contextId];
+                        delete window[resultId];
+                    }
+                }
+            };
+        });
+    }
+    Plugin.GetInvokeFunction = GetInvokeFunction;
     /**
      * Returns cache identifier for a plugin.
      * Example: {
@@ -16656,6 +16739,134 @@ var Plugin;
     Plugin.GetIndexFileCacheKey = GetIndexFileCacheKey;
 })(Plugin || (Plugin = {}));
 
+/**
+ * Validation for AI_TOOL plugins.
+ */
+var PluginAiTool;
+(function (PluginAiTool) {
+    /** Location value that exposes a plugin as an AI Tool. */
+    PluginAiTool.LOCATION = "AI_TOOL";
+    /** Prefix that turns a plugin ID into its tool name. */
+    const TOOL_NAME_PREFIX = "plugin_";
+    /** Provider limit on a tool name, prefix included. */
+    const MAX_TOOL_NAME_LENGTH = 64;
+    /** Longest plugin ID that still fits inside the tool name limit. */
+    PluginAiTool.MAX_PLUGIN_ID_LENGTH = MAX_TOOL_NAME_LENGTH - TOOL_NAME_PREFIX.length;
+    /**
+     * Schema keywords that silently drop a tool out of strict mode instead of
+     * failing. The tool still works, but stops being structurally guaranteed,
+     * and nothing downstream reports that it happened.
+     */
+    const STRICT_INCOMPATIBLE_KEYWORDS = ["$ref", "$defs", "allOf", "not"];
+    /**
+     * Side effects an AI Tool may declare.
+     *
+     */
+    const ALLOWED_SIDE_EFFECTS = ["none", "external"];
+    function isPlainObject(value) {
+        return !!value && typeof value === "object" && !Array.isArray(value);
+    }
+    /**
+     * Walks a schema for a keyword that would disable strict mode.
+     * @param node
+     * @param depth bounded so a pathological schema cannot hang the save
+     * @returns the offending keyword, or null
+     */
+    function findStrictModeViolation(node, depth = 0) {
+        if (!node || typeof node !== "object" || depth > 32) {
+            return null;
+        }
+        if (Array.isArray(node)) {
+            for (const child of node) {
+                const nested = findStrictModeViolation(child, depth + 1);
+                if (nested) {
+                    return nested;
+                }
+            }
+            return null;
+        }
+        for (const key of Object.keys(node)) {
+            if (STRICT_INCOMPATIBLE_KEYWORDS.includes(key)) {
+                return key;
+            }
+            const nested = findStrictModeViolation(node[key], depth + 1);
+            if (nested) {
+                return nested;
+            }
+        }
+        return null;
+    }
+    /**
+     * Returns why an AI Tool plugin cannot be saved, or null when it is valid.
+     *
+     * Messages are written for the administrator authoring the plugin, and say
+     * what to change rather than what failed.
+     * @param plugin
+     * @returns
+     */
+    function Validate(plugin) {
+        var _a, _b, _c, _d;
+        if (!plugin || plugin.Location !== PluginAiTool.LOCATION) {
+            return null;
+        }
+        const id = ((_a = plugin.ID) !== null && _a !== void 0 ? _a : "").trim();
+        if (!id) {
+            return "An AI Tool needs an ID: it becomes the tool name the agent calls.";
+        }
+        if (!/^[a-zA-Z0-9_-]+$/.test(id)) {
+            return `The ID "${id}" contains characters that are not allowed in a tool name. `
+                + "Use letters, numbers, hyphens and underscores only.";
+        }
+        if (TOOL_NAME_PREFIX.length + id.length > MAX_TOOL_NAME_LENGTH) {
+            return `The ID is ${id.length} characters, which makes the tool name too long. `
+                + `The maximum is ${PluginAiTool.MAX_PLUGIN_ID_LENGTH} characters.`;
+        }
+        const tool = (_b = plugin.Settings) === null || _b === void 0 ? void 0 : _b.tool;
+        if (!isPlainObject(tool)) {
+            return "An AI Tool must declare Settings.tool with an inputSchema the agent can call it with.";
+        }
+        // The tool name is an opaque ID, so it carries no signal about what the
+        // tool does. The description is the only thing the agent can select on:
+        // without one it is registered but never chosen, and nothing reports that.
+        const description = typeof tool.description === "string" ? tool.description.trim() : "";
+        if (!description && !((_c = plugin.Name) !== null && _c !== void 0 ? _c : "").trim()) {
+            return "An AI Tool needs a description. Set Settings.tool.description, or fill in the plugin's "
+                + "Name and Description — the agent has nothing else to choose the tool on.";
+        }
+        if (!isPlainObject(tool.inputSchema)) {
+            return "Settings.tool.inputSchema is missing or is not an object.";
+        }
+        if (tool.inputSchema.type && tool.inputSchema.type !== "object") {
+            return `Settings.tool.inputSchema.type is "${tool.inputSchema.type}"; it must be "object".`;
+        }
+        const strictViolation = findStrictModeViolation(tool.inputSchema);
+        if (strictViolation) {
+            return `Settings.tool.inputSchema uses "${strictViolation}", which silently turns off strict mode `
+                + "for this tool. Inline the schema instead.";
+        }
+        if (tool.annotations !== undefined && !isPlainObject(tool.annotations)) {
+            return "Settings.tool.annotations must be an object.";
+        }
+        const annotations = (_d = tool.annotations) !== null && _d !== void 0 ? _d : {};
+        if (annotations.sideEffect !== undefined) {
+            const sideEffect = String(annotations.sideEffect).trim().toLowerCase();
+            if (!ALLOWED_SIDE_EFFECTS.includes(sideEffect)) {
+                return `sideEffect "${annotations.sideEffect}" is not allowed. AI Tools are read-only in this `
+                    + "release: use \"none\", or \"external\" for a reviewed read-only external request.";
+            }
+        }
+        if (annotations.timeoutMs !== undefined) {
+            if (typeof annotations.timeoutMs !== "number"
+                || !isFinite(annotations.timeoutMs)
+                || annotations.timeoutMs <= 0) {
+                return "timeoutMs must be a positive number of milliseconds.";
+            }
+        }
+        return null;
+    }
+    PluginAiTool.Validate = Validate;
+})(PluginAiTool || (PluginAiTool = {}));
+
 /**
  * Describes the "Program Key" concept within Nextspace.
  * A program key is an access token for an arbitrary software.
@@ -20744,7 +20955,7 @@ var UrlUtils;
 })(UrlUtils || (UrlUtils = {}));
 
 // This is updated with the package.json version on build.
-const VERSION = "7.1.86";
+const VERSION = "7.1.87";
 
-export { VERSION, Account, AccountAudit, AccountConcept, AccountFeatures, AccountInvite, AccountLimits, AccountTemplate, AccountType, AnnDocument, AbstractApi, Api, ApiGetters, BruceApi, GlobalApi, GuardianApi, Assembly, Calculator, ChangeSet, ClientFile, Bounds, BruceEvent, BruceVariable, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, GeoJson, Geometry, LRUCache, UTC, CustomForm, DashboardView, DataFeed, DataLab, DataLabGroup, DataSource, DataTransform, Comment, Entity, EntityAttachment, EntityAttachmentType, EntityAttribute, EntityComment, EntityCoords, EntityHistoricData, EntityLink, EntityLod, EntityLodCategory, EntityRelation, EntityRelationType, EntitySource, EntityTableView, EntityTag, EntityType, EntityTypeRelation, EntityTypeTrigger, Ontology, OntologyDocument, ENVIRONMENT, ExportBrz, ExportCsv, ExportUsd, Hexbin, ImportAssembly, ImportCad, ImportCsv, ImportGeoJson, ImportJson, ImportKml, ImportLcc, ImportedFile, Uploader, Markup, UIMarkup, NAVIGATOR_CHAT_EVENT_ENTITY_HIGHLIGHT_APPLIED, NAVIGATOR_CHAT_EVENT_SCENE_CONTEXT_PREFETCHED, NavigatorChatClient, NavigatorMcpWebSocketClient, Plugin, ProgramKey, MenuItem, ProjectView, ProjectViewBookmark, ProjectViewBookmarkGroup, ProjectViewLegacy, ProjectViewLegacyBookmark, ProjectViewLegacyTile, ProjectViewTile, ZoomControl, Scenario, HostingLocation, MessageBroker, PendingAction, RecordChangeFeed, Style, Tileset, Tracking, Permission, Session, User, UserGroup, UserMfaMethod, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils };
+export { VERSION, Account, AccountAudit, AccountConcept, AccountFeatures, AccountInvite, AccountLimits, AccountTemplate, AccountType, AnnDocument, AbstractApi, Api, ApiGetters, BruceApi, GlobalApi, GuardianApi, Assembly, Calculator, ChangeSet, ClientFile, Bounds, BruceEvent, BruceVariable, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, GeoJson, Geometry, LRUCache, UTC, CustomForm, DashboardView, DataFeed, DataLab, DataLabGroup, DataSource, DataTransform, Comment, Entity, EntityAttachment, EntityAttachmentType, EntityAttribute, EntityComment, EntityCoords, EntityHistoricData, EntityLink, EntityLod, EntityLodCategory, EntityRelation, EntityRelationType, EntitySource, EntityTableView, EntityTag, EntityType, EntityTypeRelation, EntityTypeTrigger, Ontology, OntologyDocument, ENVIRONMENT, ExportBrz, ExportCsv, ExportUsd, Hexbin, ImportAssembly, ImportCad, ImportCsv, ImportGeoJson, ImportJson, ImportKml, ImportLcc, ImportedFile, Uploader, Markup, UIMarkup, NAVIGATOR_CHAT_EVENT_ENTITY_HIGHLIGHT_APPLIED, NAVIGATOR_CHAT_EVENT_SCENE_CONTEXT_PREFETCHED, NavigatorChatClient, NavigatorMcpWebSocketClient, Plugin, PluginAiTool, ProgramKey, MenuItem, ProjectView, ProjectViewBookmark, ProjectViewBookmarkGroup, ProjectViewLegacy, ProjectViewLegacyBookmark, ProjectViewLegacyTile, ProjectViewTile, ZoomControl, Scenario, HostingLocation, MessageBroker, PendingAction, RecordChangeFeed, Style, Tileset, Tracking, Permission, Session, User, UserGroup, UserMfaMethod, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils };
 //# sourceMappingURL=bruce-models.es5.js.map