@acrolinx/sidebar-interface - npm Package Compare versions

Comparing version 15.2.0 to 15.3.0

dist/index.d.ts

@@ -134,2 +134,3 @@ /**
         supportsBatchChecks?: boolean;
+        supportsLive?: boolean;
         /**
@@ -172,3 +173,3 @@ * Tells the Sidebar, that this integration supports AcrolinxPlugin.log
 }
-export declare type UiMode = 'default' | 'noOptions';
+export type UiMode = 'default' | 'noOptions';
 export interface CsrfConfig {
@@ -265,3 +266,3 @@ url: string;
 }
-export declare type DocumentRange = [number, number];
+export type DocumentRange = [number, number];
 /**
@@ -338,4 +339,4 @@ * Each {@link checkGlobal} call will return an unique id, which helps the plugin to map results,
 }
-export declare type InvalidDocumentPart = CheckedDocumentPart;
-export declare type CheckedDocumentRange = CheckedDocumentPart;
+export type InvalidDocumentPart = CheckedDocumentPart;
+export type CheckedDocumentRange = CheckedDocumentPart;
 export interface Match {
@@ -430,2 +431,10 @@ content: string;
 }
+export interface LiveSuggestion {
+    preferredPhrase: string;
+    description: string;
+}
+export interface LiveSearchResult {
+    requestId: string;
+    results: LiveSuggestion[];
+}
 /**
@@ -513,2 +522,7 @@ * The sidebar will provide this interface in window.acrolinxSidebar.
     showMessage(message: Message): void;
+    /**
+     * Perform a search for suggestions with the given query .
+     * @param query The query on which to perform a search for suggestions.
+     */
+    liveSearch?(query: string): void;
 }
@@ -601,2 +615,26 @@ /**
     log?(logEntry: LogEntry): void;
+    /**
+   * Notifies the AcrolinxPlugin that a live search has finished.
+   * @param liveSearchResult  The live search result.
+   */
+    onLiveSearchResults?(liveSearchResult: LiveSearchResult): void;
+    /**
+    * Notifies the AcrolinxPlugin that live search for an input query has failed.
+    * @param query  The query on which the search has failed.
+    */
+    onLiveSearchFailed?(query: string): void;
+    /**
+    * the user has clicked on the button to open live panel. The AcrolinxPlugin is requested to open the live panel.
+    */
+    openLivePanel?(): void;
+    /**
+    * Notifies the AcrolinxPlugin that the user has changed the UI langauge in the sidebar.
+    * @param UILanguage   The selected UI language
+    */
+    onUILanguageChanged?(UILanguage: string): void;
+    /**
+    * Notifies the AcrolinxPlugin that the user has selected a target that supports live.
+    * @param supportsLive   True if the selected target supports live, false otherwise.
+    */
+    onTargetChanged?(supportsLive: boolean): void;
 }
@@ -603,0 +641,0 @@ /**

package.json

 {
   "name": "@acrolinx/sidebar-interface",
   "description": "The interface of the Acrolinx Sidebar",
-  "version": "15.2.0",
+  "version": "15.3.0",
   "license": "Apache-2.0",
@@ -22,7 +22,7 @@ "author": "Acrolinx",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.13.0",
-    "@typescript-eslint/parser": "^4.13.0",
-    "eslint": "^7.17.0",
-    "typedoc": "^0.19.2",
-    "typescript": "^4.1.3"
+    "@typescript-eslint/eslint-plugin": "^5.45.0",
+    "@typescript-eslint/parser": "^5.45.0",
+    "eslint": "^8.29.0",
+    "typedoc": "^0.23.21",
+    "typescript": "^4.8.4"
   },
@@ -29,0 +29,0 @@ "scripts": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

43220

increased by3.34%

Lines of code

692

increased by5.81%

No dependency changes