bb-relay 0.0.38 → 0.0.39

package/dist/editor.d.mts

@@ -56,6 +56,7 @@ type Settings = {
      */
     registry: Record<string, string>;
     mute: boolean;
+    icon: string;
 };
 
 interface TutorialHeader {

package/dist/editor.d.ts

@@ -56,6 +56,7 @@ type Settings = {
      */
     registry: Record<string, string>;
     mute: boolean;
+    icon: string;
 };
 
 interface TutorialHeader {

package/dist/index.d.mts

@@ -17,10 +17,15 @@ type Manifest = {
     name: string;
     description?: string;
     keyword?: string[];
+    permissions: Permission[];
+    manifest_version: 1;
+    version: string;
+    author?: string;
+    homepage?: string;
+    repository?: string;
     sidebar?: {
         icon: string;
         title: string;
-        path: string;
     };
     main?: {
         path: string;
@@ -28,16 +33,10 @@ type Manifest = {
         extensions: string[];
         icon?: string;
     };
-    permissions: Permission[];
-    iconsPath?: string;
-    manifest_version: 1;
-    version: string;
-    author?: string;
-    homepage?: string;
-    repository?: string;
+    icons?: string;
     theme?: string;
+    entry?: string;
     [key: string]: unknown;
-    status?: string;
 };
 
 declare const validateManifest: (manifestContent: string) => {

package/dist/index.d.ts

@@ -17,10 +17,15 @@ type Manifest = {
     name: string;
     description?: string;
     keyword?: string[];
+    permissions: Permission[];
+    manifest_version: 1;
+    version: string;
+    author?: string;
+    homepage?: string;
+    repository?: string;
     sidebar?: {
         icon: string;
         title: string;
-        path: string;
     };
     main?: {
         path: string;
@@ -28,16 +33,10 @@ type Manifest = {
         extensions: string[];
         icon?: string;
     };
-    permissions: Permission[];
-    iconsPath?: string;
-    manifest_version: 1;
-    version: string;
-    author?: string;
-    homepage?: string;
-    repository?: string;
+    icons?: string;
     theme?: string;
+    entry?: string;
     [key: string]: unknown;
-    status?: string;
 };
 
 declare const validateManifest: (manifestContent: string) => {

package/dist/index.js

@@ -36,39 +36,46 @@ var validateManifest = (manifestContent) => {
   if (content.main) {
     if (!content.main.path) {
       errors.push("Manifest main path is missing");
-    } else if (!content.main.type) {
+    } else {
+      fileChecks.push(content.main.path);
+    }
+    if (!content.main.type) {
       errors.push("Manifest main type is missing");
-    } else if (!content.main.extensions) {
+    }
+    if (!content.main.extensions) {
       errors.push("Manifest main extensions is missing");
     } else if (!Array.isArray(content.main.extensions)) {
       errors.push("Manifest main extensions is not an array");
     } else if (content.main.extensions.length === 0) {
       errors.push("Manifest main extensions is empty");
-    } else {
-      fileChecks.push(content.main.path);
     }
   }
   if (content.sidebar) {
     if (!content.sidebar.icon) {
       errors.push("Manifest sidebar icon is missing");
-    } else if (!content.sidebar.title) {
-      errors.push("Manifest sidebar title is missing");
-    } else if (content.sidebar.path) {
-      if (!content.sidebar.path.endsWith(".js")) {
-        errors.push("Manifest sidebar path must be a js file");
-      } else fileChecks.push(content.sidebar.path);
     } else {
       fileChecks.push(content.sidebar.icon);
     }
+    if (!content.sidebar.title) {
+      errors.push("Manifest sidebar title is missing");
+    }
   }
-  if (content.status) {
-    fileChecks.push(content.status);
+  if (content.entry) {
+    if (!content.entry.endsWith(".js"))
+      errors.push("Entry file is not a javascript file");
+    else fileChecks.push(content.entry);
   }
-  if (content.iconsPath) {
-    fileChecks.push(content.iconsPath + "/bb.png");
+  if (content.icons) {
+    fileChecks.push(content.icons + "/bb.png");
+    fileChecks.push(content.icons + "/bbe.png");
+    fileChecks.push(content.icons + "/default.png");
+    fileChecks.push(content.icons + "/folder.png");
+    fileChecks.push(content.icons + "/folder-open.png");
   }
   if (content.theme) {
-    fileChecks.push(content.theme);
+    if (!content.theme.endsWith(".css"))
+      errors.push("Theme file is not a css file");
+    else fileChecks.push(content.theme);
   }
   return {
     errors,

package/dist/index.mjs

@@ -36,39 +36,46 @@ var validateManifest = (manifestContent) => {
   if (content.main) {
     if (!content.main.path) {
       errors.push("Manifest main path is missing");
-    } else if (!content.main.type) {
+    } else {
+      fileChecks.push(content.main.path);
+    }
+    if (!content.main.type) {
       errors.push("Manifest main type is missing");
-    } else if (!content.main.extensions) {
+    }
+    if (!content.main.extensions) {
       errors.push("Manifest main extensions is missing");
     } else if (!Array.isArray(content.main.extensions)) {
       errors.push("Manifest main extensions is not an array");
     } else if (content.main.extensions.length === 0) {
       errors.push("Manifest main extensions is empty");
-    } else {
-      fileChecks.push(content.main.path);
     }
   }
   if (content.sidebar) {
     if (!content.sidebar.icon) {
       errors.push("Manifest sidebar icon is missing");
-    } else if (!content.sidebar.title) {
-      errors.push("Manifest sidebar title is missing");
-    } else if (content.sidebar.path) {
-      if (!content.sidebar.path.endsWith(".js")) {
-        errors.push("Manifest sidebar path must be a js file");
-      } else fileChecks.push(content.sidebar.path);
     } else {
       fileChecks.push(content.sidebar.icon);
     }
+    if (!content.sidebar.title) {
+      errors.push("Manifest sidebar title is missing");
+    }
   }
-  if (content.status) {
-    fileChecks.push(content.status);
+  if (content.entry) {
+    if (!content.entry.endsWith(".js"))
+      errors.push("Entry file is not a javascript file");
+    else fileChecks.push(content.entry);
   }
-  if (content.iconsPath) {
-    fileChecks.push(content.iconsPath + "/bb.png");
+  if (content.icons) {
+    fileChecks.push(content.icons + "/bb.png");
+    fileChecks.push(content.icons + "/bbe.png");
+    fileChecks.push(content.icons + "/default.png");
+    fileChecks.push(content.icons + "/folder.png");
+    fileChecks.push(content.icons + "/folder-open.png");
   }
   if (content.theme) {
-    fileChecks.push(content.theme);
+    if (!content.theme.endsWith(".css"))
+      errors.push("Theme file is not a css file");
+    else fileChecks.push(content.theme);
   }
   return {
     errors,

package/dist/plugin.d.mts

@@ -156,7 +156,7 @@ type StatusElement = {
     iconLeft?: IconName;
     iconRight?: IconName;
     message?: string;
-    text?: string;
+    text?: string | number;
 };
 type RenderStatusType = {
     element: StatusElement[];
@@ -229,7 +229,7 @@ declare abstract class Plugin<T extends Record<string, unknown>> {
      * You will also need to set initial state here
      */
     abstract init(): T;
-    protected render(message: "sidebar" | "modal", arg: ElementInstruction): void;
+    protected updateRender(): void;
     /**
      * Used to determine what will be shown at the sidebar whenever a user navigates
      * to it.
@@ -283,7 +283,6 @@ declare abstract class Plugin<T extends Record<string, unknown>> {
     protected on(event: "ping", callback: (arg: unknown) => void): void;
     renderStatusBar?(): RenderStatusType | null;
     private registerStatus;
-    private onStatusLoad;
     protected setState(param: SetState<T>): void;
     protected getState(): T;
     protected log(message: string): void;

package/dist/plugin.d.ts

@@ -156,7 +156,7 @@ type StatusElement = {
     iconLeft?: IconName;
     iconRight?: IconName;
     message?: string;
-    text?: string;
+    text?: string | number;
 };
 type RenderStatusType = {
     element: StatusElement[];
@@ -229,7 +229,7 @@ declare abstract class Plugin<T extends Record<string, unknown>> {
      * You will also need to set initial state here
      */
     abstract init(): T;
-    protected render(message: "sidebar" | "modal", arg: ElementInstruction): void;
+    protected updateRender(): void;
     /**
      * Used to determine what will be shown at the sidebar whenever a user navigates
      * to it.
@@ -283,7 +283,6 @@ declare abstract class Plugin<T extends Record<string, unknown>> {
     protected on(event: "ping", callback: (arg: unknown) => void): void;
     renderStatusBar?(): RenderStatusType | null;
     private registerStatus;
-    private onStatusLoad;
     protected setState(param: SetState<T>): void;
     protected getState(): T;
     protected log(message: string): void;

package/dist/plugin.js

@@ -56,13 +56,11 @@ var Plugin = class {
       this.index = -1;
       this.eventIds.forEach((event) => this.off(event));
       this.eventIds = [];
-      const sidebar = _optionalChain([this, 'access', _ => _.renderSidebar, 'optionalCall', _2 => _2()]) || null;
-      if (sidebar) this.render("sidebar", sidebar);
-      const status = _optionalChain([this, 'access', _3 => _3.renderStatusBar, 'optionalCall', _4 => _4()]) || null;
-      if (status) this.registerStatus();
+      this.updateRender();
     });
     this.onSidebarLoad();
-    this.onStatusLoad();
+    this.registerStatus();
+    this.registerSubscription("destroy", this.destroy);
   }
   // -----------------------------
   // Element Factory
@@ -89,13 +87,18 @@ var Plugin = class {
       }
     };
   }
-  render(message, arg) {
-    this.sendMessage({ type: message, arg });
+  updateRender() {
+    this.index = -1;
+    this.sendMessage({
+      type: "sidebar-update",
+      arg: _optionalChain([this, 'access', _ => _.renderSidebar, 'optionalCall', _2 => _2()]) || null
+    });
+    this.registerStatus();
   }
   onSidebarLoad() {
     this.index = -1;
     this.registerHandler("sidebar-load", () => {
-      return _optionalChain([this, 'access', _5 => _5.renderSidebar, 'optionalCall', _6 => _6()]) || null;
+      return _optionalChain([this, 'access', _3 => _3.renderSidebar, 'optionalCall', _4 => _4()]) || null;
     });
   }
   // -----------------------------
@@ -169,7 +172,7 @@ var Plugin = class {
     this.registerSubscription(event, callback);
   }
   registerStatus() {
-    const arg = _optionalChain([this, 'access', _7 => _7.renderStatusBar, 'optionalCall', _8 => _8()]);
+    const arg = _optionalChain([this, 'access', _5 => _5.renderStatusBar, 'optionalCall', _6 => _6()]);
     if (!arg) return;
     const { onClick, ...rest } = arg;
     if (arg) {
@@ -181,19 +184,6 @@ var Plugin = class {
       if (onClick) this.registerSubscription("status-click", onClick);
     }
   }
-  onStatusLoad() {
-    this.registerHandler("status-load", () => {
-      const statusBar = _optionalChain([this, 'access', _9 => _9.renderStatusBar, 'optionalCall', _10 => _10()]);
-      if (statusBar) {
-        const { onClick, ...rest } = statusBar;
-        if (onClick) {
-          this.registerSubscription("status-click", onClick);
-        }
-        return rest;
-      }
-      return null;
-    });
-  }
   // -----------------------------
   // State
   // -----------------------------

package/dist/plugin.mjs

@@ -56,13 +56,11 @@ var Plugin = class {
       this.index = -1;
       this.eventIds.forEach((event) => this.off(event));
       this.eventIds = [];
-      const sidebar = this.renderSidebar?.() || null;
-      if (sidebar) this.render("sidebar", sidebar);
-      const status = this.renderStatusBar?.() || null;
-      if (status) this.registerStatus();
+      this.updateRender();
     });
     this.onSidebarLoad();
-    this.onStatusLoad();
+    this.registerStatus();
+    this.registerSubscription("destroy", this.destroy);
   }
   // -----------------------------
   // Element Factory
@@ -89,8 +87,13 @@ var Plugin = class {
       }
     };
   }
-  render(message, arg) {
-    this.sendMessage({ type: message, arg });
+  updateRender() {
+    this.index = -1;
+    this.sendMessage({
+      type: "sidebar-update",
+      arg: this.renderSidebar?.() || null
+    });
+    this.registerStatus();
   }
   onSidebarLoad() {
     this.index = -1;
@@ -181,19 +184,6 @@ var Plugin = class {
       if (onClick) this.registerSubscription("status-click", onClick);
     }
   }
-  onStatusLoad() {
-    this.registerHandler("status-load", () => {
-      const statusBar = this.renderStatusBar?.();
-      if (statusBar) {
-        const { onClick, ...rest } = statusBar;
-        if (onClick) {
-          this.registerSubscription("status-click", onClick);
-        }
-        return rest;
-      }
-      return null;
-    });
-  }
   // -----------------------------
   // State
   // -----------------------------

package/package.json

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

package/src/lib/plugin/RenderStatusType.ts

@@ -4,7 +4,7 @@ export type StatusElement = {
   iconLeft?: IconName;
   iconRight?: IconName;
   message?: string;
-  text?: string;
+  text?: string | number;
 };
 
 export type RenderStatusType = {

package/src/lib/plugin/index.ts

@@ -111,6 +111,7 @@ export abstract class Plugin<T extends Record<string, unknown>> {
     store: Store<T>;
     notify: (message: string) => void;
   }) {
+    // supply functions from the main app
     this.notify = notify;
     this.sendMessage = (arg) => sendMessage({ ...arg, pluginId });
     this.subscribe = subscribe;
@@ -119,24 +120,24 @@ export abstract class Plugin<T extends Record<string, unknown>> {
     this.pluginId = pluginId;
     this.editor = editor;
 
+    // Sync local state
     this.store = store;
     const value = store.get();
     this.setState({ ...this.init(), ...value });
 
+    // Store changes will trigger updates in sidebar and status if implemented
     this.store.subscribe((curr, prev) => {
       const isEqual = equal(curr, prev);
       if (isEqual) return;
       this.index = -1;
       this.eventIds.forEach((event) => this.off(event));
       this.eventIds = [];
-      const sidebar = this.renderSidebar?.() || null;
-      if (sidebar) this.render("sidebar", sidebar);
-      const status = this.renderStatusBar?.() || null;
-      if (status) this.registerStatus();
+      this.updateRender();
     });
 
     this.onSidebarLoad();
-    this.onStatusLoad();
+    this.registerStatus();
+    this.registerSubscription("destroy", this.destroy);
   }
 
   // -----------------------------
@@ -196,12 +197,16 @@ export abstract class Plugin<T extends Record<string, unknown>> {
 
   abstract init(): T;
 
-  protected render(
-    message: "sidebar" | "modal",
-    arg: ElementInstruction,
-  ): void {
-    this.sendMessage({ type: message, arg });
+  protected updateRender(): void {
+    this.index = -1;
+    this.sendMessage({
+      type: "sidebar-update",
+      arg: this.renderSidebar?.() || null,
+    });
+
+    this.registerStatus();
   }
+
   // -----------------------------
   // Sidebar
   // -----------------------------
@@ -368,20 +373,6 @@ export abstract class Plugin<T extends Record<string, unknown>> {
     }
   }
 
-  private onStatusLoad(): void {
-    this.registerHandler("status-load", () => {
-      const statusBar = this.renderStatusBar?.();
-      if (statusBar) {
-        const { onClick, ...rest } = statusBar;
-        if (onClick) {
-          this.registerSubscription("status-click", onClick);
-        }
-        return rest;
-      }
-      return null;
-    });
-  }
-
   // -----------------------------
   // State
   // -----------------------------

package/src/lib/validate-manifest/index.ts

@@ -30,44 +30,52 @@ const validateManifest = (manifestContent: string) => {
   if (content.main) {
     if (!content.main.path) {
       errors.push("Manifest main path is missing");
-    } else if (!content.main.type) {
+    } else {
+      fileChecks.push(content.main.path);
+    }
+    if (!content.main.type) {
       errors.push("Manifest main type is missing");
-    } else if (!content.main.extensions) {
+    }
+    if (!content.main.extensions) {
       errors.push("Manifest main extensions is missing");
     } else if (!Array.isArray(content.main.extensions)) {
       errors.push("Manifest main extensions is not an array");
     } else if (content.main.extensions.length === 0) {
       errors.push("Manifest main extensions is empty");
-    } else {
-      fileChecks.push(content.main.path);
     }
   }
 
   if (content.sidebar) {
     if (!content.sidebar.icon) {
       errors.push("Manifest sidebar icon is missing");
-    } else if (!content.sidebar.title) {
-      errors.push("Manifest sidebar title is missing");
-    } else if (content.sidebar.path) {
-      if (!content.sidebar.path.endsWith(".js")) {
-        errors.push("Manifest sidebar path must be a js file");
-      } else fileChecks.push(content.sidebar.path);
     } else {
       fileChecks.push(content.sidebar.icon);
     }
+    if (!content.sidebar.title) {
+      errors.push("Manifest sidebar title is missing");
+    }
   }
 
-  if (content.status) {
-    fileChecks.push(content.status);
+  if (content.entry) {
+    if (!content.entry.endsWith(".js"))
+      errors.push("Entry file is not a javascript file");
+    else fileChecks.push(content.entry);
   }
 
-  if (content.iconsPath) {
-    fileChecks.push(content.iconsPath + "/bb.png");
+  if (content.icons) {
+    fileChecks.push(content.icons + "/bb.png");
+    fileChecks.push(content.icons + "/bbe.png");
+    fileChecks.push(content.icons + "/default.png");
+    fileChecks.push(content.icons + "/folder.png");
+    fileChecks.push(content.icons + "/folder-open.png");
   }
 
   if (content.theme) {
-    fileChecks.push(content.theme);
+    if (!content.theme.endsWith(".css"))
+      errors.push("Theme file is not a css file");
+    else fileChecks.push(content.theme);
   }
+
   return {
     errors,
     fileChecks,

package/src/types/editor/Manifest.ts

@@ -14,10 +14,15 @@ export type Manifest = {
   name: string;
   description?: string;
   keyword?: string[];
+  permissions: Permission[];
+  manifest_version: 1;
+  version: string;
+  author?: string;
+  homepage?: string;
+  repository?: string;
   sidebar?: {
     icon: string;
     title: string;
-    path: string;
   };
   main?: {
     path: string;
@@ -25,14 +30,8 @@ export type Manifest = {
     extensions: string[];
     icon?: string;
   };
-  permissions: Permission[];
-  iconsPath?: string;
-  manifest_version: 1;
-  version: string;
-  author?: string;
-  homepage?: string;
-  repository?: string;
+  icons?: string;
   theme?: string;
+  entry?: string;
   [key: string]: unknown;
-  status?: string;
 };

package/src/types/editor/Settings.ts

@@ -48,4 +48,5 @@ export type Settings = {
    */
   registry: Record<string, string>;
   mute: boolean;
+  icon: string;
 };