@acrolinx/sdk - npm Package Compare versions

Comparing version 0.1.2-build.1211 to 0.1.3-build.1271

CONTRIBUTING.md

@@ -7,11 +7,11 @@ # Contributing to this SDK
 
-2. To successfully run the integration tests you need to setup local environment variables:
+2. To successfully run the integration tests you need to set up local environment variables:
 
     |Key|Description|
     |---|-----------|
-    TEST_SERVER_URL|Acrolinx Server URL to connect|
-    SSO_USERNAME|Username for Single Sign On request
-    SSO_GENERIC_TOKEN|Single Sign On Token
+    TEST_SERVER_URL|Acrolinx URL to connect|
+    SSO_USERNAME|Username for single sign-on request
+    SSO_GENERIC_TOKEN|Single sign-on Token
     ACROLINX_API_TOKEN|API Token for specified username (ACROLINX_API_USERNAME)
-    ACROLINX_API_USERNAME|Username to log in to Acrolinx server|
+    ACROLINX_API_USERNAME|Username to sign in to Acrolinx Platform|
     </br>
@@ -25,7 +25,9 @@
     ```
+
     Also run the same command before pushing your changes to repository.
 
 4. To run tests locally you can run the command
-    ```
+
+    ```bash
     npm run test
     ```

dist/src/check.d.ts

 import { Addon, AddonId } from './addons';
-import { CheckType, ContentEncoding, ContentFormatId, Goal, GoalId, GuidanceProfileId, ReportType } from './capabilities';
+import { CheckType, ContentEncoding, ContentFormatId, Goal, GoalId, GoalScoring, GuidanceProfileId, ReportType } from './capabilities';
 import { AsyncApiResponse, AsyncStartedProcessLinks, LanguageId, SuccessResponse, URL } from './common-types';
@@ -163,2 +163,7 @@ import { DictionaryScope } from './dictionary';
     issueType: IssueType;
+    /**
+     * Since Acrolinx platform 2021.4
+     * Only available if the server runs in Targets mode.
+     */
+    scoring?: GoalScoring;
 }
@@ -165,0 +170,0 @@ export interface PositionalInformation {

dist/test/schemas/check-result.json

@@ -168,2 +168,10 @@ {
                 },
+                "scoring": {
+                    "description": "Since Acrolinx platform 2021.4\nOnly available if the server runs in Targets mode.",
+                    "enum": [
+                        "recommended",
+                        "required"
+                    ],
+                    "type": "string"
+                },
                 "subIssues": {
@@ -413,2 +421,10 @@ "items": {
                 },
+                "scoring": {
+                    "description": "Since Acrolinx platform 2021.4\nOnly available if the server runs in Targets mode.",
+                    "enum": [
+                        "recommended",
+                        "required"
+                    ],
+                    "type": "string"
+                },
                 "subIssues": {
@@ -415,0 +431,0 @@ "items": {

package.json

 {
   "name": "@acrolinx/sdk",
-  "version": "0.1.2-build.1211",
+  "version": "0.1.3-build.1271",
   "description": "Acrolinx JavaScript SDK for the Acrolinx API",
@@ -5,0 +5,0 @@ "license": "Apache-2.0",

src/check.ts

@@ -23,3 +23,3 @@ /*
   Goal,
-  GoalId,
+  GoalId, GoalScoring,
   GuidanceProfileId,
@@ -231,2 +231,8 @@ ReportType,
   issueType: IssueType;
+
+  /**
+   * Since Acrolinx platform 2021.4
+   * Only available if the server runs in Targets mode.
+   */
+  scoring?: GoalScoring
 }
@@ -233,0 +239,0 @@

No alert changes

Improved metrics

Total package byte prevSize

539442

increased by0.18%

Lines of code

10524

increased by0.25%

No dependency changes