From 13c898c1493853d9e4c9b151f7d5bb9362af2e6c Mon Sep 17 00:00:00 2001 From: Harvey Zhao Date: Sat, 12 Sep 2026 02:58:44 +0800 Subject: [PATCH] refactor(audio): [PKG-AUDIO-04] migrate strict source and compatible type entries --- .../ts/artplayer-plugin-audio-track.d.ts | 84 +- .../artplayer-plugin-audio-track/.npmignore | 3 +- .../ARCHITECTURE.md | 40 +- .../artplayer-plugin-audio-track/README.md | 35 +- .../artplayer-plugin-audio-track/package.json | 44 +- .../src/{index.js => index.ts} | 18 +- .../src/{track.js => track.ts} | 12 +- .../tsconfig.json | 5 + .../types/artplayer-plugin-audio-track.d.cts | 14 + .../types/artplayer-plugin-audio-track.d.mts | 2 + .../types/artplayer-plugin-audio-track.d.ts | 19 +- .../types/runtime/index.d.cts | 14 + .../types/runtime/index.d.mts | 2 + .../types/runtime/index.d.ts | 5 + refactor/audio-validation.md | 12 + .../baselines/audio-types-validation.json | 18330 ++++++++++++++++ .../changes/2026-09-12-PKG-AUDIO-04-types.md | 66 + refactor/decisions.md | 1 + refactor/plan.md | 5 +- refactor/progress.md | 17 + refactor/risk-table.md | 2 +- refactor/risks.json | 12 +- refactor/scripts/audio-types.test.mjs | 76 + refactor/tasks.json | 7 +- refactor/typechecking.md | 6 + scripts/build-ts.js | 5 +- scripts/typecheck.mjs | 2 +- test/browser/audio-editor-types.spec.js | 77 + test/browser/audio-track.spec.js | 28 +- test/types/audio-track-source.ts | 7 + test/types/audio-track.ts | 63 + 31 files changed, 18923 insertions(+), 90 deletions(-) rename packages/artplayer-plugin-audio-track/src/{index.js => index.ts} (72%) rename packages/artplayer-plugin-audio-track/src/{track.js => track.ts} (81%) create mode 100644 packages/artplayer-plugin-audio-track/tsconfig.json create mode 100644 packages/artplayer-plugin-audio-track/types/artplayer-plugin-audio-track.d.cts create mode 100644 packages/artplayer-plugin-audio-track/types/artplayer-plugin-audio-track.d.mts create mode 100644 packages/artplayer-plugin-audio-track/types/runtime/index.d.cts create mode 100644 packages/artplayer-plugin-audio-track/types/runtime/index.d.mts create mode 100644 packages/artplayer-plugin-audio-track/types/runtime/index.d.ts create mode 100644 refactor/baselines/audio-types-validation.json create mode 100644 refactor/changes/2026-09-12-PKG-AUDIO-04-types.md create mode 100644 refactor/scripts/audio-types.test.mjs create mode 100644 test/browser/audio-editor-types.spec.js create mode 100644 test/types/audio-track-source.ts create mode 100644 test/types/audio-track.ts diff --git a/docs/assets/ts/artplayer-plugin-audio-track.d.ts b/docs/assets/ts/artplayer-plugin-audio-track.d.ts index 6d2dd469b..cbbad7d15 100644 --- a/docs/assets/ts/artplayer-plugin-audio-track.d.ts +++ b/docs/assets/ts/artplayer-plugin-audio-track.d.ts @@ -1,40 +1,52 @@ -interface Option { - /** - * Audio track URL - */ - url: string - - /** - * Time offset in seconds between video and audio - * Positive value means audio plays ahead of video - * Negative value means audio plays behind video - * @default 0 - */ - offset?: number - - /** - * Synchronization threshold in seconds - * @default 0.3 - */ - sync?: number +// Generated from the package public declaration by yarn build:ts. Do not edit. +/* eslint-disable ts/no-redeclare -- Callable and public type namespace intentionally merge. */ +declare namespace artplayerPluginAudioTrackDefinitions { + export interface Option { + /** + * Audio track URL + */ + url: string + /** + * Time offset in seconds between video and audio + * Positive value means audio plays ahead of video + * Negative value means audio plays behind video + * @default 0 + */ + offset?: number + /** + * Synchronization threshold in seconds + * @default 0.3 + */ + sync?: number + } + export type UpdateOption = Partial