@object-ui/core 0.3.1 → 2.0.0

package/src/query/__tests__/window-functions.test.ts

@@ -0,0 +1,275 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @object-ui/core - Window Function Tests
+ * 
+ * Tests for ObjectStack Spec v2.0.1 window function support
+ */
+
+import { describe, it, expect } from 'vitest';
+import { QueryASTBuilder } from '../query-ast';
+import type { WindowNode, WindowFunction } from '@object-ui/types';
+
+describe('QueryASTBuilder - Window Functions', () => {
+  const builder = new QueryASTBuilder();
+
+  describe('buildWindow', () => {
+    it('should build a simple row_number window function', () => {
+      const config = {
+        function: 'row_number' as WindowFunction,
+        alias: 'row_num',
+        partitionBy: ['department'],
+        orderBy: [{ field: 'salary', direction: 'desc' as const }],
+      };
+
+      // @ts-expect-error - testing private method
+      const result: WindowNode = builder.buildWindow(config);
+
+      expect(result).toMatchObject({
+        type: 'window',
+        function: 'row_number',
+        alias: 'row_num',
+      });
+
+      expect(result.partitionBy).toHaveLength(1);
+      expect(result.partitionBy![0]).toMatchObject({
+        type: 'field',
+        name: 'department',
+      });
+
+      expect(result.orderBy).toHaveLength(1);
+      expect(result.orderBy![0]).toMatchObject({
+        field: { type: 'field', name: 'salary' },
+        direction: 'desc',
+      });
+    });
+
+    it('should build a rank window function with multiple partition fields', () => {
+      const config = {
+        function: 'rank' as WindowFunction,
+        alias: 'rank_val',
+        partitionBy: ['department', 'location'],
+        orderBy: [
+          { field: 'performance_score', direction: 'desc' as const },
+          { field: 'tenure_years', direction: 'desc' as const },
+        ],
+      };
+
+      // @ts-expect-error - testing private method
+      const result: WindowNode = builder.buildWindow(config);
+
+      expect(result).toMatchObject({
+        type: 'window',
+        function: 'rank',
+        alias: 'rank_val',
+      });
+
+      expect(result.partitionBy).toHaveLength(2);
+      expect(result.orderBy).toHaveLength(2);
+    });
+
+    it('should build a lag window function with offset and default value', () => {
+      const config = {
+        function: 'lag' as WindowFunction,
+        field: 'revenue',
+        alias: 'prev_month_revenue',
+        partitionBy: ['product_id'],
+        orderBy: [{ field: 'month', direction: 'asc' as const }],
+        offset: 1,
+        defaultValue: 0,
+      };
+
+      // @ts-expect-error - testing private method
+      const result: WindowNode = builder.buildWindow(config);
+
+      expect(result).toMatchObject({
+        type: 'window',
+        function: 'lag',
+        alias: 'prev_month_revenue',
+        offset: 1,
+      });
+
+      expect(result.field).toMatchObject({
+        type: 'field',
+        name: 'revenue',
+      });
+
+      expect(result.defaultValue).toMatchObject({
+        type: 'literal',
+        value: 0,
+        data_type: 'number',
+      });
+    });
+
+    it('should build a lead window function', () => {
+      const config = {
+        function: 'lead' as WindowFunction,
+        field: 'sales',
+        alias: 'next_day_sales',
+        orderBy: [{ field: 'date', direction: 'asc' as const }],
+        offset: 1,
+      };
+
+      // @ts-expect-error - testing private method
+      const result: WindowNode = builder.buildWindow(config);
+
+      expect(result).toMatchObject({
+        type: 'window',
+        function: 'lead',
+        alias: 'next_day_sales',
+        offset: 1,
+      });
+    });
+
+    it('should build aggregate window functions (sum, avg, count)', () => {
+      const sumConfig = {
+        function: 'sum' as WindowFunction,
+        field: 'amount',
+        alias: 'running_total',
+        orderBy: [{ field: 'date', direction: 'asc' as const }],
+        frame: {
+          unit: 'rows' as const,
+          start: 'unbounded_preceding' as const,
+          end: 'current_row' as const,
+        },
+      };
+
+      // @ts-expect-error - testing private method
+      const result: WindowNode = builder.buildWindow(sumConfig);
+
+      expect(result).toMatchObject({
+        type: 'window',
+        function: 'sum',
+        alias: 'running_total',
+      });
+
+      expect(result.field).toMatchObject({
+        type: 'field',
+        name: 'amount',
+      });
+
+      expect(result.frame).toEqual({
+        unit: 'rows',
+        start: 'unbounded_preceding',
+        end: 'current_row',
+      });
+    });
+
+    it('should build first_value window function', () => {
+      const config = {
+        function: 'first_value' as WindowFunction,
+        field: 'price',
+        alias: 'first_price',
+        partitionBy: ['product_category'],
+        orderBy: [{ field: 'created_at', direction: 'asc' as const }],
+      };
+
+      // @ts-expect-error - testing private method
+      const result: WindowNode = builder.buildWindow(config);
+
+      expect(result).toMatchObject({
+        type: 'window',
+        function: 'first_value',
+        alias: 'first_price',
+      });
+    });
+
+    it('should build last_value window function', () => {
+      const config = {
+        function: 'last_value' as WindowFunction,
+        field: 'status',
+        alias: 'latest_status',
+        partitionBy: ['customer_id'],
+        orderBy: [{ field: 'updated_at', direction: 'desc' as const }],
+      };
+
+      // @ts-expect-error - testing private method
+      const result: WindowNode = builder.buildWindow(config);
+
+      expect(result).toMatchObject({
+        type: 'window',
+        function: 'last_value',
+        alias: 'latest_status',
+      });
+    });
+
+    it('should handle window function without partition by', () => {
+      const config = {
+        function: 'row_number' as WindowFunction,
+        alias: 'global_row_num',
+        orderBy: [{ field: 'created_at', direction: 'asc' as const }],
+      };
+
+      // @ts-expect-error - testing private method
+      const result: WindowNode = builder.buildWindow(config);
+
+      expect(result.partitionBy).toBeUndefined();
+      expect(result.orderBy).toBeDefined();
+    });
+
+    it('should handle window function with frame specification', () => {
+      const config = {
+        function: 'avg' as WindowFunction,
+        field: 'temperature',
+        alias: 'moving_avg_3days',
+        orderBy: [{ field: 'date', direction: 'asc' as const }],
+        frame: {
+          unit: 'rows' as const,
+          start: { type: 'preceding' as const, offset: 2 },
+          end: 'current_row' as const,
+        },
+      };
+
+      // @ts-expect-error - testing private method
+      const result: WindowNode = builder.buildWindow(config);
+
+      expect(result.frame).toEqual({
+        unit: 'rows',
+        start: { type: 'preceding', offset: 2 },
+        end: 'current_row',
+      });
+    });
+
+    it('should build dense_rank window function', () => {
+      const config = {
+        function: 'dense_rank' as WindowFunction,
+        alias: 'dense_rank_val',
+        partitionBy: ['team'],
+        orderBy: [{ field: 'score', direction: 'desc' as const }],
+      };
+
+      // @ts-expect-error - testing private method
+      const result: WindowNode = builder.buildWindow(config);
+
+      expect(result).toMatchObject({
+        type: 'window',
+        function: 'dense_rank',
+        alias: 'dense_rank_val',
+      });
+    });
+
+    it('should build percent_rank window function', () => {
+      const config = {
+        function: 'percent_rank' as WindowFunction,
+        alias: 'percentile',
+        partitionBy: ['class'],
+        orderBy: [{ field: 'exam_score', direction: 'desc' as const }],
+      };
+
+      // @ts-expect-error - testing private method
+      const result: WindowNode = builder.buildWindow(config);
+
+      expect(result).toMatchObject({
+        type: 'window',
+        function: 'percent_rank',
+        alias: 'percentile',
+      });
+    });
+  });
+});

package/src/query/index.ts

@@ -0,0 +1,7 @@
+/**
+ * @object-ui/core - Query Module
+ * 
+ * Phase 3.3: Query AST builder and utilities
+ */
+
+export * from './query-ast.js';

package/src/query/query-ast.ts

@@ -0,0 +1,341 @@
+/**
+ * ObjectUI - Query AST Builder
+ * Phase 3.3: QuerySchema AST implementation
+ * ObjectStack Spec v2.0.1: Window functions support
+ */
+
+import type {
+  QueryAST,
+  QuerySchema,
+  SelectNode,
+  FromNode,
+  WhereNode,
+  JoinNode,
+  GroupByNode,
+  OrderByNode,
+  LimitNode,
+  OffsetNode,
+  AggregateNode,
+  WindowNode,
+  WindowFunction,
+  WindowFrame,
+  WindowConfig,
+  FieldNode,
+  LiteralNode,
+  OperatorNode,
+  LogicalOperator,
+  AdvancedFilterSchema,
+  AdvancedFilterCondition,
+  QuerySortConfig,
+  JoinConfig,
+  AggregationConfig,
+} from '@object-ui/types';
+
+/**
+ * Query AST Builder - Converts QuerySchema to AST
+ */
+export class QueryASTBuilder {
+  build(query: QuerySchema): QueryAST {
+    const ast: QueryAST = {
+      select: this.buildSelect(query),
+      from: this.buildFrom(query),
+    };
+
+    if (query.filter) {
+      ast.where = this.buildWhere(query.filter);
+    }
+
+    if (query.joins && query.joins.length > 0) {
+      ast.joins = query.joins.map(join => this.buildJoin(join));
+    }
+
+    if (query.group_by && query.group_by.length > 0) {
+      ast.group_by = this.buildGroupBy(query.group_by);
+    }
+
+    if (query.sort && query.sort.length > 0) {
+      ast.order_by = this.buildOrderBy(query.sort);
+    }
+
+    if (query.limit !== undefined) {
+      ast.limit = this.buildLimit(query.limit);
+    }
+
+    if (query.offset !== undefined) {
+      ast.offset = this.buildOffset(query.offset);
+    }
+
+    return ast;
+  }
+
+  private buildSelect(query: QuerySchema): SelectNode {
+    const fields: (FieldNode | AggregateNode | WindowNode)[] = [];
+
+    if (query.fields && query.fields.length > 0) {
+      fields.push(...query.fields.map(field => this.buildField(field)));
+    } else if (!query.aggregations || query.aggregations.length === 0) {
+      // Only add '*' if there are no aggregations
+      fields.push(this.buildField('*'));
+    }
+
+    if (query.aggregations && query.aggregations.length > 0) {
+      fields.push(...query.aggregations.map(agg => this.buildAggregation(agg)));
+    }
+
+    // Add window functions (ObjectStack Spec v2.0.1)
+    if (query.windows && query.windows.length > 0) {
+      fields.push(...query.windows.map(win => this.buildWindow(win)));
+    }
+
+    return {
+      type: 'select',
+      fields,
+      distinct: false,
+    };
+  }
+
+  private buildFrom(query: QuerySchema): FromNode {
+    return {
+      type: 'from',
+      table: query.object,
+    };
+  }
+
+  private buildWhere(filter: AdvancedFilterSchema): WhereNode {
+    return {
+      type: 'where',
+      condition: this.buildFilterCondition(filter),
+    };
+  }
+
+  private buildFilterCondition(filter: AdvancedFilterSchema): OperatorNode {
+    const operator = filter.operator || 'and';
+    const operands: (OperatorNode | FieldNode | LiteralNode)[] = [];
+
+    if (filter.conditions && filter.conditions.length > 0) {
+      operands.push(...filter.conditions.map(cond => this.buildCondition(cond)));
+    }
+
+    if (filter.groups && filter.groups.length > 0) {
+      operands.push(...filter.groups.map(group => this.buildFilterCondition(group)));
+    }
+
+    return {
+      type: 'operator',
+      operator: operator as LogicalOperator,
+      operands,
+    };
+  }
+
+  private buildCondition(condition: AdvancedFilterCondition): OperatorNode {
+    const field = this.buildField(condition.field);
+    
+    // Map filter operators to comparison operators
+    const operatorMap: Record<string, string> = {
+      'equals': '=',
+      'not_equals': '!=',
+      'greater_than': '>',
+      'greater_than_or_equal': '>=',
+      'less_than': '<',
+      'less_than_or_equal': '<=',
+      'contains': 'contains',
+      'not_contains': 'contains',
+      'starts_with': 'starts_with',
+      'ends_with': 'ends_with',
+      'like': 'like',
+      'ilike': 'ilike',
+      'in': 'in',
+      'not_in': 'not_in',
+      'is_null': 'is_null',
+      'is_not_null': 'is_not_null',
+      'between': 'between',
+    };
+
+    const operator = operatorMap[condition.operator] || '=';
+    
+    // Handle special operators
+    if (operator === 'between' && condition.values && condition.values.length === 2) {
+      return {
+        type: 'operator',
+        operator: 'between' as any,
+        operands: [
+          field,
+          this.buildLiteral(condition.values[0]),
+          this.buildLiteral(condition.values[1])
+        ],
+      };
+    }
+
+    if ((operator === 'in' || operator === 'not_in') && condition.values) {
+      return {
+        type: 'operator',
+        operator: operator as any,
+        operands: [field, ...condition.values.map(v => this.buildLiteral(v))],
+      };
+    }
+
+    if (operator === 'is_null' || operator === 'is_not_null') {
+      return {
+        type: 'operator',
+        operator: operator as any,
+        operands: [field],
+      };
+    }
+
+    // Standard binary operator
+    const value = this.buildLiteral(condition.value);
+    return {
+      type: 'operator',
+      operator: operator as any,
+      operands: [field, value],
+    };
+  }
+
+  private buildJoin(join: JoinConfig): JoinNode {
+    const onCondition: OperatorNode = {
+      type: 'operator',
+      operator: '=',
+      operands: [
+        this.buildField(join.on.local_field),
+        this.buildField(join.on.foreign_field, join.alias || join.object),
+      ],
+    };
+
+    return {
+      type: 'join',
+      join_type: join.type,
+      table: join.object,
+      alias: join.alias,
+      on: onCondition,
+    };
+  }
+
+  private buildGroupBy(fields: string[]): GroupByNode {
+    return {
+      type: 'group_by',
+      fields: fields.map(field => this.buildField(field)),
+    };
+  }
+
+  private buildOrderBy(sorts: QuerySortConfig[]): OrderByNode {
+    return {
+      type: 'order_by',
+      fields: sorts.map(sort => ({
+        field: this.buildField(sort.field),
+        direction: sort.order,
+      })),
+    };
+  }
+
+  private buildLimit(limit: number): LimitNode {
+    return {
+      type: 'limit',
+      value: limit,
+    };
+  }
+
+  private buildOffset(offset: number): OffsetNode {
+    return {
+      type: 'offset',
+      value: offset,
+    };
+  }
+
+  private buildField(field: string, table?: string): FieldNode {
+    const parts = field.split('.');
+    
+    if (parts.length === 2) {
+      return {
+        type: 'field',
+        table: parts[0],
+        name: parts[1],
+      };
+    }
+
+    return {
+      type: 'field',
+      table,
+      name: field,
+    };
+  }
+
+  private buildLiteral(value: any): LiteralNode {
+    let dataType: 'string' | 'number' | 'boolean' | 'date' | 'null' = 'string';
+    
+    if (value === null || value === undefined) {
+      dataType = 'null';
+    } else if (typeof value === 'number') {
+      dataType = 'number';
+    } else if (typeof value === 'boolean') {
+      dataType = 'boolean';
+    } else if (value instanceof Date) {
+      dataType = 'date';
+    }
+
+    return {
+      type: 'literal',
+      value,
+      data_type: dataType,
+    };
+  }
+
+  private buildAggregation(agg: AggregationConfig): AggregateNode {
+    return {
+      type: 'aggregate',
+      function: agg.function,
+      field: agg.field ? this.buildField(agg.field) : undefined,
+      alias: agg.alias,
+      distinct: agg.distinct,
+    };
+  }
+
+  /**
+   * Build window function node (ObjectStack Spec v2.0.1)
+   */
+  private buildWindow(config: WindowConfig): WindowNode {
+    const node: WindowNode = {
+      type: 'window',
+      function: config.function,
+      alias: config.alias,
+    };
+
+    if (config.field) {
+      node.field = this.buildField(config.field);
+    }
+
+    if (config.partitionBy && config.partitionBy.length > 0) {
+      node.partitionBy = config.partitionBy.map(field => this.buildField(field));
+    }
+
+    if (config.orderBy && config.orderBy.length > 0) {
+      node.orderBy = config.orderBy.map(sort => ({
+        field: this.buildField(sort.field),
+        direction: sort.direction,
+      }));
+    }
+
+    if (config.frame) {
+      node.frame = config.frame;
+    }
+
+    if (config.offset !== undefined) {
+      node.offset = config.offset;
+    }
+
+    if (config.defaultValue !== undefined) {
+      node.defaultValue = this.buildLiteral(config.defaultValue);
+    }
+
+    return node;
+  }
+
+  optimize(ast: QueryAST): QueryAST {
+    return ast;
+  }
+}
+
+export const defaultQueryASTBuilder = new QueryASTBuilder();
+
+export function buildQueryAST(query: QuerySchema): QueryAST {
+  return defaultQueryASTBuilder.build(query);
+}