bb-relay 0.0.1

package/src/locales/en-GB.ts

@@ -0,0 +1,117 @@
+export const enGB = {
+  "language.british_english": "British English",
+  "language.french": "French (France)",
+  "file.new": "New File",
+  "file.new.placeholder": "Press enter to add file",
+  "file.open": "Open File",
+  "file.duplicate": "Duplicate File",
+  "file.delete": "Delete File",
+  "file.rename": "Rename File",
+  "file.close": "Close File",
+  "file.cut": "Cut File",
+  "file.copy": "Copy File",
+  "file.export_html": "Export as HTML",
+  "file.export_pdf": "Export as PDF",
+  "file.print": "Print File",
+  "file.location.open": "Open File Location",
+  file: "File",
+  edit: "Edit",
+  view: "View",
+  help: "Help",
+  welcome: "Welcome to BB Desktop!",
+  "welcome.message": "Get started by creating a new file or opening an existing one.",
+  "version.current": "Current Version",
+  "version.latest": "Latest Version",
+  "version.out_of_date": "An update is available!",
+  "version.up_to_date": "You are using the latest version.",
+  "update.check": "Check for Updates",
+  "update.download": "Download Update",
+  "update.release_notes": "Release Notes",
+  install_and_restart: "Install and Restart",
+  later: "Later",
+  close: "Close",
+  about: "About",
+  change_log: "Change Log",
+  documentation: "Documentation",
+  "report.issue": "Report Issue",
+  "folder.new": "New Folder",
+  "folder.new.placeholder": "Press enter to add folder",
+  "folder.open": "Open folder",
+  "folder.open.message": "You can open a folder",
+  "folder.open.description":
+    "Opening a folder allows you to create a project, and save all files in that folder",
+  "project.download": "Download Project",
+  "project.download.title": "You can download a project",
+  "project.download.description":
+    " You browse the projects that you backed up in the clouds and download them to your computer",
+  "project.select": "Select project",
+  "project.select.title": "You can select a previous project",
+  "project.select.description": "Go into your file system to select a previously saved project",
+  "project.new": "New Project",
+  tags: "Tags",
+  "tag.input.placeholder": "Press enter to add tag",
+  category: "Category",
+  "category.select": "Select category",
+  "project.title": "Project Title",
+  "project.title.placeholder": "The tales of two cities",
+  "project.description": "What is your story about",
+  "project.description.placeholder": "This is a story about...",
+  email: "Email",
+  "email.placeholder": "example@email.com",
+  password: "Password",
+  "password.placeholder": "********",
+  username: "username",
+  "username.placeholder": "@bb-author",
+  "workspace.select": "Select workspace",
+  "workspace.select.description": "Select a folder where all your projects will be saved",
+  "file.explorer": "File explorer",
+  "no_workspace.message": "Select a workspace to start working on your next project",
+  "folder.select.placeholder": "./path/to/project",
+  "folder.select": "Select folder",
+  "folder.rename": "Rename Folder",
+  "folder.duplicate": "Duplicate Folder",
+  "folder.paste": "Paste into Folder",
+  "folder.cut": "Cut Folder",
+  "folder.copy": "Copy Folder",
+  "folder.delete": "Delete Folder",
+  folder: "Folder",
+  "folder.location.open": "Open Folder Location",
+  "checkpoint.list.header": "Checkpoints",
+  "checkpoint.placeholder": "Checkpoint message...",
+  "checkpoint.button": "Save checkpoint",
+  "git.stage.all": "Add all to stage",
+  "git.discard.all": "Discard all changes",
+  "git.stage": "Add to stage",
+  "git.discard": "Discard changes",
+  "git.discard.message": "Are you sure you want to discard all changes?",
+  "git.unstage.all": "Remove all from stage",
+  "git.unstage": "Remove from stage",
+  changes: "Changes",
+  history: "History",
+  home: "Home",
+  cancel: "Cancel",
+  confirm: "Confirm",
+  "plugin.install": "Install plugin",
+  "project.create": "Create project",
+  "checkpoint.save": "Save checkpoint",
+  "file.delete.warning": "Are you sure you want to delete this file? This action cannot be undone.",
+  "folder.delete.warning":
+    "Are you sure you want to delete this folder? This action cannot be undone.",
+  delete: "Delete",
+  "placeholder.text": "This is a placeholder text",
+  "placeholder.click": "Click me",
+  "placeholder.label": "Label",
+  find: "Find",
+  replace: "Replace",
+  "replace.all": "Replace all",
+  previous: "Previous",
+  next: "Next",
+  "search.use.regex": "Use regex",
+  "search.case.sensitive": "Case sensitive",
+  "plugins.search": "Search Plugins in Marketplace",
+  install: "Install",
+  uninstall: "Uninstall",
+  repository: "Repository"
+}
+
+export default enGB

package/src/locales/fr-FR.ts

@@ -0,0 +1,125 @@
+import Language from "@/types/Language";
+
+export const frFR: { [key in Language] } = {
+  "language.british_english": "Anglais britannique",
+  "language.french": "Français (France)",
+  "file.new": "Nouveau fichier",
+  "file.new.placeholder": "Appuyez sur Entrée pour ajouter un fichier",
+  "file.open": "Ouvrir le fichier",
+  "file.duplicate": "Dupliquer le fichier",
+  "file.delete": "Supprimer le fichier",
+  "file.rename": "Renommer le fichier",
+  "file.close": "Fermer le fichier",
+  "file.cut": "Couper le fichier",
+  "file.copy": "Copier le fichier",
+  "file.export_html": "Exporter au format HTML",
+  "file.export_pdf": "Exporter au format PDF",
+  "file.print": "Imprimer le fichier",
+  "file.location.open": "Ouvrir l'emplacement du fichier",
+  file: "Fichier",
+  edit: "Modifier",
+  view: "Afficher",
+  help: "Aide",
+  welcome: "Bienvenue sur BB Desktop !",
+  "welcome.message":
+    "Obtenir Commencer par créer un nouveau fichier ou en ouvrir un existant.",
+  "version.current": "Version actuelle",
+  "version.latest": "Dernière version",
+  "version.out_of_date": "Une mise à jour est disponible !",
+  "version.up_to_date": "Vous utilisez la dernière version.",
+  "update.check": "Rechercher les mises à jour",
+  "update.download": "Télécharger la mise à jour",
+  "update.release_notes": "Notes de version",
+  install_and_restart: "Installer et redémarrer",
+  later: "Plus tard",
+  close: "Fermer",
+  about: "À propos",
+  change_log: "Journal des modifications",
+  documentation: "Documentation",
+  "report.issue": "Signaler un problème",
+  "folder.new": "Nouveau dossier",
+  "folder.new.placeholder": "Appuyez sur Entrée pour ajouter un dossier",
+  "folder.open": "Ouvrir un dossier",
+  "folder.open.message": "Vous pouvez ouvrir un dossier",
+  "folder.open.description":
+    "Ouvrir un dossier vous permet de créer un projet et d'enregistrer tous les fichiers qu'il contient.",
+  "project.download": "Télécharger le projet",
+  "project.download.title": "Vous pouvez télécharger un projet.",
+  "project.download.description":
+    "Parcourez les projets sauvegardés dans le cloud et téléchargez-les sur votre ordinateur.",
+  "project.select": "Sélectionner un projet.",
+  "project.select.title": "Vous pouvez sélectionner un projet précédent.",
+  "project.select.description":
+    "Accédez à votre système de fichiers pour sélectionner un projet précédemment enregistré.",
+  "project.new": "Nouveau projet.",
+  tags: "Étiquettes",
+  "tag.input.placeholder": "Appuyez sur Entrée pour ajouter une étiquette.",
+  category: "Catégorie",
+  "category.select": "Sélectionnez une catégorie.",
+  "project.title": "Titre du projet.",
+  "project.title.placeholder": "Les contes de deux villes.",
+  "project.description": "De quoi parle votre histoire ?",
+  "project.description.placeholder": "Ceci est une histoire sur...",
+  email: "Email",
+  "email.placeholder": "example@email.com",
+  password: "Password",
+  "password.placeholder": "********",
+  username: "username",
+  "username.placeholder": "@bb-author",
+  "workspace.select": "Sélectionnez un espace de travail",
+  "workspace.select.description":
+    "Sélectionnez un dossier où tous vos projets seront enregistrés",
+  "file.explorer": "Explorateur de fichiers",
+  "no_workspace.message":
+    "Sélectionnez un espace de travail pour commencer à travailler sur votre prochain projet",
+  "folder.select.placeholder": "./chemin/vers/projet",
+  "folder.select": "Sélectionnez un dossier",
+  "folder.rename": "Renommer le dossier",
+  "folder.duplicate": "Dupliquer le dossier",
+  "folder.paste": "Coller dans le dossier",
+  "folder.cut": "Couper le dossier",
+  "folder.copy": "Copier le dossier",
+  "folder.delete": "Supprimer le dossier",
+  folder: "Dossier",
+  "folder.location.open": "Ouvrir l'emplacement du dossier",
+  "checkpoint.list.header": "Points de contrôle",
+  "checkpoint.placeholder": "Message du point de contrôle...",
+  "checkpoint.button": "Enregistrer le point de contrôle",
+  "git.stage.all": "Ajouter tout à la zone de préparation",
+  "git.discard.all": "Annuler toutes les modifications",
+  "git.stage": "Ajouter à la zone de préparation",
+  "git.discard": "Annuler les modifications",
+  "git.discard.message":
+    "Êtes-vous sûr de vouloir annuler toutes les modifications ?",
+  "git.unstage.all": "Retirer tout de la zone de préparation",
+  "git.unstage": "Retirer de la zone de préparation",
+  changes: "Modifications",
+  history: "Historique",
+  home: "Accueil",
+  cancel: "Annuler",
+  confirm: "Confirmer",
+  "plugin.install": "Installer le plugin",
+  "project.create": "Créer projet",
+  "checkpoint.save": "Enregistrer le point de contrôle",
+  "file.delete.warning":
+    "Êtes-vous sûr de vouloir supprimer ce fichier ? Cette action est irréversible.",
+  "folder.delete.warning":
+    "Êtes-vous sûr de vouloir supprimer ce dossier ? Cette action est irréversible.",
+  delete: "Supprimer",
+  "placeholder.text": "Ceci est un texte d'espace réservé",
+  "placeholder.click": "Cliquez ici",
+  "placeholder.label": "Étiquette",
+  find: "Rechercher",
+  replace: "Remplacer",
+  "replace.all": "Tout remplacer",
+  previous: "Précédent",
+  next: "Suivant",
+  "search.use.regex": "Utiliser une expression régulière",
+  "search.case.sensitive": "Respecter la casse",
+  "plugins.search": "Rechercher des plugins dans le Marketplace",
+  install: "Installer",
+  uninstall: "Désinstaller",
+  repository: "Dépôt",
+};
+
+export default frFR;

package/src/relay/index.ts

@@ -0,0 +1,89 @@
+import registerRequest from "./registerRequest";
+import BBRequest from "../types/BBRequest";
+import storageBridge from "./storage-bridge";
+import RequestReturn from "../types/RequestReturn";
+import BBEvent from "../types/BBEvent";
+import EventReturn from "../types/EventReturn";
+import registerEvent from "./registerEvent";
+
+export default class BBRelay {
+  private requestCallbacks = new Map<
+    string,
+    {
+      type: keyof BBRequest;
+      callback: <K extends keyof BBRequest>(result: {
+        response: BBRequest[K]["response"] | null;
+        error: null | string;
+      }) => void;
+    }
+  >();
+
+  private eventCallbacks = new Map<
+    string,
+    {
+      type: keyof BBEvent;
+      callback: <K extends keyof BBEvent>(result: {
+        response: BBEvent[K]["response"] | null;
+      }) => void;
+    }
+  >();
+
+  private responseIds: string[] = [];
+
+  constructor() {
+    storageBridge();
+    window.addEventListener("message", (event: MessageEvent) => {
+      const data = event.data;
+      if (!data?.type) return;
+      if (this.responseIds.includes(data.responseId)) return;
+      this.responseIds.push(data.responseId);
+
+      if (!data.id) {
+        for (const [, { type, callback }] of this.eventCallbacks) {
+          const { response } = data as EventReturn<typeof data.type>;
+          if (type === data.type) {
+            callback({ response });
+          }
+        }
+      }
+
+      const callback = this.requestCallbacks.get(data.id);
+      if (callback) {
+        const { response, error } = data as RequestReturn<typeof data.type>;
+        callback.callback({ response, error });
+        this.requestCallbacks.delete(data.id);
+        return;
+      }
+    });
+  }
+
+  request<K extends keyof BBRequest>(
+    type: K,
+    arg: BBRequest[K]["args"],
+    callback?: (result: RequestReturn<K>) => void
+  ) {
+    const id = crypto.randomUUID();
+    if (callback)
+      this.requestCallbacks.set(id, {
+        type,
+        callback: callback as (result: unknown) => void,
+      });
+    registerRequest({ type, arg, id });
+  }
+
+  subscribe<K extends keyof BBEvent>(
+    type: K,
+    callback: (result: EventReturn<K>) => void
+  ) {
+    const id = crypto.randomUUID();
+    this.eventCallbacks.set(id, {
+      type,
+      callback: callback as (result: unknown) => void,
+    });
+    registerEvent({ type });
+
+    return () => {
+      this.eventCallbacks.delete(id);
+    };
+  }
+}

package/src/relay/registerEvent.ts

@@ -0,0 +1,16 @@
+import BBEvent from "../types/BBEvent";
+
+/**
+ * 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
+ */
+export default function registerEvent<K extends keyof BBEvent>(event: {
+  type: K;
+}) {
+  if (!window) throw new Error("Window not found");
+  if (window === window.parent) throw new Error("No parent window available");
+
+  window.parent.postMessage({ ...event, source: "event" }, "*");
+}

package/src/relay/registerRequest.ts

@@ -0,0 +1,16 @@
+import BBRequest from "../types/BBRequest";
+
+/**
+ * This will be used to send message (request) from the iframe to editor
+ * @param request the params that will be sent to the editor
+ */
+export default function registerRequest<K extends keyof BBRequest>(request: {
+  id: string;
+  type: K;
+  arg: BBRequest[K]["args"];
+}) {
+  if (!window) throw new Error("Window not found");
+  if (window === window.parent) throw new Error("No parent window available");
+
+  window.parent.postMessage({ ...request, source: "request" }, "*");
+}

package/src/relay/storage-bridge.ts

@@ -0,0 +1,71 @@
+import registerRequest from "./registerRequest";
+import RequestReturn from "../types/RequestReturn";
+
+export default function storageBridge() {
+  let loaded = false;
+  const proto = Storage.prototype;
+
+  // Keep original references
+  const _setItem = proto.setItem;
+  const _removeItem = proto.removeItem;
+  const _clear = proto.clear;
+
+  function snapshot(storage: Storage) {
+    const obj: Record<string, string> = {};
+    for (let i = 0; i < storage.length; i++) {
+      const key = storage.key(i);
+      if (key !== null) {
+        obj[key] = storage.getItem(key)!;
+      }
+    }
+    return obj;
+  }
+
+  function notify() {
+    registerRequest({
+      type: "sync-storage",
+      id: crypto.randomUUID(),
+      arg: {
+        data: snapshot(localStorage),
+      },
+    });
+  }
+
+  // Patch setItem
+  proto.setItem = function (key: string, value: string): void {
+    const result = _setItem.apply(this, [key, value]);
+    notify();
+    return result;
+  };
+
+  // Patch removeItem
+  proto.removeItem = function (key: string): void {
+    const result = _removeItem.apply(this, [key]);
+    notify();
+    return result;
+  };
+
+  // Patch clear
+  proto.clear = function (): void {
+    const result = _clear.apply(this);
+    notify();
+    return result;
+  };
+
+  registerRequest({
+    type: "load-storage",
+    id: crypto.randomUUID(),
+    arg: null,
+  });
+  window.addEventListener("message", (event) => {
+    const data = event.data as RequestReturn<"load-storage">;
+    if (data.type === "load-storage") {
+      if (!loaded && data.response) {
+        loaded = true;
+        for (const key in data.response) {
+          localStorage.setItem(key, data.response[key]);
+        }
+      }
+    }
+  });
+}

package/src/types/BBEvent.ts

@@ -0,0 +1,51 @@
+import Load from "./status/Load";
+import Project from "./project/Project";
+
+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;
+  };
+};
+
+export default BBEvent;

package/src/types/BBRequest.ts

@@ -0,0 +1,8 @@
+import { FileRequests } from "./files";
+import { DirRequests } from "./dir";
+import { StorageRequests } from "./storage";
+import ProjectRequest from "./project";
+
+type BBRequest = FileRequests & DirRequests & StorageRequests & ProjectRequest;
+
+export default BBRequest;

package/src/types/Checkpoint.ts

@@ -0,0 +1,11 @@
+type Checkpoint = {
+  sha: string
+  message: string
+  timestamp: number
+  author: {
+    name: string
+    email: string
+  }
+}
+
+export default Checkpoint

package/src/types/CopyArg.ts

@@ -0,0 +1,6 @@
+type CopyArg = {
+  path: string
+  targetFolder: string
+}
+
+export default CopyArg

package/src/types/DirectoryContents.ts

@@ -0,0 +1,4 @@
+export default interface DirectoryContents {
+  files: string[]
+  directories: string[]
+}

package/src/types/DirectoryStats.ts

@@ -0,0 +1,4 @@
+export type DirectoryStats = {
+  files: number
+  directories: number
+}

package/src/types/EventParam.ts

@@ -0,0 +1,8 @@
+import BBEvent from "./BBEvent";
+
+type EventParam<K extends keyof BBEvent> = {
+  id: string;
+  type: K;
+};
+
+export default EventParam;

package/src/types/EventReturn.ts

@@ -0,0 +1,9 @@
+import BBEvent from "./BBEvent";
+
+interface EventReturn<K extends keyof BBEvent> {
+  type: K;
+  response: BBEvent[K]["response"];
+  responseId: string;
+}
+
+export default EventReturn;

package/src/types/FileContent.ts

@@ -0,0 +1,9 @@
+export type FileEncoding = Extract<BufferEncoding, "utf8" | "hex" | "base64" | "base64url">
+
+type FileContent = {
+  path: string
+  content: string
+  type: FileEncoding
+}
+
+export default FileContent

package/src/types/GitFileStatus.ts

@@ -0,0 +1,5 @@
+export default interface GitFileStatus {
+  filePath: string
+  staged: boolean
+  status: "new" | "modified" | "deleted"
+}

package/src/types/IconArg.ts

@@ -0,0 +1,6 @@
+type IconArg = {
+  pluginId?: string
+  extension: string
+}
+
+export default IconArg

package/src/types/Language.ts

@@ -0,0 +1,5 @@
+import enGB from "@/locales/en-GB";
+
+type Language = keyof typeof enGB;
+
+export default Language;

package/src/types/Locale.ts

@@ -0,0 +1,3 @@
+type Locale = "en-GB" | "fr-FR"
+
+export default Locale

package/src/types/MenuContent.ts

@@ -0,0 +1,10 @@
+import Language from "./Language";
+
+export interface MenuContent {
+  header: Language;
+  shortcut?: string;
+  disabled?: boolean;
+  sub?: MenuContent[];
+  separator?: boolean;
+  onClick?: () => void;
+}

package/src/types/Nav.ts

@@ -0,0 +1,3 @@
+type Nav = "file-explorer" | "checkpoints" | "plugins" | "settings" | "remote"
+
+export default Nav

package/src/types/PluginItem.ts

@@ -0,0 +1,14 @@
+import { Tables } from "./database.types";
+
+export type PluginItem = Tables<"plugins"> & {
+  production_version: {
+    id: number;
+    version: string;
+    release_note: string;
+    size: number;
+    updated_at: string;
+  } | null;
+  profile: {
+    username: string | null;
+  } | null;
+};

package/src/types/RenameType.ts

@@ -0,0 +1,4 @@
+export interface RenameType {
+  path: string;
+  newPath: string;
+}

package/src/types/RequestParam.ts

@@ -0,0 +1,9 @@
+import BBRequest from "./BBRequest";
+
+type RequestParam<K extends keyof BBRequest> = {
+  id: string;
+  type: K;
+  arg: BBRequest[K]["args"];
+};
+
+export default RequestParam;

package/src/types/RequestReturn.ts

@@ -0,0 +1,11 @@
+import BBRequest from "./BBRequest";
+
+interface RequestReturn<K extends keyof BBRequest> {
+  id: string;
+  type: K;
+  response: BBRequest[K]["response"] | null;
+  error: null | string;
+  responseId: string;
+}
+
+export default RequestReturn;

package/src/types/Result.ts

@@ -0,0 +1,6 @@
+type Result<T = null> = {
+  data: T | null
+  error: string | null
+}
+
+export default Result

package/src/types/Route.ts

@@ -0,0 +1 @@
+export type Route = "welcome" | "project" | "new-project" | "settings" | "updates"

package/src/types/Settings.ts

@@ -0,0 +1,7 @@
+import Locale from "./Locale"
+
+export type Settings = {
+  theme: "light" | "dark" | "system"
+  language?: Locale
+  sidebarWidth: number
+}