mirror of
https://github.com/stablyai/orca.git
synced 2026-11-16 10:58:10 +00:00
* feat(plugins): add permissioned desktop appearance publication * docs(plugins): add one-line API comments for appearance provider * chore(plugins): regenerate declarative testing kit for appearance API --------- Co-authored-by: Matthew Wilkinson <wilkinson.m@outlook.com>
48 lines
1.5 KiB
TypeScript
48 lines
1.5 KiB
TypeScript
import { z } from 'zod'
|
|
import { spec, WORKER_ONLY } from './plugin-host-method-spec'
|
|
|
|
/** Provisional schema floor for the appearance capability; not a stock-release claim. */
|
|
export const PLUGIN_APPEARANCE_SINCE = '1.4.249'
|
|
const revision = z.string().regex(/^[a-f0-9]{64}$/)
|
|
const artifact = z
|
|
.string()
|
|
.min(1)
|
|
.max(16 * 1024)
|
|
|
|
/** Conditional-update params: the read revision must still be current at apply time. */
|
|
export const pluginAppearanceApplyParams = z.strictObject({
|
|
expectedRevision: revision,
|
|
app: artifact,
|
|
terminal: artifact
|
|
})
|
|
|
|
/** Worker-only appearance methods; spread into the host API table. */
|
|
export const PLUGIN_APPEARANCE_API = {
|
|
'appearance.read': spec({
|
|
summary: 'Reads the current desktop appearance revision for a conditional update.',
|
|
since: 4,
|
|
scope: 'desktop',
|
|
capability: 'appearance:write',
|
|
mutation: false,
|
|
surfaces: WORKER_ONLY,
|
|
params: z.strictObject({}).optional(),
|
|
result: z.strictObject({ revision })
|
|
}),
|
|
'appearance.apply': spec({
|
|
summary:
|
|
'Publishes owned app/editor and terminal colors and selects them in the desktop. Returns publication, not renderer acknowledgement.',
|
|
since: 4,
|
|
scope: 'desktop',
|
|
capability: 'appearance:write',
|
|
mutation: true,
|
|
surfaces: WORKER_ONLY,
|
|
params: pluginAppearanceApplyParams,
|
|
result: z.strictObject({
|
|
revision,
|
|
themeId: z.templateLiteral(['plugin:', z.string()]),
|
|
mode: z.enum(['dark', 'light']),
|
|
delivery: z.literal('published')
|
|
})
|
|
})
|
|
}
|