@sampleapp.ai/sdk 1.0.29 → 1.0.30

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 import { default as default_2 } from 'react';
+import * as React_2 from 'react';
+import { ReactNode } from 'react';
 
 export declare interface AiChatSettings {
     aiAssistantAvatar?: string;
@@ -13,7 +15,34 @@ export declare interface BaseSettings {
     [key: string]: any;
 }
 
-export declare const ChatBar: ({ placeholder, onSubmit, playgroundUid, isSubmitting, typingTexts, shouldFocusOnMount, showModelSelector, projectUid, theme, height, deepgramApiKey, }: ChatBarProps) => default_2.JSX.Element;
+/**
+ * Builds a nested GuardianConfig from use cases with nested frameworks.
+ * Returns a structure where config[useCaseId].frameworks[frameworkKey] gives you the full config.
+ *
+ * @example
+ * const config = buildGuardianConfig(USE_CASES, options);
+ * // Access via: config["full-stack-auth"].frameworks["nextjs"]
+ */
+export declare function buildGuardianConfig(useCases: GuardianUseCase[], options: BuildGuardianConfigOptions): GuardianNestedConfig;
+
+/**
+ * Options for building a Guardian config from use cases.
+ */
+export declare interface BuildGuardianConfigOptions {
+    /** Playground unique identifier */
+    playgroundUid: string;
+    /** Playground logo component */
+    playgroundLogo: ReactNode;
+    /**
+     * Optional map of framework keys to human-readable labels.
+     * If not provided, the shared FrameworkLabel map is used.
+     */
+    frameworkLabels?: Partial<Record<Framework, string>>;
+    /** Optional variant (defaults to undefined) */
+    variant?: GuardianComponentProps["variant"];
+}
+
+export declare const ChatBar: React_2.FC<ChatBarProps>;
 
 export declare interface ChatBarProps {
     playgroundUid: string;
@@ -38,10 +67,239 @@ declare interface ChatButtonProps {
     onClick?: () => void;
 }
 
+declare enum CodeLanguage {
+    JAVASCRIPT = "javascript",
+    TYPESCRIPT = "typescript",
+    HTML = "html",
+    CSS = "css",
+    SCSS = "scss",
+    MARKDOWN = "markdown",
+    TOML = "toml",
+    C = "c",
+    DOCKERFILE = "dockerfile",
+    PYTHON = "python",
+    JAVA = "java",
+    CSHARP = "csharp",
+    CPP = "cpp",
+    RUBY = "ruby",
+    GO = "go",
+    RUST = "rust",
+    SWIFT = "swift",
+    KOTLIN = "kotlin",
+    PHP = "php",
+    BASH = "bash",
+    POWERSHELL = "powershell",
+    SQL = "sql",
+    PLSQL = "plsql",
+    XML = "xml",
+    YAML = "yaml",
+    R = "r",
+    SCALA = "scala",
+    PERL = "perl",
+    HASKELL = "haskell",
+    MATLAB = "matlab",
+    ASSEMBLY = "assembly",
+    DART = "dart",
+    ELIXIR = "elixir",
+    LUA = "lua",
+    OBJECTIVEC = "objectivec",
+    TEXT = "text",
+    JSON = "json"
+}
+
+declare interface CodeOutput {
+    response_type: "CodeOutput";
+    file_path: string;
+    code_file_name: string;
+    code_language: CodeLanguage;
+    dependencies_to_install: string[];
+    framework: string | null;
+    full_code: string;
+}
+
+/**
+ * Creates sandbox URL configs for preloading from a framework's urlsToPreload.
+ * Only includes URLs that need VM preloading (useVm: true).
+ * Uses the same sandboxUid for all configs since caching is done by sandboxUid + browserUrl.
+ */
+export declare function createSandboxUrlConfigs(sandboxUid: string, urlsToPreload?: UrlToPreload[]): SandboxUrlConfig[];
+
 export declare const DEFAULT_THEME: ThemeName;
 
+export declare enum Framework {
+    FLASK = "flask",
+    EXPRESS = "express",
+    NEXTJS_YARN = "nextjsy",
+    VITE = "vite",
+    NEXTJS = "nextjs",
+    FASTAPI = "fastapi",
+    FASTMCP = "fastmcp"
+}
+
 export declare const getTheme: (themeName?: ThemeName) => ThemeColors;
 
+export declare function GuardianComponent({ demoOptions, frameworkOptions, firstFrameworkByUseCase, currentFramework, currentUseCase, CustomConsole, GuideView, playgroundLogo, playgroundUid, browserUrl, useVm, sandboxUid, codeZipFile, consoleUrlConfigs, completeCodeZipFile, variant, themeColor, hasPreview, isFrame, apiKey, env, chatUid, }: GuardianComponentProps): default_2.JSX.Element;
+
+export declare interface GuardianComponentProps {
+    name: string;
+    description: string;
+    demoOptions: {
+        label: string;
+        value: string;
+    }[];
+    frameworkOptions: {
+        label: string;
+        value: string;
+    }[];
+    CustomConsole: default_2.ComponentType<{
+        onReloadPreview: () => void;
+        onStageChange: (stage: "hidden" | "error" | "rebuilding") => void;
+        themeColor: string;
+    }> | string;
+    /** Maps use case ID to first available framework key */
+    firstFrameworkByUseCase?: Record<string, string>;
+    /** The current framework key for this sandbox */
+    currentFramework: string;
+    /** The current use case ID (for nested config navigation) */
+    currentUseCase?: string;
+    GuideView?: default_2.ComponentType | string;
+    playgroundLogo: default_2.ReactNode;
+    playgroundUid: string;
+    browserUrl: string;
+    useVm: boolean;
+    sandboxUid: string;
+    codeZipFile: string | UpdateContainerCodebaseType;
+    /**
+     * Optional console URL configs to preload.
+     * These are URLs used in the CustomConsole component.
+     */
+    completeCodeZipFile: string;
+    consoleUrlConfigs?: SandboxUrlConfig[];
+    variant?: "panel" | "top-down";
+    /**
+     * Hex color (e.g. "#3b82f6") used to theme Guardian UI elements.
+     */
+    themeColor: string;
+    /**
+     * Whether there is a preview available for the sandbox
+     */
+    hasPreview?: boolean;
+    /**
+     * Whether to render in frame mode (just the right view, no console/header)
+     */
+    isFrame?: boolean;
+    /** API key for starting sandbox */
+    apiKey?: string;
+    /** Environment variables for sandbox */
+    env?: Record<string, string>;
+    /** Chat UID for starting sandbox */
+    chatUid?: string;
+}
+
+/**
+ * Represents a single framework variant within a use case.
+ * Only contains the fields that differ per framework.
+ */
+export declare interface GuardianFramework {
+    /** Framework identifier key (e.g., "nextjs", "express", "fastapi") */
+    key: Framework;
+    /** Live browser URL for this framework variant */
+    browserUrl: string;
+    /** Unique sandbox identifier for this framework variant */
+    sandboxUid: string;
+    /** Path to the code zip file OR generated_code object (backward compatible) */
+    codeZipFile: string | UpdateContainerCodebaseType;
+    /** Download endpoint URL for the complete code zip file (e.g., `${baseUrl}/fileshare?container_id=${containerId}`) */
+    completeCodeZipFile: string;
+    /** Whether to use VM for this framework */
+    useVm: boolean;
+    /** Custom console component/string for this framework */
+    CustomConsole: GuardianComponentProps["CustomConsole"];
+    /** Optional custom guide view for this framework */
+    GuideView?: GuardianComponentProps["GuideView"];
+    /** Optional theme color override for this framework */
+    themeColor?: string;
+    /** Optional URLs to preload for this specific framework */
+    urlsToPreload?: UrlToPreload[];
+}
+
+/**
+ * Individual framework configuration within a use case
+ */
+declare interface GuardianFrameworkConfig extends GuardianComponentProps {
+    frameworkKey: Framework;
+}
+
+/**
+ * Nested config structure: use case → framework → config
+ * This is the new recommended structure for Guardian playgrounds
+ */
+export declare type GuardianNestedConfig = Record<string, GuardianUseCaseConfig>;
+
+/**
+ * Guardian Playground component with nested config structure.
+ * Expects config[useCaseId].frameworks[frameworkKey] structure.
+ *
+ * When isFrame=true, reads framework from URL params client-side.
+ */
+export declare function GuardianPlayground({ nestedConfig, useCase, framework: serverFramework, isFrame, apiKey, env, chatUid, }: {
+    /** Nested config structure (use case → framework → config) */
+    nestedConfig: GuardianNestedConfig;
+    /** Current use case ID */
+    useCase: string;
+    /** Current framework key (from server-side props) */
+    framework: string;
+    /** Whether to render in frame mode (just the right view) */
+    isFrame?: boolean;
+    /** API key for starting sandbox */
+    apiKey?: string;
+    /** Environment variables for sandbox */
+    env?: Record<string, string>;
+    /** Chat UID for starting sandbox */
+    chatUid?: string;
+}): default_2.JSX.Element;
+
+export declare function GuardianProvider({ children }: {
+    children: ReactNode;
+}): default_2.JSX.Element;
+
+/**
+ * Represents a use case with multiple framework implementations.
+ * Contains shared fields across all frameworks.
+ */
+export declare interface GuardianUseCase {
+    /** Unique identifier for this use case (e.g., "scalekit-fsa") */
+    id: string;
+    /** Display name for this use case */
+    name: string;
+    /** Description of what this use case demonstrates */
+    description: string;
+    /** Default theme color for all frameworks */
+    themeColor: string;
+    /** Whether to show the preview for this use case */
+    hasPreview?: boolean;
+    /** List of framework implementations for this use case */
+    frameworks: GuardianFramework[];
+}
+
+/**
+ * A single use case with its framework implementations
+ */
+export declare interface GuardianUseCaseConfig {
+    /** Unique identifier for this use case (e.g., "full-stack-auth") */
+    id: string;
+    /** Display name for this use case */
+    name: string;
+    /** Description of what this use case demonstrates */
+    description: string;
+    /** Default theme color for all frameworks */
+    themeColor: string;
+    /** Whether to show the preview for this use case */
+    hasPreview?: boolean;
+    /** Map of framework key to its complete configuration */
+    frameworks: Record<string, GuardianFrameworkConfig>;
+}
+
 export declare const ModalSearchAndChat: default_2.FC<ModalSearchAndChatProps>;
 
 declare interface ModalSearchAndChatProps {
@@ -61,6 +319,58 @@ declare class SampleAppSDK {
     private createButtonContainer;
 }
 
+/**
+ * Sandbox component - simplified API for embedding sandboxes
+ *
+ * @example
+ * ```tsx
+ * <Sandbox
+ *   apiKey={process.env.NEXT_PUBLIC_SAMPLEAPP_API_KEY!}
+ *   sandboxId="launchdarkly-feature-flags"
+ *   env={{
+ *     LAUNCHDARKLY_SDK_KEY: "sdk-xxx",
+ *   }}
+ * />
+ * ```
+ */
+export declare function Sandbox({ apiKey, sandboxId, env, themeColor, }: SandboxProps): default_2.JSX.Element | null;
+
+export declare const SandboxHome: React_2.FC<SandboxHomeProps>;
+
+export declare interface SandboxHomeProps {
+    apiKey: string;
+    orgid: string;
+    baseUrl?: string;
+    sandboxes?: SandboxItem[];
+}
+
+export declare interface SandboxItem {
+    id: string;
+    title: string;
+    description: string;
+    sandboxId?: string;
+}
+
+/**
+ * Props for the Sandbox component
+ */
+export declare interface SandboxProps {
+    /** API key for container technology - required */
+    apiKey: string;
+    /** Sandbox ID to fetch configuration - required */
+    sandboxId: string;
+    /** Environment variables to pass to the sandbox - required */
+    env: Record<string, string>;
+    /** Optional theme color override */
+    themeColor?: string;
+}
+
+declare interface SandboxUrlConfig {
+    sandboxUid: string;
+    browserUrl: string;
+    useVm: boolean;
+}
+
 declare const sdk: SampleAppSDK;
 export default sdk;
 
@@ -69,6 +379,13 @@ export declare interface SDKSettings {
     aiChatSettings?: AiChatSettings;
 }
 
+export declare const TailwindExample: React_2.FC<TailwindExampleProps>;
+
+export declare interface TailwindExampleProps {
+    title?: string;
+    description?: string;
+}
+
 export declare interface ThemeColors {
     primary: string;
     shadow: {
@@ -100,4 +417,22 @@ export declare type ThemeName = "ocean" | "autumn" | "mint" | "sunset" | "lavend
 
 export declare const themes: Record<ThemeName, ThemeColors>;
 
+declare type UpdateContainerCodebaseType = Record<string, CodeOutput>;
+
+/**
+ * Configuration for a single URL to preload in the sandbox
+ */
+declare interface UrlToPreload {
+    /** Browser URL to load */
+    browserUrl: string;
+    /** Whether to use VM for this URL */
+    useVm: boolean;
+    /** Suffix for the sandboxUid (e.g., "main", "abc", "def") */
+    suffix?: string;
+}
+
+export declare const VmProvider: ({ children }: {
+    children: ReactNode;
+}) => default_2.JSX.Element;
+
 export { }