@byteplus/amk-editor 0.0.0-beta.1

package/dist/export-modal.d.ts

@@ -0,0 +1,63 @@
+import type { ExportVideoParams } from './types';
+import type { AmkI18nInstance } from './i18n';
+export interface CreateExportModalOptions {
+    container: HTMLElement;
+    videoName: string;
+    /** 每次打开弹窗时读取最新的默认视频名称。 */
+    getVideoName?: () => string;
+    onConfirm: (params: ExportVideoParams) => Promise<void> | void;
+    t?: AmkI18nInstance['t'];
+    /** 是否展示「视频画质增强」。默认不展示。 */
+    showQualityEnhancement?: boolean;
+}
+export interface ExportModalController {
+    open: () => void;
+    close: () => void;
+    destroy: () => void;
+    /**
+     * Opens the modal and waits for the user to confirm or cancel.
+     * Confirmed results are returned to the caller and do not invoke `onConfirm`
+     * (callers such as Agent tools own the submit path). Header `open()` still
+     * uses `onConfirm` for the direct-export path.
+     */
+    request: () => Promise<ExportModalRequestResult>;
+}
+export type ExportModalRequestResult = {
+    status: 'confirmed';
+    params: ExportVideoParams;
+} | {
+    status: 'cancel';
+};
+type SelectOption<T extends string> = {
+    label: string;
+    value: T;
+};
+/** @deprecated 使用 AMK_I18N_KEYS.export.qualityTooltip + t() */
+export declare const QUALITY_TOOLTIP = "AI MediaKit \u753B\u8D28\u589E\u5F3A\u96C6\u6210\u667A\u80FD\u8D85\u5206\u3001\u63D2\u5E27\u3001\u753B\u9762\u589E\u5F3A\u3001\u81EA\u9002\u5E94\u9510\u5316\u3001\u8272\u5F69\u589E\u5F3A\u7B49 30+ \u9AD8\u8D28\u91CF\u7B97\u6CD5\uFF0C\u7ED3\u5408\u81EA\u7814\u89C6\u9891\u5185\u5BB9\u7406\u89E3\u4E0E\u667A\u80FD\u8C03\u5EA6\uFF0C\u6309\u573A\u666F\u81EA\u52A8\u62E9\u4F18\u8C03\u7528\uFF0C\u5168\u9762\u63D0\u5347\u89C6\u9891\u753B\u8D28\u3002";
+export declare function getBaseResolutions(t: AmkI18nInstance['t']): SelectOption<ExportVideoParams['resolution']>[];
+/** 画质增强开启后的分辨率：不含原画；大模型版不含 4K */
+export declare function getEnhancedResolutions(_t: AmkI18nInstance['t'], enhancementVersion?: ExportVideoParams['enhancementVersion']): SelectOption<ExportVideoParams['resolution']>[];
+/** 当前模式下合法分辨率；非法时回落到默认项 */
+export declare function normalizeExportResolution(params: Pick<ExportVideoParams, 'qualityEnhancement' | 'enhancementVersion' | 'resolution'>, t?: AmkI18nInstance['t']): ExportVideoParams['resolution'];
+export declare function getEnhancementVersions(t: AmkI18nInstance['t']): SelectOption<ExportVideoParams['enhancementVersion']>[];
+export declare const BASE_FORMATS: SelectOption<ExportVideoParams['format']>[];
+export declare const BASE_CODECS: SelectOption<ExportVideoParams['codec']>[];
+export declare const AUDIO_CODECS: SelectOption<ExportVideoParams['codec']>[];
+/** 按导出格式返回编码下拉选项；画质增强开启时仅保留 H264。 */
+export declare function getCodecOptions(format: ExportVideoParams['format'], enhanced: boolean): SelectOption<ExportVideoParams['codec']>[];
+/** 保证 codec 与 format 一致：MP3 固定 mp3，MP4 回落到合法视频编码。 */
+export declare function normalizeExportCodec(params: Pick<ExportVideoParams, 'format' | 'codec'>): ExportVideoParams['codec'];
+export declare function applyExportFormatChange(current: ExportVideoParams, format: ExportVideoParams['format']): ExportVideoParams;
+/** 兼容旧测试/调用方：中文默认标签 */
+export declare const BASE_RESOLUTIONS: SelectOption<"original" | "720p" | "1080p" | "2k" | "4k">[];
+export declare const ENHANCED_RESOLUTIONS: SelectOption<"original" | "720p" | "1080p" | "2k" | "4k">[];
+export declare const ENHANCEMENT_VERSIONS: SelectOption<"standard" | "professional" | "large-model">[];
+export declare function createDefaultExportVideoParams(videoName: string): ExportVideoParams;
+/** 导出帧率合法区间（含端点） */
+export declare const EXPORT_FRAME_RATE_MIN = 15;
+export declare const EXPORT_FRAME_RATE_MAX = 120;
+/** 将导出帧率钳制到 15～120；非法输入回落 24 */
+export declare function normalizeExportFrameRate(frameRate: unknown): number;
+export declare function toggleQualityEnhancement(params: ExportVideoParams, enabled: boolean): ExportVideoParams;
+export declare function createExportModal(options: CreateExportModalOptions): ExportModalController;
+export {};

package/dist/export-project-adapter.d.ts

@@ -0,0 +1,14 @@
+import type { ExportVideoParams } from './types';
+/**
+ * 开启画质增强时，把增强任务参数交给代理层（callback_args，JSON 字符串）。
+ * - large-model → POST .../tools/enhance-video-generative
+ * - standard / professional → POST .../tools/enhance-video，带 tool_version
+ * video_url 由代理在导出完成后再填；关闭增强时返回 undefined。
+ */
+export declare function buildExportCallbackArgs(params: Pick<ExportVideoParams, 'qualityEnhancement' | 'keepOriginal' | 'enhancementVersion' | 'resolution' | 'frameRate'>): string | undefined;
+/**
+ * 临时导出兜底：
+ * 根据目标分辨率短边等比缩放 Canvas、Track 元素和 Extra。
+ * 只返回导出副本，不修改编辑器内部工程；服务端支持后可整文件删除。
+ */
+export declare function adaptEditParamForExport(editParam: Record<string, unknown>, params: Pick<ExportVideoParams, 'resolution' | 'format' | 'frameRate' | 'codec'>): Record<string, unknown>;

package/dist/export-task-polling.d.ts

@@ -0,0 +1,15 @@
+import { type TaskPollingController } from './task-polling';
+export declare const EXPORT_TASK_POLL_INTERVAL_MS = 5000;
+export declare const EXPORT_TASK_VISIBLE_WINDOW_MS: number;
+export type ExportTaskPollingStatus = 'polling' | 'success' | 'failed';
+export declare function resolveExportTaskPollingStatus(payload: unknown): ExportTaskPollingStatus;
+export declare function resolveExportTaskProgress(payload: unknown): number | undefined;
+export declare function resolveExportTaskOutputUrl(payload: unknown): string | undefined;
+/** 服务端仍查最新 10 条，前端只展示提交时间位于最近 24 小时内的任务。 */
+export declare function filterRecentExportTasks<T extends Record<string, unknown>>(items: T[], now?: number): T[];
+export declare function startExportTaskPolling(options: {
+    taskId: string;
+    getTask: (taskId: string) => Promise<unknown>;
+    onStatusChange: (status: ExportTaskPollingStatus, payload?: unknown) => void | Promise<void>;
+    onError?: (error: unknown) => void | Promise<void>;
+}): TaskPollingController;

package/dist/header.d.ts

@@ -0,0 +1,57 @@
+import type { AmkI18nInstance } from './i18n';
+export interface ResolveHeaderTitleOptions {
+    /** initialData.projectName / getProject.projectName */
+    projectName?: string;
+    t?: AmkI18nInstance['t'];
+}
+export interface CreateAmkEditorLayoutOptions {
+    container: HTMLElement;
+    title: string;
+    theme?: 'light' | 'dark';
+    showHeader: boolean;
+    /** 是否展示项目初始化 loading，默认展示。 */
+    showProjectLoading?: boolean;
+    /** 是否展示导出任务列表入口，默认开启。 */
+    showExportTaskList?: boolean;
+    /** When set, append the header here instead of inside the editor root. */
+    headerMount?: HTMLElement;
+    onExport: () => void;
+    /** 导出任务列表每次从关闭变为展开时触发。 */
+    onExportTasksOpen?: () => void | Promise<void>;
+    /** 传入则展示返回按钮 */
+    onBack?: () => void;
+    /** 传入则展示关闭按钮 */
+    onClose?: () => void;
+    onTitleSubmit?: (title: string) => void | Promise<void>;
+    i18n?: AmkI18nInstance;
+}
+export type AmkSaveStatus = 'saving' | 'saved';
+export type AmkExportTaskStatus = 'idle' | 'polling' | 'success' | 'failed';
+export type AmkExportTaskListItem = {
+    taskId: string;
+    name: string;
+    format: 'mp4' | 'mp3';
+    status: Exclude<AmkExportTaskStatus, 'idle'>;
+    /** 任务提交时间；历史任务来自任务列表接口的 submitted_at。 */
+    submittedAt?: string;
+    /** 服务端返回的任务进度（0-100）；没有进度时使用不定长动画。 */
+    progress?: number;
+    /** 是否已在当前页面触发过浏览器下载。 */
+    downloaded?: boolean;
+    outputUrl?: string;
+};
+export interface AmkEditorLayout {
+    root: HTMLDivElement;
+    workspace: HTMLDivElement;
+    setTitle: (title: string) => void;
+    setSaveStatus: (status: AmkSaveStatus) => void;
+    setExportTasks: (tasks: AmkExportTaskListItem[]) => void;
+    updateExportTask: (task: AmkExportTaskListItem) => void;
+    setExportTasksLoading: (loading: boolean) => void;
+    openExportTasks: () => void;
+    setProjectLoading: (loading: boolean) => void;
+    destroy: () => void;
+}
+export declare function resolveHeaderTitle(options: ResolveHeaderTitleOptions): string;
+export declare function validateHeaderTitle(title: string, t?: AmkI18nInstance['t']): string | undefined;
+export declare function createAmkEditorLayout(options: CreateAmkEditorLayoutOptions): AmkEditorLayout;

package/dist/i18n/index.d.ts

@@ -0,0 +1,17 @@
+export type Locale = string;
+export type Messages = Record<string, string>;
+export type LocaleMessages = Record<Locale, Messages>;
+export interface AmkI18nOptions {
+    locale?: Locale;
+    messages?: LocaleMessages;
+    messageOverrides?: Messages;
+}
+export interface AmkI18nInstance {
+    t: (key: string, params?: Record<string, any>, fallback?: string) => string;
+    getLocale: () => Locale;
+}
+export declare function createAmkI18n(options?: AmkI18nOptions): AmkI18nInstance;
+export declare function setGlobalAmkI18n(i18n: AmkI18nInstance): void;
+export declare function getGlobalAmkI18n(): AmkI18nInstance | null;
+export declare function tAmk(key: string, params?: Record<string, any>, fallback?: string): string;
+export { AMK_I18N_KEYS } from './keys';

package/dist/i18n/keys.d.ts

@@ -0,0 +1,107 @@
+export declare const AMK_I18N_KEYS: {
+    readonly common: {
+        readonly close: "amk.common.close";
+        readonly cancel: "amk.common.cancel";
+        readonly confirm: "amk.common.confirm";
+        readonly projectLoading: "amk.common.projectLoading";
+        readonly uploading: "amk.common.uploading";
+        readonly uploadFailed: "amk.common.uploadFailed";
+    };
+    readonly header: {
+        readonly defaultTitle: "amk.header.defaultTitle";
+        readonly back: "amk.header.back";
+        readonly editTitle: "amk.header.editTitle";
+        readonly clearTitle: "amk.header.clearTitle";
+        readonly confirmTitle: "amk.header.confirmTitle";
+        readonly cancelEditTitle: "amk.header.cancelEditTitle";
+        readonly saving: "amk.header.saving";
+        readonly saved: "amk.header.saved";
+        readonly exportVideo: "amk.header.exportVideo";
+        readonly exportTasks: "amk.header.exportTasks";
+        readonly exportTaskTooltip: "amk.header.exportTaskTooltip";
+        readonly exportTaskRetention: "amk.header.exportTaskRetention";
+        readonly exportTaskPolling: "amk.header.exportTaskPolling";
+        readonly exportTaskSuccess: "amk.header.exportTaskSuccess";
+        readonly exportTaskFailed: "amk.header.exportTaskFailed";
+        readonly exportMessageLoading: "amk.header.exportMessageLoading";
+        readonly exportMessageSuccess: "amk.header.exportMessageSuccess";
+        readonly exportMessageView: "amk.header.exportMessageView";
+        readonly exportTaskEmpty: "amk.header.exportTaskEmpty";
+        readonly exportTaskEmptyDescription: "amk.header.exportTaskEmptyDescription";
+        readonly exportTaskLoading: "amk.header.exportTaskLoading";
+        readonly exportTaskDownloadReady: "amk.header.exportTaskDownloadReady";
+        readonly exportTaskUrlUnavailable: "amk.header.exportTaskUrlUnavailable";
+        readonly exportTaskDownload: "amk.header.exportTaskDownload";
+        readonly exportTaskDownloadAgain: "amk.header.exportTaskDownloadAgain";
+        readonly exportTaskDownloading: "amk.header.exportTaskDownloading";
+        readonly exportTaskDownloadFailed: "amk.header.exportTaskDownloadFailed";
+        readonly exportTaskDownloadCorsHint: "amk.header.exportTaskDownloadCorsHint";
+        readonly exportTaskView: "amk.header.exportTaskView";
+        readonly exportTaskVideo: "amk.header.exportTaskVideo";
+        readonly exportTaskAudio: "amk.header.exportTaskAudio";
+        readonly titleRuleEmpty: "amk.header.titleRuleEmpty";
+        readonly titleRuleMaxLength: "amk.header.titleRuleMaxLength";
+        readonly titleRuleCharset: "amk.header.titleRuleCharset";
+    };
+    readonly import: {
+        readonly local: "amk.import.local";
+        readonly url: "amk.import.url";
+        readonly system: "amk.import.system";
+        readonly action: "amk.import.action";
+    };
+    readonly localUpload: {
+        readonly title: "amk.localUpload.title";
+        readonly dropHint: "amk.localUpload.dropHint";
+        readonly dropSubHint: "amk.localUpload.dropSubHint";
+        readonly columnName: "amk.localUpload.columnName";
+        readonly columnType: "amk.localUpload.columnType";
+        readonly columnFormat: "amk.localUpload.columnFormat";
+        readonly columnSize: "amk.localUpload.columnSize";
+        readonly typeVideo: "amk.localUpload.typeVideo";
+        readonly typeAudio: "amk.localUpload.typeAudio";
+        readonly typeImage: "amk.localUpload.typeImage";
+        readonly typeOther: "amk.localUpload.typeOther";
+        readonly emptyFiles: "amk.localUpload.emptyFiles";
+        readonly uploadSuccess: "amk.localUpload.uploadSuccess";
+        readonly emptyResult: "amk.localUpload.emptyResult";
+        readonly partialFailed: "amk.localUpload.partialFailed";
+    };
+    readonly urlUpload: {
+        readonly title: "amk.urlUpload.title";
+        readonly hint: "amk.urlUpload.hint";
+        readonly placeholder: "amk.urlUpload.placeholder";
+        readonly submit: "amk.urlUpload.submit";
+        readonly emptyUrls: "amk.urlUpload.emptyUrls";
+        readonly tooManyUrls: "amk.urlUpload.tooManyUrls";
+        readonly invalidUrl: "amk.urlUpload.invalidUrl";
+    };
+    readonly asr: {
+        readonly tooltipLine1: "amk.asr.tooltipLine1";
+        readonly processing: "amk.asr.processing";
+    };
+    readonly emptyTrackSave: {
+        readonly title: "amk.emptyTrackSave.title";
+        readonly desc: "amk.emptyTrackSave.desc";
+    };
+    readonly export: {
+        readonly title: "amk.export.title";
+        readonly videoName: "amk.export.videoName";
+        readonly qualityEnhancement: "amk.export.qualityEnhancement";
+        readonly qualityTooltip: "amk.export.qualityTooltip";
+        readonly aiEnhanceTag: "amk.export.aiEnhanceTag";
+        readonly billingHintPrefix: "amk.export.billingHintPrefix";
+        readonly billingRules: "amk.export.billingRules";
+        readonly keepOriginal: "amk.export.keepOriginal";
+        readonly enhancementVersion: "amk.export.enhancementVersion";
+        readonly resolution: "amk.export.resolution";
+        readonly enhancedResolution: "amk.export.enhancedResolution";
+        readonly frameRate: "amk.export.frameRate";
+        readonly enhancedFrameRate: "amk.export.enhancedFrameRate";
+        readonly format: "amk.export.format";
+        readonly codec: "amk.export.codec";
+        readonly resolutionOriginal: "amk.export.resolutionOriginal";
+        readonly enhancementStandard: "amk.export.enhancementStandard";
+        readonly enhancementProfessional: "amk.export.enhancementProfessional";
+        readonly enhancementLargeModel: "amk.export.enhancementLargeModel";
+    };
+};

package/dist/i18n/locales/en-US.d.ts

@@ -0,0 +1,2 @@
+declare const enUSMessages: Record<string, string>;
+export default enUSMessages;

package/dist/i18n/locales/zh-CN.d.ts

@@ -0,0 +1,2 @@
+declare const zhCNMessages: Record<string, string>;
+export default zhCNMessages;

package/dist/import-actions-dropdown-view.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+export interface ImportDropdownAction {
+    key: string;
+    label: string;
+    onSelect: () => void;
+}
+export interface ImportActionsDropdownViewProps {
+    actions: ImportDropdownAction[];
+    label: string;
+}
+/**
+ * “导入”是固定的操作入口，而非表单选择值：菜单项点击后只触发对应回调。
+ * selection="none" 同时确保组件不会维护选中态或展示勾选图标。
+ */
+export declare function ImportActionsDropdownView({ actions, label, }: ImportActionsDropdownViewProps): React.ReactElement;

package/dist/import-actions.d.ts

@@ -0,0 +1,29 @@
+import { type UploadQueue } from './upload-queue';
+import type { AmkMaterialImportType, AmkMaterialImportRequestOptions, MaterialItem, SystemMaterialItem } from './types';
+import type { AmkI18nInstance } from './i18n';
+interface MountImportActionsOptions {
+    uploadQueue?: UploadQueue;
+    /** AMKEditor 自己的浮层容器；按钮仍挂在 VeVeditor 提供的工具栏插槽中。 */
+    modalContainer: HTMLElement;
+    uploadAccept?: string;
+    onUploadStatusChange?: (uploading: boolean) => void;
+    onUploadFile?: (file: File) => Promise<MaterialItem> | MaterialItem;
+    onUploadMaterial?: (files: File[]) => Promise<MaterialItem[]> | MaterialItem[];
+    onUploadUrlMaterial?: (urls: string[]) => Promise<MaterialItem[]> | MaterialItem[];
+    onUploadFromSystem?: () => Promise<SystemMaterialItem[] | undefined | null> | SystemMaterialItem[] | undefined | null;
+    onMaterialsImported: (materials: Array<MaterialItem | SystemMaterialItem>) => MaterialItem[] | Promise<MaterialItem[]>;
+    t?: AmkI18nInstance['t'];
+}
+export declare function resolveImportErrorMessage(error: unknown, fallback: string): string;
+/**
+ * 素材面板按钮与外部入口共用的控制器。保留可调用的 cleanup 形态，兼容已有
+ * `renderImportActions` 挂载协议；外部入口通过 trigger 复用完全相同的导入链路。
+ */
+export type ImportActionsController = (() => void) & {
+    hasAction: (type: AmkMaterialImportType) => boolean;
+    trigger: (type: AmkMaterialImportType, options?: AmkMaterialImportRequestOptions) => boolean;
+    destroy: () => void;
+};
+/** AMK 独立拥有素材导入 UI 与业务回调，VeVeditor 仅提供挂载容器和标准数据写入 API。 */
+export declare function mountImportActions(container: HTMLElement, options: MountImportActionsOptions): ImportActionsController;
+export {};

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export declare const version: string;
+export type { AmkAsrProvider } from './asr-provider';
+export { AmkEditor, createAmkEditor } from './amk-editor';
+export { AmkApiClient, createAmkApiClient } from './api/client';
+export type { AmkApiClientOptions, AmkInvokeToolParams } from './api/client';
+export type { PresetLibrary, PresetLibraryItem, PresetLibraryResourceKey, } from './api/preset-library';
+export { AMK_I18N_KEYS, createAmkI18n, tAmk, getGlobalAmkI18n, setGlobalAmkI18n, } from './i18n';
+export type { AmkI18nInstance, AmkI18nOptions, Locale, LocaleMessages, Messages, } from './i18n';
+export type { AmkEditorOptions, AmkEditorStorageConfig, AmkEditorUploadSTSCredentials, AmkEditorVodPlayInfo, AmkEditorVodUploadToken, AmkEditorConfig, AmkEditorDecodeOptions, AmkEditorExportConfig, AmkEditorGetHeaders, AmkEditorHeaderConfig, AmkEditorHeaderTitleUpdateSuccess, AmkEditorInternalConfig, AmkMaterialImportType, AmkMaterialImportRequestOptions, AmkExportRequestResult, AmkExportTaskCreatedEvent, AmkProjectSnapshot, AmkProjectInfo, ExportVideoParams, MaterialConfig, MaterialItem, PersistExtractUrlsResult, RecommendedExtractStorageFields, SystemMaterialItem, Theme, VeVeditorInstance, } from './types';