@appsemble/node-utils 0.20.8 → 0.20.11

package/interceptors.test.js

@@ -0,0 +1,93 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fake_timers_1 = require("@sinonjs/fake-timers");
+const axios_1 = __importDefault(require("axios"));
+const axios_mock_adapter_1 = __importDefault(require("axios-mock-adapter"));
+const cli_highlight_1 = require("cli-highlight");
+const form_data_1 = __importDefault(require("form-data"));
+const _1 = require(".");
+function h(content) {
+    return (0, cli_highlight_1.highlight)(content, { language: 'http' });
+}
+let instance;
+let mock;
+let clock;
+jest.mock('os');
+beforeEach(() => {
+    clock = (0, fake_timers_1.install)();
+});
+afterEach(() => {
+    clock.uninstall();
+});
+describe('formData', () => {
+    beforeAll(() => {
+        instance = axios_1.default.create();
+        instance.interceptors.request.use(_1.formData);
+        mock = new axios_mock_adapter_1.default(instance);
+    });
+    it('should add headers for form-data requests', async () => {
+        let headers;
+        mock.onAny('/').reply((config) => {
+            ({ headers } = config);
+            return [200];
+        });
+        const form = new form_data_1.default();
+        await instance.post('/', form);
+        expect(headers).toHaveProperty('Content-Type', expect.stringMatching(/^multipart\/form-data; boundary=/));
+    });
+    it('should not add headers to non form-data requests', async () => {
+        let headers;
+        mock.onAny('/').reply((config) => {
+            ({ headers } = config);
+            return [200];
+        });
+        await instance.post('/', {});
+        expect(headers).toBeUndefined();
+    });
+});
+describe('requestLogger', () => {
+    beforeAll(() => {
+        instance = axios_1.default.create();
+        instance.interceptors.request.use(_1.requestLogger);
+        mock = new axios_mock_adapter_1.default(instance);
+        mock.onAny().reply(200);
+    });
+    it('should log requests', async () => {
+        jest.spyOn(_1.logger, 'verbose');
+        await instance.get('/');
+        expect(_1.logger.verbose).toHaveBeenCalledWith(`> 0 ${h('GET / HTTP/1.1')}`);
+    });
+});
+describe('responseLogger', () => {
+    beforeAll(() => {
+        instance = axios_1.default.create();
+        instance.interceptors.response.use(_1.responseLogger);
+        mock = new axios_mock_adapter_1.default(instance);
+        mock.onAny().reply(200);
+    });
+    it('should log responses', async () => {
+        jest.spyOn(_1.logger, 'verbose');
+        await instance.get('/');
+        expect(_1.logger.verbose).toHaveBeenCalledWith(expect.any(String));
+    });
+});
+describe('configureAxios', () => {
+    beforeEach(() => {
+        jest.spyOn(axios_1.default.interceptors.request, 'use').mockImplementation();
+        jest.spyOn(axios_1.default.interceptors.response, 'use').mockImplementation();
+    });
+    it('should set the correct user agent', () => {
+        (0, _1.configureAxios)('TestClient', '1.2.3');
+        expect(axios_1.default.defaults.headers.common['user-agent']).toBe(`TestClient/1.2.3 (Linux x64; Node ${process.version})`);
+    });
+    it('should apply all interceptors', () => {
+        (0, _1.configureAxios)('TestClient', '1.2.3');
+        expect(axios_1.default.interceptors.request.use).toHaveBeenCalledWith(_1.formData);
+        expect(axios_1.default.interceptors.request.use).toHaveBeenCalledWith(_1.requestLogger);
+        expect(axios_1.default.interceptors.response.use).toHaveBeenCalledWith(_1.responseLogger);
+    });
+});
+//# sourceMappingURL=interceptors.test.js.map

package/interceptors.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interceptors.test.js","sourceRoot":"","sources":["interceptors.test.ts"],"names":[],"mappings":";;;;;AAAA,sDAA+D;AAC/D,kDAA6C;AAC7C,4EAA6C;AAC7C,iDAA0C;AAC1C,0DAAiC;AAEjC,wBAAoF;AAEpF,SAAS,CAAC,CAAC,OAAe;IACxB,OAAO,IAAA,yBAAS,EAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;AAClD,CAAC;AAED,IAAI,QAAuB,CAAC;AAC5B,IAAI,IAAiB,CAAC;AACtB,IAAI,KAAqB,CAAC;AAE1B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEhB,UAAU,CAAC,GAAG,EAAE;IACd,KAAK,GAAG,IAAA,qBAAO,GAAE,CAAC;AACpB,CAAC,CAAC,CAAC;AAEH,SAAS,CAAC,GAAG,EAAE;IACb,KAAK,CAAC,SAAS,EAAE,CAAC;AACpB,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,GAAG,eAAK,CAAC,MAAM,EAAE,CAAC;QAC1B,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,WAAQ,CAAC,CAAC;QAC5C,IAAI,GAAG,IAAI,4BAAW,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,IAAI,OAAO,CAAC;QACZ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;YAC/B,CAAC,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,CAAC;YACvB,OAAO,CAAC,GAAG,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAC5B,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC/B,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAC5B,cAAc,EACd,MAAM,CAAC,cAAc,CAAC,kCAAkC,CAAC,CAC1D,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,IAAI,OAAO,CAAC;QACZ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;YAC/B,CAAC,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,CAAC;YACvB,OAAO,CAAC,GAAG,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QACH,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC7B,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,CAAC;IAClC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,GAAG,eAAK,CAAC,MAAM,EAAE,CAAC;QAC1B,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAa,CAAC,CAAC;QACjD,IAAI,GAAG,IAAI,4BAAW,CAAC,QAAQ,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACnC,IAAI,CAAC,KAAK,CAAC,SAAM,EAAE,SAAS,CAAC,CAAC;QAC9B,MAAM,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxB,MAAM,CAAC,SAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,GAAG,eAAK,CAAC,MAAM,EAAE,CAAC;QAC1B,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,iBAAc,CAAC,CAAC;QACnD,IAAI,GAAG,IAAI,4BAAW,CAAC,QAAQ,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACpC,IAAI,CAAC,KAAK,CAAC,SAAM,EAAE,SAAS,CAAC,CAAC;QAC9B,MAAM,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxB,MAAM,CAAC,SAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,KAAK,CAAC,eAAK,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,kBAAkB,EAAE,CAAC;QACnE,IAAI,CAAC,KAAK,CAAC,eAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,IAAA,iBAAc,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACtC,MAAM,CAAC,eAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CACtD,qCAAqC,OAAO,CAAC,OAAO,GAAG,CACxD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,IAAA,iBAAc,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACtC,MAAM,CAAC,eAAK,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,WAAQ,CAAC,CAAC;QACtE,MAAM,CAAC,eAAK,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,gBAAa,CAAC,CAAC;QAC3E,MAAM,CAAC,eAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,iBAAc,CAAC,CAAC;IAC/E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/interceptors.test.ts

@@ -0,0 +1,108 @@
+import { install, InstalledClock } from '@sinonjs/fake-timers';
+import axios, { AxiosInstance } from 'axios';
+import MockAdapter from 'axios-mock-adapter';
+import { highlight } from 'cli-highlight';
+import FormData from 'form-data';
+
+import { configureAxios, formData, logger, requestLogger, responseLogger } from '.';
+
+function h(content: string): string {
+  return highlight(content, { language: 'http' });
+}
+
+let instance: AxiosInstance;
+let mock: MockAdapter;
+let clock: InstalledClock;
+
+jest.mock('os');
+
+beforeEach(() => {
+  clock = install();
+});
+
+afterEach(() => {
+  clock.uninstall();
+});
+
+describe('formData', () => {
+  beforeAll(() => {
+    instance = axios.create();
+    instance.interceptors.request.use(formData);
+    mock = new MockAdapter(instance);
+  });
+
+  it('should add headers for form-data requests', async () => {
+    let headers;
+    mock.onAny('/').reply((config) => {
+      ({ headers } = config);
+      return [200];
+    });
+    const form = new FormData();
+    await instance.post('/', form);
+    expect(headers).toHaveProperty(
+      'Content-Type',
+      expect.stringMatching(/^multipart\/form-data; boundary=/),
+    );
+  });
+
+  it('should not add headers to non form-data requests', async () => {
+    let headers;
+    mock.onAny('/').reply((config) => {
+      ({ headers } = config);
+      return [200];
+    });
+    await instance.post('/', {});
+    expect(headers).toBeUndefined();
+  });
+});
+
+describe('requestLogger', () => {
+  beforeAll(() => {
+    instance = axios.create();
+    instance.interceptors.request.use(requestLogger);
+    mock = new MockAdapter(instance);
+    mock.onAny().reply(200);
+  });
+
+  it('should log requests', async () => {
+    jest.spyOn(logger, 'verbose');
+    await instance.get('/');
+    expect(logger.verbose).toHaveBeenCalledWith(`> 0 ${h('GET / HTTP/1.1')}`);
+  });
+});
+
+describe('responseLogger', () => {
+  beforeAll(() => {
+    instance = axios.create();
+    instance.interceptors.response.use(responseLogger);
+    mock = new MockAdapter(instance);
+    mock.onAny().reply(200);
+  });
+
+  it('should log responses', async () => {
+    jest.spyOn(logger, 'verbose');
+    await instance.get('/');
+    expect(logger.verbose).toHaveBeenCalledWith(expect.any(String));
+  });
+});
+
+describe('configureAxios', () => {
+  beforeEach(() => {
+    jest.spyOn(axios.interceptors.request, 'use').mockImplementation();
+    jest.spyOn(axios.interceptors.response, 'use').mockImplementation();
+  });
+
+  it('should set the correct user agent', () => {
+    configureAxios('TestClient', '1.2.3');
+    expect(axios.defaults.headers.common['user-agent']).toBe(
+      `TestClient/1.2.3 (Linux x64; Node ${process.version})`,
+    );
+  });
+
+  it('should apply all interceptors', () => {
+    configureAxios('TestClient', '1.2.3');
+    expect(axios.interceptors.request.use).toHaveBeenCalledWith(formData);
+    expect(axios.interceptors.request.use).toHaveBeenCalledWith(requestLogger);
+    expect(axios.interceptors.response.use).toHaveBeenCalledWith(responseLogger);
+  });
+});

package/interceptors.ts

@@ -0,0 +1,81 @@
+import { arch, type } from 'os';
+
+import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { highlight } from 'cli-highlight';
+import FormData from 'form-data';
+
+import { logger } from './logger';
+
+/**
+ * This is used to set a request id, so the request and response can be matched in the logs.
+ */
+const id = Symbol('id');
+
+declare module 'axios' {
+  interface AxiosRequestConfig {
+    [id]?: number;
+  }
+}
+
+/**
+ * An {@link axios} request interceptor to add support for {@link form-data}.
+ *
+ * @param config The axios request configuration.
+ * @returns The config with additional `multipart/form-data` headers if appropriate.
+ */
+export function formData(config: AxiosRequestConfig): AxiosRequestConfig {
+  if (config.data instanceof FormData) {
+    Object.assign(config.headers, config.data.getHeaders());
+  }
+  return config;
+}
+
+/**
+ * An {@link axios} request interceptor to log requests.
+ *
+ * @param config The axios request configuration.
+ * @returns The original config.
+ */
+export function requestLogger(config: AxiosRequestConfig): AxiosRequestConfig {
+  const time = Date.now();
+  logger.verbose(
+    `> ${time} ${highlight(`${config.method.toUpperCase()} ${axios.getUri(config)} HTTP/1.1`, {
+      language: 'http',
+    })}`,
+  );
+  // eslint-disable-next-line no-param-reassign
+  config[id] = time;
+  return config;
+}
+
+/**
+ * An {@link axios} response interceptor to log responses.
+ *
+ * @param response The axios response.
+ * @returns The original response.
+ */
+export function responseLogger(response: AxiosResponse): AxiosResponse {
+  logger.verbose(
+    `< ${response.config[id]} ${highlight(`HTTP/1.1 ${response.status} ${response.statusText}`, {
+      language: 'http',
+    })}`,
+  );
+  return response;
+}
+
+/**
+ * Configure the default Axios instance.
+ *
+ * This applies the interceptors in this modules and sets the appropriate user agent string.
+ *
+ * @param name A PascalCase representation of the client.
+ * @param version The version of the client to represent.
+ */
+export function configureAxios(name: string, version: string): void {
+  const ua = `${name}/${version} (${type()} ${arch()}; Node ${process.version})`;
+  axios.defaults.headers.common['user-agent'] = ua;
+
+  axios.interceptors.request.use(formData);
+  axios.interceptors.request.use(requestLogger);
+  axios.interceptors.response.use(responseLogger);
+}

package/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('../../config/jest/config')(__dirname);

package/jest.setup.d.ts

@@ -0,0 +1 @@
+export {};

package/jest.setup.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Importing a module here will break mocks for that module. Only add imports from `./src/*` here
+// that are strictly necessary.
+const logger_1 = require("./logger");
+const testFixtures_1 = require("./testFixtures");
+(0, testFixtures_1.setFixtureBase)(__dirname);
+(0, logger_1.setLogLevel)(0);
+//# sourceMappingURL=jest.setup.js.map

package/jest.setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.setup.js","sourceRoot":"","sources":["jest.setup.ts"],"names":[],"mappings":";;AAAA,iGAAiG;AACjG,+BAA+B;AAC/B,qCAAuC;AACvC,iDAAgD;AAEhD,IAAA,6BAAc,EAAC,SAAS,CAAC,CAAC;AAC1B,IAAA,oBAAW,EAAC,CAAC,CAAC,CAAC"}

package/jest.setup.ts

@@ -0,0 +1,7 @@
+// Importing a module here will break mocks for that module. Only add imports from `./src/*` here
+// that are strictly necessary.
+import { setLogLevel } from './logger';
+import { setFixtureBase } from './testFixtures';
+
+setFixtureBase(__dirname);
+setLogLevel(0);

package/{dist/logger.d.ts → logger.d.ts}

@@ -16,7 +16,7 @@ export declare const logger: winston.Logger;
 /**
  * Set the logging level using a string or numeric value.
  *
- * @param level - The logger level to set.
+ * @param level The logger level to set.
  */
 export declare function setLogLevel(level?: number | string): void;
 /**
@@ -24,7 +24,7 @@ export declare function setLogLevel(level?: number | string): void;
  *
  * Use this in conjunction with `yargs`.
  *
- * @param argv - The processed command line arguments.
+ * @param argv The processed command line arguments.
  */
 export declare function configureLogger({ quiet, verbose }: ConfigureLoggerParams): void;
 export {};

package/{dist/logger.js → logger.js}

@@ -7,7 +7,7 @@ exports.configureLogger = exports.setLogLevel = exports.logger = void 0;
 const os_1 = require("os");
 const util_1 = require("util");
 const axios_1 = __importDefault(require("axios"));
-const chalk_1 = require("chalk");
+const chalk_1 = __importDefault(require("chalk"));
 const cli_highlight_1 = require("cli-highlight");
 const winston_1 = __importDefault(require("winston"));
 const levels = ['crit', 'error', 'warn', 'info', 'verbose', 'silly'];
@@ -20,7 +20,7 @@ function httpErrorToString(error) {
     var _a, _b, _c;
     const { config, request, response } = error;
     return [
-        chalk_1.blue.bold('Request:'),
+        chalk_1.default.blue.bold('Request:'),
         (0, cli_highlight_1.highlight)([
             `${config.method.toUpperCase()} ${axios_1.default.getUri(config)} HTTP/${(_b = (_a = request.res) === null || _a === void 0 ? void 0 : _a.httpVersion) !== null && _b !== void 0 ? _b : '1.1'}`,
             ...Object.entries(config.headers)
@@ -29,7 +29,7 @@ function httpErrorToString(error) {
                 .sort(),
         ].join(os_1.EOL), { language: 'http', ignoreIllegals: true }),
         '',
-        chalk_1.blue.bold('Response:'),
+        chalk_1.default.blue.bold('Response:'),
         response
             ? (0, cli_highlight_1.highlight)([
                 `HTTP/${(_c = request.res) === null || _c === void 0 ? void 0 : _c.httpVersion} ${response.status} ${response.statusText}`,
@@ -41,7 +41,7 @@ function httpErrorToString(error) {
                     ? JSON.stringify(response.data, null, 2)
                     : response.data,
             ].join(os_1.EOL), { language: 'http', ignoreIllegals: true })
-            : chalk_1.red.bold('No response from server'),
+            : chalk_1.default.red.bold('No response from server'),
     ].join(os_1.EOL);
 }
 function toString(info) {
@@ -73,7 +73,7 @@ exports.logger = winston_1.default.createLogger({
 /**
  * Set the logging level using a string or numeric value.
  *
- * @param level - The logger level to set.
+ * @param level The logger level to set.
  */
 function setLogLevel(level = DEFAULT_LEVEL) {
     exports.logger.level = Number.isNaN(Number(level))
@@ -87,7 +87,7 @@ exports.setLogLevel = setLogLevel;
  *
  * Use this in conjunction with `yargs`.
  *
- * @param argv - The processed command line arguments.
+ * @param argv The processed command line arguments.
  */
 function configureLogger({ quiet = 0, verbose = 0 }) {
     process.on('warning', (warning) => {

package/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["logger.ts"],"names":[],"mappings":";;;;;;AAAA,2BAAyB;AACzB,+BAA+B;AAE/B,kDAA0C;AAC1C,kDAA0B;AAC1B,iDAA0C;AAE1C,sDAA8B;AAc9B,MAAM,MAAM,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAU,CAAC;AAC9E,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;AAEhE,SAAS,UAAU,CAAC,MAAc;IAChC,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAC5D,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAiB;;IAC1C,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IAC5C,OAAO;QACL,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;QAC3B,IAAA,yBAAS,EACP;YACE,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,eAAK,CAAC,MAAM,CAAC,MAAM,CAAC,SACpD,MAAA,MAAA,OAAO,CAAC,GAAG,0CAAE,WAAW,mCAAI,KAC9B,EAAE;YACF,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;iBAC9B,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;iBAC/C,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,GAAG,KAAK,eAAe,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;iBAClF,IAAI,EAAE;SACV,CAAC,IAAI,CAAC,QAAG,CAAC,EACX,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,CAC3C;QACD,EAAE;QACF,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;QAC5B,QAAQ;YACN,CAAC,CAAC,IAAA,yBAAS,EACP;gBACE,QAAQ,MAAA,OAAO,CAAC,GAAG,0CAAE,WAAW,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE;gBAC5E,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;qBAChC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC;qBACrD,IAAI,EAAE;gBACT,EAAE;gBACF,QAAQ,CAAC,IAAI,YAAY,MAAM;oBAC7B,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;oBACxC,CAAC,CAAC,QAAQ,CAAC,IAAI;aAClB,CAAC,IAAI,CAAC,QAAG,CAAC,EACX,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,CAC3C;YACH,CAAC,CAAC,eAAK,CAAC,GAAG,CAAC,IAAI,CAAC,yBAAyB,CAAC;KAC9C,CAAC,IAAI,CAAC,QAAG,CAAC,CAAC;AACd,CAAC;AAED,SAAS,QAAQ,CAAC,IAAuB;IACvC,IAAI,IAAI,YAAY,KAAK,EAAE;QACzB,IAAI,eAAK,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;YAC5B,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;SAChC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;KACnB;IACD,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC;KACrB;IACD,OAAO,IAAA,cAAO,EAAC,IAAI,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AACjD,CAAC;AAED;;GAEG;AACU,QAAA,MAAM,GAAG,iBAAO,CAAC,YAAY,CAAC;IACzC,KAAK,EAAE,MAAM,CAAC,aAAa,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IACxE,MAAM,EAAE,iBAAO,CAAC,MAAM,CAAC,OAAO,CAC5B,iBAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACxB,GAAG,IAAI;QACP,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC;aAClB,KAAK,CAAC,OAAO,CAAC;aACd,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC;KACrE,CAAC,CAAC,EAAE,EACL,iBAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,EACzB,iBAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,qBAAqB,EAAE,CAAC,EAC3D,iBAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,CACpD,KAAK,CAAC,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,GAAG,SAAS,KAAK,KAAK,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,QAAG,CAAC,CAC1E,CACF;IACD,UAAU,EAAE,CAAC,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;CAC/C,CAAC,CAAC;AAEH;;;;GAIG;AACH,SAAgB,WAAW,CAAC,QAAyB,aAAa;IAChE,cAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC,CAAE,KAAgB;QACnB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAe,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACtE,cAAM,CAAC,KAAK,CAAC,wBAAwB,cAAM,CAAC,KAAK,EAAE,CAAC,CAAC;AACvD,CAAC;AALD,kCAKC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC,EAAyB;IAC/E,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;QAChC,cAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE;QACzC,cAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,WAAW,CAAC,aAAa,GAAG,OAAO,GAAG,KAAK,CAAC,CAAC;AAC/C,CAAC;AAVD,0CAUC"}

package/logger.test.d.ts

@@ -0,0 +1 @@
+export {};

package/logger.test.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("./logger");
+describe('setLogLevel', () => {
+    afterEach(() => {
+        (0, logger_1.setLogLevel)();
+    });
+    it('should set the level of the exported logger based on a string', () => {
+        (0, logger_1.setLogLevel)('verbose');
+        expect(logger_1.logger.level).toBe('verbose');
+    });
+    it('should set the level of the exported logger based on a number', () => {
+        (0, logger_1.setLogLevel)(1);
+        expect(logger_1.logger.level).toBe('error');
+    });
+    it('should set the level of the exported logger based on a numeric string', () => {
+        (0, logger_1.setLogLevel)('2');
+        expect(logger_1.logger.level).toBe('warn');
+    });
+});
+describe('configureLogger', () => {
+    afterEach(() => {
+        (0, logger_1.setLogLevel)();
+    });
+    it('should configure a log level based on the quiet count of the argv', () => {
+        (0, logger_1.configureLogger)({ quiet: 1 });
+        expect(logger_1.logger.level).toBe('warn');
+    });
+    it('should configure a log level based on the verbose count of the argv', () => {
+        (0, logger_1.configureLogger)({ verbose: 1 });
+        expect(logger_1.logger.level).toBe('verbose');
+    });
+    it('should configure a log level based on the combined quiet and verbose count', () => {
+        (0, logger_1.configureLogger)({ quiet: 1, verbose: 1 });
+        expect(logger_1.logger.level).toBe('info');
+    });
+});
+//# sourceMappingURL=logger.test.js.map

package/logger.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.test.js","sourceRoot":"","sources":["logger.test.ts"],"names":[],"mappings":";;AAAA,qCAAgE;AAEhE,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,SAAS,CAAC,GAAG,EAAE;QACb,IAAA,oBAAW,GAAE,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,IAAA,oBAAW,EAAC,SAAS,CAAC,CAAC;QACvB,MAAM,CAAC,eAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,IAAA,oBAAW,EAAC,CAAC,CAAC,CAAC;QACf,MAAM,CAAC,eAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC/E,IAAA,oBAAW,EAAC,GAAG,CAAC,CAAC;QACjB,MAAM,CAAC,eAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,SAAS,CAAC,GAAG,EAAE;QACb,IAAA,oBAAW,GAAE,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAC3E,IAAA,wBAAe,EAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC9B,MAAM,CAAC,eAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC7E,IAAA,wBAAe,EAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;QAChC,MAAM,CAAC,eAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,GAAG,EAAE;QACpF,IAAA,wBAAe,EAAC,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;QAC1C,MAAM,CAAC,eAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/logger.test.ts

@@ -0,0 +1,43 @@
+import { configureLogger, logger, setLogLevel } from './logger';
+
+describe('setLogLevel', () => {
+  afterEach(() => {
+    setLogLevel();
+  });
+
+  it('should set the level of the exported logger based on a string', () => {
+    setLogLevel('verbose');
+    expect(logger.level).toBe('verbose');
+  });
+
+  it('should set the level of the exported logger based on a number', () => {
+    setLogLevel(1);
+    expect(logger.level).toBe('error');
+  });
+
+  it('should set the level of the exported logger based on a numeric string', () => {
+    setLogLevel('2');
+    expect(logger.level).toBe('warn');
+  });
+});
+
+describe('configureLogger', () => {
+  afterEach(() => {
+    setLogLevel();
+  });
+
+  it('should configure a log level based on the quiet count of the argv', () => {
+    configureLogger({ quiet: 1 });
+    expect(logger.level).toBe('warn');
+  });
+
+  it('should configure a log level based on the verbose count of the argv', () => {
+    configureLogger({ verbose: 1 });
+    expect(logger.level).toBe('verbose');
+  });
+
+  it('should configure a log level based on the combined quiet and verbose count', () => {
+    configureLogger({ quiet: 1, verbose: 1 });
+    expect(logger.level).toBe('info');
+  });
+});

package/logger.ts

@@ -0,0 +1,130 @@
+import { EOL } from 'os';
+import { inspect } from 'util';
+
+import axios, { AxiosError } from 'axios';
+import chalk from 'chalk';
+import { highlight } from 'cli-highlight';
+import { TransformableInfo } from 'logform';
+import winston from 'winston';
+
+interface ConfigureLoggerParams {
+  /**
+   * The negative verbosity count.
+   */
+  quiet?: number;
+
+  /**
+   * The verbosity count.
+   */
+  verbose?: number;
+}
+
+const levels = ['crit', 'error', 'warn', 'info', 'verbose', 'silly'] as const;
+const DEFAULT_LEVEL = levels.indexOf('info');
+const padding = Math.max(...levels.map(({ length }) => length));
+
+function headerCase(header: string): string {
+  return header.replace(/(^|-)\w/g, (a) => a.toUpperCase());
+}
+
+function httpErrorToString(error: AxiosError): string {
+  const { config, request, response } = error;
+  return [
+    chalk.blue.bold('Request:'),
+    highlight(
+      [
+        `${config.method.toUpperCase()} ${axios.getUri(config)} HTTP/${
+          request.res?.httpVersion ?? '1.1'
+        }`,
+        ...Object.entries(config.headers)
+          .map(([key, value]) => [headerCase(key), value])
+          .map(([key, value]) => `${key}: ${key === 'Authorization' ? 'xxxxxxxxxx' : value}`)
+          .sort(),
+      ].join(EOL),
+      { language: 'http', ignoreIllegals: true },
+    ),
+    '',
+    chalk.blue.bold('Response:'),
+    response
+      ? highlight(
+          [
+            `HTTP/${request.res?.httpVersion} ${response.status} ${response.statusText}`,
+            ...Object.entries(response.headers)
+              .map(([key, value]) => `${headerCase(key)}: ${value}`)
+              .sort(),
+            '',
+            response.data instanceof Object
+              ? JSON.stringify(response.data, null, 2)
+              : response.data,
+          ].join(EOL),
+          { language: 'http', ignoreIllegals: true },
+        )
+      : chalk.red.bold('No response from server'),
+  ].join(EOL);
+}
+
+function toString(info: TransformableInfo): string {
+  if (info instanceof Error) {
+    if (axios.isAxiosError(info)) {
+      return httpErrorToString(info);
+    }
+    return info.stack;
+  }
+  if (typeof info.message === 'string') {
+    return info.message;
+  }
+  return inspect(info.message, { colors: true });
+}
+
+/**
+ * The default logger for NodeJS Appsemble projects.
+ */
+export const logger = winston.createLogger({
+  level: levels[DEFAULT_LEVEL],
+  levels: Object.fromEntries(levels.map((level, index) => [level, index])),
+  format: winston.format.combine(
+    winston.format((info) => ({
+      ...info,
+      lines: toString(info)
+        .split(/\r?\n/)
+        .map((line) => `${''.padEnd(padding - info.level.length)}${line}`),
+    }))(),
+    winston.format.colorize(),
+    winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
+    winston.format.printf(({ level, lines, timestamp }) =>
+      lines.map((line: string) => `${timestamp} [${level}]: ${line}`).join(EOL),
+    ),
+  ),
+  transports: [new winston.transports.Console()],
+});
+
+/**
+ * Set the logging level using a string or numeric value.
+ *
+ * @param level The logger level to set.
+ */
+export function setLogLevel(level: number | string = DEFAULT_LEVEL): void {
+  logger.level = Number.isNaN(Number(level))
+    ? (level as string)
+    : levels[Math.min(Math.max(level as number, 0), levels.length - 1)];
+  logger.silly(`Logging level set to ${logger.level}`);
+}
+
+/**
+ * Configure logging using named quiet and verbose parameters.
+ *
+ * Use this in conjunction with `yargs`.
+ *
+ * @param argv The processed command line arguments.
+ */
+export function configureLogger({ quiet = 0, verbose = 0 }: ConfigureLoggerParams): void {
+  process.on('warning', (warning) => {
+    logger.warn(warning);
+  });
+
+  process.on('unhandledRejection', (error) => {
+    logger.error(error);
+  });
+
+  setLogLevel(DEFAULT_LEVEL + verbose - quiet);
+}