squirreling 0.2.0 → 0.2.2

package/README.md

@@ -7,6 +7,7 @@
 [![minzipped](https://img.shields.io/bundlephobia/minzip/squirreling)](https://www.npmjs.com/package/squirreling)
 [![workflow status](https://github.com/hyparam/squirreling/actions/workflows/ci.yml/badge.svg)](https://github.com/hyparam/squirreling/actions)
 [![mit license](https://img.shields.io/badge/License-MIT-orange.svg)](https://opensource.org/licenses/MIT)
+![coverage](https://img.shields.io/badge/Coverage-89-darkred)
 [![dependencies](https://img.shields.io/badge/Dependencies-0-blueviolet)](https://www.npmjs.com/package/squirreling?activeTab=dependencies)
 
 Squirreling is a lightweight SQL engine for JavaScript applications, designed to provide efficient and easy-to-use database functionalities in the browser.
@@ -29,7 +30,7 @@ const source = [
   { id: 2, name: 'Bob' },
 ]
 
-const result = executeSql({ source, sql: 'SELECT UPPER(name) AS name_upper FROM users' })
+const result = executeSql({ source, query: 'SELECT UPPER(name) AS name_upper FROM users' })
 console.log(result)
 // Output: [ { name_upper: 'ALICE' }, { name_upper: 'BOB' } ]
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "squirreling",
-  "version": "0.2.0",
-  "description": "",
+  "version": "0.2.2",
+  "description": "Squirreling SQL Engine",
   "author": "Hyperparam",
   "homepage": "https://hyperparam.app",
   "keywords": [
@@ -40,7 +40,7 @@
     "@types/node": "24.10.1",
     "@vitest/coverage-v8": "4.0.13",
     "eslint": "9.39.1",
-    "eslint-plugin-jsdoc": "61.4.0",
+    "eslint-plugin-jsdoc": "61.4.1",
     "typescript": "5.9.3",
     "vitest": "4.0.13"
   }

package/src/execute/execute.js

@@ -4,7 +4,7 @@
 
 import { defaultAggregateAlias, evaluateAggregate } from './aggregates.js'
 import { evaluateExpr } from './expression.js'
-import { createHavingContext, evaluateHavingExpr } from './having.js'
+import { evaluateHavingExpr } from './having.js'
 import { parseSql } from '../parse/parse.js'
 import { createMemorySource, createRowAccessor } from '../backend/memory.js'
 
@@ -14,8 +14,8 @@ import { createMemorySource, createRowAccessor } from '../backend/memory.js'
  * @param {ExecuteSqlOptions} options - the execution options
  * @returns {Record<string, any>[]} the result rows matching the query
  */
-export function executeSql({ source, sql }) {
-  const select = parseSql(sql)
+export function executeSql({ source, query }) {
+  const select = parseSql(query)
   const dataSource = Array.isArray(source) ? createMemorySource(source) : source
   return evaluateSelectAst(select, dataSource)
 }
@@ -142,6 +142,8 @@ function evaluateSelectAst(select, dataSource) {
     throw new Error('JOIN is not supported')
   }
 
+  // SQL priority: from, where, group by, having, select, order by, offset, limit
+
   // WHERE clause filtering
   /** @type {RowSource[]} */
   const working = []
@@ -244,8 +246,7 @@ function evaluateSelectAst(select, dataSource) {
       if (select.having) {
         // For HAVING, we need to evaluate aggregates in the context of the group
         // Create a special row context that includes both the group data and aggregate values
-        const havingContext = createHavingContext(resultRow, group)
-        if (!evaluateHavingExpr(select.having, havingContext, group)) {
+        if (!evaluateHavingExpr(select.having, resultRow, group)) {
           continue
         }
       }

package/src/execute/having.js

@@ -12,7 +12,7 @@ import { evaluateExpr } from './expression.js'
  * @param {RowSource[]} group - the group of rows
  * @returns {RowSource} a context row for HAVING evaluation
  */
-export function createHavingContext(resultRow, group) {
+function createHavingContext(resultRow, group) {
   // Include the first row of the group (for GROUP BY columns)
   const firstRow = group[0]
   /** @type {Record<string, any>} */
@@ -41,11 +41,13 @@ export function createHavingContext(resultRow, group) {
  * Evaluates a HAVING expression with support for aggregate functions
  *
  * @param {ExprNode} expr - the HAVING expression
- * @param {RowSource} context - the context row with aggregated values
+ * @param {Record<string, any>} row - the aggregated result row
  * @param {RowSource[]} group - the group of rows for re-evaluating aggregates
  * @returns {boolean} whether the HAVING condition is satisfied
  */
-export function evaluateHavingExpr(expr, context, group) {
+export function evaluateHavingExpr(expr, row, group) {
+  const context = createHavingContext(row, group)
+
   // For HAVING, we need special handling of aggregate functions
   // They need to be re-evaluated against the group
   if (expr.type === 'function') {

package/src/index.d.ts

@@ -1,13 +1,14 @@
-import type { RowSource, SelectStatement } from './types.js'
+import type { ExecuteSqlOptions, SelectStatement } from './types.js'
 
 /**
  * Executes a SQL SELECT query against an array of data rows
  *
- * @param rows - data rows to query as a list of objects
- * @param sql - SQL query string
+ * @param options
+ * @param options.source - source data as a list of objects or a DataSource
+ * @param options.sql - SQL query string
  * @returns rows matching the query
  */
-export function executeSql(rows: RowSource[], sql: string): RowSource[]
+export function executeSql(options: ExecuteSqlOptions): Record<string, any>[]
 
 /**
  * Parses a SQL query string into an abstract syntax tree
@@ -15,4 +16,4 @@ export function executeSql(rows: RowSource[], sql: string): RowSource[]
  * @param sql - SQL query string to parse
  * @returns parsed SQL select statement
  */
-export function parseSql(sql: string): SelectStatement
+export function parseSql(query: string): SelectStatement

package/src/types.d.ts

@@ -10,7 +10,7 @@ export interface DataSource {
 
 export interface ExecuteSqlOptions {
   source: Record<string, any>[] | DataSource
-  sql: string
+  query: string
 }
 
 export type SqlPrimitive = string | number | bigint | boolean | null