@lightdash/common 0.2104.6 → 0.2104.8

package/dist/types/dbt/DbtSchemaEditor/DbtSchemaEditor.js

@@ -0,0 +1,285 @@
+import Ajv from 'ajv';
+import betterAjvErrors from 'better-ajv-errors';
+import { isMap, isScalar, isSeq, parseDocument, YAMLSeq, } from 'yaml';
+import { parseAllReferences } from '../../compiler/exploreCompiler';
+import lightdashDbtYamlSchema from '../../schemas/json/lightdash-dbt-2.0.json';
+import { ParseError } from '../../types/errors';
+import { defaultSql, isCustomSqlDimension, } from '../../types/field';
+import { isDbtVersion110OrHigher, } from '../../types/projects';
+import { convertCustomBinDimensionToDbt, convertCustomSqlDimensionToDbt, } from '../../utils/convertCustomDimensionsToYaml';
+import { convertCustomMetricToDbt } from '../../utils/convertCustomMetricsToYaml';
+/**
+ * Class to edit dbt schema files(YAML)
+ * Methods can be chained and the final schema can be obtained as a string.
+ * Usage:
+ * const editor = new DbtSchemaEditor(schema);
+ * const updatedSchema = editor.addCustomMetrics(customMetricsToAdd).toString();
+ */
+export default class DbtSchemaEditor {
+    constructor(doc = '', filename = '', dbtVersion) {
+        this.doc = parseDocument(doc);
+        this.dbtVersion = dbtVersion;
+        const ajvCompiler = new Ajv({
+            coerceTypes: true,
+            allowUnionTypes: true,
+        });
+        const validate = ajvCompiler.compile(lightdashDbtYamlSchema);
+        const schemaFile = this.doc.toJS();
+        if (schemaFile && !validate(schemaFile)) {
+            const errors = betterAjvErrors(lightdashDbtYamlSchema, schemaFile, validate.errors || [], { indent: 2 });
+            throw new ParseError(`Invalid schema file: ${filename}\n${errors}`);
+        }
+    }
+    isDbtVersion110OrHigher() {
+        return isDbtVersion110OrHigher(this.dbtVersion);
+    }
+    findModelByName(name) {
+        const node = this.doc.get('models');
+        if (!isSeq(node)) {
+            // node is not an array
+            return undefined;
+        }
+        return node.items.find((item) => isMap(item) && item.get('name') === name);
+    }
+    getModelByName(name) {
+        const model = this.findModelByName(name);
+        if (!model) {
+            throw new Error(`Model ${name} not found`);
+        }
+        return model;
+    }
+    findColumnByName(modelName, columnName) {
+        const model = this.findModelByName(modelName);
+        if (!model) {
+            // model not found
+            return undefined;
+        }
+        const columns = model.getIn(['columns']);
+        if (!isSeq(columns)) {
+            // node is not an array
+            return undefined;
+        }
+        return columns.items.find((item) => isMap(item) && item.get('name') === columnName);
+    }
+    findFirstColumnFromModelByName(name) {
+        const model = this.findModelByName(name);
+        if (!model) {
+            return undefined;
+        }
+        return model.getIn(['columns', 0]);
+    }
+    getColumnByName(modelName, columnName) {
+        const column = this.findColumnByName(modelName, columnName);
+        if (!column) {
+            throw new Error(`Column ${columnName} not found in model ${modelName}`);
+        }
+        return column;
+    }
+    hasModels() {
+        const models = this.doc.get('models');
+        return isSeq(models) && models.items.length > 0;
+    }
+    getModelColumns(modelName) {
+        const model = this.findModelByName(modelName);
+        if (!model) {
+            // model not found
+            return undefined;
+        }
+        const columns = model.getIn(['columns']);
+        if (!isSeq(columns)) {
+            // node is not an array
+            return undefined;
+        }
+        return columns.items
+            .filter(isMap)
+            .map((column) => column.toJSON());
+    }
+    addModel(model) {
+        const models = this.doc.get('models');
+        if (!isSeq(models)) {
+            // create models array
+            this.doc.set('models', [model]);
+        }
+        else {
+            // add model to existing models
+            models.items.push(model);
+        }
+        return this;
+    }
+    addColumn(modelName, column) {
+        const model = this.findModelByName(modelName);
+        if (!model) {
+            // model not found
+            throw new Error(`Model ${modelName} not found`);
+        }
+        if (this.findColumnByName(modelName, column.name)) {
+            throw new Error(`Column ${column.name} already exists in model ${modelName}`);
+        }
+        // If columns doesn't exist, create a new YAMLSeq
+        if (!isSeq(model.get('columns'))) {
+            model.set('columns', new YAMLSeq());
+        }
+        // Add the new column
+        model.addIn(['columns'], column);
+        return this;
+    }
+    removeColumns(modelName, columnNames) {
+        const model = this.getModelByName(modelName);
+        const columns = model.getIn(['columns']);
+        if (!isSeq(columns)) {
+            throw new Error(`Model ${modelName} has invalid columns array`);
+        }
+        columnNames.forEach((columnName) => {
+            const index = columns.items.findIndex((item) => isMap(item) && item.get('name') === columnName);
+            if (index !== -1) {
+                model.deleteIn(['columns', index]);
+            }
+        });
+        return this;
+    }
+    addCustomMetrics(customMetricsToAdd) {
+        customMetricsToAdd.forEach((metric) => {
+            if (metric.baseDimensionName === undefined) {
+                throw new Error(`Metric ${metric.name} is missing baseDimensionName`);
+            }
+            const column = this.findColumnByName(metric.table, metric.baseDimensionName);
+            if (!column) {
+                throw new Error(`Column ${metric.baseDimensionName} not found in model ${metric.table}`);
+            }
+            // For dbt >= 1.10, meta should be inside config
+            if (isDbtVersion110OrHigher(this.dbtVersion)) {
+                column.setIn(['config', 'meta', 'metrics', metric.name], convertCustomMetricToDbt(metric));
+            }
+            else {
+                column.setIn(['meta', 'metrics', metric.name], convertCustomMetricToDbt(metric));
+            }
+        });
+        return this;
+    }
+    addCustomDimensions(customDimensionsToAdd, warehouseClient) {
+        customDimensionsToAdd.forEach((dimension) => {
+            this.addCustomDimension(dimension, warehouseClient);
+        });
+        return this;
+    }
+    addCustomDimension(customDimension, warehouseClient) {
+        if (isCustomSqlDimension(customDimension)) {
+            this.addCustomSqlDimension(customDimension);
+        }
+        else {
+            this.addCustomBinDimension(customDimension, warehouseClient);
+        }
+        return this;
+    }
+    addCustomBinDimension(customDimension, warehouseSqlBuilder) {
+        // Extract base dimension name from custom dimension id. Eg: `table_a_dim_a` -> `dim_a`
+        const baseDimensionName = customDimension.dimensionId.replace(`${customDimension.table}_`, '');
+        const column = this.findColumnByName(customDimension.table, baseDimensionName);
+        if (!column) {
+            throw new Error(`Column ${baseDimensionName} not found in model ${customDimension.table}`);
+        }
+        // Generate base dimension SQL
+        let baseDimensionSql = defaultSql(baseDimensionName);
+        // Use base dimension custom SQL if exists
+        const columnSql = column.getIn(['meta', 'dimension', 'sql']);
+        if (isScalar(columnSql) && typeof columnSql.value === 'string') {
+            baseDimensionSql = columnSql.value;
+        }
+        // For dbt >= 1.10, meta should be inside config
+        if (isDbtVersion110OrHigher(this.dbtVersion)) {
+            column.setIn(['config', 'meta', 'additional_dimensions', customDimension.id], convertCustomBinDimensionToDbt({
+                customDimension,
+                baseDimensionSql,
+                warehouseSqlBuilder,
+            }));
+        }
+        else {
+            column.setIn(['meta', 'additional_dimensions', customDimension.id], convertCustomBinDimensionToDbt({
+                customDimension,
+                baseDimensionSql,
+                warehouseSqlBuilder,
+            }));
+        }
+        return this;
+    }
+    addCustomSqlDimension(customDimension) {
+        const model = this.findModelByName(customDimension.table);
+        if (!model) {
+            throw new Error(`Model ${customDimension.table} not found`);
+        }
+        const refs = parseAllReferences(customDimension.sql, customDimension.table);
+        let firstRefFromSameTable = refs.find((ref) => !!this.findColumnByName(customDimension.table, ref.refName))?.refName;
+        if (!firstRefFromSameTable) {
+            firstRefFromSameTable = this.findFirstColumnFromModelByName(customDimension.table)?.get('name');
+            if (!firstRefFromSameTable) {
+                throw new Error(`No columns found in model ${customDimension.table}`);
+            }
+        }
+        const additionalDimension = convertCustomSqlDimensionToDbt(customDimension);
+        const column = this.findColumnByName(customDimension.table, firstRefFromSameTable);
+        if (!column) {
+            throw new Error(`Column ${firstRefFromSameTable} not found in model ${customDimension.table}`);
+        }
+        // For dbt >= 1.10, meta should be inside config
+        if (isDbtVersion110OrHigher(this.dbtVersion)) {
+            column.setIn(['config', 'meta', 'additional_dimensions', customDimension.id], additionalDimension);
+        }
+        else {
+            column.setIn(['meta', 'additional_dimensions', customDimension.id], additionalDimension);
+        }
+        return this;
+    }
+    /**
+     * Update column properties(deep) in the schema.
+     * Null values can be used to remove properties.
+     * Undefined values are ignored.
+     * Usage:
+     * editor.updateColumn({
+     *  modelName: 'my_model',
+     *  columnName: 'my_column',
+     *  properties: {
+     *    description: 'new description',
+     *    meta: {
+     *      type: 'string',
+     *      label: null, // remove label
+     *    }
+     *  }
+     */
+    updateColumn({ modelName, columnName, properties = {}, }) {
+        const column = this.getColumnByName(modelName, columnName);
+        // Update schema properties recursively if value is an object
+        function applyUpdates(path, value) {
+            if (value === undefined) {
+                return;
+            }
+            if (typeof value === 'object' && value !== null) {
+                const existingValue = column.getIn(path);
+                if (existingValue && typeof existingValue === 'object') {
+                    Object.entries(value).forEach(([key, val]) => applyUpdates([...path, key], val));
+                    return;
+                }
+            }
+            column.setIn(path, value);
+        }
+        Object.entries(properties).forEach(([key, value]) => applyUpdates([key], value));
+    }
+    // Returns the updated schema as a string(YAML)
+    toString(options) {
+        return this.doc.toString({
+            /**
+             * Use 'single quote' rather than "double quote" where applicable.
+             * Set to `false` to disable single quotes completely.
+             * Set to `null` to keep the original quotes.
+             *
+             * Once we allow the user to set the quote char in the UI, we can enforce the quote char for the entire file.
+             * Until then, we try to keep the original quotes by defaulting to null.
+             */
+            singleQuote: options?.quoteChar && options.quoteChar === `'` ? true : null,
+        });
+    }
+    // Returns the updated schema as a JSON object
+    toJS() {
+        return this.doc.toJS();
+    }
+}
+//# sourceMappingURL=DbtSchemaEditor.js.map

package/dist/types/dbt/DbtSchemaEditor/DbtSchemaEditor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DbtSchemaEditor.js","sourceRoot":"","sources":["../../../../src/dbt/DbtSchemaEditor/DbtSchemaEditor.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,EACH,KAAK,EACL,QAAQ,EACR,KAAK,EACL,aAAa,EACb,OAAO,GAGV,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,sBAAsB,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EACH,UAAU,EACV,oBAAoB,GAIvB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACH,uBAAuB,GAE1B,MAAM,sBAAsB,CAAC;AAU9B,OAAO,EACH,8BAA8B,EAC9B,8BAA8B,GACjC,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAElF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAKhC,YACI,MAAc,EAAE,EAChB,WAAmB,EAAE,EACrB,UAAiC;QAEjC,IAAI,CAAC,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC;YACxB,WAAW,EAAE,IAAI;YACjB,eAAe,EAAE,IAAI;SACxB,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAChC,sBAAsB,CACzB,CAAC;QACF,MAAM,UAAU,GAAY,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAC5C,IAAI,UAAU,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACtC,MAAM,MAAM,GAAG,eAAe,CAC1B,sBAAsB,EACtB,UAAU,EACV,QAAQ,CAAC,MAAM,IAAI,EAAE,EACrB,EAAE,MAAM,EAAE,CAAC,EAAE,CAChB,CAAC;YACF,MAAM,IAAI,UAAU,CAAC,wBAAwB,QAAQ,KAAK,MAAM,EAAE,CAAC,CAAC;QACxE,CAAC;IACL,CAAC;IAED,uBAAuB;QACnB,OAAO,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpD,CAAC;IAED,eAAe,CAAC,IAAY;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACf,uBAAuB;YACvB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAClB,CAAC,IAAI,EAAqC,EAAE,CACxC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,CAC/C,CAAC;IACN,CAAC;IAED,cAAc,CAAC,IAAY;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,YAAY,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,gBAAgB,CAAC,SAAiB,EAAE,UAAkB;QAClD,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,kBAAkB;YAClB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YAClB,uBAAuB;YACvB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,CACrB,CAAC,IAAI,EAAqC,EAAE,CACxC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,UAAU,CACrD,CAAC;IACN,CAAC;IAEO,8BAA8B,CAAC,IAAY;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAElB,CAAC;IACpB,CAAC;IAED,eAAe,CAAC,SAAiB,EAAE,UAAkB;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CACX,UAAU,UAAU,uBAAuB,SAAS,EAAE,CACzD,CAAC;QACN,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,SAAS;QACL,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACtC,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IACpD,CAAC;IAED,eAAe,CAAC,SAAiB;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,kBAAkB;YAClB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YAClB,uBAAuB;YACvB,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,OAAO,CAAC,KAAK;aACf,MAAM,CAAC,KAAK,CAAC;aACb,GAAG,CAAa,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,QAAQ,CAAC,KAAgB;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACjB,sBAAsB;YACtB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACJ,+BAA+B;YAC/B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,SAAS,CAAC,SAAiB,EAAE,MAAkB;QAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,kBAAkB;YAClB,MAAM,IAAI,KAAK,CAAC,SAAS,SAAS,YAAY,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CACX,UAAU,MAAM,CAAC,IAAI,4BAA4B,SAAS,EAAE,CAC/D,CAAC;QACN,CAAC;QAED,iDAAiD;QACjD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAC/B,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,OAAO,EAAE,CAAC,CAAC;QACxC,CAAC;QAED,qBAAqB;QACrB,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,aAAa,CAAC,SAAiB,EAAE,WAAqB;QAClD,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QAC7C,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,SAAS,SAAS,4BAA4B,CAAC,CAAC;QACpE,CAAC;QACD,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CACjC,CAAC,IAAI,EAAqC,EAAE,CACxC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,UAAU,CACrD,CAAC;YACF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACf,KAAK,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;YACvC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,gBAAgB,CAAC,kBAAsC;QACnD,kBAAkB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAClC,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CACX,UAAU,MAAM,CAAC,IAAI,+BAA+B,CACvD,CAAC;YACN,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAChC,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,iBAAiB,CAC3B,CAAC;YACF,IAAI,CAAC,MAAM,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CACX,UAAU,MAAM,CAAC,iBAAiB,uBAAuB,MAAM,CAAC,KAAK,EAAE,CAC1E,CAAC;YACN,CAAC;YAED,gDAAgD;YAChD,IAAI,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC3C,MAAM,CAAC,KAAK,CACR,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,EAC1C,wBAAwB,CAAC,MAAM,CAAC,CACnC,CAAC;YACN,CAAC;iBAAM,CAAC;gBACJ,MAAM,CAAC,KAAK,CACR,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,EAChC,wBAAwB,CAAC,MAAM,CAAC,CACnC,CAAC;YACN,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,mBAAmB,CACf,qBAAwC,EACxC,eAAgC;QAEhC,qBAAqB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YACxC,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,kBAAkB,CACd,eAAgC,EAChC,eAAgC;QAEhC,IAAI,oBAAoB,CAAC,eAAe,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,qBAAqB,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;QACjE,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEO,qBAAqB,CACzB,eAAmC,EACnC,mBAAwC;QAExC,uFAAuF;QACvF,MAAM,iBAAiB,GAAG,eAAe,CAAC,WAAW,CAAC,OAAO,CACzD,GAAG,eAAe,CAAC,KAAK,GAAG,EAC3B,EAAE,CACL,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAChC,eAAe,CAAC,KAAK,EACrB,iBAAiB,CACpB,CAAC;QACF,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CACX,UAAU,iBAAiB,uBAAuB,eAAe,CAAC,KAAK,EAAE,CAC5E,CAAC;QACN,CAAC;QAED,8BAA8B;QAC9B,IAAI,gBAAgB,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC;QACrD,0CAA0C;QAC1C,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;QAC7D,IAAI,QAAQ,CAAC,SAAS,CAAC,IAAI,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC7D,gBAAgB,GAAG,SAAS,CAAC,KAAK,CAAC;QACvC,CAAC;QAED,gDAAgD;QAChD,IAAI,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC3C,MAAM,CAAC,KAAK,CACR,CAAC,QAAQ,EAAE,MAAM,EAAE,uBAAuB,EAAE,eAAe,CAAC,EAAE,CAAC,EAC/D,8BAA8B,CAAC;gBAC3B,eAAe;gBACf,gBAAgB;gBAChB,mBAAmB;aACtB,CAAC,CACL,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,KAAK,CACR,CAAC,MAAM,EAAE,uBAAuB,EAAE,eAAe,CAAC,EAAE,CAAC,EACrD,8BAA8B,CAAC;gBAC3B,eAAe;gBACf,gBAAgB;gBAChB,mBAAmB;aACtB,CAAC,CACL,CAAC;QACN,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEO,qBAAqB,CACzB,eAAmC;QAEnC,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC1D,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CAAC,SAAS,eAAe,CAAC,KAAK,YAAY,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,IAAI,GAAG,kBAAkB,CAC3B,eAAe,CAAC,GAAG,EACnB,eAAe,CAAC,KAAK,CACxB,CAAC;QACF,IAAI,qBAAqB,GAAG,IAAI,CAAC,IAAI,CACjC,CAAC,GAAG,EAAE,EAAE,CACJ,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAClE,EAAE,OAAO,CAAC;QAEX,IAAI,CAAC,qBAAqB,EAAE,CAAC;YACzB,qBAAqB,GAAG,IAAI,CAAC,8BAA8B,CACvD,eAAe,CAAC,KAAK,CACxB,EAAE,GAAG,CAAC,MAAM,CAAW,CAAC;YACzB,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACX,6BAA6B,eAAe,CAAC,KAAK,EAAE,CACvD,CAAC;YACN,CAAC;QACL,CAAC;QAED,MAAM,mBAAmB,GACrB,8BAA8B,CAAC,eAAe,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAChC,eAAe,CAAC,KAAK,EACrB,qBAAqB,CACxB,CAAC;QACF,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CACX,UAAU,qBAAqB,uBAAuB,eAAe,CAAC,KAAK,EAAE,CAChF,CAAC;QACN,CAAC;QACD,gDAAgD;QAChD,IAAI,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC3C,MAAM,CAAC,KAAK,CACR,CAAC,QAAQ,EAAE,MAAM,EAAE,uBAAuB,EAAE,eAAe,CAAC,EAAE,CAAC,EAC/D,mBAAmB,CACtB,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,KAAK,CACR,CAAC,MAAM,EAAE,uBAAuB,EAAE,eAAe,CAAC,EAAE,CAAC,EACrD,mBAAmB,CACtB,CAAC;QACN,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,EACT,SAAS,EACT,UAAU,EACV,UAAU,GAAG,EAAE,GAKlB;QACG,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAE3D,6DAA6D;QAC7D,SAAS,YAAY,CAAC,IAAc,EAAE,KAAc;YAChD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACtB,OAAO;YACX,CAAC;YACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC9C,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACzC,IAAI,aAAa,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;oBACrD,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CACzC,YAAY,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CACpC,CAAC;oBACF,OAAO;gBACX,CAAC;YACL,CAAC;YACD,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;QAED,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAChD,YAAY,CAAC,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAC7B,CAAC;IACN,CAAC;IAED,+CAA+C;IAC/C,QAAQ,CAAC,OAAmC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;YACrB;;;;;;;eAOG;YACH,WAAW,EACP,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;SACpE,CAAC,CAAC;IACP,CAAC;IAED,8CAA8C;IAC9C,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;CACJ"}

package/dist/types/dbt/DbtSchemaEditor/DbtSchemaEditor.mock.js

@@ -0,0 +1,224 @@
+// Mock schema file with comments, different multi-line strings, different types of quotes, different types of arrays
+import { BinType, CustomDimensionType, DimensionType, MetricType, } from '../../types/field';
+export const SCHEMA_YML = `# comment at the top
+version: 2
+models:
+  - name: table_a
+    description: |
+      # Description
+      This table has basic information
+    columns:
+      - name: dim_a
+        tests:
+          - unique
+          - not_null
+        meta:
+          metrics:
+            metric_a:
+              type: count_distinct
+            metric_b:
+              type: sum
+  - name: table_b
+    description: >-
+      # Description This table has basic information
+    columns:
+      - name: dim_a
+        tests: [ "unique", 'not_null' ]
+        meta:
+          metrics:
+            metric_a:
+              type: count_distinct
+            metric_b:
+              type: sum
+`;
+export const SCHEMA_JSON = {
+    version: 2,
+    models: [
+        {
+            name: 'table_a',
+            description: '# Description\nThis table has basic information\n',
+            columns: [
+                {
+                    name: 'dim_a',
+                    tests: ['unique', 'not_null'],
+                    meta: {
+                        metrics: {
+                            metric_a: {
+                                type: 'count_distinct',
+                            },
+                            metric_b: {
+                                type: 'sum',
+                            },
+                        },
+                    },
+                },
+            ],
+        },
+        {
+            name: 'table_b',
+            description: '# Description This table has basic information',
+            columns: [
+                {
+                    name: 'dim_a',
+                    tests: ['unique', 'not_null'],
+                    meta: {
+                        metrics: {
+                            metric_a: {
+                                type: 'count_distinct',
+                            },
+                            metric_b: {
+                                type: 'sum',
+                            },
+                        },
+                    },
+                },
+            ],
+        },
+    ],
+};
+export const SIMPLE_SCHEMA = `version: 2
+models:
+  - name: test_table
+    columns:
+      - name: test_column
+        description: A test column`;
+// invalid schema: models require a `name` field
+export const INVALID_SCHEMA_YML = `
+version: 2
+models:
+ - label: table_a
+`;
+export const CUSTOM_METRIC = {
+    name: 'new_metric',
+    description: 'description',
+    sql: 'sql',
+    type: MetricType.AVERAGE,
+    table: 'table_a',
+    baseDimensionName: 'dim_a',
+};
+export const CUSTOM_SQL_DIMENSION = {
+    id: 'id',
+    name: 'sql_dimension',
+    table: 'table_a',
+    type: CustomDimensionType.SQL,
+    sql: '${table_a.dim_a} || "suffix"',
+    dimensionType: DimensionType.STRING,
+};
+export const FIXED_WIDTH_BIN_DIMENSION = {
+    id: 'fixed_width_id',
+    name: 'fixed width name',
+    table: 'table_a',
+    dimensionId: 'table_a_dim_a',
+    type: CustomDimensionType.BIN,
+    binType: BinType.FIXED_WIDTH,
+    binWidth: 10,
+};
+export const CUSTOM_RANGE_BIN_DIMENSION = {
+    id: 'range_id',
+    name: 'range name',
+    table: 'table_a',
+    dimensionId: 'table_a_dim_a',
+    type: CustomDimensionType.BIN,
+    binType: BinType.CUSTOM_RANGE,
+    customRange: [
+        {
+            from: 0,
+            to: 10,
+        },
+        {
+            from: 11,
+            to: 20,
+        },
+    ],
+};
+// eslint-disable-next-line no-useless-escape
+export const EXPECTED_SCHEMA_YML_WITH_NEW_METRICS_AND_DIMENSIONS = `# comment at the top
+version: 2
+models:
+  - name: table_a
+    description: |
+      # Description
+      This table has basic information
+    columns:
+      - name: dim_a
+        tests:
+          - unique
+          - not_null
+        meta:
+          metrics:
+            metric_a:
+              type: count_distinct
+            metric_b:
+              type: sum
+            new_metric:
+              label: New metric
+              description: description
+              type: average
+              format: "#,##0.000"
+          additional_dimensions:
+            id:
+              label: Sql dimension
+              type: string
+              sql: \${table_a.dim_a} || "suffix"
+            fixed_width_id:
+              label: Fixed width name
+              type: string
+              sql: CONCAT(FLOOR(\${TABLE}.dim_a / 10) * 10, ' - ', (FLOOR(\${TABLE}.dim_a / 10)
+                + 1) * 10 - 1)
+            range_id:
+              label: Range name
+              type: string
+              sql: >-
+                CASE
+                            WHEN \${TABLE}.dim_a IS NULL THEN NULL
+                WHEN \${TABLE}.dim_a >= 0 AND \${TABLE}.dim_a < 10 THEN CONCAT(0,
+                '-', 10)
+
+                WHEN \${TABLE}.dim_a >= 11 AND \${TABLE}.dim_a < 20 THEN
+                CONCAT(11, '-', 20)
+                            END
+  - name: table_b
+    description: >-
+      # Description This table has basic information
+    columns:
+      - name: dim_a
+        tests: [ "unique", 'not_null' ]
+        meta:
+          metrics:
+            metric_a:
+              type: count_distinct
+            metric_b:
+              type: sum
+`;
+export const NEW_MODEL = {
+    name: 'new_model',
+    description: `SQL model for testing`,
+    meta: {
+        label: 'New model',
+    },
+    columns: [
+        {
+            name: 'new_column',
+            meta: {
+                dimension: {
+                    type: DimensionType.STRING,
+                },
+            },
+        },
+    ],
+};
+export const EXPECTED_SCHEMA_JSON_WITH_NEW_MODEL = {
+    models: [NEW_MODEL],
+};
+export const EXPECTED_SCHEMA_YML_WITH_NEW_MODEL = `models:
+  - name: new_model
+    description: SQL model for testing
+    meta:
+      label: New model
+    columns:
+      - name: new_column
+        meta:
+          dimension:
+            type: string
+`;
+//# sourceMappingURL=DbtSchemaEditor.mock.js.map

package/dist/types/dbt/DbtSchemaEditor/DbtSchemaEditor.mock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DbtSchemaEditor.mock.js","sourceRoot":"","sources":["../../../../src/dbt/DbtSchemaEditor/DbtSchemaEditor.mock.ts"],"names":[],"mappings":"AAAA,qHAAqH;AACrH,OAAO,EACH,OAAO,EAEP,mBAAmB,EAEnB,aAAa,EACb,UAAU,GACb,MAAM,mBAAmB,CAAC;AAG3B,MAAM,CAAC,MAAM,UAAU,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BzB,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB,OAAO,EAAE,CAAC;IACV,MAAM,EAAE;QACJ;YACI,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,mDAAmD;YAChE,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;oBAC7B,IAAI,EAAE;wBACF,OAAO,EAAE;4BACL,QAAQ,EAAE;gCACN,IAAI,EAAE,gBAAgB;6BACzB;4BACD,QAAQ,EAAE;gCACN,IAAI,EAAE,KAAK;6BACd;yBACJ;qBACJ;iBACJ;aACJ;SACJ;QACD;YACI,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,gDAAgD;YAC7D,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;oBAC7B,IAAI,EAAE;wBACF,OAAO,EAAE;4BACL,QAAQ,EAAE;gCACN,IAAI,EAAE,gBAAgB;6BACzB;4BACD,QAAQ,EAAE;gCACN,IAAI,EAAE,KAAK;6BACd;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ;CACJ,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG;;;;;mCAKM,CAAC;AAEpC,gDAAgD;AAChD,MAAM,CAAC,MAAM,kBAAkB,GAAG;;;;CAIjC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAqB;IAC3C,IAAI,EAAE,YAAY;IAClB,WAAW,EAAE,aAAa;IAC1B,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,UAAU,CAAC,OAAO;IACxB,KAAK,EAAE,SAAS;IAChB,iBAAiB,EAAE,OAAO;CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAuB;IACpD,EAAE,EAAE,IAAI;IACR,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,SAAS;IAChB,IAAI,EAAE,mBAAmB,CAAC,GAAG;IAC7B,GAAG,EAAE,8BAA8B;IACnC,aAAa,EAAE,aAAa,CAAC,MAAM;CACtC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAuB;IACzD,EAAE,EAAE,gBAAgB;IACpB,IAAI,EAAE,kBAAkB;IACxB,KAAK,EAAE,SAAS;IAChB,WAAW,EAAE,eAAe;IAC5B,IAAI,EAAE,mBAAmB,CAAC,GAAG;IAC7B,OAAO,EAAE,OAAO,CAAC,WAAW;IAC5B,QAAQ,EAAE,EAAE;CACf,CAAC;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAuB;IAC1D,EAAE,EAAE,UAAU;IACd,IAAI,EAAE,YAAY;IAClB,KAAK,EAAE,SAAS;IAChB,WAAW,EAAE,eAAe;IAC5B,IAAI,EAAE,mBAAmB,CAAC,GAAG;IAC7B,OAAO,EAAE,OAAO,CAAC,YAAY;IAC7B,WAAW,EAAE;QACT;YACI,IAAI,EAAE,CAAC;YACP,EAAE,EAAE,EAAE;SACT;QACD;YACI,IAAI,EAAE,EAAE;YACR,EAAE,EAAE,EAAE;SACT;KACJ;CACJ,CAAC;AAEF,6CAA6C;AAC7C,MAAM,CAAC,MAAM,mDAAmD,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyDlE,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG;IACrB,IAAI,EAAE,WAAW;IACjB,WAAW,EAAE,uBAAuB;IACpC,IAAI,EAAE;QACF,KAAK,EAAE,WAAW;KACrB;IACD,OAAO,EAAE;QACL;YACI,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE;gBACF,SAAS,EAAE;oBACP,IAAI,EAAE,aAAa,CAAC,MAAM;iBAC7B;aACJ;SACJ;KACJ;CACJ,CAAC;AAEF,MAAM,CAAC,MAAM,mCAAmC,GAAG;IAC/C,MAAM,EAAE,CAAC,SAAS,CAAC;CACtB,CAAC;AAEF,MAAM,CAAC,MAAM,kCAAkC,GAAG;;;;;;;;;;CAUjD,CAAC"}

package/dist/types/dbt/DbtSchemaEditor/DbtSchemaEditor.test.js

@@ -0,0 +1,129 @@
+import { warehouseClientMock } from '../../compiler/exploreCompiler.mock';
+import { ParseError } from '../../types/errors';
+import { CustomDimensionType, DimensionType, MetricType, } from '../../types/field';
+import { SupportedDbtVersions } from '../../types/projects';
+import DbtSchemaEditor from './DbtSchemaEditor';
+import { CUSTOM_METRIC, CUSTOM_RANGE_BIN_DIMENSION, CUSTOM_SQL_DIMENSION, EXPECTED_SCHEMA_JSON_WITH_NEW_MODEL, EXPECTED_SCHEMA_YML_WITH_NEW_METRICS_AND_DIMENSIONS, EXPECTED_SCHEMA_YML_WITH_NEW_MODEL, FIXED_WIDTH_BIN_DIMENSION, INVALID_SCHEMA_YML, NEW_MODEL, SCHEMA_JSON, SCHEMA_YML, SIMPLE_SCHEMA, } from './DbtSchemaEditor.mock';
+describe('DbtSchemaEditor', () => {
+    it('should load the yaml schema and convert to JS and YML', () => {
+        const editor = new DbtSchemaEditor(SCHEMA_YML);
+        // can convert to JS
+        expect(editor.toJS()).toEqual(SCHEMA_JSON);
+        // can convert back to string
+        expect(editor.toString()).toEqual(SCHEMA_YML);
+    });
+    it('should throw error with invalid yaml schema', () => {
+        expect(() => new DbtSchemaEditor(INVALID_SCHEMA_YML)).toThrowError(ParseError);
+    });
+    it('should update a model with custom metrics and custom dimensions', () => {
+        const editor = new DbtSchemaEditor(SCHEMA_YML);
+        // confirms it has models
+        expect(editor.hasModels()).toEqual(true);
+        // adds custom metrics
+        editor.addCustomMetrics([CUSTOM_METRIC]);
+        editor.addCustomDimensions([
+            CUSTOM_SQL_DIMENSION,
+            FIXED_WIDTH_BIN_DIMENSION,
+            CUSTOM_RANGE_BIN_DIMENSION,
+        ], warehouseClientMock);
+        expect(editor.toString()).toEqual(EXPECTED_SCHEMA_YML_WITH_NEW_METRICS_AND_DIMENSIONS);
+    });
+    it('should create a new file', () => {
+        const editor = new DbtSchemaEditor('');
+        // confirm it has no models
+        expect(editor.hasModels()).toEqual(false);
+        // add a new model
+        editor.addModel(NEW_MODEL);
+        expect(editor.hasModels()).toEqual(true);
+        expect(editor.toJS()).toEqual(EXPECTED_SCHEMA_JSON_WITH_NEW_MODEL);
+        expect(editor.toString()).toEqual(EXPECTED_SCHEMA_YML_WITH_NEW_MODEL);
+    });
+});
+describe('dbt v1.10+ compatibility', () => {
+    it('should add custom metrics under config.meta for dbt v1.10', () => {
+        const editor = new DbtSchemaEditor(SIMPLE_SCHEMA, '', SupportedDbtVersions.V1_10);
+        editor.addCustomMetrics([
+            {
+                name: 'test_metric',
+                description: 'Test metric',
+                sql: 'COUNT(*)',
+                type: MetricType.COUNT,
+                table: 'test_table',
+                baseDimensionName: 'test_column',
+            },
+        ]);
+        const result = editor.toString().replace(/\s+/g, '');
+        // Check that the structure is config->meta->metrics (no spaces)
+        expect(result).toContain('config:meta:metrics:');
+        // Ensure meta is not directly at column level
+        expect(result).not.toContain('description:Atestcolumnmeta:');
+    });
+    it('should add custom metrics directly under meta for dbt v1.9', () => {
+        const editor = new DbtSchemaEditor(SIMPLE_SCHEMA, '', SupportedDbtVersions.V1_9);
+        editor.addCustomMetrics([
+            {
+                name: 'test_metric',
+                description: 'Test metric',
+                sql: 'COUNT(*)',
+                type: MetricType.COUNT,
+                table: 'test_table',
+                baseDimensionName: 'test_column',
+            },
+        ]);
+        const result = editor.toString().replace(/\s+/g, '');
+        // Check that meta is NOT inside config
+        expect(result).not.toContain('config:meta:metrics:');
+        // Check that meta is directly at column level
+        expect(result).toContain('description:Atestcolumnmeta:metrics:');
+    });
+    it('should add custom dimensions under config.meta for dbt v1.10', () => {
+        const editor = new DbtSchemaEditor(SIMPLE_SCHEMA, '', SupportedDbtVersions.V1_10);
+        editor.addCustomDimensions([
+            {
+                id: 'custom_dim',
+                name: 'Custom Dimension',
+                table: 'test_table',
+                type: CustomDimensionType.SQL,
+                sql: '${test_table.test_column} || "_suffix"',
+                dimensionType: DimensionType.STRING,
+            },
+        ], warehouseClientMock);
+        const result = editor.toString().replace(/\s+/g, '');
+        // Check that the structure is config->meta->additional_dimensions (no spaces)
+        expect(result).toContain('config:meta:additional_dimensions:');
+        // Ensure meta is not directly at column level
+        expect(result).not.toContain('description:Atestcolumnmeta:');
+    });
+    it('should add custom dimensions directly under meta for dbt v1.9', () => {
+        const editor = new DbtSchemaEditor(SIMPLE_SCHEMA, '', SupportedDbtVersions.V1_9);
+        editor.addCustomDimensions([
+            {
+                id: 'custom_dim',
+                name: 'Custom Dimension',
+                table: 'test_table',
+                type: CustomDimensionType.SQL,
+                sql: '${test_table.test_column} || "_suffix"',
+                dimensionType: DimensionType.STRING,
+            },
+        ], warehouseClientMock);
+        const result = editor.toString().replace(/\s+/g, '');
+        // Check that meta is NOT inside config
+        expect(result).not.toContain('config:meta:additional_dimensions:');
+        // Check that meta is directly at column level
+        expect(result).toContain('description:Atestcolumnmeta:additional_dimensions:');
+    });
+    it('should handle dbt versions correctly in isDbtVersion110OrHigher', () => {
+        // Test v1.9 and below
+        const editorV19 = new DbtSchemaEditor('version: 2', '', SupportedDbtVersions.V1_9);
+        expect(editorV19.isDbtVersion110OrHigher()).toBe(false);
+        const editorV18 = new DbtSchemaEditor('version: 2', '', SupportedDbtVersions.V1_8);
+        expect(editorV18.isDbtVersion110OrHigher()).toBe(false);
+        // Test v1.10
+        const editorV110 = new DbtSchemaEditor('version: 2', '', SupportedDbtVersions.V1_10);
+        expect(editorV110.isDbtVersion110OrHigher()).toBe(true);
+        // Test undefined version (defaults to false)
+        const editorNoVersion = new DbtSchemaEditor('version: 2', '');
+        expect(editorNoVersion.isDbtVersion110OrHigher()).toBe(false);
+    });
+});
+//# sourceMappingURL=DbtSchemaEditor.test.js.map

package/dist/types/dbt/DbtSchemaEditor/DbtSchemaEditor.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DbtSchemaEditor.test.js","sourceRoot":"","sources":["../../../../src/dbt/DbtSchemaEditor/DbtSchemaEditor.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EACH,mBAAmB,EACnB,aAAa,EACb,UAAU,GACb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,EACH,aAAa,EACb,0BAA0B,EAC1B,oBAAoB,EACpB,mCAAmC,EACnC,mDAAmD,EACnD,kCAAkC,EAClC,yBAAyB,EACzB,kBAAkB,EAClB,SAAS,EACT,WAAW,EACX,UAAU,EACV,aAAa,GAChB,MAAM,wBAAwB,CAAC;AAEhC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC7D,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,UAAU,CAAC,CAAC;QAC/C,oBAAoB;QACpB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC3C,6BAA6B;QAC7B,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACnD,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,YAAY,CAC9D,UAAU,CACb,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACvE,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,UAAU,CAAC,CAAC;QAC/C,yBAAyB;QACzB,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACzC,sBAAsB;QACtB,MAAM,CAAC,gBAAgB,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,mBAAmB,CACtB;YACI,oBAAoB;YACpB,yBAAyB;YACzB,0BAA0B;SAC7B,EACD,mBAAmB,CACtB,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAC7B,mDAAmD,CACtD,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAChC,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,EAAE,CAAC,CAAC;QACvC,2BAA2B;QAC3B,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE1C,kBAAkB;QAClB,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,mCAAmC,CAAC,CAAC;QACnE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACtC,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACjE,MAAM,MAAM,GAAG,IAAI,eAAe,CAC9B,aAAa,EACb,EAAE,EACF,oBAAoB,CAAC,KAAK,CAC7B,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC;YACpB;gBACI,IAAI,EAAE,aAAa;gBACnB,WAAW,EAAE,aAAa;gBAC1B,GAAG,EAAE,UAAU;gBACf,IAAI,EAAE,UAAU,CAAC,KAAK;gBACtB,KAAK,EAAE,YAAY;gBACnB,iBAAiB,EAAE,aAAa;aACnC;SACJ,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACrD,gEAAgE;QAChE,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QACjD,8CAA8C;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QAClE,MAAM,MAAM,GAAG,IAAI,eAAe,CAC9B,aAAa,EACb,EAAE,EACF,oBAAoB,CAAC,IAAI,CAC5B,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC;YACpB;gBACI,IAAI,EAAE,aAAa;gBACnB,WAAW,EAAE,aAAa;gBAC1B,GAAG,EAAE,UAAU;gBACf,IAAI,EAAE,UAAU,CAAC,KAAK;gBACtB,KAAK,EAAE,YAAY;gBACnB,iBAAiB,EAAE,aAAa;aACnC;SACJ,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACrD,uCAAuC;QACvC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QACrD,8CAA8C;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACpE,MAAM,MAAM,GAAG,IAAI,eAAe,CAC9B,aAAa,EACb,EAAE,EACF,oBAAoB,CAAC,KAAK,CAC7B,CAAC;QACF,MAAM,CAAC,mBAAmB,CACtB;YACI;gBACI,EAAE,EAAE,YAAY;gBAChB,IAAI,EAAE,kBAAkB;gBACxB,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,mBAAmB,CAAC,GAAG;gBAC7B,GAAG,EAAE,wCAAwC;gBAC7C,aAAa,EAAE,aAAa,CAAC,MAAM;aACtC;SACJ,EACD,mBAAmB,CACtB,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACrD,8EAA8E;QAC9E,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,oCAAoC,CAAC,CAAC;QAC/D,8CAA8C;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACrE,MAAM,MAAM,GAAG,IAAI,eAAe,CAC9B,aAAa,EACb,EAAE,EACF,oBAAoB,CAAC,IAAI,CAC5B,CAAC;QACF,MAAM,CAAC,mBAAmB,CACtB;YACI;gBACI,EAAE,EAAE,YAAY;gBAChB,IAAI,EAAE,kBAAkB;gBACxB,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,mBAAmB,CAAC,GAAG;gBAC7B,GAAG,EAAE,wCAAwC;gBAC7C,aAAa,EAAE,aAAa,CAAC,MAAM;aACtC;SACJ,EACD,mBAAmB,CACtB,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACrD,uCAAuC;QACvC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,oCAAoC,CAAC,CAAC;QACnE,8CAA8C;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CACpB,oDAAoD,CACvD,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACvE,sBAAsB;QACtB,MAAM,SAAS,GAAG,IAAI,eAAe,CACjC,YAAY,EACZ,EAAE,EACF,oBAAoB,CAAC,IAAI,CAC5B,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,uBAAuB,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAExD,MAAM,SAAS,GAAG,IAAI,eAAe,CACjC,YAAY,EACZ,EAAE,EACF,oBAAoB,CAAC,IAAI,CAC5B,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,uBAAuB,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAExD,aAAa;QACb,MAAM,UAAU,GAAG,IAAI,eAAe,CAClC,YAAY,EACZ,EAAE,EACF,oBAAoB,CAAC,KAAK,CAC7B,CAAC;QACF,MAAM,CAAC,UAAU,CAAC,uBAAuB,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAExD,6CAA6C;QAC7C,MAAM,eAAe,GAAG,IAAI,eAAe,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QAC9D,MAAM,CAAC,eAAe,CAAC,uBAAuB,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}