@univerjs-pro/drill-down-extraction 0.3.0-nightly.202410101606

package/lib/locale/ru-RU.json

@@ -0,0 +1,45 @@
+{
+  "drill-down-extraction": {
+    "message": {
+      "failed": "Extraction data has been cancelled: {0}",
+      "success": " Fields extract data successfully",
+      "drop": "The result has been discarded"
+    },
+    "config": {
+      "title": "Fields extraction Process",
+      "helper": " Fields extraction process",
+      "dataSource": "Hyperlink in the column",
+      "dataSourcePlaceholder": "Select the link to the data source",
+      "dataSourceError": "Please select a link",
+      "column": "Extraction Fields",
+      "columnPlaceholder": "Select the fields",
+      "columnError": "Please select the field to be extracted",
+      "columnItemTitle": " Fields",
+      "optionsBlank": "No options available",
+      "gettingData": "Extracting Fields...",
+      "gettingDataError": "Failed to extract data.",
+      "stopMessage": "Fields extraction has been stopped.",
+      "gettingDataSuccess": "Fields extraction is successful. Check whether the data is correct.",
+      "startCompletion": "Begin Extracting Fields",
+      "drop": "Drop",
+      "retry": "Retry",
+      "confirm": "Confirm",
+      "stop": "Stop",
+      "cancel": "Cancel",
+      "subscribe": "Subscribe",
+      "toInstall": "To Install",
+      "SuccessMessage": " Fields extraction successfully",
+      "cancelMessage": "Fields extraction has been cancelled",
+      "dropMessage": "The result has been discarded",
+      "stayTuned": "Feature under development. Stay tuned!",
+      "limitDialogTitle": "Limited per extraction",
+      "limitDialogContent": "{0} rows extraction limit reached. To extract more rows, please subscribe.",
+      "extensionDialogTitle": "No extension installed",
+      "extensionDialogContent": "The field extraction process requires the Clipsheet extension to be installed."
+    },
+    "hyperLink": {
+      "optionLabel": "Extraction field",
+      "placeholder": "Please get the extraction field by ClipSheet extension"
+    }
+  }
+}

package/lib/locale/zh-CN.json

@@ -0,0 +1,45 @@
+{
+  "drill-down-extraction": {
+    "message": {
+      "failed": "数据采集失败: {0}",
+      "success": "数据采集完成",
+      "drop": "已丢弃采集数据"
+    },
+    "config": {
+      "title": "数据采集",
+      "helper": "用采集字段写入数据",
+      "dataSource": "超链接所在列",
+      "dataSourcePlaceholder": "选择数据源链接",
+      "dataSourceError": "请选择数据源链接",
+      "column": "采集字段",
+      "columnPlaceholder": "选择采集字段",
+      "columnError": "选择采集字段",
+      "columnItemTitle": "字段",
+      "optionsBlank": "暂无选项",
+      "gettingData": "数据采集中...",
+      "gettingDataError": "采集数据失败",
+      "stopMessage": "数据采集已暂停",
+      "gettingDataSuccess": "数据采集成功，请检查是否正确",
+      "startCompletion": "开始数据采集",
+      "drop": "丢弃",
+      "retry": "重试",
+      "confirm": "确认",
+      "stop": "停止",
+      "cancel": "取消",
+      "subscribe": "订阅",
+      "toInstall": "前去安装",
+      "SuccessMessage": "数据采集成功",
+      "cancelMessage": "已取消数据采集",
+      "dropMessage": "已丢弃采集数据",
+      "stayTuned": "功能正在开发中，敬请期待！",
+      "limitDialogTitle": "采集限制提醒",
+      "limitDialogContent": "已达到 {0} 行采集上限，要采集更多数据，请订阅。",
+      "extensionDialogTitle": "未安装扩展",
+      "extensionDialogContent": "采集字段写入数据需要安装 Clipsheet 扩展。"
+    },
+    "hyperLink": {
+      "optionLabel": "采集字段",
+      "placeholder": "请使用插件获取采集字段"
+    }
+  }
+}

package/lib/types/common/extraction-field.d.ts

@@ -0,0 +1,24 @@
+export declare const EXTRACTION_FIELD_TYPE = "extract_field";
+export interface ISelectorItem {
+    selector: string;
+    text: string;
+}
+export interface IExtractionFieldData {
+    url: string;
+    type: typeof EXTRACTION_FIELD_TYPE;
+    selectors: Array<ISelectorItem>;
+}
+export declare const extractionFieldLinkHelper: {
+    payloadPattern: RegExp;
+    getSelectorItems(data: IExtractionFieldData): {
+        text: string;
+        payload: string;
+    }[];
+    generateLinkPayload(url: string, selector: string): string;
+    isPayload(payload: string): boolean;
+    parsePayload(payload: string): [string, string] | null;
+};
+export declare const extractionFieldHelper: {
+    parsePlainText(clipboard: string): IExtractionFieldData | null;
+    checkData(data: any): data is IExtractionFieldData;
+};

package/lib/types/common/field-extraction-event.d.ts

@@ -0,0 +1,34 @@
+export interface IFieldExtractionRequestEvent {
+    id: string;
+    interval: number;
+    url: string;
+    selectors: string[];
+}
+export interface IFieldExtractionResponseEvent {
+    id: string;
+    url: string;
+    datum: Array<{
+        selector: string;
+        text: string;
+    }>;
+    success: boolean;
+}
+export declare enum FieldExtractionEvents {
+    Request = "univer-field-extraction-request",
+    Response = "univer-field-extraction-response",
+    Installed = "univer-field-extraction-installed"
+}
+declare function sendRequestFieldExtractionEvent(detail: IFieldExtractionRequestEvent): void;
+declare function sendResponseFieldExtractionEvent(detail: IFieldExtractionResponseEvent): void;
+declare function listenFieldExtractionRequestEvent(callback: (params: IFieldExtractionRequestEvent) => void): () => void;
+declare function listenFieldExtractionResponseEvent(callback: (params: IFieldExtractionResponseEvent) => void): () => void;
+declare function listenExtensionInstalledEvent(callback: () => void): () => void;
+export declare const fieldExtractionEvent: {
+    sendRequest: typeof sendRequestFieldExtractionEvent;
+    sendResponse: typeof sendResponseFieldExtractionEvent;
+    broadcastInstalled: () => boolean;
+    listenInstalled: typeof listenExtensionInstalledEvent;
+    listenRequest: typeof listenFieldExtractionRequestEvent;
+    listenResponse: typeof listenFieldExtractionResponseEvent;
+};
+export {};

package/lib/types/constants.d.ts

@@ -0,0 +1 @@
+export declare const UniverSheetsDrillDownExtractionPluginName: "UNIVER_DRILL_DOWN_EXTRACTION_PLUGIN";

package/lib/types/controllers/config.schema.d.ts

@@ -0,0 +1,5 @@
+export declare const PLUGIN_CONFIG_KEY = "drill-down-extraction.config";
+export declare const configSymbol: unique symbol;
+export interface IUniverDrillDownExtractionConfig {
+}
+export declare const defaultPluginConfig: IUniverDrillDownExtractionConfig;

package/lib/types/controllers/drill-down-extraction-hyper-link.controller.d.ts

@@ -0,0 +1,21 @@
+import { Disposable, Injector, LocaleService } from '@univerjs/core';
+import { SheetInterceptorService } from '@univerjs/sheets';
+import { HyperLinkModel } from '@univerjs/sheets-hyper-link';
+import { SheetsHyperLinkCopyPasteController, SheetsHyperLinkSidePanelService } from '@univerjs/sheets-hyper-link-ui';
+import { ISheetClipboardService } from '@univerjs/sheets-ui';
+export declare class SheetsDrillDownExtractionHyperLinkController extends Disposable {
+    private _sheetClipboardService;
+    private readonly _sheetInterceptorService;
+    private _sheetHyperLinkSidePanelService;
+    private _hyperLinkModel;
+    private _injector;
+    private _localeService;
+    private _hyperLinkCopyPasteController;
+    private _copyInfo;
+    constructor(_sheetClipboardService: ISheetClipboardService, _sheetInterceptorService: SheetInterceptorService, _sheetHyperLinkSidePanelService: SheetsHyperLinkSidePanelService, _hyperLinkModel: HyperLinkModel, _injector: Injector, _localeService: LocaleService, _hyperLinkCopyPasteController: SheetsHyperLinkCopyPasteController);
+    private _registerHyperLink;
+    private _initCopyPaste;
+    private _initSetRangeValuesCommandInterceptor;
+    private _collect;
+    private _generateMutations;
+}

package/lib/types/controllers/drill-down-extraction-ui.controller.d.ts

@@ -0,0 +1,7 @@
+import { Disposable } from '@univerjs/core';
+import { ComponentManager } from '@univerjs/ui';
+export declare class DrillDownExtractionUIController extends Disposable {
+    private readonly _componentManager;
+    constructor(_componentManager: ComponentManager);
+    private _initComponent;
+}

package/lib/types/controllers/drill-down-extraction.controller.d.ts

@@ -0,0 +1,58 @@
+import { ICellData, IObjectMatrixPrimitiveType, IRange, Disposable, ICommandService, IPermissionService, IUniverInstanceService, LocaleService, ThemeService, UserManagerService } from '@univerjs/core';
+import { ISheetCommandSharedParams, RangeProtectionRuleModel, RefRangeService, SheetsSelectionsService } from '@univerjs/sheets';
+import { IRenderManagerService } from '@univerjs/engine-render';
+import { HTTPService } from '@univerjs/network';
+import { HyperLinkModel } from '@univerjs/sheets-hyper-link';
+import { SheetCanvasPopManagerService } from '@univerjs/sheets-ui';
+import { IMessageService } from '@univerjs/ui';
+import { SuggestionManagerService } from '../services/suggestion-manager.service';
+export declare const DrillDownExtractionFloatingButtonName = "DrillDownExtractionFloatingButtonName";
+export declare const DrillDownExtractionFloatingRectName = "DrillDownExtractionFloatingRectName";
+export declare const DrillDownExtractionFloatingRectZIndex = 100;
+export interface IFieldsExtractionCommandParams extends ISheetCommandSharedParams {
+    urlToRowsMap: Map<string, number[]>;
+    selectorToColumnsMap: Map<string, number[]>;
+}
+export declare function generateNullCellValue(range: IRange[]): IObjectMatrixPrimitiveType<ICellData>;
+export declare class DrillDownExtractionController extends Disposable {
+    private _selectionProtectionRuleModel;
+    private _permissionService;
+    private readonly _selectionManagerService;
+    private readonly _sheetPopManagerService;
+    private readonly _httpService;
+    private readonly _refRangeService;
+    private readonly _localeService;
+    private readonly _commandService;
+    private readonly _messageService;
+    private readonly _instanceService;
+    private readonly _hyperLinkModel;
+    private readonly _suggestionManagerService;
+    private readonly _renderManagerService;
+    private readonly _themeService;
+    private readonly _userManagerService;
+    private _rectsDisposer;
+    constructor(_selectionProtectionRuleModel: RangeProtectionRuleModel, _permissionService: IPermissionService, _selectionManagerService: SheetsSelectionsService, _sheetPopManagerService: SheetCanvasPopManagerService, _httpService: HTTPService, _refRangeService: RefRangeService, _localeService: LocaleService, _commandService: ICommandService, _messageService: IMessageService, _instanceService: IUniverInstanceService, _hyperLinkModel: HyperLinkModel, _suggestionManagerService: SuggestionManagerService, _renderManagerService: IRenderManagerService, _themeService: ThemeService, _userManagerService: UserManagerService);
+    getRowsLimit(): Promise<number>;
+    private _initCommand;
+    private _initActiveSheetChange;
+    private _initSelectionChangeListener;
+    private _initRequestingRangeListener;
+    private _selectionContentShouldBeDrillDownExtract;
+    private _showDrillDownExtractButton;
+    private _operationHandlerListener;
+    private _generateSuggestOptions;
+    private _requestingRange;
+    private _getScale;
+    private _clearSuggestionContent;
+    private _getClearRangeByColumns;
+    private _isHyperLink;
+    private _getExtractionField;
+    private _getHyperlinkFromCell;
+    private _generateCellValue;
+    private _getExtractionInterval;
+    private _getRequest;
+    private _stopSubscription;
+    private _requestDrillDownExtract;
+    stopDrillDown(): void;
+}
+export declare function hasURL(text: string): boolean;

package/lib/types/index.d.ts

@@ -0,0 +1,3 @@
+export { UniverSheetsDrillDownExtractionPlugin } from './plugin';
+export { UniverSheetsDrillDownExtractionPluginName } from './constants';
+export { SuggestionManagerService, SuggestStateEnum } from './services/suggestion-manager.service';

package/lib/types/locale/en-US.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/ru-RU.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/zh-CN.d.ts

@@ -0,0 +1,46 @@
+declare const locales: {
+    'drill-down-extraction': {
+        message: {
+            failed: string;
+            success: string;
+            drop: string;
+        };
+        config: {
+            title: string;
+            helper: string;
+            dataSource: string;
+            dataSourcePlaceholder: string;
+            dataSourceError: string;
+            column: string;
+            columnPlaceholder: string;
+            columnError: string;
+            columnItemTitle: string;
+            optionsBlank: string;
+            gettingData: string;
+            gettingDataError: string;
+            stopMessage: string;
+            gettingDataSuccess: string;
+            startCompletion: string;
+            drop: string;
+            retry: string;
+            confirm: string;
+            stop: string;
+            cancel: string;
+            subscribe: string;
+            toInstall: string;
+            SuccessMessage: string;
+            cancelMessage: string;
+            dropMessage: string;
+            stayTuned: string;
+            limitDialogTitle: string;
+            limitDialogContent: string;
+            extensionDialogTitle: string;
+            extensionDialogContent: string;
+        };
+        hyperLink: {
+            optionLabel: string;
+            placeholder: string;
+        };
+    };
+};
+export default locales;

package/lib/types/plugin.d.ts

@@ -0,0 +1,13 @@
+import { IUniverDrillDownExtractionConfig } from './controllers/config.schema';
+import { IConfigService, Injector, Plugin, UniverInstanceType } from '@univerjs/core';
+export declare class UniverSheetsDrillDownExtractionPlugin extends Plugin {
+    private readonly _config;
+    protected _injector: Injector;
+    private readonly _configService;
+    static pluginName: "UNIVER_DRILL_DOWN_EXTRACTION_PLUGIN";
+    static type: UniverInstanceType;
+    constructor(_config: IUniverDrillDownExtractionConfig | undefined, _injector: Injector, _configService: IConfigService);
+    onStarting(): void;
+    onReady(): void;
+    onSteady(): void;
+}

package/lib/types/services/suggestion-manager.service.d.ts

@@ -0,0 +1,62 @@
+import { DisposableCollection, IDisposable, IRange, Nullable } from '@univerjs/core';
+export interface ISuggestionManagerServiceParam {
+    unitId: string;
+    subUnitId: string;
+    range: IRange;
+    disposable: DisposableCollection;
+}
+export interface ISuggestManagerServiceRequestParam {
+    minInterval: number | null;
+    maxInterval: number | null;
+}
+export declare enum SuggestStateEnum {
+    CONFIG = 0,
+    REQUESTING = 1,
+    COMPLETE = 2,
+    ERROR = 3,
+    STOP = 4,
+    IDLE = 5
+}
+export declare enum OperationTypeEnum {
+    REQUEST = 0,
+    CLEAR = 1,
+    STOP = 2,
+    START = 3
+}
+export interface ISuggestionManagerOptions {
+    label: string;
+    value: string;
+    selected?: boolean;
+}
+export declare class SuggestionManagerService {
+    private _suggestionParam;
+    private _requestParam;
+    private _suggestState;
+    private _request$;
+    readonly request$: import('rxjs').Observable<SuggestStateEnum>;
+    private _operation$;
+    readonly operation$: import('rxjs').Observable<OperationTypeEnum>;
+    private _extensionInstalled;
+    constructor();
+    get extensionInstalled(): boolean;
+    get suggestState(): SuggestStateEnum;
+    dispose(): void;
+    suggest(suggestState?: SuggestStateEnum): void;
+    operation(state?: OperationTypeEnum): void;
+    isSuggesting(): boolean;
+    updateRange(range: IRange): void;
+    disposeSuggestion(): void;
+    addDisposable(disposable: IDisposable): void;
+    setRequestParam(value: Nullable<ISuggestManagerServiceRequestParam>): void;
+    setSuggestionParam(value: Nullable<ISuggestionManagerServiceParam>): void;
+    getRequestParam(): Nullable<ISuggestManagerServiceRequestParam>;
+    getSuggestionParam(): Nullable<ISuggestionManagerServiceParam>;
+    getSuggestionRange(): IRange | undefined;
+    private _hyperlinkOptions;
+    getHyperlinkOptions(): ISuggestionManagerOptions[];
+    setHyperlinkOptions(options: ISuggestionManagerOptions[]): void;
+    private _columnOptions;
+    getColumnOptions(): ISuggestionManagerOptions[];
+    setColumnOptions(options: ISuggestionManagerOptions[]): void;
+    getSelectedColumns(): number[];
+}

package/lib/types/views/components/ExtractionFieldForm.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare const ExtractionFieldForm: React.NamedExoticComponent<import('@univerjs/sheets-hyper-link-ui/services/side-panel.service.js').ICustomHyperLinkFormProps>;

package/lib/types/views/components/FloatingButton.d.ts

@@ -0,0 +1,25 @@
+import { default as React } from 'react';
+export default function DrillDownExtractionFloatingButton(): React.JSX.Element;
+interface IDrillDownExtractionColumnSelectorProps {
+    options: {
+        label: string;
+        value: string;
+    }[];
+    value: string[];
+    onChange: (value: string[]) => void;
+}
+export declare function DrillDownExtractionColumnSelector(props: IDrillDownExtractionColumnSelectorProps): React.JSX.Element;
+export declare function DrillDownExtractionFloatingHeader(): React.JSX.Element;
+export declare function DrillDownExtractionLimitationDialog(props: {
+    visible: boolean;
+    onClose?: () => void;
+    limit?: number;
+}): React.JSX.Element;
+export declare function InstallExtensionDialog(props: {
+    visible: boolean;
+    onClose?: () => void;
+}): React.JSX.Element;
+export declare function DrillDownExtractionStartFooter(props: {
+    onStart: () => void;
+}): React.JSX.Element;
+export {};