@acrolinx/sidebar-interface - npm Package Compare versions

Comparing version 15.0.0 to 15.1.0

dist/index.d.ts

 /**
- * This document describes the interface of the Acrolinx Sidebar with Batch checks. Batch checks are supported from sidebar version 15.0.0.
+ * This document describes the interface of the Acrolinx Sidebar. Batch checking feature is only supported from sidebar version 15.0 and Core Platform version 2021.12.
  *
@@ -26,21 +26,21 @@ * Let's understand how the typical bootstrapping of an integration and the Acrolinx Sidebar works:
  *
- * 10) If the user pushes the button "Check" or "Batch Check", {@link AcrolinxPlugin.requestGlobalCheck|requestGlobalCheck} is called.
- *     In case of a batch check, the flag batchCheck in options is set to true.
+ * 8) If the user pushes the button "Check" or "Batch Check", {@link AcrolinxPlugin.requestGlobalCheck|requestGlobalCheck} is called.
+ *     In case of a batch check, the flag {@link RequestGlobalCheckOptions.batchCheck|batchCheck} in options is set to true.
  *
- * 11) The acrolinxPlugin must call {@link AcrolinxSidebar.checkGlobal|checkGlobal} to perform a check
- *     or {@link AcrolinxSidebar.initBatchCheck|initBatchCheck} with a list of document identifiers to perform a batch check.
+ * 9) The acrolinxPlugin must call {@link AcrolinxSidebar.checkGlobal|checkGlobal} to perform a check.
+ *    In case of a batch check, the acrolinxPlugin must call  {@link AcrolinxSidebar.initBatchCheck|initBatchCheck} with a list of document identifiers to be checked.
  *
- * 12) When the check finished, {@link AcrolinxPlugin.onCheckResult|onCheckResult} is called and the sidebar displays
+ * 10) When a regular check has finished, {@link AcrolinxPlugin.onCheckResult|onCheckResult} is called and the sidebar displays
  * cards for the issues.
  *
- * 13) If the user clicks a card {@link AcrolinxPlugin.selectRanges|selectRanges} is called
+ * 11) If the user clicks a card after a regular check, {@link AcrolinxPlugin.selectRanges|selectRanges} is called
  *
- * 14) When the user selects a replacement {@link AcrolinxPlugin.replaceRanges|replaceRanges} is called.
+ * 12) When the user selects a replacement after a regular check, {@link AcrolinxPlugin.replaceRanges|replaceRanges} is called.
  *
- * 15) In case of a batch check, the sidebar will request the integration to initiate a check for each document identifier
+ * 13) When a batch check is started, the sidebar will request the integration to initiate a check for each document identifier
  *     by calling {@link AcrolinxPlugin.requestCheckForDocumentInBatch|requestCheckForDocumentInBatch}.
  *
- * 16) The acrolinxPlugin must call {@link AcrolinxSidebar.checkDocumentInBatch|checkDocumentInBatch} to perform a check on a given document.
+ * 14) The acrolinxPlugin must then call {@link AcrolinxSidebar.checkDocumentInBatch|checkDocumentInBatch} to perform a check on a given document.
  *
- * 17) If the user clicks a card {@link AcrolinxPlugin.openDocumentInEditor} is called.
+ * 15) If the user clicks a card after the batch check has started, {@link AcrolinxPlugin.openDocumentInEditor|openDocumentInEditor} is called requesting acrolinxPlugin to open the document.
  *
@@ -283,2 +283,3 @@ * For a minimal integration (not feature complete) you must implement {@link requestInit}, {@link requestGlobalCheck},
     ditaReferences?: ExternalContentField[];
+    xincludeReferences?: ExternalContentField[];
 }
@@ -461,11 +462,11 @@ /**
      * Perform a batch check of the document components.
-     * @param documentIdentifiers
+     * @param documentIdentifiers List of document identifiers on which to perfrom a batch check.
      */
     initBatchCheck?(documentIdentifiers: BatchCheckRequestOptions[]): void;
     /**
-     * Initiates a check for the document with the given documentIdentifier.
+     * Initiates a check for the document with the given document identifier.
      *
-     * @param documentIdentifier
-     * @param documentContent
-     * @param options
+     * @param documentIdentifier Identifier for the document to be checked.
+     * @param documentContent The document to be checked.
+     * @param options Check options.
      */
@@ -521,3 +522,3 @@ checkDocumentInBatch?(documentIdentifier: string, documentContent: string, options: CheckOptions): void;
      *
-     * @param documentIdentifier
+     * @param documentIdentifier Identifier of the document to be checked.
      */
@@ -528,3 +529,3 @@ requestCheckForDocumentInBatch?(documentIdentifier: string): void;
      *
-     * @param documentIdentifier
+     * @param documentIdentifier Identifier of the document to open.
      */
@@ -531,0 +532,0 @@ openDocumentInEditor?(documentIdentifier: string): void | Promise<void>;

package.json

 {
   "name": "@acrolinx/sidebar-interface",
   "description": "The interface of the Acrolinx Sidebar",
-  "version": "15.0.0",
+  "version": "15.1.0",
   "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

41340

increased by1.37%

Lines of code

637

increased by0.16%

No dependency changes