bb-relay 0.0.34 → 0.0.36

package/dist/editor.d.mts

@@ -57,6 +57,7 @@ type Settings = {
      * { [fileExtension: string]: pluginId  }
      */
     registry: Record<string, string>;
+    mute: boolean;
 };
 
 interface TutorialHeader {

package/dist/editor.d.ts

@@ -57,6 +57,7 @@ type Settings = {
      * { [fileExtension: string]: pluginId  }
      */
     registry: Record<string, string>;
+    mute: boolean;
 };
 
 interface TutorialHeader {

package/dist/index.d.mts

@@ -15,12 +15,12 @@ type Permission = "file-system" | "storage" | "project" | "url" | "selection" |
 type Manifest = {
     id: string;
     name: string;
-    entry: string;
     description?: string;
     keyword?: string[];
     sidebar?: {
         icon: string;
         title: string;
+        path: string;
     };
     main?: {
         path: string;
@@ -37,6 +37,7 @@ type Manifest = {
     repository?: string;
     theme?: string;
     [key: string]: unknown;
+    status?: string;
 };
 
 declare const validateManifest: (manifestContent: string) => {

package/dist/index.d.ts

@@ -15,12 +15,12 @@ type Permission = "file-system" | "storage" | "project" | "url" | "selection" |
 type Manifest = {
     id: string;
     name: string;
-    entry: string;
     description?: string;
     keyword?: string[];
     sidebar?: {
         icon: string;
         title: string;
+        path: string;
     };
     main?: {
         path: string;
@@ -37,6 +37,7 @@ type Manifest = {
     repository?: string;
     theme?: string;
     [key: string]: unknown;
+    status?: string;
 };
 
 declare const validateManifest: (manifestContent: string) => {

package/dist/index.js

@@ -53,18 +53,20 @@ var validateManifest = (manifestContent) => {
       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.status) {
+    fileChecks.push(content.status);
+  }
   if (content.iconsPath) {
     fileChecks.push(content.iconsPath + "/bb.png");
   }
-  if (content.entry) {
-    if (!content.entry.endsWith(".js")) {
-      errors.push("Manifest entry must be a js file");
-    } else fileChecks.push(content.entry);
-  }
   if (content.theme) {
     fileChecks.push(content.theme);
   }

package/dist/index.mjs

@@ -53,18 +53,20 @@ var validateManifest = (manifestContent) => {
       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.status) {
+    fileChecks.push(content.status);
+  }
   if (content.iconsPath) {
     fileChecks.push(content.iconsPath + "/bb.png");
   }
-  if (content.entry) {
-    if (!content.entry.endsWith(".js")) {
-      errors.push("Manifest entry must be a js file");
-    } else fileChecks.push(content.entry);
-  }
   if (content.theme) {
     fileChecks.push(content.theme);
   }

package/dist/plugin.d.mts

@@ -152,6 +152,17 @@ type PluginElement = {
 
 type EventHandler<T = unknown> = (payload?: T) => unknown | Promise<unknown>;
 
+type StatusElement = {
+    iconLeft?: IconName;
+    iconRight?: IconName;
+    message?: string;
+    text?: string;
+};
+type RenderStatusType = {
+    element: StatusElement[];
+    onClick?: () => void;
+};
+
 type Store<T extends Record<string, unknown>> = {
     get(): T;
     set(next: SetState<T>): void;
@@ -191,10 +202,12 @@ declare abstract class Plugin<T extends Record<string, unknown>> {
     private sendMessage;
     private eventIds;
     private index;
+    /** Notification */
+    protected notify: (message: string) => void;
     /** App api, the ones available will be based on the permissions in the manifest*/
     protected editor: EditorAPI;
     /** Constructor */
-    constructor({ pluginId, editor, handler, removeHandler, subscribe, sendMessage, store, }: {
+    constructor({ pluginId, editor, handler, removeHandler, subscribe, sendMessage, store, notify, }: {
         pluginId: string;
         editor: EditorAPI;
         handler: (channel: string, arg: EventHandler) => void;
@@ -206,6 +219,7 @@ declare abstract class Plugin<T extends Record<string, unknown>> {
             pluginId: string;
         }) => void;
         store: Store<T>;
+        notify: (message: string) => void;
     });
     private makeElement;
     protected element: PluginElement;
@@ -267,8 +281,12 @@ declare abstract class Plugin<T extends Record<string, unknown>> {
     protected on(event: "file-changed", callback: (filePath: string) => void): void;
     protected on(event: "file-deleted", callback: (filePath: string) => void): void;
     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;
     selectFile(filePath: string): void;
 }
 
@@ -280,17 +298,4 @@ type Message = {
 
 declare const getPluginChannel: (event: string, pluginId: string) => string;
 
-type StatusElement = {
-    type: "icon";
-    icon: IconName;
-} | {
-    type: "text";
-    text: string;
-};
-type RenderStatusType = {
-    element: StatusElement[];
-    message: string;
-    onClick: () => void;
-};
-
 export { type EditorAPI, type ElementInstruction, type InputInstruction, type Message, type PluginElement, type RenderStatusType, type SetState, type Store, type TextVariant, type TextareaInstruction, Plugin as default, getPluginChannel };

package/dist/plugin.d.ts

@@ -152,6 +152,17 @@ type PluginElement = {
 
 type EventHandler<T = unknown> = (payload?: T) => unknown | Promise<unknown>;
 
+type StatusElement = {
+    iconLeft?: IconName;
+    iconRight?: IconName;
+    message?: string;
+    text?: string;
+};
+type RenderStatusType = {
+    element: StatusElement[];
+    onClick?: () => void;
+};
+
 type Store<T extends Record<string, unknown>> = {
     get(): T;
     set(next: SetState<T>): void;
@@ -191,10 +202,12 @@ declare abstract class Plugin<T extends Record<string, unknown>> {
     private sendMessage;
     private eventIds;
     private index;
+    /** Notification */
+    protected notify: (message: string) => void;
     /** App api, the ones available will be based on the permissions in the manifest*/
     protected editor: EditorAPI;
     /** Constructor */
-    constructor({ pluginId, editor, handler, removeHandler, subscribe, sendMessage, store, }: {
+    constructor({ pluginId, editor, handler, removeHandler, subscribe, sendMessage, store, notify, }: {
         pluginId: string;
         editor: EditorAPI;
         handler: (channel: string, arg: EventHandler) => void;
@@ -206,6 +219,7 @@ declare abstract class Plugin<T extends Record<string, unknown>> {
             pluginId: string;
         }) => void;
         store: Store<T>;
+        notify: (message: string) => void;
     });
     private makeElement;
     protected element: PluginElement;
@@ -267,8 +281,12 @@ declare abstract class Plugin<T extends Record<string, unknown>> {
     protected on(event: "file-changed", callback: (filePath: string) => void): void;
     protected on(event: "file-deleted", callback: (filePath: string) => void): void;
     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;
     selectFile(filePath: string): void;
 }
 
@@ -280,17 +298,4 @@ type Message = {
 
 declare const getPluginChannel: (event: string, pluginId: string) => string;
 
-type StatusElement = {
-    type: "icon";
-    icon: IconName;
-} | {
-    type: "text";
-    text: string;
-};
-type RenderStatusType = {
-    element: StatusElement[];
-    message: string;
-    onClick: () => void;
-};
-
 export { type EditorAPI, type ElementInstruction, type InputInstruction, type Message, type PluginElement, type RenderStatusType, type SetState, type Store, type TextVariant, type TextareaInstruction, Plugin as default, getPluginChannel };

package/dist/plugin.js

@@ -14,7 +14,8 @@ var Plugin = class {
     removeHandler,
     subscribe,
     sendMessage,
-    store
+    store,
+    notify
   }) {
     /** Events: ipc.handle()*/
     this.registeredHandlers = /* @__PURE__ */ new Set();
@@ -39,6 +40,7 @@ var Plugin = class {
       content: (props) => this.makeElement("content", props),
       icon: (props) => this.makeElement("icon", props)
     };
+    this.notify = notify;
     this.sendMessage = (arg) => sendMessage({ ...arg, pluginId });
     this.subscribe = subscribe;
     this.handler = handler;
@@ -56,8 +58,11 @@ var Plugin = class {
       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.onSidebarLoad();
+    this.onStatusLoad();
   }
   // -----------------------------
   // Element Factory
@@ -90,7 +95,7 @@ var Plugin = class {
   onSidebarLoad() {
     this.index = -1;
     this.registerHandler("sidebar-load", () => {
-      return _optionalChain([this, 'access', _3 => _3.renderSidebar, 'optionalCall', _4 => _4()]) || null;
+      return _optionalChain([this, 'access', _5 => _5.renderSidebar, 'optionalCall', _6 => _6()]) || null;
     });
   }
   // -----------------------------
@@ -163,28 +168,32 @@ var Plugin = class {
   on(event, callback) {
     this.registerSubscription(event, callback);
   }
-  // -----------------------------
-  // Status Bar
-  // -----------------------------
-  // abstract renderStatusBar(): RenderStatusType | null;
-  // private registerStatusBar(): void {
-  //   const arg = this.renderStatusBar();
-  //   if (!arg) return;
-  //   const { onClick, ...rest } = arg;
-  //   if (arg) {
-  //     this.sendMessage({
-  //       type: `status`,
-  //       arg: rest,
-  //     });
-  //     this.off("status-click");
-  //     this.registerSubscription("status-click", onClick);
-  //   }
-  // }
-  // private onStatusLoad(): void {
-  //   this.registerHandler("status-load", () => {
-  //     return this.renderStatusBar();
-  //   });
-  // }
+  registerStatus() {
+    const arg = _optionalChain([this, 'access', _7 => _7.renderStatusBar, 'optionalCall', _8 => _8()]);
+    if (!arg) return;
+    const { onClick, ...rest } = arg;
+    if (arg) {
+      this.sendMessage({
+        type: `status`,
+        arg: rest
+      });
+      this.off("status-click");
+      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
   // -----------------------------
@@ -197,12 +206,12 @@ var Plugin = class {
   // -----------------------------
   // Logging
   // -----------------------------
-  // protected notify(message: string): void {
-  //   this.sendMessage({
-  //     type: "notify",
-  //     arg: message,
-  //   });
-  // }
+  log(message) {
+    this.sendMessage({
+      type: "log",
+      arg: message
+    });
+  }
   // -----------------------------
   // Utils
   // -----------------------------

package/dist/plugin.mjs

@@ -14,7 +14,8 @@ var Plugin = class {
     removeHandler,
     subscribe,
     sendMessage,
-    store
+    store,
+    notify
   }) {
     /** Events: ipc.handle()*/
     this.registeredHandlers = /* @__PURE__ */ new Set();
@@ -39,6 +40,7 @@ var Plugin = class {
       content: (props) => this.makeElement("content", props),
       icon: (props) => this.makeElement("icon", props)
     };
+    this.notify = notify;
     this.sendMessage = (arg) => sendMessage({ ...arg, pluginId });
     this.subscribe = subscribe;
     this.handler = handler;
@@ -56,8 +58,11 @@ var Plugin = class {
       this.eventIds = [];
       const sidebar = this.renderSidebar?.() || null;
       if (sidebar) this.render("sidebar", sidebar);
+      const status = this.renderStatusBar?.() || null;
+      if (status) this.registerStatus();
     });
     this.onSidebarLoad();
+    this.onStatusLoad();
   }
   // -----------------------------
   // Element Factory
@@ -163,28 +168,32 @@ var Plugin = class {
   on(event, callback) {
     this.registerSubscription(event, callback);
   }
-  // -----------------------------
-  // Status Bar
-  // -----------------------------
-  // abstract renderStatusBar(): RenderStatusType | null;
-  // private registerStatusBar(): void {
-  //   const arg = this.renderStatusBar();
-  //   if (!arg) return;
-  //   const { onClick, ...rest } = arg;
-  //   if (arg) {
-  //     this.sendMessage({
-  //       type: `status`,
-  //       arg: rest,
-  //     });
-  //     this.off("status-click");
-  //     this.registerSubscription("status-click", onClick);
-  //   }
-  // }
-  // private onStatusLoad(): void {
-  //   this.registerHandler("status-load", () => {
-  //     return this.renderStatusBar();
-  //   });
-  // }
+  registerStatus() {
+    const arg = this.renderStatusBar?.();
+    if (!arg) return;
+    const { onClick, ...rest } = arg;
+    if (arg) {
+      this.sendMessage({
+        type: `status`,
+        arg: rest
+      });
+      this.off("status-click");
+      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
   // -----------------------------
@@ -197,12 +206,12 @@ var Plugin = class {
   // -----------------------------
   // Logging
   // -----------------------------
-  // protected notify(message: string): void {
-  //   this.sendMessage({
-  //     type: "notify",
-  //     arg: message,
-  //   });
-  // }
+  log(message) {
+    this.sendMessage({
+      type: "log",
+      arg: message
+    });
+  }
   // -----------------------------
   // Utils
   // -----------------------------

package/package.json

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

package/src/lib/plugin/RenderStatusType.ts

@@ -1,17 +1,13 @@
 import { IconName } from "lucide-react/dynamic";
 
-export type StatusElement =
-  | {
-      type: "icon";
-      icon: IconName;
-    }
-  | {
-      type: "text";
-      text: string;
-    };
+export type StatusElement = {
+  iconLeft?: IconName;
+  iconRight?: IconName;
+  message?: string;
+  text?: string;
+};
 
 export type RenderStatusType = {
   element: StatusElement[];
-  message: string;
-  onClick: () => void;
+  onClick?: () => void;
 };

package/src/lib/plugin/index.ts

@@ -1,6 +1,5 @@
 import { ElementInstruction } from "./ElementInstruction";
 import { PluginElement } from "./PluginElement";
-// import { RenderStatusType } from "./RenderStatusType";
 import { EventHandler } from "./EventHandler";
 import { getPluginChannel } from "./getPluginChannel";
 import {
@@ -12,6 +11,7 @@ import {
 } from "@/editor";
 import { Project } from "@/database";
 import equal from "fast-deep-equal";
+import { RenderStatusType } from "./RenderStatusType";
 
 export type Store<T extends Record<string, unknown>> = {
   get(): T;
@@ -81,6 +81,9 @@ export abstract class Plugin<T extends Record<string, unknown>> {
 
   private index: number = -1;
 
+  /** Notification */
+  protected notify: (message: string) => void;
+
   /** App api, the ones available will be based on the permissions in the manifest*/
   protected editor: EditorAPI = {};
 
@@ -93,6 +96,7 @@ export abstract class Plugin<T extends Record<string, unknown>> {
     subscribe,
     sendMessage,
     store,
+    notify,
   }: {
     pluginId: string;
     editor: EditorAPI;
@@ -105,7 +109,9 @@ export abstract class Plugin<T extends Record<string, unknown>> {
       pluginId: string;
     }) => void;
     store: Store<T>;
+    notify: (message: string) => void;
   }) {
+    this.notify = notify;
     this.sendMessage = (arg) => sendMessage({ ...arg, pluginId });
     this.subscribe = subscribe;
     this.handler = handler;
@@ -125,9 +131,12 @@ export abstract class Plugin<T extends Record<string, unknown>> {
       this.eventIds = [];
       const sidebar = this.renderSidebar?.() || null;
       if (sidebar) this.render("sidebar", sidebar);
+      const status = this.renderStatusBar?.() || null;
+      if (status) this.registerStatus();
     });
 
     this.onSidebarLoad();
+    this.onStatusLoad();
   }
 
   // -----------------------------
@@ -343,27 +352,35 @@ export abstract class Plugin<T extends Record<string, unknown>> {
   // Status Bar
   // -----------------------------
 
-  // abstract renderStatusBar(): RenderStatusType | null;
-
-  // private registerStatusBar(): void {
-  //   const arg = this.renderStatusBar();
-  //   if (!arg) return;
-  //   const { onClick, ...rest } = arg;
-  //   if (arg) {
-  //     this.sendMessage({
-  //       type: `status`,
-  //       arg: rest,
-  //     });
-  //     this.off("status-click");
-  //     this.registerSubscription("status-click", onClick);
-  //   }
-  // }
-
-  // private onStatusLoad(): void {
-  //   this.registerHandler("status-load", () => {
-  //     return this.renderStatusBar();
-  //   });
-  // }
+  renderStatusBar?(): RenderStatusType | null;
+
+  private registerStatus(): void {
+    const arg = this.renderStatusBar?.();
+    if (!arg) return;
+    const { onClick, ...rest } = arg;
+    if (arg) {
+      this.sendMessage({
+        type: `status`,
+        arg: rest,
+      });
+      this.off("status-click");
+      if (onClick) this.registerSubscription("status-click", onClick);
+    }
+  }
+
+  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
@@ -381,12 +398,12 @@ export abstract class Plugin<T extends Record<string, unknown>> {
   // Logging
   // -----------------------------
 
-  // protected notify(message: string): void {
-  //   this.sendMessage({
-  //     type: "notify",
-  //     arg: message,
-  //   });
-  // }
+  protected log(message: string): void {
+    this.sendMessage({
+      type: "log",
+      arg: message,
+    });
+  }
 
   // -----------------------------
   // Utils

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

@@ -48,19 +48,21 @@ const validateManifest = (manifestContent: string) => {
       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.iconsPath) {
-    fileChecks.push(content.iconsPath + "/bb.png");
+  if (content.status) {
+    fileChecks.push(content.status);
   }
 
-  if (content.entry) {
-    if (!content.entry.endsWith(".js")) {
-      errors.push("Manifest entry must be a js file");
-    } else fileChecks.push(content.entry);
+  if (content.iconsPath) {
+    fileChecks.push(content.iconsPath + "/bb.png");
   }
 
   if (content.theme) {

package/src/types/editor/Manifest.ts

@@ -12,12 +12,12 @@ type Permission =
 export type Manifest = {
   id: string;
   name: string;
-  entry: string;
   description?: string;
   keyword?: string[];
   sidebar?: {
     icon: string;
     title: string;
+    path: string;
   };
   main?: {
     path: string;
@@ -34,4 +34,5 @@ export type Manifest = {
   repository?: string;
   theme?: string;
   [key: string]: unknown;
+  status?: string;
 };

package/src/types/editor/Settings.ts

@@ -41,4 +41,5 @@ export type Settings = {
    * { [fileExtension: string]: pluginId  }
    */
   registry: Record<string, string>;
+  mute: boolean;
 };

package/src/lib/plugin/sample.ts

@@ -1,81 +0,0 @@
-import { Plugin } from ".";
-import { RenderStatusType } from "./RenderStatusType";
-
-const templateGenerator = () => {
-  return [
-    {
-      path: "chapters/chapter 1.md",
-      content: "# Chapter 1 \n The content of your book",
-    },
-    {
-      path: "characters/main/Jane Doe.md",
-      content: "# Jane Doe \n The central characters in your story",
-    },
-    {
-      path: "characters/secondary/John Doe.md",
-      content: "# John Doe \n The supporting characters in your story",
-    },
-    {
-      path: "characters/tertiary/Tom Dick Harry.md",
-      content: "# Tom Dick Harry \n Background characters in your story",
-    },
-    {
-      path: "location/House.md",
-      content: "Places where certain events take place",
-    },
-    {
-      path: "scene/assassination.md",
-      content: "Combination of location and event/action",
-    },
-  ];
-};
-
-export class ExtPlugin extends Plugin {
-  init(): Promise<void> | void {
-    console.log("hello");
-    this.subscribe("project-selected", (arg) => {
-      console.log(arg.id, arg.workingDir);
-    });
-    this.subscribe("file-selected", (path) => {
-      console.log(path);
-    });
-    this.subscribe("new-project", (arg) => {
-      const workingDir = arg.workingDir;
-      const fs = this.editor?.fs!;
-      templateGenerator().forEach(async (file) => {
-        await fs.writeFile({
-          path: `${workingDir}/${file.path}`,
-          content: file.content,
-          type: "utf8",
-        });
-      });
-    });
-  }
-
-  renderSidebar() {
-    return this.element.button({
-      style: {
-        color: "red",
-      },
-      label: "Hello world",
-      onClick: () => {
-        console.log("Hello world");
-      },
-    });
-  }
-
-  renderStatusBar(): RenderStatusType {
-    return {
-      element: [
-        {
-          type: "text",
-          text: "Hello world",
-        },
-      ],
-      message: "Hello world",
-      onClick: () => {
-        console.log("Hello world");
-      },
-    };
-  }
-}