@objectql/api 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @objectql/api
+
+## 1.0.0
+
+### Major Changes
+
+- first release
+
+### Patch Changes
+
+- Updated dependencies
+  - @objectql/core@1.0.0

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { Router, Request, Response } from 'express';
+import { IObjectQL, ObjectQLContext } from '@objectql/core';
+export interface ObjectQLServerOptions {
+    objectql: IObjectQL;
+    getContext?: (req: Request, res: Response) => Promise<ObjectQLContext> | ObjectQLContext;
+    swagger?: {
+        enabled: boolean;
+        path?: string;
+    };
+}
+export declare function createObjectQLRouter(options: ObjectQLServerOptions): Router;

package/dist/index.js

@@ -0,0 +1,278 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createObjectQLRouter = createObjectQLRouter;
+const express_1 = require("express");
+const swagger_ui_express_1 = __importDefault(require("swagger-ui-express"));
+const generator_1 = require("./swagger/generator");
+function createObjectQLRouter(options) {
+    const router = (0, express_1.Router)();
+    const { objectql, getContext, swagger } = options;
+    if (swagger && swagger.enabled) {
+        const docPath = swagger.path || '/docs';
+        const spec = (0, generator_1.generateOpenApiSpec)(objectql);
+        router.use(docPath, swagger_ui_express_1.default.serve, swagger_ui_express_1.default.setup(spec));
+        console.log(`Swagger UI available at ${docPath}`);
+    }
+    const getCtx = async (req, res) => {
+        if (getContext) {
+            return await getContext(req, res);
+        }
+        return {
+            roles: [],
+            object: (name) => { throw new Error("Not implemented in default context stub"); },
+            transaction: async (cb) => cb({}),
+            sudo: () => ({})
+        };
+    };
+    const getRepo = async (req, res, objectName) => {
+        const ctx = await getCtx(req, res);
+        return ctx.object(objectName);
+    };
+    // Helper: Parse UnifiedQuery from Request
+    const parseQuery = (req) => {
+        const query = {};
+        const q = req.query;
+        // 1. Fields
+        if (q.fields) {
+            if (typeof q.fields === 'string') {
+                query.fields = q.fields.split(',');
+            }
+        }
+        // 2. Filters
+        if (q.filters) {
+            try {
+                if (typeof q.filters === 'string') {
+                    query.filters = JSON.parse(q.filters);
+                }
+            }
+            catch (e) {
+                throw new Error("Invalid filters JSON");
+            }
+        }
+        // 3. Sort
+        // Format: ?sort=item1:asc,item2:desc  OR  ?sort=[["item1","asc"]]
+        if (q.sort) {
+            if (typeof q.sort === 'string') {
+                // Check if JSON
+                if (q.sort.startsWith('[')) {
+                    try {
+                        query.sort = JSON.parse(q.sort);
+                    }
+                    catch { }
+                }
+                else {
+                    // split by comma
+                    query.sort = q.sort.split(',').map(part => {
+                        const [field, order] = part.split(':');
+                        return [field, (order || 'asc').toLowerCase() === 'desc' ? 'desc' : 'asc'];
+                    });
+                }
+            }
+        }
+        // 4. Pagination
+        if (q.top || q.limit) {
+            query.limit = parseInt((q.top || q.limit));
+        }
+        if (q.skip || q.offset) {
+            query.skip = parseInt((q.skip || q.offset));
+        }
+        // 5. Expand
+        // ?expand=items,details  OR ?expand={"items":{"fields":["name"]}}
+        if (q.expand) {
+            if (typeof q.expand === 'string') {
+                if (q.expand.startsWith('{')) {
+                    try {
+                        query.expand = JSON.parse(q.expand);
+                    }
+                    catch { }
+                }
+                else {
+                    query.expand = {};
+                    q.expand.split(',').forEach(field => {
+                        // Simple expand implies selecting all or default fields
+                        // UnifiedQuery expects sub-query
+                        query.expand[field] = {};
+                    });
+                }
+            }
+        }
+        return query;
+    };
+    // === Special Endpoints (Must come before /:objectName) ===
+    router.get('/_schema', async (req, res) => {
+        try {
+            const configs = objectql.getConfigs();
+            res.json(configs);
+        }
+        catch (e) {
+            res.status(500).json({ error: e.message });
+        }
+    });
+    // NONE for now, as :objectName is the root.
+    // However, we might want /:objectName/count or /:objectName/aggregate.
+    // === Collection Routes ===
+    // count
+    router.get('/:objectName/count', async (req, res) => {
+        try {
+            const { objectName } = req.params;
+            const repo = await getRepo(req, res, objectName);
+            let filters = undefined;
+            if (req.query.filters) {
+                try {
+                    filters = JSON.parse(req.query.filters);
+                }
+                catch {
+                    return res.status(400).json({ error: "Invalid filters JSON" });
+                }
+            }
+            const count = await repo.count(filters);
+            res.json({ count });
+        }
+        catch (e) {
+            res.status(500).json({ error: e.message });
+        }
+    });
+    // aggregate
+    router.post('/:objectName/aggregate', async (req, res) => {
+        try {
+            const { objectName } = req.params;
+            const repo = await getRepo(req, res, objectName);
+            const pipeline = req.body;
+            if (!Array.isArray(pipeline)) {
+                return res.status(400).json({ error: "Pipeline must be an array" });
+            }
+            const result = await repo.aggregate(pipeline);
+            res.json(result);
+        }
+        catch (e) {
+            res.status(500).json({ error: e.message });
+        }
+    });
+    // delete many
+    router.delete('/:objectName', async (req, res) => {
+        try {
+            const { objectName } = req.params;
+            if (!req.query.filters) {
+                return res.status(400).json({ error: "filters parameter is required for bulk delete" });
+            }
+            const repo = await getRepo(req, res, objectName);
+            let filters;
+            try {
+                filters = JSON.parse(req.query.filters);
+            }
+            catch {
+                return res.status(400).json({ error: "Invalid filters JSON" });
+            }
+            const result = await repo.deleteMany(filters);
+            res.json(result);
+        }
+        catch (e) {
+            res.status(500).json({ error: e.message });
+        }
+    });
+    // list
+    router.get('/:objectName', async (req, res) => {
+        try {
+            const { objectName } = req.params;
+            const repo = await getRepo(req, res, objectName);
+            const query = parseQuery(req);
+            const results = await repo.find(query);
+            res.json(results);
+        }
+        catch (e) {
+            res.status(500).json({ error: e.message });
+        }
+    });
+    // create (one or many)
+    router.post('/:objectName', async (req, res) => {
+        try {
+            const { objectName } = req.params;
+            const repo = await getRepo(req, res, objectName);
+            if (Array.isArray(req.body)) {
+                const results = await repo.createMany(req.body);
+                res.status(201).json(results);
+            }
+            else {
+                const result = await repo.create(req.body);
+                res.status(201).json(result);
+            }
+        }
+        catch (e) {
+            res.status(500).json({ error: e.message });
+        }
+    });
+    // === Item Routes ===
+    // run action
+    router.post('/:objectName/:id/:actionName', async (req, res) => {
+        try {
+            const { objectName, id, actionName } = req.params;
+            const repo = await getRepo(req, res, objectName);
+            // Params merging body and id? Usually action needs specific params.
+            // Let's pass body as params.
+            const params = {
+                id,
+                ...req.body
+            };
+            const result = await repo.call(actionName, params);
+            res.json(result);
+        }
+        catch (e) {
+            res.status(500).json({ error: e.message });
+        }
+    });
+    router.get('/:objectName/:id', async (req, res) => {
+        try {
+            const { objectName, id } = req.params;
+            const repo = await getRepo(req, res, objectName);
+            // Allow expand here too?
+            // findOne takes id or query.
+            // If expand is needed, we should construct a query with filters: {_id: id}
+            if (req.query.expand || req.query.fields) {
+                const query = parseQuery(req);
+                // Force filter by ID
+                // Note: normalized ID vs string ID.
+                query.filters = [['_id', '=', id]]; // or 'id' depending on driver
+                const results = await repo.find(query);
+                if (!results.length) {
+                    return res.status(404).json({ error: "Not found" });
+                }
+                return res.json(results[0]);
+            }
+            const result = await repo.findOne(id);
+            if (!result) {
+                return res.status(404).json({ error: "Not found" });
+            }
+            res.json(result);
+        }
+        catch (e) {
+            res.status(500).json({ error: e.message });
+        }
+    });
+    router.put('/:objectName/:id', async (req, res) => {
+        try {
+            const { objectName, id } = req.params;
+            const repo = await getRepo(req, res, objectName);
+            const result = await repo.update(id, req.body);
+            res.json(result);
+        }
+        catch (e) {
+            res.status(500).json({ error: e.message });
+        }
+    });
+    router.delete('/:objectName/:id', async (req, res) => {
+        try {
+            const { objectName, id } = req.params;
+            const repo = await getRepo(req, res, objectName);
+            await repo.delete(id);
+            res.status(204).send();
+        }
+        catch (e) {
+            res.status(500).json({ error: e.message });
+        }
+    });
+    return router;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAeA,oDAsRC;AArSD,qCAAkE;AAGlE,4EAA2C;AAC3C,mDAA0D;AAW1D,SAAgB,oBAAoB,CAAC,OAA8B;IAC/D,MAAM,MAAM,GAAG,IAAA,gBAAM,GAAE,CAAC;IACxB,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAElD,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC;QACxC,MAAM,IAAI,GAAG,IAAA,+BAAmB,EAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,4BAAS,CAAC,KAAK,EAAE,4BAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,OAAO,CAAC,GAAG,CAAC,2BAA2B,OAAO,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,MAAM,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAA4B,EAAE;QAC3E,IAAI,UAAU,EAAE,CAAC;YACb,OAAO,MAAM,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtC,CAAC;QACD,OAAO;YACH,KAAK,EAAE,EAAE;YACT,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC,CAAC,CAAC;YACzF,WAAW,EAAE,KAAK,EAAE,EAAO,EAAE,EAAE,CAAC,EAAE,CAAC,EAAS,CAAC;YAC7C,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,EAAU,CAAA;SACI,CAAC;IACpC,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,UAAkB,EAAE,EAAE;QACtE,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACnC,OAAO,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC,CAAC;IAEF,0CAA0C;IAC1C,MAAM,UAAU,GAAG,CAAC,GAAY,EAAgB,EAAE;QAC9C,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC;QAEpB,YAAY;QACZ,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;YACX,IAAI,OAAO,CAAC,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACvC,CAAC;QACL,CAAC;QAED,aAAa;QACb,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC;gBACD,IAAI,OAAO,CAAC,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;oBAChC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBAC1C,CAAC;YACL,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAC5C,CAAC;QACL,CAAC;QAED,UAAU;QACV,kEAAkE;QAClE,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;YACT,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,gBAAgB;gBAChB,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBACzB,IAAI,CAAC;wBACD,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;oBACpC,CAAC;oBAAC,MAAM,CAAC,CAAA,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACJ,iBAAiB;oBACjB,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;wBACtC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBACvC,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,KAAK,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;oBAC/E,CAAC,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;QACL,CAAC;QAED,gBAAgB;QAChB,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;YACnB,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAW,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,CAAW,CAAC,CAAC;QAC1D,CAAC;QAED,YAAY;QACZ,kEAAkE;QAClE,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;YACX,IAAI,OAAO,CAAC,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC3B,IAAI,CAAC;wBACD,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;oBACxC,CAAC;oBAAC,MAAM,CAAC,CAAA,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACJ,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;oBAClB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;wBAChC,wDAAwD;wBACxD,iCAAiC;wBACjC,KAAK,CAAC,MAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;oBAC9B,CAAC,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;QACL,CAAC;QAED,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;IAEF,4DAA4D;IAE5D,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACzD,IAAI,CAAC;YACD,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,EAAE,CAAC;YACtC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACb,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAChD,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,4CAA4C;IAC5C,uEAAuE;IAGvE,4BAA4B;IAE5B,QAAQ;IACR,MAAM,CAAC,GAAG,CAAC,oBAAoB,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACnE,IAAI,CAAC;YACD,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;YAClC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YACjD,IAAI,OAAO,GAAG,SAAS,CAAC;YACxB,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACpB,IAAI,CAAC;oBACD,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAiB,CAAC,CAAC;gBACtD,CAAC;gBAAC,MAAM,CAAC;oBACL,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC,CAAC;gBACnE,CAAC;YACL,CAAC;YACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACxC,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QACxB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACb,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAChD,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,YAAY;IACZ,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACxE,IAAI,CAAC;YACD,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;YAClC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YACjD,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3B,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,2BAA2B,EAAE,CAAC,CAAC;YACxE,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC9C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACb,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAChD,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,cAAc;IACd,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QAChE,IAAI,CAAC;YACD,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;YAClC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACrB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,+CAA+C,EAAE,CAAC,CAAC;YAC5F,CAAC;YACD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YACjD,IAAI,OAAO,CAAC;YACX,IAAI,CAAC;gBACF,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAiB,CAAC,CAAC;YACtD,CAAC;YAAC,MAAM,CAAC;gBACL,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC,CAAC;YACnE,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAC9C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACb,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAChD,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO;IACP,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QAC7D,IAAI,CAAC;YACD,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;YAClC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YACjD,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/C,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,uBAAuB;IACvB,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QAC9D,IAAI,CAAC;YACD,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;YAClC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YACjD,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAChD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC3C,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACjC,CAAC;QACL,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/C,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,sBAAsB;IAEtB,aAAa;IACb,MAAM,CAAC,IAAI,CAAC,8BAA8B,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QAC7E,IAAI,CAAC;YACF,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;YAClD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YACjD,oEAAoE;YACpE,6BAA6B;YAC7B,MAAM,MAAM,GAAG;gBACX,EAAE;gBACF,GAAG,GAAG,CAAC,IAAI;aACd,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YACnD,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/C,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,GAAG,CAAC,kBAAkB,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACjE,IAAI,CAAC;YACD,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;YACtC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YAEjD,yBAAyB;YACzB,6BAA6B;YAC7B,2EAA2E;YAE3E,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;gBACvC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;gBAC9B,qBAAqB;gBACrB,oCAAoC;gBACpC,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,8BAA8B;gBAClE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;oBAClB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;gBACxD,CAAC;gBACD,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAChC,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACV,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;YACxD,CAAC;YACD,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/C,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,GAAG,CAAC,kBAAkB,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACjE,IAAI,CAAC;YACD,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;YACtC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YACjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/C,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACpE,IAAI,CAAC;YACD,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;YACtC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;YACjD,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACtB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/C,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAClB,CAAC"}

package/dist/swagger/generator.d.ts

@@ -0,0 +1,12 @@
+import { IObjectQL } from '@objectql/core';
+export declare function generateOpenApiSpec(objectql: IObjectQL): {
+    openapi: string;
+    info: {
+        title: string;
+        version: string;
+    };
+    paths: any;
+    components: {
+        schemas: any;
+    };
+};

package/dist/swagger/generator.js

@@ -0,0 +1,163 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateOpenApiSpec = generateOpenApiSpec;
+function generateOpenApiSpec(objectql) {
+    const configs = objectql.getConfigs();
+    const paths = {};
+    const schemas = {};
+    Object.values(configs).forEach((config) => {
+        const objectName = config.name;
+        const schemaName = objectName;
+        // 1. Define Schema
+        schemas[schemaName] = {
+            type: 'object',
+            properties: mapFieldsToProperties(config.fields)
+        };
+        // 2. Define Paths
+        const basePath = `/api/${objectName}`;
+        // GET /api/{obj} - List
+        paths[basePath] = {
+            get: {
+                summary: `List ${config.label || objectName}`,
+                tags: [config.label || objectName],
+                parameters: [
+                    {
+                        name: 'fields',
+                        in: 'query',
+                        description: 'Comma separated fields to return',
+                        schema: { type: 'string' }
+                    },
+                    {
+                        name: 'filters',
+                        in: 'query',
+                        description: 'JSON string of filters',
+                        schema: { type: 'string' }
+                    },
+                ],
+                responses: {
+                    200: {
+                        description: 'Success',
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    type: 'array',
+                                    items: { $ref: `#/components/schemas/${schemaName}` }
+                                }
+                            }
+                        }
+                    }
+                }
+            },
+            // POST /api/{obj} - Create
+            post: {
+                summary: `Create ${config.label || objectName}`,
+                tags: [config.label || objectName],
+                requestBody: {
+                    required: true,
+                    content: {
+                        'application/json': {
+                            schema: { $ref: `#/components/schemas/${schemaName}` }
+                        }
+                    }
+                },
+                responses: {
+                    201: {
+                        description: 'Created',
+                        content: {
+                            'application/json': {
+                                schema: { $ref: `#/components/schemas/${schemaName}` }
+                            }
+                        }
+                    }
+                }
+            }
+        };
+        // /{id} operations
+        const itemPath = `${basePath}/{id}`;
+        paths[itemPath] = {
+            // GET - Retrieve
+            get: {
+                summary: `Get ${config.label || objectName}`,
+                tags: [config.label || objectName],
+                parameters: [{ name: 'id', in: 'path', required: true, schema: { type: 'string' } }],
+                responses: {
+                    200: {
+                        description: 'Success',
+                        content: {
+                            'application/json': {
+                                schema: { $ref: `#/components/schemas/${schemaName}` }
+                            }
+                        }
+                    }
+                }
+            },
+            // PUT - Update
+            put: {
+                summary: `Update ${config.label || objectName}`,
+                tags: [config.label || objectName],
+                parameters: [{ name: 'id', in: 'path', required: true, schema: { type: 'string' } }],
+                requestBody: {
+                    required: true,
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'object',
+                                properties: mapFieldsToProperties(config.fields)
+                            }
+                        }
+                    }
+                },
+                responses: {
+                    200: { description: 'Updated' }
+                }
+            },
+            // DELETE
+            delete: {
+                summary: `Delete ${config.label || objectName}`,
+                tags: [config.label || objectName],
+                parameters: [{ name: 'id', in: 'path', required: true, schema: { type: 'string' } }],
+                responses: {
+                    200: { description: 'Deleted' }
+                }
+            }
+        };
+    });
+    return {
+        openapi: '3.0.0',
+        info: {
+            title: 'ObjectQL API',
+            version: '1.0.0',
+        },
+        paths,
+        components: {
+            schemas
+        }
+    };
+}
+function mapFieldsToProperties(fields) {
+    const props = {};
+    Object.entries(fields).forEach(([key, field]) => {
+        props[key] = {
+            type: mapType(field.type),
+            description: field.label
+        };
+    });
+    // Add _id
+    props['_id'] = { type: 'string' };
+    return props;
+}
+function mapType(objectType) {
+    switch (objectType) {
+        case 'number':
+        case 'currency':
+            return 'number';
+        case 'boolean':
+            return 'boolean';
+        case 'date':
+        case 'datetime':
+            return 'string'; // format: date-time ideally
+        default:
+            return 'string';
+    }
+}
+//# sourceMappingURL=generator.js.map

package/dist/swagger/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../src/swagger/generator.ts"],"names":[],"mappings":";;AAEA,kDA4IC;AA5ID,SAAgB,mBAAmB,CAAC,QAAmB;IACrD,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,EAAE,CAAC;IAEtC,MAAM,KAAK,GAAQ,EAAE,CAAC;IACtB,MAAM,OAAO,GAAQ,EAAE,CAAC;IAExB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACxC,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;QAC/B,MAAM,UAAU,GAAG,UAAU,CAAC;QAE9B,mBAAmB;QACnB,OAAO,CAAC,UAAU,CAAC,GAAG;YACpB,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,qBAAqB,CAAC,MAAM,CAAC,MAAM,CAAC;SACjD,CAAC;QAEF,kBAAkB;QAClB,MAAM,QAAQ,GAAG,QAAQ,UAAU,EAAE,CAAC;QAEtC,wBAAwB;QACxB,KAAK,CAAC,QAAQ,CAAC,GAAG;YAChB,GAAG,EAAE;gBACH,OAAO,EAAE,QAAQ,MAAM,CAAC,KAAK,IAAI,UAAU,EAAE;gBAC7C,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,IAAI,UAAU,CAAC;gBAClC,UAAU,EAAE;oBACV;wBACE,IAAI,EAAE,QAAQ;wBACd,EAAE,EAAE,OAAO;wBACX,WAAW,EAAE,kCAAkC;wBAC/C,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;qBAC3B;oBACD;wBACE,IAAI,EAAE,SAAS;wBACf,EAAE,EAAE,OAAO;wBACX,WAAW,EAAE,wBAAwB;wBACrC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;qBAC3B;iBACF;gBACD,SAAS,EAAE;oBACT,GAAG,EAAE;wBACH,WAAW,EAAE,SAAS;wBACtB,OAAO,EAAE;4BACP,kBAAkB,EAAE;gCAClB,MAAM,EAAE;oCACN,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE,EAAE,IAAI,EAAE,wBAAwB,UAAU,EAAE,EAAE;iCACtD;6BACF;yBACF;qBACF;iBACF;aACF;YACD,2BAA2B;YAC3B,IAAI,EAAE;gBACJ,OAAO,EAAE,UAAU,MAAM,CAAC,KAAK,IAAI,UAAU,EAAE;gBAC/C,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,IAAI,UAAU,CAAC;gBAClC,WAAW,EAAE;oBACX,QAAQ,EAAE,IAAI;oBACd,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE,EAAE,IAAI,EAAE,wBAAwB,UAAU,EAAE,EAAE;yBACvD;qBACF;iBACF;gBACD,SAAS,EAAE;oBACT,GAAG,EAAE;wBACH,WAAW,EAAE,SAAS;wBACtB,OAAO,EAAE;4BACP,kBAAkB,EAAE;gCACjB,MAAM,EAAE,EAAE,IAAI,EAAE,wBAAwB,UAAU,EAAE,EAAE;6BACxD;yBACF;qBACF;iBACF;aACF;SACF,CAAC;QAEF,mBAAmB;QACnB,MAAM,QAAQ,GAAG,GAAG,QAAQ,OAAO,CAAC;QACpC,KAAK,CAAC,QAAQ,CAAC,GAAG;YAChB,iBAAiB;YACjB,GAAG,EAAE;gBACH,OAAO,EAAE,OAAO,MAAM,CAAC,KAAK,IAAI,UAAU,EAAE;gBAC5C,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,IAAI,UAAU,CAAC;gBAClC,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC;gBACpF,SAAS,EAAE;oBACT,GAAG,EAAE;wBACH,WAAW,EAAE,SAAS;wBACtB,OAAO,EAAE;4BACL,kBAAkB,EAAE;gCACjB,MAAM,EAAE,EAAE,IAAI,EAAE,wBAAwB,UAAU,EAAE,EAAE;6BACxD;yBACJ;qBACF;iBACF;aACF;YACD,eAAe;YACf,GAAG,EAAE;gBACH,OAAO,EAAE,UAAU,MAAM,CAAC,KAAK,IAAI,UAAU,EAAE;gBAC/C,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,IAAI,UAAU,CAAC;gBAClC,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC;gBACpF,WAAW,EAAE;oBACX,QAAQ,EAAE,IAAI;oBACd,OAAO,EAAE;wBACP,kBAAkB,EAAE;4BAClB,MAAM,EAAE;gCACJ,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE,qBAAqB,CAAC,MAAM,CAAC,MAAM,CAAC;6BACnD;yBACF;qBACF;iBACF;gBACD,SAAS,EAAE;oBACT,GAAG,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE;iBAChC;aACF;YACD,SAAS;YACT,MAAM,EAAE;gBACN,OAAO,EAAE,UAAU,MAAM,CAAC,KAAK,IAAI,UAAU,EAAE;gBAC/C,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,IAAI,UAAU,CAAC;gBAClC,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC;gBACpF,SAAS,EAAE;oBACT,GAAG,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE;iBAChC;aACF;SACF,CAAC;IAEJ,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACJ,KAAK,EAAE,cAAc;YACrB,OAAO,EAAE,OAAO;SACjB;QACD,KAAK;QACL,UAAU,EAAE;YACV,OAAO;SACR;KACF,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,MAAmC;IAChE,MAAM,KAAK,GAAQ,EAAE,CAAC;IACtB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,KAAK,CAAC,GAAG,CAAC,GAAG;YACX,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;YACzB,WAAW,EAAE,KAAK,CAAC,KAAK;SACzB,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,UAAU;IACV,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAClC,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,OAAO,CAAC,UAAkB;IACjC,QAAQ,UAAU,EAAE,CAAC;QACnB,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU;YACb,OAAO,QAAQ,CAAC;QAClB,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC;QACnB,KAAK,MAAM,CAAC;QACZ,KAAK,UAAU;YACb,OAAO,QAAQ,CAAC,CAAC,4BAA4B;QAC/C;YACE,OAAO,QAAQ,CAAC;IACpB,CAAC;AACH,CAAC"}

package/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/test/**/*.test.ts'],
+};

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@objectql/api",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@objectql/core": "^1.0.0",
+    "express": "^4.18.2",
+    "swagger-ui-express": "^5.0.1"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.17",
+    "@types/swagger-ui-express": "^4.1.8",
+    "typescript": "^5.9.3"
+  }
+}