@appilots/sdk 0.8.0 → 0.11.0

package/dist/registerScreen-D1oGm28T.d.mts

@@ -1,159 +0,0 @@
-import React__default from 'react';
-
-interface AppilotsNavigationContainerProps {
-    children: React__default.ReactElement;
-}
-/**
- * Wraps your NavigationContainer from the outside and automatically
- * injects `ref` and `onStateChange` to track the current screen.
- *
- * ```tsx
- * import { NavigationContainer } from '@react-navigation/native';
- * import { AppilotsNavigationContainer } from '@appilots/sdk';
- *
- * <AppilotsProvider>
- *   <AppilotsNavigationContainer>
- *     <NavigationContainer>
- *       <Stack.Navigator>...</Stack.Navigator>
- *     </NavigationContainer>
- *   </AppilotsNavigationContainer>
- *   <AppilotsChat />
- * </AppilotsProvider>
- * ```
- */
-declare function AppilotsNavigationContainer({ children }: AppilotsNavigationContainerProps): React__default.ReactElement<any, string | React__default.JSXElementConstructor<any>>;
-
-/**
- * Navigation-related types for the Appilots SDK.
- */
-interface ScreenFieldMetadata {
-    /** Field identifier (used by AI model to reference this field) */
-    id: string;
-    /** Human-readable label (must match the UI component's label) */
-    label: string;
-    /** Field type */
-    type: 'text' | 'number' | 'select' | 'toggle' | 'date' | string;
-    /** Whether the field is required */
-    required?: boolean;
-    /** Options for select fields */
-    options?: {
-        label: string;
-        value: string;
-    }[];
-}
-interface ScreenActionMetadata {
-    /** Action identifier (used by AI model to reference this action) */
-    id: string;
-    /** Human-readable label (must match the UI component's label) */
-    label: string;
-    /** Action type */
-    type: 'submit' | 'button' | 'link' | string;
-    /** Target screen for navigation/link actions, when known. */
-    targetScreen?: string;
-    /**
-     * When true, the agent MUST present a confirmation card to the user
-     * before executing this action. Set at registerScreen time for
-     * high-risk or destructive operations.
-     *
-     * The server's permission policy honours this flag when present in
-     * the MCP doc, but a stale MCP can miss it. As defense-in-depth,
-     * the SDK also gates such actions locally: when a `ui_interaction`
-     * targets an action with `requiresConfirmation: true` and there is
-     * NO already-pending confirm action in the queue, the executor
-     * synthesises one and waits for user input before pressing.
-     */
-    requiresConfirmation?: boolean;
-    /**
-     * Structured risk/effect metadata. Prefer these fields over label
-     * heuristics for multilingual apps: the runtime can gate the action
-     * without trying to infer intent from Portuguese/English/etc. text.
-     */
-    effect?: 'read' | 'write' | 'destructive' | string;
-    riskLevel?: 'low' | 'medium' | 'high' | string;
-    destructive?: boolean;
-    /**
-     * Static-analysis hints produced by the MCP generator (Camada B).
-     * Present only when the generator could statically prove the
-     * handler's async shape — otherwise undefined and the SDK falls
-     * back to agnostic runtime signals (ActivityIndicator,
-     * pressed-button-still-disabled, fingerprint quiescence).
-     *
-     * Mirrors `AppilotsInferredAction` from `@appilots/mcp-generator`.
-     * Kept as a structural type here to avoid a runtime dependency
-     * between sdk and mcp-generator packages.
-     */
-    appilotsInferred?: AppilotsInferredAction;
-}
-/**
- * Inferred metadata about an action's expected async behavior.
- * See `packages/mcp-generator/docs/INFERRED_ACTION_FIELDS.md` for
- * the full schema and detection rules.
- */
-interface AppilotsInferredAction {
-    isAsyncTrigger?: boolean;
-    expectedOutcome?: 'navigation' | 'inline-feedback' | 'data-arrival' | 'mixed' | 'none';
-    loadingStateBindings?: string[];
-}
-interface ScreenMetadata {
-    /** Unique screen identifier */
-    name: string;
-    /** Human-readable title */
-    title?: string;
-    /** Description of what this screen does */
-    description?: string;
-    /** Available actions on this screen (legacy: string[], new: ScreenActionMetadata[]) */
-    actions?: (string | ScreenActionMetadata)[];
-    /** Form fields available on this screen (legacy: string[], new: ScreenFieldMetadata[]) */
-    fields?: ScreenFieldMetadata[];
-    /** Legacy: simple list of form field names */
-    formFields?: string[];
-    /** Tags for categorisation */
-    tags?: string[];
-    /**
-     * Dev-defined prompts to surface as chips when the chat opens on this
-     * screen. Highest priority — these win over screen-action and global
-     * popular prompts. Keep them short and specific to the screen ("Adicionar
-     * cliente" beats "Me ajude").
-     *
-     * @example
-     * registerScreen({
-     *   name: 'Customers',
-     *   suggestedPrompts: ['Adicionar cliente', 'Buscar por nome'],
-     * });
-     */
-    suggestedPrompts?: string[];
-}
-interface NavigationConfig {
-    /** Root navigator name */
-    rootNavigator?: string;
-    /** Map of screen names to metadata */
-    screens?: Record<string, ScreenMetadata>;
-    /** Navigation linking config */
-    linking?: {
-        prefixes?: string[];
-        config?: Record<string, unknown>;
-    };
-}
-
-/**
- * Register a screen with metadata so the AI agent can understand it.
- *
- * @example
- * ```tsx
- * registerScreen({
- *   name: 'ItemList',
- *   title: 'Items',
- *   description: 'Lists items available in this app',
- *   actions: ['viewDetails', 'addItem'],
- * });
- * ```
- */
-declare function registerScreen(metadata: ScreenMetadata): void;
-/** Get metadata for a specific screen */
-declare function getScreenMetadata(name: string): ScreenMetadata | undefined;
-/** Get all registered screens */
-declare function getAllScreens(): ScreenMetadata[];
-/** Clear the screen registry (useful for testing) */
-declare function clearScreenRegistry(): void;
-
-export { AppilotsNavigationContainer as A, type NavigationConfig as N, type ScreenActionMetadata as S, type ScreenFieldMetadata as a, type ScreenMetadata as b, clearScreenRegistry as c, getScreenMetadata as d, getAllScreens as g, registerScreen as r };

package/dist/registerScreen-D1oGm28T.d.ts

@@ -1,159 +0,0 @@
-import React__default from 'react';
-
-interface AppilotsNavigationContainerProps {
-    children: React__default.ReactElement;
-}
-/**
- * Wraps your NavigationContainer from the outside and automatically
- * injects `ref` and `onStateChange` to track the current screen.
- *
- * ```tsx
- * import { NavigationContainer } from '@react-navigation/native';
- * import { AppilotsNavigationContainer } from '@appilots/sdk';
- *
- * <AppilotsProvider>
- *   <AppilotsNavigationContainer>
- *     <NavigationContainer>
- *       <Stack.Navigator>...</Stack.Navigator>
- *     </NavigationContainer>
- *   </AppilotsNavigationContainer>
- *   <AppilotsChat />
- * </AppilotsProvider>
- * ```
- */
-declare function AppilotsNavigationContainer({ children }: AppilotsNavigationContainerProps): React__default.ReactElement<any, string | React__default.JSXElementConstructor<any>>;
-
-/**
- * Navigation-related types for the Appilots SDK.
- */
-interface ScreenFieldMetadata {
-    /** Field identifier (used by AI model to reference this field) */
-    id: string;
-    /** Human-readable label (must match the UI component's label) */
-    label: string;
-    /** Field type */
-    type: 'text' | 'number' | 'select' | 'toggle' | 'date' | string;
-    /** Whether the field is required */
-    required?: boolean;
-    /** Options for select fields */
-    options?: {
-        label: string;
-        value: string;
-    }[];
-}
-interface ScreenActionMetadata {
-    /** Action identifier (used by AI model to reference this action) */
-    id: string;
-    /** Human-readable label (must match the UI component's label) */
-    label: string;
-    /** Action type */
-    type: 'submit' | 'button' | 'link' | string;
-    /** Target screen for navigation/link actions, when known. */
-    targetScreen?: string;
-    /**
-     * When true, the agent MUST present a confirmation card to the user
-     * before executing this action. Set at registerScreen time for
-     * high-risk or destructive operations.
-     *
-     * The server's permission policy honours this flag when present in
-     * the MCP doc, but a stale MCP can miss it. As defense-in-depth,
-     * the SDK also gates such actions locally: when a `ui_interaction`
-     * targets an action with `requiresConfirmation: true` and there is
-     * NO already-pending confirm action in the queue, the executor
-     * synthesises one and waits for user input before pressing.
-     */
-    requiresConfirmation?: boolean;
-    /**
-     * Structured risk/effect metadata. Prefer these fields over label
-     * heuristics for multilingual apps: the runtime can gate the action
-     * without trying to infer intent from Portuguese/English/etc. text.
-     */
-    effect?: 'read' | 'write' | 'destructive' | string;
-    riskLevel?: 'low' | 'medium' | 'high' | string;
-    destructive?: boolean;
-    /**
-     * Static-analysis hints produced by the MCP generator (Camada B).
-     * Present only when the generator could statically prove the
-     * handler's async shape — otherwise undefined and the SDK falls
-     * back to agnostic runtime signals (ActivityIndicator,
-     * pressed-button-still-disabled, fingerprint quiescence).
-     *
-     * Mirrors `AppilotsInferredAction` from `@appilots/mcp-generator`.
-     * Kept as a structural type here to avoid a runtime dependency
-     * between sdk and mcp-generator packages.
-     */
-    appilotsInferred?: AppilotsInferredAction;
-}
-/**
- * Inferred metadata about an action's expected async behavior.
- * See `packages/mcp-generator/docs/INFERRED_ACTION_FIELDS.md` for
- * the full schema and detection rules.
- */
-interface AppilotsInferredAction {
-    isAsyncTrigger?: boolean;
-    expectedOutcome?: 'navigation' | 'inline-feedback' | 'data-arrival' | 'mixed' | 'none';
-    loadingStateBindings?: string[];
-}
-interface ScreenMetadata {
-    /** Unique screen identifier */
-    name: string;
-    /** Human-readable title */
-    title?: string;
-    /** Description of what this screen does */
-    description?: string;
-    /** Available actions on this screen (legacy: string[], new: ScreenActionMetadata[]) */
-    actions?: (string | ScreenActionMetadata)[];
-    /** Form fields available on this screen (legacy: string[], new: ScreenFieldMetadata[]) */
-    fields?: ScreenFieldMetadata[];
-    /** Legacy: simple list of form field names */
-    formFields?: string[];
-    /** Tags for categorisation */
-    tags?: string[];
-    /**
-     * Dev-defined prompts to surface as chips when the chat opens on this
-     * screen. Highest priority — these win over screen-action and global
-     * popular prompts. Keep them short and specific to the screen ("Adicionar
-     * cliente" beats "Me ajude").
-     *
-     * @example
-     * registerScreen({
-     *   name: 'Customers',
-     *   suggestedPrompts: ['Adicionar cliente', 'Buscar por nome'],
-     * });
-     */
-    suggestedPrompts?: string[];
-}
-interface NavigationConfig {
-    /** Root navigator name */
-    rootNavigator?: string;
-    /** Map of screen names to metadata */
-    screens?: Record<string, ScreenMetadata>;
-    /** Navigation linking config */
-    linking?: {
-        prefixes?: string[];
-        config?: Record<string, unknown>;
-    };
-}
-
-/**
- * Register a screen with metadata so the AI agent can understand it.
- *
- * @example
- * ```tsx
- * registerScreen({
- *   name: 'ItemList',
- *   title: 'Items',
- *   description: 'Lists items available in this app',
- *   actions: ['viewDetails', 'addItem'],
- * });
- * ```
- */
-declare function registerScreen(metadata: ScreenMetadata): void;
-/** Get metadata for a specific screen */
-declare function getScreenMetadata(name: string): ScreenMetadata | undefined;
-/** Get all registered screens */
-declare function getAllScreens(): ScreenMetadata[];
-/** Clear the screen registry (useful for testing) */
-declare function clearScreenRegistry(): void;
-
-export { AppilotsNavigationContainer as A, type NavigationConfig as N, type ScreenActionMetadata as S, type ScreenFieldMetadata as a, type ScreenMetadata as b, clearScreenRegistry as c, getScreenMetadata as d, getAllScreens as g, registerScreen as r };