bb-relay 0.0.32 → 0.0.34

package/src/locales/fr-FR.ts

@@ -1,169 +1,171 @@
-import Language from "@/types/editor/Language";
-
-export const frFR: { [key in Language]: string } = {
-  "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",
-  "install.version": "Installer une version spécifique",
-  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",
-  login: "Se connecter",
-  logout: "Se déconnecter",
-  "projects.search": "Rechercher des projets",
-  download: "Télécharger",
-  "project.delete.warning":
-    "Êtes-vous sûr de vouloir supprimer ce projet ? Cette action est irréversible.",
-  "project.message.download": "Télécharger le projet sur le cloud",
-  "project.message.synced": "Le projet est à jour",
-  "project.message.update": "Il y a des modifications non enregistrées",
-  "project.message.upload": "Téléverser le projet sur le cloud",
-  loading: "Chargement...",
-  enable: "Activer",
-  disable: "Désactiver",
-  plugin: "Plugin",
-  plugins: "Plugins",
-  "updates.check": "Rechercher les mises à jour",
-  "updates.download": "Télécharger les mises à jour",
-  "plugins.enable.all": "Activer tous les plugins",
-  "plugins.disable.all": "Désactiver tous les plugins",
-  "plugins.install.local": "Installer des plugins locaux",
-  "check.all": "Tout cocher",
-  "uncheck.all": "Tout décocher",
-  "checkpoint.latest": "Revenir au dernier point de contrôle",
-  errors: "Erreurs",
-  "path.copy": "Copier le chemin",
-  general: "Général",
-  appearance: "Apparence",
-  registry: "Registre",
-  shortcuts: "Couches",
-  account: "Compte",
-  "sidebar.toggle": "Basculer la barre latérale",
-  "project.open": "Ouvrir un projet",
-  quit: "Quitter",
-  duplicate: "Dupliquer",
-  copy: "Copier",
-  cut: "Couper",
-  paste: "Coller",
-  "en-GB": "Anglais (UK)",
-  "fr-FR": "Français (France)",
-  "app.minimise": "Minimiser",
-  "app.maximise": "Maximiser",
-  "app.restart": "Redémarrer",
-  app: "App",
-};
-
-export default frFR;
+import Language from "@/types/editor/Language";
+
+export const frFR: { [key in Language]: string } = {
+  "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",
+  "install.version": "Installer une version spécifique",
+  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",
+  login: "Se connecter",
+  logout: "Se déconnecter",
+  "projects.search": "Rechercher des projets",
+  download: "Télécharger",
+  "project.delete.warning":
+    "Êtes-vous sûr de vouloir supprimer ce projet ? Cette action est irréversible.",
+  "project.message.download": "Télécharger le projet sur le cloud",
+  "project.message.synced": "Le projet est à jour",
+  "project.message.update": "Il y a des modifications non enregistrées",
+  "project.message.upload": "Téléverser le projet sur le cloud",
+  loading: "Chargement...",
+  enable: "Activer",
+  disable: "Désactiver",
+  plugin: "Plugin",
+  plugins: "Plugins",
+  "updates.check": "Rechercher les mises à jour",
+  "updates.download": "Télécharger les mises à jour",
+  "plugins.enable.all": "Activer tous les plugins",
+  "plugins.disable.all": "Désactiver tous les plugins",
+  "plugins.install.local": "Installer des plugins locaux",
+  "check.all": "Tout cocher",
+  "uncheck.all": "Tout décocher",
+  "checkpoint.latest": "Revenir au dernier point de contrôle",
+  errors: "Erreurs",
+  "path.copy": "Copier le chemin",
+  general: "Général",
+  appearance: "Apparence",
+  registry: "Registre",
+  shortcuts: "Couches",
+  account: "Compte",
+  "sidebar.toggle": "Basculer la barre latérale",
+  "project.open": "Ouvrir un projet",
+  quit: "Quitter",
+  duplicate: "Dupliquer",
+  copy: "Copier",
+  cut: "Couper",
+  paste: "Coller",
+  "en-GB": "Anglais (UK)",
+  "fr-FR": "Français (France)",
+  "app.minimise": "Minimiser",
+  "app.maximise": "Maximiser",
+  "app.restart": "Redémarrer",
+  app: "App",
+  settings: "Paramètres",
+  preferences: "Préférences",
+};
+
+export default frFR;

package/src/relay/postEventResponse.ts

@@ -8,8 +8,6 @@ export function postEventResponse<K extends BBEventKey>(
 ): void {
   const res: EventReturn<K> = {
     ...response,
-    source: "event",
-    responseId: crypto.randomUUID(),
   };
   window.postMessage(res, "*");
 }

package/src/relay/postRequestResponse.ts

@@ -0,0 +1,14 @@
+import RequestReturn from "@/types/api/RequestReturn";
+import { RelayRequest } from "./registerRequest";
+
+type BBRequestKey = keyof RelayRequest;
+
+export function postRequestResponse<K extends BBRequestKey>(
+  window: Window,
+  response: RequestReturn<K>,
+): void {
+  const res: RequestReturn<K> = {
+    ...response,
+  };
+  window.postMessage(res, "*");
+}

package/src/relay/registerEvent.ts

@@ -1,4 +1,4 @@
-import EventParam from "@/types/api/EventParam";
+import { EventParam } from "@/api";
 import RelayEvent from "../types/api/RelayEvent";
 
 /**
@@ -8,10 +8,15 @@ import RelayEvent from "../types/api/RelayEvent";
  * @param event the params that will be sent to the editor
  */
 export default function registerEvent<K extends keyof RelayEvent>(
-  event: EventParam<K>,
+  type: K,
+  unsubscribe?: boolean,
 ) {
   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" }, "*");
+  const message: EventParam<K> = {
+    type,
+    source: unsubscribe ? "unsubscribe" : "event",
+  };
+  window.parent.postMessage(message, "*");
 }

package/src/relay/registerRequest.ts

@@ -0,0 +1,35 @@
+import RequestParam from "@/types/api/RequestParam";
+
+export type RelayRequest = {
+  /**
+   * Updates the content of the current file
+   * Note, type is not stated, it would use the one stated in manifest
+   */
+  update: {
+    args: {
+      content: string;
+    };
+    response: {
+      error: string | null;
+    };
+  };
+  ping: {
+    args: unknown;
+    response: {
+      data: unknown | null;
+    };
+  };
+};
+
+/**
+ * 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 RelayRequest>(
+  request: RequestParam<K>,
+) {
+  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/request.ts

@@ -0,0 +1,19 @@
+import registerRequest, { RelayRequest } from "./registerRequest";
+import RequestReturn from "@/types/api/RequestReturn";
+
+export default function request<K extends keyof RelayRequest>(
+  type: K,
+  arg: RelayRequest[K]["args"],
+  callback?: (response: RelayRequest[K]["response"]) => void,
+) {
+  const id = crypto.randomUUID();
+  registerRequest({ type, id, arg, source: "request" });
+  window.addEventListener("message", (ev: MessageEvent) => {
+    const data = ev.data as RequestReturn<K>;
+
+    const { response } = data as RequestReturn<K>;
+    if (type === data.type && id === data.id) {
+      callback?.(response);
+    }
+  });
+}

package/src/relay/subscribe.ts

@@ -0,0 +1,20 @@
+import { EventReturn, RelayEvent } from "@/api";
+import registerEvent from "./registerEvent";
+
+export default function subscribe<K extends keyof RelayEvent>(
+  type: K,
+  callback: (response: RelayEvent[K]["response"]) => void,
+) {
+  registerEvent(type);
+  window.addEventListener("message", (ev: MessageEvent) => {
+    const data = ev.data as EventReturn<K>;
+
+    const { response } = data as EventReturn<K>;
+    if (type === data.type) {
+      callback(response);
+    }
+  });
+  return () => {
+    registerEvent(type, true);
+  };
+}

package/src/types/api/EventParam.ts

@@ -1,9 +1,8 @@
 import RelayEvent from "./RelayEvent";
 
 type EventParam<K extends keyof RelayEvent> = {
-  id: string;
   type: K;
-  source: "event";
+  source: "event" | "unsubscribe";
 };
 
 export default EventParam;

package/src/types/api/EventReturn.ts

@@ -3,8 +3,6 @@ import RelayEvent from "./RelayEvent";
 interface EventReturn<K extends keyof RelayEvent> {
   type: K;
   response: RelayEvent[K]["response"];
-  responseId: string;
-  source: "event";
 }
 
 export default EventReturn;

package/src/types/api/RelayEvent.ts

@@ -6,7 +6,7 @@ type RelayEvent = {
    * Indicate change in theme
    */
   theme: {
-    response: "dark" | "light";
+    response: string;
   };
   /**
    * Indicate that the iframe is loaded and ready to receive instructions
@@ -17,12 +17,6 @@ type RelayEvent = {
   load: {
     response: Load;
   };
-  /**
-   * The style of the editor
-   */
-  style: {
-    response: string;
-  };
   /**
    * The language of the editor
    */

package/src/types/api/RequestParam.ts

@@ -0,0 +1,10 @@
+import { RelayRequest } from "@/relay/registerRequest";
+
+type RequestParam<K extends keyof RelayRequest> = {
+  type: K;
+  source: "request";
+  id: string;
+  arg: RelayRequest[K]["args"];
+};
+
+export default RequestParam;

package/src/types/api/RequestReturn.ts

@@ -0,0 +1,9 @@
+import { RelayRequest } from "@/relay/registerRequest";
+
+interface RequestReturn<K extends keyof RelayRequest> {
+  type: K;
+  response: RelayRequest[K]["response"];
+  id: string;
+}
+
+export default RequestReturn;

package/src/types/editor/FileContent.ts

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

package/src/types/editor/Load.ts

@@ -1,6 +1,5 @@
 type Load = {
-  styles: string;
-  theme: "light" | "dark";
+  theme: string;
   languages: string[];
 };
 

package/src/types/editor/Manifest.ts

@@ -23,6 +23,7 @@ export type Manifest = {
     path: string;
     type: FileContent["type"];
     extensions: string[];
+    icon?: string;
   };
   permissions: Permission[];
   iconsPath?: string;
@@ -31,9 +32,6 @@ export type Manifest = {
   author?: string;
   homepage?: string;
   repository?: string;
-  theme?: {
-    name: string;
-    path: string;
-  };
+  theme?: string;
   [key: string]: unknown;
 };