enhance(plugins): add hosted renderer registration and resolution

Author: xyhp915

libs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logseq/libs",
-  "version": "0.2.12",
+  "version": "0.3.1",
   "description": "Logseq SDK libraries",
   "main": "dist/lsplugin.user.js",
   "typings": "index.d.ts",

libs/src/modules/LSPlugin.Experiments.ts

@@ -95,6 +95,37 @@ export class LSPluginExperiments {
     )
   }
 
+  registerHostedRenderer(
+    key: string,
+    opts: {
+      title?: string,
+      subs?: Array<string>
+      type?: string,
+      render: (props: {}) => any
+    }
+  ) {
+    return this.invokeExperMethod(
+      'registerHostedRenderer',
+      this.ctx.baseInfo.id,
+      key,
+      opts
+    )
+  }
+
+  registerSidebarRenderer(
+    key: string,
+    opts: {
+      title?: string,
+      subs?: Array<string>
+      render: (props: {}) => any,
+      [k: string]: any
+    }
+  ) {
+    key = `_sidebar.${key}`
+    opts.type = 'sidebar'
+    return this.registerHostedRenderer(key, opts)
+  }
+
   registerRouteRenderer(
     key: string,
     opts: {

src/main/frontend/components/plugins.cljs

@@ -1591,16 +1591,22 @@
 (rum/defc renderer-resolver < rum/static
   [key']
   (when-let [[pid key] (some-> key' (string/split "."))]
-    ;; TODO: resolve pid renderer from registered plugins
-    (let [pid (or pid "UnknownPlugin")
-          render (if (not (string/blank? key))
-                   (fn [opts]
-                     [:div.p-6
-                      [:h2.bold.text-lg "Renderer for key: " key]
-                      [:p "Plugin ID: " pid]
-                      [:pre (pr-str opts)]])
-                   #(do [:div "No renderer found for key: " key]))]
-      (renderer-container {:key key :pid pid :render render}))))
+    (let [[renderer set-renderer!] (rum/use-state nil)]
+
+      (hooks/use-effect!
+       (fn []
+         (try
+           (when-let [renderer (plugin-handler/resolve-hosted-render pid key :sidebar)]
+             (let [r (bean/->clj renderer)
+                   title (:title r)]
+               (when-let [^js dom (and title (js/document.getElementById key'))]
+                 (set! (. dom -textContent) title))
+               (set-renderer! r)))
+           (catch js/Error e (js/console.error "Failed to resolve renderer:" key' e))))
+       [pid key])
+
+      (when renderer
+        (renderer-container renderer)))))
 
 (defn hook-custom-routes
   [routes]

src/main/frontend/components/plugins.css

@@ -975,3 +975,7 @@ body[data-page=plugins] {
     padding-right: 30px;
   }
 }
+
+.lsp-host-renderer-container {
+  user-select: text;
+}

src/main/frontend/components/right_sidebar.cljs

@@ -138,7 +138,7 @@
         :plugin
         [[:.flex.items-center.page-title
           (ui/icon "puzzle" {:class "text-md mr-2"})
-          (str db-id)]
+          [:h3 {:id db-id} (str db-id)]]
          (plugins/renderer-resolver db-id)]
 
         :search

src/main/frontend/handler/plugin.cljs

@@ -495,6 +495,24 @@
   (create-local-renderer-getter
    :daemon-renderers *daemon-renderer-providers true))
 
+(defonce *hosted-renderer-providers (atom #{}))
+(def register-hosted-renderer
+  ;; [pid key payload]
+  (create-local-renderer-register
+   :hosted-renderers *hosted-renderer-providers))
+(def get-hosted-renderers
+  ;; [key]
+  (create-local-renderer-getter
+   :hosted-renderers *hosted-renderer-providers true))
+
+(defn resolve-hosted-render
+  [pid key type]
+  (some->> (get-hosted-renderers)
+           (medley/find-first #(and (some-> (:pid %) (name) (= pid))
+                                    (or (some-> (:key %) (name) (= key))
+                                        (some-> (:key %) (str) (string/includes? (str "." key))))
+                                    (some->> type (name) (= (:type %)))))))
+
 (defn select-a-plugin-theme
   [pid]
   (when-let [themes (get (group-by :pid (:plugin/installed-themes @state/state)) pid)]

src/main/logseq/sdk/experiments.cljs

@@ -39,6 +39,13 @@
      (keyword pid) key (reduce #(assoc %1 %2 (aget opts (name %2))) {}
                                [:before :subs :render]))))
 
+(defn ^:export register_hosted_renderer
+  [pid key ^js opts]
+  (when-let [^js _pl (plugin-handler/get-plugin-inst pid)]
+    (plugin-handler/register-hosted-renderer
+     (keyword pid) key (reduce #(assoc %1 %2 (aget opts (name %2))) {}
+                               [:title :type :mode :subs :render]))))
+
 (defn ^:export register_extensions_enhancer
   [pid type enhancer]
   (when-let [^js _pl (and (fn? enhancer) (plugin-handler/get-plugin-inst pid))]