From f4a6b205adca486d4e9cda0270e13a9ff0afd7be Mon Sep 17 00:00:00 2001 From: Codex Date: Mon, 26 Oct 2026 05:26:25 +0000 Subject: [PATCH] feat(plugins): add versioned offline brand icons and author guidance --- application/state/usePluginBrandIcon.ts | 19 ++++ components/plugins/PluginBrandIcon.tsx | 26 ++++++ components/plugins/catalog-brand-icons.json | 17 ++++ components/plugins/catalogBrandIcons.ts | 9 ++ .../settings/tabs/PluginBrandIcon.test.tsx | 58 +++++++++++++ .../settings/tabs/PluginMarketplace.tsx | 7 +- .../settings/tabs/PluginPackageManager.tsx | 5 +- docs/plugin-platform/contract-and-sdk.md | 17 +++- docs/plugin-platform/plugin-icons-proposal.md | 2 +- docs/plugin-platform/plugin-icons.md | 81 ++++++++++++++++++ electron/main/registerBridges.cjs | 1 + electron/pluginRuntime.test.cjs | 2 + electron/plugins/brandIconService.test.cjs | 38 ++++++++ electron/plugins/constants.cjs | 2 +- electron/plugins/contributionIconService.cjs | 34 +++++++- .../generated/plugin-contract.schema.json | 5 +- electron/plugins/hostService.cjs | 4 +- electron/plugins/pluginBridge.cjs | 5 ++ electron/plugins/pluginBridge.test.cjs | 13 +++ electron/plugins/runtimeSupervisor.cjs | 4 +- electron/plugins/runtimeSupervisor.test.cjs | 16 ++++ electron/preload/api.cjs | 1 + examples/plugins/hello-netcatty/package.json | 2 +- examples/plugins/starter-netcatty/README.md | 9 +- .../starter-netcatty/assets/logo-dark.png | Bin 0 -> 873 bytes .../starter-netcatty/assets/logo-light.png | Bin 0 -> 873 bytes .../starter-netcatty/netcatty.plugin.json | 14 ++- .../plugins/starter-netcatty/package.json | 4 +- global.d.ts | 1 + package-lock.json | 16 ++-- packages/plugin-cli/package.json | 4 +- packages/plugin-cli/src/archive.ts | 22 ++++- packages/plugin-cli/src/brandIcons.test.ts | 57 ++++++++++++ packages/plugin-cli/src/commands.ts | 2 +- packages/plugin-cli/src/compatibility.ts | 10 ++- packages/plugin-cli/src/manifest.ts | 10 ++- packages/plugin-contract/package.json | 2 +- .../schema/plugin-contract.schema.json | 3 +- packages/plugin-contract/src/brandIcon.ts | 55 ++++++++++++ .../src/generated/plugin-contract.ts | 1 + packages/plugin-contract/src/index.ts | 4 +- packages/plugin-sdk/package.json | 4 +- scripts/generate-plugin-contract.mjs | 2 +- 43 files changed, 546 insertions(+), 42 deletions(-) create mode 100644 application/state/usePluginBrandIcon.ts create mode 100644 components/plugins/PluginBrandIcon.tsx create mode 100644 components/plugins/catalog-brand-icons.json create mode 100644 components/plugins/catalogBrandIcons.ts create mode 100644 components/settings/tabs/PluginBrandIcon.test.tsx create mode 100644 docs/plugin-platform/plugin-icons.md create mode 100644 electron/plugins/brandIconService.test.cjs create mode 100644 examples/plugins/starter-netcatty/assets/logo-dark.png create mode 100644 examples/plugins/starter-netcatty/assets/logo-light.png create mode 100644 packages/plugin-cli/src/brandIcons.test.ts create mode 100644 packages/plugin-contract/src/brandIcon.ts diff --git a/application/state/usePluginBrandIcon.ts b/application/state/usePluginBrandIcon.ts new file mode 100644 index 000000000..ab195ca4d --- /dev/null +++ b/application/state/usePluginBrandIcon.ts @@ -0,0 +1,19 @@ +import { useEffect, useState } from 'react'; +import { netcattyBridge } from '../../infrastructure/services/netcattyBridge'; + +type Raster = { light: string; dark?: string }; +export function usePluginBrandIcon(plugin?: NetcattyInstalledPlugin): Raster | null { + const pluginId = plugin?.id; + const kind = plugin?.manifest?.icon?.kind; + const key = JSON.stringify([pluginId, plugin?.activeVersion, plugin?.archiveSha256, plugin?.runtime?.quarantinedAt, plugin?.manifest?.icon]); + const [loaded, setLoaded] = useState<{ key: string; value: Raster | null } | null>(null); + useEffect(() => { + if (!pluginId || kind !== 'package') return; + let cancelled = false; + void netcattyBridge.get()?.getPluginBrandIcon?.(pluginId).then((value) => { + if (!cancelled) setLoaded({ key, value }); + }).catch(() => { if (!cancelled) setLoaded({ key, value: null }); }); + return () => { cancelled = true; }; + }, [key, pluginId, kind]); + return loaded?.key === key ? loaded.value : null; +} diff --git a/components/plugins/PluginBrandIcon.tsx b/components/plugins/PluginBrandIcon.tsx new file mode 100644 index 000000000..1bcd6aa9e --- /dev/null +++ b/components/plugins/PluginBrandIcon.tsx @@ -0,0 +1,26 @@ +import React, { useState } from 'react'; +import { Package } from 'lucide-react'; +import { usePluginBrandIcon } from '../../application/state/usePluginBrandIcon'; +import { PluginContributionIcon } from './PluginContributionIcon'; +import { resolveCatalogBrandIcon } from './catalogBrandIcons'; + +export function PluginBrandIcon({ plugin, entry, size = 32, className = '' }: { + plugin?: NetcattyInstalledPlugin; + entry?: NetcattyPluginCatalogEntry; + size?: number; + className?: string; +}) { + const manifest = plugin?.manifest ?? entry?.manifest; + const icon = manifest?.icon; + const key = JSON.stringify([plugin?.id, plugin?.activeVersion, plugin?.archiveSha256, plugin?.runtime?.quarantinedAt, icon]); + const loaded = usePluginBrandIcon(plugin); + const [failed, setFailed] = useState(null); + const raster = plugin ? loaded : entry ? resolveCatalogBrandIcon(entry) : null; + const imageKey = JSON.stringify([key, raster]); + if (icon?.kind === 'theme') return ; + if (!raster || failed === imageKey) return