refactor(core): [CORE-21] generate compatible public and editor declarations

packages/artplayer/public/option.ts

@@ -0,0 +1,331 @@
+import type Artplayer from './artplayer'
+import type { ComponentInput, ComponentOption } from './component'
+import type { CssVar } from './cssVar'
+import type { I18n } from './i18n'
+import type { Icons } from './icons'
+import type { PluginFactory } from './plugin'
+import type { Quality } from './quality'
+import type { Setting } from './setting'
+import type { Subtitle } from './subtitle'
+
+export type CustomType
+  = | 'flv'
+    | 'm3u8'
+    | 'hls'
+    | 'ts'
+    | 'mpd'
+    | 'torrent'
+    | (string & Record<never, never>)
+
+export interface Thumbnails {
+  /**
+   * The thumbnail image url
+   */
+  url: string
+
+  /**
+   * The thumbnail item number
+   */
+  number?: number
+
+  /**
+   * The thumbnail column size
+   */
+  column?: number
+
+  /**
+   * The thumbnail width
+   */
+  width?: number
+
+  /**
+   * The thumbnail height
+   */
+  height?: number
+
+  /**
+   * The thumbnail scale
+   */
+  scale?: number
+}
+
+/** Constructor input; Option retains its historical required URL/read types. */
+export interface OptionInput extends Omit<Option, 'url' | 'controls' | 'layers' | 'contextmenu'> {
+  url?: string
+  controls?: ComponentInput[]
+  layers?: ComponentInput[]
+  contextmenu?: ComponentInput[]
+}
+
+export interface Option {
+  /**
+   * The player id
+   */
+  id?: string
+
+  /**
+   * The container mounted by the player
+   */
+  container: string | HTMLDivElement
+
+  /**
+   * Video url
+   */
+  url: string
+
+  /**
+   * Video poster image url
+   */
+  poster?: string
+
+  /**
+   * Video url type
+   */
+  type?: CustomType
+
+  /**
+   * Player color theme
+   */
+  theme?: string
+
+  /**
+   * Player language
+   */
+  lang?: keyof I18n
+
+  /**
+   * Player default volume
+   */
+  volume?: number
+
+  /**
+   * Whether live broadcast mode
+   */
+  isLive?: boolean
+
+  /**
+   * Whether video muted
+   */
+  muted?: boolean
+
+  /**
+   * Whether video auto play
+   */
+  autoplay?: boolean
+
+  /**
+   * Whether player auto resize
+   */
+  autoSize?: boolean
+
+  /**
+   * Whether player auto run mini mode
+   */
+  autoMini?: boolean
+
+  /**
+   * Whether video auto loop
+   */
+  loop?: boolean
+
+  /**
+   * Whether show video flip button
+   */
+  flip?: boolean
+
+  /**
+   * Whether show video playback rate button
+   */
+  playbackRate?: boolean
+
+  /**
+   * Whether show video aspect ratio button
+   */
+  aspectRatio?: boolean
+
+  /**
+   * Whether show video screenshot button
+   */
+  screenshot?: boolean
+
+  /**
+   * Whether show video setting button
+   */
+  setting?: boolean
+
+  /**
+   * Whether to enable player hotkey
+   */
+  hotkey?: boolean
+
+  /**
+   * Whether show video pip button
+   */
+  pip?: boolean
+
+  /**
+   * Do you want to run only one player at a time
+   */
+  mutex?: boolean
+
+  /**
+   * Whether use backdrop in UI
+   */
+  backdrop?: boolean
+
+  /**
+   * Whether show video window fullscreen button
+   */
+  fullscreen?: boolean
+
+  /**
+   * Whether show video web fullscreen button
+   */
+  fullscreenWeb?: boolean
+
+  /**
+   * Whether to enable player subtitle offset
+   */
+  subtitleOffset?: boolean
+
+  /**
+   * Whether to enable player mini progress bar
+   */
+  miniProgressBar?: boolean
+
+  /**
+   * Whether use SSR function
+   */
+  useSSR?: boolean
+
+  /**
+   * Whether use playsInline in mobile
+   */
+  playsInline?: boolean
+
+  /**
+   * Whether use lock in mobile
+   */
+  lock?: boolean
+
+  /**
+   * Whether use gesture in mobile
+   */
+  gesture?: boolean
+
+  /**
+   * Whether use fast forward in mobile
+   */
+  fastForward?: boolean
+
+  /**
+   * Whether use auto playback
+   */
+  autoPlayback?: boolean
+
+  /**
+   * Whether use auto orientation in mobile
+   */
+  autoOrientation?: boolean
+
+  /**
+   * Whether use airplay
+   */
+  airplay?: boolean
+
+  /**
+   * Custom video proxy
+   */
+  proxy?: (this: Artplayer, art: Artplayer) => HTMLCanvasElement | HTMLVideoElement | undefined
+
+  /**
+   * Custom plugin list
+   */
+  plugins?: PluginFactory[]
+
+  /**
+   * Custom layer list
+   */
+  layers?: ComponentOption[]
+
+  /**
+   * Custom contextmenu list
+   */
+  contextmenu?: ComponentOption[]
+
+  /**
+   * Custom control list
+   */
+  controls?: ComponentOption[]
+
+  /**
+   * Custom setting list
+   */
+  settings?: Setting[]
+
+  /**
+   * Custom video quality list
+   */
+  quality?: Quality[]
+
+  /**
+   * Custom highlight list
+   */
+  highlight?: {
+    /**
+     * The highlight time
+     */
+    time: number
+
+    /**
+     * The highlight text
+     */
+    text: string
+  }[]
+
+  /**
+   * Custom thumbnail
+   */
+  thumbnails?: Thumbnails
+
+  /**
+   * Custom subtitle option
+   */
+  subtitle?: Subtitle
+
+  /**
+   * Other video attribute
+   */
+  moreVideoAttr?: Partial<Readonly<{
+    [K in keyof HTMLVideoElement as HTMLVideoElement[K] extends (...args: unknown[]) => unknown
+      ? never
+      : K]: HTMLVideoElement[K]
+  }>>
+
+  /**
+   * Custom i18n
+   */
+  i18n?: I18n
+
+  /**
+   * Custom default icons
+   */
+  icons?: {
+    [key in keyof Icons]?: HTMLElement | string
+  }
+
+  /**
+   * Custom css variables
+   */
+  cssVar?: Partial<CssVar>
+
+  /**
+   * Custom video type function
+   */
+  customType?: Partial<
+    Record<
+      CustomType,
+      (this: Artplayer, video: HTMLVideoElement, url: string, art: Artplayer) => unknown | Promise<unknown>
+    >
+  >
+}