@autofleet/settings 1.0.1 → 1.0.2

package/dist/index.d.ts

@@ -1 +1,32 @@
-export {};
+/// <reference types="node" />
+import NodeCache from 'node-cache';
+import EventEmitter from 'events';
+interface SettingsClassOptions {
+    serviceUrl?: string;
+    ttl?: number;
+}
+declare type SettingValue = string | boolean | number | never;
+interface Label {
+    businessModelId?: string;
+    demandSourceId?: string;
+    fleetId?: string;
+}
+declare type LabelsArray = Label[];
+interface GetSettingOption {
+    timeout?: number;
+    rejectOnFail?: boolean;
+}
+declare class SettingsManager {
+    ttl: number;
+    settingsCache: NodeCache;
+    networkEvents: EventEmitter;
+    network: any;
+    NEVER_DEFAULT_VALUE: string;
+    static get NEVER_DEFAULT_VALUE(): string;
+    static readNetworkValue(networkValue: SettingValue, defaultValue: SettingValue): string | number | boolean;
+    constructor({ serviceUrl, ttl }?: SettingsClassOptions);
+    get(key: SettingValue, defaultValue?: SettingValue, labels?: LabelsArray, { timeout, rejectOnFail }?: GetSettingOption): Promise<unknown>;
+    setLocal(key: string, labels: LabelsArray, value: SettingValue): void;
+    flush(): void;
+}
+export default SettingsManager;

package/dist/index.js

@@ -109,4 +109,4 @@ class SettingsManager {
         return this.settingsCache.flushAll();
     }
 }
-module.exports = SettingsManager;
+exports.default = SettingsManager;

package/dist/index.test.d.ts

@@ -1,4 +1 @@
-declare const nock: any;
-declare const Settings: any;
-declare const serviceUrl = "localhost:8085";
-declare const mockSetting: (key: string, value: string | boolean | number | never, labels?: any, response?: number) => any;
+export {};

package/dist/index.test.js

@@ -8,8 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = __importDefault(require("./index"));
 const nock = require('nock');
-const Settings = require('./index');
 process.env.NODE_ENV = 'node-common-test';
 const serviceUrl = 'localhost:8085';
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -21,20 +25,20 @@ const mockSetting = (key, value, labels = undefined, response = 200) => {
 };
 describe('Settings', () => {
     it('Throws exeption if there is no defualt value', () => __awaiter(void 0, void 0, void 0, function* () {
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         expect(settings.get('key1'))
             .rejects.toEqual(new Error('Can\'t get a key without defaultValue'));
     }));
     it('Can get 0 as default value', () => __awaiter(void 0, void 0, void 0, function* () {
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         expect(yield settings.get('key1', 0)).toBe(0);
     }));
     it('Can get false as default value', () => __awaiter(void 0, void 0, void 0, function* () {
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         expect(yield settings.get('key1', false)).toBe(false);
@@ -42,7 +46,7 @@ describe('Settings', () => {
     it('Uses env.SETTING_MS_SERVICE_HOST as service host if no one defined', () => __awaiter(void 0, void 0, void 0, function* () {
         const m = mockSetting('key1', 'value1');
         process.env.SETTING_MS_SERVICE_HOST = serviceUrl;
-        const settings = new Settings();
+        const settings = new index_1.default();
         const value = yield settings.get('key1', 'dv');
         expect(value).toEqual('value1');
         expect(m.isDone()).toBeTruthy();
@@ -50,7 +54,7 @@ describe('Settings', () => {
     }));
     it('Get a key from server', () => __awaiter(void 0, void 0, void 0, function* () {
         const m = mockSetting('key1', 'value1');
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         const value = yield settings.get('key1', 'dv');
@@ -59,7 +63,7 @@ describe('Settings', () => {
     }));
     it('Cache from server', () => __awaiter(void 0, void 0, void 0, function* () {
         const m = mockSetting('key1', 'value1');
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         const value = yield settings.get('key1', 'dv');
@@ -70,7 +74,7 @@ describe('Settings', () => {
     }));
     it('Use only one request for similar keys', () => __awaiter(void 0, void 0, void 0, function* () {
         const m = mockSetting('key1EM', 'value1EM');
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         const [value, value2] = yield Promise.all([
@@ -84,7 +88,7 @@ describe('Settings', () => {
     it('Finds with labels', () => __awaiter(void 0, void 0, void 0, function* () {
         const labels = [{ fleetId: 'uuid' }];
         const m = mockSetting('key1', 'value1', labels);
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         const value = yield settings.get('key1', 'dv', labels);
@@ -92,14 +96,14 @@ describe('Settings', () => {
         expect(m.isDone()).toBeTruthy();
     }));
     it('Returns default value when network error', () => __awaiter(void 0, void 0, void 0, function* () {
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         const value = yield settings.get('key1', 'dv', [{ fleetId: 'uuid' }]);
         expect(value).toEqual('dv');
     }));
     it('Throws an error if network error and no default value', () => __awaiter(void 0, void 0, void 0, function* () {
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         const f = () => settings.get('key1', settings.NEVER_DEFAULT_VALUE, [{ fleetId: 'uuid' }]);
@@ -107,7 +111,7 @@ describe('Settings', () => {
             .rejects.toEqual(new Error('Cannot find value from network or cache, default value is set to never'));
     }));
     it('Throws an error if network error and no default value and success the next time', (done) => __awaiter(void 0, void 0, void 0, function* () {
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         const f = () => settings.get('key1', settings.NEVER_DEFAULT_VALUE);
@@ -122,7 +126,7 @@ describe('Settings', () => {
     }));
     it('Values can be flushed', () => __awaiter(void 0, void 0, void 0, function* () {
         const m1 = mockSetting('key1', 'value1');
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         settings.flush();
@@ -137,7 +141,7 @@ describe('Settings', () => {
     }));
     it('when NODE_ENV === test return the default value', () => __awaiter(void 0, void 0, void 0, function* () {
         process.env.NODE_ENV = 'test';
-        const settings = new Settings({
+        const settings = new index_1.default({
             serviceUrl: `http://${serviceUrl}/`,
         });
         const value = yield settings.get('key1', 'dv');

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@autofleet/settings",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
     "start": "ts-node  src/index.ts",
     "example": "ts-node  src/example.ts",
-    "prepublish": "tsc",
+    "build": "tsc",
+    "prepublish": "npm run build",
     "linter": "./node_modules/.bin/eslint .",
     "test": "jest --forceExit",
     "coverage": "jest --coverage --forceExit --runInBand && rm -rf ./coverage",

package/src/index.test.ts

@@ -1,5 +1,6 @@
+import Settings from './index';
+
 const nock = require('nock');
-const Settings = require('./index');
 
 process.env.NODE_ENV = 'node-common-test';
 

package/src/index.ts

@@ -80,7 +80,7 @@ class SettingsManager {
 
   async get(
     key: SettingValue,
-    defaultValue: SettingValue,
+    defaultValue?: SettingValue,
     labels:LabelsArray = [],
     { timeout = 5000, rejectOnFail = false } : GetSettingOption = {},
   ) {
@@ -145,4 +145,4 @@ class SettingsManager {
   }
 }
 
-module.exports = SettingsManager;
+export default SettingsManager;