@map-colonies/config 1.0.0 → 1.1.0

package/README.md

@@ -71,26 +71,31 @@ This package allows you to configure various options for loading and managing co
 
 ### `schema`
 - **Type**: `T extends SchemaWithType`
+- **Optional**: `false`
 - **Description**: The schema of the configuration object.
 
 ### `configName`
 - **Type**: `string`
+- **Optional**: `false`
 - **Description**: The name of the remote configuration.
 - **Environment Variable**: `CONFIG_NAME`
 
 ### `version`
 - **Type**: `'latest' | number`
+- **Optional**: `false`
 - **Description**: The version of the remote configuration. It can be either `'latest'` or a number.
 - **Environment Variable**: `CONFIG_VERSION`
 
 ### `configServerUrl`
 - **Type**: `string`
+- **Optional**: `false`
 - **Description**: The URL of the configuration server.
 - **Environment Variable**: `CONFIG_SERVER_URL`
 
 ### `offlineMode`
 - **Type**: `boolean`
 - **Optional**: `true`
+- **Default**: `false`
 - **Description**: Indicates whether the configuration should be loaded in offline mode.
 - **Environment Variable**: `CONFIG_OFFLINE_MODE`
 
@@ -102,6 +107,7 @@ This package allows you to configure various options for loading and managing co
 
 ### `localConfigPath`
 - **Type**: `string`
+- **Optional**: `true`
 - **Default**: `./config`
 - **Description**: The path to the local configuration folder.
 

package/dist/schemas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":";AAEA,OAAO,UAAU,EAAE,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAO7E,QAAA,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAmB,CAAC;AAanC,wBAAsB,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,WAAW,CAAC,CAiB7F"}
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":";AAEA,OAAO,UAAU,EAAE,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAO7E,QAAA,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAmB,CAAC;AAkBnC,wBAAsB,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC,OAAO,SAAS,CAAC,WAAW,CAAC,CAiB7F"}

package/dist/schemas.js

@@ -18,7 +18,10 @@ function loadSpecificSchema(relativePath) {
     if (!node_fs_1.default.existsSync(fullPath)) {
         throw (0, errors_1.createConfigError)(`schemaNotFoundError`, `Schema not found at path`, { schemaPath: fullPath });
     }
-    return JSON.parse(node_fs_1.default.readFileSync(fullPath, { encoding: 'utf-8' }));
+    const schema = JSON.parse(node_fs_1.default.readFileSync(fullPath, { encoding: 'utf-8' }));
+    // removed to prevent the "reference resolves to more than one schema" error from ajv
+    delete schema.$id;
+    return schema;
 }
 async function loadSchema(schema) {
     debug('loading schema id %s', schema.$id);

package/dist/schemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":";;;;;;AAAA,0DAA6B;AAC7B,sDAAyB;AACzB,iGAA6E;AAC7E,2CAA8D;AAC9D,yCAA4C;AAC5C,qCAA6C;AAE7C,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,SAAS,CAAC,CAAC;AAErC,MAAM,SAAS,GAAG,IAAI,gCAAU,EAAE,CAAC;AAEnC,SAAS,kBAAkB,CAAC,YAAoB;IAC9C,KAAK,CAAC,oCAAoC,EAAE,YAAY,CAAC,CAAC;IAC1D,MAAM,QAAQ,GAAG,mBAAI,CAAC,IAAI,CAAC,4BAAgB,EAAE,YAAY,GAAG,cAAc,CAAC,CAAC;IAE5E,IAAI,CAAC,iBAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAA,0BAAiB,EAAC,qBAAqB,EAAE,0BAA0B,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;IACvG,CAAC;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAe,CAAC;AACpF,CAAC;AAEM,KAAK,UAAU,UAAU,CAAC,MAAkB;IACjD,KAAK,CAAC,sBAAsB,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,kBAAkB,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE;QAC7D,WAAW,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE;QAChC,OAAO,EAAE;YACP,WAAW,EAAE;gBACX,OAAO,EAAE,gCAAgC;gBACzC,KAAK,EAAE,CAAC;gBACR,IAAI,EAAE,CAAC,IAAsD,EAAE,EAAE;oBAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yBAAa,CAAC,CAAC,CAAC,CAAC,CAAC;oBAEjD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;gBACrC,CAAC;aACF;SACF;KACF,CAAC,CAAC;IACH,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAjBD,gCAiBC"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":";;;;;;AAAA,0DAA6B;AAC7B,sDAAyB;AACzB,iGAA6E;AAC7E,2CAA8D;AAC9D,yCAA4C;AAC5C,qCAA6C;AAE7C,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,SAAS,CAAC,CAAC;AAErC,MAAM,SAAS,GAAG,IAAI,gCAAU,EAAE,CAAC;AAEnC,SAAS,kBAAkB,CAAC,YAAoB;IAC9C,KAAK,CAAC,oCAAoC,EAAE,YAAY,CAAC,CAAC;IAC1D,MAAM,QAAQ,GAAG,mBAAI,CAAC,IAAI,CAAC,4BAAgB,EAAE,YAAY,GAAG,cAAc,CAAC,CAAC;IAE5E,IAAI,CAAC,iBAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAA,0BAAiB,EAAC,qBAAqB,EAAE,0BAA0B,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;IACvG,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAe,CAAC;IAE1F,qFAAqF;IACrF,OAAO,MAAM,CAAC,GAAG,CAAC;IAElB,OAAO,MAAM,CAAC;AAChB,CAAC;AAEM,KAAK,UAAU,UAAU,CAAC,MAAkB;IACjD,KAAK,CAAC,sBAAsB,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,kBAAkB,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE;QAC7D,WAAW,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE;QAChC,OAAO,EAAE;YACP,WAAW,EAAE;gBACX,OAAO,EAAE,gCAAgC;gBACzC,KAAK,EAAE,CAAC;gBACR,IAAI,EAAE,CAAC,IAAsD,EAAE,EAAE;oBAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yBAAa,CAAC,CAAC,CAAC,CAAC,CAAC;oBAEjD,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;gBACrC,CAAC;aACF;SACF;KACF,CAAC,CAAC;IACH,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAjBD,gCAiBC"}

package/dist/validator.d.ts.map

@@ -1 +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"}
+{"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,iCAQvB,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

@@ -16,10 +16,11 @@ const ajvConfigValidator = (0, ajv_formats_1.default)(new _2019_1.default({
     useDefaults: true,
     allErrors: true,
     verbose: true,
+    discriminator: true,
     keywords: ['x-env-value'],
 }));
 exports.ajvConfigValidator = ajvConfigValidator;
-ajvConfigValidator.addMetaSchema(draft7MetaSchema);
+ajvConfigValidator.addMetaSchema(draft7MetaSchema, 'http://json-schema.org/draft-07/schema#');
 exports.ajvOptionsValidator = new _2019_1.default({
     useDefaults: true,
     coerceTypes: true,

package/dist/validator.js.map

@@ -1 +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"}
+{"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,aAAa,EAAE,IAAI;IACnB,QAAQ,EAAE,CAAC,aAAa,CAAC;CAC1B,CAAC,CACH,CAAC;AAIO,gDAAkB;AAF3B,kBAAkB,CAAC,aAAa,CAAC,gBAAgB,EAAE,yCAAyC,CAAC,CAAC;AAIjF,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

@@ -1,6 +1,6 @@
 {
   "name": "@map-colonies/config",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Config package for MapColonies with support for central config management",
   "main": "dist/index.js",
   "exports": {
@@ -61,7 +61,7 @@
     "undici": "^6.18.2"
   },
   "peerDependencies": {
-    "@map-colonies/schemas": "^0.2.0"
+    "@map-colonies/schemas": "^1.0.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^11.0.0",

package/dist/avi.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=avi.d.ts.map

package/dist/avi.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"avi.d.ts","sourceRoot":"","sources":["../src/avi.ts"],"names":[],"mappings":""}

package/dist/avi.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const schemas_1 = require("@map-colonies/schemas");
-const config_1 = require("./config");
-(async () => {
-    const c = await (0, config_1.config)({
-        schema: schemas_1.threeDFileSyncerV1,
-        configName: 'threeDFileSyncerV1',
-        configServerUrl: 'http://localhost:3000',
-        version: 1,
-        offlineMode: true,
-    });
-    const a = c.get('telemetry.logger');
-    console.log(a);
-})().catch(console.error);
-//# sourceMappingURL=avi.js.map

package/dist/avi.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"avi.js","sourceRoot":"","sources":["../src/avi.ts"],"names":[],"mappings":";;AAAA,mDAA2D;AAC3D,qCAAkC;AAElC,CAAC,KAAK,IAAI,EAAE;IACV,MAAM,CAAC,GAAG,MAAM,IAAA,eAAM,EAAC;QACrB,MAAM,EAAE,4BAAkB;QAC1B,UAAU,EAAE,oBAAoB;QAChC,eAAe,EAAE,uBAAuB;QACxC,OAAO,EAAE,CAAC;QACV,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC;IAEH,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACpC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACjB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC"}