@frankieai/core 0.2.4 → 0.2.5

package/dist/index.d.cts

@@ -180,14 +180,35 @@ declare const toolPolicySchema: z.ZodObject<{
     denyByDefault: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>;
 /**
- * A starter card shown on the empty chat screen: a title and short description
- * the reader sees, and the message that is sent as if they typed it when they
- * click the card. Configured per workspace in the dashboard's Appearance tab.
+ * The icons a starter card may use, shared by the dashboard picker and the SDK
+ * so the choices stay in step. Each maps to a concrete icon in the widget.
+ */
+declare const STARTER_PROMPT_ICONS: readonly ["sparkles", "wand", "book", "chat", "chart", "bolt", "music", "mic", "image", "compass", "lightbulb", "file"];
+type StarterPromptIcon = (typeof STARTER_PROMPT_ICONS)[number];
+/**
+ * A starter card shown on the empty chat screen: an icon, a title and short
+ * description the reader sees, and the message that is sent as if they typed it
+ * when they click the card. Configured per workspace in the dashboard's
+ * Appearance tab.
  */
 declare const starterPromptSchema: z.ZodObject<{
     title: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
     message: z.ZodString;
+    icon: z.ZodOptional<z.ZodEnum<{
+        file: "file";
+        sparkles: "sparkles";
+        wand: "wand";
+        book: "book";
+        chat: "chat";
+        chart: "chart";
+        bolt: "bolt";
+        music: "music";
+        mic: "mic";
+        image: "image";
+        compass: "compass";
+        lightbulb: "lightbulb";
+    }>>;
 }, z.core.$strip>;
 declare const agentConfigSchema: z.ZodObject<{
     systemPrompt: z.ZodDefault<z.ZodString>;
@@ -197,6 +218,20 @@ declare const agentConfigSchema: z.ZodObject<{
         title: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
         message: z.ZodString;
+        icon: z.ZodOptional<z.ZodEnum<{
+            file: "file";
+            sparkles: "sparkles";
+            wand: "wand";
+            book: "book";
+            chat: "chat";
+            chart: "chart";
+            bolt: "bolt";
+            music: "music";
+            mic: "mic";
+            image: "image";
+            compass: "compass";
+            lightbulb: "lightbulb";
+        }>>;
     }, z.core.$strip>>>;
     maxTurns: z.ZodDefault<z.ZodNumber>;
     maxBudgetUsd: z.ZodOptional<z.ZodNumber>;
@@ -286,6 +321,20 @@ declare const frankieConfigSchema: z.ZodObject<{
             title: z.ZodString;
             description: z.ZodOptional<z.ZodString>;
             message: z.ZodString;
+            icon: z.ZodOptional<z.ZodEnum<{
+                file: "file";
+                sparkles: "sparkles";
+                wand: "wand";
+                book: "book";
+                chat: "chat";
+                chart: "chart";
+                bolt: "bolt";
+                music: "music";
+                mic: "mic";
+                image: "image";
+                compass: "compass";
+                lightbulb: "lightbulb";
+            }>>;
         }, z.core.$strip>>>;
         maxTurns: z.ZodDefault<z.ZodNumber>;
         maxBudgetUsd: z.ZodOptional<z.ZodNumber>;
@@ -614,6 +663,8 @@ interface StarterPrompt {
     title: string;
     description?: string;
     message: string;
+    /** One of STARTER_PROMPT_ICONS; the widget maps it to a concrete icon. */
+    icon?: string;
 }
 /** The subset of tenant config the widget is allowed to see. */
 interface PublicWidgetConfig {
@@ -686,6 +737,13 @@ interface ToolDecision {
  * also allows every tool on the `acme` server.
  */
 declare function evaluateToolPolicy(toolName: string, policy: ToolPolicy): ToolDecision;
+/**
+ * The agent-harness tool a skill-following agent calls to announce which
+ * reviewed workspace skill it is about to apply. It grants no permissions and
+ * does nothing on its own — it exists so a skill shows up in the transcript like
+ * any other tool call, instead of being followed invisibly.
+ */
+declare const SKILL_TOOL_NAME = "frankie__use_skill";
 /** A short human label for a tool call, for the "Frankie is …" line in the UI. */
 declare function describeTool(toolName: string, input: unknown): string;
 
@@ -807,4 +865,4 @@ declare function compareApiDocuments(before: ApiDocument, after: ApiDocument): {
     unchangedIds: string[];
 };
 
-export { type AgentConfig, type ApiCapability, type ApiDocument, type ApiSourceConfig, type ApiToolInventory, type AuthConfig, type AuthStrategy, type BrandingConfig, type ChatAttachment, type ChatRequestBody, type CreateSessionBody, type CreateSessionResponse, FIREWORKS_MODELS, type FeaturesConfig, type FrankieConfig, type FrankieConfigInput, type FrankieErrorCode, type FrankieServerEvent, type HostToolRequest, type HostToolResult, type InstallPlan, type InstallProject, type LimitsConfig, type LoadedSkill, type McpServerConfig, type ModelChoice, type ModelConfig, type PublicFeatures, type PublicWidgetConfig, type StarterPrompt, type StopReason, type ThinkingLevel, type ToolDecision, type ToolPolicy, type ToolResultBody, type UsageSummary, type WidgetTheme, type WidgetThemeConfig, type WorkspaceSkill, activeSkills, agentConfigSchema, apiCapabilitySchema, apiMethods, apiOperations, apiSourceSchema, approvedSkillTools, assertNoCommittedFrankieKeys, authConfigSchema, brandingConfigSchema, canonicalJson, compareApiDocuments, defineFrankieConfig, describeTool, draftSkill, evaluateToolPolicy, featuresConfigSchema, frankieConfigSchema, limitsConfigSchema, matchPath, mcpServerSchema, modelChoiceSchema, modelConfigSchema, operationId, parseFrankieConfig, planHostedInstall, sdkUpdateWorkflow, skillSchema, starterPromptSchema, suggestedPromptsFromSkills, thinkingLevelSchema, toolDescriptions, toolPolicySchema, validateApiDocument, widgetThemeSchema };
+export { type AgentConfig, type ApiCapability, type ApiDocument, type ApiSourceConfig, type ApiToolInventory, type AuthConfig, type AuthStrategy, type BrandingConfig, type ChatAttachment, type ChatRequestBody, type CreateSessionBody, type CreateSessionResponse, FIREWORKS_MODELS, type FeaturesConfig, type FrankieConfig, type FrankieConfigInput, type FrankieErrorCode, type FrankieServerEvent, type HostToolRequest, type HostToolResult, type InstallPlan, type InstallProject, type LimitsConfig, type LoadedSkill, type McpServerConfig, type ModelChoice, type ModelConfig, type PublicFeatures, type PublicWidgetConfig, SKILL_TOOL_NAME, STARTER_PROMPT_ICONS, type StarterPrompt, type StarterPromptIcon, type StopReason, type ThinkingLevel, type ToolDecision, type ToolPolicy, type ToolResultBody, type UsageSummary, type WidgetTheme, type WidgetThemeConfig, type WorkspaceSkill, activeSkills, agentConfigSchema, apiCapabilitySchema, apiMethods, apiOperations, apiSourceSchema, approvedSkillTools, assertNoCommittedFrankieKeys, authConfigSchema, brandingConfigSchema, canonicalJson, compareApiDocuments, defineFrankieConfig, describeTool, draftSkill, evaluateToolPolicy, featuresConfigSchema, frankieConfigSchema, limitsConfigSchema, matchPath, mcpServerSchema, modelChoiceSchema, modelConfigSchema, operationId, parseFrankieConfig, planHostedInstall, sdkUpdateWorkflow, skillSchema, starterPromptSchema, suggestedPromptsFromSkills, thinkingLevelSchema, toolDescriptions, toolPolicySchema, validateApiDocument, widgetThemeSchema };

package/dist/index.d.ts

@@ -180,14 +180,35 @@ declare const toolPolicySchema: z.ZodObject<{
     denyByDefault: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>;
 /**
- * A starter card shown on the empty chat screen: a title and short description
- * the reader sees, and the message that is sent as if they typed it when they
- * click the card. Configured per workspace in the dashboard's Appearance tab.
+ * The icons a starter card may use, shared by the dashboard picker and the SDK
+ * so the choices stay in step. Each maps to a concrete icon in the widget.
+ */
+declare const STARTER_PROMPT_ICONS: readonly ["sparkles", "wand", "book", "chat", "chart", "bolt", "music", "mic", "image", "compass", "lightbulb", "file"];
+type StarterPromptIcon = (typeof STARTER_PROMPT_ICONS)[number];
+/**
+ * A starter card shown on the empty chat screen: an icon, a title and short
+ * description the reader sees, and the message that is sent as if they typed it
+ * when they click the card. Configured per workspace in the dashboard's
+ * Appearance tab.
  */
 declare const starterPromptSchema: z.ZodObject<{
     title: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
     message: z.ZodString;
+    icon: z.ZodOptional<z.ZodEnum<{
+        file: "file";
+        sparkles: "sparkles";
+        wand: "wand";
+        book: "book";
+        chat: "chat";
+        chart: "chart";
+        bolt: "bolt";
+        music: "music";
+        mic: "mic";
+        image: "image";
+        compass: "compass";
+        lightbulb: "lightbulb";
+    }>>;
 }, z.core.$strip>;
 declare const agentConfigSchema: z.ZodObject<{
     systemPrompt: z.ZodDefault<z.ZodString>;
@@ -197,6 +218,20 @@ declare const agentConfigSchema: z.ZodObject<{
         title: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
         message: z.ZodString;
+        icon: z.ZodOptional<z.ZodEnum<{
+            file: "file";
+            sparkles: "sparkles";
+            wand: "wand";
+            book: "book";
+            chat: "chat";
+            chart: "chart";
+            bolt: "bolt";
+            music: "music";
+            mic: "mic";
+            image: "image";
+            compass: "compass";
+            lightbulb: "lightbulb";
+        }>>;
     }, z.core.$strip>>>;
     maxTurns: z.ZodDefault<z.ZodNumber>;
     maxBudgetUsd: z.ZodOptional<z.ZodNumber>;
@@ -286,6 +321,20 @@ declare const frankieConfigSchema: z.ZodObject<{
             title: z.ZodString;
             description: z.ZodOptional<z.ZodString>;
             message: z.ZodString;
+            icon: z.ZodOptional<z.ZodEnum<{
+                file: "file";
+                sparkles: "sparkles";
+                wand: "wand";
+                book: "book";
+                chat: "chat";
+                chart: "chart";
+                bolt: "bolt";
+                music: "music";
+                mic: "mic";
+                image: "image";
+                compass: "compass";
+                lightbulb: "lightbulb";
+            }>>;
         }, z.core.$strip>>>;
         maxTurns: z.ZodDefault<z.ZodNumber>;
         maxBudgetUsd: z.ZodOptional<z.ZodNumber>;
@@ -614,6 +663,8 @@ interface StarterPrompt {
     title: string;
     description?: string;
     message: string;
+    /** One of STARTER_PROMPT_ICONS; the widget maps it to a concrete icon. */
+    icon?: string;
 }
 /** The subset of tenant config the widget is allowed to see. */
 interface PublicWidgetConfig {
@@ -686,6 +737,13 @@ interface ToolDecision {
  * also allows every tool on the `acme` server.
  */
 declare function evaluateToolPolicy(toolName: string, policy: ToolPolicy): ToolDecision;
+/**
+ * The agent-harness tool a skill-following agent calls to announce which
+ * reviewed workspace skill it is about to apply. It grants no permissions and
+ * does nothing on its own — it exists so a skill shows up in the transcript like
+ * any other tool call, instead of being followed invisibly.
+ */
+declare const SKILL_TOOL_NAME = "frankie__use_skill";
 /** A short human label for a tool call, for the "Frankie is …" line in the UI. */
 declare function describeTool(toolName: string, input: unknown): string;
 
@@ -807,4 +865,4 @@ declare function compareApiDocuments(before: ApiDocument, after: ApiDocument): {
     unchangedIds: string[];
 };
 
-export { type AgentConfig, type ApiCapability, type ApiDocument, type ApiSourceConfig, type ApiToolInventory, type AuthConfig, type AuthStrategy, type BrandingConfig, type ChatAttachment, type ChatRequestBody, type CreateSessionBody, type CreateSessionResponse, FIREWORKS_MODELS, type FeaturesConfig, type FrankieConfig, type FrankieConfigInput, type FrankieErrorCode, type FrankieServerEvent, type HostToolRequest, type HostToolResult, type InstallPlan, type InstallProject, type LimitsConfig, type LoadedSkill, type McpServerConfig, type ModelChoice, type ModelConfig, type PublicFeatures, type PublicWidgetConfig, type StarterPrompt, type StopReason, type ThinkingLevel, type ToolDecision, type ToolPolicy, type ToolResultBody, type UsageSummary, type WidgetTheme, type WidgetThemeConfig, type WorkspaceSkill, activeSkills, agentConfigSchema, apiCapabilitySchema, apiMethods, apiOperations, apiSourceSchema, approvedSkillTools, assertNoCommittedFrankieKeys, authConfigSchema, brandingConfigSchema, canonicalJson, compareApiDocuments, defineFrankieConfig, describeTool, draftSkill, evaluateToolPolicy, featuresConfigSchema, frankieConfigSchema, limitsConfigSchema, matchPath, mcpServerSchema, modelChoiceSchema, modelConfigSchema, operationId, parseFrankieConfig, planHostedInstall, sdkUpdateWorkflow, skillSchema, starterPromptSchema, suggestedPromptsFromSkills, thinkingLevelSchema, toolDescriptions, toolPolicySchema, validateApiDocument, widgetThemeSchema };
+export { type AgentConfig, type ApiCapability, type ApiDocument, type ApiSourceConfig, type ApiToolInventory, type AuthConfig, type AuthStrategy, type BrandingConfig, type ChatAttachment, type ChatRequestBody, type CreateSessionBody, type CreateSessionResponse, FIREWORKS_MODELS, type FeaturesConfig, type FrankieConfig, type FrankieConfigInput, type FrankieErrorCode, type FrankieServerEvent, type HostToolRequest, type HostToolResult, type InstallPlan, type InstallProject, type LimitsConfig, type LoadedSkill, type McpServerConfig, type ModelChoice, type ModelConfig, type PublicFeatures, type PublicWidgetConfig, SKILL_TOOL_NAME, STARTER_PROMPT_ICONS, type StarterPrompt, type StarterPromptIcon, type StopReason, type ThinkingLevel, type ToolDecision, type ToolPolicy, type ToolResultBody, type UsageSummary, type WidgetTheme, type WidgetThemeConfig, type WorkspaceSkill, activeSkills, agentConfigSchema, apiCapabilitySchema, apiMethods, apiOperations, apiSourceSchema, approvedSkillTools, assertNoCommittedFrankieKeys, authConfigSchema, brandingConfigSchema, canonicalJson, compareApiDocuments, defineFrankieConfig, describeTool, draftSkill, evaluateToolPolicy, featuresConfigSchema, frankieConfigSchema, limitsConfigSchema, matchPath, mcpServerSchema, modelChoiceSchema, modelConfigSchema, operationId, parseFrankieConfig, planHostedInstall, sdkUpdateWorkflow, skillSchema, starterPromptSchema, suggestedPromptsFromSkills, thinkingLevelSchema, toolDescriptions, toolPolicySchema, validateApiDocument, widgetThemeSchema };

package/dist/index.js

@@ -26,12 +26,24 @@ function matches(toolName, pattern) {
   if (toolName === pattern) return true;
   return toolName.startsWith(`${pattern}__`);
 }
+var SKILL_TOOL_NAME = "frankie__use_skill";
 function describeTool(toolName, input) {
+  if (toolName === SKILL_TOOL_NAME) {
+    const skill = typeof input === "object" && input !== null ? input["skill"] : void 0;
+    return typeof skill === "string" && skill.trim() ? `Using skill: ${skill.trim()}` : "Using a skill";
+  }
   const mcp = /^mcp__([^_]+(?:_[^_]+)*)__(.+)$/.exec(toolName);
   if (mcp) {
     const [, server, tool] = mcp;
     return `${humanise(tool ?? toolName)} \xB7 ${server}`;
   }
+  if (toolName.startsWith("api__")) {
+    const rest = toolName.slice("api__".length);
+    const sep = rest.indexOf("__");
+    const operation = (sep >= 0 ? rest.slice(sep + 2) : rest).replace(/__+/g, "_");
+    const verb = /^(get|post|put|patch|delete|head|options)_(.+)$/i.exec(operation);
+    return verb ? `${verb[1].toUpperCase()} ${humanise(verb[2])}` : humanise(operation);
+  }
   const inputRecord = typeof input === "object" && input !== null ? input : {};
   const hint = inputRecord["path"] ?? inputRecord["url"] ?? inputRecord["query"] ?? inputRecord["command"];
   return typeof hint === "string" ? `${humanise(toolName)}: ${truncate(hint, 60)}` : humanise(toolName);
@@ -364,10 +376,26 @@ var toolPolicySchema = z2.object({
    */
   denyByDefault: z2.boolean().default(true)
 });
+var STARTER_PROMPT_ICONS = [
+  "sparkles",
+  "wand",
+  "book",
+  "chat",
+  "chart",
+  "bolt",
+  "music",
+  "mic",
+  "image",
+  "compass",
+  "lightbulb",
+  "file"
+];
 var starterPromptSchema = z2.object({
   title: z2.string().trim().min(1).max(80),
   description: z2.string().trim().max(160).optional(),
-  message: z2.string().trim().min(1).max(2e3)
+  message: z2.string().trim().min(1).max(2e3),
+  /** One of STARTER_PROMPT_ICONS; unknown values fall back to a default icon. */
+  icon: z2.enum(STARTER_PROMPT_ICONS).optional()
 });
 var agentConfigSchema = z2.object({
   /** Prepended to the runtime's own operating instructions. */
@@ -1050,6 +1078,8 @@ function compareApiDocuments(before, after) {
 }
 export {
   FIREWORKS_MODELS,
+  SKILL_TOOL_NAME,
+  STARTER_PROMPT_ICONS,
   activeSkills,
   agentConfigSchema,
   apiCapabilitySchema,