@lightdash/common 0.1921.0 → 0.1922.0

package/dist/cjs/schemas/json/lightdash-project-config-1.0.json

@@ -64,6 +64,7 @@
                         "options": {
                             "description": "A list of possible values for the parameter",
                             "type": "array",
+                            "minItems": 1,
                             "items": {
                                 "type": "string"
                             }
@@ -104,7 +105,26 @@
                             "required": ["model", "dimension"]
                         }
                     },
-                    "required": ["label"]
+                    "required": ["label"],
+                    "anyOf": [
+                        {
+                            "required": ["options_from_dimension"],
+                            "errorMessage": "Must have one of the following properties: allow_custom_values, options, options_from_dimension"
+                        },
+                        {
+                            "required": ["options"],
+                            "errorMessage": "Must have one of the following properties: allow_custom_values, options, options_from_dimension"
+                        },
+                        {
+                            "properties": {
+                                "allow_custom_values": {
+                                    "enum": [true]
+                                }
+                            },
+                            "required": ["allow_custom_values"],
+                            "errorMessage": "Must have one of the following properties: allow_custom_values, options, options_from_dimension"
+                        }
+                    ]
                 }
             }
         }

package/dist/cjs/utils/loadLightdashProjectConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loadLightdashProjectConfig.d.ts","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.ts"],"names":[],"mappings":"AAKA,OAAO,EAEH,KAAK,sBAAsB,EAC9B,MAAM,iCAAiC,CAAC;AAKzC,eAAO,MAAM,0BAA0B,qBACjB,MAAM,aACb,CAAC,MAAM,EAAE,sBAAsB,KAAK,OAAO,CAAC,IAAI,CAAC,KAC7D,OAAO,CAAC,sBAAsB,CAuChC,CAAC"}
+{"version":3,"file":"loadLightdashProjectConfig.d.ts","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.ts"],"names":[],"mappings":"AAMA,OAAO,EAEH,KAAK,sBAAsB,EAC9B,MAAM,iCAAiC,CAAC;AAKzC,eAAO,MAAM,0BAA0B,qBACjB,MAAM,aACb,CAAC,MAAM,EAAE,sBAAsB,KAAK,OAAO,CAAC,IAAI,CAAC,KAC7D,OAAO,CAAC,sBAAsB,CAyChC,CAAC"}

package/dist/cjs/utils/loadLightdashProjectConfig.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadLightdashProjectConfig = void 0;
 const tslib_1 = require("tslib");
 const ajv_1 = tslib_1.__importDefault(require("ajv"));
+const ajv_errors_1 = tslib_1.__importDefault(require("ajv-errors"));
 const better_ajv_errors_1 = tslib_1.__importDefault(require("better-ajv-errors"));
 const yaml = tslib_1.__importStar(require("js-yaml"));
 const lightdash_project_config_1_0_json_1 = tslib_1.__importDefault(require("../schemas/json/lightdash-project-config-1.0.json"));
@@ -22,7 +23,9 @@ const loadLightdashProjectConfig = async (yamlFileContents, onLoaded) => {
         ...defaultConfig,
         ...loadedConfig,
     };
-    const ajv = new ajv_1.default({ coerceTypes: true });
+    const ajv = new ajv_1.default({ coerceTypes: true, allErrors: true });
+    // This method call extends JSON schema to utilize AJV Errors
+    (0, ajv_errors_1.default)(ajv);
     const validate = ajv.compile(lightdash_project_config_1_0_json_1.default);
     if (!validate(configFile)) {
         const errors = (0, better_ajv_errors_1.default)(lightdash_project_config_1_0_json_1.default, configFile, validate.errors || [], { indent: 2 });

package/dist/cjs/utils/loadLightdashProjectConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"loadLightdashProjectConfig.js","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,kFAAgD;AAChD,sDAAgC;AAChC,kIAA6F;AAC7F,4CAA6C;AAC7C,4EAGyC;AAEzC,MAAM,aAAa,GAA2B;IAC1C,SAAS,EAAE,iDAAwB;CACtC,CAAC;AACK,MAAM,0BAA0B,GAAG,KAAK,EAC3C,gBAAwB,EACxB,QAA4D,EAC7B,EAAE;IACjC,IAAI,gBAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACjC,OAAO,aAAa,CAAC;IACzB,CAAC;IACD,4CAA4C;IAC5C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAC1B,gBAAgB,CACgB,CAAC;IACrC,kDAAkD;IAClD,MAAM,UAAU,GAA2B;QACvC,GAAG,aAAa;QAChB,GAAG,YAAY;KAClB,CAAC;IACF,MAAM,GAAG,GAAG,IAAI,aAAG,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CACxB,2CAA4B,CAC/B,CAAC;IAEF,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG,IAAA,2BAAe,EAC1B,2CAA4B,EAC5B,UAAU,EACV,QAAQ,CAAC,MAAM,IAAI,EAAE,EACrB,EAAE,MAAM,EAAE,CAAC,EAAE,CAChB,CAAC;QACF,MAAM,IAAI,mBAAU,CAChB,8CAA8C,MAAM,EAAE,CACzD,CAAC;IACN,CAAC;IAED,IAAI,UAAU,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAChC,UAAU,CAAC,UAAU,GAAG,SAAS,CAAC;IACtC,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACX,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,UAAU,CAAC;AACtB,CAAC,CAAC;AA1CW,QAAA,0BAA0B,8BA0CrC"}
+{"version":3,"file":"loadLightdashProjectConfig.js","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,oEAAmC;AACnC,kFAAgD;AAChD,sDAAgC;AAChC,kIAA6F;AAC7F,4CAA6C;AAC7C,4EAGyC;AAEzC,MAAM,aAAa,GAA2B;IAC1C,SAAS,EAAE,iDAAwB;CACtC,CAAC;AACK,MAAM,0BAA0B,GAAG,KAAK,EAC3C,gBAAwB,EACxB,QAA4D,EAC7B,EAAE;IACjC,IAAI,gBAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACjC,OAAO,aAAa,CAAC;IACzB,CAAC;IACD,4CAA4C;IAC5C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAC1B,gBAAgB,CACgB,CAAC;IACrC,kDAAkD;IAClD,MAAM,UAAU,GAA2B;QACvC,GAAG,aAAa;QAChB,GAAG,YAAY;KAClB,CAAC;IACF,MAAM,GAAG,GAAG,IAAI,aAAG,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,6DAA6D;IAC7D,IAAA,oBAAS,EAAC,GAAG,CAAC,CAAC;IACf,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CACxB,2CAA4B,CAC/B,CAAC;IAEF,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG,IAAA,2BAAe,EAC1B,2CAA4B,EAC5B,UAAU,EACV,QAAQ,CAAC,MAAM,IAAI,EAAE,EACrB,EAAE,MAAM,EAAE,CAAC,EAAE,CAChB,CAAC;QACF,MAAM,IAAI,mBAAU,CAChB,8CAA8C,MAAM,EAAE,CACzD,CAAC;IACN,CAAC;IAED,IAAI,UAAU,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAChC,UAAU,CAAC,UAAU,GAAG,SAAS,CAAC;IACtC,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACX,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,UAAU,CAAC;AACtB,CAAC,CAAC;AA5CW,QAAA,0BAA0B,8BA4CrC"}

package/dist/cjs/utils/loadLightdashProjectConfig.mock.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Mock YAML content for lightdash project config tests
+ */
+export declare const emptyConfig = "";
+export declare const validConfigWithParameters = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    options:\n      - option1\n      - option2\n";
+export declare const validConfigWithOptionsFromDimension = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    options_from_dimension:\n      model: test_model\n      dimension: test_dimension\n";
+export declare const validConfigWithAllowCustomValues = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    allow_custom_values: true\n";
+export declare const invalidConfigWithNoOptions = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n";
+export declare const invalidConfigWithAllowCustomValuesFalse = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    allow_custom_values: false\n";
+export declare const configWithEmptyOptionsArray = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    options: []\n";
+export declare const invalidConfigWithIncompleteOptionsFromDimension = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    options_from_dimension:\n      model: test_model\n";
+//# sourceMappingURL=loadLightdashProjectConfig.mock.d.ts.map

package/dist/cjs/utils/loadLightdashProjectConfig.mock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadLightdashProjectConfig.mock.d.ts","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.mock.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,eAAO,MAAM,WAAW,KAAK,CAAC;AAE9B,eAAO,MAAM,yBAAyB,sJASrC,CAAC;AAEF,eAAO,MAAM,mCAAmC,6LAS/C,CAAC;AAEF,eAAO,MAAM,gCAAgC,qIAO5C,CAAC;AAEF,eAAO,MAAM,0BAA0B,sGAMtC,CAAC;AAEF,eAAO,MAAM,uCAAuC,sIAOnD,CAAC;AAEF,eAAO,MAAM,2BAA2B,uHAOvC,CAAC;AAEF,eAAO,MAAM,+CAA+C,4JAQ3D,CAAC"}

package/dist/cjs/utils/loadLightdashProjectConfig.mock.js

@@ -0,0 +1,68 @@
+"use strict";
+/**
+ * Mock YAML content for lightdash project config tests
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invalidConfigWithIncompleteOptionsFromDimension = exports.configWithEmptyOptionsArray = exports.invalidConfigWithAllowCustomValuesFalse = exports.invalidConfigWithNoOptions = exports.validConfigWithAllowCustomValues = exports.validConfigWithOptionsFromDimension = exports.validConfigWithParameters = exports.emptyConfig = void 0;
+exports.emptyConfig = '';
+exports.validConfigWithParameters = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    options:
+      - option1
+      - option2
+`;
+exports.validConfigWithOptionsFromDimension = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    options_from_dimension:
+      model: test_model
+      dimension: test_dimension
+`;
+exports.validConfigWithAllowCustomValues = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    allow_custom_values: true
+`;
+exports.invalidConfigWithNoOptions = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+`;
+exports.invalidConfigWithAllowCustomValuesFalse = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    allow_custom_values: false
+`;
+exports.configWithEmptyOptionsArray = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    options: []
+`;
+exports.invalidConfigWithIncompleteOptionsFromDimension = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    options_from_dimension:
+      model: test_model
+`;
+//# sourceMappingURL=loadLightdashProjectConfig.mock.js.map

package/dist/cjs/utils/loadLightdashProjectConfig.mock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadLightdashProjectConfig.mock.js","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.mock.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEU,QAAA,WAAW,GAAG,EAAE,CAAC;AAEjB,QAAA,yBAAyB,GAAG;;;;;;;;;CASxC,CAAC;AAEW,QAAA,mCAAmC,GAAG;;;;;;;;;CASlD,CAAC;AAEW,QAAA,gCAAgC,GAAG;;;;;;;CAO/C,CAAC;AAEW,QAAA,0BAA0B,GAAG;;;;;;CAMzC,CAAC;AAEW,QAAA,uCAAuC,GAAG;;;;;;;CAOtD,CAAC;AAEW,QAAA,2BAA2B,GAAG;;;;;;;CAO1C,CAAC;AAEW,QAAA,+CAA+C,GAAG;;;;;;;;CAQ9D,CAAC"}

package/dist/cjs/utils/loadLightdashProjectConfig.test.d.ts

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

package/dist/cjs/utils/loadLightdashProjectConfig.test.d.ts.map

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

package/dist/cjs/utils/loadLightdashProjectConfig.test.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const errors_1 = require("../types/errors");
+const loadLightdashProjectConfig_1 = require("./loadLightdashProjectConfig");
+const loadLightdashProjectConfig_mock_1 = require("./loadLightdashProjectConfig.mock");
+describe('loadLightdashProjectConfig', () => {
+    it('should load an empty config', async () => {
+        const config = await (0, loadLightdashProjectConfig_1.loadLightdashProjectConfig)(loadLightdashProjectConfig_mock_1.emptyConfig);
+        expect(config).toEqual({
+            spotlight: {
+                default_visibility: 'show',
+            },
+        });
+    });
+    it('should load a valid config with parameters', async () => {
+        const config = await (0, loadLightdashProjectConfig_1.loadLightdashProjectConfig)(loadLightdashProjectConfig_mock_1.validConfigWithParameters);
+        expect(config).toEqual({
+            spotlight: {
+                default_visibility: 'show',
+            },
+            parameters: {
+                test_param: {
+                    label: 'Test Parameter',
+                    options: ['option1', 'option2'],
+                },
+            },
+        });
+    });
+    it('should load a valid config with parameters using options_from_dimension', async () => {
+        const config = await (0, loadLightdashProjectConfig_1.loadLightdashProjectConfig)(loadLightdashProjectConfig_mock_1.validConfigWithOptionsFromDimension);
+        expect(config).toEqual({
+            spotlight: {
+                default_visibility: 'show',
+            },
+            parameters: {
+                test_param: {
+                    label: 'Test Parameter',
+                    options_from_dimension: {
+                        model: 'test_model',
+                        dimension: 'test_dimension',
+                    },
+                },
+            },
+        });
+    });
+    it('should load a valid config with parameters using allow_custom_values', async () => {
+        const config = await (0, loadLightdashProjectConfig_1.loadLightdashProjectConfig)(loadLightdashProjectConfig_mock_1.validConfigWithAllowCustomValues);
+        expect(config).toEqual({
+            spotlight: {
+                default_visibility: 'show',
+            },
+            parameters: {
+                test_param: {
+                    label: 'Test Parameter',
+                    allow_custom_values: true,
+                },
+            },
+        });
+    });
+    it('should throw an error for invalid parameter with no options', async () => {
+        await expect((0, loadLightdashProjectConfig_1.loadLightdashProjectConfig)(loadLightdashProjectConfig_mock_1.invalidConfigWithNoOptions)).rejects.toThrow(errors_1.ParseError);
+    });
+    it('should throw an error for invalid parameter with allow_custom_values set to false', async () => {
+        await expect((0, loadLightdashProjectConfig_1.loadLightdashProjectConfig)(loadLightdashProjectConfig_mock_1.invalidConfigWithAllowCustomValuesFalse)).rejects.toThrow(errors_1.ParseError);
+    });
+    it('should throw an error for parameter with empty options array', async () => {
+        await expect((0, loadLightdashProjectConfig_1.loadLightdashProjectConfig)(loadLightdashProjectConfig_mock_1.configWithEmptyOptionsArray)).rejects.toThrow(errors_1.ParseError);
+    });
+    it('should throw an error for invalid parameter with incomplete options_from_dimension', async () => {
+        await expect((0, loadLightdashProjectConfig_1.loadLightdashProjectConfig)(loadLightdashProjectConfig_mock_1.invalidConfigWithIncompleteOptionsFromDimension)).rejects.toThrow(errors_1.ParseError);
+    });
+});
+//# sourceMappingURL=loadLightdashProjectConfig.test.js.map

package/dist/cjs/utils/loadLightdashProjectConfig.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadLightdashProjectConfig.test.js","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.test.ts"],"names":[],"mappings":";;AAAA,4CAA6C;AAC7C,6EAA0E;AAC1E,uFAS2C;AAE3C,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACxC,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,MAAM,GAAG,MAAM,IAAA,uDAA0B,EAAC,6CAAW,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACnB,SAAS,EAAE;gBACP,kBAAkB,EAAE,MAAM;aAC7B;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,MAAM,GAAG,MAAM,IAAA,uDAA0B,EAC3C,2DAAyB,CAC5B,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACnB,SAAS,EAAE;gBACP,kBAAkB,EAAE,MAAM;aAC7B;YACD,UAAU,EAAE;gBACR,UAAU,EAAE;oBACR,KAAK,EAAE,gBAAgB;oBACvB,OAAO,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;iBAClC;aACJ;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,MAAM,GAAG,MAAM,IAAA,uDAA0B,EAC3C,qEAAmC,CACtC,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACnB,SAAS,EAAE;gBACP,kBAAkB,EAAE,MAAM;aAC7B;YACD,UAAU,EAAE;gBACR,UAAU,EAAE;oBACR,KAAK,EAAE,gBAAgB;oBACvB,sBAAsB,EAAE;wBACpB,KAAK,EAAE,YAAY;wBACnB,SAAS,EAAE,gBAAgB;qBAC9B;iBACJ;aACJ;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,MAAM,GAAG,MAAM,IAAA,uDAA0B,EAC3C,kEAAgC,CACnC,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACnB,SAAS,EAAE;gBACP,kBAAkB,EAAE,MAAM;aAC7B;YACD,UAAU,EAAE;gBACR,UAAU,EAAE;oBACR,KAAK,EAAE,gBAAgB;oBACvB,mBAAmB,EAAE,IAAI;iBAC5B;aACJ;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,MAAM,CACR,IAAA,uDAA0B,EAAC,4DAA0B,CAAC,CACzD,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAU,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mFAAmF,EAAE,KAAK,IAAI,EAAE;QAC/F,MAAM,MAAM,CACR,IAAA,uDAA0B,EAAC,yEAAuC,CAAC,CACtE,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAU,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,MAAM,CACR,IAAA,uDAA0B,EAAC,6DAA2B,CAAC,CAC1D,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAU,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oFAAoF,EAAE,KAAK,IAAI,EAAE;QAChG,MAAM,MAAM,CACR,IAAA,uDAA0B,EACtB,iFAA+C,CAClD,CACJ,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAU,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/esm/schemas/json/lightdash-project-config-1.0.json

@@ -64,6 +64,7 @@
                         "options": {
                             "description": "A list of possible values for the parameter",
                             "type": "array",
+                            "minItems": 1,
                             "items": {
                                 "type": "string"
                             }
@@ -104,7 +105,26 @@
                             "required": ["model", "dimension"]
                         }
                     },
-                    "required": ["label"]
+                    "required": ["label"],
+                    "anyOf": [
+                        {
+                            "required": ["options_from_dimension"],
+                            "errorMessage": "Must have one of the following properties: allow_custom_values, options, options_from_dimension"
+                        },
+                        {
+                            "required": ["options"],
+                            "errorMessage": "Must have one of the following properties: allow_custom_values, options, options_from_dimension"
+                        },
+                        {
+                            "properties": {
+                                "allow_custom_values": {
+                                    "enum": [true]
+                                }
+                            },
+                            "required": ["allow_custom_values"],
+                            "errorMessage": "Must have one of the following properties: allow_custom_values, options, options_from_dimension"
+                        }
+                    ]
                 }
             }
         }

package/dist/esm/utils/loadLightdashProjectConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loadLightdashProjectConfig.d.ts","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.ts"],"names":[],"mappings":"AAKA,OAAO,EAEH,KAAK,sBAAsB,EAC9B,MAAM,iCAAiC,CAAC;AAKzC,eAAO,MAAM,0BAA0B,qBACjB,MAAM,aACb,CAAC,MAAM,EAAE,sBAAsB,KAAK,OAAO,CAAC,IAAI,CAAC,KAC7D,OAAO,CAAC,sBAAsB,CAuChC,CAAC"}
+{"version":3,"file":"loadLightdashProjectConfig.d.ts","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.ts"],"names":[],"mappings":"AAMA,OAAO,EAEH,KAAK,sBAAsB,EAC9B,MAAM,iCAAiC,CAAC;AAKzC,eAAO,MAAM,0BAA0B,qBACjB,MAAM,aACb,CAAC,MAAM,EAAE,sBAAsB,KAAK,OAAO,CAAC,IAAI,CAAC,KAC7D,OAAO,CAAC,sBAAsB,CAyChC,CAAC"}

package/dist/esm/utils/loadLightdashProjectConfig.js

@@ -1,4 +1,5 @@
 import Ajv from 'ajv';
+import AjvErrors from 'ajv-errors';
 import betterAjvErrors from 'better-ajv-errors';
 import * as yaml from 'js-yaml';
 import lightdashProjectConfigSchema from '../schemas/json/lightdash-project-config-1.0.json';
@@ -18,7 +19,9 @@ export const loadLightdashProjectConfig = async (yamlFileContents, onLoaded) =>
         ...defaultConfig,
         ...loadedConfig,
     };
-    const ajv = new Ajv({ coerceTypes: true });
+    const ajv = new Ajv({ coerceTypes: true, allErrors: true });
+    // This method call extends JSON schema to utilize AJV Errors
+    AjvErrors(ajv);
     const validate = ajv.compile(lightdashProjectConfigSchema);
     if (!validate(configFile)) {
         const errors = betterAjvErrors(lightdashProjectConfigSchema, configFile, validate.errors || [], { indent: 2 });

package/dist/esm/utils/loadLightdashProjectConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"loadLightdashProjectConfig.js","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,4BAA4B,MAAM,mDAAmD,CAAC;AAC7F,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EACH,wBAAwB,GAE3B,MAAM,iCAAiC,CAAC;AAEzC,MAAM,aAAa,GAA2B;IAC1C,SAAS,EAAE,wBAAwB;CACtC,CAAC;AACF,MAAM,CAAC,MAAM,0BAA0B,GAAG,KAAK,EAC3C,gBAAwB,EACxB,QAA4D,EAC7B,EAAE;IACjC,IAAI,gBAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACjC,OAAO,aAAa,CAAC;IACzB,CAAC;IACD,4CAA4C;IAC5C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAC1B,gBAAgB,CACgB,CAAC;IACrC,kDAAkD;IAClD,MAAM,UAAU,GAA2B;QACvC,GAAG,aAAa;QAChB,GAAG,YAAY;KAClB,CAAC;IACF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CACxB,4BAA4B,CAC/B,CAAC;IAEF,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG,eAAe,CAC1B,4BAA4B,EAC5B,UAAU,EACV,QAAQ,CAAC,MAAM,IAAI,EAAE,EACrB,EAAE,MAAM,EAAE,CAAC,EAAE,CAChB,CAAC;QACF,MAAM,IAAI,UAAU,CAChB,8CAA8C,MAAM,EAAE,CACzD,CAAC;IACN,CAAC;IAED,IAAI,UAAU,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAChC,UAAU,CAAC,UAAU,GAAG,SAAS,CAAC;IACtC,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACX,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,UAAU,CAAC;AACtB,CAAC,CAAC"}
+{"version":3,"file":"loadLightdashProjectConfig.js","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,4BAA4B,MAAM,mDAAmD,CAAC;AAC7F,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EACH,wBAAwB,GAE3B,MAAM,iCAAiC,CAAC;AAEzC,MAAM,aAAa,GAA2B;IAC1C,SAAS,EAAE,wBAAwB;CACtC,CAAC;AACF,MAAM,CAAC,MAAM,0BAA0B,GAAG,KAAK,EAC3C,gBAAwB,EACxB,QAA4D,EAC7B,EAAE;IACjC,IAAI,gBAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACjC,OAAO,aAAa,CAAC;IACzB,CAAC;IACD,4CAA4C;IAC5C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAC1B,gBAAgB,CACgB,CAAC;IACrC,kDAAkD;IAClD,MAAM,UAAU,GAA2B;QACvC,GAAG,aAAa;QAChB,GAAG,YAAY;KAClB,CAAC;IACF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,6DAA6D;IAC7D,SAAS,CAAC,GAAG,CAAC,CAAC;IACf,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CACxB,4BAA4B,CAC/B,CAAC;IAEF,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG,eAAe,CAC1B,4BAA4B,EAC5B,UAAU,EACV,QAAQ,CAAC,MAAM,IAAI,EAAE,EACrB,EAAE,MAAM,EAAE,CAAC,EAAE,CAChB,CAAC;QACF,MAAM,IAAI,UAAU,CAChB,8CAA8C,MAAM,EAAE,CACzD,CAAC;IACN,CAAC;IAED,IAAI,UAAU,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAChC,UAAU,CAAC,UAAU,GAAG,SAAS,CAAC;IACtC,CAAC;IAED,IAAI,QAAQ,EAAE,CAAC;QACX,MAAM,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,UAAU,CAAC;AACtB,CAAC,CAAC"}

package/dist/esm/utils/loadLightdashProjectConfig.mock.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Mock YAML content for lightdash project config tests
+ */
+export declare const emptyConfig = "";
+export declare const validConfigWithParameters = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    options:\n      - option1\n      - option2\n";
+export declare const validConfigWithOptionsFromDimension = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    options_from_dimension:\n      model: test_model\n      dimension: test_dimension\n";
+export declare const validConfigWithAllowCustomValues = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    allow_custom_values: true\n";
+export declare const invalidConfigWithNoOptions = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n";
+export declare const invalidConfigWithAllowCustomValuesFalse = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    allow_custom_values: false\n";
+export declare const configWithEmptyOptionsArray = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    options: []\n";
+export declare const invalidConfigWithIncompleteOptionsFromDimension = "\nspotlight:\n  default_visibility: show\nparameters:\n  test_param:\n    label: Test Parameter\n    options_from_dimension:\n      model: test_model\n";
+//# sourceMappingURL=loadLightdashProjectConfig.mock.d.ts.map

package/dist/esm/utils/loadLightdashProjectConfig.mock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadLightdashProjectConfig.mock.d.ts","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.mock.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,eAAO,MAAM,WAAW,KAAK,CAAC;AAE9B,eAAO,MAAM,yBAAyB,sJASrC,CAAC;AAEF,eAAO,MAAM,mCAAmC,6LAS/C,CAAC;AAEF,eAAO,MAAM,gCAAgC,qIAO5C,CAAC;AAEF,eAAO,MAAM,0BAA0B,sGAMtC,CAAC;AAEF,eAAO,MAAM,uCAAuC,sIAOnD,CAAC;AAEF,eAAO,MAAM,2BAA2B,uHAOvC,CAAC;AAEF,eAAO,MAAM,+CAA+C,4JAQ3D,CAAC"}

package/dist/esm/utils/loadLightdashProjectConfig.mock.js

@@ -0,0 +1,65 @@
+/**
+ * Mock YAML content for lightdash project config tests
+ */
+export const emptyConfig = '';
+export const validConfigWithParameters = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    options:
+      - option1
+      - option2
+`;
+export const validConfigWithOptionsFromDimension = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    options_from_dimension:
+      model: test_model
+      dimension: test_dimension
+`;
+export const validConfigWithAllowCustomValues = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    allow_custom_values: true
+`;
+export const invalidConfigWithNoOptions = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+`;
+export const invalidConfigWithAllowCustomValuesFalse = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    allow_custom_values: false
+`;
+export const configWithEmptyOptionsArray = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    options: []
+`;
+export const invalidConfigWithIncompleteOptionsFromDimension = `
+spotlight:
+  default_visibility: show
+parameters:
+  test_param:
+    label: Test Parameter
+    options_from_dimension:
+      model: test_model
+`;
+//# sourceMappingURL=loadLightdashProjectConfig.mock.js.map

package/dist/esm/utils/loadLightdashProjectConfig.mock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadLightdashProjectConfig.mock.js","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.mock.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,CAAC,MAAM,WAAW,GAAG,EAAE,CAAC;AAE9B,MAAM,CAAC,MAAM,yBAAyB,GAAG;;;;;;;;;CASxC,CAAC;AAEF,MAAM,CAAC,MAAM,mCAAmC,GAAG;;;;;;;;;CASlD,CAAC;AAEF,MAAM,CAAC,MAAM,gCAAgC,GAAG;;;;;;;CAO/C,CAAC;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAG;;;;;;CAMzC,CAAC;AAEF,MAAM,CAAC,MAAM,uCAAuC,GAAG;;;;;;;CAOtD,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG;;;;;;;CAO1C,CAAC;AAEF,MAAM,CAAC,MAAM,+CAA+C,GAAG;;;;;;;;CAQ9D,CAAC"}

package/dist/esm/utils/loadLightdashProjectConfig.test.d.ts

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

package/dist/esm/utils/loadLightdashProjectConfig.test.d.ts.map

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

package/dist/esm/utils/loadLightdashProjectConfig.test.js

@@ -0,0 +1,71 @@
+import { ParseError } from '../types/errors';
+import { loadLightdashProjectConfig } from './loadLightdashProjectConfig';
+import { configWithEmptyOptionsArray, emptyConfig, invalidConfigWithAllowCustomValuesFalse, invalidConfigWithIncompleteOptionsFromDimension, invalidConfigWithNoOptions, validConfigWithAllowCustomValues, validConfigWithOptionsFromDimension, validConfigWithParameters, } from './loadLightdashProjectConfig.mock';
+describe('loadLightdashProjectConfig', () => {
+    it('should load an empty config', async () => {
+        const config = await loadLightdashProjectConfig(emptyConfig);
+        expect(config).toEqual({
+            spotlight: {
+                default_visibility: 'show',
+            },
+        });
+    });
+    it('should load a valid config with parameters', async () => {
+        const config = await loadLightdashProjectConfig(validConfigWithParameters);
+        expect(config).toEqual({
+            spotlight: {
+                default_visibility: 'show',
+            },
+            parameters: {
+                test_param: {
+                    label: 'Test Parameter',
+                    options: ['option1', 'option2'],
+                },
+            },
+        });
+    });
+    it('should load a valid config with parameters using options_from_dimension', async () => {
+        const config = await loadLightdashProjectConfig(validConfigWithOptionsFromDimension);
+        expect(config).toEqual({
+            spotlight: {
+                default_visibility: 'show',
+            },
+            parameters: {
+                test_param: {
+                    label: 'Test Parameter',
+                    options_from_dimension: {
+                        model: 'test_model',
+                        dimension: 'test_dimension',
+                    },
+                },
+            },
+        });
+    });
+    it('should load a valid config with parameters using allow_custom_values', async () => {
+        const config = await loadLightdashProjectConfig(validConfigWithAllowCustomValues);
+        expect(config).toEqual({
+            spotlight: {
+                default_visibility: 'show',
+            },
+            parameters: {
+                test_param: {
+                    label: 'Test Parameter',
+                    allow_custom_values: true,
+                },
+            },
+        });
+    });
+    it('should throw an error for invalid parameter with no options', async () => {
+        await expect(loadLightdashProjectConfig(invalidConfigWithNoOptions)).rejects.toThrow(ParseError);
+    });
+    it('should throw an error for invalid parameter with allow_custom_values set to false', async () => {
+        await expect(loadLightdashProjectConfig(invalidConfigWithAllowCustomValuesFalse)).rejects.toThrow(ParseError);
+    });
+    it('should throw an error for parameter with empty options array', async () => {
+        await expect(loadLightdashProjectConfig(configWithEmptyOptionsArray)).rejects.toThrow(ParseError);
+    });
+    it('should throw an error for invalid parameter with incomplete options_from_dimension', async () => {
+        await expect(loadLightdashProjectConfig(invalidConfigWithIncompleteOptionsFromDimension)).rejects.toThrow(ParseError);
+    });
+});
+//# sourceMappingURL=loadLightdashProjectConfig.test.js.map

package/dist/esm/utils/loadLightdashProjectConfig.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadLightdashProjectConfig.test.js","sourceRoot":"","sources":["../../../src/utils/loadLightdashProjectConfig.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EACH,2BAA2B,EAC3B,WAAW,EACX,uCAAuC,EACvC,+CAA+C,EAC/C,0BAA0B,EAC1B,gCAAgC,EAChC,mCAAmC,EACnC,yBAAyB,GAC5B,MAAM,mCAAmC,CAAC;AAE3C,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACxC,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,MAAM,GAAG,MAAM,0BAA0B,CAAC,WAAW,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACnB,SAAS,EAAE;gBACP,kBAAkB,EAAE,MAAM;aAC7B;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,MAAM,GAAG,MAAM,0BAA0B,CAC3C,yBAAyB,CAC5B,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACnB,SAAS,EAAE;gBACP,kBAAkB,EAAE,MAAM;aAC7B;YACD,UAAU,EAAE;gBACR,UAAU,EAAE;oBACR,KAAK,EAAE,gBAAgB;oBACvB,OAAO,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;iBAClC;aACJ;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,MAAM,GAAG,MAAM,0BAA0B,CAC3C,mCAAmC,CACtC,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACnB,SAAS,EAAE;gBACP,kBAAkB,EAAE,MAAM;aAC7B;YACD,UAAU,EAAE;gBACR,UAAU,EAAE;oBACR,KAAK,EAAE,gBAAgB;oBACvB,sBAAsB,EAAE;wBACpB,KAAK,EAAE,YAAY;wBACnB,SAAS,EAAE,gBAAgB;qBAC9B;iBACJ;aACJ;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,MAAM,GAAG,MAAM,0BAA0B,CAC3C,gCAAgC,CACnC,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACnB,SAAS,EAAE;gBACP,kBAAkB,EAAE,MAAM;aAC7B;YACD,UAAU,EAAE;gBACR,UAAU,EAAE;oBACR,KAAK,EAAE,gBAAgB;oBACvB,mBAAmB,EAAE,IAAI;iBAC5B;aACJ;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,MAAM,CACR,0BAA0B,CAAC,0BAA0B,CAAC,CACzD,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mFAAmF,EAAE,KAAK,IAAI,EAAE;QAC/F,MAAM,MAAM,CACR,0BAA0B,CAAC,uCAAuC,CAAC,CACtE,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,MAAM,CACR,0BAA0B,CAAC,2BAA2B,CAAC,CAC1D,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oFAAoF,EAAE,KAAK,IAAI,EAAE;QAChG,MAAM,MAAM,CACR,0BAA0B,CACtB,+CAA+C,CAClD,CACJ,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}