@frankieai/core 0.2.7 → 0.2.9

package/dist/index.d.cts

@@ -248,6 +248,7 @@ declare const agentConfigSchema: z.ZodObject<{
         denyByDefault: z.ZodDefault<z.ZodBoolean>;
     }, z.core.$strip>>;
     showToolActivity: z.ZodDefault<z.ZodBoolean>;
+    confirmWrites: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>;
 declare const authConfigSchema: z.ZodObject<{
     publishableKey: z.ZodString;
@@ -348,6 +349,7 @@ declare const personaProfileSchema: z.ZodObject<{
             denyByDefault: z.ZodDefault<z.ZodBoolean>;
         }, z.core.$strip>>;
         showToolActivity: z.ZodDefault<z.ZodBoolean>;
+        confirmWrites: z.ZodDefault<z.ZodBoolean>;
     }, z.core.$strip>>;
     features: z.ZodPrefault<z.ZodObject<{
         attachments: z.ZodPrefault<z.ZodObject<{
@@ -454,6 +456,7 @@ declare const frankieConfigSchema: z.ZodObject<{
             denyByDefault: z.ZodDefault<z.ZodBoolean>;
         }, z.core.$strip>>;
         showToolActivity: z.ZodDefault<z.ZodBoolean>;
+        confirmWrites: z.ZodDefault<z.ZodBoolean>;
     }, z.core.$strip>>;
     auth: z.ZodObject<{
         publishableKey: z.ZodString;
@@ -624,6 +627,7 @@ declare const frankieConfigSchema: z.ZodObject<{
                 denyByDefault: z.ZodDefault<z.ZodBoolean>;
             }, z.core.$strip>>;
             showToolActivity: z.ZodDefault<z.ZodBoolean>;
+            confirmWrites: z.ZodDefault<z.ZodBoolean>;
         }, z.core.$strip>>;
         features: z.ZodPrefault<z.ZodObject<{
             attachments: z.ZodPrefault<z.ZodObject<{
@@ -655,6 +659,7 @@ declare const frankieConfigSchema: z.ZodObject<{
             maxPages: z.ZodDefault<z.ZodNumber>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
+    agentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 type ThinkingLevel = z.infer<typeof thinkingLevelSchema>;
 type WidgetThemeConfig = z.infer<typeof widgetThemeSchema>;
@@ -761,6 +766,18 @@ type FrankieServerEvent = {
     name: string;
     reason: string;
 }
+/**
+ * An action that changes data is waiting for the user. The widget shows it
+ * with Approve and Cancel and answers with `confirm` on the next message.
+ * Nothing has run yet; on Approve the server runs exactly this call.
+ */
+ | {
+    type: "action_confirm";
+    toolUseId: string;
+    name: string;
+    label: string;
+    preview: ActionPreview;
+}
 /**
  * Client-side tool execution: the server asks the widget to make one HTTP
  * call to the host's own API, from the user's browser and on the user's
@@ -849,6 +866,13 @@ interface ChatRequestBody {
     /** Omit to start a new conversation; the server replies with a `session` event. */
     sessionId?: string;
     message: string;
+    /**
+     * A fresh host-signed user token for the session's own user. Host tokens are
+     * short-lived (minutes) while a session lasts an hour, so the widget sends a
+     * new one with each message and the server forwards that one to the
+     * workspace's tools instead of the expired one it started with.
+     */
+    userToken?: string;
     /**
      * Free-form page context the host passes through (current route, plan tier,
      * feature flags). Surfaced to the agent as a system reminder, never trusted
@@ -862,6 +886,33 @@ interface ChatRequestBody {
     model?: string;
     /** Files attached to this turn. Honoured only when attachments are enabled. */
     attachments?: ChatAttachment[];
+    /**
+     * The widget can show an `action_confirm` card. Without it, actions run as
+     * they always have, so an SDK that can't ask the user is never left with a
+     * paused action and no button to approve it.
+     */
+    confirmActions?: boolean;
+    /**
+     * The widget renders Markdown tables, so the agent may answer report-style
+     * questions with one. Older widgets would show raw `|` text, so it's opt-in.
+     */
+    markdownTables?: boolean;
+    /** The user's answer to the action waiting for approval (`action_confirm`). */
+    confirm?: ActionDecision;
+}
+/** Approve or cancel the action an `action_confirm` event paused. */
+interface ActionDecision {
+    /** The `toolUseId` from the `action_confirm` event. */
+    toolUseId: string;
+    approved: boolean;
+}
+/** What an action that's waiting for approval will do, for the confirmation card. */
+interface ActionPreview {
+    /** HTTP method and path for an API action, when there is one. */
+    method?: string;
+    path?: string;
+    /** The exact inputs it will run with. */
+    input?: unknown;
 }
 /** Client -> server body for `POST /v1/session`. */
 interface CreateSessionBody {
@@ -915,6 +966,12 @@ interface PublicWidgetConfig {
     features: PublicFeatures;
     /** App-Router path globs this agent shows on; empty = every page no other agent claims. Optional so older servers stay compatible. */
     pages?: string[];
+    /**
+     * Whether the chat shows the "Agent context" bar (skills and APIs loaded for
+     * the turn). Off for visitor-facing page agents such as Support and Docs,
+     * where it means nothing to the person chatting. Absent (older servers) = shown.
+     */
+    agentContext?: boolean;
 }
 /** The subset of `features` config the widget needs to render its controls. */
 interface PublicFeatures {
@@ -1103,6 +1160,20 @@ declare function renderJson(value: unknown, original: string | undefined): strin
  */
 declare function moduleImporter(files: Record<string, string>, root: string, sourceRoot: string): (fromFile: string, module: string) => string;
 
+/**
+ * A prompt a developer pastes into their AI coding assistant (Claude Code,
+ * Cursor, Copilot…) to add Frankie to their app. The docs show it with
+ * placeholders; the dashboard fills in the workspace's own ID and public key.
+ * It never contains a secret: FRANKIE_JWT_SECRET is only ever named.
+ */
+interface InstallPromptOptions {
+    workspaceId?: string;
+    publishableKey?: string;
+    /** The workspace lets visitors chat without signing in: no token endpoint. */
+    allowAnonymous?: boolean;
+}
+declare function installPrompt(options?: InstallPromptOptions): string;
+
 declare const skillSchema: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
@@ -1223,4 +1294,82 @@ declare function normalizeColor(raw: string): string | undefined;
  */
 declare function inferTheme(files: Record<string, string>, root?: string): InferredTheme | undefined;
 
-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 InferredTheme, type InstallPlan, type InstallProject, type KnowledgeBaseConfig, type LimitsConfig, type LoadedSkill, type McpServerConfig, type ModelChoice, type ModelConfig, type PersonaProfile, type PublicFeatures, type PublicWidgetConfig, SKILL_TOOL_NAME, STANDARD_AGENT_IDS, 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, inferTheme, insertImport, installAgentIds, installBranch, installTitle, knowledgeBaseSchema, knowledgeSourceSchema, limitsConfigSchema, matchPath, matchesAnyPagePattern, matchesInstallBranch, matchesPagePattern, mcpServerSchema, modelChoiceSchema, modelConfigSchema, moduleImporter, mountWidget, normalizeColor, operationId, parseFrankieConfig, personaEnvKey, personaInstructions, personaProfileSchema, plainText, planHostedInstall, renderJson, resolvePersonaConfig, sdkUpdateWorkflow, skillSchema, starterPromptSchema, suggestedPromptsFromSkills, thinkingLevelSchema, toolDescriptions, toolPolicySchema, validateApiDocument, widgetThemeSchema, withDependencies };
+/** Who an end user is, as far as their own app's sign-in token said. */
+type EndUser = {
+    id: string;
+    displayName?: string;
+    email?: string;
+    anonymous: boolean;
+};
+/**
+ * One label for the person behind a conversation, used by the list, the
+ * transcript and the escalations inbox so they always agree. A token's name
+ * wins, then its email; a signed-in user whose app sent neither still gets a
+ * short id, so two people never read as the same "Signed-in user".
+ */
+declare function userLabel(user: EndUser): string;
+/** What a conversation log is built from: the stored conversation as the dashboard and the server both see it. */
+interface ConversationLogInput {
+    id: string;
+    title: string;
+    createdAt: number;
+    updatedAt: number;
+    costUsd: number;
+    busy: boolean;
+    user: EndUser;
+    /** The transcript the chat UI saved. */
+    messages: unknown[];
+    /** The server's model and tool transcript. */
+    agentMessages: unknown[];
+    escalations?: Array<{
+        id: string;
+        at: number;
+        reason: string;
+        summary: string;
+        email?: string;
+        name?: string;
+    }>;
+}
+/**
+ * One conversation as plain Markdown, written to be pasted into any LLM to ask
+ * what happened: a summary, the chat as the person saw it, then the agent's
+ * full trace (model messages, tool calls with their inputs, tool results and
+ * errors). Images are noted, not inlined, and very long blocks are cut so the
+ * log stays pasteable.
+ */
+declare function conversationLog(conversation: ConversationLogInput, options?: {
+    workspace?: {
+        id: string;
+        name: string;
+    };
+    agent?: string;
+}): string;
+/** A file name for the downloaded log. */
+declare function conversationLogFileName(conversation: {
+    id: string;
+    title: string;
+}): string;
+
+/** Where Frankie's sync workflow lives in a repository. */
+declare const API_SYNC_WORKFLOW_PATH = ".github/workflows/frankie-api-sync.yml";
+interface ApiSyncWorkflowOptions {
+    /** The Frankie service the workflow posts to (the control plane's public URL). */
+    url: string;
+    /** The workspace id. */
+    workspace: string;
+    /** The API connection's name in that workspace. */
+    api: string;
+    /** The API description file in the repository, e.g. "public/openapi.json". */
+    path: string;
+}
+/**
+ * A repository-owned workflow that sends the API description to Frankie on
+ * every push to the default branch that changes it. It holds no secret: it
+ * asks GitHub for an OIDC token (audience "frankie") that proves the
+ * repository and commit, and Frankie checks that against the workspace.
+ */
+declare function apiSyncWorkflow(options: ApiSyncWorkflowOptions): string;
+/** A plain file path in the repository: no traversal, quoting or glob characters. */
+declare function isSafeRepositoryPath(path: string): boolean;
+
+export { API_SYNC_WORKFLOW_PATH, type ActionDecision, type ActionPreview, type AgentConfig, type ApiCapability, type ApiDocument, type ApiSourceConfig, type ApiSyncWorkflowOptions, type ApiToolInventory, type AuthConfig, type AuthStrategy, type BrandingConfig, type ChatAttachment, type ChatRequestBody, type ConversationLogInput, type CreateSessionBody, type CreateSessionResponse, type EndUser, FIREWORKS_MODELS, type FeaturesConfig, type FrankieConfig, type FrankieConfigInput, type FrankieErrorCode, type FrankieServerEvent, type HostToolRequest, type HostToolResult, type InferredTheme, type InstallPlan, type InstallProject, type InstallPromptOptions, type KnowledgeBaseConfig, type LimitsConfig, type LoadedSkill, type McpServerConfig, type ModelChoice, type ModelConfig, type PersonaProfile, type PublicFeatures, type PublicWidgetConfig, SKILL_TOOL_NAME, STANDARD_AGENT_IDS, 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, apiSyncWorkflow, approvedSkillTools, assertNoCommittedFrankieKeys, authConfigSchema, brandingConfigSchema, canonicalJson, compareApiDocuments, conversationLog, conversationLogFileName, defineFrankieConfig, describeTool, draftSkill, evaluateToolPolicy, featuresConfigSchema, frankieConfigSchema, inferTheme, insertImport, installAgentIds, installBranch, installPrompt, installTitle, isSafeRepositoryPath, knowledgeBaseSchema, knowledgeSourceSchema, limitsConfigSchema, matchPath, matchesAnyPagePattern, matchesInstallBranch, matchesPagePattern, mcpServerSchema, modelChoiceSchema, modelConfigSchema, moduleImporter, mountWidget, normalizeColor, operationId, parseFrankieConfig, personaEnvKey, personaInstructions, personaProfileSchema, plainText, planHostedInstall, renderJson, resolvePersonaConfig, sdkUpdateWorkflow, skillSchema, starterPromptSchema, suggestedPromptsFromSkills, thinkingLevelSchema, toolDescriptions, toolPolicySchema, userLabel, validateApiDocument, widgetThemeSchema, withDependencies };

package/dist/index.d.ts

@@ -248,6 +248,7 @@ declare const agentConfigSchema: z.ZodObject<{
         denyByDefault: z.ZodDefault<z.ZodBoolean>;
     }, z.core.$strip>>;
     showToolActivity: z.ZodDefault<z.ZodBoolean>;
+    confirmWrites: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>;
 declare const authConfigSchema: z.ZodObject<{
     publishableKey: z.ZodString;
@@ -348,6 +349,7 @@ declare const personaProfileSchema: z.ZodObject<{
             denyByDefault: z.ZodDefault<z.ZodBoolean>;
         }, z.core.$strip>>;
         showToolActivity: z.ZodDefault<z.ZodBoolean>;
+        confirmWrites: z.ZodDefault<z.ZodBoolean>;
     }, z.core.$strip>>;
     features: z.ZodPrefault<z.ZodObject<{
         attachments: z.ZodPrefault<z.ZodObject<{
@@ -454,6 +456,7 @@ declare const frankieConfigSchema: z.ZodObject<{
             denyByDefault: z.ZodDefault<z.ZodBoolean>;
         }, z.core.$strip>>;
         showToolActivity: z.ZodDefault<z.ZodBoolean>;
+        confirmWrites: z.ZodDefault<z.ZodBoolean>;
     }, z.core.$strip>>;
     auth: z.ZodObject<{
         publishableKey: z.ZodString;
@@ -624,6 +627,7 @@ declare const frankieConfigSchema: z.ZodObject<{
                 denyByDefault: z.ZodDefault<z.ZodBoolean>;
             }, z.core.$strip>>;
             showToolActivity: z.ZodDefault<z.ZodBoolean>;
+            confirmWrites: z.ZodDefault<z.ZodBoolean>;
         }, z.core.$strip>>;
         features: z.ZodPrefault<z.ZodObject<{
             attachments: z.ZodPrefault<z.ZodObject<{
@@ -655,6 +659,7 @@ declare const frankieConfigSchema: z.ZodObject<{
             maxPages: z.ZodDefault<z.ZodNumber>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
+    agentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 type ThinkingLevel = z.infer<typeof thinkingLevelSchema>;
 type WidgetThemeConfig = z.infer<typeof widgetThemeSchema>;
@@ -761,6 +766,18 @@ type FrankieServerEvent = {
     name: string;
     reason: string;
 }
+/**
+ * An action that changes data is waiting for the user. The widget shows it
+ * with Approve and Cancel and answers with `confirm` on the next message.
+ * Nothing has run yet; on Approve the server runs exactly this call.
+ */
+ | {
+    type: "action_confirm";
+    toolUseId: string;
+    name: string;
+    label: string;
+    preview: ActionPreview;
+}
 /**
  * Client-side tool execution: the server asks the widget to make one HTTP
  * call to the host's own API, from the user's browser and on the user's
@@ -849,6 +866,13 @@ interface ChatRequestBody {
     /** Omit to start a new conversation; the server replies with a `session` event. */
     sessionId?: string;
     message: string;
+    /**
+     * A fresh host-signed user token for the session's own user. Host tokens are
+     * short-lived (minutes) while a session lasts an hour, so the widget sends a
+     * new one with each message and the server forwards that one to the
+     * workspace's tools instead of the expired one it started with.
+     */
+    userToken?: string;
     /**
      * Free-form page context the host passes through (current route, plan tier,
      * feature flags). Surfaced to the agent as a system reminder, never trusted
@@ -862,6 +886,33 @@ interface ChatRequestBody {
     model?: string;
     /** Files attached to this turn. Honoured only when attachments are enabled. */
     attachments?: ChatAttachment[];
+    /**
+     * The widget can show an `action_confirm` card. Without it, actions run as
+     * they always have, so an SDK that can't ask the user is never left with a
+     * paused action and no button to approve it.
+     */
+    confirmActions?: boolean;
+    /**
+     * The widget renders Markdown tables, so the agent may answer report-style
+     * questions with one. Older widgets would show raw `|` text, so it's opt-in.
+     */
+    markdownTables?: boolean;
+    /** The user's answer to the action waiting for approval (`action_confirm`). */
+    confirm?: ActionDecision;
+}
+/** Approve or cancel the action an `action_confirm` event paused. */
+interface ActionDecision {
+    /** The `toolUseId` from the `action_confirm` event. */
+    toolUseId: string;
+    approved: boolean;
+}
+/** What an action that's waiting for approval will do, for the confirmation card. */
+interface ActionPreview {
+    /** HTTP method and path for an API action, when there is one. */
+    method?: string;
+    path?: string;
+    /** The exact inputs it will run with. */
+    input?: unknown;
 }
 /** Client -> server body for `POST /v1/session`. */
 interface CreateSessionBody {
@@ -915,6 +966,12 @@ interface PublicWidgetConfig {
     features: PublicFeatures;
     /** App-Router path globs this agent shows on; empty = every page no other agent claims. Optional so older servers stay compatible. */
     pages?: string[];
+    /**
+     * Whether the chat shows the "Agent context" bar (skills and APIs loaded for
+     * the turn). Off for visitor-facing page agents such as Support and Docs,
+     * where it means nothing to the person chatting. Absent (older servers) = shown.
+     */
+    agentContext?: boolean;
 }
 /** The subset of `features` config the widget needs to render its controls. */
 interface PublicFeatures {
@@ -1103,6 +1160,20 @@ declare function renderJson(value: unknown, original: string | undefined): strin
  */
 declare function moduleImporter(files: Record<string, string>, root: string, sourceRoot: string): (fromFile: string, module: string) => string;
 
+/**
+ * A prompt a developer pastes into their AI coding assistant (Claude Code,
+ * Cursor, Copilot…) to add Frankie to their app. The docs show it with
+ * placeholders; the dashboard fills in the workspace's own ID and public key.
+ * It never contains a secret: FRANKIE_JWT_SECRET is only ever named.
+ */
+interface InstallPromptOptions {
+    workspaceId?: string;
+    publishableKey?: string;
+    /** The workspace lets visitors chat without signing in: no token endpoint. */
+    allowAnonymous?: boolean;
+}
+declare function installPrompt(options?: InstallPromptOptions): string;
+
 declare const skillSchema: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
@@ -1223,4 +1294,82 @@ declare function normalizeColor(raw: string): string | undefined;
  */
 declare function inferTheme(files: Record<string, string>, root?: string): InferredTheme | undefined;
 
-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 InferredTheme, type InstallPlan, type InstallProject, type KnowledgeBaseConfig, type LimitsConfig, type LoadedSkill, type McpServerConfig, type ModelChoice, type ModelConfig, type PersonaProfile, type PublicFeatures, type PublicWidgetConfig, SKILL_TOOL_NAME, STANDARD_AGENT_IDS, 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, inferTheme, insertImport, installAgentIds, installBranch, installTitle, knowledgeBaseSchema, knowledgeSourceSchema, limitsConfigSchema, matchPath, matchesAnyPagePattern, matchesInstallBranch, matchesPagePattern, mcpServerSchema, modelChoiceSchema, modelConfigSchema, moduleImporter, mountWidget, normalizeColor, operationId, parseFrankieConfig, personaEnvKey, personaInstructions, personaProfileSchema, plainText, planHostedInstall, renderJson, resolvePersonaConfig, sdkUpdateWorkflow, skillSchema, starterPromptSchema, suggestedPromptsFromSkills, thinkingLevelSchema, toolDescriptions, toolPolicySchema, validateApiDocument, widgetThemeSchema, withDependencies };
+/** Who an end user is, as far as their own app's sign-in token said. */
+type EndUser = {
+    id: string;
+    displayName?: string;
+    email?: string;
+    anonymous: boolean;
+};
+/**
+ * One label for the person behind a conversation, used by the list, the
+ * transcript and the escalations inbox so they always agree. A token's name
+ * wins, then its email; a signed-in user whose app sent neither still gets a
+ * short id, so two people never read as the same "Signed-in user".
+ */
+declare function userLabel(user: EndUser): string;
+/** What a conversation log is built from: the stored conversation as the dashboard and the server both see it. */
+interface ConversationLogInput {
+    id: string;
+    title: string;
+    createdAt: number;
+    updatedAt: number;
+    costUsd: number;
+    busy: boolean;
+    user: EndUser;
+    /** The transcript the chat UI saved. */
+    messages: unknown[];
+    /** The server's model and tool transcript. */
+    agentMessages: unknown[];
+    escalations?: Array<{
+        id: string;
+        at: number;
+        reason: string;
+        summary: string;
+        email?: string;
+        name?: string;
+    }>;
+}
+/**
+ * One conversation as plain Markdown, written to be pasted into any LLM to ask
+ * what happened: a summary, the chat as the person saw it, then the agent's
+ * full trace (model messages, tool calls with their inputs, tool results and
+ * errors). Images are noted, not inlined, and very long blocks are cut so the
+ * log stays pasteable.
+ */
+declare function conversationLog(conversation: ConversationLogInput, options?: {
+    workspace?: {
+        id: string;
+        name: string;
+    };
+    agent?: string;
+}): string;
+/** A file name for the downloaded log. */
+declare function conversationLogFileName(conversation: {
+    id: string;
+    title: string;
+}): string;
+
+/** Where Frankie's sync workflow lives in a repository. */
+declare const API_SYNC_WORKFLOW_PATH = ".github/workflows/frankie-api-sync.yml";
+interface ApiSyncWorkflowOptions {
+    /** The Frankie service the workflow posts to (the control plane's public URL). */
+    url: string;
+    /** The workspace id. */
+    workspace: string;
+    /** The API connection's name in that workspace. */
+    api: string;
+    /** The API description file in the repository, e.g. "public/openapi.json". */
+    path: string;
+}
+/**
+ * A repository-owned workflow that sends the API description to Frankie on
+ * every push to the default branch that changes it. It holds no secret: it
+ * asks GitHub for an OIDC token (audience "frankie") that proves the
+ * repository and commit, and Frankie checks that against the workspace.
+ */
+declare function apiSyncWorkflow(options: ApiSyncWorkflowOptions): string;
+/** A plain file path in the repository: no traversal, quoting or glob characters. */
+declare function isSafeRepositoryPath(path: string): boolean;
+
+export { API_SYNC_WORKFLOW_PATH, type ActionDecision, type ActionPreview, type AgentConfig, type ApiCapability, type ApiDocument, type ApiSourceConfig, type ApiSyncWorkflowOptions, type ApiToolInventory, type AuthConfig, type AuthStrategy, type BrandingConfig, type ChatAttachment, type ChatRequestBody, type ConversationLogInput, type CreateSessionBody, type CreateSessionResponse, type EndUser, FIREWORKS_MODELS, type FeaturesConfig, type FrankieConfig, type FrankieConfigInput, type FrankieErrorCode, type FrankieServerEvent, type HostToolRequest, type HostToolResult, type InferredTheme, type InstallPlan, type InstallProject, type InstallPromptOptions, type KnowledgeBaseConfig, type LimitsConfig, type LoadedSkill, type McpServerConfig, type ModelChoice, type ModelConfig, type PersonaProfile, type PublicFeatures, type PublicWidgetConfig, SKILL_TOOL_NAME, STANDARD_AGENT_IDS, 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, apiSyncWorkflow, approvedSkillTools, assertNoCommittedFrankieKeys, authConfigSchema, brandingConfigSchema, canonicalJson, compareApiDocuments, conversationLog, conversationLogFileName, defineFrankieConfig, describeTool, draftSkill, evaluateToolPolicy, featuresConfigSchema, frankieConfigSchema, inferTheme, insertImport, installAgentIds, installBranch, installPrompt, installTitle, isSafeRepositoryPath, knowledgeBaseSchema, knowledgeSourceSchema, limitsConfigSchema, matchPath, matchesAnyPagePattern, matchesInstallBranch, matchesPagePattern, mcpServerSchema, modelChoiceSchema, modelConfigSchema, moduleImporter, mountWidget, normalizeColor, operationId, parseFrankieConfig, personaEnvKey, personaInstructions, personaProfileSchema, plainText, planHostedInstall, renderJson, resolvePersonaConfig, sdkUpdateWorkflow, skillSchema, starterPromptSchema, suggestedPromptsFromSkills, thinkingLevelSchema, toolDescriptions, toolPolicySchema, userLabel, validateApiDocument, widgetThemeSchema, withDependencies };