@objectstack/service-ai 7.1.0 → 7.2.1

package/dist/index.d.ts

@@ -861,10 +861,22 @@ declare const createObjectTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /**
@@ -882,10 +894,22 @@ declare const addFieldTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /**
@@ -902,10 +926,22 @@ declare const modifyFieldTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /**
@@ -922,10 +958,22 @@ declare const deleteFieldTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /**
@@ -943,10 +991,22 @@ declare const listObjectsTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /**
@@ -964,10 +1024,22 @@ declare const describeObjectTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /** All built-in metadata management tool definitions (Tool metadata). */
@@ -1068,10 +1140,22 @@ declare const listPackagesTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /**
@@ -1087,10 +1171,22 @@ declare const getPackageTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /**
@@ -1107,10 +1203,22 @@ declare const createPackageTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /**
@@ -1126,10 +1234,22 @@ declare const getActivePackageTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /**
@@ -1146,10 +1266,22 @@ declare const setActivePackageTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /** All built-in package management tool definitions (Tool metadata). */
@@ -1958,6 +2090,13 @@ declare const AiConversationObject: Omit<{
         caseSensitive?: boolean | undefined;
         autonumberFormat?: string | undefined;
     }>;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     label?: string | undefined;
     pluralLabel?: string | undefined;
     description?: string | undefined;
@@ -2347,7 +2486,7 @@ declare const AiConversationObject: Omit<{
         apiMethods?: ("restore" | "export" | "import" | "delete" | "purge" | "upsert" | "search" | "create" | "list" | "get" | "update" | "history" | "bulk" | "aggregate")[] | undefined;
     } | undefined;
     recordTypes?: string[] | undefined;
-    sharingModel?: "private" | "read" | "full" | "read_write" | undefined;
+    sharingModel?: "full" | "private" | "read" | "read_write" | undefined;
     publicSharing?: {
         enabled: boolean;
         allowedAudiences?: ("email" | "public" | "link_only" | "signed_in")[] | undefined;
@@ -2450,6 +2589,11 @@ declare const AiConversationObject: Omit<{
             role?: string | undefined;
         } | undefined;
     }[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 }, "fields"> & Pick<{
     readonly name: "ai_conversations";
     readonly label: "AI Conversation";
@@ -3913,6 +4057,13 @@ declare const AiMessageObject: Omit<{
         caseSensitive?: boolean | undefined;
         autonumberFormat?: string | undefined;
     }>;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     label?: string | undefined;
     pluralLabel?: string | undefined;
     description?: string | undefined;
@@ -4302,7 +4453,7 @@ declare const AiMessageObject: Omit<{
         apiMethods?: ("restore" | "export" | "import" | "delete" | "purge" | "upsert" | "search" | "create" | "list" | "get" | "update" | "history" | "bulk" | "aggregate")[] | undefined;
     } | undefined;
     recordTypes?: string[] | undefined;
-    sharingModel?: "private" | "read" | "full" | "read_write" | undefined;
+    sharingModel?: "full" | "private" | "read" | "read_write" | undefined;
     publicSharing?: {
         enabled: boolean;
         allowedAudiences?: ("email" | "public" | "link_only" | "signed_in")[] | undefined;
@@ -4405,6 +4556,11 @@ declare const AiMessageObject: Omit<{
             role?: string | undefined;
         } | undefined;
     }[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 }, "fields"> & Pick<{
     readonly name: "ai_messages";
     readonly label: "AI Message";
@@ -6740,6 +6896,13 @@ declare const AiTraceObject: Omit<{
         caseSensitive?: boolean | undefined;
         autonumberFormat?: string | undefined;
     }>;
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     label?: string | undefined;
     pluralLabel?: string | undefined;
     description?: string | undefined;
@@ -7129,7 +7292,7 @@ declare const AiTraceObject: Omit<{
         apiMethods?: ("restore" | "export" | "import" | "delete" | "purge" | "upsert" | "search" | "create" | "list" | "get" | "update" | "history" | "bulk" | "aggregate")[] | undefined;
     } | undefined;
     recordTypes?: string[] | undefined;
-    sharingModel?: "private" | "read" | "full" | "read_write" | undefined;
+    sharingModel?: "full" | "private" | "read" | "read_write" | undefined;
     publicSharing?: {
         enabled: boolean;
         allowedAudiences?: ("email" | "public" | "link_only" | "signed_in")[] | undefined;
@@ -7232,6 +7395,11 @@ declare const AiTraceObject: Omit<{
             role?: string | undefined;
         } | undefined;
     }[] | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 }, "fields"> & Pick<{
     readonly name: "ai_traces";
     readonly label: "AI Trace";
@@ -10429,6 +10597,13 @@ declare const AiTraceObject: Omit<{
  * automatically in Studio when AIService is loaded.
  */
 declare const AiTraceView: {
+    _lock?: "none" | "full" | "no-overlay" | "no-delete" | undefined;
+    _lockReason?: string | undefined;
+    _lockSource?: "artifact" | "package" | "env-forced" | undefined;
+    _provenance?: "package" | "env-forced" | "org" | undefined;
+    _packageId?: string | undefined;
+    _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     list?: {
         type: "map" | "kanban" | "calendar" | "gantt" | "gallery" | "timeline" | "chart" | "grid";
         columns: string[] | {
@@ -11129,6 +11304,11 @@ declare const AiTraceView: {
             role?: string | undefined;
         } | undefined;
     }> | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /**

package/dist/index.js

@@ -189,6 +189,7 @@ var init_data_tools = __esm({
     DEFAULT_QUERY_LIMIT = 20;
     QUERY_RECORDS_TOOL = {
       name: "query_records",
+      label: "Query Records",
       description: "Query records from a data object with optional filters, field selection, sorting, and pagination. Returns an array of matching records.",
       parameters: {
         type: "object",
@@ -234,6 +235,7 @@ var init_data_tools = __esm({
     };
     GET_RECORD_TOOL = {
       name: "get_record",
+      label: "Get Record",
       description: "Get a single record by its ID from a data object.",
       parameters: {
         type: "object",
@@ -258,6 +260,7 @@ var init_data_tools = __esm({
     };
     AGGREGATE_DATA_TOOL = {
       name: "aggregate_data",
+      label: "Aggregate Data",
       description: "Perform aggregation/statistical operations on a data object. Supports count, sum, avg, min, max with optional groupBy and where filters.",
       parameters: {
         type: "object",
@@ -2305,6 +2308,7 @@ function cryptoRandomId() {
 }
 
 // src/plugin.ts
+import { readEnvWithDeprecation } from "@objectstack/types";
 import { EMBEDDER_SERVICE } from "@objectstack/spec/contracts";
 
 // src/stream/vercel-stream-encoder.ts
@@ -5194,6 +5198,7 @@ var QueryPlanSchema = z2.object({
 });
 var QUERY_DATA_TOOL = {
   name: "query_data",
+  label: "Query Data (Natural Language)",
   description: "Answer a natural-language question about the user's data. Internally retrieves the relevant object schema, generates an ObjectQL query, executes it, and returns the matching records. Prefer this tool over `query_records` / `aggregate_data` when the user's intent is expressed in plain language.",
   parameters: {
     type: "object",
@@ -6710,7 +6715,7 @@ var _AIServicePlugin = class _AIServicePlugin {
           );
           const provider = mod[factory] ?? mod.default;
           if (typeof provider === "function") {
-            const modelId = process.env.AI_MODEL ?? defaultModel;
+            const modelId = readEnvWithDeprecation("OS_AI_MODEL", "AI_MODEL") ?? defaultModel;
             const useChatApi = factory === "openai" && typeof provider.chat === "function";
             const model = useChatApi ? provider.chat(modelId) : provider(modelId);
             const adapter = new VercelLLMAdapter({ model });
@@ -6803,7 +6808,7 @@ var _AIServicePlugin = class _AIServicePlugin {
       name: "AI Service",
       version: "1.0.0",
       type: "plugin",
-      scope: "project",
+      scope: "system",
       namespace: "ai",
       objects: [AiConversationObject, AiMessageObject, AiTraceObject, AiPendingActionObject, AiEvalCaseObject, AiEvalRunObject],
       views: [AiTraceView, AiMessageView, AiPendingActionView, AiEvalCaseView, AiEvalRunView]
@@ -6906,7 +6911,8 @@ var _AIServicePlugin = class _AIServicePlugin {
             }
             if (!toolExists) {
               try {
-                await withTimeout(metadataService.register("tool", toolDef.name, toolDef));
+                const label = toolDef.label ?? toToolLabel(toolDef.name);
+                await withTimeout(metadataService.register("tool", toolDef.name, { ...toolDef, label }));
               } catch (err) {
                 ctx.logger.warn(
                   "[AI] Failed to persist tool metadata (non-fatal)",
@@ -7324,6 +7330,9 @@ _AIServicePlugin.OPENAI_COMPATIBLE_PRESETS = {
   openrouter: { baseURL: "https://openrouter.ai/api/v1", defaultModel: "openai/gpt-4o-mini" }
 };
 var AIServicePlugin = _AIServicePlugin;
+function toToolLabel(name) {
+  return name.split("_").filter(Boolean).map((w) => w.charAt(0).toUpperCase() + w.slice(1)).join(" ");
+}
 function extractOverrides(payload) {
   if (!payload || typeof payload !== "object") return {};
   const p = payload;