@brftech/filex-core 0.21.6 → 0.23.0

package/dist/index.d.ts

@@ -49,6 +49,8 @@ declare type __VLS_Props_11 = {
     viewMode?: ViewMode;
     /** ui-fix — authenticated thumb resolver, forwarded to grid/gallery. */
     thumbSrc?: (n: FileNode) => string | null;
+    /** Desktop selective sync badge resolver, forwarded to the views. */
+    keepBadgeFor?: (n: FileNode) => 'kept' | 'syncing' | 'cloud' | 'partial' | null;
     /** ui-fix — mirror the main panel's virtual `.trash` row at storage root
      *  so both split panes list identical rows (no row-offset). Defaults on. */
     trashVisible?: boolean;
@@ -824,6 +826,50 @@ export declare interface ExplorerConfig {
         driver?: string;
         readOnly?: boolean;
     }>;
+    /**
+     * Desktop-shell hook — selective sync ("keep on this computer").
+     *
+     * Present only when the explorer runs inside the filex desktop app; the
+     * shell passes functions that talk to its sync engine, and the explorer
+     * grows "Keep on this computer" / "Online only" entries on folder menus.
+     * Absent (web admin, embeds): nothing about it renders.
+     *
+     * Folders only, by design: the sync engine pairs directories, and a file
+     * rides along with the folder that holds it.
+     */
+    desktopSync?: {
+        /** Kept folders for the mounted account, adapter-qualified remotes. */
+        kept: () => Promise<Array<{
+            remote: string;
+            local: string;
+        }>>;
+        /** Start keeping a folder — or, with kind 'file', a single file.
+         *  Resolves once the pair is registered (or the user cancelled the
+         *  shell's root-folder prompt — re-read `kept`). */
+        keep: (remote: string, kind: 'dir' | 'file') => Promise<void>;
+        /** Stop keeping. The SHELL owns the "what happens to the local copy"
+         *  question — it asks natively and may cancel; re-read `kept` after. */
+        unkeep: (remote: string) => Promise<void>;
+        /** Open the folder's local mirror in the OS file manager. */
+        reveal: (remote: string) => Promise<void>;
+        /** Live engine state, for the row badges and the bottom progress strip.
+         *  `active` is the folder being worked on right now — the engine walks
+         *  its pairs one at a time — or null between runs. */
+        status?: () => Promise<{
+            running: boolean;
+            lastError?: string | null;
+            active: {
+                remote: string;
+                phase: 'inventory' | 'plan' | 'transfer' | 'settling';
+                done: number;
+                total: number;
+            } | null;
+        }>;
+        /** Subscribe to "something about sync changed" pokes from the shell —
+         *  the explorer re-reads `kept` and `status` when poked. The shell keeps
+         *  ONE subscriber (the mounted explorer) and overwrites it on remount. */
+        onChange?: (cb: () => void) => void;
+    };
 }
 
 /** Component emits — the parent listens for these events. */
@@ -1102,18 +1148,19 @@ virtualRows?: () => FileNode[];
 active?: boolean;
 viewMode?: ViewMode;
 thumbSrc?: (n: FileNode) => string | null;
+keepBadgeFor?: (n: FileNode) => "kept" | "syncing" | "cloud" | "partial" | null;
 trashVisible?: boolean;
 }> & Readonly<{
-onClose?: (() => any) | undefined;
-onNavigate?: ((path: string) => any) | undefined;
-"onOpen-trash"?: (() => any) | undefined;
-onActivate?: (() => any) | undefined;
-"onOpen-tab"?: ((path: string) => any) | undefined;
 onTransfer?: ((p: {
 sources: string[];
 targetWire: string;
 originWire?: string;
 }) => any) | undefined;
+onClose?: (() => any) | undefined;
+onNavigate?: ((path: string) => any) | undefined;
+"onOpen-trash"?: (() => any) | undefined;
+onActivate?: (() => any) | undefined;
+"onOpen-tab"?: ((path: string) => any) | undefined;
 onContext?: ((node: FileNode | null, ev: MouseEvent) => any) | undefined;
 }>, {
 reload: () => Promise<void>;
@@ -1123,16 +1170,16 @@ openSelected: () => void;
 selectedNodes: () => FileNode[];
 getPath: () => string;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
-close: () => any;
-navigate: (path: string) => any;
-"open-trash": () => any;
-activate: () => any;
-"open-tab": (path: string) => any;
 transfer: (p: {
 sources: string[];
 targetWire: string;
 originWire?: string;
 }) => any;
+close: () => any;
+navigate: (path: string) => any;
+"open-trash": () => any;
+activate: () => any;
+"open-tab": (path: string) => any;
 context: (node: FileNode | null, ev: MouseEvent) => any;
 }, PublicProps, {}, false, {}, {}, GlobalComponents, GlobalDirectives, string, {}, HTMLElement, ComponentProvideOptions, {
 P: {};
@@ -1155,18 +1202,19 @@ virtualRows?: () => FileNode[];
 active?: boolean;
 viewMode?: ViewMode;
 thumbSrc?: (n: FileNode) => string | null;
+keepBadgeFor?: (n: FileNode) => "kept" | "syncing" | "cloud" | "partial" | null;
 trashVisible?: boolean;
 }> & Readonly<{
-onClose?: (() => any) | undefined;
-onNavigate?: ((path: string) => any) | undefined;
-"onOpen-trash"?: (() => any) | undefined;
-onActivate?: (() => any) | undefined;
-"onOpen-tab"?: ((path: string) => any) | undefined;
 onTransfer?: ((p: {
 sources: string[];
 targetWire: string;
 originWire?: string;
 }) => any) | undefined;
+onClose?: (() => any) | undefined;
+onNavigate?: ((path: string) => any) | undefined;
+"onOpen-trash"?: (() => any) | undefined;
+onActivate?: (() => any) | undefined;
+"onOpen-tab"?: ((path: string) => any) | undefined;
 onContext?: ((node: FileNode | null, ev: MouseEvent) => any) | undefined;
 }>, {
 reload: () => Promise<void>;
@@ -1943,28 +1991,28 @@ openSelected: typeof openSelected;
 selectedNodes: typeof selectedNodes;
 getPath: typeof getPath;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {} & {
+transfer: (p: {
+sources: string[];
+targetWire: string;
+originWire?: string;
+}) => any;
 close: () => any;
 navigate: (path: string) => any;
 "open-trash": () => any;
 activate: () => any;
 "open-tab": (path: string) => any;
-transfer: (p: {
+context: (node: FileNode | null, ev: MouseEvent) => any;
+}, string, PublicProps, Readonly<__VLS_Props_11> & Readonly<{
+onTransfer?: ((p: {
 sources: string[];
 targetWire: string;
 originWire?: string;
-}) => any;
-context: (node: FileNode | null, ev: MouseEvent) => any;
-}, string, PublicProps, Readonly<__VLS_Props_11> & Readonly<{
+}) => any) | undefined;
 onClose?: (() => any) | undefined;
 onNavigate?: ((path: string) => any) | undefined;
 "onOpen-trash"?: (() => any) | undefined;
 onActivate?: (() => any) | undefined;
 "onOpen-tab"?: ((path: string) => any) | undefined;
-onTransfer?: ((p: {
-sources: string[];
-targetWire: string;
-originWire?: string;
-}) => any) | undefined;
 onContext?: ((node: FileNode | null, ev: MouseEvent) => any) | undefined;
 }>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLElement>;