@delta-comic/model 1.3.0 → 1.3.1

package/dist/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './struct';
+export * as uni from './model';

package/dist/lib/model/comment.d.ts

@@ -0,0 +1,47 @@
+import { default as dayjs } from 'dayjs';
+import { Component } from 'vue';
+import { SourcedKeyMap, Struct, Metadata, Metadatable, StreamQuery } from '../struct';
+import { Item } from './item';
+import { User } from './user';
+export interface RawComment extends Metadatable {
+    sender: User;
+    content: {
+        type: 'string' | 'html';
+        text: string;
+    };
+    time: number;
+    id: string;
+    childrenCount: number;
+    likeCount: number;
+    isLiked: boolean;
+    reported: boolean;
+    isTop: boolean;
+}
+export type CommentRow = Component<{
+    comment: Comment;
+    item: Item;
+    parentComment?: Comment;
+}>;
+export declare abstract class Comment extends Struct<RawComment> implements RawComment {
+    static commentRow: import('vue').ShallowReactive<SourcedKeyMap<[plugin: string, name: string], CommentRow>>;
+    constructor(v: RawComment);
+    abstract sender: User;
+    content: {
+        type: 'string' | 'html';
+        text: string;
+    };
+    time: number;
+    get $time(): dayjs.Dayjs;
+    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<[], Comment>;
+}

package/dist/lib/model/content.d.ts

@@ -0,0 +1,31 @@
+import { Component } from 'vue';
+import { SourcedKeyMap, StreamQuery, SourcedKeyType } from '../struct';
+import * as comment from './comment';
+import * as ep from './ep';
+import * as item from './item';
+export type ContentPageLike = new (preload: item.Item | undefined, id: string, ep: string) => ContentPage;
+export type ContentType_ = SourcedKeyType<typeof ContentPage.contentPages>;
+export type ContentType = Exclude<ContentType_, string>;
+export type ViewComponent = Component<{
+    page: ContentPage;
+    isFullScreen: boolean;
+}>;
+export type LayoutComponent = Component<{
+    page: ContentPage;
+}>;
+export declare abstract class ContentPage {
+    preload: item.Item | undefined;
+    id: string;
+    ep: string;
+    static layouts: import('vue').ShallowReactive<SourcedKeyMap<[plugin: string, name: string], LayoutComponent>>;
+    static contentPages: import('vue').ShallowReactive<SourcedKeyMap<[plugin: string, name: string], ContentPageLike>>;
+    constructor(preload: item.Item | undefined, id: string, ep: string);
+    abstract plugin: string;
+    abstract contentType: ContentType;
+    abstract fetchShortId: (signal?: AbortSignal) => Promise<string>;
+    abstract fetchDetail: (signal?: AbortSignal) => Promise<item.Item>;
+    abstract fetchRecommends: StreamQuery<[], item.Item>;
+    abstract fetchComments: StreamQuery<[], comment.Comment>;
+    abstract fetchEps: StreamQuery<[], ep.Ep>;
+    abstract ViewComponent: ViewComponent;
+}

package/dist/lib/model/download.d.ts

@@ -0,0 +1,10 @@
+import { Metadata, Metadatable } from '../struct';
+export declare abstract class Downloader implements Metadatable {
+    abstract id: string;
+    abstract name: string;
+    abstract $$plugin: string;
+    abstract $$meta?: Metadata;
+    abstract begin: () => void;
+    abstract resume: () => void;
+    abstract pause: () => void;
+}

package/dist/lib/model/ep.d.ts

@@ -0,0 +1,12 @@
+import { Struct, Metadata, Metadatable } from '../struct';
+export interface RawEp extends Metadatable {
+    name: string;
+    id: string;
+}
+export declare class Ep extends Struct<RawEp> implements RawEp {
+    name: string;
+    id: string;
+    $$plugin: string;
+    $$meta?: Metadata;
+    constructor(v: RawEp);
+}

package/dist/lib/model/image.d.ts

@@ -0,0 +1,19 @@
+import { Metadatable } from '../struct';
+import { Resource, RawResource, ProcessStep_ } from './resource';
+export interface RawImage extends Metadatable {
+    path: string;
+    forkNamespace: string;
+    processSteps?: ProcessStep_[];
+}
+export declare class Image extends Resource {
+    static is(value: unknown): value is Image;
+    static create(v: RawResource | RawImage, aspect?: ImageAspect): Image;
+    protected constructor(v: RawResource | RawImage, aspect?: ImageAspect);
+    get aspect(): Partial<ImageAspect> | undefined;
+    set aspect(v: Partial<ImageAspect> | undefined);
+}
+export interface ImageAspect {
+    width: number;
+    height: number;
+}
+export type Image_ = string | Image;

package/dist/lib/model/index.d.ts

@@ -0,0 +1,8 @@
+export * as comment from './comment';
+export * as content from './content';
+export * as download from './download';
+export * as ep from './ep';
+export * as image from './image';
+export * as item from './item';
+export * as resource from './resource';
+export * as user from './user';

package/dist/lib/model/item.d.ts

@@ -0,0 +1,104 @@
+import { default as dayjs } from 'dayjs';
+import { Component } from 'vue';
+import { SourcedKeyMap, Struct, Metadatable } from '../struct';
+import { ContentType, ContentType_ } from './content';
+import { Ep, RawEp } from './ep';
+import { RawResource } from './resource';
+import * as image from './image';
+export interface Category extends Metadatable {
+    name: string;
+    group: string;
+    search: {
+        keyword: string;
+        source: string;
+        sort: string;
+    };
+}
+export interface Author extends Metadatable {
+    label: string;
+    icon: RawResource | image.RawImage | string;
+    description: string;
+    /**
+     * 为空则不可订阅
+     * 否则传入的为`defineConfig`中定义的`subscribe.type`
+     */ subscribe?: string;
+    actions?: string[];
+}
+export interface RawItem extends Metadatable {
+    cover: RawResource | image.RawImage;
+    title: string;
+    id: string;
+    /** @alias tags  */
+    categories: Category[];
+    author: Author[];
+    viewNumber?: number;
+    likeNumber?: number;
+    commentNumber?: number;
+    isLiked?: boolean;
+    updateTime?: number;
+    customIsAI?: boolean;
+    contentType: ContentType_;
+    length: string;
+    epLength: string;
+    description?: Description;
+    thisEp: RawEp;
+    commentSendable: boolean;
+    customIsSafe?: boolean;
+}
+export type ItemCardComponent = Component<{
+    item: Item;
+    freeHeight?: boolean;
+    disabled?: boolean;
+    type?: 'default' | 'big' | 'small';
+    class?: any;
+    style?: any;
+}, any, any, any, any, {
+    click: [];
+}, {
+    default(): void;
+    smallTopInfo(): void;
+    cover(): void;
+}>;
+export type ItemTranslator = (raw: RawItem) => Item;
+export type Description = string | {
+    type: 'html';
+    content: string;
+} | {
+    type: 'text';
+    content: string;
+};
+export declare abstract class Item extends Struct<RawItem> implements RawItem {
+    static itemTranslator: import('vue').ShallowReactive<SourcedKeyMap<[plugin: string, name: string], ItemTranslator>>;
+    static create(raw: RawItem): Item;
+    static authorIcon: import('vue').ShallowReactive<SourcedKeyMap<[plugin: string, name: string], Component>>;
+    static itemCards: import('vue').ShallowReactive<SourcedKeyMap<[plugin: string, name: string], ItemCardComponent>>;
+    abstract like(): Promise<any>;
+    abstract report(): Promise<any>;
+    abstract sendComment(text: string): Promise<any>;
+    static is(value: unknown): value is Item;
+    cover: RawResource | image.RawImage;
+    get $cover(): image.Image;
+    title: string;
+    id: string;
+    categories: Category[];
+    author: Author[];
+    viewNumber?: number;
+    likeNumber?: number;
+    commentNumber?: number;
+    isLiked?: boolean;
+    description?: Description;
+    updateTime?: number;
+    get $updateTime(): dayjs.Dayjs;
+    contentType: ContentType;
+    length: string;
+    epLength: string;
+    $$plugin: string;
+    $$meta: import('..').Metadata | undefined;
+    thisEp: RawEp;
+    customIsSafe?: boolean;
+    get $thisEp(): Ep;
+    constructor(v: RawItem);
+    commentSendable: boolean;
+    customIsAI?: boolean;
+    get $isAi(): boolean;
+}

package/dist/lib/model/resource.d.ts

@@ -0,0 +1,34 @@
+import { SourcedKeyMap, Struct, Metadata, Metadatable } from '../struct';
+export type ProcessInstance = (nowPath: string, resource: Resource) => Promise<[path: string, exit: boolean]>;
+export interface ProcessStep {
+    referenceName: string;
+    ignoreExit?: boolean;
+}
+export type ProcessStep_ = ProcessStep | string;
+export interface ResourceType {
+    type: string;
+    urls: string[];
+    test: (url: string, signal: AbortSignal) => PromiseLike<void>;
+}
+export interface RawResource extends Metadatable {
+    pathname: string;
+    type: string;
+    processSteps?: ProcessStep_[];
+}
+export declare class Resource extends Struct<RawResource> implements RawResource {
+    static processInstances: import('vue').ShallowReactive<SourcedKeyMap<[plugin: string, referenceName: string], ProcessInstance>>;
+    static fork: import('vue').ShallowReactive<SourcedKeyMap<[plugin: string, type: string], ResourceType>>;
+    static precedenceFork: import('vue').ShallowReactive<SourcedKeyMap<[plugin: string, type: string], string>>;
+    static is(value: unknown): value is Resource;
+    static create(v: RawResource): Resource;
+    protected constructor(v: RawResource);
+    type: string;
+    pathname: string;
+    processSteps: ProcessStep[];
+    $$meta?: Metadata;
+    $$plugin: string;
+    getUrl(): Promise<string>;
+    omittedForks: import('vue').ShallowReactive<Set<string>>;
+    getThisFork(): string;
+    localChangeFork(): boolean;
+}

package/dist/lib/model/user.d.ts

@@ -0,0 +1,25 @@
+import { Component } from 'vue';
+import { Metadata, Metadatable } from '../struct';
+import { Image } from './image';
+import { RawResource } from './resource';
+export interface RawUser extends Metadatable {
+    avatar?: RawResource;
+    name: string;
+    id: string;
+}
+export declare abstract class User {
+    static userBase: import('vue').ShallowReactive<Map<string, User>>;
+    static userEditorBase: import('vue').ShallowReactive<Map<string, Component>>;
+    static userCards: import('vue').ShallowReactive<Map<string, UserCardComponent>>;
+    constructor(v: RawUser);
+    avatar?: Image;
+    name: string;
+    id: string;
+    $$plugin: string;
+    $$meta?: Metadata;
+    abstract customUser: object;
+}
+export type UserCardComponent = Component<{
+    user: User;
+    isSmall?: boolean;
+}>;

package/dist/lib/struct/index.d.ts

@@ -0,0 +1,3 @@
+export * from './store';
+export * from './struct';
+export * from './meta';

package/dist/lib/struct/meta.d.ts

@@ -0,0 +1,12 @@
+export interface Metadatable {
+    $$meta?: Metadata;
+    $$plugin: string;
+}
+export type Metadata = Record<string | number, any>;
+export type PageKey = string | number;
+export interface StreamQuery<TParameters extends any[], TItem> {
+    (...args: [...TParameters, page: PageKey, signal?: AbortSignal]): Promise<TItem[] & {
+        nextPage?: PageKey;
+    }>;
+    initialPageParam: PageKey;
+}

package/dist/lib/struct/store.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 比如有很多需要注明来自哪个插件的值都可以用
+ */
+export 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_
+ */
+export declare class SourcedKeyMap<TKey extends [string, string], TValue> implements Map<string, 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]>;
+}
+export 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;

package/dist/lib/struct/struct.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 可以结构化的数据，调用`toJSON`获取纯粹的json(没有get/set或method)
+ */
+export 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;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@delta-comic/model",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "空阙虱楼",
   "homepage": "https://github.com/delta-comic/delta-comic",
   "license": "AGPL-3.0-only",
@@ -39,8 +39,8 @@
   },
   "peerDependencies": {
     "vue": "^3.5",
-    "@delta-comic/request": "1.3.0",
-    "@delta-comic/utils": "1.3.0"
+    "@delta-comic/request": "1.3.1",
+    "@delta-comic/utils": "1.3.1"
   },
   "release": {
     "tagFormat": "model-${version}"