npm - @objectql/server - Versions diffs - 1.3.1 → 1.5.0 - Mend

@objectql/server 1.3.1 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

package/CHANGELOG.md +31 -0
package/LICENSE +21 -0
package/dist/adapters/node.js +157 -23
package/dist/adapters/node.js.map +1 -1
package/dist/adapters/rest.d.ts +15 -0
package/dist/adapters/rest.js +252 -0
package/dist/adapters/rest.js.map +1 -0
package/dist/index.d.ts +2 -1
package/dist/index.js +3 -1
package/dist/index.js.map +1 -1
package/dist/metadata.d.ts +1 -1
package/dist/metadata.js +165 -38
package/dist/metadata.js.map +1 -1
package/dist/openapi.js +73 -24
package/dist/openapi.js.map +1 -1
package/dist/server.d.ts +8 -0
package/dist/server.js +75 -15
package/dist/server.js.map +1 -1
package/dist/studio.d.ts +5 -0
package/dist/{console.js → studio.js} +35 -23
package/dist/studio.js.map +1 -0
package/dist/types.d.ts +49 -1
package/dist/types.js +17 -0
package/dist/types.js.map +1 -1
package/package.json +7 -5
package/src/adapters/node.ts +166 -26
package/src/adapters/rest.ts +271 -0
package/src/index.ts +3 -1
package/src/metadata.ts +180 -38
package/src/openapi.ts +80 -32
package/src/server.ts +119 -16
package/src/{console.ts → studio.ts} +35 -22
package/src/types.ts +56 -2
package/test/rest.test.ts +164 -0
package/tsconfig.json +5 -1
package/tsconfig.tsbuildinfo +1 -1
package/dist/console.d.ts +0 -5
package/dist/console.js.map +0 -1

package/dist/{console.js → studio.js} RENAMED Viewed

@@ -33,37 +33,49 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createConsoleHandler = createConsoleHandler;
+exports.createStudioHandler = createStudioHandler;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 /**
- * Creates a handler to serve the console UI static files.
+ * Creates a handler to serve the Studio UI static files.
  */
-function createConsoleHandler() {
-    // Try to find the built console files
-    const possiblePaths = [
-        path.join(__dirname, '../../console/dist'),
-        path.join(process.cwd(), 'node_modules/@objectql/console/dist'),
-        path.join(process.cwd(), 'packages/console/dist'),
-    ];
+function createStudioHandler() {
     let distPath = null;
-    for (const p of possiblePaths) {
-        if (fs.existsSync(p)) {
-            distPath = p;
-            break;
+    // 1. Try to resolve from installed package (Standard way)
+    try {
+        const studioPkg = require.resolve('@objectql/studio/package.json');
+        const candidate = path.join(path.dirname(studioPkg), 'dist');
+        if (fs.existsSync(candidate)) {
+            distPath = candidate;
+        }
+    }
+    catch (e) {
+        // @objectql/studio might not be installed
+    }
+    // 2. Fallback for local development (Monorepo)
+    if (!distPath) {
+        const possiblePaths = [
+            path.join(__dirname, '../../studio/dist'),
+            path.join(process.cwd(), 'packages/studio/dist'),
+        ];
+        for (const p of possiblePaths) {
+            if (fs.existsSync(p)) {
+                distPath = p;
+                break;
+            }
         }
     }
     return async (req, res) => {
         if (!distPath) {
-            // Return placeholder page if console is not built
+            // Return placeholder page if studio is not built
             const html = getPlaceholderPage();
             res.setHeader('Content-Type', 'text/html');
             res.statusCode = 200;
             res.end(html);
             return;
         }
-        // Parse the URL and remove /console prefix
-        let urlPath = (req.url || '').replace(/^\/console/, '') || '/';
+        // Parse the URL and remove /studio prefix
+        let urlPath = (req.url || '').replace(/^\/studio/, '') || '/';
         // Default to index.html for SPA routing
         if (urlPath === '/' || !urlPath.includes('.')) {
             urlPath = '/index.html';
@@ -119,7 +131,7 @@ function getPlaceholderPage() {
 <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>ObjectQL Console</title>
+    <title>ObjectQL Studio</title>
     <style>
         * { margin: 0; padding: 0; box-sizing: border-box; }
         body {
@@ -155,19 +167,19 @@ function getPlaceholderPage() {
 </head>
 <body>
     <div class="container">
-        <h1>ObjectQL Console</h1>
-        <p>Web-based admin console for database management</p>
+        <h1>ObjectQL Studio</h1>
+        <p>Web-based admin studio for database management</p>
         <div class="info">
             <p style="margin-bottom: 1rem;">
-                The console is available but needs to be built separately.
+                The studio is available but needs to be built separately.
             </p>
             <p style="font-size: 1rem;">
-                To use the full console UI, run:<br>
-                <code>cd packages/console && pnpm run build</code>
+                To use the full studio UI, run:<br>
+                <code>cd packages/studio && pnpm run build</code>
             </p>
         </div>
     </div>
 </body>
 </html>`;
 }
-//# sourceMappingURL=console.js.map
+//# sourceMappingURL=studio.js.map

package/dist/studio.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"studio.js","sourceRoot":"","sources":["../src/studio.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,kDAkFC;AAxFD,uCAAyB;AACzB,2CAA6B;AAE7B;;GAEG;AACH,SAAgB,mBAAmB;IAC/B,IAAI,QAAQ,GAAkB,IAAI,CAAC;IAEnC,0DAA0D;IAC1D,IAAI,CAAC;QACD,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;QACnE,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC;QAC7D,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC3B,QAAQ,GAAG,SAAS,CAAC;QACzB,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,0CAA0C;IAC9C,CAAC;IAED,+CAA+C;IAC/C,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,MAAM,aAAa,GAAG;YAClB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC;YACzC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,sBAAsB,CAAC;SACnD,CAAC;QAEF,KAAK,MAAM,CAAC,IAAI,aAAa,EAAE,CAAC;YAC5B,IAAI,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnB,QAAQ,GAAG,CAAC,CAAC;gBACb,MAAM;YACV,CAAC;QACL,CAAC;IACL,CAAC;IAED,OAAO,KAAK,EAAE,GAAoB,EAAE,GAAmB,EAAE,EAAE;QACvD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,iDAAiD;YACjD,MAAM,IAAI,GAAG,kBAAkB,EAAE,CAAC;YAClC,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;YAC3C,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;YACrB,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACd,OAAO;QACX,CAAC;QAED,0CAA0C;QAC1C,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC;QAE9D,wCAAwC;QACxC,IAAI,OAAO,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5C,OAAO,GAAG,aAAa,CAAC;QAC5B,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAE9C,qDAAqD;QACrD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;YACrB,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QAED,uBAAuB;QACvB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,yDAAyD;YACzD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;YACpD,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC3B,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;gBAC3C,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;gBAC3C,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;gBACrB,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACjB,OAAO;YACX,CAAC;YAED,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;YACrB,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QAED,0BAA0B;QAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC1C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACnC,MAAM,WAAW,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QAExC,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QAC3C,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;QACrB,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC,CAAC;AACN,CAAC;AAED,SAAS,cAAc,CAAC,GAAW;IAC/B,MAAM,KAAK,GAA2B;QAClC,OAAO,EAAE,WAAW;QACpB,KAAK,EAAE,wBAAwB;QAC/B,MAAM,EAAE,UAAU;QAClB,OAAO,EAAE,kBAAkB;QAC3B,MAAM,EAAE,WAAW;QACnB,MAAM,EAAE,YAAY;QACpB,MAAM,EAAE,WAAW;QACnB,MAAM,EAAE,eAAe;QACvB,MAAM,EAAE,cAAc;KACzB,CAAC;IACF,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,0BAA0B,CAAC;AACpD,CAAC;AAED,SAAS,kBAAkB;IACvB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAsDH,CAAC;AACT,CAAC"}

package/dist/types.d.ts CHANGED Viewed

@@ -1,3 +1,29 @@
+/**
+ * Standardized error codes for ObjectQL API
+ */
+export declare enum ErrorCode {
+    INVALID_REQUEST = "INVALID_REQUEST",
+    VALIDATION_ERROR = "VALIDATION_ERROR",
+    UNAUTHORIZED = "UNAUTHORIZED",
+    FORBIDDEN = "FORBIDDEN",
+    NOT_FOUND = "NOT_FOUND",
+    CONFLICT = "CONFLICT",
+    INTERNAL_ERROR = "INTERNAL_ERROR",
+    DATABASE_ERROR = "DATABASE_ERROR",
+    RATE_LIMIT_EXCEEDED = "RATE_LIMIT_EXCEEDED"
+}
+/**
+ * AI context for better logging, debugging, and AI processing
+ */
+export interface AIContext {
+    intent?: string;
+    natural_language?: string;
+    use_case?: string;
+    [key: string]: unknown;
+}
+/**
+ * ObjectQL JSON-RPC style request
+ */
 export interface ObjectQLRequest {
     user?: {
         id: string;
@@ -7,11 +33,33 @@ export interface ObjectQLRequest {
     op: 'find' | 'findOne' | 'create' | 'update' | 'delete' | 'count' | 'action';
     object: string;
     args: any;
+    ai_context?: AIContext;
 }
+/**
+ * Error details structure
+ */
+export interface ErrorDetails {
+    field?: string;
+    reason?: string;
+    fields?: Record<string, string>;
+    required_permission?: string;
+    user_roles?: string[];
+    retry_after?: number;
+    [key: string]: unknown;
+}
+/**
+ * ObjectQL API response
+ */
 export interface ObjectQLResponse {
     data?: any;
     error?: {
-        code: string;
+        code: ErrorCode | string;
         message: string;
+        details?: ErrorDetails;
+    };
+    meta?: {
+        total?: number;
+        page?: number;
+        per_page?: number;
     };
 }

package/dist/types.js CHANGED Viewed

@@ -1,3 +1,20 @@
 "use strict";
+// src/types.ts
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorCode = void 0;
+/**
+ * Standardized error codes for ObjectQL API
+ */
+var ErrorCode;
+(function (ErrorCode) {
+    ErrorCode["INVALID_REQUEST"] = "INVALID_REQUEST";
+    ErrorCode["VALIDATION_ERROR"] = "VALIDATION_ERROR";
+    ErrorCode["UNAUTHORIZED"] = "UNAUTHORIZED";
+    ErrorCode["FORBIDDEN"] = "FORBIDDEN";
+    ErrorCode["NOT_FOUND"] = "NOT_FOUND";
+    ErrorCode["CONFLICT"] = "CONFLICT";
+    ErrorCode["INTERNAL_ERROR"] = "INTERNAL_ERROR";
+    ErrorCode["DATABASE_ERROR"] = "DATABASE_ERROR";
+    ErrorCode["RATE_LIMIT_EXCEEDED"] = "RATE_LIMIT_EXCEEDED";
+})(ErrorCode || (exports.ErrorCode = ErrorCode = {}));
 //# sourceMappingURL=types.js.map

package/dist/types.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
1	+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,eAAe;;;AAEf;;GAEG;AACH,IAAY,SAUX;AAVD,WAAY,SAAS;IACjB,gDAAmC,CAAA;IACnC,kDAAqC,CAAA;IACrC,0CAA6B,CAAA;IAC7B,oCAAuB,CAAA;IACvB,oCAAuB,CAAA;IACvB,kCAAqB,CAAA;IACrB,8CAAiC,CAAA;IACjC,8CAAiC,CAAA;IACjC,wDAA2C,CAAA;AAC/C,CAAC,EAVW,SAAS,yBAAT,SAAS,QAUpB"}

package/package.json CHANGED Viewed

@@ -1,16 +1,18 @@
 {
   "name": "@objectql/server",
-  "version": "1.3.1",
+  "version": "1.5.0",
   "description": "HTTP Server Adapter for ObjectQL",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@objectql/core": "1.3.1",
-    "@objectql/types": "1.3.1"
+    "js-yaml": "^4.1.1",
+    "@objectql/core": "1.5.0",
+    "@objectql/types": "1.5.0"
   },
   "devDependencies": {
-    "typescript": "^5.3.0",
-    "@types/node": "^20.10.0"
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^20.10.0",
+    "typescript": "^5.3.0"
   },
   "scripts": {
     "build": "tsc",

package/src/adapters/node.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 import { IObjectQL } from '@objectql/types';
 import { ObjectQLServer } from '../server';
-import { ObjectQLRequest } from '../types';
+import { ObjectQLRequest, ErrorCode } from '../types';
 import { IncomingMessage, ServerResponse } from 'http';
 import { generateOpenAPI } from '../openapi';
@@ -21,50 +21,190 @@ export function createNodeHandler(app: IObjectQL) {
             return;
         }
-        if (req.method !== 'POST') {
-            res.statusCode = 405;
-            res.end('Method Not Allowed');
-            return;
-        }
         const handleRequest = async (json: any) => {
              try {
-                // TODO: Parse user from header or request override
+                // Determine Operation based on JSON or previously derived info
                 const qlReq: ObjectQLRequest = {
                     op: json.op,
                     object: json.object,
                     args: json.args,
-                    user: json.user // For dev/testing, allowing user injection
+                    user: json.user,
+                    ai_context: json.ai_context
                 };
                 const result = await server.handle(qlReq);
+                // Determine HTTP status code based on error
+                let statusCode = 200;
+                if (result.error) {
+                    switch (result.error.code) {
+                        case ErrorCode.INVALID_REQUEST:
+                        case ErrorCode.VALIDATION_ERROR:
+                            statusCode = 400;
+                            break;
+                        case ErrorCode.UNAUTHORIZED:
+                            statusCode = 401;
+                            break;
+                        case ErrorCode.FORBIDDEN:
+                            statusCode = 403;
+                            break;
+                        case ErrorCode.NOT_FOUND:
+                            statusCode = 404;
+                            break;
+                        case ErrorCode.CONFLICT:
+                            statusCode = 409;
+                            break;
+                        case ErrorCode.RATE_LIMIT_EXCEEDED:
+                            statusCode = 429;
+                            break;
+                        default:
+                            statusCode = 500;
+                    }
+                }
                 res.setHeader('Content-Type', 'application/json');
-                res.statusCode = result.error ? 500 : 200;
+                res.statusCode = statusCode;
                 res.end(JSON.stringify(result));
             } catch (e) {
+                console.error(e);
                 res.statusCode = 500;
-                res.end(JSON.stringify({ error: { code: 'INTERNAL_ERROR', message: 'Internal Server Error' }}));
+                res.end(JSON.stringify({
+                    error: {
+                        code: ErrorCode.INTERNAL_ERROR,
+                        message: 'Internal Server Error'
+                    }
+                }));
             }
         };
-        // 1. Check if body is already parsed (e.g. by express.json())
-        if (req.body && typeof req.body === 'object') {
-            await handleRequest(req.body);
-            return;
+        // Parse URL
+        const urlObj = new URL(req.url || '/', `http://${req.headers.host || 'localhost'}`);
+        const pathName = urlObj.pathname;
+        const method = req.method;
+        // 1. JSON-RPC: POST /api/objectql
+        if (pathName === '/api/objectql' && method === 'POST') {
+             await processBody(req, async (json) => {
+                 await handleRequest(json);
+             }, res);
+             return;
         }
-        // 2. Parse Body from stream
-        let body = '';
-        req.on('data', chunk => body += chunk);
-        req.on('end', async () => {
-            try {
-                const json = JSON.parse(body);
-                await handleRequest(json);
-            } catch (e) {
-                res.statusCode = 400;
-                res.end('Invalid JSON');
+        // 2. REST API: /api/data/:object and /api/data/:object/:id
+        // Regex to match /api/data/objectName(/id)?
+        const restMatch = pathName.match(/^\/api\/data\/([^/]+)(?:\/(.+))?$/);
+        if (restMatch) {
+            const objectName = restMatch[1];
+            const id = restMatch[2];
+            const query = Object.fromEntries(urlObj.searchParams.entries());
+            if (method === 'GET') {
+                // GET /api/data/:object/:id -> findOne
+                if (id) {
+                    await handleRequest({
+                        op: 'findOne',
+                        object: objectName,
+                        args: { filters: [['_id', '=', id]] } // Assuming _id or id mapping
+                    });
+                }
+                // GET /api/data/:object -> find (List)
+                else {
+                    // Parse standard params
+                    const args: any = {};
+                    if (query.fields) args.fields = (query.fields as string).split(',');
+                    if (query.top) args.limit = parseInt(query.top as string);
+                    if (query.skip) args.skip = parseInt(query.skip as string);
+                    if (query.filter) {
+                        try {
+                            args.filters = JSON.parse(query.filter as string);
+                        } catch (e) {
+                            // ignore invalid filter json
+                        }
+                    }
+                    await handleRequest({ op: 'find', object: objectName, args });
+                }
+                return;
+            }
+            if (method === 'POST' && !id) {
+                // POST /api/data/:object -> create
+                await processBody(req, async (body) => {
+                    await handleRequest({
+                        op: 'create',
+                        object: objectName,
+                        args: body.data || body // Support enclosed in data or flat
+                    });
+                }, res);
+                return;
+            }
+            if (method === 'PATCH' && id) {
+                // PATCH /api/data/:object/:id -> update
+                await processBody(req, async (body) => {
+                    await handleRequest({
+                        op: 'update',
+                        object: objectName,
+                        args: {
+                            id: id,
+                            data: body.data || body
+                        }
+                    });
+                }, res);
+                return;
             }
-        });
+            if (method === 'DELETE' && id) {
+                // DELETE /api/data/:object/:id -> delete
+                await handleRequest({
+                    op: 'delete',
+                    object: objectName,
+                    args: { id: id }
+                });
+                return;
+            }
+        }
+        // Fallback or 404
+        if (req.method === 'POST') {
+             // Fallback for root POSTs if people forget /api/objectql but send to /api something
+             await processBody(req, handleRequest, res);
+             return;
+        }
+        // Special case for root: since we accept POST / (RPC), correct response for GET / is 405
+        if (pathName === '/') {
+            res.setHeader('Allow', 'POST');
+            res.statusCode = 405;
+            res.end(JSON.stringify({ error: { code: ErrorCode.INVALID_REQUEST, message: 'Method Not Allowed. Use POST for JSON-RPC.' } }));
+            return;
+        }
+        res.statusCode = 404;
+        res.end(JSON.stringify({ error: { code: ErrorCode.NOT_FOUND, message: 'Not Found' } }));
     };
 }
+// Helper to process body
+async function processBody(req: IncomingMessage & { body?: any }, callback: (json: any) => Promise<void>, res: ServerResponse) {
+    if (req.body && typeof req.body === 'object') {
+        return callback(req.body);
+    }
+    let body = '';
+    req.on('data', chunk => body += chunk);
+    req.on('end', async () => {
+        try {
+            const json = body ? JSON.parse(body) : {};
+            await callback(json);
+        } catch (e) {
+            res.statusCode = 400;
+            res.end(JSON.stringify({
+                error: {
+                    code: 'INVALID_JSON',
+                    message: 'Invalid JSON body'
+                }
+            }));
+        }
+    });
+}