@delta-comic/model 2.2.0 → 3.0.0-next.5

package/dist/index.d.mts

@@ -0,0 +1,546 @@
+import { Component } from "vue";
+
+//#region lib/struct/store.d.ts
+/**
+ * 比如有很多需要注明来自哪个插件的值都可以用
+ */
+declare class SourcedValue<T extends [string, string]> {
+  separator: string;
+  toJSON(value: T | string): T;
+  parse(value: string): T;
+  toString(value: T | string): string;
+  stringify(value: T): string;
+  constructor(separator?: string);
+}
+/**
+ * 相比较于普通的Map，这个元素的key操作可以是`TKey | string`
+ * _但内部保存仍使用`SourcedValue.key.toString`作为key_
+ */
+declare class SourcedKeyMap<TKey extends [string, string], TValue> implements Map<string, TValue> {
+  getOrInsert(key: string | TKey, value: TValue): TValue;
+  getOrInsertComputed(key: string | TKey, compute: (key: string) => TValue): TValue;
+  static createReactive<TKey extends [string, string], TValue>(separator?: string): import("vue").ShallowReactive<SourcedKeyMap<TKey, TValue>>;
+  constructor(separator?: string);
+  key: SourcedValue<TKey>;
+  private store;
+  get size(): number;
+  [Symbol.toStringTag]: string;
+  clear(): void;
+  delete(key: string | TKey): boolean;
+  forEach(callbackfn: (value: TValue, key: string, map: Map<string, TValue>) => void, thisArg?: any): void;
+  get(key: string | TKey): TValue | undefined;
+  has(key: string | TKey): boolean;
+  set(key: string | TKey, value: TValue): this;
+  entries(): MapIterator<[string, TValue]>;
+  keys(): MapIterator<string>;
+  values(): MapIterator<TValue>;
+  [Symbol.iterator](): MapIterator<[string, TValue]>;
+}
+type SourcedKeyType<T extends SourcedKeyMap<[string, string], any> | SourcedValue<[string, string]>> = T extends SourcedKeyMap<infer K, any> ? K | string : T extends SourcedValue<infer K> ? K | string : never;
+//#endregion
+//#region lib/struct/struct.d.ts
+/**
+ * 可以结构化的数据，调用`toJSON`获取纯粹的json(没有get/set或method)
+ */
+declare class Struct<TRaw extends object> {
+  protected $$raw: TRaw;
+  toJSON(): TRaw;
+  /**
+   * @param $$raw 一个纯粹json对象，不可以是高级对象
+   */
+  constructor($$raw: TRaw);
+  static toRaw<T extends object, TRaw = (T extends Struct<infer TR> ? TR : T)>(item: T): TRaw;
+}
+//#endregion
+//#region lib/struct/meta.d.ts
+interface Metadatable {
+  $$meta?: Metadata;
+  $$plugin: string;
+}
+type Metadata = Record<string | number, any>;
+type PageKey = string | number;
+declare class StreamQuery<TResult, TData extends object = {}> {
+  query: (data: TData, page: PageKey, signal?: AbortSignal) => Promise<{
+    data: TResult[];
+    lastPage?: PageKey;
+    nextPage?: PageKey;
+  }>;
+  initPage: PageKey;
+  constructor(query: (data: TData, page: PageKey, signal?: AbortSignal) => Promise<{
+    data: TResult[];
+    lastPage?: PageKey;
+    nextPage?: PageKey;
+  }>, initPage: PageKey);
+}
+//#endregion
+//#region lib/struct/from.d.ts
+interface Base {
+  info: string;
+  placeholder?: string;
+  /**
+   * @default true
+   */
+  required?: boolean;
+}
+interface FormString extends Base {
+  type: 'string';
+  patten?: RegExp;
+  defaultValue?: FormDefaultValue['string'];
+}
+interface FormNumber extends Base {
+  type: 'number';
+  range?: [number, number];
+  float?: boolean;
+  defaultValue?: FormDefaultValue['number'];
+}
+interface FormRadio extends Base {
+  type: 'radio';
+  selects: {
+    label: string;
+    value: string;
+  }[];
+  comp: 'radio' | 'select';
+  defaultValue?: FormDefaultValue['radio'];
+}
+interface FormCheckbox extends Base {
+  type: 'checkbox';
+  selects: {
+    label: string;
+    value: string;
+  }[];
+  comp: 'checkbox' | 'multipleSelect';
+  defaultValue?: FormDefaultValue['checkbox'];
+}
+interface FormSwitch extends Base {
+  type: 'switch';
+  close?: string;
+  open?: string;
+  defaultValue?: FormDefaultValue['switch'];
+}
+interface FormDate extends Base {
+  type: 'date';
+  format: string;
+  time?: boolean;
+  defaultValue?: FormDefaultValue['date'];
+}
+interface FormDateRange extends Base {
+  type: 'dateRange';
+  format: string;
+  time?: boolean;
+  defaultValue?: FormDefaultValue['dateRange'];
+}
+interface FormPairs extends Base {
+  type: 'pairs';
+  defaultValue?: FormDefaultValue['pairs'];
+  noMultiple?: boolean;
+}
+interface FormDefaultValue {
+  string: string;
+  number: number;
+  radio: string;
+  checkbox: string[];
+  switch: boolean;
+  date: string;
+  pairs: {
+    key: string;
+    value: string;
+  }[];
+  dateRange: [Form: FormDefaultValue['date'], to: FormDefaultValue['date']];
+}
+type FormSingleConfigure = FormString | FormNumber | FormRadio | FormCheckbox | FormSwitch | FormDate | FormDateRange | FormPairs;
+type FormSingleResult<T extends FormSingleConfigure> = FormDefaultValue[T['type']];
+type FormConfigure = { [x in string]: FormSingleConfigure };
+type FormResult<T extends FormConfigure> = { [K in keyof T]: FormSingleResult<T[K]> };
+//#endregion
+//#region lib/model/download.d.ts
+type UniDownloadChecksumAlgorithm = 'sha256' | 'md5';
+interface UniDownloadChecksum {
+  algorithm: UniDownloadChecksumAlgorithm;
+  value: string;
+}
+/** A JSON-safe HTTP header value. Sensitive values should be passed by reference. */
+type UniDownloadHttpHeaderValue = {
+  type: 'value';
+  value: string;
+} | {
+  type: 'secretRef';
+  secretRef: string;
+};
+interface UniDownloadHttpMirror {
+  url: string;
+  /** Larger values are tried first. Mirrors with the same priority keep their declared order. */
+  priority?: number;
+  headers?: Record<string, UniDownloadHttpHeaderValue>;
+}
+interface UniDownloadHttpSource {
+  type: 'http';
+  mirrors: UniDownloadHttpMirror[];
+  etag?: string;
+  lastModified?: string;
+  expectedSize?: number;
+  /** Unix timestamp in milliseconds after which the source should be refreshed. */
+  expiresAt?: number;
+}
+type UniDownloadTorrentInput = {
+  type: 'magnet';
+  uri: string;
+} | {
+  type: 'url';
+  url: string;
+} | {
+  type: 'bytes';
+  base64: string;
+};
+type UniDownloadTorrentSeedPolicy = {
+  mode: 'none';
+} | {
+  mode: 'ratio';
+  ratio: number;
+} | {
+  mode: 'duration';
+  durationSeconds: number;
+} | {
+  mode: 'ratioOrDuration';
+  ratio: number;
+  durationSeconds: number;
+};
+interface UniDownloadTorrentSource {
+  type: 'torrent';
+  input: UniDownloadTorrentInput;
+  /** Zero-based file indexes in torrent metadata. Omit to download every file. */
+  onlyFiles?: number[];
+  seedPolicy?: UniDownloadTorrentSeedPolicy;
+}
+type UniDownloadSource = UniDownloadHttpSource | UniDownloadTorrentSource;
+/** A JSON-serializable file entry produced by a content plugin. */
+interface UniDownloadAsset {
+  /** Stable within the containing plan and across retries. */
+  key: string;
+  /** Relative to the destination selected by the host application. */
+  relativePath: string;
+  size?: number;
+  checksum?: UniDownloadChecksum;
+  source: UniDownloadSource;
+}
+/** A JSON-serializable group of files that should be enqueued together. */
+interface UniDownloadPlan {
+  /** Stable for the content represented by this plan. */
+  key: string;
+  title: string;
+  assets: UniDownloadAsset[];
+}
+type UniContentDownloadSelection = {
+  type: 'currentEpisode';
+} | {
+  type: 'episodes';
+  episodeIds: string[];
+} | {
+  type: 'allEpisodes';
+};
+interface UniDownloadResolveInput {
+  page: UniContentPage;
+  selection: UniContentDownloadSelection;
+}
+type UniDownloadRefreshSourceReason = 'expired' | 'unauthorized' | 'forbidden';
+interface UniDownloadRefreshSourceInput {
+  page: UniContentPage;
+  planKey: string;
+  assetKey: string;
+  source: UniDownloadSource;
+  reason: UniDownloadRefreshSourceReason;
+}
+/**
+ * Resolves plugin-specific content into a portable download plan.
+ *
+ * Providers are runtime objects and are not serialized. Their returned plans and sources must be
+ * JSON-serializable so the native downloader can persist and resume them without a live WebView.
+ */
+interface UniContentDownloadProvider {
+  resolve(input: UniDownloadResolveInput, signal: AbortSignal): Promise<UniDownloadPlan>;
+  refreshSource?(input: UniDownloadRefreshSourceInput, signal: AbortSignal): Promise<UniDownloadSource>;
+}
+/**
+ * Legacy imperative download controller.
+ *
+ * @deprecated Register a {@link UniContentDownloadProvider} for the content type and let the native
+ * downloader own task state, persistence, and lifecycle controls. This class remains unchanged so
+ * existing plugins can migrate without an immediate breaking change.
+ */
+declare abstract class UniDownloader implements Metadatable {
+  abstract id: string;
+  abstract name: string;
+  abstract $$plugin: string;
+  abstract $$meta?: Metadata;
+  abstract begin: () => void;
+  abstract resume: () => void;
+  abstract pause: () => void;
+}
+/** @deprecated Use {@link UniContentDownloadProvider}. */
+type UniLegacyDownloader = UniDownloader;
+//#endregion
+//#region lib/model/ep.d.ts
+interface UniEpRaw extends Metadatable {
+  name: string;
+  id: string;
+}
+declare class UniEp extends Struct<UniEpRaw> implements UniEpRaw {
+  name: string;
+  id: string;
+  $$plugin: string;
+  $$meta?: Metadata;
+  constructor(v: UniEpRaw);
+}
+//#endregion
+//#region lib/model/content.d.ts
+type UniContentPageLike = new (preload: UniItem | undefined, id: string, ep: string) => UniContentPage;
+type UniContentType_ = SourcedKeyType<typeof UniContentPage.contentPages>;
+type UniContentType = Exclude<UniContentType_, string>;
+type UniContentViewComponent = Component<{
+  page: UniContentPage;
+  union?: UniItem;
+}>;
+type UniContentLayoutComponent = Component<{
+  page: UniContentPage;
+}, any, any, any, any, any, {
+  view(args: {
+    item?: UniItem;
+  }): any;
+}>;
+declare abstract class UniContentPage {
+  preload: UniItem | undefined;
+  id: string;
+  ep: string;
+  static layouts: import("vue").ShallowReactive<SourcedKeyMap<[plugin: string, name: string], UniContentLayoutComponent>>;
+  static contentPages: import("vue").ShallowReactive<SourcedKeyMap<[plugin: string, name: string], UniContentPageLike>>;
+  static downloadProviders: import("vue").ShallowReactive<SourcedKeyMap<[plugin: string, name: string], UniContentDownloadProvider>>;
+  constructor(preload: UniItem | undefined, id: string, ep: string);
+  abstract plugin: string;
+  abstract contentType: UniContentType;
+  abstract fetchShortId(signal?: AbortSignal): Promise<string>;
+  abstract fetchDetail(signal?: AbortSignal): Promise<UniItem>;
+  abstract fetchRecommends: StreamQuery<UniItem>;
+  abstract fetchComments: StreamQuery<UniComment>;
+  abstract fetchEps: StreamQuery<UniEp>;
+  abstract ViewComponent: UniContentViewComponent;
+}
+//#endregion
+//#region lib/model/resource.d.ts
+type UniResourceProcessInstance = (nowPath: string, resource: UniResource) => Promise<[path: string, exit: boolean]>;
+interface UniResourceProcessStep {
+  referenceName: string;
+  ignoreExit?: boolean;
+}
+type UniResourceProcessStep_ = UniResourceProcessStep | string;
+interface UniResourceType {
+  type: string;
+  urls: string[];
+  test: (url: string, signal: AbortSignal) => PromiseLike<void>;
+}
+interface UniResourceRaw extends Metadatable {
+  pathname: string;
+  type: string;
+  processSteps?: UniResourceProcessStep_[];
+}
+declare class UniResource extends Struct<UniResourceRaw> implements UniResourceRaw {
+  static processInstances: import("vue").ShallowReactive<SourcedKeyMap<[plugin: string, referenceName: string], UniResourceProcessInstance>>;
+  static fork: import("vue").ShallowReactive<SourcedKeyMap<[plugin: string, type: string], UniResourceType>>;
+  static precedenceFork: import("vue").ShallowReactive<SourcedKeyMap<[plugin: string, type: string], string>>;
+  static is(value: unknown): value is UniResource;
+  static create(v: UniResourceRaw): UniResource;
+  protected constructor(v: UniResourceRaw);
+  type: string;
+  pathname: string;
+  processSteps: UniResourceProcessStep[];
+  $$meta?: Metadata;
+  $$plugin: string;
+  getUrl(): Promise<string>;
+  omittedForks: import("vue").ShallowReactive<Set<string>>;
+  getThisFork(): string;
+  localChangeFork(): boolean;
+}
+//#endregion
+//#region lib/model/image.d.ts
+interface UniImageRaw extends Metadatable {
+  path: string;
+  forkNamespace: string;
+  processSteps?: UniResourceProcessStep_[];
+}
+declare class UniImage extends UniResource {
+  static is(value: unknown): value is UniImage;
+  static create(v: UniResourceRaw | UniImageRaw, aspect?: UniImageAspect): UniImage;
+  protected constructor(v: UniResourceRaw | UniImageRaw, aspect?: UniImageAspect);
+  get aspect(): Partial<UniImageAspect> | undefined;
+  set aspect(v: Partial<UniImageAspect> | undefined);
+}
+interface UniImageAspect {
+  width: number;
+  height: number;
+}
+type UniImage_ = string | UniImage;
+//#endregion
+//#region lib/model/item.d.ts
+interface UniItemCategory extends Metadatable {
+  name: string;
+  group: string;
+  search: {
+    keyword: string;
+    source: string;
+    sort: string;
+  };
+}
+interface UniItemAuthor extends Metadatable {
+  label: string;
+  icon: UniResourceRaw | UniImageRaw | string;
+  description: string;
+  /**
+   * 为空则不可订阅
+   * 否则传入的为`defineConfig`中定义的`subscribe.type`
+   */
+  subscribe?: string;
+  actions?: string[];
+}
+interface UniItemRaw extends Metadatable {
+  cover: UniResourceRaw | UniImageRaw;
+  title: string;
+  id: string;
+  /** @alias tags  */
+  categories: UniItemCategory[];
+  author: UniItemAuthor[];
+  viewNumber?: number;
+  likeNumber?: number;
+  commentNumber?: number;
+  isLiked?: boolean;
+  updateTime?: number;
+  customIsAI?: boolean;
+  contentType: UniContentType_;
+  length: string;
+  epLength: string;
+  description?: UniItemDescription;
+  thisEp: UniEpRaw;
+  commentSendable: boolean;
+  customIsSafe?: boolean;
+}
+type UniItemCardComponent = Component<{
+  item: UniItem;
+  freeHeight?: boolean;
+  disabled?: boolean;
+  type?: 'default' | 'big' | 'small';
+  class?: any;
+  style?: any;
+}, any, any, any, any, {
+  click: [];
+}, {
+  default(): void;
+  smallTopInfo(): void;
+  cover(): void;
+}>;
+type UniItemTranslator = (raw: UniItemRaw) => UniItem;
+type UniItemDescription = string | {
+  type: 'html';
+  content: string;
+} | {
+  type: 'text';
+  content: string;
+};
+declare abstract class UniItem extends Struct<UniItemRaw> implements UniItemRaw {
+  static itemTranslator: import("vue").ShallowReactive<SourcedKeyMap<[plugin: string, name: string], UniItemTranslator>>;
+  static create(raw: UniItemRaw): UniItem;
+  static authorIcon: import("vue").ShallowReactive<SourcedKeyMap<[plugin: string, name: string], Component>>;
+  static itemCards: import("vue").ShallowReactive<SourcedKeyMap<[plugin: string, name: string], UniItemCardComponent>>;
+  abstract like(): Promise<any>;
+  abstract report(): Promise<any>;
+  abstract sendComment(text: string): Promise<any>;
+  static is(value: unknown): value is UniItem;
+  cover: UniResourceRaw | UniImageRaw;
+  get $cover(): UniImage;
+  title: string;
+  id: string;
+  categories: UniItemCategory[];
+  author: UniItemAuthor[];
+  viewNumber?: number;
+  likeNumber?: number;
+  commentNumber?: number;
+  isLiked?: boolean;
+  description?: UniItemDescription;
+  updateTime?: number;
+  contentType: UniContentType;
+  length: string;
+  epLength: string;
+  $$plugin: string;
+  $$meta: Metadata | undefined;
+  thisEp: UniEpRaw;
+  customIsSafe?: boolean;
+  get $thisEp(): UniEp;
+  constructor(v: UniItemRaw);
+  commentSendable: boolean;
+  customIsAI?: boolean;
+  get $isAi(): boolean;
+}
+//#endregion
+//#region lib/model/user.d.ts
+interface UniUserRaw extends Metadatable {
+  avatar?: UniResourceRaw;
+  name: string;
+  id: string;
+}
+declare abstract class UniUser {
+  static userBase: import("vue").ShallowReactive<Map<string, UniUser>>;
+  static userEditorBase: import("vue").ShallowReactive<Map<string, Component>>;
+  static userCards: import("vue").ShallowReactive<Map<string, UniUserCardComponent>>;
+  constructor(v: UniUserRaw);
+  avatar?: UniImage;
+  name: string;
+  id: string;
+  $$plugin: string;
+  $$meta?: Metadata;
+  abstract customUser: object;
+}
+type UniUserCardComponent = Component<{
+  user: UniUser;
+  isSmall?: boolean;
+}>;
+//#endregion
+//#region lib/model/comment.d.ts
+interface UniCommentRaw extends Metadatable {
+  sender: UniUser;
+  content: {
+    type: 'string' | 'html';
+    text: string;
+  };
+  time: number;
+  id: string;
+  childrenCount: number;
+  likeCount: number;
+  isLiked: boolean;
+  reported: boolean;
+  isTop: boolean;
+}
+type UniCommentRow = Component<{
+  comment: UniComment;
+  item: UniItem;
+  parentComment?: UniComment;
+}>;
+declare abstract class UniComment extends Struct<UniCommentRaw> implements UniCommentRaw {
+  static commentRow: import("vue").ShallowReactive<SourcedKeyMap<[plugin: string, name: string], UniCommentRow>>;
+  constructor(v: UniCommentRaw);
+  abstract sender: UniUser;
+  content: {
+    type: 'string' | 'html';
+    text: string;
+  };
+  time: number;
+  id: string;
+  childrenCount: number;
+  likeCount: number;
+  isTop: boolean;
+  isLiked: boolean;
+  reported: boolean;
+  $$plugin: string;
+  $$meta?: Metadata;
+  abstract like(signal?: AbortSignal): PromiseLike<boolean>;
+  abstract report(signal?: AbortSignal): PromiseLike<any>;
+  abstract sendComment(text: string, signal?: AbortSignal): PromiseLike<any>;
+  abstract fetchChildren: StreamQuery<UniComment>;
+}
+//#endregion
+export { Base, FormCheckbox, FormConfigure, FormDate, FormDateRange, FormDefaultValue, FormNumber, FormPairs, FormRadio, FormResult, FormSingleConfigure, FormSingleResult, FormString, FormSwitch, Metadata, Metadatable, PageKey, SourcedKeyMap, SourcedKeyType, SourcedValue, StreamQuery, Struct, UniComment, UniCommentRaw, UniCommentRow, UniContentDownloadProvider, UniContentDownloadSelection, UniContentLayoutComponent, UniContentPage, UniContentPageLike, UniContentType, UniContentType_, UniContentViewComponent, UniDownloadAsset, UniDownloadChecksum, UniDownloadChecksumAlgorithm, UniDownloadHttpHeaderValue, UniDownloadHttpMirror, UniDownloadHttpSource, UniDownloadPlan, UniDownloadRefreshSourceInput, UniDownloadRefreshSourceReason, UniDownloadResolveInput, UniDownloadSource, UniDownloadTorrentInput, UniDownloadTorrentSeedPolicy, UniDownloadTorrentSource, UniDownloader, UniEp, UniEpRaw, UniImage, UniImageAspect, UniImageRaw, UniImage_, UniItem, UniItemAuthor, UniItemCardComponent, UniItemCategory, UniItemDescription, UniItemRaw, UniItemTranslator, UniLegacyDownloader, UniResource, UniResourceProcessInstance, UniResourceProcessStep, UniResourceProcessStep_, UniResourceRaw, UniResourceType, UniUser, UniUserCardComponent, UniUserRaw };