npm - @flowblade/sql-tag-format - Versions diffs - 0.0.2 - Mend

@flowblade/sql-tag-format 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2024-current Sébastien Vanvelthem
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,142 @@
+# @flowblade/sql-tag-format
+Sql formatter utilities for [@flowblade/sql-tag](https://github.com/belgattitude/flowblade/tree/main/packages/sql-tag#readme)
+[![npm](https://img.shields.io/npm/v/@flowblade/sql-tag-format?style=for-the-badge&label=Npm&labelColor=444&color=informational)](https://www.npmjs.com/package/@flowblade/sql-tag-format)
+[![changelog](https://img.shields.io/static/v1?label=&message=changelog&logo=github&style=for-the-badge&labelColor=444&color=informational)](https://github.com/belgattitude/flowblade/blob/main/packages/sql-tag-format/CHANGELOG.md)
+[![codecov](https://img.shields.io/codecov/c/github/belgattitude/flowblade?logo=codecov&label=Unit&flag=flowblade-sql-tag-format-unit&style=for-the-badge&labelColor=444)](https://app.codecov.io/gh/belgattitude/flowblade/tree/main/packages%2Fsql-tag-format)
+[![bundles](https://img.shields.io/static/v1?label=&message=cjs|esm@treeshake&logo=webpack&style=for-the-badge&labelColor=444&color=informational)](https://github.com/belgattitude/flowblade/blob/main/packages/sql-tag-format/.size-limit.cjs)
+[![node](https://img.shields.io/static/v1?label=Node&message=18%2b&logo=node.js&style=for-the-badge&labelColor=444&color=informational)](#compatibility)
+[![browserslist](https://img.shields.io/static/v1?label=Browser&message=%3E96%25&logo=googlechrome&style=for-the-badge&labelColor=444&color=informational)](#compatibility)
+[![size](https://img.shields.io/bundlephobia/minzip/@flowblade/sql-tag-format@latest?label=Max&style=for-the-badge&labelColor=444&color=informational)](https://bundlephobia.com/package/@flowblade/sql-tag-format@latest)
+[![downloads](https://img.shields.io/npm/dm/@flowblade/sql-tag-format?style=for-the-badge&labelColor=444)](https://www.npmjs.com/package/@flowblade/sql-tag-format)
+[![license](https://img.shields.io/npm/l/@flowblade/sql-tag-format?style=for-the-badge&labelColor=444)](https://github.com/belgattitude/flowblade/blob/main/LICENSE)
+## Features
+- 🛡️&nbsp; Tested on [node 18-22, browser, cloudflare workers and runtime/edge](#compatibility).
+- 🗝️&nbsp; Available in ESM and CJS formats.
+## Install
+```bash
+yarn add @flowblade/sql-tag-format @flowblade/sql-tag
+```
+## Usage
+```typescript
+import {sql} from '@flowblade/sql-tag';
+import {SqlFormatter} from "@flowblade/sql-tag-format";
+// 👈 Unvalidated parameters
+const params = {
+    country: 'BE',
+    users: ['John', 'Doe'],
+    ids: [1],
+};
+const query = sql<{
+    id: number;
+    username: string;
+}>`
+   SELECT id, username FROM users
+   WHERE country = ${params.country}           -- 👈 simple
+   AND username IN (${sql.join(params.users)}) -- 👈 sql.join
+   -- 👇 conditional clause with sql.empty
+   ${params.ids.length > 0 ? sql`AND id IN (${sql.join(params.ids)})` : sql.empty}
+`;
+const pgsqlFormatter = new SqlFormatter('postgresql');
+const formatted = pgsqlFormatter.formatOrNull(query);
+try {
+    const formatted = pgsqlFormatter.formatOrThrow(query);
+} catch (e) {
+    console.error(e);
+}
+```
+## Supported dialects
+| Dialect      | Description                  |
+|---------------|------------------------------|
+| bigquery      | Google SQL                   |
+| db2           | DB2 SQL                      |
+| db2i          | DB2 iSeries SQL              |
+| hive          | HiveQL                       |
+| mariadb       | MariaDB SQL                  |
+| mysql         | MySQL SQL                    |
+| n1ql          | N1QL                         |
+| plsql         | PL/SQL                       |
+| postgresql    | PostgreSQL SQL               |
+| redshift      | Redshift SQL                 |
+| singlestoredb | SingleStore SQL              |
+| snowflake     | Snowflake SQL                |
+| spark         | Spark SQL                    |
+| sql           | ANSI SQL                     |
+| sqlite        | SQLite SQL                   |
+| tidb          | TiDB SQL                     |
+| transactsql   | Mssql / Transact-SQL (T-SQL) |
+| trino         | Trino SQL                    |
+| tsql          | Transact-SQL                 |
+## Bundle size
+Bundle size is tracked by a [size-limit configuration](https://github.com/belgattitude/flowblade/blob/main/packages/sql-tag/.size-limit.ts)
+| Scenario (esm)                                            | Size (compressed) |
+|-----------------------------------------------------------|------------------:|
+| `import { SqlFormatter } from '@flowblade/sql-tag-format` |            ~ 47Kb |
+## Compatibility
+| Level      | CI | Description                                                                                                                                                                                                                                                                                                                                    |
+|------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Node       | ✅  | CI for 18.x, 20.x & 22.x.                                                                                                                                                                                                                                                                                                                      |
+| Browser    | ✅  | Tested with latest chrome (vitest/playwright)                                                                                                                                                                                                                                                                                            |
+| Browsers   | ✅  | [> 96%](https://browserslist.dev/?q=ZGVmYXVsdHMsIGNocm9tZSA%2BPSA5NixmaXJlZm94ID49IDkwLGVkZ2UgPj0gMTksc2FmYXJpID49IDEyLGlvcyA%2BPSAxMixvcGVyYSA%2BPSA3Nw%3D%3D) on 07/2024. Mins to [Chrome 96+, Firefox 90+, Edge 19+, iOS 12+, Safari 12+, Opera 77+](https://github.com/belgattitude/flowblade/blob/main/packages/sql-tag/.browserslistrc) |
+| Edge       | ✅  | Ensured on CI with [@vercel/edge-runtime](https://github.com/vercel/edge-runtime).                                                                                                                                                                                                                                                       |
+| Cloudflare | ✅  | Ensured with @cloudflare/vitest-pool-workers (see [wrangler.toml](https://github.com/belgattitude/flowblade/blob/main/devtools/vitest/wrangler.toml)                                                                                                                                                                                         |
+| Typescript | ✅  | TS 5.0 + / [are-the-type-wrong](https://github.com/arethetypeswrong/arethetypeswrong.github.io) checks on CI.                                                                                                                                                                                                                                  |
+| ES2022     | ✅  | Dist files checked with [es-check](https://github.com/yowainwright/es-check)                                                                                                                                                                                                                                                                   |
+| Performance| ✅  | Monitored with [codspeed.io](https://codspeed.io/belgattitude/flowblade)                                                                                                                                                                                                                                                                      |
+## Contributors
+Contributions are welcome. Have a look to the [CONTRIBUTING](https://github.com/belgattitude/flowblade/blob/main/CONTRIBUTING.md) document.
+## Sponsors
+[Sponsor](<[sponsorship](https://github.com/sponsors/belgattitude)>), [coffee](<(https://ko-fi.com/belgattitude)>),
+or star – All is spent for quality time with loved ones. Thanks ! 🙏❤️
+### Special thanks to
+<table>
+  <tr>
+    <td>
+      <a href="https://www.jetbrains.com/?ref=belgattitude" target="_blank">
+         <img width="65" src="https://asset.brandfetch.io/idarKiKkI-/id53SttZhi.jpeg" alt="Jetbrains logo" />
+      </a>
+    </td>
+    <td>
+      <a href="https://www.embie.be/?ref=belgattitude" target="_blank">
+        <img width="65" src="https://avatars.githubusercontent.com/u/98402122?s=200&v=4" alt="Jetbrains logo" />
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <a href="https://www.jetbrains.com/?ref=belgattitude" target="_blank">JetBrains</a>
+    </td>
+    <td align="center">
+      <a href="https://www.embie.be/?ref=belgattitude" target="_blank">Embie.be</a>
+    </td>
+   </tr>
+</table>
+## License
+MIT © [Sébastien Vanvelthem](https://github.com/belgattitude) and contributors.

package/dist/index.cjs ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ 'use strict';var sqlFormatter=require('sql-formatter');var m=Object.defineProperty;var s=(o,r,t)=>r in o?m(o,r,{enumerable:true,configurable:true,writable:true,value:t}):o[r]=t;var e=(o,r,t)=>s(o,typeof r!="symbol"?r+"":r,t);var l=class{constructor(r,t){this.dialect=r;this.formatterOptions=t;e(this,"formatOrNull",(r,t)=>{try{return this.formatOrThrow(r,t)}catch{return null}});e(this,"formatOrThrow",(r,t)=>{var a,i;let n=(a=t==null?undefined:t.options)!=null?a:this.formatterOptions;return sqlFormatter.format(r.sql,{language:(i=t==null?undefined:t.dialect)!=null?i:this.dialect,...n})});}};exports.SqlFormatter=l;//# sourceMappingURL=index.cjs.map
2	+ //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../src/sql-formatter.ts"],"names":["SqlFormatter","dialect","formatterOptions","__publicField","sql","params","_a","_b","options","sqlFormat"],"mappings":"uDACA,IAAA,CAAA,CAAA,MAAA,CAAA,cAAA,CAAA,IAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,GAAA,CAAA,IAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,UAAA,CAAA,IAAA,CAAA,YAAA,CAAA,IAAA,CAAA,QAAA,CAAA,IAAA,CAAA,KAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,IAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,GAAA,CAAA,CAAA,CAAA,CAAA,OAAA,CAAA,EAAA,QAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAoBO,IAAMA,EAAN,KAAmB,CAmCxB,WACUC,CAAAA,CAAAA,CACAC,EACR,CAFQ,IAAA,CAAA,OAAA,CAAAD,CACA,CAAA,IAAA,CAAA,gBAAA,CAAAC,EAiBVC,CAAA,CAAA,IAAA,CAAA,cAAA,CAAe,CACbC,CAAAA,CACAC,IACkB,CAClB,GAAI,CACF,OAAO,KAAK,aAAcD,CAAAA,CAAAA,CAAKC,CAAM,CACvC,MAAQ,CACN,OAAO,IACT,CACF,GAqBAF,CAAA,CAAA,IAAA,CAAA,eAAA,CAAgB,CAACC,CAAAA,CAAsBC,IAAkC,CAzG3E,IAAAC,CAAAC,CAAAA,CAAAA,CA0GI,IAAMC,CAAUF,CAAAA,CAAAA,CAAAA,CAAAD,CAAA,EAAA,IAAA,CAAA,SAAA,CAAAA,EAAQ,OAAR,GAAA,IAAA,CAAAC,CAAmB,CAAA,IAAA,CAAK,iBACxC,OAAOG,mBAAAA,CAAUL,CAAI,CAAA,GAAA,CAAK,CACxB,QAAUG,CAAAA,CAAAA,CAAAA,CAAAF,CAAA,EAAA,IAAA,CAAA,SAAA,CAAAA,EAAQ,OAAR,GAAA,IAAA,CAAAE,CAAmB,CAAA,IAAA,CAAK,QAClC,GAAGC,CACL,CAAC,CACH,GApDG,CAqDL","file":"index.cjs","sourcesContent":["import type { SqlTag } from '@flowblade/sql-tag';\nimport {\n format as sqlFormat,\n type FormatOptions,\n type SqlLanguage,\n} from 'sql-formatter';\n\nexport type SqlFormatterOptions = Omit<FormatOptions, 'indentStyle'>;\nexport type SqlFormatterDialect = SqlLanguage;\n\ntype FormatParams = {\n /**\n * If not provided will default to the dialect provided in the constructor\n */\n dialect?: SqlFormatterDialect;\n /**\n * If not provided will default to the formatter options provided in the constructor\n */\n options?: Partial<SqlFormatterOptions>;\n};\n\nexport class SqlFormatter {\n /**\n * SqlFormatter constructor\n *\n * @example\n * ```typescript\n * const sqlFormatter = new SqlFormatter('postgresql');\n *\n * // Alternatively, you can pass in options\n * // @see https://github.com/sql-formatter-org/sql-formatter/tree/master?tab=readme-ov-file#configuration-options\n *\n * const pgsqlFormatter = new SqlFormatter('postgresql', {\n * keywordCase: 'preserve',\n * identifierCase: 'preserve',\n * dataTypeCase: 'preserve',\n * functionCase: 'preserve',\n * logicalOperatorNewline: 'before',\n * expressionWidth: 50,\n * linesBetweenQueries: 1,\n * denseOperators: false,\n * newlineBeforeSemicolon: false,\n * useTabs: false,\n * tabWidth: 2,\n * });\n *\n * try {\n * const formatted = pgsqlFormatter.formatOrThrow(\n * 'SELECT * FROM table WHERE id = 1'\n * );\n * } catch (e) {\n * // Might throw something similar to: Parse error: Unexpected \"[col] from\" at line 1 column 8\n * console.log('Error:', e);\n * }\n * ```\n */\n constructor(\n private dialect: SqlFormatterDialect,\n private formatterOptions?: SqlFormatterOptions\n ) {}\n\n /**\n * Format sql to string or return null if sql cannot be parsed\n *\n * @example\n * ```typescript\n * const sqlFormatter = new SqlFormatter('postgresql');\n *\n * const formatted = sqlFormatter.formatOrNull(\n * 'SELECT * FROM table WHERE id = 1'\n * );\n * ```\n *\n * @return string if sql can be parsed, null otherwise\n */\n formatOrNull = (\n sql: SqlTag<unknown>,\n params?: FormatParams\n ): string | null => {\n try {\n return this.formatOrThrow(sql, params);\n } catch {\n return null;\n }\n };\n\n /**\n * Format sql to string or throw an error if sql cannot be parsed\n *\n * @example\n * ```typescript\n * const sqlFormatter = new SqlFormatter('postgresql');\n *\n * try {\n * const formatted = sqlFormatter.formatOrThrow(\n * 'SELECT * FROM table WHERE id = 1'\n * );\n * } catch (e) {\n * // Might throw something similat to: Parse error: Unexpected \"[col] from\" at line 1 column 8\n * console.log('Error:', e);\n * }\n * ```\n *\n * @throws Error is sql cannot be parsed\n */\n formatOrThrow = (sql: SqlTag<unknown>, params?: FormatParams): string => {\n const options = params?.options ?? this.formatterOptions;\n return sqlFormat(sql.sql, {\n language: params?.dialect ?? this.dialect,\n ...options,\n });\n };\n}\n"]}

package/dist/index.d.cts ADDED Viewed

@@ -0,0 +1,91 @@
+import { SqlTag } from '@flowblade/sql-tag';
+import { FormatOptions, SqlLanguage } from 'sql-formatter';
+type SqlFormatterOptions = Omit<FormatOptions, 'indentStyle'>;
+type SqlFormatterDialect = SqlLanguage;
+type FormatParams = {
+    /**
+     * If not provided will default to the dialect provided in the constructor
+     */
+    dialect?: SqlFormatterDialect;
+    /**
+     * If not provided will default to the formatter options provided in the constructor
+     */
+    options?: Partial<SqlFormatterOptions>;
+};
+declare class SqlFormatter {
+    private dialect;
+    private formatterOptions?;
+    /**
+     * 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: SqlFormatterDialect, formatterOptions?: SqlFormatterOptions | undefined);
+    /**
+     * 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: SqlTag<unknown>, params?: FormatParams) => string | null;
+    /**
+     * 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 similat to: Parse error: Unexpected "[col] from" at line 1 column 8
+     *   console.log('Error:', e);
+     * }
+     * ```
+     *
+     * @throws Error is sql cannot be parsed
+     */
+    formatOrThrow: (sql: SqlTag<unknown>, params?: FormatParams) => string;
+}
+export { SqlFormatter, type SqlFormatterDialect, type SqlFormatterOptions };

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,91 @@
+import { SqlTag } from '@flowblade/sql-tag';
+import { FormatOptions, SqlLanguage } from 'sql-formatter';
+type SqlFormatterOptions = Omit<FormatOptions, 'indentStyle'>;
+type SqlFormatterDialect = SqlLanguage;
+type FormatParams = {
+    /**
+     * If not provided will default to the dialect provided in the constructor
+     */
+    dialect?: SqlFormatterDialect;
+    /**
+     * If not provided will default to the formatter options provided in the constructor
+     */
+    options?: Partial<SqlFormatterOptions>;
+};
+declare class SqlFormatter {
+    private dialect;
+    private formatterOptions?;
+    /**
+     * 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: SqlFormatterDialect, formatterOptions?: SqlFormatterOptions | undefined);
+    /**
+     * 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: SqlTag<unknown>, params?: FormatParams) => string | null;
+    /**
+     * 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 similat to: Parse error: Unexpected "[col] from" at line 1 column 8
+     *   console.log('Error:', e);
+     * }
+     * ```
+     *
+     * @throws Error is sql cannot be parsed
+     */
+    formatOrThrow: (sql: SqlTag<unknown>, params?: FormatParams) => string;
+}
+export { SqlFormatter, type SqlFormatterDialect, type SqlFormatterOptions };

package/dist/index.mjs ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ import {format}from'sql-formatter';var m=Object.defineProperty;var s=(o,r,t)=>r in o?m(o,r,{enumerable:true,configurable:true,writable:true,value:t}):o[r]=t;var e=(o,r,t)=>s(o,typeof r!="symbol"?r+"":r,t);var l=class{constructor(r,t){this.dialect=r;this.formatterOptions=t;e(this,"formatOrNull",(r,t)=>{try{return this.formatOrThrow(r,t)}catch{return null}});e(this,"formatOrThrow",(r,t)=>{var a,i;let n=(a=t==null?undefined:t.options)!=null?a:this.formatterOptions;return format(r.sql,{language:(i=t==null?undefined:t.dialect)!=null?i:this.dialect,...n})});}};export{l as SqlFormatter};//# sourceMappingURL=index.mjs.map
2	+ //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../src/sql-formatter.ts"],"names":["SqlFormatter","dialect","formatterOptions","__publicField","sql","params","_a","_b","options","sqlFormat"],"mappings":"mCACA,IAAA,CAAA,CAAA,MAAA,CAAA,cAAA,CAAA,IAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,GAAA,CAAA,IAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,UAAA,CAAA,IAAA,CAAA,YAAA,CAAA,IAAA,CAAA,QAAA,CAAA,IAAA,CAAA,KAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,IAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,GAAA,CAAA,CAAA,CAAA,CAAA,OAAA,CAAA,EAAA,QAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAoBO,IAAMA,EAAN,KAAmB,CAmCxB,WACUC,CAAAA,CAAAA,CACAC,EACR,CAFQ,IAAA,CAAA,OAAA,CAAAD,CACA,CAAA,IAAA,CAAA,gBAAA,CAAAC,EAiBVC,CAAA,CAAA,IAAA,CAAA,cAAA,CAAe,CACbC,CAAAA,CACAC,IACkB,CAClB,GAAI,CACF,OAAO,KAAK,aAAcD,CAAAA,CAAAA,CAAKC,CAAM,CACvC,MAAQ,CACN,OAAO,IACT,CACF,GAqBAF,CAAA,CAAA,IAAA,CAAA,eAAA,CAAgB,CAACC,CAAAA,CAAsBC,IAAkC,CAzG3E,IAAAC,CAAAC,CAAAA,CAAAA,CA0GI,IAAMC,CAAUF,CAAAA,CAAAA,CAAAA,CAAAD,CAAA,EAAA,IAAA,CAAA,SAAA,CAAAA,EAAQ,OAAR,GAAA,IAAA,CAAAC,CAAmB,CAAA,IAAA,CAAK,iBACxC,OAAOG,MAAAA,CAAUL,CAAI,CAAA,GAAA,CAAK,CACxB,QAAUG,CAAAA,CAAAA,CAAAA,CAAAF,CAAA,EAAA,IAAA,CAAA,SAAA,CAAAA,EAAQ,OAAR,GAAA,IAAA,CAAAE,CAAmB,CAAA,IAAA,CAAK,QAClC,GAAGC,CACL,CAAC,CACH,GApDG,CAqDL","file":"index.mjs","sourcesContent":["import type { SqlTag } from '@flowblade/sql-tag';\nimport {\n format as sqlFormat,\n type FormatOptions,\n type SqlLanguage,\n} from 'sql-formatter';\n\nexport type SqlFormatterOptions = Omit<FormatOptions, 'indentStyle'>;\nexport type SqlFormatterDialect = SqlLanguage;\n\ntype FormatParams = {\n /**\n * If not provided will default to the dialect provided in the constructor\n */\n dialect?: SqlFormatterDialect;\n /**\n * If not provided will default to the formatter options provided in the constructor\n */\n options?: Partial<SqlFormatterOptions>;\n};\n\nexport class SqlFormatter {\n /**\n * SqlFormatter constructor\n *\n * @example\n * ```typescript\n * const sqlFormatter = new SqlFormatter('postgresql');\n *\n * // Alternatively, you can pass in options\n * // @see https://github.com/sql-formatter-org/sql-formatter/tree/master?tab=readme-ov-file#configuration-options\n *\n * const pgsqlFormatter = new SqlFormatter('postgresql', {\n * keywordCase: 'preserve',\n * identifierCase: 'preserve',\n * dataTypeCase: 'preserve',\n * functionCase: 'preserve',\n * logicalOperatorNewline: 'before',\n * expressionWidth: 50,\n * linesBetweenQueries: 1,\n * denseOperators: false,\n * newlineBeforeSemicolon: false,\n * useTabs: false,\n * tabWidth: 2,\n * });\n *\n * try {\n * const formatted = pgsqlFormatter.formatOrThrow(\n * 'SELECT * FROM table WHERE id = 1'\n * );\n * } catch (e) {\n * // Might throw something similar to: Parse error: Unexpected \"[col] from\" at line 1 column 8\n * console.log('Error:', e);\n * }\n * ```\n */\n constructor(\n private dialect: SqlFormatterDialect,\n private formatterOptions?: SqlFormatterOptions\n ) {}\n\n /**\n * Format sql to string or return null if sql cannot be parsed\n *\n * @example\n * ```typescript\n * const sqlFormatter = new SqlFormatter('postgresql');\n *\n * const formatted = sqlFormatter.formatOrNull(\n * 'SELECT * FROM table WHERE id = 1'\n * );\n * ```\n *\n * @return string if sql can be parsed, null otherwise\n */\n formatOrNull = (\n sql: SqlTag<unknown>,\n params?: FormatParams\n ): string | null => {\n try {\n return this.formatOrThrow(sql, params);\n } catch {\n return null;\n }\n };\n\n /**\n * Format sql to string or throw an error if sql cannot be parsed\n *\n * @example\n * ```typescript\n * const sqlFormatter = new SqlFormatter('postgresql');\n *\n * try {\n * const formatted = sqlFormatter.formatOrThrow(\n * 'SELECT * FROM table WHERE id = 1'\n * );\n * } catch (e) {\n * // Might throw something similat to: Parse error: Unexpected \"[col] from\" at line 1 column 8\n * console.log('Error:', e);\n * }\n * ```\n *\n * @throws Error is sql cannot be parsed\n */\n formatOrThrow = (sql: SqlTag<unknown>, params?: FormatParams): string => {\n const options = params?.options ?? this.formatterOptions;\n return sqlFormat(sql.sql, {\n language: params?.dialect ?? this.dialect,\n ...options,\n });\n };\n}\n"]}

package/package.json ADDED Viewed

@@ -0,0 +1,106 @@
+{
+  "name": "@flowblade/sql-tag-format",
+  "description": "Formatter utilities for @flowblade/sql-tag",
+  "version": "0.0.2",
+  "license": "MIT",
+  "author": {
+    "name": "Vanvelthem Sébastien",
+    "url": "https://github.com/belgattitude"
+  },
+  "homepage": "https://belgattitude.github.io/flowblade",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/belgattitude/flowblade.git",
+    "directory": "packages/sql-tag-format"
+  },
+  "keywords": [],
+  "sideEffects": false,
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "?build-release": "When https://github.com/atlassian/changesets/issues/432 has a solution we can remove this trick",
+    "build": "run clean && yarn run tsup",
+    "build-release": "run build",
+    "bench-disabled": "vitest bench --run",
+    "bench-codspeed-disabled": "cross-env CODSPEED=1 vitest bench --run",
+    "bench-watch-disabled": "vitest bench",
+    "docgen": "run-s docgen-typedoc",
+    "docgen-typedoc": "rimraf ./docs/api && typedoc --plugin typedoc-plugin-markdown --out ./docs/api",
+    "check-dist": "run-s check-dist-esm check-dist-cjs",
+    "check-dist-cjs": "es-check --not './dist/*.map.js' -v es2022 './dist/**/*.cjs'",
+    "check-dist-esm": "es-check --not './dist/*.map.js' -v es2022 --module './dist/**/*.mjs'",
+    "check-pub": "attw --pack && publint",
+    "check-size": "size-limit",
+    "clean": "rimraf --glob ./dist ./build ./coverage ./_release './tsconfig*.tsbuildinfo'",
+    "dev": "tsup --watch",
+    "fix-staged": "lint-staged --allow-empty",
+    "lint": "eslint . --ext .ts,.tsx,.js,.jsx,.mjs,.cjs,.mts,.cts --cache --cache-location ../../.cache/eslint/sql-tag-format.eslintcache",
+    "test": "vitest run",
+    "test-unit": "vitest run",
+    "test-e2e": "vitest --config=vitest.e2e.config.ts run",
+    "test-unit-coverage": "vitest run --coverage",
+    "test-unit-edge": "vitest run --environment edge-runtime",
+    "test-unit-watch": "vitest --ui --api 4515",
+    "typecheck": "tsc --project tsconfig.json --noEmit",
+    "typecheck-build": "tsc --project tsconfig.build.json --noEmit",
+    "ci-coverage-upload": "../../.github/scripts/download/codecov -F flowblade-sql-tag-format --dir ./coverage"
+  },
+  "dependencies": {
+    "sql-formatter": "^15.4.9"
+  },
+  "peerDependencies": {
+    "@flowblade/sql-tag": "workspace:^"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "0.17.2",
+    "@belgattitude/eslint-config-bases": "6.18.0",
+    "@codspeed/vitest-plugin": "4.0.0",
+    "@edge-runtime/vm": "5.0.0",
+    "@size-limit/file": "11.1.6",
+    "@size-limit/webpack": "11.1.6",
+    "@vitest/coverage-istanbul": "2.1.8",
+    "@vitest/ui": "2.1.8",
+    "browserslist": "4.24.3",
+    "browserslist-to-esbuild": "2.1.1",
+    "cross-env": "7.0.3",
+    "es-check": "8.0.1",
+    "esbuild": "0.24.2",
+    "eslint": "8.57.1",
+    "execa": "9.5.2",
+    "npm-run-all2": "7.0.2",
+    "prettier": "3.4.2",
+    "publint": "0.3.0",
+    "rimraf": "6.0.1",
+    "rollup": "4.30.1",
+    "size-limit": "11.1.6",
+    "tsup": "8.3.5",
+    "tsx": "4.19.2",
+    "typedoc": "0.27.6",
+    "typedoc-plugin-markdown": "4.4.1",
+    "typescript": "5.7.2",
+    "vite-tsconfig-paths": "5.1.4",
+    "vitest": "2.1.8",
+    "webpack": "5.97.1"
+  },
+  "engines": {
+    "node": ">=18.17.0"
+  }
+}