@map-colonies/config 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,105 @@
+/// <reference types="lodash" />
+import { typeSymbol } from '@map-colonies/schemas/build/schemas/symbol';
+import { JSONSchemaType } from 'ajv';
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+export type EnvType = 'number' | 'string' | 'boolean' | 'integer' | 'null';
+export interface EnvDetails {
+    type: EnvType;
+    path: string;
+}
+export type EnvMap = Record<string, EnvDetails>;
+export interface Config {
+    configName: string;
+    schemaId: string;
+    version: number;
+    config: {
+        [key: string]: unknown;
+    };
+    createdAt: number;
+    createdBy: string;
+}
+export interface ServerCapabilities {
+    serverVersion: string;
+    schemasPackageVersion: string;
+    pubSubEnabled: boolean;
+}
+export interface SchemaWithType {
+    $id?: string;
+    [typeSymbol]: unknown;
+}
+/**
+ * Represents the base options for configuration.
+ */
+export interface BaseOptions {
+    /**
+     * The name of the remote configuration.
+     */
+    configName: string;
+    /**
+     * The version of the remote configuration. It can be either 'latest' or a number.
+     */
+    version: 'latest' | number;
+    /**
+     * The URL of the configuration server.
+     */
+    configServerUrl: string;
+    /**
+     * Indicates whether the configuration should be loaded in offline mode.
+     */
+    offlineMode?: boolean;
+    /**
+     * Indicates whether to ignore the error when the server version is older than the requested version.
+     */
+    ignoreServerIsOlderVersionError?: boolean;
+    /**
+     * The path to the local configuration folder.
+     * @default './config'
+     */
+    localConfigPath?: string;
+}
+/**
+ * Represents the options for configuration.
+ */
+export type ConfigOptions<T extends SchemaWithType> = Prettify<BaseOptions & {
+    /**
+     * The schema of the configuration object.
+     */
+    schema: T;
+}>;
+export declare const optionsSchema: JSONSchemaType<BaseOptions>;
+/**
+ * Represents the schema of the configuration object.
+ * @template T - The type of the configuration schema.
+ */
+export interface ConfigInstance<T> {
+    /**
+     * Retrieves the value at the specified path from the configuration object.
+     * @template TPath - The type of the path.
+     * @param path - The path to the desired value.
+     * @returns The value at the specified path.
+     */
+    get: <TPath extends string>(path: TPath) => _.GetFieldType<T, TPath>;
+    /**
+     * Retrieves the entire configuration object.
+     * @returns The entire configuration object.
+     */
+    getAll: () => T;
+    /**
+     * Retrieves different parts of the configuration object before being merged and validated.
+     * @returns An object containing the localConfig, config, and envConfig parts of the configuration.
+     */
+    getConfigParts: () => {
+        localConfig: object;
+        config: object;
+        envConfig: object;
+    };
+    /**
+     * Retrieves the resolved options from the configuration object.
+     * @returns The resolved options.
+     */
+    getResolvedOptions: () => BaseOptions;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4CAA4C,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,KAAK,CAAC;AAErC,KAAK,QAAQ,CAAC,CAAC,IAAI;KAChB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAErB,GAAG,EAAE,CAAC;AAEP,MAAM,MAAM,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;AAE3E,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAEhD,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,aAAa,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC3B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,cAAc,IAAI,QAAQ,CAC5D,WAAW,GAAG;IACZ;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC;CACX,CACF,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,cAAc,CAAC,WAAW,CAiBrD,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B;;;;;OAKG;IACH,GAAG,EAAE,CAAC,KAAK,SAAS,MAAM,EAAE,IAAI,EAAE,KAAK,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAErE;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhB;;;OAGG;IACH,cAAc,EAAE,MAAM;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAEF;;;OAGG;IACH,kBAAkB,EAAE,MAAM,WAAW,CAAC;CACvC"}

package/dist/types.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.optionsSchema = void 0;
+const symbol_1 = require("@map-colonies/schemas/build/schemas/symbol");
+exports.optionsSchema = {
+    required: ['configName', 'configServerUrl', 'version'],
+    additionalProperties: false,
+    type: 'object',
+    properties: {
+        configName: { type: 'string' },
+        version: {
+            oneOf: [
+                { type: 'string', const: 'latest' },
+                { type: 'integer', minimum: 1 },
+            ],
+        },
+        configServerUrl: { type: 'string' },
+        offlineMode: { type: 'boolean', nullable: true },
+        ignoreServerIsOlderVersionError: { type: 'boolean', nullable: true },
+        localConfigPath: { type: 'string', default: './config', nullable: true },
+    },
+};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA,uEAAwE;AAkF3D,QAAA,aAAa,GAAgC;IACxD,QAAQ,EAAE,CAAC,YAAY,EAAE,iBAAiB,EAAE,SAAS,CAAC;IACtD,oBAAoB,EAAE,KAAK;IAC3B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE;gBACnC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;aAChC;SACF;QACD,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACnC,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;QAChD,+BAA+B,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;QACpE,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;KACzE;CACF,CAAC"}

package/dist/utils/debug.d.ts

@@ -0,0 +1,3 @@
+import debug from 'debug';
+export declare function createDebug(name: string): debug.Debugger;
+//# sourceMappingURL=debug.d.ts.map

package/dist/utils/debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../src/utils/debug.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,QAAQ,CAExD"}

package/dist/utils/debug.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDebug = void 0;
+const debug_1 = __importDefault(require("debug"));
+function createDebug(name) {
+    return (0, debug_1.default)(`@map-colonies/config:${name}`);
+}
+exports.createDebug = createDebug;
+//# sourceMappingURL=debug.js.map

package/dist/utils/debug.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.js","sourceRoot":"","sources":["../../src/utils/debug.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAE1B,SAAgB,WAAW,CAAC,IAAY;IACtC,OAAO,IAAA,eAAK,EAAC,wBAAwB,IAAI,EAAE,CAAC,CAAC;AAC/C,CAAC;AAFD,kCAEC"}

package/dist/validator.d.ts

@@ -0,0 +1,7 @@
+import Ajv, { SchemaObject } from 'ajv/dist/2019';
+import { ValidationError } from '@apideck/better-ajv-errors';
+declare const ajvConfigValidator: import("ajv/dist/core").default;
+export { ajvConfigValidator };
+export declare const ajvOptionsValidator: Ajv;
+export declare function validate<T>(ajv: Ajv, schema: SchemaObject, data: unknown): [ValidationError[], undefined] | [undefined, T];
+//# sourceMappingURL=validator.d.ts.map

package/dist/validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../src/validator.ts"],"names":[],"mappings":"AACA,OAAO,GAAG,EAAE,EAAmB,YAAY,EAAE,MAAM,eAAe,CAAC;AAGnE,OAAO,EAAE,eAAe,EAAmB,MAAM,4BAA4B,CAAC;AAS9E,QAAA,MAAM,kBAAkB,iCAOvB,CAAC;AAIF,OAAO,EAAE,kBAAkB,EAAE,CAAC;AAE9B,eAAO,MAAM,mBAAmB,KAK9B,CAAC;AAEH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,GAAG,CAAC,eAAe,EAAE,EAAE,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAc1H"}

package/dist/validator.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = exports.ajvOptionsValidator = exports.ajvConfigValidator = void 0;
+const node_fs_1 = require("node:fs");
+const _2019_1 = __importDefault(require("ajv/dist/2019"));
+const ajv_formats_1 = __importDefault(require("ajv-formats"));
+const lodash_1 = __importDefault(require("lodash"));
+const better_ajv_errors_1 = require("@apideck/better-ajv-errors");
+const debug_1 = require("./utils/debug");
+const debug = (0, debug_1.createDebug)('validator');
+const draft7MetaSchema = JSON.parse((0, node_fs_1.readFileSync)(require.resolve('ajv/dist/refs/json-schema-draft-07.json'), { encoding: 'utf-8' }));
+const ajvConfigValidator = (0, ajv_formats_1.default)(new _2019_1.default({
+    useDefaults: true,
+    allErrors: true,
+    verbose: true,
+    keywords: ['x-env-value'],
+}));
+exports.ajvConfigValidator = ajvConfigValidator;
+ajvConfigValidator.addMetaSchema(draft7MetaSchema);
+exports.ajvOptionsValidator = new _2019_1.default({
+    useDefaults: true,
+    coerceTypes: true,
+    allErrors: true,
+    verbose: true,
+});
+function validate(ajv, schema, data) {
+    debug('validating data %j with schema %s', data, schema.$id);
+    const clonedData = lodash_1.default.cloneDeep(data);
+    const valid = ajv.validate(schema, clonedData);
+    if (!valid) {
+        debug('validation failed with errors %j', ajv.errors);
+        // eslint-disable-next-line @typescript-eslint/no-magic-numbers
+        const betterErrors = (0, better_ajv_errors_1.betterAjvErrors)({ schema: schema, data, errors: ajv.errors });
+        return [betterErrors, undefined];
+    }
+    debug('validation successful');
+    return [undefined, clonedData];
+}
+exports.validate = validate;
+//# sourceMappingURL=validator.js.map

package/dist/validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.js","sourceRoot":"","sources":["../src/validator.ts"],"names":[],"mappings":";;;;;;AAAA,qCAAuC;AACvC,0DAAmE;AACnE,8DAAqC;AACrC,oDAA4B;AAC5B,kEAA8E;AAC9E,yCAA4C;AAE5C,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,WAAW,CAAC,CAAC;AAEvC,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CACjC,IAAA,sBAAY,EAAC,OAAO,CAAC,OAAO,CAAC,yCAAyC,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAC7E,CAAC;AAErB,MAAM,kBAAkB,GAAG,IAAA,qBAAU,EACnC,IAAI,eAAG,CAAC;IACN,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,CAAC,aAAa,CAAC;CAC1B,CAAC,CACH,CAAC;AAIO,gDAAkB;AAF3B,kBAAkB,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;AAItC,QAAA,mBAAmB,GAAG,IAAI,eAAG,CAAC;IACzC,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,IAAI;CACd,CAAC,CAAC;AAEH,SAAgB,QAAQ,CAAI,GAAQ,EAAE,MAAoB,EAAE,IAAa;IACvE,KAAK,CAAC,mCAAmC,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAE7D,MAAM,UAAU,GAAG,gBAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC/C,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,KAAK,CAAC,kCAAkC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QACtD,+DAA+D;QAC/D,MAAM,YAAY,GAAG,IAAA,mCAAe,EAAC,EAAE,MAAM,EAAE,MAAyD,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACtI,OAAO,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC/B,OAAO,CAAC,SAAS,EAAE,UAAe,CAAC,CAAC;AACtC,CAAC;AAdD,4BAcC"}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@map-colonies/config",
+  "version": "1.0.0",
+  "description": "Config package for MapColonies with support for central config management",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "format": "prettier --check .",
+    "format:fix": "prettier --write .",
+    "prelint:fix": "npm run format:fix",
+    "prelint": "npm run format",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "test": "cross-env SUPPRESS_NO_CONFIG_WARNING=true NODE_CONFIG_STRICT_MODE=false jest --config=./tests/configurations/jest.config.js",
+    "prebuild": "npm run clean",
+    "build": "tsc --project tsconfig.build.json",
+    "start": "npm run build && cd dist && node ./index.js",
+    "clean": "rimraf dist",
+    "prepublish": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MapColonies/config.git"
+  },
+  "author": "MapColonies",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/MapColonies/config/issues"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "pretty-quick --staged",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "homepage": "https://github.com/MapColonies/config#readme",
+  "dependencies": {
+    "@apideck/better-ajv-errors": "^0.3.6",
+    "@apidevtools/json-schema-ref-parser": "^11.6.4",
+    "@map-colonies/read-pkg": "^0.0.1",
+    "@types/lodash": "^4.17.0",
+    "ajv": "^8.16.0",
+    "ajv-formats": "^3.0.1",
+    "config": "^3.3.11",
+    "debug": "^4.3.5",
+    "deepmerge": "^4.3.1",
+    "http-status-codes": "^2.3.0",
+    "lodash": "^4.17.21",
+    "semver": "^7.6.2",
+    "undici": "^6.18.2"
+  },
+  "peerDependencies": {
+    "@map-colonies/schemas": "^0.2.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^11.0.0",
+    "@commitlint/config-conventional": "^11.0.0",
+    "@map-colonies/eslint-config": "^4.0.0",
+    "@types/config": "^3.3.4",
+    "@types/debug": "^4.1.12",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^14.14.12",
+    "commitlint": "^11.0.0",
+    "cross-env": "^7.0.3",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.56.0",
+    "husky": "^4.3.5",
+    "jest": "^29.7.0",
+    "prettier": "^2.2.1",
+    "pretty-quick": "^3.1.0",
+    "ts-jest": "^29.1.5",
+    "typescript": "^5.4.5"
+  }
+}