HCK-10159: enable dbt feature (#130)

* HCK-10159: add dbt provider

* HCK-10159: enable dbt feature

Author: serhii-filonenko

esbuild.package.js

@@ -14,6 +14,7 @@ esbuild
 			path.resolve(__dirname, 'api', 're.js'),
 			path.resolve(__dirname, 'forward_engineering', 'api.js'),
 			path.resolve(__dirname, 'forward_engineering', 'ddlProvider.js'),
+			path.resolve(__dirname, 'forward_engineering', 'dbtProvider.js'),
 			path.resolve(__dirname, 'reverse_engineering', 'api.js'),
 		],
 		bundle: true,

forward_engineering/dbtProvider.js

@@ -0,0 +1,89 @@
+/**
+ * @typedef {import('./types').AppInstance} AppInstance
+ * @typedef {import('./types').ColumnDefinition} ColumnDefinition
+ * @typedef {import('./types').JsonSchema} JsonSchema
+ * @typedef {import('./types').ConstraintDto} ConstraintDto
+ */
+const { toLower, toUpper } = require('lodash');
+
+const types = require('./configs/types');
+const defaultTypes = require('./configs/defaultTypes');
+const getKeyHelper = require('./helpers/keyHelper');
+const getColumnDefinitionHelper = require('./helpers/columnDefinitionHelper');
+
+class DbtProvider {
+	/**
+	 * @type {AppInstance}
+	 */
+	#appInstance;
+
+	/**
+	 * @param {{ appInstance: AppInstance }}
+	 */
+	constructor({ appInstance }) {
+		this.#appInstance = appInstance;
+	}
+
+	/**
+	 * @param {{ appInstance }}
+	 * @returns {DbtProvider}
+	 */
+	static createDbtProvider({ appInstance }) {
+		return new DbtProvider({ appInstance });
+	}
+
+	/**
+	 * @param {string} type
+	 * @returns {string | undefined}
+	 */
+	getDefaultType(type) {
+		return defaultTypes[type];
+	}
+
+	/**
+	 * @returns {Record<string, object>}
+	 */
+	getTypesDescriptors() {
+		return types;
+	}
+
+	/**
+	 * @param {string} type
+	 * @returns {boolean}
+	 */
+	hasType(type) {
+		return Object.keys(types).map(toLower).includes(toLower(type));
+	}
+
+	/**
+	 * @param {{ type: string; columnDefinition: ColumnDefinition }}
+	 * @returns {string}
+	 */
+	decorateType({ type, columnDefinition }) {
+		const columnDefinitionHelper = getColumnDefinitionHelper(this.#appInstance);
+
+		return columnDefinitionHelper.decorateType(toUpper(type), columnDefinition);
+	}
+
+	/**
+	 * @param {{ jsonSchema: JsonSchema }}
+	 * @returns {ConstraintDto[]}
+	 */
+	getCompositeKeyConstraints({ jsonSchema }) {
+		const keyHelper = getKeyHelper(this.#appInstance);
+
+		return keyHelper.getCompositeKeyConstraints({ jsonSchema });
+	}
+
+	/**
+	 * @param {{ columnDefinition: ColumnDefinition; jsonSchema: JsonSchema }}
+	 * @returns {ConstraintDto[]}
+	 */
+	getColumnConstraints({ columnDefinition, jsonSchema }) {
+		const keyHelper = getKeyHelper(this.#appInstance);
+
+		return keyHelper.getColumnConstraints({ columnDefinition });
+	}
+}
+
+module.exports = DbtProvider;

forward_engineering/helpers/keyHelper.js

@@ -1,3 +1,9 @@
+/**
+ * @typedef {import('../types').ColumnDefinition} ColumnDefinition
+ * @typedef {import('../types').JsonSchema} JsonSchema
+ * @typedef {import('../types').ConstraintDto} ConstraintDto
+ */
+
 module.exports = app => {
 	const _ = app.require('lodash');
 	const { clean } = app.require('@hackolade/ddl-fe-utils').general;
@@ -184,12 +190,68 @@ module.exports = app => {
 		];
 	};
 
+	/**
+	 * @param {{ jsonSchema: JsonSchema }}
+	 * @returns {ConstraintDto[]}
+	 */
+	const getCompositeKeyConstraints = ({ jsonSchema }) => {
+		const compositePrimaryKeys = getCompositePrimaryKeys(jsonSchema);
+		const compositeUniqueKeys = getCompositeUniqueKeys(jsonSchema);
+
+		return [...compositePrimaryKeys, ...compositeUniqueKeys];
+	};
+
+	/**
+	 * @param {{ columnDefinition: ColumnDefinition }}
+	 * @returns {ConstraintDto | undefined}
+	 */
+	const getPrimaryKeyConstraint = ({ columnDefinition }) => {
+		if (!isPrimaryKey(columnDefinition)) {
+			return;
+		}
+
+		return hydratePrimaryKeyOptions(columnDefinition.primaryKeyOptions ?? {}, '', columnDefinition.isActivated);
+	};
+
+	/**
+	 * @param {{ columnDefinition: ColumnDefinition }}
+	 * @returns {ConstraintDto[]}
+	 */
+	const getUniqueKeyConstraints = ({ columnDefinition }) => {
+		if (!isUnique(columnDefinition)) {
+			return [];
+		}
+
+		if (isInlineUnique(columnDefinition)) {
+			const constraint = hydrateUniqueOptions({}, '', columnDefinition.isActivated);
+
+			return [constraint];
+		}
+
+		return columnDefinition.uniqueKeyOptions.map(uniqueKeyOption => {
+			return hydrateUniqueOptions(uniqueKeyOption, '', columnDefinition.isActivated);
+		});
+	};
+
+	/**
+	 * @param {{ columnDefinition: ColumnDefinition }}
+	 * @returns {ConstraintDto[]}
+	 */
+	const getColumnConstraints = ({ columnDefinition }) => {
+		const primaryKeyConstraint = getPrimaryKeyConstraint({ columnDefinition });
+		const uniqueKeyConstraints = getUniqueKeyConstraints({ columnDefinition });
+
+		return [primaryKeyConstraint, ...uniqueKeyConstraints].filter(Boolean);
+	};
+
 	return {
 		getTableKeyConstraints,
 		isInlineUnique,
 		isInlinePrimaryKey,
 		hydratePrimaryKeyOptions,
 		hydrateUniqueOptions,
 		getCompositePrimaryKeys,
+		getCompositeKeyConstraints,
+		getColumnConstraints,
 	};
 };

forward_engineering/types.d.ts

@@ -0,0 +1,33 @@
+export type ColumnDefinition = {
+  name: string;
+  type: string;
+  isActivated: boolean;
+  length?: number;
+  precision?: number;
+  primaryKey?: boolean;
+  scale?: number;
+  timePrecision?: number;
+  unique?: boolean;
+  primaryKeyOptions?: { GUID: string; constraintName: string };
+  uniqueKeyOptions?: Array<{ GUID: string; constraintName: string }>;
+};
+
+export type AppInstance = {
+  require: (packageName: string) => unknown;
+  general: object;
+}
+
+export type ConstraintDtoColumn = {
+  name: string;
+  isActivated: boolean;
+};
+
+export type KeyType = 'PRIMARY KEY' | 'UNIQUE';
+
+export type ConstraintDto = {
+  keyType: KeyType;
+  name: string;
+  columns?: ConstraintDtoColumn[];
+};
+
+export type JsonSchema = Record<string, unknown>;

package.json

@@ -24,7 +24,13 @@
             "nestedCollections": false,
             "disablePatternField": true,
             "disableMultipleTypes": true,
-            "enableForwardEngineering": true,
+            "enableForwardEngineering": {
+                "jsonDocument": true,
+                "jsonSchema": true,
+                "excel": true,
+                "plugin": true,
+                "dbt": true
+            },
             "disableReverseEngineering": false,
             "disableChoices": true,
             "enableJsonType": true,