跳转到内容

前端 SDK 导出:ExtensionAppPageMetadata – HandIcon

本页由当前 SDK 声明自动生成。 导入入口:@woohaa3/frontend/extension-api。

返回接口索引

ExtensionAppPageMetadata · ExtensionAppPageQuery · ExtensionAppPageRuntime · ExtensionFrontendActivation · ExtensionFrontendConfigScope · ExtensionFrontendDescriptor · ExtensionFrontendModule · EyeIcon · EyeOffIcon · FileImageIcon · FileTextIcon · FilmIcon · FitScreenIcon · FolderPlusIcon · FrontendEventName · FrontendEventPayloads · FrontendEventSignatures · GameIcon · GenerationDirectoryProps · GenerationHistoryIcon · GenerationModelDirectory · GenerationParameterField · GenerationParameters · HandIcon

ExtensionAppPageMetadata

扩展 app/page 的纯路由元数据(可 JSON 序列化) 。

这是发布目录(/extension-releases/<id>.json 的 metadata.appPages)携带的唯一权威路由 数据:宿主 Router 在扩展实现加载之前即可按 pageId/path/旧路径/资格建立 registry。纯数据 不含可执行入口,因此与 ExtensionFrontendMetadata 一样只经部署协议传输,不来自管理数据。

export type ExtensionAppPageMetadata = {
pageId: string;
path: string;
legacyRedirectPaths?: readonly string[];
requiresAuth: boolean;
requiredActions?: readonly AccessAction[];
title?: string;
};

关联类型:AccessAction

成员说明:

  • pageId:稳定 pageId(宿主据此建立独立 page scope identity)。
  • path:静态可信路径(必须 / 开头)。
  • legacyRedirectPaths:可选旧路径受保护 redirect(如 /task-history);宿主只 replace 到 path。
  • requiresAuth:所需认证等级下限。
  • requiredActions:所需站点 action(如 tasks.inspect);服务端仍独立重查。
  • title:页面标题(诊断/导航展示)。

ExtensionAppPageQuery

规范化后的页面查询(类型化 URL 的通用载体)。

只含稳定、可分享的字段;MUST NOT 含草稿、prompt、parameters 或媒体 URL。字符串值便于 宿主 Router 做白名单转换与序列化;具体页面自行解码为领域查询。

export type ExtensionAppPageQuery = Readonly<Record<string, string>>;

ExtensionAppPageRuntime

扩展 app/page 的运行时入口(由发布目录 descriptor 在实现加载后提供) 。

纯路由元数据进发布目录;createPlugin 只会随扩展实现求值出现(loadDescriptor 返回的 descriptor)。宿主按 pageId 关联两者:Router 用元数据解析,page scope 用本入口装配。

export type ExtensionAppPageRuntime = {
pageId: string;
createPlugin: () => Plugin;
};

关联类型:Plugin

成员说明:

  • pageId:稳定 pageId(必须与 metadata.appPages 同名项一致)。
  • createPlugin:无副作用构造 page-scope plugin;宿主负责装配与 fiber 生命周期。

ExtensionFrontendActivation

入口装配策略(静态可信元数据,不可由 browser-local 偏好改写)。

export type ExtensionFrontendActivation = "always" | "server-active" | "browser-local";

ExtensionFrontendConfigScope

前端入口配置范围:

  • site:站点应用插件(服务端权威配置);
  • browser-local:纯前端可选能力,只由当前 origin 的浏览器本地选择控制。
export type ExtensionFrontendConfigScope = "site" | "browser-local";

ExtensionFrontendDescriptor

extension 前端入口描述。plugin 是无副作用工厂:只有宿主请求装配时才构造完整 Cordis plugin;extensionId 由源码导入绑定(语言级,不解析字符串),供构建期扫描判定身份。

export type ExtensionFrontendDescriptor = {
extensionId: string;
configScope?: ExtensionFrontendConfigScope;
activation?: ExtensionFrontendActivation;
required?: boolean;
label?: string;
description?: string;
appPages?: readonly (ExtensionAppPageRuntime | ExtensionAppPageMetadata)[];
plugin: () => Plugin;
settingsPlugin?: () => Plugin;
};

关联类型:ExtensionFrontendConfigScope · ExtensionFrontendActivation · ExtensionAppPageRuntime · ExtensionAppPageMetadata · Plugin

成员说明:

  • configScope:配置范围;缺省 site(站点应用插件)。browser-local 用于纯前端可选能力。
  • activation:装配策略;缺省 server-active(由服务端权威状态驱动)。
  • required:常驻入口的启动失败边界(required: true 时装配失败视为 scope 启动失败)。 仅 activation: "always"(进入 kernel 清单)时有实际意义;browser-local 入口 MUST NOT 声明 required(按 optional 处理)。
  • appPages:本扩展的 app/page 贡献。两种形态按来源区分: - 直接来自 metadata.appPages 的纯路由数据(ExtensionAppPageMetadata,无实现); - 扩展在 descriptor 里显式覆盖的运行时入口(ExtensionAppPageRuntime,带 createPlugin)。 宿主按 pageId 关联两边:Router 用纯路由解析路径,page scope 用 createPlugin 装配页面。 缺省表示本扩展不贡献独立页面。
  • plugin:无副作用构造 plugin;宿主负责在目标 scope 装配并拥有 fiber 生命周期。
  • settingsPlugin:设置专用入口。 只构造「设置面板」所需的贡献(settings.plugin-config),MUST NOT 启动生成入口、画布事件、 业务轮询或任务执行。宿主仅在用户打开设置、且该扩展未激活时按需调用,并在关闭设置时 释放该 fiber;缺少本入口的旧 artifact 只复用已存在的贡献,不回退执行完整 plugin()。 与 metadata 的 settingsPanel: boolean(声明「本扩展有设置面板」)是两件事:后者是纯数据 声明,前者是可执行的设置专用工厂。

ExtensionFrontendModule

扫描器从 源码声明*\/src/frontend/index.ts 读取的模块形状。

export type ExtensionFrontendModule = {
descriptor: ExtensionFrontendDescriptor;
};

关联类型:ExtensionFrontendDescriptor

EyeIcon

export const EyeIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

EyeOffIcon

export const EyeOffIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

FileImageIcon

export const FileImageIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

FileTextIcon

export const FileTextIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

FilmIcon

export const FilmIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

FitScreenIcon

export const FitScreenIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

FolderPlusIcon

export const FolderPlusIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

FrontendEventName

export type FrontendEventName = keyof FrontendEventPayloads;

关联类型:FrontendEventPayloads

FrontendEventPayloads

所有跨插件事件的 payload 类型(编译期事实源)。

export type FrontendEventPayloads = {
"ui.media-preview.open-requested": {
assetId: string;
nodeId: string;
title: string;
};
"ui.text-preview.open-requested": {
nodeId: string;
};
"ui.video-frame-capture.open-requested": {
nodeId: string;
};
"ui.node-history.open-requested": {
nodeId: string;
};
"ui.node-history.switch-requested": {
nodeId: string;
index?: number;
step?: number;
presentationId?: string;
entryId?: string;
operationId?: string;
};
"ui.node-download.save-requested": {
nodeId: string;
};
"task.activity.started": TaskActivityStarted;
"task.activity.updated": TaskActivityUpdated;
"task.activity.finished": TaskActivityFinished;
"extension.release.changed": ReleaseChangedPayload;
};

关联类型:TaskActivityStarted · TaskActivityUpdated · TaskActivityFinished · ReleaseChangedPayload

成员说明:

  • extension.release.changed:宿主发布目录已切换并完成热登记: 新增条目已按资格装配;升级/卸载的条目当前页面仍用旧版本,pendingReopen 供设置面提示重开画布。

FrontendEventSignatures

Cordis Events 需要函数签名;由 payload map 派生。

export type FrontendEventSignatures = {
[K in keyof FrontendEventPayloads]: (payload: FrontendEventPayloads[K]) => void;
};

关联类型:FrontendEventPayloads

成员说明:

  • extension.release.changed:宿主发布目录已切换并完成热登记: 新增条目已按资格装配;升级/卸载的条目当前页面仍用旧版本,pendingReopen 供设置面提示重开画布。

GameIcon

游戏生成。

export const GameIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

GenerationDirectoryProps

export type GenerationDirectoryProps = {
entries: readonly GenerationModelEntry[];
sources: readonly GenerationSourceEntry[];
selected: string;
open: boolean;
onOpenChange(open: boolean): void;
onSelect(entry: GenerationModelEntry): void;
onRetry?(sourceIdentity: string): void;
onManage?(): void;
recent?: readonly string[];
disabled?: boolean;
placeholder?: string;
loading?: boolean;
error?: string;
onRetryAll?(): void;
};

关联类型:GenerationModelEntry · GenerationSourceEntry

GenerationHistoryIcon

export const GenerationHistoryIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

GenerationModelDirectory

Pure controlled directory. Source browsing is deliberately not an execution selection.

export function GenerationModelDirectory(props: GenerationDirectoryProps): React.JSX.Element;

关联类型:GenerationDirectoryProps

GenerationParameterField

export interface GenerationParameterField extends PresentableParameter {
type?: "select" | "number" | "text" | "boolean" | "textarea" | "unsupported";
control?: "slider";
semantic?: PptaskParameterControl;
required?: boolean;
adaptiveValue?: string;
}

关联类型:PresentableParameter · PptaskParameterControl

成员说明:

  • schema:Original property schema, used for constraints beyond the basic control.

GenerationParameters

export function GenerationParameters({ fields, parameters, open, onOpenChange, onChange, onReset, disabled, summary: summaryOverride }: { fields: readonly GenerationParameterField[]; parameters: Record<string, unknown>; open: boolean; onOpenChange(open: boolean): void; onChange(patch: Record<string, unknown>): void; onReset?(): void; disabled?: boolean; summary?: string; }): React.JSX.Element;

关联类型:GenerationParameterField

HandIcon

export const HandIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps