bb-relay 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,666 @@
+type BinaryFile = {
+    path: string;
+    type: "binary";
+    content: Uint8Array;
+};
+type TextFile = {
+    path: string;
+    type: "text";
+    content: string;
+};
+
+type ReadFile = {
+    args: {
+        path: string;
+        type: "text";
+    };
+    response: TextFile;
+} | {
+    args: {
+        path: string;
+        type: "binary";
+    };
+    response: BinaryFile;
+};
+
+type FileRequests = {
+    "create-file": {
+        args: {
+            path: string;
+        };
+        response: null;
+    };
+    "copy-file": {
+        args: {
+            source: string;
+            destination: string;
+        };
+        response: null;
+    };
+    "read-file": ReadFile;
+    stat: {
+        args: {
+            path: string;
+        };
+        response: FileInfo;
+    };
+    "write-file": {
+        args: TextFile | BinaryFile;
+        response: null;
+    };
+    "delete-file": {
+        args: {
+            path: string;
+        };
+        response: null;
+    };
+    "select-file": {
+        args: {
+            path: string;
+        };
+        response: null;
+    };
+};
+
+type DirInfo = {
+    name: string;
+    fullPath: string;
+    createdAt: string;
+    modifiedAt: string;
+    fsCount: number;
+    size: number;
+};
+
+type DirRequests = {
+    "create-dir": {
+        args: {
+            path: string;
+        };
+        response: null;
+    };
+    "read-dir": {
+        args: {
+            path: string;
+        };
+        response: {
+            path: string;
+            type: "file" | "dir";
+        }[];
+    };
+    "get-files": {
+        args: {
+            path: string;
+        };
+        response: string[];
+    };
+    "get-dir-info": {
+        args: {
+            path: string;
+        };
+        response: DirInfo;
+    };
+    "copy-dir": {
+        args: {
+            source: string;
+            destination: string;
+        };
+        response: null;
+    };
+    "delete-dir": {
+        args: {
+            path: string;
+        };
+        response: null;
+    };
+    "select-dir": {
+        args: {
+            path: string;
+        };
+        response: null;
+    };
+};
+
+type StorageRequests = {
+    "sync-storage": {
+        args: {
+            data: Record<string, string>;
+        };
+        response: null;
+    };
+    "load-storage": {
+        args: null;
+        response: Record<string, string>;
+    };
+};
+
+type ProjectRequest = {
+    "update-project": {
+        args: {
+            name: string;
+            description: string;
+        };
+        response: null;
+    };
+};
+
+type BBRequest = FileRequests & DirRequests & StorageRequests & ProjectRequest;
+
+interface RequestReturn<K extends keyof BBRequest> {
+    id: string;
+    type: K;
+    response: BBRequest[K]["response"] | null;
+    error: null | string;
+    responseId: string;
+}
+
+type Load = {
+    /**
+     * Whether the app is in dark mode or not
+     */
+    mode: "dark" | "light";
+    /**
+     * The CSS to be applied to the app
+     */
+    css: string;
+    /**
+     * The language of the app e.g. en, en-gb
+     */
+    language: string;
+};
+
+type Category = "Action" | "Adventure" | "ChickLit" | "Comedy" | "Drama" | "FanFiction" | "Fantasy" | "Horror" | "Mystery / Thriller" | "Parody" | "Poetry" | "Romance" | "SciFi" | "Thriller" | "Western" | "Historical Fiction" | "No Fiction" | "Paranormal" | "Adult" | "Short story" | "Spiritual" | "Other";
+interface Project {
+    title: string;
+    createdAt: string;
+    updatedAt: string;
+    lastAccessedAt: string;
+    remoteId?: string;
+    tags?: string[];
+    category?: Category;
+    description?: string;
+    genre?: string | null;
+}
+
+type BBEvent = {
+    /**
+     * When sidebar loads to ensure that the theme matches the app
+     */
+    load: {
+        response: Load;
+    };
+    /**
+     * Show what has been selected
+     */
+    selected: {
+        response: {
+            path: string;
+            type: "file" | "dir";
+        };
+    };
+    /**
+     * Access tokens
+     */
+    tokens: {
+        response: string;
+    };
+    /**
+     * File event
+     */
+    "file-updated": {
+        response: string;
+    };
+    "dir-updated": {
+        response: string;
+    };
+    /**
+     * When the current project details is updated e.g. the title
+     */
+    "project-updated": {
+        response: Project;
+    };
+    /**
+     * When a new project is selected. Unlike updated, the workspaces and files
+     * will be totally different
+     * Hence if user is using file systems, they might want to reload the files
+     */
+    "project-changed": {
+        response: Project | null;
+    };
+};
+
+interface EventReturn<K extends keyof BBEvent> {
+    type: K;
+    response: BBEvent[K]["response"];
+    responseId: string;
+}
+
+declare class BBRelay {
+    private requestCallbacks;
+    private eventCallbacks;
+    private responseIds;
+    constructor();
+    request<K extends keyof BBRequest>(type: K, arg: BBRequest[K]["args"], callback?: (result: RequestReturn<K>) => void): void;
+    subscribe<K extends keyof BBEvent>(type: K, callback: (result: EventReturn<K>) => void): () => void;
+}
+
+type FileInfo = {
+    name: string;
+    fullPath: string;
+    createdAt: string;
+    modifiedAt: string;
+    ext: string;
+    size: number;
+    wordCount: number;
+    summary: string;
+};
+
+/**
+ * Window = iframe
+ * This will be used to send message (request) from the iframe to editor
+ * It will let the app know which event to listen to and update the iframe
+ * @param event the params that will be sent to the editor
+ */
+declare function registerEvent<K extends keyof BBEvent>(event: {
+    type: K;
+}): void;
+
+/**
+ * This will be used to send message (request) from the iframe to editor
+ * @param request the params that will be sent to the editor
+ */
+declare function registerRequest<K extends keyof BBRequest>(request: {
+    id: string;
+    type: K;
+    arg: BBRequest[K]["args"];
+}): void;
+
+/**
+ * This is the function to inject styles to the iframe from the parent window
+ * @param css the css styles from parent window
+ * @returns function to remove the injected styles
+ */
+declare function injectStyles(css: string): () => void;
+
+type Checkpoint = {
+    sha: string;
+    message: string;
+    timestamp: number;
+    author: {
+        name: string;
+        email: string;
+    };
+};
+
+type CopyArg = {
+    path: string;
+    targetFolder: string;
+};
+
+type WatchFSEvent = "updated" | "deleted";
+
+type User = {
+    id: string;
+    name: string;
+    email: string;
+    bio: string;
+    avatar: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+interface DirectoryContents {
+    files: string[];
+    directories: string[];
+}
+
+type DirectoryStats = {
+    files: number;
+    directories: number;
+};
+
+type FileEncoding = Extract<BufferEncoding, "utf8" | "hex" | "base64" | "base64url">;
+type FileContent = {
+    path: string;
+    content: string;
+    type: FileEncoding;
+};
+
+interface GitFileStatus {
+    filePath: string;
+    staged: boolean;
+    status: "new" | "modified" | "deleted";
+}
+
+type IconArg = {
+    pluginId?: string;
+    extension: string;
+};
+
+declare const enGB: {
+    "language.british_english": string;
+    "language.french": string;
+    "file.new": string;
+    "file.new.placeholder": string;
+    "file.open": string;
+    "file.duplicate": string;
+    "file.delete": string;
+    "file.rename": string;
+    "file.close": string;
+    "file.cut": string;
+    "file.copy": string;
+    "file.export_html": string;
+    "file.export_pdf": string;
+    "file.print": string;
+    "file.location.open": string;
+    file: string;
+    edit: string;
+    view: string;
+    help: string;
+    welcome: string;
+    "welcome.message": string;
+    "version.current": string;
+    "version.latest": string;
+    "version.out_of_date": string;
+    "version.up_to_date": string;
+    "update.check": string;
+    "update.download": string;
+    "update.release_notes": string;
+    install_and_restart: string;
+    later: string;
+    close: string;
+    about: string;
+    change_log: string;
+    documentation: string;
+    "report.issue": string;
+    "folder.new": string;
+    "folder.new.placeholder": string;
+    "folder.open": string;
+    "folder.open.message": string;
+    "folder.open.description": string;
+    "project.download": string;
+    "project.download.title": string;
+    "project.download.description": string;
+    "project.select": string;
+    "project.select.title": string;
+    "project.select.description": string;
+    "project.new": string;
+    tags: string;
+    "tag.input.placeholder": string;
+    category: string;
+    "category.select": string;
+    "project.title": string;
+    "project.title.placeholder": string;
+    "project.description": string;
+    "project.description.placeholder": string;
+    email: string;
+    "email.placeholder": string;
+    password: string;
+    "password.placeholder": string;
+    username: string;
+    "username.placeholder": string;
+    "workspace.select": string;
+    "workspace.select.description": string;
+    "file.explorer": string;
+    "no_workspace.message": string;
+    "folder.select.placeholder": string;
+    "folder.select": string;
+    "folder.rename": string;
+    "folder.duplicate": string;
+    "folder.paste": string;
+    "folder.cut": string;
+    "folder.copy": string;
+    "folder.delete": string;
+    folder: string;
+    "folder.location.open": string;
+    "checkpoint.list.header": string;
+    "checkpoint.placeholder": string;
+    "checkpoint.button": string;
+    "git.stage.all": string;
+    "git.discard.all": string;
+    "git.stage": string;
+    "git.discard": string;
+    "git.discard.message": string;
+    "git.unstage.all": string;
+    "git.unstage": string;
+    changes: string;
+    history: string;
+    home: string;
+    cancel: string;
+    confirm: string;
+    "plugin.install": string;
+    "project.create": string;
+    "checkpoint.save": string;
+    "file.delete.warning": string;
+    "folder.delete.warning": string;
+    delete: string;
+    "placeholder.text": string;
+    "placeholder.click": string;
+    "placeholder.label": string;
+    find: string;
+    replace: string;
+    "replace.all": string;
+    previous: string;
+    next: string;
+    "search.use.regex": string;
+    "search.case.sensitive": string;
+    "plugins.search": string;
+    install: string;
+    uninstall: string;
+    repository: string;
+};
+
+type Language = keyof typeof enGB;
+
+type Locale = "en-GB" | "fr-FR";
+
+interface MenuContent {
+    header: Language;
+    shortcut?: string;
+    disabled?: boolean;
+    sub?: MenuContent[];
+    separator?: boolean;
+    onClick?: () => void;
+}
+
+type Nav = "file-explorer" | "checkpoints" | "plugins" | "settings" | "remote";
+
+type Database = {
+    __InternalSupabase: {
+        PostgrestVersion: "13.0.4";
+    };
+    public: {
+        Tables: {
+            plugin_versions: {
+                Row: {
+                    archived: boolean;
+                    created_at: string;
+                    id: number;
+                    plugin_id: number;
+                    release_note: string;
+                    size: number;
+                    stage: Database["public"]["Enums"]["version_stage"];
+                    updated_at: string;
+                    version: string;
+                };
+                Insert: {
+                    archived?: boolean;
+                    created_at?: string;
+                    id?: number;
+                    plugin_id: number;
+                    release_note: string;
+                    size?: number;
+                    stage?: Database["public"]["Enums"]["version_stage"];
+                    updated_at?: string;
+                    version: string;
+                };
+                Update: {
+                    archived?: boolean;
+                    created_at?: string;
+                    id?: number;
+                    plugin_id?: number;
+                    release_note?: string;
+                    size?: number;
+                    stage?: Database["public"]["Enums"]["version_stage"];
+                    updated_at?: string;
+                    version?: string;
+                };
+                Relationships: [
+                    {
+                        foreignKeyName: "plugin_versions_plugin_id_fkey";
+                        columns: ["plugin_id"];
+                        isOneToOne: false;
+                        referencedRelation: "plugins";
+                        referencedColumns: ["id"];
+                    }
+                ];
+            };
+            plugins: {
+                Row: {
+                    author_id: string;
+                    categories: string[] | null;
+                    created_at: string;
+                    description: string | null;
+                    homepage: string | null;
+                    id: number;
+                    key: string;
+                    name: string | null;
+                    npm_package: string | null;
+                    updated_at: string;
+                };
+                Insert: {
+                    author_id?: string;
+                    categories?: string[] | null;
+                    created_at?: string;
+                    description?: string | null;
+                    homepage?: string | null;
+                    id?: number;
+                    key?: string;
+                    name?: string | null;
+                    npm_package?: string | null;
+                    updated_at?: string;
+                };
+                Update: {
+                    author_id?: string;
+                    categories?: string[] | null;
+                    created_at?: string;
+                    description?: string | null;
+                    homepage?: string | null;
+                    id?: number;
+                    key?: string;
+                    name?: string | null;
+                    npm_package?: string | null;
+                    updated_at?: string;
+                };
+                Relationships: [
+                    {
+                        foreignKeyName: "plugins_author_id_fkey";
+                        columns: ["author_id"];
+                        isOneToOne: false;
+                        referencedRelation: "profiles";
+                        referencedColumns: ["id"];
+                    }
+                ];
+            };
+            profiles: {
+                Row: {
+                    avatar_url: string | null;
+                    full_name: string | null;
+                    id: string;
+                    updated_at: string | null;
+                    username: string | null;
+                    website: string | null;
+                };
+                Insert: {
+                    avatar_url?: string | null;
+                    full_name?: string | null;
+                    id: string;
+                    updated_at?: string | null;
+                    username?: string | null;
+                    website?: string | null;
+                };
+                Update: {
+                    avatar_url?: string | null;
+                    full_name?: string | null;
+                    id?: string;
+                    updated_at?: string | null;
+                    username?: string | null;
+                    website?: string | null;
+                };
+                Relationships: [];
+            };
+        };
+        Views: {
+            [_ in never]: never;
+        };
+        Functions: {
+            [_ in never]: never;
+        };
+        Enums: {
+            version_stage: "DRAFT" | "ALPHA" | "BETA" | "PROD";
+        };
+        CompositeTypes: {
+            [_ in never]: never;
+        };
+    };
+};
+type DatabaseWithoutInternals = Omit<Database, "__InternalSupabase">;
+type DefaultSchema = DatabaseWithoutInternals[Extract<keyof Database, "public">];
+type Tables<DefaultSchemaTableNameOrOptions extends keyof (DefaultSchema["Tables"] & DefaultSchema["Views"]) | {
+    schema: keyof DatabaseWithoutInternals;
+}, TableName extends DefaultSchemaTableNameOrOptions extends {
+    schema: keyof DatabaseWithoutInternals;
+} ? keyof (DatabaseWithoutInternals[DefaultSchemaTableNameOrOptions["schema"]]["Tables"] & DatabaseWithoutInternals[DefaultSchemaTableNameOrOptions["schema"]]["Views"]) : never = never> = DefaultSchemaTableNameOrOptions extends {
+    schema: keyof DatabaseWithoutInternals;
+} ? (DatabaseWithoutInternals[DefaultSchemaTableNameOrOptions["schema"]]["Tables"] & DatabaseWithoutInternals[DefaultSchemaTableNameOrOptions["schema"]]["Views"])[TableName] extends {
+    Row: infer R;
+} ? R : never : DefaultSchemaTableNameOrOptions extends keyof (DefaultSchema["Tables"] & DefaultSchema["Views"]) ? (DefaultSchema["Tables"] & DefaultSchema["Views"])[DefaultSchemaTableNameOrOptions] extends {
+    Row: infer R;
+} ? R : never : never;
+
+type PluginItem = Tables<"plugins"> & {
+    production_version: {
+        id: number;
+        version: string;
+        release_note: string;
+        size: number;
+        updated_at: string;
+    } | null;
+    profile: {
+        username: string | null;
+    } | null;
+};
+
+interface RenameType {
+    path: string;
+    newPath: string;
+}
+
+type Result<T = null> = {
+    data: T | null;
+    error: string | null;
+};
+
+type Route = "welcome" | "project" | "new-project" | "settings" | "updates";
+
+type Settings = {
+    theme: "light" | "dark" | "system";
+    language?: Locale;
+    sidebarWidth: number;
+};
+
+interface TutorialHeader {
+    slug: string;
+    title: string;
+    tags: string[];
+    order: number | null;
+    date: string | null;
+    excerpt: string;
+    filePath: string;
+    body: string;
+}
+
+declare const frFR: {
+    [key in Language]: ;
+};
+
+export { type BBEvent, type BBRequest, type Checkpoint, type CopyArg, type DirInfo, type DirectoryContents, type DirectoryStats, type EventReturn, type FileContent, type FileInfo, type GitFileStatus, type IconArg, type Language, type Load, type Locale, type MenuContent, type Nav, type PluginItem, type Project, type RenameType, type RequestReturn, type Result, type Route, type Settings, type TutorialHeader, type User, type WatchFSEvent, BBRelay as default, enGB, frFR, injectStyles, registerEvent, registerRequest };