@acrolinx/sidebar-interface - npm Package Compare versions

Comparing version 14.29.0-beta.5 to 14.29.0-beta.6

dist/index.d.ts

@@ -220,5 +220,6 @@ /**
     selection: boolean;
+    batchCheck: boolean;
 }
 export interface BatchCheckRequestOptions {
-    reference: string;
+    documentIdentifier: string;
     displayName: string;
@@ -447,20 +448,15 @@ }
      */
-    checkGlobal(documentContent: string, options: CheckOptions): Check | Promise<Check | void>;
+    checkGlobal(documentContent: string, options: CheckOptions): Check;
     /**
      * Inits a check for a bunch of files that runs in the background
-     * @param references
+     * @param documentIdentifiers
      */
-    initBatchCheck?(references: BatchCheckRequestOptions[]): void;
+    initBatchCheck?(documentIdentifiers: BatchCheckRequestOptions[]): void;
     /**
      * Experimental for Dita Checking
-     * @param reference
+     * @param documentIdentifier
      * @param documentContent
      * @param options
      */
-    checkReferenceInBackground?(reference: string, documentContent: string, options: CheckOptions): void;
-    /**
-     * Experimental for Dita Checking
-     * @param reference
-     */
-    onReferenceLoadedInEditor?(reference: string): void;
+    checkDocumentInBackground?(documentIdentifier: string, documentContent: string, options: CheckOptions): void;
     onGlobalCheckRejected(): void;
@@ -509,16 +505,15 @@ /**
     /**
-     * Experimental for Dita Checking
-     * @param reference
+     * A batch check has started and the AcrolinxPlugin is requested to call AcrolinxSidebar.checkDocumentInBackground()
+     * for the document under check.
+     *
+     * @param documentIdentifier
      */
-    requestBackgroundCheckForRef?(reference: string): void;
+    requestBackgroundCheckForDocument?(documentIdentifier: string): void;
     /**
-     * Experimental for Dita Checking
-     * @param reference
+     * A batch check has started and the user has clicked on a card. The AcrolinxPlugin is requested to open the corresponding document.
+     *
+     * @param documentIdentifier
      */
-    openReferenceInEditor?(reference: string): void | Promise<void>;
+    openDocumentInEditor?(documentIdentifier: string): void | Promise<void>;
     /**
-     * Experimental for Dita Checking
-     */
-    openMapInEditor?(): void;
-    /**
      * Notifies the AcrolinxPlugin that a check has finished. If a global check has been performed, that's a good time
@@ -525,0 +520,0 @@ * to clean up states belonging to previous checks.

package.json

 {
   "name": "@acrolinx/sidebar-interface",
   "description": "The interface of the Acrolinx Sidebar",
-  "version": "14.29.0-beta.5",
+  "version": "14.29.0-beta.6",
   "license": "Apache-2.0",
@@ -6,0 +6,0 @@ "author": "Acrolinx",

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

39808

increased by0.25%

Worsened metrics

Lines of code

624

decreased by-0.79%

No dependency changes