rawsql-ts 0.1.0-beta.12 → 0.1.0-beta.14

package/README.md

@@ -1,6 +1,10 @@
 # rawsql-ts
 
 ![No external dependencies](https://img.shields.io/badge/dependencies-none-brightgreen)
+![Browser Support](https://img.shields.io/badge/browser-%F0%9F%9A%80-brightgreen)
+![npm version](https://img.shields.io/npm/v/rawsql-ts)
+![npm downloads](https://img.shields.io/npm/dm/rawsql-ts)
+![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
 
 rawsql-ts is a high-performance SQL parser and AST transformer library written in TypeScript. It is designed for extensibility and advanced SQL analysis, with initial focus on PostgreSQL syntax but not limited to it. The library enables easy SQL parsing, transformation, and analysis for a wide range of SQL dialects.
 
@@ -134,36 +138,70 @@ A suite of utilities for transforming and analyzing SQL ASTs.
 ## Usage Example
 
 ```typescript
-import { TableColumnResolver } from "./src/transformers/TableColumnResolver";
-import { SelectQueryParser } from 'rawsql-ts';
-import { SelectableColumnCollector } from 'rawsql-ts/transformers/SelectableColumnCollector';
-import { SelectValueCollector } from 'rawsql-ts/transformers/SelectValueCollector';
-import { TableSourceCollector } from 'rawsql-ts/transformers/TableSourceCollector';
+import { TableColumnResolver, SelectQueryParser, SelectableColumnCollector, SelectValueCollector, TableSourceCollector, Formatter } from 'rawsql-ts';
 
 // TableColumnResolver example
 const resolver: TableColumnResolver = (tableName) => {
-  if (tableName === "users") return ["id", "name", "email"];
-  if (tableName === "posts") return ["id", "title", "content"];
-  return [];
+    if (tableName === 'users') return ['user_id', 'user_name', 'email'];
+    if (tableName === 'posts') return ['post_id', 'user_id', 'title', 'content'];
+    return [];
 };
 
-const sql = `SELECT u.* FROM users u JOIN posts p ON u.id = p.user_id`;
+const sql = `SELECT u.*, p.title as post_title FROM users u INNER JOIN posts p ON u.user_id = p.user_id`;
 const query = SelectQueryParser.parse(sql);
+const formatter = new Formatter();
 
-// Wildcard expansion example
+// Collects information from the SELECT clause.
+// To expand wildcards, you must specify a TableColumnResolver.
 const selectValueCollector = new SelectValueCollector(resolver);
 const selectValues = selectValueCollector.collect(query);
-console.log(selectValues.map(val => val.alias || val.expression.toString()));
-
-// Collect all selectable columns from FROM/JOIN sources
-const selectableColumnCollector = new SelectableColumnCollector();
+// Log the name and formatted value of each select value
+console.log('Select values:');
+selectValues.forEach(val => {
+    console.log(`  name: ${val.name}, value: ${formatter.format(val.value)}`);
+});
+/*
+Select values:
+  name: post_title, value: "p"."title"
+  name: user_id, value: "u"."user_id"
+  name: user_name, value: "u"."user_name"
+  name: email, value: "u"."email"
+*/
+
+// Collects selectable columns from the FROM/JOIN clauses.
+// You can get accurate information by specifying a TableColumnResolver.
+// If omitted, the information will be inferred from the query content.
+const selectableColumnCollector = new SelectableColumnCollector(resolver);
 const selectableColumns = selectableColumnCollector.collect(query);
-console.log(selectableColumns.map(col => col.name));
-
-// Collect all table and subquery sources from FROM/JOIN clauses
+// Log detailed info for each selectable column
+console.log('Selectable columns:');
+selectableColumns.forEach(val => {
+    console.log(`  name: ${val.name}, value: ${formatter.format(val.value)}`);
+});
+/*
+Selectable columns:
+  name: post_title, value: "p"."title"
+  name: user_id, value: "u"."user_id"
+  name: user_name, value: "u"."user_name"
+  name: email, value: "u"."email"
+  name: post_id, value: "p"."post_id"
+  name: title, value: "p"."title"
+  name: content, value: "p"."content"
+*/
+
+// Retrieves physical table sources.
 const tableSourceCollector = new TableSourceCollector();
 const sources = tableSourceCollector.collect(query);
-console.log(sources.map(src => src.alias || src.name));
+// Log detailed info for each source
+console.log('Sources:');
+sources.forEach(src => {
+    console.log(`  name: ${src.getSourceName()}`);
+});
+/*
+TableSources:
+  name: users
+  name: posts
+*/
 ```
 
 ---

package/package.json

@@ -1,18 +1,10 @@
 {
     "name": "rawsql-ts",
-    "version": "0.1.0-beta.12",
+    "version": "0.1.0-beta.14",
     "description": "[beta]High-performance SQL parser and AST analyzer written in TypeScript. Provides fast parsing and advanced transformation capabilities.",
     "main": "dist/index.js",
     "module": "dist/esm/index.js",
     "types": "dist/index.d.ts",
-    "exports": {
-        ".": {
-            "require": "./dist/index.js",
-            "import": "./dist/esm/index.js",
-            "types": "./dist/index.d.ts",
-            "browser": "./dist/esm/index.js"
-        }
-    },
     "browser": "dist/esm/index.js",
     "scripts": {
         "test": "vitest run",