@difizen/libro-search 0.0.2-alpha.0

package/es/libro-search-protocol.d.ts

@@ -0,0 +1,176 @@
+import type { CellView } from '@difizen/libro-core';
+import type { Disposable, Event } from '@difizen/mana-app';
+import type { View } from '@difizen/mana-app';
+import { Syringe } from '@difizen/mana-app';
+/**
+ * Base search match interface
+ */
+export interface SearchMatch {
+    /**
+     * Text of the exact match itself
+     */
+    readonly text: string;
+    /**
+     * Start location of the match (in a text, this is the column)
+     */
+    position: number;
+}
+/**
+ * HTML search match interface
+ */
+export interface HTMLSearchMatch extends SearchMatch {
+    /**
+     * Node containing the match
+     */
+    readonly node: Text;
+}
+/**
+ * Filter interface
+ */
+export interface SearchFilter {
+    /**
+     * Filter title
+     */
+    title: string;
+    /**
+     * Filter description
+     */
+    description: string;
+    /**
+     * Default value
+     */
+    default: boolean;
+    /**
+     * Does the filter support replace?
+     */
+    supportReplace: boolean;
+}
+/**
+ * Type of filters
+ *
+ */
+export interface SearchFilters {
+    searchCellOutput: boolean;
+    onlySearchSelectedCells: boolean;
+}
+/**
+ * Base search provider interface
+ *
+ * #### Notes
+ * It is implemented by subprovider like searching on a single cell.
+ */
+export interface BaseSearchProvider extends Disposable {
+    /**
+     * Get an initial query value if applicable so that it can be entered
+     * into the search box as an initial query
+     *
+     * @returns Initial value used to populate the search box.
+     */
+    getInitialQuery?(): string;
+    /**
+     * Start a search
+     *
+     * @param query Regular expression to test for
+     * @param filters Filters to apply when searching
+     */
+    startQuery(query: RegExp, filters?: SearchFilters): Promise<void>;
+    /**
+     * Stop a search and clear any internal state of the provider
+     */
+    endQuery(): Promise<void>;
+    /**
+     * Clear currently highlighted match.
+     */
+    clearHighlight(): Promise<void>;
+    /**
+     * Highlight the next match
+     *
+     * @param loop Whether to loop within the matches list.
+     *
+     * @returns The next match if it exists
+     */
+    highlightNext(loop?: boolean): Promise<SearchMatch | undefined>;
+    /**
+     * Highlight the previous match
+     *
+     * @param loop Whether to loop within the matches list.
+     *
+     * @returns The previous match if it exists.
+     */
+    highlightPrevious(loop?: boolean): Promise<SearchMatch | undefined>;
+    /**
+     * Replace the currently selected match with the provided text
+     * and highlight the next match.
+     *
+     * @param newText The replacement text
+     * @param loop Whether to loop within the matches list.
+     *
+     * @returns A promise that resolves with a boolean indicating whether a replace occurred.
+     */
+    replaceCurrentMatch(newText: string, loop?: boolean): Promise<boolean>;
+    /**
+     * Replace all matches in the widget with the provided text
+     *
+     * @param newText The replacement text.
+     *
+     * @returns A promise that resolves with a boolean indicating whether a replace occurred.
+     */
+    replaceAllMatches(newText: string): Promise<boolean>;
+    /**
+     * Signal indicating that something in the search has changed, so the UI should update
+     */
+    readonly stateChanged: Event<void>;
+    /**
+     * The current index of the selected match.
+     */
+    readonly currentMatchIndex: number | undefined;
+    /**
+     * The number of matches.
+     */
+    readonly matchesCount: number | undefined;
+}
+/**
+ * Search provider interface
+ */
+export interface SearchProvider extends BaseSearchProvider {
+    /**
+     * Set to true if the widget under search is read-only, false
+     * if it is editable.  Will be used to determine whether to show
+     * the replace option.
+     */
+    readonly isReadOnly: boolean;
+    /**
+     * Get the filters definition for the given provider.
+     *
+     * @returns The filters definition.
+     *
+     * ### Notes
+     * TODO For now it only supports boolean filters (represented with checkboxes)
+     */
+    getFilters?(): Record<string, SearchFilter>;
+    /**
+     * Validate a new filter value for the widget.
+     *
+     * @param name The filter name
+     * @param value The filter value candidate
+     *
+     * @returns The valid filter value
+     */
+    validateFilter?(name: string, value: boolean): Promise<boolean>;
+}
+export interface CellSearchProvider extends BaseSearchProvider {
+    isActive: boolean;
+}
+export interface CellSearchProviderContribution {
+    canHandle: (cell: CellView) => number;
+    factory: (cell: CellView) => CellSearchProvider;
+    getInitialQuery?: (cell: CellView) => string;
+}
+export declare const CellSearchProviderContribution: Syringe.DefinedToken;
+export declare const LIBRO_SEARCH_FOUND_CLASSES: string[];
+export declare const LIBRO_SEARCH_SELECTED_CLASSES: string[];
+export interface SearchProviderOption {
+    view: View;
+}
+export declare const SearchProviderOption: unique symbol;
+//# sourceMappingURL=libro-search-protocol.d.ts.map

package/es/libro-search-protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"libro-search-protocol.d.ts","sourceRoot":"","sources":["../src/libro-search-protocol.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB;AACD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,uBAAuB,EAAE,OAAO,CAAC;CAClC;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;;;;OAKG;IACH,eAAe,CAAC,IAAI,MAAM,CAAC;IAC3B;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;IAEhE;;;;;;OAMG;IACH,iBAAiB,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;IAEpE;;;;;;;;OAQG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEvE;;;;;;OAMG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErD;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACxD;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAE5C;;;;;;;OAOG;IACH,cAAc,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACjE;AAID,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC5D,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,CAAC;IACtC,OAAO,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,kBAAkB,CAAC;IAChD,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,CAAC;CAC9C;AAED,eAAO,MAAM,8BAA8B,sBAE1C,CAAC;AAEF,eAAO,MAAM,0BAA0B,UAKtC,CAAC;AACF,eAAO,MAAM,6BAA6B,UAGzC,CAAC;AAEF,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,IAAI,CAAC;CACZ;AACD,eAAO,MAAM,oBAAoB,eAAiC,CAAC"}

package/es/libro-search-protocol.js

@@ -0,0 +1,36 @@
+import { Syringe } from '@difizen/mana-app';
+
+/**
+ * Base search match interface
+ */
+
+/**
+ * HTML search match interface
+ */
+
+/**
+ * Filter interface
+ */
+
+/**
+ * Type of filters
+ *
+ */
+
+/**
+ * Base search provider interface
+ *
+ * #### Notes
+ * It is implemented by subprovider like searching on a single cell.
+ */
+
+/**
+ * Search provider interface
+ */
+
+// export const SearchProvider = Syringe.defineToken('SearchProvider');
+
+export var CellSearchProviderContribution = Syringe.defineToken('CellSearchProviderContribution');
+export var LIBRO_SEARCH_FOUND_CLASSES = ['cm-string', 'cm-overlay', 'cm-searching', 'libro-searching'];
+export var LIBRO_SEARCH_SELECTED_CLASSES = ['CodeMirror-selectedtext', 'libro-selectedtext'];
+export var SearchProviderOption = Symbol('SearchProviderOption');

package/es/libro-search-provider.d.ts

@@ -0,0 +1,138 @@
+import type { CellView } from '@difizen/libro-core';
+import { LibroView } from '@difizen/libro-core';
+import { Deferred, DisposableCollection } from '@difizen/mana-app';
+import { AbstractSearchProvider } from './abstract-search-provider.js';
+import { LibroCellSearchProvider } from './libro-cell-search-provider.js';
+import type { CellSearchProvider, SearchFilter, SearchMatch, SearchFilters } from './libro-search-protocol.js';
+import { SearchProviderOption } from './libro-search-protocol.js';
+export type LibroSearchProviderFactory = (option: SearchProviderOption) => LibroSearchProvider;
+export declare const LibroSearchProviderFactory: unique symbol;
+/**
+ * Libro view search provider
+ */
+export declare class LibroSearchProvider extends AbstractSearchProvider {
+    libroCellSearchProvider: LibroCellSearchProvider;
+    protected cellsChangeDeferred: Deferred<void> | undefined;
+    protected toDispose: DisposableCollection;
+    protected currentProviderIndex: number | undefined;
+    searchCellOutput: boolean;
+    protected onlySearchSelectedCells: boolean;
+    replaceMode: boolean;
+    protected get filters(): SearchFilters;
+    protected query: RegExp | undefined;
+    protected searchProviders: (CellSearchProvider | undefined)[];
+    protected providerMap: Map<string, CellSearchProvider>;
+    protected documentHasChanged: boolean;
+    protected view: LibroView;
+    updateSearchCellOutput(value: boolean): void;
+    /**
+     * @param option Provide the view to search in
+     */
+    constructor(option: SearchProviderOption);
+    protected getProvider: (cell: CellView) => CellSearchProvider | undefined;
+    /**
+     * Report whether or not this provider has the ability to search on the given object
+     *
+     * @param domain Widget to test
+     * @returns Search ability
+     */
+    static isApplicable(domain: LibroView): domain is LibroView;
+    /**
+     * The current index of the selected match.
+     */
+    get currentMatchIndex(): number | undefined;
+    /**
+     * The number of matches.
+     */
+    get matchesCount(): number | undefined;
+    /**
+     * Set to true if the widget under search is read-only, false
+     * if it is editable.  Will be used to determine whether to show
+     * the replace option.
+     */
+    get isReadOnly(): boolean;
+    /**
+     * Dispose of the resources held by the search provider.
+     *
+     * #### Notes
+     * If the object's `dispose` method is called more than once, all
+     * calls made after the first will be a no-op.
+     *
+     * #### Undefined Behavior
+     * It is undefined behavior to use any functionality of the object
+     * after it has been disposed unless otherwise explicitly noted.
+     */
+    dispose(): void;
+    /**
+     * Get the filters for the given provider.
+     *
+     * @returns The filters.
+     */
+    getFilters(): Record<string, SearchFilter>;
+    /**
+     * Get an initial query value if applicable so that it can be entered
+     * into the search box as an initial query
+     *
+     * @returns Initial value used to populate the search box.
+     */
+    getInitialQuery: () => string;
+    /**
+     * Clear currently highlighted match.
+     */
+    clearHighlight: () => Promise<void>;
+    /**
+     * Highlight the next match.
+     *
+     * @param loop Whether to loop within the matches list.
+     *
+     * @returns The next match if available.
+     */
+    highlightNext: (loop?: boolean) => Promise<SearchMatch | undefined>;
+    /**
+     * Highlight the previous match.
+     *
+     * @param loop Whether to loop within the matches list.
+     *
+     * @returns The previous match if available.
+     */
+    highlightPrevious: (loop?: boolean) => Promise<SearchMatch | undefined>;
+    /**
+     * Search for a regular expression with optional filters.
+     *
+     * @param query A regular expression to test for
+     * @param filters Filter parameters to pass to provider
+     *
+     */
+    startQuery: (query: RegExp, _filters?: SearchFilters, highlightNext?: boolean) => Promise<void>;
+    /**
+     * Stop the search and clear all internal state.
+     */
+    endQuery: () => Promise<void>;
+    /**
+     * Replace the currently selected match with the provided text
+     *
+     * @param newText The replacement text.
+     * @param loop Whether to loop within the matches list.
+     *
+     * @returns A promise that resolves with a boolean indicating whether a replace occurred.
+     */
+    replaceCurrentMatch: (newText: string, loop?: boolean) => Promise<boolean>;
+    /**
+     * Replace all matches in the notebook with the provided text
+     *
+     * @param newText The replacement text.
+     *
+     * @returns A promise that resolves with a boolean indicating whether a replace occurred.
+     */
+    replaceAllMatches: (newText: string) => Promise<boolean>;
+    protected addCellProvider: (index: number) => void;
+    protected removeCellProvider: (index: number) => void;
+    protected doCellsChanged: () => Promise<void>;
+    protected onCellsChanged: () => Promise<void>;
+    protected getActiveIndex: () => number | undefined;
+    protected stepNext: (reverse?: boolean, loop?: boolean) => Promise<SearchMatch | undefined>;
+    protected onActiveCellChanged: () => Promise<void>;
+    protected onSearchProviderChanged: () => void;
+    protected _onSelectionChanged: () => Promise<void>;
+}
+//# sourceMappingURL=libro-search-provider.d.ts.map

package/es/libro-search-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"libro-search-provider.d.ts","sourceRoot":"","sources":["../src/libro-search-provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAGnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EACV,kBAAkB,EAClB,YAAY,EACZ,WAAW,EACX,aAAa,EACd,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE,MAAM,MAAM,0BAA0B,GAAG,CACvC,MAAM,EAAE,oBAAoB,KACzB,mBAAmB,CAAC;AACzB,eAAO,MAAM,0BAA0B,eAAuC,CAAC;AAC/E;;GAEG;AACH,qBACa,mBAAoB,SAAQ,sBAAsB;IAC5B,uBAAuB,EAAE,uBAAuB,CAAC;IAClF,SAAS,CAAC,mBAAmB,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAE1D,SAAS,CAAC,SAAS,uBAA8B;IACzC,SAAS,CAAC,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAa;IAC/D,gBAAgB,UAAQ;IACxB,SAAS,CAAC,uBAAuB,UAAS;IAC1C,WAAW,UAAS;IAE5B,SAAS,KAAK,OAAO,IAAI,aAAa,CAKrC;IAED,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAa;IACxC,SAAS,CAAC,eAAe,EAAE,CAAC,kBAAkB,GAAG,SAAS,CAAC,EAAE,CAAM;IACnE,SAAS,CAAC,WAAW,kCAAyC;IACtE,SAAS,CAAC,kBAAkB,UAAS;IACrC,UAAmB,IAAI,EAAE,SAAS,CAAC;IAEnC,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAI5C;;OAEG;gBACuC,MAAM,EAAE,oBAAoB;IAOtE,SAAS,CAAC,WAAW,SAAU,QAAQ,oCAErC;IACF;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,IAAI,SAAS;IAM3D;;OAEG;IACH,IAAa,iBAAiB,IAAI,MAAM,GAAG,SAAS,CAenD;IAED;;OAEG;IACH,IAAa,YAAY,IAAI,MAAM,GAAG,SAAS,CAU9C;IAED;;;;OAIG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;;;;;;;;OAUG;IACM,OAAO,IAAI,IAAI;IAsBxB;;;;OAIG;IACM,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IAiBnD;;;;;OAKG;IACM,eAAe,QAAO,MAAM,CAMnC;IAEF;;OAEG;IACH,cAAc,QAAa,QAAQ,IAAI,CAAC,CAKtC;IAEF;;;;;;OAMG;IACH,aAAa,sBAAwB,QAAQ,WAAW,GAAG,SAAS,CAAC,CAGnE;IAEF;;;;;;OAMG;IACH,iBAAiB,sBAAwB,QAAQ,WAAW,GAAG,SAAS,CAAC,CAGvE;IAEF;;;;;;OAMG;IACH,UAAU,UACD,MAAM,aACF,aAAa,8BAEvB,QAAQ,IAAI,CAAC,CA2Cd;IAEF;;OAEG;IACH,QAAQ,QAAa,QAAQ,IAAI,CAAC,CAShC;IAEF;;;;;;;OAOG;IACH,mBAAmB,YAAmB,MAAM,qBAAgB,QAAQ,OAAO,CAAC,CAyB1E;IAEF;;;;;;OAMG;IACH,iBAAiB,YAAmB,MAAM,KAAG,QAAQ,OAAO,CAAC,CAO3D;IAEF,SAAS,CAAC,eAAe,UAAW,MAAM,UAoBxC;IAEF,SAAS,CAAC,kBAAkB,UAAW,MAAM,UAI3C;IAEF,SAAS,CAAC,cAAc,QAAa,QAAQ,IAAI,CAAC,CAQhD;IACF,SAAS,CAAC,cAAc,QAAa,QAAQ,IAAI,CAAC,CAQhD;IAEF,SAAS,CAAC,cAAc,QAAO,MAAM,GAAG,SAAS,CAW/C;IACF,SAAS,CAAC,QAAQ,yCAGf,QAAQ,WAAW,GAAG,SAAS,CAAC,CAwEjC;IAEF,SAAS,CAAC,mBAAmB,sBAM3B;IAEF,SAAS,CAAC,uBAAuB,aAK/B;IAEF,SAAS,CAAC,mBAAmB,sBAU3B;CACH"}