@objectstack/service-ai 7.2.0 → 7.3.0

package/dist/index.d.cts

@@ -861,10 +861,22 @@ declare const createObjectTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | 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;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | 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;
-    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | 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;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | 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;
-    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | 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;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | 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;
-    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | 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;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | 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;
-    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | 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;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | 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;
-    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | 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;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | 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;
-    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | 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;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | 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;
-    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | 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;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | 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;
-    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | 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;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | 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;
-    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | 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;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | 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;
-    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "analytics" | "integration" | 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;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | 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). */
@@ -1605,38 +1737,18 @@ declare class AgentRuntime {
      * chat endpoint when the client doesn't specify an `agentName`.
      *
      * Resolution order:
-     * 1. The `defaultAgent` of the app named by `context.appName`.
-     * 2. The first active agent in the registry (deterministic fallback).
-     * 3. `undefined` if no agents are registered.
+     * 1. The `defaultAgent` of the app named by `context.appName`
+     *    (e.g. Studio → `metadata_assistant`).
+     * 2. The platform data-query agent (`data_chat`) — the implicit
+     *    copilot bound to every app that doesn't pin its own. This is
+     *    what end users get by default, so they never have to choose.
+     * 3. The first active agent in the registry (last-resort fallback,
+     *    e.g. in stripped-down deployments without the data agent).
+     * 4. `undefined` if no agents are registered.
      */
     resolveDefaultAgent(context?: AgentChatContext): Promise<Agent | undefined>;
 }
 
-/**
- * Built-in `data_chat` agent — a thin **persona** record.
- *
- * Following the platform's metadata-driven philosophy, this agent no
- * longer hardcodes the tools it can call. The capability bundle lives
- * on the `data_explorer` *skill* (see `../skills/data-explorer-skill.ts`).
- * The agent record is now just:
- *   - identity (name / label / role)
- *   - persona (system prompt)
- *   - model + safety config
- *   - skills attached → `skills: ['data_explorer']`
- *
- * To grant data-exploration powers to a different agent, just add
- * `data_explorer` to its `skills[]`. To revoke globally, set the
- * skill's `active: false` in metadata.
- *
- * @example
- * ```
- * POST /api/v1/ai/agents/data_chat/chat
- * {
- *   "messages": [{ "role": "user", "content": "Show me all active accounts" }],
- *   "context": { "objectName": "account" }
- * }
- * ```
- */
 declare const DATA_CHAT_AGENT: Agent;
 
 /**
@@ -1964,6 +2076,7 @@ declare const AiConversationObject: Omit<{
     _provenance?: "package" | "env-forced" | "org" | undefined;
     _packageId?: string | undefined;
     _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     label?: string | undefined;
     pluralLabel?: string | undefined;
     description?: string | undefined;
@@ -2353,7 +2466,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" | "full" | "read" | "read_write" | undefined;
+    sharingModel?: "full" | "private" | "read" | "read_write" | undefined;
     publicSharing?: {
         enabled: boolean;
         allowedAudiences?: ("email" | "public" | "link_only" | "signed_in")[] | undefined;
@@ -2456,6 +2569,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";
@@ -3925,6 +4043,7 @@ declare const AiMessageObject: Omit<{
     _provenance?: "package" | "env-forced" | "org" | undefined;
     _packageId?: string | undefined;
     _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     label?: string | undefined;
     pluralLabel?: string | undefined;
     description?: string | undefined;
@@ -4314,7 +4433,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" | "full" | "read" | "read_write" | undefined;
+    sharingModel?: "full" | "private" | "read" | "read_write" | undefined;
     publicSharing?: {
         enabled: boolean;
         allowedAudiences?: ("email" | "public" | "link_only" | "signed_in")[] | undefined;
@@ -4417,6 +4536,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";
@@ -6758,6 +6882,7 @@ declare const AiTraceObject: Omit<{
     _provenance?: "package" | "env-forced" | "org" | undefined;
     _packageId?: string | undefined;
     _packageVersion?: string | undefined;
+    _lockDocsUrl?: string | undefined;
     label?: string | undefined;
     pluralLabel?: string | undefined;
     description?: string | undefined;
@@ -7147,7 +7272,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" | "full" | "read" | "read_write" | undefined;
+    sharingModel?: "full" | "private" | "read" | "read_write" | undefined;
     publicSharing?: {
         enabled: boolean;
         allowedAudiences?: ("email" | "public" | "link_only" | "signed_in")[] | undefined;
@@ -7250,6 +7375,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";
@@ -10447,6 +10577,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[] | {
@@ -11147,6 +11284,11 @@ declare const AiTraceView: {
             role?: string | undefined;
         } | undefined;
     }> | undefined;
+    protection?: {
+        lock: "none" | "full" | "no-overlay" | "no-delete";
+        reason: string;
+        docsUrl?: string | undefined;
+    } | undefined;
 };
 
 /**