@delta-comic/plugin 0.0.0-semantically-released

package/dist/lib/config.d.ts

@@ -0,0 +1,64 @@
+import { FormType } from '@delta-comic/ui';
+import { Ref } from 'vue';
+export type ConfigDescription = Record<string, Required<Pick<FormType.SingleConfigure, 'defaultValue'>> & FormType.SingleConfigure>;
+export declare class ConfigPointer<T extends ConfigDescription = ConfigDescription> {
+    pluginName: string;
+    config: T;
+    constructor(pluginName: string, config: T);
+    readonly key: symbol;
+}
+export declare const appConfig: ConfigPointer<{
+    recordHistory: {
+        type: "switch";
+        defaultValue: true;
+        info: string;
+    };
+    showAIProject: {
+        type: "switch";
+        defaultValue: true;
+        info: string;
+    };
+    darkMode: {
+        type: "radio";
+        defaultValue: string;
+        info: string;
+        comp: "select";
+        selects: {
+            label: string;
+            value: string;
+        }[];
+    };
+    easilyTitle: {
+        type: "switch";
+        defaultValue: false;
+        info: string;
+    };
+}>;
+export declare const useConfig: import('pinia').StoreDefinition<"config", Pick<{
+    isDark: import('vue').ComputedRef<boolean>;
+    form: import('vue').ShallowReactive<Map<symbol, {
+        form: ConfigDescription;
+        value: Ref<any>;
+    }>>;
+    $load: <T extends ConfigPointer>(pointer: T) => Ref<FormType.Result<T["config"]>>;
+    $isExistConfig: (pointer: ConfigPointer) => boolean;
+    $resignerConfig: (pointer: ConfigPointer) => void;
+}, "form">, Pick<{
+    isDark: import('vue').ComputedRef<boolean>;
+    form: import('vue').ShallowReactive<Map<symbol, {
+        form: ConfigDescription;
+        value: Ref<any>;
+    }>>;
+    $load: <T extends ConfigPointer>(pointer: T) => Ref<FormType.Result<T["config"]>>;
+    $isExistConfig: (pointer: ConfigPointer) => boolean;
+    $resignerConfig: (pointer: ConfigPointer) => void;
+}, "isDark">, Pick<{
+    isDark: import('vue').ComputedRef<boolean>;
+    form: import('vue').ShallowReactive<Map<symbol, {
+        form: ConfigDescription;
+        value: Ref<any>;
+    }>>;
+    $load: <T extends ConfigPointer>(pointer: T) => Ref<FormType.Result<T["config"]>>;
+    $isExistConfig: (pointer: ConfigPointer) => boolean;
+    $resignerConfig: (pointer: ConfigPointer) => void;
+}, "$load" | "$isExistConfig" | "$resignerConfig">>;

package/dist/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './plugin';
+export * from './config';

package/dist/lib/plugin/api.d.ts

@@ -0,0 +1,8 @@
+export interface Config {
+    forks: () => PromiseLike<string[]> | string[];
+    /**
+     * error -> 不可用
+     * other -> 可用并比对时间
+     */
+    test: (fork: string, signal: AbortSignal) => PromiseLike<void>;
+}

package/dist/lib/plugin/auth.d.ts

@@ -0,0 +1,15 @@
+import { FormType } from '@delta-comic/ui';
+export interface Config {
+    signUp: (by: Method) => PromiseLike<any>;
+    logIn: (by: Method) => PromiseLike<any>;
+    passSelect: () => PromiseLike<'signUp' | 'logIn' | false>;
+}
+export type Method = {
+    form<T extends FormType.Configure>(form: T): Promise<{
+        [x in keyof T]: FormType.SingleResult<T[x]>;
+    }>;
+    /**
+     * sandbox: "allow-forms allow-modals allow-orientation-lock allow-popups-to-escape-sandbox  allow-pointer-lock"
+     */
+    website(url: string): Window;
+};

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

@@ -0,0 +1,8 @@
+import { uni } from '@delta-comic/model';
+export type Config = Record<string, {
+    itemCard?: uni.item.ItemCardComp;
+    commentRow?: uni.comment.CommentRow;
+    layout?: uni.content.ViewLayoutComp;
+    contentPage?: uni.content.ContentPageLike;
+    itemTranslator?: uni.item.ItemTranslator;
+}>;

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

@@ -0,0 +1,78 @@
+import { ConfigPointer } from '../config';
+import type * as Share from './share';
+export type * as Share from './share';
+import type * as Content from './content';
+export type * as Content from './content';
+import type * as Subscribe from './subscribe';
+export type * as Subscribe from './subscribe';
+import type * as User from './user';
+export type * as User from './user';
+import type * as Api from './api';
+export type * as Api from './api';
+import type * as OtherProgress from './otherProgress';
+export type * as OtherProgress from './otherProgress';
+import type * as Search from './search';
+export type * as Search from './search';
+import type * as Auth from './auth';
+export type * as Auth from './auth';
+import type * as Resource from './resource';
+export type * as Resource from './resource';
+export interface DefineConfig {
+    name: string;
+    content?: Content.Config;
+    resource?: Resource.Content;
+    api?: Record<string, Api.Config>;
+    user?: User.Config;
+    auth?: Auth.Config;
+    otherProgress?: OtherProgress.Config[];
+    /**
+     * 返回值如果不为空，则会await后作为expose暴露
+     */
+    onBooted?(ins: DefineResult): (PromiseLike<object> | object) | void;
+    search?: Search.Config;
+    /**
+     * 插件的配置项需在此处注册
+     * 传入`Store.ConfigPointer`
+     */
+    config?: ConfigPointer[];
+    subscribe?: Record<string, Subscribe.Config>;
+    share?: Share.Config;
+}
+export type DefineResult = {
+    api?: Record<string, string | undefined | false>;
+};
+export declare const definePlugin: <T extends DefineConfig>(config: T | ((safe: boolean) => T)) => Promise<T>;
+export type PluginExpose<T extends ReturnType<typeof definePlugin>> = Awaited<ReturnType<NonNullable<Awaited<T>['onBooted']>>>;
+export interface RawPluginMeta {
+    'name:display': string;
+    'name:id': string;
+    'version': string;
+    'author': string | undefined;
+    'description': string;
+    'require'?: string[] | string;
+}
+export interface PluginMeta {
+    name: {
+        display: string;
+        id: string;
+    };
+    version: {
+        plugin: string;
+        supportCore: string;
+    };
+    author: string;
+    description: string;
+    require: {
+        id: string;
+        download?: string | undefined;
+    }[];
+    entry?: {
+        jsPath: string;
+        cssPath?: string;
+    };
+    beforeBoot?: {
+        path: string;
+        slot: string;
+    }[];
+}
+export declare const decodePluginMeta: (v: RawPluginMeta) => PluginMeta;

package/dist/lib/plugin/otherProgress.d.ts

@@ -0,0 +1,4 @@
+export interface Config {
+    call: (setDescription: (description: string) => void) => PromiseLike<any>;
+    name: string;
+}

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

@@ -0,0 +1,5 @@
+import { uni } from '@delta-comic/model';
+export interface Content {
+    process?: Record<string, uni.resource.ProcessInstance>;
+    types?: uni.resource.ResourceType[];
+}

package/dist/lib/plugin/search.d.ts

@@ -0,0 +1,71 @@
+import { RPromiseContent, RStream, uni } from '@delta-comic/model';
+import { Component } from 'vue';
+export interface Config {
+    /**
+     * @description
+     * key: id
+     */
+    methods?: Record<string, SearchMethod>;
+    tabbar?: Tabbar[];
+    categories?: Category[];
+    hotPage?: {
+        levelBoard?: HotLevelboard[];
+        topButton?: HotTopButton[];
+        mainListCard?: HotMainList[];
+    };
+    barcode?: Barcode[];
+}
+export interface SearchMethod {
+    name: string;
+    sorts: {
+        text: string;
+        value: string;
+    }[];
+    defaultSort: string;
+    getStream(input: string, sort: string): RStream<uni.item.Item>;
+    getAutoComplete(input: string, signal: AbortSignal): PromiseLike<({
+        text: string;
+        value: string;
+    } | Component)[]>;
+}
+export interface HotLevelboard {
+    name: string;
+    content: () => RStream<uni.item.Item> | RPromiseContent<any, uni.item.Item[]>;
+}
+export interface HotMainList {
+    name: string;
+    content: () => RStream<uni.item.Item> | RPromiseContent<any, uni.item.Item[]>;
+    onClick?(): any;
+}
+export interface HotTopButton {
+    name: string;
+    icon: Component;
+    bgColor: string;
+    onClick?(): any;
+}
+export interface Category {
+    title: string;
+    namespace: string;
+    search: {
+        methodId: string;
+        input: string;
+        sort: string;
+    };
+}
+export interface Tabbar {
+    title: string;
+    id: string;
+    comp: Component<{
+        isActive: boolean;
+        tabbar: Tabbar;
+    }>;
+}
+export type RouteToContent = (contentType_: uni.content.ContentType_, id: string, ep: string, preload?: uni.content.PreloadValue) => PromiseLike<any>;
+export interface Barcode {
+    match: (searchText: string) => boolean;
+    /**
+     * 选中后返回路由信息
+     */
+    getContent: (searchText: string, signal: AbortSignal) => PromiseLike<Parameters<RouteToContent>>;
+    name: string;
+}

package/dist/lib/plugin/share.d.ts

@@ -0,0 +1,26 @@
+import { uni } from '@delta-comic/model';
+import { Component } from 'vue';
+export interface Config {
+    initiative: InitiativeItem[];
+    tokenListen: ShareToken[];
+}
+export interface ShareToken {
+    key: string;
+    name: string;
+    patten(chipboard: string): boolean;
+    show(chipboard: string): Promise<PopupConfig> | PopupConfig;
+}
+export interface PopupConfig {
+    title: string;
+    detail: string;
+    onPositive(): void;
+    onNegative(): void;
+}
+export interface InitiativeItem {
+    key: string;
+    name: string;
+    icon: Component | uni.image.Image;
+    bgColor?: string;
+    call(page: uni.content.ContentPage): Promise<any>;
+    filter(page: uni.content.ContentPage): boolean;
+}

package/dist/lib/plugin/subscribe.d.ts

@@ -0,0 +1,13 @@
+import { uni, RStream } from '@delta-comic/model';
+export interface Config {
+    getUpdateList(olds: {
+        author: uni.item.Author;
+        list: uni.item.Item[];
+    }[], signal?: AbortSignal): PromiseLike<{
+        isUpdated: boolean;
+        whichUpdated: uni.item.Author[];
+    }>;
+    onAdd?(author: uni.item.Author): any;
+    onRemove?(author: uni.item.Author): any;
+    getListStream(author: uni.item.Author): RStream<uni.item.Item>;
+}

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

@@ -0,0 +1,47 @@
+import { uni } from '@delta-comic/model';
+import { Component, MaybeRefOrGetter } from 'vue';
+export interface Config {
+    edit?: Component;
+    card?: uni.user.UserCardComp;
+    authorIcon?: Record<string, Component>;
+    /**
+     * 1. download
+     * 2. upload (收藏那些云端未收藏的漫画)
+     */
+    syncFavourite?: {
+        download: () => PromiseLike<uni.item.Item[]>;
+        upload: (items: uni.item.RawItem[]) => PromiseLike<any>;
+    };
+    /**
+     * 你希望展示的(`userActions`)自己的板块的页面
+     */
+    userActionPages?: UserActionPage[];
+    /**
+     * 在用户界面，在历史记录那个板块的下方，你希望展示的自己的板块
+     */
+    userActions?: Record<string, UserAction>;
+}
+export interface UserAction {
+    call(author: uni.item.Author): any;
+    name: string;
+    icon?: Component;
+}
+export interface UserActionPage {
+    title?: string;
+    items: ActionPageItem[];
+    clickPage?: Component;
+    clickText?: string;
+}
+export type ActionPageItem = {
+    name: string;
+    key: string;
+    type: 'button';
+    icon: Component;
+    page: Component;
+} | {
+    name: string;
+    key: string;
+    type: 'statistic';
+    icon?: Component;
+    value: MaybeRefOrGetter<string | number>;
+};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@delta-comic/plugin",
+  "version": "0.0.0-semantically-released",
+  "description": "空阙虱楼",
+  "homepage": "https://github.com/delta-comic/delta-comic-core",
+  "license": "AGPL-3.0-only",
+  "author": {
+    "name": "wenxig",
+    "email": "wenxinguo12@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/delta-comic/delta-comic-core.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/lib/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@vueuse/core": "^14.2.1",
+    "mitt": "^3.0.1",
+    "@delta-comic/model": "0.0.0-semantically-released",
+    "@delta-comic/utils": "0.0.0-semantically-released",
+    "@delta-comic/ui": "0.0.0-semantically-released",
+    "@delta-comic/core": "0.0.0-semantically-released"
+  },
+  "peerDependencies": {
+    "pinia": "^3.0",
+    "vue": "^3.5",
+    "vue-router": "^5.0"
+  },
+  "release": {
+    "extends": "../../release.config.js",
+    "tagFormat": "plugin-${version}"
+  },
+  "dist": {
+    "tarball": "./dist/pack.tgz"
+  },
+  "readme": "./README.md",
+  "scripts": {
+    "build": "vite build && pnpm pack --out ./dist/pack.tgz"
+  }
+}