@inpageedit/core 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import { InPageEdit as IPECore } from './InPageEdit';
+export { InPageEdit, Service, Schema } from './InPageEdit';
+export { default as BasePlugin } from './plugins/BasePlugin';
+declare global {
+    const InPageEdit: typeof IPECore;
+    const ipe: IPECore;
+    interface Window {
+        InPageEdit: typeof IPECore;
+        ipe: IPECore;
+        __IPE_MODULES__: {
+            push(payload: (ipe: IPECore) => void): void;
+        };
+    }
+}
+declare global {
+    interface Window {
+        RLQ: {
+            push(callback: () => void): void;
+            push(depAndCallback: [string, () => void]): void;
+            push(depsAndCallback: [string[], () => void]): void;
+        };
+    }
+}

package/dist/index.js

@@ -0,0 +1,8 @@
+import { B as s, I as i, S as r, b as S } from "./index-CuEf9G7f.js";
+export {
+  s as BasePlugin,
+  i as InPageEdit,
+  r as Schema,
+  S as Service
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/models/WikiPage/index.d.ts

@@ -0,0 +1,63 @@
+import { PageInfo } from './types/PageInfo';
+import { PageParseData } from './types/PageParseData';
+import { WatchlistAction } from './types/WatchlistAction';
+import { MediaWikiApi, MwApiParams } from 'wiki-saikou/browser';
+export declare class WikiPage {
+    readonly api: MediaWikiApi;
+    pageInfo: PageInfo;
+    static readonly DEFAULT_PAGE_INFO: PageInfo;
+    constructor(pageInfo: Partial<PageInfo>, api?: MediaWikiApi);
+    getPageInfo(payload: MwApiParams): Promise<PageInfo>;
+    parse(params?: MwApiParams): Promise<import('fexios').FexiosFinalContext<{
+        parse: PageParseData;
+    }>>;
+    preview(text: string, params?: MwApiParams): Promise<import('fexios').FexiosFinalContext<{
+        parse: PageParseData;
+    }>>;
+    edit(payload: {
+        text?: string;
+        prependtext?: string;
+        appendtext?: string;
+        summary?: string;
+        watchlist?: WatchlistAction;
+    }, params?: MwApiParams): Promise<import('fexios').FexiosFinalContext<any>>;
+    createOnly(payload: {
+        text: string;
+        summary?: string;
+        watchlist?: WatchlistAction;
+    }, params?: MwApiParams): Promise<import('fexios').FexiosFinalContext<any>>;
+    delete(reason?: string, params?: MwApiParams): Promise<import('fexios').FexiosFinalContext<any>>;
+    moveTo(title: string, reason?: string, params?: Partial<MwApiParams & {
+        movetalk: boolean;
+        movesubpages: boolean;
+    }>): Promise<import('fexios').FexiosFinalContext<any>>;
+    userCan(action: keyof PageInfo['actions']): boolean;
+    userCanEdit(): boolean;
+    refetch(): Promise<this>;
+    get pageid(): number;
+    get title(): string;
+    get ns(): number;
+    get contentmodel(): keyof import('./types/PageInfo').ContentModelMap;
+    get fullurl(): string;
+    get canonicalurl(): string;
+    get editurl(): string | undefined;
+    get revisions(): {
+        revid: number;
+        parentid: number;
+        minor: boolean;
+        user: string;
+        timestamp: string;
+        comment: string;
+        contentformat: import('./types/PageInfo').ContentModelMap[keyof import('./types/PageInfo').ContentModelMap];
+        contentmodel: keyof import('./types/PageInfo').ContentModelMap;
+        content: string;
+    }[];
+    get templates(): {
+        ns: number;
+        title: string;
+    }[];
+    get images(): {
+        ns: number;
+        title: string;
+    }[];
+}

package/dist/models/WikiPage/types/PageInfo.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @url https://www.mediawiki.org/wiki/Content_handlers
+ */
+export type ContentModelMap = {
+    css: 'text/css';
+    javascript: 'text/javascript';
+    json: 'application/json';
+    text: 'text/plain';
+    wikitext: 'text/x-wiki';
+    GeoJson: 'application/json';
+    'sanitized-css': 'text/css';
+    Scribunto: 'text/plain';
+    'smw/schema': 'application/json';
+};
+export interface PageInfo {
+    pageid: number;
+    ns: number;
+    title: string;
+    contentmodel: keyof ContentModelMap;
+    pagelanguage: string;
+    pagelanguagehtmlcode: string;
+    pagelanguagedir: 'ltr' | 'rtl';
+    touched: string;
+    lastrevid: number;
+    length: number;
+    protection: [];
+    restrictiontypes: string[];
+    fullurl: string;
+    canonicalurl: string;
+    editurl?: string;
+    varianttitles?: Record<string, string>;
+    actions: {
+        edit: boolean;
+        move: boolean;
+        delete: boolean;
+    };
+    revisions?: {
+        revid: number;
+        parentid: number;
+        minor: boolean;
+        user: string;
+        timestamp: string;
+        comment: string;
+        contentformat: ContentModelMap[keyof ContentModelMap];
+        contentmodel: keyof ContentModelMap;
+        content: string;
+    }[];
+    templates: {
+        ns: number;
+        title: string;
+    }[];
+    images: {
+        ns: number;
+        title: string;
+    }[];
+}

package/dist/models/WikiPage/types/PageParseData.d.ts

@@ -0,0 +1,17 @@
+export interface PageParseData {
+    title: string;
+    pageid: number;
+    text: string;
+    langlinks: any[];
+    categories: any[];
+    links: any[];
+    templates: any[];
+    images: any[];
+    externallinks: string[];
+    sections: any[];
+    showtoc: boolean;
+    parsewarnings: any[];
+    displaytitle: string;
+    iwlinks: any[];
+    properties: any;
+}

package/dist/models/WikiPage/types/WatchlistAction.d.ts

@@ -0,0 +1,6 @@
+export declare enum WatchlistAction {
+    preferences = "preferences",
+    watch = "watch",
+    unwatch = "unwatch",
+    nochange = "nochange"
+}

package/dist/models/WikiTitle/index.d.ts

@@ -0,0 +1,12 @@
+export declare class WikiTitle {
+    readonly namespaceMap: {
+        id: number;
+        canonical: string;
+        aliases: string[];
+    };
+    constructor(title: string, ns: string | number, namespaceMap: {
+        id: number;
+        canonical: string;
+        aliases: string[];
+    });
+}

package/dist/plugins/BasePlugin.d.ts

@@ -0,0 +1,19 @@
+import { InPageEdit, Logger } from '../InPageEdit';
+interface DisposeHandler {
+    (ctx: InPageEdit): Promise<void> | void;
+}
+export default class BasePlugin<T extends unknown = any> {
+    #private;
+    ctx: InPageEdit;
+    config: T;
+    private disposeHandlers;
+    constructor(ctx: InPageEdit, config?: T, name?: string);
+    protected start(): Promise<void> | void;
+    protected stop(): Promise<void> | void;
+    protected addDisposeHandler(fn: DisposeHandler): void;
+    protected removeDisposeHandler(fn: DisposeHandler): void;
+    set name(name: string);
+    get name(): string;
+    get logger(): Logger;
+}
+export {};

package/dist/plugins/_debug/index.d.ts

@@ -0,0 +1,8 @@
+import { InPageEdit } from '../../InPageEdit';
+declare class PluginDebug extends BasePlugin {
+    ctx: InPageEdit;
+    constructor(ctx: InPageEdit);
+    protected start(): Promise<void>;
+    showModal(): SsiModal.SsiModal;
+}
+export default PluginDebug;

package/dist/plugins/preferences/PluginPreferencesUI.d.ts

@@ -0,0 +1,11 @@
+import { InPageEdit } from '../../InPageEdit';
+declare module '../../InPageEdit' {
+    interface InPageEdit {
+        preferencesUI: PluginPreferencesUI;
+    }
+}
+export declare class PluginPreferencesUI extends BasePlugin {
+    ctx: InPageEdit;
+    constructor(ctx: InPageEdit);
+    showModal(): void;
+}

package/dist/plugins/preferences/components/hooks.d.ts

@@ -0,0 +1,5 @@
+import { InPageEdit } from '../../../InPageEdit';
+import { App } from 'vue';
+export declare const IPEInjectKey: unique symbol;
+export declare const injectIPE: (ipe: InPageEdit, app?: App) => InPageEdit;
+export declare const useIPE: () => InPageEdit | undefined;

package/dist/plugins/preferences/index.d.ts

@@ -0,0 +1,37 @@
+import { InPageEdit, Schema } from '../../InPageEdit';
+import { IPEStorageItem } from '../../services/StorageService';
+declare module '../../InPageEdit' {
+    interface InPageEdit {
+        preferences: PluginPreferences;
+    }
+}
+export interface InPageEditPreferenceUICategory {
+    name: string;
+    label: string;
+    description?: string;
+    index?: number;
+}
+export interface InPageEditPreferenceUIRegistryItem {
+    name: string;
+    schema: Schema;
+    defaults: Record<string, any>;
+    category: string;
+}
+export declare class PluginPreferences extends BasePlugin {
+    ctx: InPageEdit;
+    private db;
+    customRegistries: InPageEditPreferenceUIRegistryItem[];
+    categoryDefinitions: InPageEditPreferenceUICategory[];
+    private _defaultPreferences;
+    constructor(ctx: InPageEdit);
+    start(): Promise<void>;
+    get<T = any>(key: string, fallback?: () => T | Promise<T>): Promise<T | null>;
+    getDefaultValue(key: string): any;
+    set<T = any>(key: string, value: T): Promise<IPEStorageItem<T> | void>;
+    getAll(): Promise<Record<string, any>>;
+    private loadDefaultConfigs;
+    registerCustomConfig(name: string, schema: Schema, category: string, defaults: Record<string, any>): this;
+    getConfigRegistries(category?: string): InPageEditPreferenceUIRegistryItem[];
+    defineCategory(category: InPageEditPreferenceUICategory): this;
+    getConfigCategories(): InPageEditPreferenceUICategory[];
+}

package/dist/plugins/quick-diff/JsDiffService.d.ts

@@ -0,0 +1,23 @@
+import { InPageEdit } from '../../InPageEdit';
+import * as JsDiff from 'diff';
+declare module '../../InPageEdit' {
+    interface InPageEdit {
+        jsdiff: JsDiffService;
+    }
+}
+export type JsDiffDiffType = 'diffChars' | 'diffWords' | 'diffWordsWithSpace' | 'diffLines' | 'diffTrimmedLines' | 'diffSentences' | 'diffCss' | 'diffJson' | 'diffArrays' | 'createTwoFilesPatch';
+export declare class JsDiffService {
+    ctx: InPageEdit;
+    constructor(ctx: InPageEdit);
+    JsDiff: typeof JsDiff;
+    diffChars: typeof JsDiff.diffChars;
+    diffWords: typeof JsDiff.diffWords;
+    diffWordsWithSpace: typeof JsDiff.diffWordsWithSpace;
+    diffLines: typeof JsDiff.diffLines;
+    diffTrimmedLines: typeof JsDiff.diffTrimmedLines;
+    diffSentences: typeof JsDiff.diffSentences;
+    diffCss: typeof JsDiff.diffCss;
+    diffJson: typeof JsDiff.diffJson;
+    diffArrays: typeof JsDiff.diffArrays;
+    createTwoFilesPatch: typeof JsDiff.createTwoFilesPatch;
+}

package/dist/plugins/quick-diff/PluginQuickDiffCore.d.ts

@@ -0,0 +1,69 @@
+import { InPageEdit } from '../../InPageEdit';
+import { JsDiffDiffType } from './JsDiffService';
+declare module '../../InPageEdit' {
+    interface InPageEdit {
+        quickDiff: PluginQuickDiffCore;
+    }
+}
+export interface CompareApiRequestOptions {
+    fromtitle: string;
+    fromid: number;
+    fromrev: number;
+    frompst: boolean;
+    totitle: string;
+    toid: number;
+    torev: number;
+    torelative?: 'cur' | 'prev' | 'next';
+    topst: boolean;
+    prop: string;
+    difftype: 'table' | 'unified';
+    fromtext: string;
+    fromsection: string | number;
+    fromcontentmodel: string;
+    totext: string;
+    tosection: string | number;
+    tocontentmodel: string;
+}
+export interface CompareApiResponse {
+    compare: Partial<{
+        fromid: number;
+        fromrevid: number;
+        fromns: number;
+        fromtitle: string;
+        fromsize: number;
+        fromtimestamp: string;
+        fromuser: string;
+        fromuserid: number;
+        fromcomment: string;
+        fromparsedcomment?: string;
+        toid: number;
+        torevid: number;
+        tons: number;
+        totitle: string;
+        tosize: number;
+        totimestamp: string;
+        touser: string;
+        touserid: number;
+        tocomment: string;
+        toparsedcomment: string;
+        diffsize: number;
+    }> & {
+        body: string;
+    };
+}
+export declare class PluginQuickDiffCore extends BasePlugin {
+    ctx: InPageEdit;
+    VALID_DIFF_TYPES: JsDiffDiffType[];
+    constructor(ctx: InPageEdit);
+    protected start(): Promise<void> | void;
+    protected stop(): Promise<void> | void;
+    private injectHistoryPage;
+    private injectQuickEdit;
+    simpleTextDiff(oldText: string, newText: string): void;
+    /**
+     * TODO: 类型体操
+     */
+    renderJsDiff(oldStr: string, newStr: string, diffType?: JsDiffDiffType): DocumentFragment;
+    readonly COMPARE_API_DEFAULT_OPTIONS: Partial<CompareApiRequestOptions>;
+    comparePages(options: Partial<CompareApiRequestOptions>): SsiModal.SsiModal;
+}

package/dist/plugins/quick-diff/components/DiffTable.d.ts

@@ -0,0 +1,6 @@
+import { JSX } from 'jsx-dom/jsx-runtime';
+import { CompareApiResponse } from '../PluginQuickDiffCore';
+export type DiffTableProps = {
+    data: Partial<CompareApiResponse['compare']>;
+} & JSX.IntrinsicElements['table'];
+export declare const DiffTable: (props: DiffTableProps) => import('jsx-dom').ReactElement;

package/dist/plugins/quick-diff/index.d.ts

@@ -0,0 +1,6 @@
+import { InPageEdit } from '../../InPageEdit';
+export declare class PluginQuickDiff extends BasePlugin {
+    ctx: InPageEdit;
+    static readonly inject: string[];
+    constructor(ctx: InPageEdit);
+}

package/dist/plugins/quick-edit/PluginQuickEditInArticleLinks.d.ts

@@ -0,0 +1,14 @@
+import { InPageEdit } from '../../InPageEdit';
+import { QuickEditOptions } from '.';
+export declare class PluginQuickEditInArticleLinks extends BasePlugin<{
+    wikiBaseUrl: string;
+    wikiArticlePath: string;
+    wikiArticleBaseUrl: string;
+    wikiScriptBaseUrl: string;
+    linkClassName: string;
+}> {
+    constructor(ctx: InPageEdit);
+    protected start(): Promise<void>;
+    stop(): void;
+    checkEditAnchor(anchor: HTMLAnchorElement): Pick<QuickEditOptions, 'title' | 'section' | 'revision' | 'createOnly'> | null;
+}

package/dist/plugins/quick-edit/index.d.ts

@@ -0,0 +1,52 @@
+import { InPageEdit } from '../../InPageEdit';
+import { WikiPage } from '../../models/WikiPage';
+import { WatchlistAction } from '../../models/WikiPage/types/WatchlistAction';
+declare module '../../InPageEdit' {
+    interface InPageEdit {
+        quickEdit: PluginQuickEdit['quickEdit'];
+    }
+    interface Events {
+        'quickEdit/initOptions'(payload: Omit<QuickEditInitPayload, 'modal' | 'wikiPage'>): void;
+        'quickEdit/showModal'(payload: Omit<QuickEditInitPayload, 'wikiPage'>): void;
+        'quickEdit/wikiPage'(payload: QuickEditInitPayload): void;
+    }
+}
+export interface QuickEditOptions {
+    title: string;
+    pageId: number;
+    revision: number;
+    /**
+     * - `undefined` for full article edit
+     * - `0` for the first section
+     * - `"new"` for a new section
+     */
+    section: number | 'new' | undefined;
+    editMinor: boolean;
+    editSummary: string;
+    createOnly: boolean;
+    reloadAfterSave: boolean;
+}
+export interface QuickEditInitPayload {
+    ctx: InPageEdit;
+    options: QuickEditOptions;
+    modal: SsiModal;
+    wikiPage: WikiPage;
+}
+export interface QuickEditSubmitPayload {
+    text?: string;
+    summary?: string;
+    minor?: boolean;
+    createonly?: boolean;
+    watchlist?: WatchlistAction;
+}
+export declare class PluginQuickEdit extends BasePlugin {
+    ctx: InPageEdit;
+    private readonly DEFAULT_OPTIONS;
+    constructor(ctx: InPageEdit);
+    protected start(): Promise<void> | void;
+    quickEdit(payload?: string | Partial<QuickEditOptions>): Promise<void>;
+    private handleSubmit;
+    private injectToolbox;
+    private getWikiPageFromPayload;
+    protected removeToolbox(ctx: InPageEdit): void;
+}

package/dist/plugins/quick-move/index.d.ts

@@ -0,0 +1,27 @@
+import { InPageEdit } from '../../InPageEdit';
+declare module '../../InPageEdit' {
+    interface InPageEdit {
+        quickMove: PluginQuickMove['quickMove'];
+        movePage: PluginQuickMove['movePage'];
+    }
+}
+export interface MovePageOptions {
+    from: string;
+    to: string;
+    reason?: string;
+    movetalk?: boolean;
+    movesubpages?: boolean;
+    noredirect?: boolean;
+}
+export interface QuickMoveOptions extends Partial<MovePageOptions> {
+    lockFromField?: boolean;
+    lockToField?: boolean;
+}
+export declare class PluginQuickMove extends BasePlugin {
+    ctx: InPageEdit;
+    constructor(ctx: InPageEdit);
+    protected start(): Promise<void> | void;
+    private injectToolbox;
+    quickMove(options?: Partial<QuickMoveOptions>): SsiModal.SsiModal;
+    movePage(options: MovePageOptions): Promise<import('fexios').FexiosFinalContext<any>>;
+}

package/dist/plugins/quick-preview/index.d.ts

@@ -0,0 +1,32 @@
+import { InPageEdit } from '../../InPageEdit';
+import { WikiPage } from '../../models/WikiPage';
+import { MwApiParams } from 'wiki-saikou';
+import { PageParseData } from '../../models/WikiPage/types/PageParseData';
+declare module '../../InPageEdit' {
+    interface InPageEdit {
+        quickPreview: PluginQuickPreview['quickPreview'];
+    }
+    interface Events {
+        'quickPreview/showModal'(payload: {
+            ctx: InPageEdit;
+            text: string;
+            modal: SsiModal;
+            wikiPage: WikiPage;
+        }): void;
+        'quickPreview/loaded'(payload: {
+            ctx: InPageEdit;
+            modal: SsiModal;
+            wikiPage: WikiPage;
+            text: string;
+            parseData: PageParseData;
+        }): void;
+    }
+}
+export declare class PluginQuickPreview extends BasePlugin {
+    ctx: InPageEdit;
+    constructor(ctx: InPageEdit);
+    protected start(): Promise<void> | void;
+    protected stop(): Promise<void> | void;
+    private injectQuickEdit;
+    quickPreview(text: string, params?: MwApiParams, wikiPage?: WikiPage): Promise<void>;
+}

package/dist/plugins/quick-redirect/index.d.ts

@@ -0,0 +1,24 @@
+import { InPageEdit } from '../../InPageEdit';
+declare module '../../InPageEdit' {
+    interface InPageEdit {
+        quickRedirect: PluginQuickRedirect['quickRedirect'];
+        redirectPage: PluginQuickRedirect['redirectPage'];
+    }
+}
+export interface RedirectPageOptions {
+    from: string;
+    to: string;
+    reason?: string;
+    overwrite?: boolean;
+}
+export interface QuickRedirectOptions extends Partial<RedirectPageOptions> {
+}
+export declare class PluginQuickRedirect extends BasePlugin {
+    ctx: InPageEdit;
+    static readonly inject: string[];
+    constructor(ctx: InPageEdit);
+    protected start(): Promise<void> | void;
+    protected stop(): Promise<void> | void;
+    quickRedirect(options?: Partial<QuickRedirectOptions>): SsiModal.SsiModal;
+    redirectPage(options: RedirectPageOptions): Promise<import('fexios').FexiosFinalContext<any>>;
+}

package/dist/plugins/toolbox/index.d.ts

@@ -0,0 +1,38 @@
+import { InPageEdit, Service } from '../../InPageEdit';
+import { ReactElement } from 'jsx-dom';
+declare module '../../InPageEdit' {
+    interface InPageEdit {
+        toolbox: PluginToolbox;
+    }
+    interface Events {
+        'toolbox/button/added'(payload: {
+            ctx: InPageEdit;
+            button: HTMLElement;
+        }): void;
+        'toolbox/button/removed'(payload: {
+            ctx: InPageEdit;
+            id: string;
+        }): void;
+    }
+}
+export declare class PluginToolbox extends Service {
+    ctx: InPageEdit;
+    container: HTMLElement;
+    private forceShow;
+    constructor(ctx: InPageEdit);
+    protected start(): Promise<void>;
+    protected stop(): void | Promise<void>;
+    private createToolbox;
+    private createIndicatorForNotArticlePage;
+    private normalizeButtonId;
+    addButton(payload: {
+        id: string;
+        group?: 'auto' | 'group1' | 'group2';
+        icon: string | HTMLElement | SVGElement | JQuery | ReactElement;
+        tooltip?: string | HTMLElement | JQuery;
+        buttonProps?: Record<string, any>;
+        onClick?: (event: MouseEvent) => void;
+        index?: number;
+    }): HTMLElement;
+    removeButton(id: string): void;
+}

package/dist/polyfills/Promise.withResolvers.d.ts

@@ -0,0 +1,5 @@
+export declare const promiseWithResolvers: <T extends unknown = any>() => {
+    promise: Promise<T>;
+    resolve: (value: T | PromiseLike<T>) => void;
+    reject: (reason?: any) => void;
+};

package/dist/services/ApiService.d.ts

@@ -0,0 +1,14 @@
+import { InPageEdit } from '../InPageEdit';
+import { MwApi } from 'wiki-saikou';
+declare module '../InPageEdit' {
+    interface InPageEdit {
+        api: MwApi;
+    }
+}
+export interface ApiServiceOptions {
+    baseURL: string | URL;
+}
+export declare class ApiService {
+    ctx: InPageEdit;
+    constructor(ctx: InPageEdit, options?: Partial<ApiServiceOptions>);
+}

package/dist/services/ResourceLoaderService.d.ts

@@ -0,0 +1,13 @@
+import { InPageEdit, Service } from '../InPageEdit';
+declare module '../InPageEdit' {
+    interface InPageEdit {
+        resourceLoader: ResourceLoaderService;
+    }
+}
+export declare class ResourceLoaderService extends Service {
+    ctx: InPageEdit;
+    constructor(ctx: InPageEdit);
+    protected stop(): void | Promise<void>;
+    loadScript(src: string, attrs?: Record<string, any>): Promise<HTMLScriptElement>;
+    loadStyle(href: string, attrs?: Record<string, any>): Promise<HTMLLinkElement>;
+}