mirror of
https://github.com/getpaseo/paseo.git
synced 2026-10-26 03:03:04 +00:00
* fix(files): report document MIME types for binary files
File reads now carry the document's MIME type for binary files, so a file panel can
hand the bytes to a viewer that needs the real type (application/pdf).
* feat(plugins): file panels
Plugins contribute file panels with addFilePanel. A file tab hosts the panels that claim the
file: the built-in Markdown, HTML and image panels, plugin panels, and Source, Paseo's editor,
which claims every text file and is always the last candidate. The panel is the tab body;
the bar shows the document's status and a switcher between the file's panels (side by side
up to three, two on a phone, a menu beyond that).
Paseo asks which panel opens a file only when a plugin panel is among several candidates,
once per open, and remembers the answer per extension or exact filename when told to. Open
with in the tab menu and the switcher change the tab's panel; Always use remembers it.
Opening a file at a line switches the tab to Source.
Panels read and write the host's document, so dirty state, autosave and conflicts stay
Paseo's. DocumentFrame shows bytes documents such as PDFs in the browser's viewer.
Replaces the file tab's Preview/Source mode toggle.
* feat(file-panels): choose and forget file panels in Settings > Files
Settings > Files lists each extension or filename where a plugin panel competes with
another candidate, or that has a remembered panel. Each row chooses the panel that opens
it, or Ask every time; Ask again forgets the choice. Source appears as a candidate for
text files. Panels no connected host offers can be forgotten but not chosen.
* docs(plugins): file panel examples and author reference
Adds the pdf-panel and markdown-panel examples, the File panels section of the plugin
reference, and an e2e spec that installs both examples, opens a PDF in the browser
viewer, and edits Markdown through Paseo's document across the switcher, Source,
autosave and conflicts.
* feat(file-panels): panels read and write through a file handle
The file tab stats the file and mounts its panel without reading it. Every
panel, built-in or plugin, gets a PluginFile handle: readText, readBytes, url,
version-checked writeText/writeBytes (PluginFileConflictError unless force),
and watch. useFileText, useFileBytes and useFileUrl read through it, and
Loading joins @getpaseo/plugin/client/ui. Panels own their loading state.
The host document pipeline, the explorer preview cache and the preview
lifecycle are deleted. The daemon classifies a file version from a bounded
sniff and writes base64 content as bytes behind fileByteWrites.
A deleted file keeps its panel mounted; a read confirms the deletion first,
so a remove-and-rewrite is not reported as one. Native Source decodes with
builtins and highlights in idle-time slices, the lines around the opening
line first, so a large file no longer blocks the JS thread.
* fix(file-panels): Settings offers Source where the picker does, and review follow-ups
- Settings > Files offers Source on every key except those a built-in panel of
another kind (Image) claims, so a plugin that alone claims a text extension
shows the same choices as the picker.
- Delete the unused isSourceFilePanel.
- The Markdown example warns with the file name when its unmount write fails,
rather than dropping the edit silently.
- Document that PluginFile stat fields are read at render time and that watch
or the read hooks are how a panel learns they changed.
* fix(plugins): file events are objects, deletion is a typed error, DocumentFrame owns its fallback
- watch listeners receive { type: "changed" } | { type: "deleted" }, so later
versions can add fields without breaking them.
- PluginFileDeletedError joins PluginFileConflictError. The read hooks report a
deleted file with it, and a write over a deleted file rejects with it; Source
shows that as the deleted notice. PluginFileConflictError now means only
"changed on disk".
- DocumentFrame on Android shows Paseo's "<TYPE> files can't be shown on this
device" message for documents its WebView cannot display, so the PDF example
is useFileUrl + Loading + DocumentFrame with no platform branch.
* test(file-panels): Settings offers Source for a remembered panel no host has
* test(e2e): hide the developer error toast instead of clicking it away
The locator handler that dismissed #error-toast could match a toast that closed before its
click, then wait on it until the test timed out (agent-timeline-resume.spec.ts:45 failed every
attempt on this branch). Hiding the toast with CSS keeps it off app actions with no race.
* test(e2e): desktop browser-tabs hides developer toasts on its attached page
217 lines
7.2 KiB
TypeScript
217 lines
7.2 KiB
TypeScript
import { QueryClient } from "@tanstack/react-query";
|
|
import type { PluginThemeContribution } from "@getpaseo/plugin";
|
|
import { describe, expect, it } from "vitest";
|
|
import { darkTheme, lightTheme } from "@/styles/theme";
|
|
import { collectPluginThemes, rememberPluginThemeHost } from "./themes";
|
|
import { toPluginTheme } from "./theme";
|
|
import type { InstalledPlugin } from "./types";
|
|
|
|
const MOCHA: PluginThemeContribution = {
|
|
id: "mocha",
|
|
name: "Catppuccin Mocha",
|
|
appearance: "dark",
|
|
colors: {
|
|
background: "#1e1e2e",
|
|
foreground: "#cdd6f4",
|
|
raised: "#313244",
|
|
control: "#45475a",
|
|
border: "#45475a",
|
|
accent: "#cba6f7",
|
|
mutedForeground: "#a6adc8",
|
|
ring: "#6c7086",
|
|
},
|
|
};
|
|
|
|
const MOCHA_FORK: PluginThemeContribution = {
|
|
...MOCHA,
|
|
colors: { ...MOCHA.colors, background: "#11111b", accent: "#f5c2e7" },
|
|
};
|
|
|
|
const LATTE: PluginThemeContribution = {
|
|
id: "latte",
|
|
name: "Catppuccin Latte",
|
|
appearance: "light",
|
|
colors: {
|
|
background: "#eff1f5",
|
|
foreground: "#4c4f69",
|
|
raised: "#e6e9ef",
|
|
control: "#dce0e8",
|
|
border: "#ccd0da",
|
|
accent: "#8839ef",
|
|
mutedForeground: "#6c6f85",
|
|
ring: "#9ca0b0",
|
|
},
|
|
};
|
|
|
|
function installed(serverId: string, themes: PluginThemeContribution[]): InstalledPlugin {
|
|
return {
|
|
id: "catppuccin",
|
|
cleanup: () => undefined,
|
|
serverId,
|
|
clientBundle: serverId,
|
|
lifetime: new AbortController(),
|
|
queryClient: new QueryClient(),
|
|
paseo: {} as InstalledPlugin["paseo"],
|
|
invoke: async () => undefined,
|
|
settingsScreens: [],
|
|
surfaces: [],
|
|
sidebarItems: { header: [], footer: [] },
|
|
legacySidebarItems: [],
|
|
filePanels: [],
|
|
workspacePanels: [],
|
|
commandCenterItems: [],
|
|
clientSlashCommands: [],
|
|
attachmentSources: [],
|
|
themes,
|
|
timelineTransformers: [],
|
|
timelineRenderers: [],
|
|
};
|
|
}
|
|
|
|
describe("toPluginTheme", () => {
|
|
it("maps the app theme into the plugin color tokens", () => {
|
|
expect(toPluginTheme(lightTheme)).toEqual({
|
|
colors: {
|
|
surface0: lightTheme.colors.surface0,
|
|
surface1: lightTheme.colors.surface1,
|
|
surface2: lightTheme.colors.surface2,
|
|
border: lightTheme.colors.border,
|
|
foreground: lightTheme.colors.foreground,
|
|
foregroundMuted: lightTheme.colors.foregroundMuted,
|
|
accent: lightTheme.colors.accent,
|
|
accentForeground: lightTheme.colors.accentForeground,
|
|
statusSuccess: lightTheme.colors.statusSuccess,
|
|
statusWarning: lightTheme.colors.statusWarning,
|
|
statusDanger: lightTheme.colors.statusDanger,
|
|
},
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("plugin theme palettes", () => {
|
|
it("expands a contributed palette onto the semantic and terminal tokens", () => {
|
|
const option = collectPluginThemes([installed("host-a", [MOCHA])], new Set(["host-a"]))[0];
|
|
const theme = option.theme;
|
|
|
|
expect(theme.colorScheme).toBe("dark");
|
|
expect(theme.colors).toMatchObject({
|
|
surface0: "#1e1e2e",
|
|
surface1: "#313244",
|
|
surface2: "#45475a",
|
|
surfaceSidebar: "#1e1e2e",
|
|
foreground: "#cdd6f4",
|
|
foregroundMuted: "#a6adc8",
|
|
border: "#45475a",
|
|
accent: "#cba6f7",
|
|
accentBright: "#cba6f7",
|
|
accentForeground: "#1e1e2e",
|
|
ring: "#6c7086",
|
|
terminal: {
|
|
background: "#1e1e2e",
|
|
foreground: "#cdd6f4",
|
|
cursor: "#cdd6f4",
|
|
cursorAccent: "#1e1e2e",
|
|
black: "#45475a",
|
|
brightBlack: "#6c7086",
|
|
},
|
|
});
|
|
});
|
|
|
|
it("carries the accent on the foreground when no accent is given", () => {
|
|
const { accent: _accent, ...colors } = MOCHA.colors;
|
|
const contribution = { ...MOCHA, colors };
|
|
const theme = collectPluginThemes([installed("host-a", [contribution])], new Set(["host-a"]))[0]
|
|
.theme;
|
|
|
|
expect(theme.colors.accent).toBe("#cdd6f4");
|
|
expect(theme.colors.accentBright).toBe("#cdd6f4");
|
|
});
|
|
|
|
it("keeps the status and syntax tokens the built-in dark themes use", () => {
|
|
const theme = collectPluginThemes([installed("host-a", [MOCHA])], new Set(["host-a"]))[0].theme;
|
|
|
|
expect(theme.colors.statusDanger).toBe(darkTheme.colors.statusDanger);
|
|
expect(theme.colors.syntax).toEqual(darkTheme.colors.syntax);
|
|
});
|
|
|
|
it("derives a complete light theme from the same palette contract", () => {
|
|
const theme = collectPluginThemes([installed("host-a", [LATTE])], new Set(["host-a"]))[0].theme;
|
|
|
|
expect(theme.colorScheme).toBe("light");
|
|
expect(theme.colors).toMatchObject({
|
|
surface0: "#eff1f5",
|
|
surface1: "#e6e9ef",
|
|
surface2: "#dce0e8",
|
|
surfaceSidebar: "#dce0e8",
|
|
foreground: "#4c4f69",
|
|
border: "#ccd0da",
|
|
accent: "#8839ef",
|
|
ring: "#9ca0b0",
|
|
terminal: {
|
|
background: "#eff1f5",
|
|
foreground: "#4c4f69",
|
|
black: "#4c4f69",
|
|
},
|
|
});
|
|
expect(theme.colors.statusDanger).toBe(lightTheme.colors.statusDanger);
|
|
expect(theme.colors.syntax).toEqual(lightTheme.colors.syntax);
|
|
});
|
|
});
|
|
|
|
const SUPPORTED = new Set(["host-a", "host-b", "host-z"]);
|
|
|
|
describe("collectPluginThemes", () => {
|
|
it("coalesces the same contribution across hosts", () => {
|
|
const options = collectPluginThemes(
|
|
[installed("host-a", [MOCHA]), installed("host-b", [MOCHA])],
|
|
new Set(["host-a", "host-b"]),
|
|
);
|
|
|
|
expect(options.map((option) => option.id)).toEqual(["catppuccin/theme/mocha"]);
|
|
});
|
|
|
|
// COMPAT(pluginThemes): a daemon without the capability keeps `addTheme` in the server bundle
|
|
// it compiles, so its themes are not offered at all.
|
|
it("drops themes from a host that predates the pluginThemes capability", () => {
|
|
expect(collectPluginThemes([installed("old-host", [MOCHA])], new Set())).toEqual([]);
|
|
});
|
|
|
|
it("keeps themes from the supported host when one peer is too old", () => {
|
|
const options = collectPluginThemes(
|
|
[installed("new-host", [MOCHA]), installed("old-host", [MOCHA])],
|
|
new Set(["new-host"]),
|
|
);
|
|
|
|
expect(options.map((option) => option.id)).toEqual(["catppuccin/theme/mocha"]);
|
|
});
|
|
|
|
// Two hosts, same plugin and theme id, different palettes. The picked host has to survive a peer
|
|
// connecting or dropping, or the app repaints with no settings change. The remembered host is
|
|
// module state, so this runs the whole sequence in one test rather than leaning on test order.
|
|
it("pins the palette to the picked host across peer connect and disconnect", () => {
|
|
const bothHosts = () =>
|
|
collectPluginThemes(
|
|
[installed("host-a", [MOCHA]), installed("host-z", [MOCHA_FORK])],
|
|
SUPPORTED,
|
|
);
|
|
|
|
const beforePick = bothHosts();
|
|
expect(beforePick).toHaveLength(1);
|
|
expect(beforePick[0]?.serverId).toBe("host-a");
|
|
expect(beforePick[0]?.theme.colors.surface0).toBe("#1e1e2e");
|
|
|
|
const onlyHostZ = collectPluginThemes([installed("host-z", [MOCHA_FORK])], SUPPORTED);
|
|
expect(onlyHostZ[0]).toBeDefined();
|
|
rememberPluginThemeHost(onlyHostZ[0]);
|
|
|
|
const afterPick = bothHosts();
|
|
expect(afterPick).toHaveLength(1);
|
|
expect(afterPick[0]?.serverId).toBe("host-z");
|
|
expect(afterPick[0]?.theme.colors.surface0).toBe("#11111b");
|
|
|
|
const withoutHostZ = collectPluginThemes([installed("host-a", [MOCHA])], SUPPORTED);
|
|
expect(withoutHostZ[0]?.serverId).toBe("host-a");
|
|
expect(withoutHostZ[0]?.theme.colors.surface0).toBe("#1e1e2e");
|
|
});
|
|
});
|