Updated to version 20.11 (#10)

Documentation and code samples updated

Author: Denis-Averin

Makefile

@@ -6,8 +6,12 @@ format:
 	./scripts/docs_format.sh
 	npm run format
 
+.PHONY: clean
+clean:
+	npm run clean
+
 .PHONY: build
-build:
+build: clean
 	npm run build
 
 .PHONY: test
@@ -27,6 +31,7 @@ update_modules:
 	npm run check-updates
 	npm update
 	npm outdated
+	npm run prepare
 
 .PHONY: check_git
 check_git:

README.md

@@ -1,13 +1,13 @@
 # Aspose.BarCode Cloud SDK for Node.js
 
 + API version: 3.0
-+ Package version: 20.10.0
++ Package version: 20.11.0
 
 Aspose.BarCode for Cloud is a REST API for Linear, 2D and postal barcode generation and recognition in the cloud. API recognizes and generates barcode images in a variety of formats. Barcode REST API allows to specify barcode image attributes like image width, height, border style and output image format in order to customize the generation process. Developers can also specify the barcode type and text attributes such as text location and font styles in order to suit the application requirements.
 
 This repository contains Aspose.BarCode Cloud SDK for Node.js source code.
 
-To use these SDKs, you will need App SID and App Key which can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) (free registration in Aspose Cloud is required for this).
+To use these SDKs, you will need Client Id and Client Secret which can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/applications) (free registration in Aspose Cloud is required for this).
 
 ## How to use the SDK
 
@@ -30,8 +30,8 @@ const fs = require('fs');
 const Barcode = require('aspose-barcode-cloud-node');
 
 const config = new Barcode.Configuration(
-    'App SID from https://dashboard.aspose.cloud/#/apps',
-    'App Key from https://dashboard.aspose.cloud/#/apps'
+    'Client Id from https://dashboard.aspose.cloud/applications',
+    'Client Secret from https://dashboard.aspose.cloud/applications'
 );
 
 async function generate(api) {

example.js

@@ -2,8 +2,8 @@
 const Barcode = require('aspose-barcode-cloud-node');
 
 const config = new Barcode.Configuration(
-    'App SID from https://dashboard.aspose.cloud/#/apps',
-    'App Key from https://dashboard.aspose.cloud/#/apps'
+    'Client Id from https://dashboard.aspose.cloud/applications',
+    'Client Secret from https://dashboard.aspose.cloud/applications'
 );
 
 async function generate(api) {

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "aspose-barcode-cloud-node",
-  "version": "20.10.0",
+  "version": "20.11.0",
   "description": "Aspose.BarCode Cloud SDK for Node.js",
   "homepage": "https://products.aspose.cloud/barcode/nodejs",
   "repository": {
@@ -29,7 +29,7 @@
     "lint": "tsc --strict",
     "format": "tsdx lint --fix",
     "prepare": "tsdx build --target=node",
-    "clear": "rm dist/* || DEL /S /Q dist",
+    "clean": "rm dist/* ; rm built/* || true",
     "check-updates": "ncu -u"
   },
   "peerDependencies": {},

package.json

@@ -38,14 +38,14 @@ export class Configuration {
     public authentication: Authentication;
 
     /**
-     * App SID.
+     * Client Id.
      */
-    public appSID: string;
+    public clientId: string;
 
     /**
-     * App key.
+     * Client Secret.
      */
-    public appKey: string;
+    public clientSecret: string;
 
     /**
      * Base Url.
@@ -55,9 +55,9 @@ export class Configuration {
     readonly version: ApiVersion = ApiVersion.v3;
     readonly accessToken: string;
 
-    constructor(appSID: string, appKey: string, baseUrl?: string, accessToken?: string) {
-        this.appSID = appSID;
-        this.appKey = appKey;
+    constructor(clientId: string, clientSecret: string, baseUrl?: string, accessToken?: string) {
+        this.clientId = clientId;
+        this.clientSecret = clientSecret;
         if (baseUrl) {
             this.baseUrl = baseUrl;
         } else {

src/Configuration.ts

@@ -32,10 +32,10 @@ export class JWTAuth implements Authentication {
     }
 
     public async applyUnauthorized(): Promise<void> {
-        if (this._configuration.appSID && this._configuration.appKey) {
+        if (this._configuration.clientId && this._configuration.clientSecret) {
             await this.requestToken();
         } else {
-            throw new Error("Required 'appSID' or 'appKey' not specified in configuration.");
+            throw new Error("Required 'clientId' or 'clientSecret' not specified in configuration.");
         }
     }
 
@@ -46,8 +46,8 @@ export class JWTAuth implements Authentication {
             uri: this._configuration.baseUrl + '/connect/token',
             form: {
                 grant_type: 'client_credentials',
-                client_id: this._configuration.appSID,
-                client_secret: this._configuration.appKey,
+                client_id: this._configuration.clientId,
+                client_secret: this._configuration.clientSecret,
             },
         };
 

src/JWTAuth.ts

@@ -1,4 +1,4 @@
 {
-    "appSID": "App SID from https://dashboard.aspose.cloud/#/apps",
-    "appKey": "App Key from https://dashboard.aspose.cloud/#/apps"
+    "clientId": "Client Id from https://dashboard.aspose.cloud/applications",
+    "clientSecret": "Client Secret from https://dashboard.aspose.cloud/applications"
 }

test/configuration.example.json

@@ -7,8 +7,8 @@ describe('LoadConfigurationFromFile', () => {
     it('should return Configuration', () => {
         const config: Configuration = LoadConfigurationFromFile('./test/configuration.example.json');
 
-        assert.strictEqual(config.appSID, 'App SID from https://dashboard.aspose.cloud/#/apps');
-        assert.strictEqual(config.appKey, 'App Key from https://dashboard.aspose.cloud/#/apps');
+        assert.strictEqual(config.clientId, 'Client Id from https://dashboard.aspose.cloud/applications');
+        assert.strictEqual(config.clientSecret, 'Client Secret from https://dashboard.aspose.cloud/applications');
         assert.strictEqual(config.baseUrl, 'https://api.aspose.cloud');
     });
 });
@@ -17,8 +17,8 @@ describe('LoadConfigurationFromEnv', () => {
     it('should return Configuration', () => {
         const config = LoadConfigurationFromEnv();
 
-        assert.ok(config.hasOwnProperty('appSID'));
-        assert.ok(config.hasOwnProperty('appKey'));
+        assert.ok(config.hasOwnProperty('clientId'));
+        assert.ok(config.hasOwnProperty('clientSecret'));
         assert.ok(config.hasOwnProperty('baseUrl'));
     });
 });
@@ -27,8 +27,8 @@ describe('LoadTestConfiguration', () => {
     it('should load something', () => {
         const config = LoadTestConfiguration();
 
-        assert.ok(config.hasOwnProperty('appSID'));
-        assert.ok(config.hasOwnProperty('appKey'));
+        assert.ok(config.hasOwnProperty('clientId'));
+        assert.ok(config.hasOwnProperty('clientSecret'));
         assert.ok(config.hasOwnProperty('baseUrl'));
     });
 });

test/configuration.test.ts

@@ -6,20 +6,20 @@ export function LoadConfigurationFromFile(filename: string): Configuration {
     const text: string = fs.readFileSync(filename, 'utf-8');
     const json = JSON.parse(text);
 
-    return new Configuration(json.appSID, json.appKey, json.baseUrl, json.accessToken);
+    return new Configuration(json.clientId, json.clientSecret, json.baseUrl, json.accessToken);
 }
 
 export function LoadConfigurationFromEnv(prefix?: string): Configuration {
     if (!prefix) {
         prefix = 'TEST_CONFIGURATION_';
     }
 
-    const appSID = process.env[prefix + 'APP_SID'];
-    const appKey = process.env[prefix + 'APP_KEY'];
+    const clientId = process.env[prefix + 'CLIENT_ID'];
+    const clientSecret = process.env[prefix + 'CLIENT_SECRET'];
     const baseUrl = process.env[prefix + 'BASE_URL'];
     const accessToken = process.env[prefix + 'ACCESS_TOKEN'];
 
-    return new Configuration(appSID, appKey, baseUrl, accessToken);
+    return new Configuration(clientId, clientSecret, baseUrl, accessToken);
 }
 
 export function LoadTestConfiguration(): Configuration {