@lapis-notes/workspace 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @lapis-notes/workspace
+
+## 0.1.0
+
+### Minor Changes
+
+- First public npm release of the Lapis Notes workspace shell that composes the
+  API workspace model with Design Core layout presentation.

package/LICENSE.md

@@ -0,0 +1,4 @@
+AGPL-3.0-or-later
+
+This package is licensed under the GNU Affero General Public License v3.0 or later.
+See <https://www.gnu.org/licenses/agpl-3.0.en.html>.

package/README.md

@@ -0,0 +1,36 @@
+# @lapis-notes/workspace
+
+Workspace shell adapter for Lapis Notes package consumers.
+
+This package exposes the public Svelte workspace shell that connects a host-owned
+`App` to Design Core layout presentation. It stays shell-only: hosts own vault
+selection, plugin boot, persistence, routing, profile management, and production
+backend setup.
+
+## Public surface
+
+- `WorkspaceShell`, the Svelte component used by hosts and demos.
+- `WorkspaceShellProps`, the public prop contract for typed Svelte consumers.
+
+## Usage
+
+```ts
+import { WorkspaceShell } from "@lapis-notes/workspace";
+```
+
+Install `@lapis-notes/api`, `@lapismd/design-core`, and Svelte from npm with
+compatible versions. `@lapis-notes/workspace@0.1.0` expects
+`@lapis-notes/api@^0.1.0`.
+
+## Common Scripts
+
+```sh
+pnpm --filter @lapis-notes/workspace build
+pnpm --filter @lapis-notes/workspace check
+pnpm --filter @lapis-notes/workspace test
+```
+
+## References
+
+- [Package spec](spec.md)
+- [Canonical spec](../../spec/src/20-packages/workspace/index.md)

package/dist/WorkspaceShell.svelte

@@ -0,0 +1,59 @@
+<script lang="ts" module>
+  import type { App } from "@lapis-notes/api";
+  import type { WorkspaceNavigation } from "@lapismd/design-core/workspace/app-shell";
+  import type { WorkspaceRequestedDisplayMode } from "@lapismd/design-core/workspace/core";
+
+  export interface WorkspaceShellProps {
+    app: App;
+    displayMode?: WorkspaceRequestedDisplayMode;
+    workspaceLabel?: string;
+    workspaceNavigation?: WorkspaceNavigation;
+    class?: string;
+  }
+</script>
+
+<script lang="ts">
+  import { onMount, untrack } from "svelte";
+  import { provideApplicationState } from "@lapis-notes/api";
+  import { getWorkspaceHostBinding } from "@lapis-notes/api/workspace-host";
+  import { AppShell } from "@lapismd/design-core/workspace/app-shell";
+  import "./workspace-shell.css";
+
+  let {
+    app,
+    displayMode,
+    workspaceLabel = "Lapis Notes",
+    workspaceNavigation,
+    class: className = "",
+  }: WorkspaceShellProps = $props();
+
+  provideApplicationState(untrack(() => app));
+  const { controller } = untrack(() => getWorkspaceHostBinding(app.workspace));
+  let activateNewTabs = $derived(
+    app.configuration
+      .getConfiguration()
+      .get("editor.alwaysFocusNewTabs", false),
+  );
+
+  onMount(() => {
+    // AppShell.Root does not own startup. By the time this shell is mounted,
+    // the consumer has loaded the vault and restored the Lapis workspace.
+    void controller.start();
+  });
+</script>
+
+<div
+  class={`lapis-workspace-shell ${className}`}
+  data-ui-component="lapis-workspace-shell"
+  data-ui-part="root"
+>
+  <AppShell.Root
+    {controller}
+    autoStart={false}
+    {activateNewTabs}
+    disposeOnDestroy={false}
+    theme="inherit"
+  >
+    <AppShell.Surface {displayMode} {workspaceLabel} {workspaceNavigation} />
+  </AppShell.Root>
+</div>

package/dist/WorkspaceShell.svelte.d.ts

@@ -0,0 +1,14 @@
+import type { App } from "@lapis-notes/api";
+import type { WorkspaceNavigation } from "@lapismd/design-core/workspace/app-shell";
+import type { WorkspaceRequestedDisplayMode } from "@lapismd/design-core/workspace/core";
+export interface WorkspaceShellProps {
+    app: App;
+    displayMode?: WorkspaceRequestedDisplayMode;
+    workspaceLabel?: string;
+    workspaceNavigation?: WorkspaceNavigation;
+    class?: string;
+}
+import "./workspace-shell.css";
+declare const WorkspaceShell: import("svelte").Component<WorkspaceShellProps, {}, "">;
+type WorkspaceShell = ReturnType<typeof WorkspaceShell>;
+export default WorkspaceShell;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { default as WorkspaceShell } from "./WorkspaceShell.svelte";
+export type { WorkspaceShellProps } from "./WorkspaceShell.svelte";
+export { registerPluginManagementSettings } from "./plugin-management/register-plugin-management-settings";
+export { default as PluginRegistrySettingsPage } from "./plugin-management/PluginRegistrySettingsPage.svelte";
+export { default as CorePluginsSettingsPage } from "./plugin-management/CorePluginsSettingsPage.svelte";
+export { default as CommunityPluginsSettingsPage } from "./plugin-management/CommunityPluginsSettingsPage.svelte";

package/dist/index.js

@@ -0,0 +1,5 @@
+export { default as WorkspaceShell } from "./WorkspaceShell.svelte";
+export { registerPluginManagementSettings } from "./plugin-management/register-plugin-management-settings";
+export { default as PluginRegistrySettingsPage } from "./plugin-management/PluginRegistrySettingsPage.svelte";
+export { default as CorePluginsSettingsPage } from "./plugin-management/CorePluginsSettingsPage.svelte";
+export { default as CommunityPluginsSettingsPage } from "./plugin-management/CommunityPluginsSettingsPage.svelte";

package/dist/plugin-management/CommunityPluginsSettingsPage.svelte

@@ -0,0 +1,182 @@
+<script lang="ts">
+  import * as Button from "@lapismd/design-core/shadcn/button";
+  import type { WorkspaceSettingsPageProps } from "@lapismd/design-core/workspace/settings";
+  import { onMount, tick, untrack } from "svelte";
+  import { getPluginManagementContext } from "./plugin-management-context.svelte";
+  import "./plugin-management.css";
+  import PluginSettingsRow from "./PluginSettingsRow.svelte";
+  import {
+    openPluginSettings,
+    pluginDiagnosticRows,
+    pluginSettingsSectionId,
+  } from "./plugin-settings-navigation";
+
+  let { controller }: WorkspaceSettingsPageProps = $props();
+  const context = untrack(() => getPluginManagementContext(controller));
+  const app = context.app;
+  let revision = $state(0);
+  let trustBusy = $state(false);
+  let trustState = $derived.by(() => {
+    revision;
+    return app.workspaceTrust.getState();
+  });
+  let expandedPluginIds = $state(new Set<string>());
+  let plugins = $derived.by(() => {
+    revision;
+    return app.plugins.communityPlugins;
+  });
+  let indexedDiagnostics = $derived.by(() => {
+    revision;
+    const loaded = new Set(plugins.map((plugin) => plugin.manifest.id));
+    const core = new Set(
+      app.plugins.corePluginEntries.map((entry) => entry.manifest.id),
+    );
+    return app.plugins.communityPluginDiagnostics.filter(
+      (entry) => !loaded.has(entry.pluginId) && !core.has(entry.pluginId),
+    );
+  });
+
+  $effect(() => {
+    const revealRevision = context.reveal.revision;
+    if (
+      !revealRevision ||
+      context.reveal.sectionId !== "community-plugins" ||
+      !context.reveal.entryId.startsWith("community:")
+    ) {
+      return;
+    }
+    const pluginId = context.reveal.entryId.slice("community:".length);
+    expandedPluginIds = new Set([...expandedPluginIds, pluginId]);
+    void tick().then(() => {
+      document
+        .querySelector(`[data-settings-plugin-id="${CSS.escape(pluginId)}"]`)
+        ?.scrollIntoView({ block: "center" });
+    });
+  });
+
+  onMount(() => {
+    const refresh = () => (revision += 1);
+    const loaded = app.plugins.on("plugins-loaded", refresh);
+    const enabled = app.plugins.on("plugin-enabled", refresh);
+    const disabled = app.plugins.on("plugin-disabled", refresh);
+    const error = app.plugins.on("plugin-error", refresh);
+    void app.workspaceTrust.ready().then(refresh);
+    return () => {
+      app.plugins.offref(loaded);
+      app.plugins.offref(enabled);
+      app.plugins.offref(disabled);
+      app.plugins.offref(error);
+    };
+  });
+
+  async function updateTrust(trusted: boolean): Promise<void> {
+    if (trustBusy) return;
+    trustBusy = true;
+    try {
+      if (trusted) await app.workspaceTrust.grant();
+      else await app.workspaceTrust.revoke();
+      revision += 1;
+    } finally {
+      trustBusy = false;
+    }
+  }
+</script>
+
+<section
+  class="lapis-plugin-management"
+  data-ui-component="lapis-plugin-management"
+  data-ui-part="community-plugins"
+>
+  <div class="lapis-plugin-management__trust">
+    <div>
+      <h1>Workspace Trust</h1>
+      <p>
+        {trustState.trusted
+          ? "This vault is trusted. Trusted desktop plugins and brokered capabilities may run for this workspace identity."
+          : "This vault is untrusted. Trusted desktop plugins, brokered capabilities, and community plugin settings surfaces stay blocked until you trust this workspace."}
+      </p>
+    </div>
+    <div class="lapis-plugin-management__actions">
+      <Button.Root
+        disabled={trustState.trusted || trustBusy}
+        onclick={() => void updateTrust(true)}
+      >Trust workspace</Button.Root>
+      <Button.Root
+        variant="destructive"
+        disabled={!trustState.trusted || trustBusy}
+        onclick={() => void updateTrust(false)}
+      >Revoke trust</Button.Root>
+    </div>
+  </div>
+
+  <header class="lapis-plugin-management__header">
+    <div>
+      <h1>Installed Plugins</h1>
+      <p>Manage installed community and registry plugins for this vault.</p>
+    </div>
+    <Button.Root
+      variant="outline"
+      onclick={() => globalThis.location?.reload()}
+    >Reload plugins</Button.Root>
+  </header>
+
+  <div class="lapis-plugin-management__rows">
+    {#if plugins.length === 0 && indexedDiagnostics.length === 0}
+      <p class="lapis-plugin-management__empty">
+        No community plugins found in .obsidian/plugins.
+      </p>
+    {/if}
+
+    {#each plugins as plugin (plugin.manifest.id)}
+      <PluginSettingsRow
+        pluginId={plugin.manifest.id}
+        name={plugin.manifest.name}
+        description={plugin.manifest.description}
+        version={plugin.manifest.version}
+        provenance={plugin.provenance}
+        status={plugin.state === "failed"
+          ? "Failed"
+          : plugin.enabled
+            ? "Enabled"
+            : "Disabled"}
+        error={plugin.lastFailureMessage ?? plugin.errorMessage ?? undefined}
+        enabled={plugin.enabled}
+        expanded={expandedPluginIds.has(plugin.manifest.id)}
+        hasOptions={Boolean(
+          pluginSettingsSectionId(controller, plugin.manifest.id),
+        )}
+        diagnostics={pluginDiagnosticRows(app, plugin.manifest.id)}
+        onOptions={() => openPluginSettings(controller, plugin.manifest.id)}
+        onRestart={async () => {
+          await app.plugins.restartPlugin(plugin.manifest.id);
+        }}
+        onToggle={async (enabled) => {
+          if (enabled) await app.plugins.enablePlugin(plugin.manifest.id);
+          else await app.plugins.disablePlugin(plugin.manifest.id);
+        }}
+      />
+    {/each}
+
+    {#each indexedDiagnostics as diagnostics (diagnostics.pluginId)}
+      <PluginSettingsRow
+        pluginId={diagnostics.pluginId}
+        name={diagnostics.name ?? diagnostics.pluginId}
+        description={diagnostics.description ?? undefined}
+        version={diagnostics.version ?? undefined}
+        provenance={diagnostics.provenance}
+        status={diagnostics.state}
+        error={diagnostics.lastFailureMessage ?? undefined}
+        enabled={false}
+        expanded={expandedPluginIds.has(diagnostics.pluginId)}
+        hasOptions={Boolean(
+          pluginSettingsSectionId(controller, diagnostics.pluginId),
+        )}
+        diagnostics={pluginDiagnosticRows(app, diagnostics.pluginId)}
+        onOptions={() => openPluginSettings(controller, diagnostics.pluginId)}
+        onRestart={async () => {
+          await app.plugins.restartPlugin(diagnostics.pluginId);
+        }}
+      />
+    {/each}
+  </div>
+</section>

package/dist/plugin-management/CommunityPluginsSettingsPage.svelte.d.ts

@@ -0,0 +1,5 @@
+import type { WorkspaceSettingsPageProps } from "@lapismd/design-core/workspace/settings";
+import "./plugin-management.css";
+declare const CommunityPluginsSettingsPage: import("svelte").Component<WorkspaceSettingsPageProps, {}, "">;
+type CommunityPluginsSettingsPage = ReturnType<typeof CommunityPluginsSettingsPage>;
+export default CommunityPluginsSettingsPage;

package/dist/plugin-management/CorePluginsSettingsPage.svelte

@@ -0,0 +1,111 @@
+<script lang="ts">
+  import type { WorkspaceSettingsPageProps } from "@lapismd/design-core/workspace/settings";
+  import { onMount, tick, untrack } from "svelte";
+  import { getPluginManagementContext } from "./plugin-management-context.svelte";
+  import "./plugin-management.css";
+  import PluginSettingsRow from "./PluginSettingsRow.svelte";
+  import {
+    openPluginSettings,
+    pluginDiagnosticRows,
+    pluginSettingsSectionId,
+  } from "./plugin-settings-navigation";
+
+  let { controller }: WorkspaceSettingsPageProps = $props();
+  const context = untrack(() => getPluginManagementContext(controller));
+  const app = context.app;
+  let revision = $state(0);
+  let expandedPluginIds = $state(new Set<string>());
+  let entries = $derived.by(() => {
+    revision;
+    const seen = new Set<string>();
+    return app.plugins.corePluginEntries.filter((entry) => {
+      if (seen.has(entry.manifest.id)) return false;
+      seen.add(entry.manifest.id);
+      return true;
+    });
+  });
+
+  $effect(() => {
+    const revealRevision = context.reveal.revision;
+    if (
+      !revealRevision ||
+      context.reveal.sectionId !== "core-plugins" ||
+      !context.reveal.entryId.startsWith("core:")
+    ) {
+      return;
+    }
+    const pluginId = context.reveal.entryId.slice("core:".length);
+    expandedPluginIds = new Set([...expandedPluginIds, pluginId]);
+    void tick().then(() => {
+      document
+        .querySelector(`[data-settings-plugin-id="${CSS.escape(pluginId)}"]`)
+        ?.scrollIntoView({ block: "center" });
+    });
+  });
+
+  onMount(() => {
+    const refresh = () => (revision += 1);
+    const loaded = app.plugins.on("plugins-loaded", refresh);
+    const enabled = app.plugins.on("plugin-enabled", refresh);
+    const disabled = app.plugins.on("plugin-disabled", refresh);
+    const error = app.plugins.on("plugin-error", refresh);
+    return () => {
+      app.plugins.offref(loaded);
+      app.plugins.offref(enabled);
+      app.plugins.offref(disabled);
+      app.plugins.offref(error);
+    };
+  });
+
+</script>
+
+<section
+  class="lapis-plugin-management"
+  data-ui-component="lapis-plugin-management"
+  data-ui-part="core-plugins"
+>
+  <header class="lapis-plugin-management__header">
+    <div>
+      <h1>Installed Core Plugins</h1>
+      <p>Enable, inspect, and configure this app's static plugins.</p>
+    </div>
+  </header>
+
+  <div class="lapis-plugin-management__rows">
+    {#if entries.length === 0}
+      <p class="lapis-plugin-management__empty">
+        No core plugins are registered.
+      </p>
+    {/if}
+    {#each entries as entry (entry.manifest.id)}
+      <PluginSettingsRow
+        pluginId={entry.manifest.id}
+        name={entry.manifest.name}
+        description={entry.manifest.description}
+        version={entry.manifest.version}
+        provenance={entry.distribution}
+        status={entry.errorMessage
+          ? "Failed"
+          : entry.enabled
+            ? "Enabled"
+            : "Disabled"}
+        error={entry.errorMessage ?? undefined}
+        enabled={entry.enabled}
+        required={entry.required}
+        expanded={expandedPluginIds.has(entry.manifest.id)}
+        hasOptions={Boolean(
+          pluginSettingsSectionId(controller, entry.manifest.id),
+        )}
+        diagnostics={pluginDiagnosticRows(app, entry.manifest.id)}
+        onOptions={() => openPluginSettings(controller, entry.manifest.id)}
+        onRestart={async () => {
+          await app.plugins.restartPlugin(entry.manifest.id);
+        }}
+        onToggle={async (enabled) => {
+          if (enabled) await app.plugins.enablePlugin(entry.manifest.id);
+          else await app.plugins.disablePlugin(entry.manifest.id);
+        }}
+      />
+    {/each}
+  </div>
+</section>

package/dist/plugin-management/CorePluginsSettingsPage.svelte.d.ts

@@ -0,0 +1,5 @@
+import type { WorkspaceSettingsPageProps } from "@lapismd/design-core/workspace/settings";
+import "./plugin-management.css";
+declare const CorePluginsSettingsPage: import("svelte").Component<WorkspaceSettingsPageProps, {}, "">;
+type CorePluginsSettingsPage = ReturnType<typeof CorePluginsSettingsPage>;
+export default CorePluginsSettingsPage;

package/dist/plugin-management/PluginReadmeRenderer.svelte

@@ -0,0 +1,47 @@
+<script lang="ts">
+  import { Component, MarkdownRenderer, type App } from "@lapis-notes/api";
+  import { onDestroy } from "svelte";
+
+  class PluginReadmeLifecycle extends Component {}
+
+  let {
+    app,
+    markdown,
+    sourcePath,
+  }: { app: App; markdown: string; sourcePath: string } = $props();
+
+  let host = $state<HTMLElement | null>(null);
+  let renderRevision = 0;
+  let lifecycle: Component | null = null;
+
+  $effect(() => {
+    const target = host;
+    const value = markdown;
+    const path = sourcePath;
+    if (!target) return;
+    const revision = ++renderRevision;
+    lifecycle?.unload();
+    lifecycle = new PluginReadmeLifecycle();
+    lifecycle.load();
+    target.replaceChildren();
+    void MarkdownRenderer.render(app, value, target, path, lifecycle).catch(
+      (error) => {
+        if (revision !== renderRevision) return;
+        target.textContent =
+          error instanceof Error ? error.message : String(error);
+      },
+    );
+  });
+
+  onDestroy(() => {
+    renderRevision += 1;
+    lifecycle?.unload();
+    lifecycle = null;
+  });
+</script>
+
+<div
+  bind:this={host}
+  class="lapis-plugin-readme"
+  data-ui-component="lapis-plugin-readme"
+></div>

package/dist/plugin-management/PluginReadmeRenderer.svelte.d.ts

@@ -0,0 +1,9 @@
+import { type App } from "@lapis-notes/api";
+type $$ComponentProps = {
+    app: App;
+    markdown: string;
+    sourcePath: string;
+};
+declare const PluginReadmeRenderer: import("svelte").Component<$$ComponentProps, {}, "">;
+type PluginReadmeRenderer = ReturnType<typeof PluginReadmeRenderer>;
+export default PluginReadmeRenderer;