openchad-react 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,246 @@
+import * as React$1 from 'react';
+import React__default, { Dispatch, SetStateAction } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { LucideIcon } from 'lucide-react';
+
+/**
+ * The setter function type - identical to React's useState setter
+ */
+type GlobalSetter<T> = Dispatch<SetStateAction<T>>;
+/**
+ * The return type of useGlobal - a tuple like useState
+ * [data, setData]
+ */
+type UseGlobalReturn<T> = readonly [T, GlobalSetter<T>];
+
+/**
+ * Folder utilities returned as the third element
+ */
+interface FolderUtils {
+    /** Create the folder if it doesn't exist */
+    create: (folder: string) => Promise<void>;
+    /** Check if a folder exists */
+    isExists: (folder: string) => Promise<boolean>;
+    /** Get only subfolders (items ending with '/') */
+    folders: string[];
+    /** Get only files (items not ending with '/') */
+    files: string[];
+    path: string;
+}
+/**
+ * The return type of useFolder - a tuple
+ * [contents, exists, { refresh, create }]
+ */
+type UseFolderReturn = readonly [string[], boolean, FolderUtils];
+
+/**
+ * The setter function type - identical to React's useState setter
+ */
+type FileSetter = Dispatch<SetStateAction<string>>;
+/**
+ * File utilities returned as the third element
+ */
+interface FileUtils {
+    /** Force refresh the file content from disk */
+    refresh: () => Promise<void>;
+    /** Get file modification time */
+    getMtime: () => Promise<number>;
+}
+/**
+ * The return type of useFile - a tuple like useState
+ * [content, setContent, exists, { refresh, getMtime }]
+ */
+type UseFileReturn = readonly [string, FileSetter, boolean, FileUtils];
+
+/**
+ * The setter function type - identical to React's useState setter
+ */
+type DatabaseSetter<T> = Dispatch<SetStateAction<T>>;
+/**
+ * Query utilities returned as the third element
+ */
+interface DatabaseUtils {
+    query: (sql: string) => Promise<unknown>;
+    ready: boolean;
+}
+/**
+ * The return type of useDatabase - a tuple like useState
+ * [data, setData, { query }]
+ */
+type UseDatabaseReturn<T> = readonly [T, DatabaseSetter<T>, DatabaseUtils];
+
+type LayoutType = "horizontal" | "vertical" | "grid2x2" | "triple" | "triple-left" | "triple-right" | "triple-top" | "triple-bottom" | "single";
+
+interface ITab {
+    iconOverride: string | null;
+    defaultIcon: React.ComponentType<{
+        className: string;
+    }>;
+    IconOverrideComponent: ({ className }: {
+        className: string;
+    }) => React.ReactNode;
+    icon: ({ className }: {
+        className: string;
+    }) => React.ReactNode;
+    title: string | null;
+    layout: string;
+    hasChildren: boolean;
+    children: string[];
+    group: string | null;
+    size: number[];
+    childrenProps: Record<string, {
+        title: string | null;
+        appname: string;
+        icon: string;
+        data: any;
+    }>;
+}
+
+interface SettingItem {
+    key: string;
+    value: any;
+    type: "string" | "int" | "float" | "boolean" | "array";
+    source: string;
+    section: string;
+    default_value: any;
+    updated_at: string;
+}
+
+interface Model {
+    id?: string | null;
+    name?: string | null;
+    backend?: string;
+    modelType?: string[];
+    modelPath?: string;
+    mmproj?: string | null;
+    fileName?: string | null;
+    apiBase?: string | null;
+    isLoaded?: boolean;
+    isLocal?: boolean;
+    lastError?: string | null;
+}
+interface AppInfo {
+    appname: string;
+    useWorkspace: () => {
+        workspace: string;
+        setWorkspace: (workspace: string) => void;
+    };
+    tabId: string;
+    appId: string;
+    useActiveTabId: () => string;
+    useTitle: () => string | null;
+    setTitle: (title: string) => void;
+    settings: Record<string, SettingItem>;
+    useNotchVisible: () => boolean;
+    useTheme: () => {
+        theme: string;
+        layout: string;
+    };
+    useTab: () => ITab;
+    addTab: (tabs: {
+        app: string;
+        data?: Record<string, any>;
+    }[] | {
+        app: string;
+        data?: Record<string, any>;
+    }, layout?: string) => string[];
+    closeTab: () => void;
+    detachTab: () => void;
+    useTool: () => (tool: string, parameters: Record<string, any>) => Promise<any>;
+    useTabDatabase: <T>(tb: string, options?: {
+        initialValue?: T | undefined;
+    }) => UseDatabaseReturn<T>;
+    useModel: () => UseDatabaseReturn<Model>;
+    getAvailableModels: () => Promise<Model[]>;
+    useGlobal: <T>(name: string, options?: {
+        initialValue?: T;
+    }) => UseGlobalReturn<T>;
+    useFile: (filename: string, options?: {
+        initialValue?: string;
+        baseDir?: string;
+        width?: number;
+        height?: number;
+        quality?: number;
+        bitrate?: string;
+        resolution?: string;
+        fps?: number;
+        thumbnail?: boolean;
+        thumb_time?: string;
+        format?: string;
+        download?: boolean;
+    }) => UseFileReturn;
+    useFolder: (path: string, options?: {
+        baseDir?: string;
+    }) => UseFolderReturn;
+    pyInvoke: <T = any>(label: string, data?: Record<string, unknown> | ArrayBufferLike | Blob | ArrayBufferView, timeout?: number) => Promise<T | void | AsyncGenerator<T, void, unknown>>;
+}
+
+interface Tab {
+    appname: string;
+    data: any;
+    App: React__default.ComponentType<AppInfo>;
+}
+interface DefaultTab {
+    layout: LayoutType;
+    icon: string;
+    tabs: Tab[];
+}
+interface AppsProps {
+    defaultTab: DefaultTab;
+    appRegistry?: Record<string, React__default.ComponentType<AppInfo>>;
+    iconRegistry?: Record<string, LucideIcon>;
+    size?: number[];
+}
+declare function Container({ Apps }: {
+    Apps: AppsProps;
+}): react_jsx_runtime.JSX.Element;
+
+declare function usePython(): {
+    pyInvoke: <T = any>(label: string, data?: Record<string, unknown> | ArrayBufferLike | Blob | ArrayBufferView, timeout?: number) => Promise<T | void | AsyncGenerator<T, void, unknown>>;
+    isStreamReady: boolean;
+};
+
+declare function useElementSize<T extends HTMLElement>(): readonly [React$1.RefObject<T | null>, {
+    width: number;
+    height: number;
+    overflowX: boolean;
+    overflowY: boolean;
+    aspectRatio: string;
+}];
+
+interface MessageState {
+    title: string | null;
+    activeId: string;
+    errorMsg: string;
+    isStreaming: boolean;
+    initialized: boolean;
+    context: string;
+}
+
+declare function generateIdFromString(input: string): string;
+declare const useTool: <T>() => (tool: string, parameters: Record<string, any>) => Promise<void | T | AsyncGenerator<T, void, unknown>>;
+declare const useDatabase: <T>(tb: string, options?: {
+    initialValue?: T;
+}) => UseDatabaseReturn<T>;
+declare const useFile: (filename: string, options?: {
+    initialValue?: string;
+    baseDir?: string;
+    width?: number;
+    height?: number;
+    quality?: number;
+    bitrate?: string;
+    resolution?: string;
+    fps?: number;
+    thumbnail?: boolean;
+    thumb_time?: string;
+    format?: string;
+    download?: boolean;
+}) => UseFileReturn;
+declare const useFolder: (path: string, options?: {
+    baseDir?: string;
+}) => UseFolderReturn;
+declare const useGlobal: <T = Record<string, unknown>>(tb: string, options?: {
+    initialValue?: T;
+}) => UseGlobalReturn<T>;
+
+export { type AppInfo, type AppsProps, Container, type MessageState, generateIdFromString, useDatabase, useElementSize, useFile, useFolder, useGlobal, usePython, useTool };

package/dist/index.d.ts

@@ -0,0 +1,246 @@
+import * as React$1 from 'react';
+import React__default, { Dispatch, SetStateAction } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { LucideIcon } from 'lucide-react';
+
+/**
+ * The setter function type - identical to React's useState setter
+ */
+type GlobalSetter<T> = Dispatch<SetStateAction<T>>;
+/**
+ * The return type of useGlobal - a tuple like useState
+ * [data, setData]
+ */
+type UseGlobalReturn<T> = readonly [T, GlobalSetter<T>];
+
+/**
+ * Folder utilities returned as the third element
+ */
+interface FolderUtils {
+    /** Create the folder if it doesn't exist */
+    create: (folder: string) => Promise<void>;
+    /** Check if a folder exists */
+    isExists: (folder: string) => Promise<boolean>;
+    /** Get only subfolders (items ending with '/') */
+    folders: string[];
+    /** Get only files (items not ending with '/') */
+    files: string[];
+    path: string;
+}
+/**
+ * The return type of useFolder - a tuple
+ * [contents, exists, { refresh, create }]
+ */
+type UseFolderReturn = readonly [string[], boolean, FolderUtils];
+
+/**
+ * The setter function type - identical to React's useState setter
+ */
+type FileSetter = Dispatch<SetStateAction<string>>;
+/**
+ * File utilities returned as the third element
+ */
+interface FileUtils {
+    /** Force refresh the file content from disk */
+    refresh: () => Promise<void>;
+    /** Get file modification time */
+    getMtime: () => Promise<number>;
+}
+/**
+ * The return type of useFile - a tuple like useState
+ * [content, setContent, exists, { refresh, getMtime }]
+ */
+type UseFileReturn = readonly [string, FileSetter, boolean, FileUtils];
+
+/**
+ * The setter function type - identical to React's useState setter
+ */
+type DatabaseSetter<T> = Dispatch<SetStateAction<T>>;
+/**
+ * Query utilities returned as the third element
+ */
+interface DatabaseUtils {
+    query: (sql: string) => Promise<unknown>;
+    ready: boolean;
+}
+/**
+ * The return type of useDatabase - a tuple like useState
+ * [data, setData, { query }]
+ */
+type UseDatabaseReturn<T> = readonly [T, DatabaseSetter<T>, DatabaseUtils];
+
+type LayoutType = "horizontal" | "vertical" | "grid2x2" | "triple" | "triple-left" | "triple-right" | "triple-top" | "triple-bottom" | "single";
+
+interface ITab {
+    iconOverride: string | null;
+    defaultIcon: React.ComponentType<{
+        className: string;
+    }>;
+    IconOverrideComponent: ({ className }: {
+        className: string;
+    }) => React.ReactNode;
+    icon: ({ className }: {
+        className: string;
+    }) => React.ReactNode;
+    title: string | null;
+    layout: string;
+    hasChildren: boolean;
+    children: string[];
+    group: string | null;
+    size: number[];
+    childrenProps: Record<string, {
+        title: string | null;
+        appname: string;
+        icon: string;
+        data: any;
+    }>;
+}
+
+interface SettingItem {
+    key: string;
+    value: any;
+    type: "string" | "int" | "float" | "boolean" | "array";
+    source: string;
+    section: string;
+    default_value: any;
+    updated_at: string;
+}
+
+interface Model {
+    id?: string | null;
+    name?: string | null;
+    backend?: string;
+    modelType?: string[];
+    modelPath?: string;
+    mmproj?: string | null;
+    fileName?: string | null;
+    apiBase?: string | null;
+    isLoaded?: boolean;
+    isLocal?: boolean;
+    lastError?: string | null;
+}
+interface AppInfo {
+    appname: string;
+    useWorkspace: () => {
+        workspace: string;
+        setWorkspace: (workspace: string) => void;
+    };
+    tabId: string;
+    appId: string;
+    useActiveTabId: () => string;
+    useTitle: () => string | null;
+    setTitle: (title: string) => void;
+    settings: Record<string, SettingItem>;
+    useNotchVisible: () => boolean;
+    useTheme: () => {
+        theme: string;
+        layout: string;
+    };
+    useTab: () => ITab;
+    addTab: (tabs: {
+        app: string;
+        data?: Record<string, any>;
+    }[] | {
+        app: string;
+        data?: Record<string, any>;
+    }, layout?: string) => string[];
+    closeTab: () => void;
+    detachTab: () => void;
+    useTool: () => (tool: string, parameters: Record<string, any>) => Promise<any>;
+    useTabDatabase: <T>(tb: string, options?: {
+        initialValue?: T | undefined;
+    }) => UseDatabaseReturn<T>;
+    useModel: () => UseDatabaseReturn<Model>;
+    getAvailableModels: () => Promise<Model[]>;
+    useGlobal: <T>(name: string, options?: {
+        initialValue?: T;
+    }) => UseGlobalReturn<T>;
+    useFile: (filename: string, options?: {
+        initialValue?: string;
+        baseDir?: string;
+        width?: number;
+        height?: number;
+        quality?: number;
+        bitrate?: string;
+        resolution?: string;
+        fps?: number;
+        thumbnail?: boolean;
+        thumb_time?: string;
+        format?: string;
+        download?: boolean;
+    }) => UseFileReturn;
+    useFolder: (path: string, options?: {
+        baseDir?: string;
+    }) => UseFolderReturn;
+    pyInvoke: <T = any>(label: string, data?: Record<string, unknown> | ArrayBufferLike | Blob | ArrayBufferView, timeout?: number) => Promise<T | void | AsyncGenerator<T, void, unknown>>;
+}
+
+interface Tab {
+    appname: string;
+    data: any;
+    App: React__default.ComponentType<AppInfo>;
+}
+interface DefaultTab {
+    layout: LayoutType;
+    icon: string;
+    tabs: Tab[];
+}
+interface AppsProps {
+    defaultTab: DefaultTab;
+    appRegistry?: Record<string, React__default.ComponentType<AppInfo>>;
+    iconRegistry?: Record<string, LucideIcon>;
+    size?: number[];
+}
+declare function Container({ Apps }: {
+    Apps: AppsProps;
+}): react_jsx_runtime.JSX.Element;
+
+declare function usePython(): {
+    pyInvoke: <T = any>(label: string, data?: Record<string, unknown> | ArrayBufferLike | Blob | ArrayBufferView, timeout?: number) => Promise<T | void | AsyncGenerator<T, void, unknown>>;
+    isStreamReady: boolean;
+};
+
+declare function useElementSize<T extends HTMLElement>(): readonly [React$1.RefObject<T | null>, {
+    width: number;
+    height: number;
+    overflowX: boolean;
+    overflowY: boolean;
+    aspectRatio: string;
+}];
+
+interface MessageState {
+    title: string | null;
+    activeId: string;
+    errorMsg: string;
+    isStreaming: boolean;
+    initialized: boolean;
+    context: string;
+}
+
+declare function generateIdFromString(input: string): string;
+declare const useTool: <T>() => (tool: string, parameters: Record<string, any>) => Promise<void | T | AsyncGenerator<T, void, unknown>>;
+declare const useDatabase: <T>(tb: string, options?: {
+    initialValue?: T;
+}) => UseDatabaseReturn<T>;
+declare const useFile: (filename: string, options?: {
+    initialValue?: string;
+    baseDir?: string;
+    width?: number;
+    height?: number;
+    quality?: number;
+    bitrate?: string;
+    resolution?: string;
+    fps?: number;
+    thumbnail?: boolean;
+    thumb_time?: string;
+    format?: string;
+    download?: boolean;
+}) => UseFileReturn;
+declare const useFolder: (path: string, options?: {
+    baseDir?: string;
+}) => UseFolderReturn;
+declare const useGlobal: <T = Record<string, unknown>>(tb: string, options?: {
+    initialValue?: T;
+}) => UseGlobalReturn<T>;
+
+export { type AppInfo, type AppsProps, Container, type MessageState, generateIdFromString, useDatabase, useElementSize, useFile, useFolder, useGlobal, usePython, useTool };