alasql 4.20.1 → 4.22.0

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alasql",
 	"description": "Use SQL to select and filter javascript data - including relational joins and search in nested objects (JSON). Export to and import from Excel and CSV",
-	"version": "4.20.1",
+	"version": "4.22.0",
 	"author": "Andrey Gershun <agershun@gmail.com>",
 	"contributors": [
 		"Mathias Wulff <m@rawu.dk>"
@@ -29,6 +29,8 @@
 		"test-cover": "# istanbul cover  -x 'lib/zt/zt.js' --dir test/coverage _mocha",
 		"build": "yarn format && yarn build-only",
 		"build-only": "sh build.sh",
+		"test-perf": "bun test/performance/vs-npm.js",
+		"test-perf-mini": "bun test/performance/vs-npm.js --scale=0.5 --runs=2 --runtime=node --fail-above=105",
 		"install-g": "yarn build && npm uninstall alasql -g && npm install -g .",
 		"release": "yarn version",
 		"jison": "jison ./src/alasqlparser.jison -o ./src/alasqlparser.js",
@@ -51,6 +53,7 @@
 		"pre-pr": "cmdmix 'yarn fresh '%1' && yarn repush'",
 		"prepare": "husky",
 		"preversion": "yarn && yarn test && npm login",
+		"prepublishOnly": "sh build.sh </dev/null",
 		"postversion": "npm publish && git push && git push --tags && echo \"Successfully released version $npm_package_version\""
 	},
 	"dependencies": {
@@ -71,7 +74,7 @@
 		"open": "11.0.4",
 		"prettier": "3.9.10",
 		"react-native-fetch-blob": "^0.10.8",
-		"rexreplace": "7.1.14",
+		"rexreplace": "7.1.15",
 		"strftime": "0.10.3",
 		"tabletop": "^1.6.2",
 		"uglify-js": "3.19.3"

package/test1107.json

@@ -0,0 +1,3 @@
+{
+  "alasql": "{\"databases\":{}}"
+}

package/types/alasql.d.ts

@@ -8,6 +8,11 @@ declare module 'alasql' {
 		(err: Error | null, data?: T): void;
 	}
 
+	// Callback of a compiled statement: data first, then the error (data is null when err is set)
+	export interface AlaSQLStatementCallback<T = unknown> {
+		(data: T | null, err?: Error): void;
+	}
+
 	export interface AlaSQLOptions {
 		errorlog: boolean;
 		valueof: boolean;
@@ -39,8 +44,10 @@ declare module 'alasql' {
 		<T = unknown>(params?: any, cb?: AlaSQLCallback<T>, scope?: unknown): T;
 	}
 
-	// returned by alasql.compile(): a compiled statement with a promise helper
-	export interface AlaSQLCompiledStatement extends AlaSQLStatement {
+	// returned by alasql.compile(): a compiled statement with a promise helper. Only this one takes
+	// the data-first callback, so the older Statement.compile() types stay as they were in 4.x
+	export interface AlaSQLCompiledStatement {
+		<T = unknown>(params?: any, cb?: AlaSQLStatementCallback<T>, scope?: unknown): T;
 		promise<T = unknown>(params?: any): Promise<T>;
 	}
 
@@ -57,12 +64,19 @@ declare module 'alasql' {
 	export interface Op extends AlaSQLExpression {
 		left: ExpressionNode;
 		op: string;
-		// `->` with a bare property name (`a->b`, `tx.a.b`) puts the name as a string
-		right?: ExpressionNode | string;
+		right?: ExpressionNode;
 		right1?: ExpressionNode;
 		right2?: ExpressionNode;
 	}
 
+	// Not in the ExpressionNode union, so code that walks the tree compiles as it did before 4.21.0
+	export interface ArrowOp extends AlaSQLExpression {
+		left: ExpressionNode;
+		op: '->';
+		// a bare property name (`a->b`, `tx.a.b`) puts the name as a string
+		right: ExpressionNode | string;
+	}
+
 	export interface Column extends AlaSQLExpression {
 		columnid: string;
 		tableid?: string;
@@ -96,14 +110,7 @@ declare module 'alasql' {
 	}
 
 	export type ExpressionNode =
-		| Op
-		| Column
-		| ParamValue
-		| NumValue
-		| StringValue
-		| LogicValue
-		| UniOp
-		| FuncValue;
+		Op | Column | ParamValue | NumValue | StringValue | LogicValue | UniOp | FuncValue;
 
 	export interface ExpressionWrapper extends AlaSQLExpression {
 		expression: ExpressionNode;

package/context/sqllogictest-failure-kinds.js

@@ -1,36 +0,0 @@
-// Sorts the failures printed in an alasql-sqllogictest result file by kind.
-// Used for context/strategic-direction.md, "What sqllogictest already says". Reads only; runs no tests.
-// Run: node context/sqllogictest-failure-kinds.js ../alasql-sqllogictest/results/output.md [kind-substring] [examples]
-const fs=require('fs');
-const f=process.argv[2];
-const txt=fs.readFileSync(f,'utf8');
-const blocks=[...txt.matchAll(/```sql\n([\s\S]*?)\n\n([\s\S]*?)\n```/g)].map(m=>({sql:m[1],msg:m[2]}));
-console.log('printed errors:',blocks.length);
-const cat={};
-const ex={};
-function add(k,b){cat[k]=(cat[k]||0)+1;(ex[k]=ex[k]||[]).push(b)}
-let nullDiff=0,valDiff=0,lenDiff=0;
-for(const b of blocks){
-  const m=b.msg;
-  let k;
-  if(/^Expected: /.test(m)){
-    const mm=m.match(/^Expected: (\[.*?\]) but got (\[.*\])/);
-    let e,g;try{e=JSON.parse(mm[1]);g=JSON.parse(mm[2]);}catch(x){k='expected/got (truncated)';add(k,b);continue}
-    if(e.length!==g.length){k='values: different count';}
-    else{
-      let n=0,o=0;
-      for(let i=0;i<e.length;i++){ if(e[i]!==g[i]){ if(e[i]==='NULL'||g[i]==='NULL') n++; else o++; } }
-      if(n&&!o)k='values: differ only where one side is NULL';
-      else if(n&&o)k='values: NULL and non-NULL differences';
-      else k='values: non-NULL differences only';
-    }
-  } else if(/Parse error/.test(m)) k='parse error';
-  else if(/expected to return results/.test(m)) k='no rows returned';
-  else if(/Expected to get an error/.test(m)) k='expected an error';
-  else if(/hash was different/.test(m)) k='hash differs (same count)';
-  else if(/results returned but expected/.test(m)) k='row count differs (hash)';
-  else k='runtime: '+m.replace(/'[^']*'/g,"'…'").replace(/\d+/g,'N').slice(0,60);
-  add(k,b);
-}
-Object.entries(cat).sort((a,b)=>b[1]-a[1]).forEach(([k,v])=>console.log(String(v).padStart(5),k));
-if(process.argv[3]){for(const k of Object.keys(ex)){ if(k.includes(process.argv[3])){ex[k].slice(0,+process.argv[4]||8).forEach(b=>console.log('\n['+k+']\n'+b.sql.slice(0,400)+'\n => '+b.msg.slice(0,300)))}}}

package/context/tag-prototype.js

@@ -1,127 +0,0 @@
-// Prototype for context/strategic-direction.md, "Tagged templates". Not part of the build.
-// Run: node context/tag-prototype.js
-//
-// Position-aware tagged template on the public 4.x API.
-// No grammar change. A scanner walks the fixed text pieces and notes
-// where each hole stands. The parser only ever sees ordinary SQL with `?`.
-const alasql = require('../dist/alasql.js');
-
-const CODE = 0, SQ = 1, DQ = 2, BR = 3, LINE = 4, BLOCK = 5;
-
-function scan(raw) {
-	// returns {parts: [...], holes: [{kind:'value'|'string'|'name'}]}
-	let state = CODE;
-	let out = '';
-	let litStart = -1; // index in `out` where the current string literal opened
-	let litHasHole = false;
-	const holes = [];
-	const segments = []; // sql text split at each name hole
-	for (let s = 0; s < raw.length; s++) {
-		const t = raw[s];
-		for (let i = 0; i < t.length; i++) {
-			const c = t[i], n = t[i + 1];
-			if (state === CODE) {
-				if (c === "'") { state = SQ; litStart = out.length; litHasHole = false; }
-				else if (c === '"') { state = DQ; litStart = out.length; litHasHole = false; }
-				else if (c === '[') state = BR;
-				else if (c === '-' && n === '-') state = LINE;
-				else if (c === '/' && n === '*') state = BLOCK;
-				out += c;
-			} else if (state === SQ || state === DQ) {
-				const q = state === SQ ? "'" : '"';
-				out += c;
-				if (c === q) {
-					if (n === q) { out += n; i++; } // doubled quote stays inside
-					else {
-						if (litHasHole) { out = out.slice(0, litStart) + '(' + out.slice(litStart) + ')'; }
-						state = CODE;
-					}
-				}
-			} else if (state === BR) { out += c; if (c === ']') state = CODE; }
-			else if (state === LINE) { out += c; if (c === '\n') state = CODE; }
-			else if (state === BLOCK) { out += c; if (c === '*' && n === '/') { out += n; i++; state = CODE; } }
-		}
-		if (s === raw.length - 1) break;
-		// a hole
-		if (state === CODE) { out += '?'; holes.push('value'); }
-		else if (state === SQ || state === DQ) {
-			const q = state === SQ ? "'" : '"';
-			out += q + ' + ? + ' + q; litHasHole = true; holes.push('string');
-		} else if (state === BR) { segments.push(out); out = ''; litStart = -1; holes.push('name'); }
-		else throw new Error('A ${} cannot stand inside a comment');
-	}
-	if (state === SQ || state === DQ || state === BR) throw new Error('Unclosed quote or bracket in the query text');
-	segments.push(out);
-	return { segments, holes };
-}
-
-const sites = new WeakMap();
-
-function tag(strings, ...values) {
-	let site = sites.get(strings);
-	if (!site) {
-		site = scan(strings.raw);
-		site.hasNames = site.holes.includes('name');
-		site.byNames = new Map();
-		sites.set(strings, site);
-	}
-	const params = [];
-	let key = '';
-	const names = [];
-	for (let i = 0; i < values.length; i++) {
-		const kind = site.holes[i], v = values[i];
-		if (kind === 'name') {
-			if (typeof v !== 'string' || v.includes(']')) throw new Error('A name in [${}] must be a string without "]"');
-			names.push(v); key += v + ']';
-		} else if (kind === 'string') params.push(v == null ? '' : String(v));
-		else params.push(v);
-	}
-	let st = site.byNames.get(key);
-	if (!st) {
-		let sql = site.segments[0];
-		for (let i = 0; i < names.length; i++) sql += names[i] + site.segments[i + 1];
-		st = alasql.compile(sql);
-		st.sqlText = sql;
-		site.byNames.set(key, st);
-	}
-	return st(params);
-}
-tag.show = (strings) => scan(strings.raw);
-module.exports = tag;
-
-if (require.main === module) {
-	const sql = tag;
-	const people = [
-		{ name: 'Ann', age: 31, city: 'Oslo' },
-		{ name: "O'Brien", age: 25, city: 'Cork' },
-		{ name: 'Bo', age: 19, city: 'Oslo' },
-	];
-	const j = (x) => JSON.stringify(x);
-	const run = (label, f) => { try { console.log(label.padEnd(46), '=>', j(f())); } catch (e) { console.log(label.padEnd(46), '!!', e.message.slice(0, 90)); } };
-
-	const city = 'Oslo', term = 'O', col = 'age', evil = "x' OR 1=1 --", min = 20;
-	run('bare value + table', () => sql`SELECT COLUMN name FROM ${people} WHERE city = ${city} AND age > ${min}`);
-	run("value inside quotes  '${city}'", () => sql`SELECT COLUMN name FROM ${people} WHERE city = '${city}'`);
-	run("LIKE '${term}%'", () => sql`SELECT COLUMN name FROM ${people} WHERE name LIKE '${term}%'`);
-	run("LIKE '%${term}%' with a doubled quote before", () => sql`SELECT COLUMN name FROM ${people} WHERE 'it''s' = 'it''s' AND name LIKE '%${'ri'}%'`);
-	run('name inside brackets  [${col}]', () => sql`SELECT COLUMN [${col}] FROM ${people} ORDER BY [${col}]`);
-	run('same call site, other name', () => { const f = (c) => sql`SELECT COLUMN [${c}] FROM ${people}`; return [f('name'), f('city')]; });
-	run('value with a quote in it, bare', () => sql`SELECT COLUMN name FROM ${people} WHERE name = ${"O'Brien"}`);
-	run('value with a quote in it, in quotes', () => sql`SELECT COLUMN name FROM ${people} WHERE name = '${"O'Brien"}'`);
-	run('injection attempt in quotes', () => sql`SELECT COLUMN name FROM ${people} WHERE name = '${evil}'`);
-	run('injection attempt bare', () => sql`SELECT COLUMN name FROM ${people} WHERE name = ${evil}`);
-	run('injection attempt as a name', () => sql`SELECT COLUMN [${'age] FROM x; DROP TABLE y; --'}] FROM ${people}`);
-	run('hole inside a comment', () => sql`SELECT 1 /* ${city} */`);
-	run('question mark inside a string is text', () => sql`SELECT VALUE 'why? ${city}'`);
-	console.log('\nWhat the parser is given for  name LIKE \'%${term}%\' AND [${col}] > ${min}:');
-	const shown = tag.show`SELECT * FROM ${people} WHERE name LIKE '%${term}%' AND [${col}] > ${min}`;
-	console.log('  text pieces:', j(shown.segments), '\n  holes:', j(shown.holes));
-
-	// timing
-	const data = []; for (let i = 0; i < 10; i++) data.push({ name: 'n' + i, age: 18 + i, city: i % 2 ? 'A' : 'B' });
-	const time = (label, f) => { for (let i = 0; i < 20000; i++) f(); const N = 200000; const s = process.hrtime.bigint(); for (let i = 0; i < N; i++) f(); const ns = Number(process.hrtime.bigint() - s) / N; console.log(label.padEnd(46), ns.toFixed(0), 'ns'); };
-	console.log();
-	time('alasql(sql, params)', () => alasql('SELECT name, age FROM ? WHERE age > ? AND city = ? ORDER BY age DESC', [data, 23, 'A']));
-	time('tag, bare holes', () => sql`SELECT name, age FROM ${data} WHERE age > ${23} AND city = ${'A'} ORDER BY age DESC`);
-	time("tag, quoted hole + name hole", () => sql`SELECT name, [${'age'}] FROM ${data} WHERE age > ${23} AND city = '${'A'}' ORDER BY age DESC`);
-}