@zero-server/orm 0.9.1 → 0.9.3

package/lib/orm/views.js

@@ -0,0 +1,350 @@
+/**
+ * @module orm/views
+ * @description Database view management for the ORM.
+ *              Supports creating, dropping, and querying database views.
+ *              View-backed models are read-only by default.
+ *
+ * @section Views
+ *
+ * @example
+ *   const { DatabaseView } = require('@zero-server/sdk');
+ *
+ *   // Define a view
+ *   const activeUsers = new DatabaseView('active_users', {
+ *       query: User.query().where('active', true).select('id', 'name', 'email'),
+ *       model: User,
+ *   });
+ *
+ *   // Create the view in the database
+ *   await activeUsers.create(db);
+ *
+ *   // Query the view
+ *   const users = await activeUsers.all();
+ *   const user = await activeUsers.findOne({ name: 'Alice' });
+ */
+
+const Model = require('./model');
+const Query = require('./query');
+const log = require('../debug')('zero:orm:views');
+
+// -- DatabaseView class -----------------------------------
+
+/**
+ * Represents a database view.
+ * Wraps a query definition and provides read-only access through a model-like API.
+ */
+class DatabaseView
+{
+    /**
+     * @constructor
+     * @param {string} name     - View name.
+     * @param {object} options  - View configuration.
+     * @param {Query}  [options.query]      - Query builder instance defining the view's SELECT.
+     * @param {string} [options.sql]        - Raw SQL for the view definition (SQL adapters only).
+     * @param {typeof Model} [options.model] - Model class the view is based on.
+     * @param {object} [options.schema]     - Column schema for the view (optional; inferred from model if omitted).
+     * @param {boolean} [options.materialized=false] - Whether to create a materialized view (PostgreSQL only).
+     */
+    constructor(name, options = {})
+    {
+        if (!name || typeof name !== 'string')
+        {
+            throw new Error('DatabaseView requires a non-empty string name');
+        }
+        if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name))
+        {
+            throw new Error(`Invalid view name: "${name}"`);
+        }
+
+        /** @type {string} View name. */
+        this.name = name;
+
+        /** @type {Query|null} Query builder defining the view. */
+        this._query = options.query || null;
+
+        /** @type {string|null} Raw SQL for view definition. */
+        this._sql = options.sql || null;
+
+        /** @type {typeof Model|null} Base model class. */
+        this._model = options.model || null;
+
+        /** @type {object|null} Column schema for the view. */
+        this._schema = options.schema || null;
+
+        /** @type {boolean} Whether this is a materialized view. */
+        this._materialized = options.materialized === true;
+
+        /** @type {object|null} The database adapter. */
+        this._adapter = null;
+
+        /** @type {typeof Model|null} The generated view model. */
+        this._viewModel = null;
+
+        if (!this._query && !this._sql)
+        {
+            throw new Error('DatabaseView requires either a query or sql option');
+        }
+    }
+
+    /**
+     * Create the view in the database.
+     * For SQL adapters, issues CREATE VIEW (or CREATE MATERIALIZED VIEW).
+     * For memory/JSON adapters, stores the query definition for execution.
+     *
+     * @param {object} db - Database instance.
+     * @returns {Promise<DatabaseView>} `this` for chaining.
+     *
+     * @example
+     *   await activeUsers.create(db);
+     */
+    async create(db)
+    {
+        this._adapter = db.adapter;
+
+        if (typeof this._adapter.createView === 'function')
+        {
+            const sql = this._sql || this._buildSQL();
+            await this._adapter.createView(this.name, sql, { materialized: this._materialized });
+        }
+
+        // Create the view-backed model
+        this._viewModel = this._createViewModel(db);
+
+        log.debug('view %s created', this.name);
+        return this;
+    }
+
+    /**
+     * Drop the view from the database.
+     *
+     * @param {object} db - Database instance.
+     * @returns {Promise<void>}
+     */
+    async drop(db)
+    {
+        const adapter = db ? db.adapter : this._adapter;
+        if (!adapter) throw new Error('No database adapter available');
+
+        if (typeof adapter.dropView === 'function')
+        {
+            await adapter.dropView(this.name, { materialized: this._materialized });
+        }
+
+        this._viewModel = null;
+        log.debug('view %s dropped', this.name);
+    }
+
+    /**
+     * Refresh a materialized view (PostgreSQL only).
+     *
+     * @param {object} [db] - Database instance.
+     * @returns {Promise<void>}
+     */
+    async refresh(db)
+    {
+        const adapter = db ? db.adapter : this._adapter;
+        if (!adapter) throw new Error('No database adapter available');
+
+        if (!this._materialized)
+        {
+            throw new Error('Only materialized views can be refreshed');
+        }
+
+        if (typeof adapter.refreshView === 'function')
+        {
+            await adapter.refreshView(this.name);
+        }
+
+        log.debug('view %s refreshed', this.name);
+    }
+
+    /**
+     * Check whether the view exists.
+     *
+     * @param {object} [db] - Database instance.
+     * @returns {Promise<boolean>} True if the view exists.
+     */
+    async exists(db)
+    {
+        const adapter = db ? db.adapter : this._adapter;
+        if (!adapter) throw new Error('No database adapter available');
+
+        if (typeof adapter.hasTable === 'function')
+        {
+            return adapter.hasTable(this.name);
+        }
+        return false;
+    }
+
+    /**
+     * Query all records from the view.
+     *
+     * @returns {Promise<Array>} All rows from the view.
+     */
+    async all()
+    {
+        return this._executeQuery();
+    }
+
+    /**
+     * Find records from the view matching conditions.
+     *
+     * @param {object} conditions - WHERE conditions.
+     * @returns {Promise<Array>} Matching rows.
+     */
+    async find(conditions = {})
+    {
+        return this._executeQuery(conditions);
+    }
+
+    /**
+     * Find a single record from the view.
+     *
+     * @param {object} conditions - WHERE conditions.
+     * @returns {Promise<object|null>} First matching row or null.
+     */
+    async findOne(conditions = {})
+    {
+        const results = await this._executeQuery(conditions, 1);
+        return results[0] || null;
+    }
+
+    /**
+     * Count records in the view.
+     *
+     * @param {object} [conditions={}] - Optional WHERE conditions.
+     * @returns {Promise<number>} Number of matching records.
+     */
+    async count(conditions = {})
+    {
+        if (this._viewModel)
+        {
+            return this._viewModel.count(conditions);
+        }
+        const results = await this._executeQuery(conditions);
+        return results.length;
+    }
+
+    /**
+     * Start a fluent query against the view.
+     *
+     * @returns {Query} Query builder targeting the view.
+     */
+    query()
+    {
+        if (this._viewModel)
+        {
+            return this._viewModel.query();
+        }
+        throw new Error('View model not created. Call create() first.');
+    }
+
+    /**
+     * Execute the view query with optional conditions.
+     * @param {object} [conditions={}] - WHERE conditions.
+     * @param {number} [limit] - Optional limit.
+     * @returns {Promise<Array>} Results.
+     * @private
+     */
+    async _executeQuery(conditions = {}, limit)
+    {
+        if (this._viewModel)
+        {
+            let q = this._viewModel.query().where(conditions);
+            if (limit) q = q.limit(limit);
+            return q.exec();
+        }
+
+        // Fallback: re-execute the source query with additional filters
+        if (this._query)
+        {
+            // Clone the query state
+            const src = this._query;
+            const model = src._model;
+            const q = model.query();
+            q._fields = src._fields;
+            q._where = [...src._where];
+            q._orderBy = [...src._orderBy];
+            q._limitVal = limit || src._limitVal;
+            q._offsetVal = src._offsetVal;
+
+            // Add additional conditions
+            if (Object.keys(conditions).length)
+            {
+                q.where(conditions);
+            }
+
+            return q.exec();
+        }
+
+        return [];
+    }
+
+    /**
+     * Build SQL from a Query descriptor.
+     * @returns {string} SQL SELECT statement.
+     * @private
+     */
+    _buildSQL()
+    {
+        if (this._sql) return this._sql;
+        if (!this._query) throw new Error('No query or SQL defined for view');
+
+        const descriptor = this._query.build();
+        const table = descriptor.table;
+
+        // Validate field names and table — identifier-safe only
+        const idRe = /^[a-zA-Z_][a-zA-Z0-9_.*]*$/;
+        const fields = descriptor.fields
+            ? descriptor.fields.filter(f => idRe.test(f)).join(', ') || '*'
+            : '*';
+        if (!idRe.test(table)) throw new Error(`Invalid table name in view query: "${table}"`);
+
+        let sql = `SELECT ${fields} FROM ${table}`;
+
+        if (descriptor.where && descriptor.where.length)
+        {
+            const clauses = descriptor.where.map(w =>
+            {
+                if (w.raw) return w.raw;
+                if (w.op === 'IS NULL') return `${w.field} IS NULL`;
+                if (w.op === 'IS NOT NULL') return `${w.field} IS NOT NULL`;
+                if (w.op === 'IN') return `${w.field} IN (${w.value.map(() => '?').join(',')})`;
+                // Escape single quotes in values for DDL safety
+                const escaped = String(w.value).replace(/'/g, "''");
+                return `${w.field} ${w.op} '${escaped}'`;
+            });
+            sql += ` WHERE ${clauses.join(' AND ')}`;
+        }
+
+        if (descriptor.orderBy && descriptor.orderBy.length)
+        {
+            const orders = descriptor.orderBy.map(o => `${o.field} ${o.dir}`);
+            sql += ` ORDER BY ${orders.join(', ')}`;
+        }
+
+        return sql;
+    }
+
+    /**
+     * Create an internal view-backed Model class.
+     * @param {object} db - Database instance.
+     * @returns {typeof Model} View model class.
+     * @private
+     */
+    _createViewModel(db)
+    {
+        const viewName = this.name;
+        const schema = this._schema || (this._model ? this._model.schema : {});
+        const ViewM = class extends Model
+        {
+            static table = viewName;
+            static schema = { ...schema };
+        };
+        Object.defineProperty(ViewM, 'name', { value: `${viewName}_view` });
+        db.register(ViewM);
+        return ViewM;
+    }
+}
+
+module.exports = { DatabaseView };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zero-server/orm",
-  "version": "0.9.1",
+  "version": "0.9.3",
   "description": "Database, Model, Query, migrations, seeds, search, geo, tenancy, audit.",
   "keywords": [
     "zero-server",
@@ -20,6 +20,8 @@
     "./package.json": "./package.json"
   },
   "files": [
+    "lib",
+    "types",
     "index.js",
     "index.d.ts",
     "README.md",
@@ -43,6 +45,14 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@zero-server/sdk": "0.9.1"
+    "@zero-server/errors": "0.9.3"
+  },
+  "peerDependencies": {
+    "@zero-server/sdk": ">=0.9.3"
+  },
+  "peerDependenciesMeta": {
+    "@zero-server/sdk": {
+      "optional": true
+    }
   }
 }

package/types/app.d.ts

@@ -0,0 +1,223 @@
+/// <reference types="node" />
+
+import { Server as HttpServer } from 'http';
+import { Server as HttpsServer, ServerOptions as TlsOptions } from 'https';
+import { Http2Server, Http2SecureServer } from 'http2';
+import { Request } from './request';
+import { Response } from './response';
+import { RouterInstance, RouteChain, RouteInfo, RouteOptions, RouteHandler } from './router';
+import { MiddlewareFunction, ErrorHandlerFunction, NextFunction } from './middleware';
+import { WebSocketHandler, WebSocketOptions, WebSocketPool } from './websocket';
+import { SSEStream } from './sse';
+import { LifecycleState } from './lifecycle';
+import { MetricsRegistry, HealthCheckResult } from './observe';
+import { ProtoSchema, GrpcServiceOptions, GrpcInterceptor, GrpcHandler } from './grpc';
+
+export interface ListenOptions {
+    /** Create an HTTP/2 server. Combined with TLS options for h2 over TLS, or h2c (cleartext) otherwise. */
+    http2?: boolean;
+    /** Allow HTTP/1.1 fallback on HTTP/2 TLS servers (ALPN negotiation). Default: true. */
+    allowHTTP1?: boolean;
+}
+
+export interface App {
+    /** Internal router instance. */
+    router: RouterInstance;
+    /** Middleware stack. */
+    middlewares: MiddlewareFunction[];
+    /** Application-level locals, merged into every request/response locals. */
+    locals: Record<string, any>;
+
+    /**
+     * Register middleware or mount a sub-router.
+     */
+    use(fn: MiddlewareFunction): App;
+    use(path: string, fn: MiddlewareFunction): App;
+    use(path: string, router: RouterInstance): App;
+
+    /**
+     * Register a global error handler.
+     */
+    onError(fn: ErrorHandlerFunction): void;
+
+    /**
+     * Core request handler for use with `http.createServer()`.
+     */
+    handler(req: import('http').IncomingMessage, res: import('http').ServerResponse): void;
+
+    /**
+     * Start listening for connections.
+     * Pass `{ http2: true }` to create an HTTP/2 server (h2c cleartext or TLS with ALPN).
+     */
+    listen(port?: number, cb?: () => void): HttpServer;
+    listen(port: number, opts: TlsOptions, cb?: () => void): HttpsServer;
+    listen(port: number, opts: ListenOptions & { http2: true } & TlsOptions, cb?: () => void): Http2SecureServer;
+    listen(port: number, opts: ListenOptions & { http2: true }, cb?: () => void): Http2Server;
+    listen(port: number, opts: ListenOptions, cb?: () => void): HttpServer | HttpsServer | Http2Server | Http2SecureServer;
+
+    /**
+     * Gracefully close the server.
+     */
+    close(cb?: (err?: Error) => void): void;
+
+    /**
+     * Perform a full graceful shutdown.
+     */
+    shutdown(opts?: { timeout?: number }): Promise<void>;
+
+    /**
+     * Register a lifecycle event listener.
+     */
+    on(event: 'beforeShutdown' | 'shutdown', fn: () => void | Promise<void>): App;
+
+    /**
+     * Remove a lifecycle event listener.
+     */
+    off(event: 'beforeShutdown' | 'shutdown', fn: () => void | Promise<void>): App;
+
+    /**
+     * Register a WebSocket pool for graceful shutdown.
+     */
+    registerPool(pool: WebSocketPool): App;
+
+    /**
+     * Unregister a WebSocket pool from lifecycle management.
+     */
+    unregisterPool(pool: WebSocketPool): App;
+
+    /**
+     * Track an SSE stream for graceful shutdown.
+     */
+    trackSSE(stream: SSEStream): App;
+
+    /**
+     * Register an ORM Database for graceful shutdown.
+     */
+    registerDatabase(db: { close(): Promise<void> }): App;
+
+    /**
+     * Unregister an ORM Database from lifecycle management.
+     */
+    unregisterDatabase(db: { close(): Promise<void> }): App;
+
+    /**
+     * Configure the shutdown timeout in milliseconds.
+     */
+    shutdownTimeout(ms: number): App;
+
+    /**
+     * Current lifecycle state.
+     */
+    readonly lifecycleState: LifecycleState;
+
+    /**
+     * Register a liveness health check endpoint.
+     */
+    health(path?: string, checks?: Record<string, () => HealthCheckResult | boolean | Promise<HealthCheckResult | boolean>>): App;
+    health(checks?: Record<string, () => HealthCheckResult | boolean | Promise<HealthCheckResult | boolean>>): App;
+
+    /**
+     * Register a readiness health check endpoint.
+     */
+    ready(path?: string, checks?: Record<string, () => HealthCheckResult | boolean | Promise<HealthCheckResult | boolean>>): App;
+    ready(checks?: Record<string, () => HealthCheckResult | boolean | Promise<HealthCheckResult | boolean>>): App;
+
+    /**
+     * Register a custom health check.
+     */
+    addHealthCheck(name: string, fn: () => HealthCheckResult | boolean | Promise<HealthCheckResult | boolean>): App;
+
+    /**
+     * Get the application metrics registry.
+     */
+    metrics(): MetricsRegistry;
+
+    /**
+     * Mount a Prometheus metrics endpoint.
+     */
+    metricsEndpoint(path?: string, opts?: { registry?: MetricsRegistry }): App;
+
+    /**
+     * Register a WebSocket upgrade handler.
+     */
+    ws(path: string, handler: WebSocketHandler): void;
+    ws(path: string, opts: WebSocketOptions, handler: WebSocketHandler): void;
+
+    /**
+     * Register a gRPC service with handlers.
+     */
+    grpc(schema: ProtoSchema, serviceName: string, handlers: Record<string, GrpcHandler>, opts?: GrpcServiceOptions): App;
+
+    /**
+     * Add a global gRPC interceptor.
+     */
+    grpcInterceptor(fn: GrpcInterceptor): App;
+
+    /**
+     * Return a flat list of all registered routes.
+     */
+    routes(): RouteInfo[];
+
+    /**
+     * Register a route with a specific HTTP method.
+     */
+    route(method: string, path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+
+    /**
+     * Get a setting value (1 arg) or set a setting value (2 args).
+     */
+    set(key: string): any;
+    set(key: string, val: any): App;
+
+    /**
+     * Get a setting value, or register a GET route.
+     * With 1 string arg: returns the setting value.
+     * With path + handlers: registers a GET route.
+     */
+    get(key: string): any;
+    get(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+
+    /**
+     * Enable a boolean setting (set to `true`).
+     */
+    enable(key: string): App;
+
+    /**
+     * Disable a boolean setting (set to `false`).
+     */
+    disable(key: string): App;
+
+    /**
+     * Check if a setting is truthy.
+     */
+    enabled(key: string): boolean;
+
+    /**
+     * Check if a setting is falsy.
+     */
+    disabled(key: string): boolean;
+
+    /**
+     * Register a parameter pre-processing handler.
+     */
+    param(name: string, fn: (req: Request, res: Response, next: NextFunction, value: string) => void): App;
+
+    /**
+     * Create a route group under a prefix with shared middleware.
+     */
+    group(prefix: string, ...args: [...MiddlewareFunction[], (router: RouterInstance) => void]): App;
+
+    /**
+     * Create a chainable route builder for the given path.
+     */
+    chain(path: string): RouteChain;
+
+    // HTTP method shortcuts
+    post(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    put(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    delete(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    patch(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    options(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    head(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+    all(path: string, ...handlers: (RouteOptions | RouteHandler)[]): App;
+}