Move node-cli to be pure ESM, use Conf for persistent storage

change/@itwin-node-cli-authorization-cd9b1e0d-dbd2-4a0a-8305-caef61275076.json

@@ -0,0 +1,7 @@
+{
+  "type": "major",
+  "comment": "Move from cjs to esm and use Conf",
+  "packageName": "@itwin/node-cli-authorization",
+  "email": "50554904+hl662@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}

packages/node-cli/package.json

@@ -1,22 +1,26 @@
 {
   "name": "@itwin/node-cli-authorization",
   "version": "1.0.1",
-  "main": "lib/cjs/index.js",
-  "types": "lib/cjs/index.d.ts",
+  "type": "module",
   "description": "Node.js command-line authorization client for iTwin platform",
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
-    "build": "npm run -s build:cjs",
-    "build:cjs": "tsc 1>&2 --outDir lib/cjs && npm run copy:assets",
-    "copy:assets": "cpx src/static/* lib/cjs/static",
+    "build": "npm run -s build:esm",
+    "build:esm": "tsc 1>&2 --outDir lib/esm && npm run copy:assets",
+    "copy:assets": "cpx src/static/* lib/esm/static",
     "clean": "rimraf lib",
     "docs": "RUSHSTACK_FILE_ERROR_BASE_FOLDER='../..' betools docs --includes=../../generated-docs/extract --json=../../generated-docs/auth-clients/node-cli-authorization/file.json --tsIndexFile=./index.ts --onlyJson",
     "lint": "eslint -f visualstudio \"./src/**/*.ts\" 1>&2",
     "lint:fix": "npm run lint -- --fix",
-    "test": "mocha \"./lib/cjs/test/**/*.test.js\"",
+    "test": "mocha \"./lib/esm/test/**/*.test.js\"",
     "cover": "nyc npm test",
     "pack": "npm pack",
     "rebuild": "npm run clean && npm run build"
   },
+  "exports": "./lib/esm/index.js",
+    "typings": "./lib/esm/index.d.ts",
   "author": {
     "name": "Bentley Systems, Inc.",
     "url": "http://www.bentley.com"
@@ -28,20 +32,19 @@
     "directory": "packages/node-cli"
   },
   "dependencies": {
-    "@itwin/core-common": "^3.3.0 || ^4.0.0",
+    "@itwin/core-common": "^4.0.0",
     "@openid/appauth": "^1.3.1",
-    "node-persist": "^3.1.3",
+    "conf": "^11.0.2",
     "open": "^8.3.0",
     "username": "^5.1.0"
   },
   "devDependencies": {
     "@itwin/build-tools": "^4.0.0-dev.93",
-    "@itwin/core-bentley": "^3.7.0",
+    "@itwin/core-bentley": "^4.0.0",
     "@itwin/eslint-plugin": "^3.7.0",
     "@types/chai-as-promised": "^7.1.1",
     "@types/chai": "^4.2.22",
     "@types/mocha": "^8.2.3",
-    "@types/node-persist": "^3.1.3",
     "@types/node": "^18.11.5",
     "@types/sinon": "^10.0.16",
     "chai-as-promised": "^7.1.1",
@@ -56,7 +59,7 @@
     "typescript": "~5.0.2"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "^3.3.0 || ^4.0.0"
+    "@itwin/core-bentley": "^4.0.0"
   },
   "eslintConfig": {
     "plugins": [

packages/node-cli/src/Client.ts

@@ -11,15 +11,15 @@
 import { readFileSync } from "fs";
 import * as path from "path";
 import * as Http from "http";
-import * as open from "open";
+import open from "open";
 import { assert, BeEvent, BentleyError, Logger } from "@itwin/core-bentley";
 import {
   AuthorizationError, AuthorizationNotifier, AuthorizationRequest, AuthorizationRequestHandler, AuthorizationResponse,
   AuthorizationServiceConfiguration, BaseTokenRequestHandler, BasicQueryStringUtils, GRANT_TYPE_AUTHORIZATION_CODE, GRANT_TYPE_REFRESH_TOKEN,
   TokenRequest,
 } from "@openid/appauth";
-import { NodeCrypto, NodeRequestor } from "@openid/appauth/built/node_support";
-import { TokenStore } from "./TokenStore";
+import { NodeCrypto, NodeRequestor } from "@openid/appauth/built/node_support/index.js";
+import { TokenStore } from "./TokenStore.js";
 
 import type { AccessToken } from "@itwin/core-bentley";
 import type { AuthorizationClient } from "@itwin/core-common";
@@ -152,8 +152,6 @@ export class NodeCliAuthorizationClient implements AuthorizationClient {
     // Would ideally set up in constructor, but async...
     if (!this._configuration)
       this._configuration = await AuthorizationServiceConfiguration.fetchFromIssuer(this._bakedConfig.issuerUrl, new NodeRequestor());
-
-    await this._tokenStore.initialize();
   }
 
   private async loadAndRefreshAccessToken() {

packages/node-cli/src/TokenStore.ts

@@ -3,22 +3,25 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 
-import * as OperatingSystemUserName from "username";
 import type { TokenResponseJson } from "@openid/appauth";
+import OperatingSystemUserName from "username";
 import { TokenResponse } from "@openid/appauth";
 import { createCipheriv, createDecipheriv, randomBytes, scryptSync } from "node:crypto";
-import * as path from "node:path";
-import * as NodePersist from "node-persist";
+import Conf from "conf";
 
 type CacheEntry = TokenResponseJson & {scopesForCacheValidation?: string};
+interface ConfEntry {
+  encryptedCache: string;
+  iv: string;
+}
 /**
  * Utility to store OIDC AppAuth in secure storage
  * @internal
  */
 export class TokenStore {
   private readonly _appStorageKey: string;
   private readonly _scopes: string;
-  private readonly _store: NodePersist.LocalStorage;
+  private readonly _store: Conf;
   public constructor(namedArgs: {clientId: string, issuerUrl: string, scopes: string}, dir?: string) {
     // A stored credential is only valid for a combination of the clientId, the issuing authority and the requested scopes.
     // We make the storage key a combination of clientId and issuing authority so that keys can stay cached when switching
@@ -29,14 +32,25 @@ export class TokenStore {
       .replace(/[.]/g, "%2E") // Replace all '.' with URL Percent-encoding representation
       .replace(/[\/]/g, "%2F"); // Replace all '/' with URL Percent-encoding representation;
     this._scopes = namedArgs.scopes;
-    this._store = NodePersist.create({
-      dir: dir ?? path.join(process.cwd(), ".configStore"), // specifies storage file path.
-    });
-  }
 
-  public async initialize(): Promise<void> {
-    await this._store.init();
+    let confConfig: object = {
+      configName: configFileName, // specifies storage file name.
+      encryptionKey: "iTwin", // obfuscates the storage file's content, in case a user finds the file and wants to modify it.
+    };
+    if (dir) {
+      confConfig = {
+        ...confConfig,
+        cwd: dir, // specifies the directory that contains the storage file.
+      };
+    } else {
+      confConfig = {
+        ...confConfig,
+        projectName: configFileName, // specifies the directory that contains the storage file.
+      };
+    }
+    this._store = new Conf(confConfig);
   }
+
   private _userName?: string;
   private async getUserName(): Promise<string | undefined> {
     if (!this._userName)
@@ -60,7 +74,7 @@ export class TokenStore {
    * Uses node's native `crypto` module to encrypt the given cache entry.
    * @returns an object containing a hexadecimal encoded token, returned as a string, as well as the initialization vector.
    */
-  private encryptCache(cacheEntry: CacheEntry): {encryptedCache: string, iv: string} {
+  private encryptCache(cacheEntry: CacheEntry): ConfEntry {
     const iv = randomBytes(16);
     const cipher = createCipheriv("aes-256-cbc", this.generateCipherKey(), iv);
 
@@ -86,18 +100,17 @@ export class TokenStore {
       return undefined;
 
     const key = await this.getKey();
-    const storeKeys = await this._store.keys();
-    if (!storeKeys.includes(key)) {
+    if (!this._store.has(key)) {
       return undefined;
     }
-    const storedObj = await this._store.getItem(key);
+    const storedObj = this._store.get(key) as ConfEntry;
     const encryptedCache = storedObj.encryptedCache;
     const iv = storedObj.iv;
     const cacheEntry = this.decryptCache(encryptedCache, Buffer.from(iv, "hex"));
     // Only reuse token if matching scopes. Don't include cache data for TokenResponse object.
     const tokenResponseObj = JSON.parse(cacheEntry) as CacheEntry;
     if (tokenResponseObj?.scopesForCacheValidation !== this._scopes) {
-      await this._store.removeItem(key);
+      this._store.delete(key);
       return undefined;
     }
     delete tokenResponseObj.scopesForCacheValidation;
@@ -124,6 +137,6 @@ export class TokenStore {
     };
     const objToStore = this.encryptCache(cacheEntry);
     const key = await this.getKey();
-    await this._store.setItem(key, objToStore);
+    this._store.set(key, objToStore);
   }
 }

packages/node-cli/src/index.ts

@@ -2,7 +2,7 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
-export * from "./Client";
+export * from "./Client.js";
 
 /** @docs-package-description
  * Provides auth functionality for node command-line applications.

packages/node-cli/src/test/Client.test.ts

@@ -3,21 +3,21 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 
-import * as chai from "chai";
-import * as chaiAsPromised from "chai-as-promised";
+import { expect, use } from "chai";
+import chaiAsPromised = require("chai-as-promised");
 
-import { BakedAuthorizationConfiguration } from "../Client";
-import type { NodeCliAuthorizationConfiguration } from "../Client";
+import { BakedAuthorizationConfiguration } from "../Client.js";
+import type { NodeCliAuthorizationConfiguration } from "../Client.js";
 
-chai.use(chaiAsPromised);
+use(chaiAsPromised);
 
 describe("NodeCliAuthorizationConfiguration defaults", () => {
   it("should throw if clientId is an empty string", () => {
-    chai.expect(() => new BakedAuthorizationConfiguration({ clientId: "", scope: "testScope" })).to.throw();
+    expect(() => new BakedAuthorizationConfiguration({ clientId: "", scope: "testScope" })).to.throw();
   });
 
   it("should throw if scope is an empty string", () => {
-    chai.expect(() => new BakedAuthorizationConfiguration({ clientId: "testClientId", scope: "" })).to.throw();
+    expect(() => new BakedAuthorizationConfiguration({ clientId: "testClientId", scope: "" })).to.throw();
   });
 });
 
@@ -31,31 +31,31 @@ describe("NodeCliAuthorizationConfiguration Authority URL Logic", () => {
   it("should use config authority without prefix", async () => {
     process.env.IMJS_URL_PREFIX = "";
     const bakedConfig = new BakedAuthorizationConfiguration({ ...config, issuerUrl: testAuthority });
-    chai.expect(bakedConfig.issuerUrl).equals(testAuthority);
+    expect(bakedConfig.issuerUrl).equals(testAuthority);
   });
 
   it("should use config authority and ignore prefix", async () => {
     process.env.IMJS_URL_PREFIX = "prefix-";
     const bakedConfig = new BakedAuthorizationConfiguration({ ...config, issuerUrl: testAuthority });
-    chai.expect(bakedConfig.issuerUrl).equals("https://test.authority.com");
+    expect(bakedConfig.issuerUrl).equals("https://test.authority.com");
   });
 
   it("should use default authority without prefix ", async () => {
     process.env.IMJS_URL_PREFIX = "";
     const bakedConfig = new BakedAuthorizationConfiguration(config);
-    chai.expect(bakedConfig.issuerUrl).equals("https://ims.bentley.com");
+    expect(bakedConfig.issuerUrl).equals("https://ims.bentley.com");
   });
 
   it("should use default authority with prefix ", async () => {
     process.env.IMJS_URL_PREFIX = "prefix-";
     const bakedConfig = new BakedAuthorizationConfiguration(config);
-    chai.expect(bakedConfig.issuerUrl).equals("https://prefix-ims.bentley.com");
+    expect(bakedConfig.issuerUrl).equals("https://prefix-ims.bentley.com");
   });
 
   it("should reroute dev prefix to qa if on default ", async () => {
     process.env.IMJS_URL_PREFIX = "dev-";
     const bakedConfig = new BakedAuthorizationConfiguration(config);
-    chai.expect(bakedConfig.issuerUrl).equals("https://qa-ims.bentley.com");
+    expect(bakedConfig.issuerUrl).equals("https://qa-ims.bentley.com");
   });
 });
 
@@ -67,15 +67,15 @@ describe("NodeCliAuthorizationConfiguration Config Scope Logic", () => {
 
   it("Should add offline_access scope", async () => {
     const bakedConfig = new BakedAuthorizationConfiguration(config);
-    chai.expect(bakedConfig.scopes).equals(`${config.scope} offline_access`);
+    expect(bakedConfig.scopes).equals(`${config.scope} offline_access`);
   });
 
   it("Should not add offline_access scope", async () => {
     const bakedConfig = new BakedAuthorizationConfiguration({
       clientId: "testClientId",
       scope: "testScope offline_access",
     });
-    chai.expect(bakedConfig.scopes).equals("testScope offline_access");
+    expect(bakedConfig.scopes).equals("testScope offline_access");
   });
 });
 

packages/node-cli/src/test/TokenStore.test.ts

@@ -1,10 +1,10 @@
 import { TokenResponse } from "@openid/appauth";
-import * as chai from "chai";
-import * as chaiAsPromised from "chai-as-promised";
-import { TokenStore } from "../TokenStore";
+import { assert, expect, use } from "chai";
+import chaiAsPromised = require("chai-as-promised");
+import { TokenStore } from "../TokenStore.js";
 import { rmSync } from "fs";
-import * as sinon from "sinon";
-chai.use(chaiAsPromised);
+import { spy } from "sinon";
+use(chaiAsPromised);
 
 describe("TokenStore", () => {
   let tokenStore: TokenStore;
@@ -20,7 +20,6 @@ describe("TokenStore", () => {
       issuerUrl: "https://testUrl.com",
       scopes: "testScope1 testScope2",
     }, `${process.cwd()}/testConfig`);
-    await tokenStore.initialize();
   });
 
   afterEach(() => {
@@ -31,9 +30,9 @@ describe("TokenStore", () => {
     if (process.platform === "linux")
       return;
 
-    const saveSpy = sinon.spy(tokenStore as any, "encryptCache");
+    const saveSpy = spy(tokenStore as any, "encryptCache");
     await tokenStore.save(testTokenResponse);
-    chai.assert.isTrue(saveSpy.calledOnce);
+    assert.isTrue(saveSpy.calledOnce);
   });
 
   it("should decrypt cache on load", async () => {
@@ -43,7 +42,7 @@ describe("TokenStore", () => {
     await tokenStore.save(testTokenResponse);
 
     const retrievedToken = await tokenStore.load();
-    chai.expect(retrievedToken!.refreshToken).equals(testTokenResponse.refreshToken);
+    expect(retrievedToken!.refreshToken).equals(testTokenResponse.refreshToken);
   });
 
   it("load() should return undefined when scopes are mismatched", async () => {
@@ -57,9 +56,8 @@ describe("TokenStore", () => {
       issuerUrl: "https://testUrl.com",
       scopes: "testScope1 testScope2 testScope3",
     }, `${process.cwd()}/testConfig`);
-    await tokenStore2.initialize();
 
     const retrievedToken = await tokenStore2.load();
-    chai.expect(retrievedToken).to.be.undefined;
+    expect(retrievedToken).to.be.undefined;
   });
 });

packages/node-cli/tsconfig.json

@@ -1,8 +1,9 @@
 {
   "extends": "./node_modules/@itwin/build-tools/tsconfig-base.json",
   "compilerOptions": {
-    "target": "es2021",
-    "module": "commonjs",
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
     "outDir": "./lib"
   },
   "include": [