@objectstack/objectql 4.0.4 → 4.1.0

package/src/util.test.ts

@@ -1,226 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import {
-  toTitleCase,
-  convertIntrospectedSchemaToObjects,
-} from './util';
-import type { IntrospectedSchema } from './util';
-
-describe('toTitleCase', () => {
-  it('should convert snake_case to Title Case', () => {
-    expect(toTitleCase('first_name')).toBe('First Name');
-    expect(toTitleCase('project_task')).toBe('Project Task');
-  });
-
-  it('should capitalize single words', () => {
-    expect(toTitleCase('name')).toBe('Name');
-    expect(toTitleCase('status')).toBe('Status');
-  });
-
-  it('should handle multiple underscores', () => {
-    expect(toTitleCase('long_multi_word_name')).toBe('Long Multi Word Name');
-  });
-
-  it('should handle empty string', () => {
-    expect(toTitleCase('')).toBe('');
-  });
-});
-
-describe('convertIntrospectedSchemaToObjects', () => {
-  const sampleSchema: IntrospectedSchema = {
-    tables: {
-      users: {
-        name: 'users',
-        columns: [
-          { name: 'id', type: 'integer', nullable: false, isPrimary: true },
-          { name: 'name', type: 'varchar', nullable: false, maxLength: 255 },
-          { name: 'email', type: 'varchar', nullable: false, isUnique: true, maxLength: 320 },
-          { name: 'bio', type: 'text', nullable: true },
-          { name: 'age', type: 'integer', nullable: true },
-          { name: 'is_active', type: 'boolean', nullable: false, defaultValue: true },
-          { name: 'created_at', type: 'timestamp', nullable: false },
-          { name: 'updated_at', type: 'timestamp', nullable: true },
-        ],
-        foreignKeys: [],
-        primaryKeys: ['id'],
-      },
-      posts: {
-        name: 'posts',
-        columns: [
-          { name: 'id', type: 'integer', nullable: false, isPrimary: true },
-          { name: 'title', type: 'varchar', nullable: false, maxLength: 500 },
-          { name: 'body', type: 'text', nullable: true },
-          { name: 'author_id', type: 'integer', nullable: false },
-          { name: 'metadata', type: 'jsonb', nullable: true },
-          { name: 'published_at', type: 'date', nullable: true },
-          { name: 'created_at', type: 'timestamp', nullable: false },
-          { name: 'updated_at', type: 'timestamp', nullable: true },
-        ],
-        foreignKeys: [
-          {
-            columnName: 'author_id',
-            referencedTable: 'users',
-            referencedColumn: 'id',
-            constraintName: 'fk_posts_author',
-          },
-        ],
-        primaryKeys: ['id'],
-      },
-    },
-  };
-
-  it('should convert all tables by default', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    expect(objects).toHaveLength(2);
-    expect(objects.map((o) => o.name)).toEqual(['users', 'posts']);
-  });
-
-  it('should skip system columns by default', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    const users = objects.find((o) => o.name === 'users')!;
-    const fieldNames = Object.keys(users.fields);
-    expect(fieldNames).not.toContain('id');
-    expect(fieldNames).not.toContain('created_at');
-    expect(fieldNames).not.toContain('updated_at');
-    expect(fieldNames).toContain('name');
-    expect(fieldNames).toContain('email');
-  });
-
-  it('should include system columns when skipSystemColumns=false', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema, {
-      skipSystemColumns: false,
-    });
-    const users = objects.find((o) => o.name === 'users')!;
-    const fieldNames = Object.keys(users.fields);
-    expect(fieldNames).toContain('id');
-    expect(fieldNames).toContain('created_at');
-    expect(fieldNames).toContain('updated_at');
-  });
-
-  it('should map varchar to text and text to textarea', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    const users = objects.find((o) => o.name === 'users')!;
-    expect(users.fields.name.type).toBe('text');
-    expect(users.fields.bio.type).toBe('textarea');
-  });
-
-  it('should map integer to number', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    const users = objects.find((o) => o.name === 'users')!;
-    expect(users.fields.age.type).toBe('number');
-  });
-
-  it('should map boolean to boolean', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    const users = objects.find((o) => o.name === 'users')!;
-    expect(users.fields.is_active.type).toBe('boolean');
-    expect(users.fields.is_active.defaultValue).toBe(true);
-  });
-
-  it('should map jsonb to json', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    const posts = objects.find((o) => o.name === 'posts')!;
-    expect(posts.fields.metadata.type).toBe('json');
-  });
-
-  it('should map date to date', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    const posts = objects.find((o) => o.name === 'posts')!;
-    expect(posts.fields.published_at.type).toBe('date');
-  });
-
-  it('should map foreign keys to lookup fields', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    const posts = objects.find((o) => o.name === 'posts')!;
-    expect(posts.fields.author_id.type).toBe('lookup');
-    expect(posts.fields.author_id.reference).toBe('users');
-  });
-
-  it('should set unique constraint', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    const users = objects.find((o) => o.name === 'users')!;
-    expect(users.fields.email.unique).toBe(true);
-  });
-
-  it('should set maxLength for text fields', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    const users = objects.find((o) => o.name === 'users')!;
-    expect(users.fields.name.maxLength).toBe(255);
-    expect(users.fields.email.maxLength).toBe(320);
-  });
-
-  it('should set required based on nullable', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    const users = objects.find((o) => o.name === 'users')!;
-    expect(users.fields.name.required).toBe(true);
-    expect(users.fields.bio.required).toBe(false);
-  });
-
-  it('should generate labels from table/field names', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema);
-    const users = objects.find((o) => o.name === 'users')!;
-    expect(users.label).toBe('Users');
-    expect(users.fields.is_active.label).toBe('Is Active');
-  });
-
-  it('should exclude tables when excludeTables is specified', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema, {
-      excludeTables: ['posts'],
-    });
-    expect(objects).toHaveLength(1);
-    expect(objects[0].name).toBe('users');
-  });
-
-  it('should include only specified tables when includeTables is specified', () => {
-    const objects = convertIntrospectedSchemaToObjects(sampleSchema, {
-      includeTables: ['posts'],
-    });
-    expect(objects).toHaveLength(1);
-    expect(objects[0].name).toBe('posts');
-  });
-
-  it('should handle empty schema', () => {
-    const objects = convertIntrospectedSchemaToObjects({ tables: {} });
-    expect(objects).toHaveLength(0);
-  });
-
-  it('should handle numeric types (float, decimal, real)', () => {
-    const schema: IntrospectedSchema = {
-      tables: {
-        metrics: {
-          name: 'metrics',
-          columns: [
-            { name: 'price', type: 'decimal', nullable: false },
-            { name: 'weight', type: 'float', nullable: true },
-            { name: 'score', type: 'real', nullable: true },
-            { name: 'quantity', type: 'bigint', nullable: false },
-          ],
-          foreignKeys: [],
-          primaryKeys: [],
-        },
-      },
-    };
-    const objects = convertIntrospectedSchemaToObjects(schema);
-    const metrics = objects[0];
-    expect(metrics.fields.price.type).toBe('number');
-    expect(metrics.fields.weight.type).toBe('number');
-    expect(metrics.fields.score.type).toBe('number');
-    expect(metrics.fields.quantity.type).toBe('number');
-  });
-
-  it('should handle time type', () => {
-    const schema: IntrospectedSchema = {
-      tables: {
-        schedule: {
-          name: 'schedule',
-          columns: [
-            { name: 'start_time', type: 'time', nullable: false },
-          ],
-          foreignKeys: [],
-          primaryKeys: [],
-        },
-      },
-    };
-    const objects = convertIntrospectedSchemaToObjects(schema);
-    expect(objects[0].fields.start_time.type).toBe('time');
-  });
-});

package/src/util.ts

@@ -1,219 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import type { ServiceObject } from '@objectstack/spec/data';
-
-// ── Introspection Types ──────────────────────────────────────────────────────
-
-/**
- * Column metadata from database introspection.
- */
-export interface IntrospectedColumn {
-  /** Column name */
-  name: string;
-  /** Native database type (e.g., 'varchar', 'integer', 'timestamp') */
-  type: string;
-  /** Whether the column is nullable */
-  nullable: boolean;
-  /** Default value if any */
-  defaultValue?: unknown;
-  /** Whether this is a primary key */
-  isPrimary?: boolean;
-  /** Whether this column has a unique constraint */
-  isUnique?: boolean;
-  /** Maximum length for string types */
-  maxLength?: number;
-}
-
-/**
- * Foreign key relationship metadata.
- */
-export interface IntrospectedForeignKey {
-  /** Column name in the source table */
-  columnName: string;
-  /** Referenced table name */
-  referencedTable: string;
-  /** Referenced column name */
-  referencedColumn: string;
-  /** Constraint name */
-  constraintName?: string;
-}
-
-/**
- * Table metadata from database introspection.
- */
-export interface IntrospectedTable {
-  /** Table name */
-  name: string;
-  /** List of columns */
-  columns: IntrospectedColumn[];
-  /** List of foreign key relationships */
-  foreignKeys: IntrospectedForeignKey[];
-  /** Primary key columns */
-  primaryKeys: string[];
-}
-
-/**
- * Complete database schema introspection result.
- */
-export interface IntrospectedSchema {
-  /** Map of table name to table metadata */
-  tables: Record<string, IntrospectedTable>;
-}
-
-// ── Utility Functions ────────────────────────────────────────────────────────
-
-/**
- * Convert a snake_case or plain string to Title Case.
- *
- * @example
- * toTitleCase('first_name')   // => 'First Name'
- * toTitleCase('project_task') // => 'Project Task'
- */
-export function toTitleCase(str: string): string {
-  return str
-    .replace(/_/g, ' ')
-    .replace(/\b\w/g, (char) => char.toUpperCase());
-}
-
-/**
- * Map a native database column type to an ObjectStack FieldType.
- */
-function mapDatabaseTypeToFieldType(
-  dbType: string
-): 'text' | 'textarea' | 'number' | 'boolean' | 'datetime' | 'date' | 'time' | 'json' {
-  const type = dbType.toLowerCase();
-
-  // Text types
-  if (type.includes('char') || type.includes('varchar') || type.includes('text')) {
-    if (type.includes('text')) return 'textarea';
-    return 'text';
-  }
-
-  // Numeric types
-  if (
-    type.includes('int') || type === 'integer' || type === 'bigint' || type === 'smallint'
-  ) {
-    return 'number';
-  }
-  if (
-    type.includes('float') || type.includes('double') || type.includes('decimal') ||
-    type.includes('numeric') || type === 'real'
-  ) {
-    return 'number';
-  }
-
-  // Boolean
-  if (type.includes('bool')) {
-    return 'boolean';
-  }
-
-  // Date / Time types
-  if (type.includes('timestamp') || type === 'datetime') {
-    return 'datetime';
-  }
-  if (type === 'date') {
-    return 'date';
-  }
-  if (type === 'time') {
-    return 'time';
-  }
-
-  // JSON types
-  if (type === 'json' || type === 'jsonb') {
-    return 'json';
-  }
-
-  // Default to text
-  return 'text';
-}
-
-/**
- * Convert an introspected database schema to ObjectStack object definitions.
- *
- * This allows using existing database tables without manually defining metadata.
- *
- * @param introspectedSchema - The schema returned from driver.introspectSchema()
- * @param options            - Optional filtering / conversion settings
- * @returns Array of ServiceObject definitions that can be registered with ObjectQL
- *
- * @example
- * ```typescript
- * const schema = await driver.introspectSchema();
- * const objects = convertIntrospectedSchemaToObjects(schema);
- * for (const obj of objects) {
- *   engine.registerObject(obj);
- * }
- * ```
- */
-export function convertIntrospectedSchemaToObjects(
-  introspectedSchema: IntrospectedSchema,
-  options?: {
-    /** Tables to exclude from conversion */
-    excludeTables?: string[];
-    /** Tables to include (if specified, only these will be converted) */
-    includeTables?: string[];
-    /** Whether to skip system columns like id, created_at, updated_at (default: true) */
-    skipSystemColumns?: boolean;
-  }
-): ServiceObject[] {
-  const objects: ServiceObject[] = [];
-  const excludeTables = options?.excludeTables || [];
-  const includeTables = options?.includeTables;
-  const skipSystemColumns = options?.skipSystemColumns !== false;
-
-  for (const [tableName, table] of Object.entries(introspectedSchema.tables)) {
-    if (excludeTables.includes(tableName)) continue;
-    if (includeTables && !includeTables.includes(tableName)) continue;
-
-    const fields: Record<string, any> = {};
-
-    for (const column of table.columns) {
-      // Skip system columns if requested
-      if (skipSystemColumns && ['id', 'created_at', 'updated_at'].includes(column.name)) {
-        continue;
-      }
-
-      // Check for foreign key → lookup field
-      const foreignKey = table.foreignKeys.find((fk) => fk.columnName === column.name);
-
-      if (foreignKey) {
-        fields[column.name] = {
-          name: column.name,
-          type: 'lookup' as const,
-          reference: foreignKey.referencedTable,
-          label: toTitleCase(column.name),
-          required: !column.nullable,
-        };
-      } else {
-        const fieldType = mapDatabaseTypeToFieldType(column.type);
-
-        const field: Record<string, any> = {
-          name: column.name,
-          type: fieldType,
-          label: toTitleCase(column.name),
-          required: !column.nullable,
-        };
-
-        if (column.isUnique) {
-          field.unique = true;
-        }
-        if (column.maxLength && (fieldType === 'text' || fieldType === 'textarea')) {
-          field.maxLength = column.maxLength;
-        }
-        if (column.defaultValue != null) {
-          field.defaultValue = column.defaultValue;
-        }
-
-        fields[column.name] = field;
-      }
-    }
-
-    objects.push({
-      name: tableName,
-      label: toTitleCase(tableName),
-      fields,
-    } as ServiceObject);
-  }
-
-  return objects;
-}

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist", "**/*.test.ts"],
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src",
-    "types": ["node"]
-  }
-}