bb-relay 0.0.49 → 0.0.50

package/dist/{FileContent-CXlulSZq.d.mts → FileContent-C0XQHPtC.d.mts}

@@ -6,4 +6,4 @@ type FileContent = {
     prevContent?: string | null;
 };
 
-export type { FileContent as F };
+export type { FileEncoding as F, FileContent as a };

package/dist/{FileContent-CXlulSZq.d.ts → FileContent-C0XQHPtC.d.ts}

@@ -6,4 +6,4 @@ type FileContent = {
     prevContent?: string | null;
 };
 
-export type { FileContent as F };
+export type { FileEncoding as F, FileContent as a };

package/dist/{RequestReturn-Clb_WcNj.d.ts → RequestReturn-Dh56kqJZ.d.ts}

@@ -1,4 +1,4 @@
-import { F as FileContent } from './FileContent-CXlulSZq.js';
+import { a as FileContent } from './FileContent-C0XQHPtC.js';
 
 type Load = {
     theme: string;

package/dist/{RequestReturn-Dahl-hde.d.mts → RequestReturn-Yinms53l.d.mts}

@@ -1,4 +1,4 @@
-import { F as FileContent } from './FileContent-CXlulSZq.mjs';
+import { a as FileContent } from './FileContent-C0XQHPtC.mjs';
 
 type Load = {
     theme: string;

package/dist/api.d.mts

@@ -1,6 +1,6 @@
-import { R as RelayEvent, a as RelayRequest } from './RequestReturn-Dahl-hde.mjs';
-export { E as EventReturn, b as RequestReturn } from './RequestReturn-Dahl-hde.mjs';
-import './FileContent-CXlulSZq.mjs';
+import { R as RelayEvent, a as RelayRequest } from './RequestReturn-Yinms53l.mjs';
+export { E as EventReturn, b as RequestReturn } from './RequestReturn-Yinms53l.mjs';
+import './FileContent-C0XQHPtC.mjs';
 
 type EventParam<K extends keyof RelayEvent> = {
     type: K;

package/dist/api.d.ts

@@ -1,6 +1,6 @@
-import { R as RelayEvent, a as RelayRequest } from './RequestReturn-Clb_WcNj.js';
-export { E as EventReturn, b as RequestReturn } from './RequestReturn-Clb_WcNj.js';
-import './FileContent-CXlulSZq.js';
+import { R as RelayEvent, a as RelayRequest } from './RequestReturn-Dh56kqJZ.js';
+export { E as EventReturn, b as RequestReturn } from './RequestReturn-Dh56kqJZ.js';
+import './FileContent-C0XQHPtC.js';
 
 type EventParam<K extends keyof RelayEvent> = {
     type: K;

package/dist/editor.d.mts

@@ -1,6 +1,7 @@
 export { C as Commit } from './Commit-PdsjrKSG.mjs';
 export { a as FileStat, F as FolderContent, b as FolderStat } from './FolderStat-Bhmwwc0t.mjs';
-export { F as FileContent } from './FileContent-CXlulSZq.mjs';
+import { F as FileEncoding } from './FileContent-C0XQHPtC.mjs';
+export { a as FileContent } from './FileContent-C0XQHPtC.mjs';
 import { L as Language, a as Locale } from './Locale-CdRgNxJo.mjs';
 export { R as Result } from './Result-BLbZLEgX.mjs';
 
@@ -73,4 +74,49 @@ interface TutorialHeader {
 
 type WatchFSEvent = "updated" | "deleted" | "add";
 
-export type { CopyArg, GitFileStatus, IconArg, MenuContent, Nav, Route, Settings, Shortcut, TutorialHeader, WatchFSEvent };
+type DownloadArg = {
+    url: string;
+    targetDir: string;
+};
+
+type ListFilesArg = {
+    path: string;
+    glob?: string;
+};
+
+/**
+ * Used for ipc calls related to git content, such as getting the content of a file in the HEAD or staging area. It includes the directory of the git repository, the file path relative to the repository, and an optional encoding for the file content.
+ */
+type GitContent = {
+    dir: string;
+    filePath: string;
+    encoding?: FileEncoding;
+};
+
+/**
+ * @description Argument for git file action like discard, stage, unstage. It includes the directory of the git repository and an array of file paths relative to the repository that the action should be performed on.
+ */
+interface GitFileActionArg {
+    dir: string;
+    filePaths: string[];
+}
+
+/**
+ * @description Argument for git action like log, checkout. It includes the directory of the git repository and an optional reference.
+ */
+interface GitActionArg {
+    dir: string;
+    ref?: string;
+}
+
+type CommitArg = {
+    dir: string;
+    message: string;
+};
+
+type ShortcutArg = {
+    id: Language;
+    data: unknown;
+};
+
+export type { CommitArg, CopyArg, DownloadArg, GitActionArg, GitContent, GitFileActionArg, GitFileStatus, IconArg, ListFilesArg, MenuContent, Nav, Route, Settings, Shortcut, ShortcutArg, TutorialHeader, WatchFSEvent };

package/dist/editor.d.ts

@@ -1,6 +1,7 @@
 export { C as Commit } from './Commit-PdsjrKSG.js';
 export { a as FileStat, F as FolderContent, b as FolderStat } from './FolderStat-Bhmwwc0t.js';
-export { F as FileContent } from './FileContent-CXlulSZq.js';
+import { F as FileEncoding } from './FileContent-C0XQHPtC.js';
+export { a as FileContent } from './FileContent-C0XQHPtC.js';
 import { L as Language, a as Locale } from './Locale-CdRgNxJo.js';
 export { R as Result } from './Result-BLbZLEgX.js';
 
@@ -73,4 +74,49 @@ interface TutorialHeader {
 
 type WatchFSEvent = "updated" | "deleted" | "add";
 
-export type { CopyArg, GitFileStatus, IconArg, MenuContent, Nav, Route, Settings, Shortcut, TutorialHeader, WatchFSEvent };
+type DownloadArg = {
+    url: string;
+    targetDir: string;
+};
+
+type ListFilesArg = {
+    path: string;
+    glob?: string;
+};
+
+/**
+ * Used for ipc calls related to git content, such as getting the content of a file in the HEAD or staging area. It includes the directory of the git repository, the file path relative to the repository, and an optional encoding for the file content.
+ */
+type GitContent = {
+    dir: string;
+    filePath: string;
+    encoding?: FileEncoding;
+};
+
+/**
+ * @description Argument for git file action like discard, stage, unstage. It includes the directory of the git repository and an array of file paths relative to the repository that the action should be performed on.
+ */
+interface GitFileActionArg {
+    dir: string;
+    filePaths: string[];
+}
+
+/**
+ * @description Argument for git action like log, checkout. It includes the directory of the git repository and an optional reference.
+ */
+interface GitActionArg {
+    dir: string;
+    ref?: string;
+}
+
+type CommitArg = {
+    dir: string;
+    message: string;
+};
+
+type ShortcutArg = {
+    id: Language;
+    data: unknown;
+};
+
+export type { CommitArg, CopyArg, DownloadArg, GitActionArg, GitContent, GitFileActionArg, GitFileStatus, IconArg, ListFilesArg, MenuContent, Nav, Route, Settings, Shortcut, ShortcutArg, TutorialHeader, WatchFSEvent };

package/dist/index.d.mts

@@ -1,7 +1,7 @@
-import { F as FileContent } from './FileContent-CXlulSZq.mjs';
+import { a as FileContent } from './FileContent-C0XQHPtC.mjs';
 export { R as Result } from './Result-BLbZLEgX.mjs';
 import { P as Plugin } from './Plugin-BUbJvxEw.mjs';
-import { R as RelayEvent, E as EventReturn, a as RelayRequest, b as RequestReturn } from './RequestReturn-Dahl-hde.mjs';
+import { R as RelayEvent, E as EventReturn, a as RelayRequest, b as RequestReturn } from './RequestReturn-Yinms53l.mjs';
 import './Wrapper-DWhYVa7F.mjs';
 
 /**

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { F as FileContent } from './FileContent-CXlulSZq.js';
+import { a as FileContent } from './FileContent-C0XQHPtC.js';
 export { R as Result } from './Result-BLbZLEgX.js';
 import { P as Plugin } from './Plugin-BYz_yl3E.js';
-import { R as RelayEvent, E as EventReturn, a as RelayRequest, b as RequestReturn } from './RequestReturn-Clb_WcNj.js';
+import { R as RelayEvent, E as EventReturn, a as RelayRequest, b as RequestReturn } from './RequestReturn-Dh56kqJZ.js';
 import './Wrapper-DWhYVa7F.js';
 
 /**

package/dist/plugin.d.mts

@@ -1,7 +1,7 @@
 import { CSSProperties, InputHTMLAttributes } from 'react';
 import { IconName } from 'lucide-react/dynamic';
 import { F as FolderContent, b as FolderStat, a as FileStat } from './FolderStat-Bhmwwc0t.mjs';
-import { F as FileContent } from './FileContent-CXlulSZq.mjs';
+import { a as FileContent } from './FileContent-C0XQHPtC.mjs';
 import { R as Result } from './Result-BLbZLEgX.mjs';
 import { P as Project } from './Project-9NfYlQ36.mjs';
 import './PROJECT_CATEGORY-BivLHtB6.mjs';
@@ -224,12 +224,11 @@ type EditorAPI = {
         commit: (arg: {
             files: string[];
             message: string;
-            email?: string;
         }) => Promise<Result>;
     };
     dialog?: {
-        selectFile: () => Promise<Result<string[]>>;
-        selectFolder: () => Promise<Result<string[]>>;
+        selectFile: () => Promise<Result<string>>;
+        selectFolder: () => Promise<Result<string>>;
     };
     project?: {
         /**

package/dist/plugin.d.ts

@@ -1,7 +1,7 @@
 import { CSSProperties, InputHTMLAttributes } from 'react';
 import { IconName } from 'lucide-react/dynamic';
 import { F as FolderContent, b as FolderStat, a as FileStat } from './FolderStat-Bhmwwc0t.js';
-import { F as FileContent } from './FileContent-CXlulSZq.js';
+import { a as FileContent } from './FileContent-C0XQHPtC.js';
 import { R as Result } from './Result-BLbZLEgX.js';
 import { P as Project } from './Project-DOzeI4xi.js';
 import './PROJECT_CATEGORY-BivLHtB6.js';
@@ -224,12 +224,11 @@ type EditorAPI = {
         commit: (arg: {
             files: string[];
             message: string;
-            email?: string;
         }) => Promise<Result>;
     };
     dialog?: {
-        selectFile: () => Promise<Result<string[]>>;
-        selectFolder: () => Promise<Result<string[]>>;
+        selectFile: () => Promise<Result<string>>;
+        selectFolder: () => Promise<Result<string>>;
     };
     project?: {
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bb-relay",
-  "version": "0.0.49",
+  "version": "0.0.50",
   "description": "For managing bb-editor extension",
   "license": "ISC",
   "author": "Ade Adeola",

package/src/editor.ts

@@ -13,6 +13,13 @@ import { WatchFSEvent } from "./types/editor/WatchFSEvent";
 import FileStat from "./types/editor/FileStat";
 import Result from "./types/editor/Result";
 import { FolderStat } from "./types/editor/FolderStat";
+import DownloadArg from "./types/editor/DownloadArg";
+import ListFilesArg from "./types/editor/ListFilesArg";
+import GitContent from "./types/editor/GitContent";
+import GitFileActionArg from "./types/editor/GitFileActionArg";
+import GitActionArg from "./types/editor/GitActionArg";
+import CommitArg from "./types/editor/CommitArg";
+import ShortcutArg from "./types/editor/ShortcutArg";
 
 export type {
   Commit,
@@ -31,4 +38,11 @@ export type {
   FolderStat,
   Result,
   Shortcut,
+  DownloadArg,
+  ListFilesArg,
+  GitContent,
+  GitFileActionArg,
+  GitActionArg,
+  CommitArg,
+  ShortcutArg,
 };

package/src/lib/plugin/index.ts

@@ -44,15 +44,11 @@ export type EditorAPI = {
     listFiles: (glob?: string) => Promise<Result<string[]>>;
   };
   git?: {
-    commit: (arg: {
-      files: string[];
-      message: string;
-      email?: string;
-    }) => Promise<Result>;
+    commit: (arg: { files: string[]; message: string }) => Promise<Result>;
   };
   dialog?: {
-    selectFile: () => Promise<Result<string[]>>;
-    selectFolder: () => Promise<Result<string[]>>;
+    selectFile: () => Promise<Result<string>>;
+    selectFolder: () => Promise<Result<string>>;
   };
   project?: {
     /**

package/src/types/editor/CommitArg.ts

@@ -0,0 +1,3 @@
+type CommitArg = { dir: string; message: string };
+
+export default CommitArg;

package/src/types/editor/DownloadArg.ts

@@ -0,0 +1,3 @@
+type DownloadArg = { url: string; targetDir: string };
+
+export default DownloadArg;

package/src/types/editor/GitActionArg.ts

@@ -0,0 +1,7 @@
+/**
+ * @description Argument for git action like log, checkout. It includes the directory of the git repository and an optional reference.
+ */
+export default interface GitActionArg {
+  dir: string;
+  ref?: string;
+}

package/src/types/editor/GitContent.ts

@@ -0,0 +1,12 @@
+import { FileEncoding } from "./FileContent";
+
+/**
+ * Used for ipc calls related to git content, such as getting the content of a file in the HEAD or staging area. It includes the directory of the git repository, the file path relative to the repository, and an optional encoding for the file content.
+ */
+type GitContent = {
+  dir: string;
+  filePath: string;
+  encoding?: FileEncoding;
+};
+
+export default GitContent;

package/src/types/editor/GitFileActionArg.ts

@@ -0,0 +1,7 @@
+/**
+ * @description Argument for git file action like discard, stage, unstage. It includes the directory of the git repository and an array of file paths relative to the repository that the action should be performed on.
+ */
+export default interface GitFileActionArg {
+  dir: string;
+  filePaths: string[];
+}

package/src/types/editor/ListFilesArg.ts

@@ -0,0 +1,3 @@
+type ListFilesArg = { path: string; glob?: string };
+
+export default ListFilesArg;

package/src/types/editor/ShortcutArg.ts

@@ -0,0 +1,5 @@
+import Language from "./Language";
+
+type ShortcutArg = { id: Language; data: unknown };
+
+export default ShortcutArg;