@flowblade/sql-tag-format 1.1.0 → 1.1.1

package/dist/index.cjs

@@ -1,12 +1,16 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 let sql_formatter = require("sql-formatter");
+//#region \0@oxc-project+runtime@0.115.0/helpers/typeof.js
 function _typeof(o) {
 	"@babel/helpers - typeof";
-	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o$1) {
-		return typeof o$1;
-	} : function(o$1) {
-		return o$1 && "function" == typeof Symbol && o$1.constructor === Symbol && o$1 !== Symbol.prototype ? "symbol" : typeof o$1;
+	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
+		return typeof o;
+	} : function(o) {
+		return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
 	}, _typeof(o);
 }
+//#endregion
+//#region \0@oxc-project+runtime@0.115.0/helpers/toPrimitive.js
 function toPrimitive(t, r) {
 	if ("object" != _typeof(t) || !t) return t;
 	var e = t[Symbol.toPrimitive];
@@ -17,10 +21,14 @@ function toPrimitive(t, r) {
 	}
 	return ("string" === r ? String : Number)(t);
 }
+//#endregion
+//#region \0@oxc-project+runtime@0.115.0/helpers/toPropertyKey.js
 function toPropertyKey(t) {
 	var i = toPrimitive(t, "string");
 	return "symbol" == _typeof(i) ? i : i + "";
 }
+//#endregion
+//#region \0@oxc-project+runtime@0.115.0/helpers/defineProperty.js
 function _defineProperty(e, r, t) {
 	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
 		value: t,
@@ -29,12 +37,14 @@ function _defineProperty(e, r, t) {
 		writable: !0
 	}) : e[r] = t, e;
 }
+//#endregion
+//#region \0@oxc-project+runtime@0.115.0/helpers/objectSpread2.js
 function ownKeys(e, r) {
 	var t = Object.keys(e);
 	if (Object.getOwnPropertySymbols) {
 		var o = Object.getOwnPropertySymbols(e);
-		r && (o = o.filter(function(r$1) {
-			return Object.getOwnPropertyDescriptor(e, r$1).enumerable;
+		r && (o = o.filter(function(r) {
+			return Object.getOwnPropertyDescriptor(e, r).enumerable;
 		})), t.push.apply(t, o);
 	}
 	return t;
@@ -42,30 +52,108 @@ function ownKeys(e, r) {
 function _objectSpread2(e) {
 	for (var r = 1; r < arguments.length; r++) {
 		var t = null != arguments[r] ? arguments[r] : {};
-		r % 2 ? ownKeys(Object(t), !0).forEach(function(r$1) {
-			_defineProperty(e, r$1, t[r$1]);
-		}) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function(r$1) {
-			Object.defineProperty(e, r$1, Object.getOwnPropertyDescriptor(t, r$1));
+		r % 2 ? ownKeys(Object(t), !0).forEach(function(r) {
+			_defineProperty(e, r, t[r]);
+		}) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function(r) {
+			Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r));
 		});
 	}
 	return e;
 }
+//#endregion
+//#region src/sql-formatter.ts
 var SqlFormatter = class {
+	/**
+	* SqlFormatter constructor
+	*
+	* @example
+	* ```typescript
+	* const sqlFormatter = new SqlFormatter('postgresql');
+	*
+	* // Alternatively, you can pass in options
+	* // @see https://github.com/sql-formatter-org/sql-formatter/tree/master?tab=readme-ov-file#configuration-options
+	*
+	* const pgsqlFormatter = new SqlFormatter('postgresql', {
+	*    keywordCase: 'preserve',
+	*    identifierCase: 'preserve',
+	*    dataTypeCase: 'preserve',
+	*    functionCase: 'preserve',
+	*    logicalOperatorNewline: 'before',
+	*    expressionWidth: 50,
+	*    linesBetweenQueries: 1,
+	*    denseOperators: false,
+	*    newlineBeforeSemicolon: false,
+	*    useTabs: false,
+	*    tabWidth: 2,
+	* });
+	*
+	* try {
+	*  const formatted = pgsqlFormatter.formatOrThrow(
+	*     'SELECT * FROM table WHERE id = 1'
+	*  );
+	* } catch (e) {
+	*   // Might throw something similar to: Parse error: Unexpected "[col] from" at line 1 column 8
+	*   console.log('Error:', e);
+	* }
+	* ```
+	*/
 	constructor(dialect, formatterOptions) {
 		this.dialect = dialect;
 		this.formatterOptions = formatterOptions;
-		_defineProperty(this, "formatOrNull", (sql, params) => {
-			try {
-				return this.formatOrThrow(sql, params);
-			} catch (_unused) {
-				return null;
+		_defineProperty(
+			this,
+			/**
+			* Format sql to string or return null if sql cannot be parsed
+			*
+			* @example
+			* ```typescript
+			* const sqlFormatter = new SqlFormatter('postgresql');
+			*
+			* const formatted = sqlFormatter.formatOrNull(
+			*     'SELECT * FROM table WHERE id = 1'
+			* );
+			* ```
+			*
+			* @return string if sql can be parsed, null otherwise
+			*/
+			"formatOrNull",
+			(sql, params) => {
+				try {
+					return this.formatOrThrow(sql, params);
+				} catch (_unused) {
+					return null;
+				}
 			}
-		});
-		_defineProperty(this, "formatOrThrow", (sql, params) => {
-			var _params$options, _params$dialect;
-			const options = (_params$options = params === null || params === void 0 ? void 0 : params.options) !== null && _params$options !== void 0 ? _params$options : this.formatterOptions;
-			return (0, sql_formatter.format)(typeof sql === "string" ? sql : sql.sql, _objectSpread2({ language: (_params$dialect = params === null || params === void 0 ? void 0 : params.dialect) !== null && _params$dialect !== void 0 ? _params$dialect : this.dialect }, options));
-		});
+		);
+		_defineProperty(
+			this,
+			/**
+			* Format sql to string or throw an error if sql cannot be parsed
+			*
+			* @example
+			* ```typescript
+			* const sqlFormatter = new SqlFormatter('postgresql');
+			*
+			* try {
+			*  const formatted = sqlFormatter.formatOrThrow(
+			*     'SELECT * FROM table WHERE id = 1'
+			*  );
+			* } catch (e) {
+			*   // Might throw something similar to: Parse error: Unexpected "[col] from" at line 1 column 8
+			*   console.log('Error:', e);
+			* }
+			* ```
+			*
+			* @throws Error is sql cannot be parsed
+			*/
+			"formatOrThrow",
+			(sql, params) => {
+				var _params$options, _params$dialect;
+				const options = (_params$options = params === null || params === void 0 ? void 0 : params.options) !== null && _params$options !== void 0 ? _params$options : this.formatterOptions;
+				return (0, sql_formatter.format)(typeof sql === "string" ? sql : sql.sql, _objectSpread2({ language: (_params$dialect = params === null || params === void 0 ? void 0 : params.dialect) !== null && _params$dialect !== void 0 ? _params$dialect : this.dialect }, options));
+			}
+		);
 	}
 };
+//#endregion
 exports.SqlFormatter = SqlFormatter;

package/dist/index.d.cts

@@ -1,11 +1,6 @@
-import { Sql } from "sql-template-tag";
+import { SqlTag } from "@flowblade/sql-tag";
 import { FormatOptions, SqlLanguage } from "sql-formatter";
 
-//#region ../sql-tag/src/types.d.ts
-type SqlTag<T> = Sql & {
-  _columns: T;
-};
-//#endregion
 //#region src/sql-formatter.d.ts
 type SqlFormatterOptions = Omit<FormatOptions, 'indentStyle'>;
 type SqlFormatterDialect = SqlLanguage;

package/dist/index.d.ts

@@ -1,11 +1,6 @@
 import { FormatOptions, SqlLanguage } from "sql-formatter";
-import { Sql } from "sql-template-tag";
+import { SqlTag } from "@flowblade/sql-tag";
 
-//#region ../sql-tag/src/types.d.ts
-type SqlTag<T> = Sql & {
-  _columns: T;
-};
-//#endregion
 //#region src/sql-formatter.d.ts
 type SqlFormatterOptions = Omit<FormatOptions, 'indentStyle'>;
 type SqlFormatterDialect = SqlLanguage;

package/dist/index.js

@@ -1,12 +1,15 @@
 import { format } from "sql-formatter";
+//#region \0@oxc-project+runtime@0.115.0/helpers/typeof.js
 function _typeof(o) {
 	"@babel/helpers - typeof";
-	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o$1) {
-		return typeof o$1;
-	} : function(o$1) {
-		return o$1 && "function" == typeof Symbol && o$1.constructor === Symbol && o$1 !== Symbol.prototype ? "symbol" : typeof o$1;
+	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
+		return typeof o;
+	} : function(o) {
+		return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
 	}, _typeof(o);
 }
+//#endregion
+//#region \0@oxc-project+runtime@0.115.0/helpers/toPrimitive.js
 function toPrimitive(t, r) {
 	if ("object" != _typeof(t) || !t) return t;
 	var e = t[Symbol.toPrimitive];
@@ -17,10 +20,14 @@ function toPrimitive(t, r) {
 	}
 	return ("string" === r ? String : Number)(t);
 }
+//#endregion
+//#region \0@oxc-project+runtime@0.115.0/helpers/toPropertyKey.js
 function toPropertyKey(t) {
 	var i = toPrimitive(t, "string");
 	return "symbol" == _typeof(i) ? i : i + "";
 }
+//#endregion
+//#region \0@oxc-project+runtime@0.115.0/helpers/defineProperty.js
 function _defineProperty(e, r, t) {
 	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
 		value: t,
@@ -29,12 +36,14 @@ function _defineProperty(e, r, t) {
 		writable: !0
 	}) : e[r] = t, e;
 }
+//#endregion
+//#region \0@oxc-project+runtime@0.115.0/helpers/objectSpread2.js
 function ownKeys(e, r) {
 	var t = Object.keys(e);
 	if (Object.getOwnPropertySymbols) {
 		var o = Object.getOwnPropertySymbols(e);
-		r && (o = o.filter(function(r$1) {
-			return Object.getOwnPropertyDescriptor(e, r$1).enumerable;
+		r && (o = o.filter(function(r) {
+			return Object.getOwnPropertyDescriptor(e, r).enumerable;
 		})), t.push.apply(t, o);
 	}
 	return t;
@@ -42,30 +51,108 @@ function ownKeys(e, r) {
 function _objectSpread2(e) {
 	for (var r = 1; r < arguments.length; r++) {
 		var t = null != arguments[r] ? arguments[r] : {};
-		r % 2 ? ownKeys(Object(t), !0).forEach(function(r$1) {
-			_defineProperty(e, r$1, t[r$1]);
-		}) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function(r$1) {
-			Object.defineProperty(e, r$1, Object.getOwnPropertyDescriptor(t, r$1));
+		r % 2 ? ownKeys(Object(t), !0).forEach(function(r) {
+			_defineProperty(e, r, t[r]);
+		}) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function(r) {
+			Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r));
 		});
 	}
 	return e;
 }
+//#endregion
+//#region src/sql-formatter.ts
 var SqlFormatter = class {
+	/**
+	* SqlFormatter constructor
+	*
+	* @example
+	* ```typescript
+	* const sqlFormatter = new SqlFormatter('postgresql');
+	*
+	* // Alternatively, you can pass in options
+	* // @see https://github.com/sql-formatter-org/sql-formatter/tree/master?tab=readme-ov-file#configuration-options
+	*
+	* const pgsqlFormatter = new SqlFormatter('postgresql', {
+	*    keywordCase: 'preserve',
+	*    identifierCase: 'preserve',
+	*    dataTypeCase: 'preserve',
+	*    functionCase: 'preserve',
+	*    logicalOperatorNewline: 'before',
+	*    expressionWidth: 50,
+	*    linesBetweenQueries: 1,
+	*    denseOperators: false,
+	*    newlineBeforeSemicolon: false,
+	*    useTabs: false,
+	*    tabWidth: 2,
+	* });
+	*
+	* try {
+	*  const formatted = pgsqlFormatter.formatOrThrow(
+	*     'SELECT * FROM table WHERE id = 1'
+	*  );
+	* } catch (e) {
+	*   // Might throw something similar to: Parse error: Unexpected "[col] from" at line 1 column 8
+	*   console.log('Error:', e);
+	* }
+	* ```
+	*/
 	constructor(dialect, formatterOptions) {
 		this.dialect = dialect;
 		this.formatterOptions = formatterOptions;
-		_defineProperty(this, "formatOrNull", (sql, params) => {
-			try {
-				return this.formatOrThrow(sql, params);
-			} catch (_unused) {
-				return null;
+		_defineProperty(
+			this,
+			/**
+			* Format sql to string or return null if sql cannot be parsed
+			*
+			* @example
+			* ```typescript
+			* const sqlFormatter = new SqlFormatter('postgresql');
+			*
+			* const formatted = sqlFormatter.formatOrNull(
+			*     'SELECT * FROM table WHERE id = 1'
+			* );
+			* ```
+			*
+			* @return string if sql can be parsed, null otherwise
+			*/
+			"formatOrNull",
+			(sql, params) => {
+				try {
+					return this.formatOrThrow(sql, params);
+				} catch (_unused) {
+					return null;
+				}
 			}
-		});
-		_defineProperty(this, "formatOrThrow", (sql, params) => {
-			var _params$options, _params$dialect;
-			const options = (_params$options = params === null || params === void 0 ? void 0 : params.options) !== null && _params$options !== void 0 ? _params$options : this.formatterOptions;
-			return format(typeof sql === "string" ? sql : sql.sql, _objectSpread2({ language: (_params$dialect = params === null || params === void 0 ? void 0 : params.dialect) !== null && _params$dialect !== void 0 ? _params$dialect : this.dialect }, options));
-		});
+		);
+		_defineProperty(
+			this,
+			/**
+			* Format sql to string or throw an error if sql cannot be parsed
+			*
+			* @example
+			* ```typescript
+			* const sqlFormatter = new SqlFormatter('postgresql');
+			*
+			* try {
+			*  const formatted = sqlFormatter.formatOrThrow(
+			*     'SELECT * FROM table WHERE id = 1'
+			*  );
+			* } catch (e) {
+			*   // Might throw something similar to: Parse error: Unexpected "[col] from" at line 1 column 8
+			*   console.log('Error:', e);
+			* }
+			* ```
+			*
+			* @throws Error is sql cannot be parsed
+			*/
+			"formatOrThrow",
+			(sql, params) => {
+				var _params$options, _params$dialect;
+				const options = (_params$options = params === null || params === void 0 ? void 0 : params.options) !== null && _params$options !== void 0 ? _params$options : this.formatterOptions;
+				return format(typeof sql === "string" ? sql : sql.sql, _objectSpread2({ language: (_params$dialect = params === null || params === void 0 ? void 0 : params.dialect) !== null && _params$dialect !== void 0 ? _params$dialect : this.dialect }, options));
+			}
+		);
 	}
 };
+//#endregion
 export { SqlFormatter };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flowblade/sql-tag-format",
   "description": "Formatter utilities for @flowblade/sql-tag",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "license": "MIT",
   "author": {
     "name": "Vanvelthem Sébastien",
@@ -67,37 +67,37 @@
     "ci-coverage-upload": "../../.github/scripts/download/codecov -F flowblade-sql-tag-format --dir ./coverage"
   },
   "dependencies": {
-    "@flowblade/sql-tag": "^0.3.0",
-    "sql-formatter": "^15.7.0"
+    "@flowblade/sql-tag": "^0.3.2",
+    "sql-formatter": "^15.7.2"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.2",
-    "@belgattitude/eslint-config-bases": "8.9.0",
-    "@codspeed/vitest-plugin": "5.0.1",
+    "@belgattitude/eslint-config-bases": "8.10.0",
+    "@codspeed/vitest-plugin": "5.2.0",
     "@edge-runtime/vm": "5.0.0",
-    "@size-limit/esbuild": "12.0.0",
-    "@size-limit/file": "12.0.0",
-    "@vitest/coverage-istanbul": "4.0.17",
-    "@vitest/ui": "4.0.17",
+    "@size-limit/esbuild": "12.0.1",
+    "@size-limit/file": "12.0.1",
+    "@vitest/coverage-istanbul": "4.0.18",
+    "@vitest/ui": "4.0.18",
     "browserslist": "4.28.1",
     "browserslist-to-esbuild": "2.1.1",
     "cross-env": "10.1.0",
-    "es-check": "9.5.4",
-    "esbuild": "0.27.2",
+    "es-check": "9.6.2",
+    "esbuild": "0.27.3",
     "eslint": "8.57.1",
     "execa": "9.6.1",
     "npm-run-all2": "8.0.4",
-    "prettier": "3.8.0",
-    "publint": "0.3.16",
-    "rimraf": "6.1.2",
-    "size-limit": "12.0.0",
-    "tsdown": "0.19.0",
+    "prettier": "3.8.1",
+    "publint": "0.3.18",
+    "rimraf": "6.1.3",
+    "size-limit": "12.0.1",
+    "tsdown": "0.21.1",
     "tsx": "4.21.0",
-    "typedoc": "0.28.16",
-    "typedoc-plugin-markdown": "4.9.0",
+    "typedoc": "0.28.17",
+    "typedoc-plugin-markdown": "4.10.0",
     "typescript": "5.9.3",
-    "vite-tsconfig-paths": "6.0.4",
-    "vitest": "4.0.17"
+    "vite-tsconfig-paths": "6.1.1",
+    "vitest": "4.0.18"
   },
   "engines": {
     "node": ">=20.9.0"