@90soft/parse-server-kit 1.0.0 → 2.0.0

package/dist/middleware/middleware.d.ts

@@ -0,0 +1,36 @@
+import express, { NextFunction, Request, Response } from 'express';
+/**
+ * Validates cloud function routes — supports both entity routes and legacy /functions routes.
+ *
+ * Entity routes:  /api/students/create → resolves to 'createStudent'
+ * Legacy routes:  /api/functions/createStudent → resolves directly
+ *
+ * Converts all requests to POST for Parse Server internal handling.
+ */
+export declare function validateFunctionRoutes(req: Request, res: Response, next: NextFunction): void | express.Response<any, Record<string, any>>;
+/**
+ * Validates entity-based routes: /api/{entity}/{action}
+ * Resolves the route to a cloud function name and rewrites the URL
+ * to /functions/{functionName} so Parse Server can handle it.
+ */
+export declare function validateEntityRoutes(req: Request, res: Response, next: NextFunction): void | express.Response<any, Record<string, any>>;
+/**
+ * Extracts master key from the request body during JSON parsing
+ */
+export declare function extractMasterKey(req: any, res: Response, buf: Buffer, encoding: BufferEncoding): void;
+/**
+ * Restricts access to specific routes unless master key is provided.
+ * Only registered entity routes and system routes are allowed.
+ * /functions is NO LONGER allowed — use entity routes instead.
+ */
+export declare function restrictRoutes(req: any, res: Response, next: NextFunction): void;
+/**
+ * Conditionally applies JSON parsing middleware, skipping file routes
+ */
+export declare function conditionalJsonMiddleware(req: Request, res: Response, next: NextFunction): void;
+/**
+ * Removes the 'result' wrapper from Parse Server responses.
+ * Applies to all registered entity routes (no longer just /functions).
+ */
+export declare function removeResultMiddleware(req: any, res: any, next: any): any;
+//# sourceMappingURL=middleware.d.ts.map

package/dist/middleware/middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../src/middleware/middleware.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAC,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAC,MAAM,SAAS,CAAC;AAKjE;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE,QAAQ,EACb,IAAI,EAAE,YAAY,qDAenB;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE,QAAQ,EACb,IAAI,EAAE,YAAY,qDAuBnB;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,GAAG,EACR,GAAG,EAAE,QAAQ,EACb,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,cAAc,QAUzB;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,QAwBzE;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE,QAAQ,EACb,IAAI,EAAE,YAAY,QAYnB;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,OAoBnE"}

package/dist/middleware/middleware.js

@@ -0,0 +1,133 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateFunctionRoutes = validateFunctionRoutes;
+exports.validateEntityRoutes = validateEntityRoutes;
+exports.extractMasterKey = extractMasterKey;
+exports.restrictRoutes = restrictRoutes;
+exports.conditionalJsonMiddleware = conditionalJsonMiddleware;
+exports.removeResultMiddleware = removeResultMiddleware;
+const express_1 = __importDefault(require("express"));
+const cloudRegistry_1 = require("../decorators/cloudRegistry");
+const routeDecorator_1 = require("../decorators/routeDecorator");
+/**
+ * Validates cloud function routes — supports both entity routes and legacy /functions routes.
+ *
+ * Entity routes:  /api/students/create → resolves to 'createStudent'
+ * Legacy routes:  /api/functions/createStudent → resolves directly
+ *
+ * Converts all requests to POST for Parse Server internal handling.
+ */
+function validateFunctionRoutes(req, res, next) {
+    const functionName = req.path.split('/')[1];
+    const metadata = cloudRegistry_1.CloudFunctionRegistry.getFunction(functionName);
+    if (!metadata) {
+        return res.status(404).json({ message: 'Function not found' });
+    }
+    if (!metadata.config.methods.includes(req.method)) {
+        return res.status(405).json({ message: 'Method not allowed' });
+    }
+    req.method = 'POST'; // Convert method to POST for Parse Server
+    return next();
+}
+/**
+ * Validates entity-based routes: /api/{entity}/{action}
+ * Resolves the route to a cloud function name and rewrites the URL
+ * to /functions/{functionName} so Parse Server can handle it.
+ */
+function validateEntityRoutes(req, res, next) {
+    // Build route path from URL: /students/create
+    const routePath = req.path;
+    const functionName = routeDecorator_1.RouteRegistry.resolve(routePath);
+    if (!functionName) {
+        return res.status(404).json({ message: 'Route not found' });
+    }
+    const metadata = cloudRegistry_1.CloudFunctionRegistry.getFunction(functionName);
+    if (!metadata) {
+        return res.status(404).json({ message: 'Function not found' });
+    }
+    if (!metadata.config.methods.includes(req.method)) {
+        return res.status(405).json({ message: 'Method not allowed' });
+    }
+    // Rewrite URL to /functions/{functionName} so Parse Server handles it
+    req.url = `/functions/${functionName}`;
+    req.method = 'POST'; // Convert method to POST for Parse Server
+    return next();
+}
+/**
+ * Extracts master key from the request body during JSON parsing
+ */
+function extractMasterKey(req, res, buf, encoding) {
+    try {
+        const body = JSON.parse(buf.toString(encoding));
+        if (body && (body.masterKey || body._MasterKey)) {
+            req['x-master-key'] = body.masterKey || body._MasterKey;
+        }
+    }
+    catch (err) {
+        throw res.status(400).json({ message: 'Error parsing JSON body' });
+    }
+}
+/**
+ * Restricts access to specific routes unless master key is provided.
+ * Only registered entity routes and system routes are allowed.
+ * /functions is NO LONGER allowed — use entity routes instead.
+ */
+function restrictRoutes(req, res, next) {
+    const systemRoutes = ['/health', '/serverInfo', '/files'];
+    // Master key bypasses all restrictions
+    if (req['x-master-key'] === process.env.masterKey) {
+        return next();
+    }
+    // Allow system routes
+    if (systemRoutes.some(route => req.path.startsWith(route))) {
+        return next();
+    }
+    // Allow registered entity route prefixes
+    if (routeDecorator_1.RouteRegistry.isRegisteredPrefix(req.path)) {
+        return next();
+    }
+    // Allow /functions for internal Parse Server use (rewritten by validateEntityRoutes)
+    if (req.path.startsWith('/functions')) {
+        return next();
+    }
+    throw res.status(403).json({ message: 'Route not allowed' });
+}
+/**
+ * Conditionally applies JSON parsing middleware, skipping file routes
+ */
+function conditionalJsonMiddleware(req, res, next) {
+    if (req.path.startsWith(`${process.env.mountPath}/files`)) {
+        console.log('Skipping JSON middleware for /files route');
+        return next();
+    }
+    express_1.default.json({
+        limit: '10mb',
+        type: ['text/plain'],
+        verify: extractMasterKey,
+    })(req, res, next);
+}
+/**
+ * Removes the 'result' wrapper from Parse Server responses.
+ * Applies to all registered entity routes (no longer just /functions).
+ */
+function removeResultMiddleware(req, res, next) {
+    const mountPath = process.env.mountPath || '/api';
+    // Check if this is a registered entity route or a rewritten /functions route
+    const pathAfterMount = req.path.replace(mountPath, '');
+    const isEntityRoute = routeDecorator_1.RouteRegistry.isRegisteredPrefix(pathAfterMount);
+    const isFunctionRoute = req.path.includes('/functions');
+    if (!isEntityRoute && !isFunctionRoute)
+        return next();
+    const originalJson = res.json.bind(res);
+    res.json = (body) => {
+        if (body && typeof body === 'object' && 'result' in body) {
+            return originalJson(body.result);
+        }
+        return originalJson(body);
+    };
+    next();
+}
+//# sourceMappingURL=middleware.js.map

package/dist/middleware/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../src/middleware/middleware.ts"],"names":[],"mappings":";;;;;AAaA,wDAkBC;AAOD,oDA0BC;AAKD,4CAcC;AAOD,wCAwBC;AAKD,8DAeC;AAMD,wDAoBC;AAhKD,sDAAiE;AACjE,+DAAkE;AAClE,iEAA2D;AAG3D;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,GAAY,EACZ,GAAa,EACb,IAAkB;IAElB,MAAM,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,qCAAqB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAEjE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAC,OAAO,EAAE,oBAAoB,EAAC,CAAC,CAAC;IAC/D,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAoB,CAAC,EAAE,CAAC;QAChE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAC,OAAO,EAAE,oBAAoB,EAAC,CAAC,CAAC;IAC/D,CAAC;IAED,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,0CAA0C;IAC/D,OAAO,IAAI,EAAE,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAClC,GAAY,EACZ,GAAa,EACb,IAAkB;IAElB,8CAA8C;IAC9C,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC;IAC3B,MAAM,YAAY,GAAG,8BAAa,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAEtD,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAC,OAAO,EAAE,iBAAiB,EAAC,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,QAAQ,GAAG,qCAAqB,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACjE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAC,OAAO,EAAE,oBAAoB,EAAC,CAAC,CAAC;IAC/D,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAoB,CAAC,EAAE,CAAC;QAChE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAC,OAAO,EAAE,oBAAoB,EAAC,CAAC,CAAC;IAC/D,CAAC;IAED,sEAAsE;IACtE,GAAG,CAAC,GAAG,GAAG,cAAc,YAAY,EAAE,CAAC;IACvC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,0CAA0C;IAC/D,OAAO,IAAI,EAAE,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAC9B,GAAQ,EACR,GAAa,EACb,GAAW,EACX,QAAwB;IAExB,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QAChD,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAChD,GAAG,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC;QAC1D,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAC,OAAO,EAAE,yBAAyB,EAAC,CAAC,CAAC;IACnE,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,GAAQ,EAAE,GAAa,EAAE,IAAkB;IACxE,MAAM,YAAY,GAAG,CAAC,SAAS,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;IAE1D,uCAAuC;IACvC,IAAI,GAAG,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QAClD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;IAED,sBAAsB;IACtB,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAC3D,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;IAED,yCAAyC;IACzC,IAAI,8BAAa,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/C,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;IAED,qFAAqF;IACrF,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;IAED,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAC,OAAO,EAAE,mBAAmB,EAAC,CAAC,CAAC;AAC7D,CAAC;AAED;;GAEG;AACH,SAAgB,yBAAyB,CACvC,GAAY,EACZ,GAAa,EACb,IAAkB;IAElB,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,QAAQ,CAAC,EAAE,CAAC;QAC1D,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAC;QACzD,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC;IAED,iBAAO,CAAC,IAAI,CAAC;QACX,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,CAAC,YAAY,CAAC;QACpB,MAAM,EAAE,gBAAgB;KACzB,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AACrB,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB,CAAC,GAAQ,EAAE,GAAQ,EAAE,IAAS;IAClE,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,MAAM,CAAC;IAElD,6EAA6E;IAC7E,MAAM,cAAc,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IACvD,MAAM,aAAa,GAAG,8BAAa,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;IACvE,MAAM,eAAe,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAExD,IAAI,CAAC,aAAa,IAAI,CAAC,eAAe;QAAE,OAAO,IAAI,EAAE,CAAC;IAEtD,MAAM,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAExC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAS,EAAE,EAAE;QACvB,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACzD,OAAO,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC;IAEF,IAAI,EAAE,CAAC;AACT,CAAC"}

package/dist/swagger/index.d.ts

@@ -0,0 +1,9 @@
+import { Express } from 'express';
+import { SwaggerConfig } from './swaggerSpec';
+export { SwaggerRegistry } from './swaggerRegistry';
+export { generateSwaggerSpec, getSwaggerJson } from './swaggerSpec';
+/**
+ * Setup Swagger UI for the Express app
+ */
+export declare function setupSwagger(app: Express, config: SwaggerConfig, path?: string): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/swagger/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/swagger/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAsB,aAAa,EAAC,MAAM,eAAe,CAAC;AAEjE,OAAO,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,eAAe,CAAC;AAElE;;GAEG;AACH,wBAAgB,YAAY,CAC1B,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,aAAa,EACrB,IAAI,GAAE,MAAoB,QA0B3B"}

package/dist/swagger/index.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSwaggerJson = exports.generateSwaggerSpec = exports.SwaggerRegistry = void 0;
+exports.setupSwagger = setupSwagger;
+const swagger_ui_express_1 = __importDefault(require("swagger-ui-express"));
+const swaggerSpec_1 = require("./swaggerSpec");
+var swaggerRegistry_1 = require("./swaggerRegistry");
+Object.defineProperty(exports, "SwaggerRegistry", { enumerable: true, get: function () { return swaggerRegistry_1.SwaggerRegistry; } });
+var swaggerSpec_2 = require("./swaggerSpec");
+Object.defineProperty(exports, "generateSwaggerSpec", { enumerable: true, get: function () { return swaggerSpec_2.generateSwaggerSpec; } });
+Object.defineProperty(exports, "getSwaggerJson", { enumerable: true, get: function () { return swaggerSpec_2.getSwaggerJson; } });
+/**
+ * Setup Swagger UI for the Express app
+ */
+function setupSwagger(app, config, path = '/api-docs') {
+    console.log(path);
+    // Generate spec dynamically (after all models and functions are loaded)
+    const getSpec = () => (0, swaggerSpec_1.generateSwaggerSpec)(config);
+    // Serve Swagger JSON BEFORE the UI middleware (so it doesn't get caught)
+    app.get(`${path}/json`, (req, res) => {
+        res.json(getSpec());
+    });
+    // Serve Swagger UI
+    app.use(path, swagger_ui_express_1.default.serve, swagger_ui_express_1.default.setup(null, {
+        swaggerOptions: {
+            url: `${path}/json`,
+            persistAuthorization: true,
+        },
+        customSiteTitle: config.title || 'API Documentation',
+    }));
+    console.log(`[Swagger] API documentation available at ${path}`);
+    console.log(`[Swagger] API spec available at ${path}/json`);
+}
+//# sourceMappingURL=index.js.map

package/dist/swagger/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/swagger/index.ts"],"names":[],"mappings":";;;;;;AAUA,oCA6BC;AAtCD,4EAA2C;AAC3C,+CAAiE;AAEjE,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,6CAAkE;AAA1D,kHAAA,mBAAmB,OAAA;AAAE,6GAAA,cAAc,OAAA;AAE3C;;GAEG;AACH,SAAgB,YAAY,CAC1B,GAAY,EACZ,MAAqB,EACrB,OAAe,WAAW;IAE1B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClB,wEAAwE;IACxE,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAA,iCAAmB,EAAC,MAAM,CAAC,CAAC;IAElD,yEAAyE;IACzE,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACnC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,mBAAmB;IACnB,GAAG,CAAC,GAAG,CACL,IAAI,EACJ,4BAAS,CAAC,KAAK,EACf,4BAAS,CAAC,KAAK,CAAC,IAAI,EAAE;QACpB,cAAc,EAAE;YACd,GAAG,EAAE,GAAG,IAAI,OAAO;YACnB,oBAAoB,EAAE,IAAI;SAC3B;QACD,eAAe,EAAE,MAAM,CAAC,KAAK,IAAI,mBAAmB;KACrD,CAAC,CACH,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,4CAA4C,IAAI,EAAE,CAAC,CAAC;IAChE,OAAO,CAAC,GAAG,CAAC,mCAAmC,IAAI,OAAO,CAAC,CAAC;AAC9D,CAAC"}

package/dist/swagger/swaggerRegistry.d.ts

@@ -0,0 +1,79 @@
+import 'reflect-metadata';
+export interface SwaggerModelSchema {
+    className: string;
+    description?: string;
+    properties: Record<string, SwaggerPropertySchema>;
+    required: string[];
+}
+export interface SwaggerPropertySchema {
+    type: string;
+    format?: string;
+    description?: string;
+    $ref?: string;
+    items?: {
+        type?: string;
+        $ref?: string;
+    };
+    nullable?: boolean;
+}
+export interface SwaggerFunctionSchema {
+    name: string;
+    method: string;
+    description?: string;
+    summary?: string;
+    tags?: string[];
+    requiresAuth: boolean;
+    requestBody?: {
+        required: boolean;
+        properties: Record<string, SwaggerPropertySchema>;
+    };
+    responses?: Record<string, {
+        description: string;
+        schema?: any;
+    }>;
+}
+/**
+ * Registry for collecting Swagger/OpenAPI documentation metadata
+ */
+export declare class SwaggerRegistry {
+    private static models;
+    private static functions;
+    /**
+     * Register a model for Swagger documentation
+     */
+    static registerModel(schema: SwaggerModelSchema): void;
+    /**
+     * Register a cloud function for Swagger documentation
+     */
+    static registerFunction(schema: SwaggerFunctionSchema): void;
+    /**
+     * Get all registered models
+     */
+    static getModels(): SwaggerModelSchema[];
+    /**
+     * Get all registered functions
+     */
+    static getFunctions(): SwaggerFunctionSchema[];
+    /**
+     * Get a specific model by name
+     */
+    static getModel(name: string): SwaggerModelSchema | undefined;
+    /**
+     * Get a specific function by name
+     */
+    static getFunction(name: string): SwaggerFunctionSchema | undefined;
+    /**
+     * Normalize class name to match Parse Server conventions
+     * (e.g., 'User' -> '_User', 'Role' -> '_Role')
+     */
+    static normalizeClassName(className?: string): string | undefined;
+    /**
+     * Convert Parse field type to Swagger/OpenAPI type
+     */
+    static parseTypeToSwagger(fieldType: string, targetClass?: string): SwaggerPropertySchema;
+    /**
+     * Convert validation field type to Swagger type
+     */
+    static validationTypeToSwagger(type: any): SwaggerPropertySchema;
+}
+//# sourceMappingURL=swaggerRegistry.d.ts.map

package/dist/swagger/swaggerRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swaggerRegistry.d.ts","sourceRoot":"","sources":["../../src/swagger/swaggerRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAClD,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE;QACZ,QAAQ,EAAE,OAAO,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;KACnD,CAAC;IACF,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,GAAG,CAAA;KAAE,CAAC,CAAC;CACnE;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAC,MAAM,CAA8C;IACnE,OAAO,CAAC,MAAM,CAAC,SAAS,CAAiD;IAEzE;;OAEG;IACH,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,kBAAkB;IAK/C;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,qBAAqB;IAKrD;;OAEG;IACH,MAAM,CAAC,SAAS;IAIhB;;OAEG;IACH,MAAM,CAAC,YAAY;IAInB;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM;IAI5B;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM;IAI/B;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAWjE;;OAEG;IACH,MAAM,CAAC,kBAAkB,CACvB,SAAS,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,MAAM,GACnB,qBAAqB;IAiCxB;;OAEG;IACH,MAAM,CAAC,uBAAuB,CAAC,IAAI,EAAE,GAAG,GAAG,qBAAqB;CAQjE"}

package/dist/swagger/swaggerRegistry.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwaggerRegistry = void 0;
+require("reflect-metadata");
+/**
+ * Registry for collecting Swagger/OpenAPI documentation metadata
+ */
+class SwaggerRegistry {
+    /**
+     * Register a model for Swagger documentation
+     */
+    static registerModel(schema) {
+        this.models.set(schema.className, schema);
+        console.log(`[Swagger] Registered model: ${schema.className}`);
+    }
+    /**
+     * Register a cloud function for Swagger documentation
+     */
+    static registerFunction(schema) {
+        this.functions.set(schema.name, schema);
+        console.log(`[Swagger] Registered function: ${schema.name}`);
+    }
+    /**
+     * Get all registered models
+     */
+    static getModels() {
+        return Array.from(this.models.values());
+    }
+    /**
+     * Get all registered functions
+     */
+    static getFunctions() {
+        return Array.from(this.functions.values());
+    }
+    /**
+     * Get a specific model by name
+     */
+    static getModel(name) {
+        return this.models.get(name);
+    }
+    /**
+     * Get a specific function by name
+     */
+    static getFunction(name) {
+        return this.functions.get(name);
+    }
+    /**
+     * Normalize class name to match Parse Server conventions
+     * (e.g., 'User' -> '_User', 'Role' -> '_Role')
+     */
+    static normalizeClassName(className) {
+        if (!className)
+            return undefined;
+        // Parse built-in classes use underscore prefix
+        const builtInClasses = ['User', 'Role', 'Session', 'Installation'];
+        if (builtInClasses.includes(className)) {
+            return `_${className}`;
+        }
+        return className;
+    }
+    /**
+     * Convert Parse field type to Swagger/OpenAPI type
+     */
+    static parseTypeToSwagger(fieldType, targetClass) {
+        const normalizedClass = this.normalizeClassName(targetClass);
+        const typeMap = {
+            String: { type: 'string' },
+            Number: { type: 'number' },
+            Boolean: { type: 'boolean' },
+            Date: { type: 'string', format: 'date-time' },
+            Object: { type: 'object' },
+            Array: { type: 'array', items: { type: 'string' } },
+            GeoPoint: {
+                type: 'object',
+                description: 'GeoPoint with latitude and longitude',
+            },
+            File: { type: 'object', description: 'Parse File object' },
+            Bytes: { type: 'string', format: 'byte' },
+            Polygon: { type: 'object', description: 'Polygon coordinates' },
+            Pointer: {
+                type: 'object',
+                description: `Pointer to ${targetClass || 'unknown'}`,
+                $ref: normalizedClass ? `#/components/schemas/${normalizedClass}` : undefined,
+            },
+            Relation: {
+                type: 'array',
+                description: `Relation to ${targetClass || 'unknown'}`,
+                items: {
+                    $ref: normalizedClass ? `#/components/schemas/${normalizedClass}` : undefined,
+                },
+            },
+        };
+        return typeMap[fieldType] || { type: 'string' };
+    }
+    /**
+     * Convert validation field type to Swagger type
+     */
+    static validationTypeToSwagger(type) {
+        if (type === String)
+            return { type: 'string' };
+        if (type === Number)
+            return { type: 'number' };
+        if (type === Boolean)
+            return { type: 'boolean' };
+        if (type === Array)
+            return { type: 'array', items: { type: 'string' } };
+        if (type === Object)
+            return { type: 'object' };
+        return { type: 'string' };
+    }
+}
+exports.SwaggerRegistry = SwaggerRegistry;
+SwaggerRegistry.models = new Map();
+SwaggerRegistry.functions = new Map();
+//# sourceMappingURL=swaggerRegistry.js.map

package/dist/swagger/swaggerRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swaggerRegistry.js","sourceRoot":"","sources":["../../src/swagger/swaggerRegistry.ts"],"names":[],"mappings":";;;AAAA,4BAA0B;AAgC1B;;GAEG;AACH,MAAa,eAAe;IAI1B;;OAEG;IACH,MAAM,CAAC,aAAa,CAAC,MAA0B;QAC7C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC1C,OAAO,CAAC,GAAG,CAAC,+BAA+B,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAA6B;QACnD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC,OAAO,CAAC,GAAG,CAAC,kCAAkC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,SAAS;QACd,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAY;QACjB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAY;QAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,SAAkB;QAC1C,IAAI,CAAC,SAAS;YAAE,OAAO,SAAS,CAAC;QAEjC,+CAA+C;QAC/C,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;QACnE,IAAI,cAAc,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACvC,OAAO,IAAI,SAAS,EAAE,CAAC;QACzB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,kBAAkB,CACvB,SAAiB,EACjB,WAAoB;QAEpB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAC7D,MAAM,OAAO,GAA0C;YACrD,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YAC5B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE;YAC7C,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC1B,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YACnD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,sCAAsC;aACpD;YACD,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE;YAC1D,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE;YACzC,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,qBAAqB,EAAE;YAC/D,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,cAAc,WAAW,IAAI,SAAS,EAAE;gBACrD,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,wBAAwB,eAAe,EAAE,CAAC,CAAC,CAAC,SAAS;aAC9E;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,eAAe,WAAW,IAAI,SAAS,EAAE;gBACtD,KAAK,EAAE;oBACL,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,wBAAwB,eAAe,EAAE,CAAC,CAAC,CAAC,SAAS;iBAC9E;aACF;SACF,CAAC;QAEF,OAAO,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,uBAAuB,CAAC,IAAS;QACtC,IAAI,IAAI,KAAK,MAAM;YAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC/C,IAAI,IAAI,KAAK,MAAM;YAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC/C,IAAI,IAAI,KAAK,OAAO;YAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QACjD,IAAI,IAAI,KAAK,KAAK;YAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC;QACxE,IAAI,IAAI,KAAK,MAAM;YAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC/C,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC5B,CAAC;;AAhHH,0CAiHC;AAhHgB,sBAAM,GAAoC,IAAI,GAAG,EAAE,CAAC;AACpD,yBAAS,GAAuC,IAAI,GAAG,EAAE,CAAC"}

package/dist/swagger/swaggerSpec.d.ts

@@ -0,0 +1,69 @@
+export interface SwaggerConfig {
+    title: string;
+    version: string;
+    description?: string;
+    basePath?: string;
+    host?: string;
+    schemes?: string[];
+}
+/**
+ * Generate OpenAPI 3.0 specification from registered metadata
+ */
+export declare function generateSwaggerSpec(config: SwaggerConfig): {
+    openapi: string;
+    info: {
+        title: string;
+        version: string;
+        description: string;
+    };
+    servers: {
+        url: string;
+        description: string;
+    }[];
+    tags: {
+        name: string;
+        description: string;
+    }[];
+    paths: Record<string, any>;
+    components: {
+        schemas: Record<string, any>;
+        securitySchemes: {
+            applicationId: {
+                type: string;
+                in: string;
+                name: string;
+                description: string;
+            };
+            sessionToken: {
+                type: string;
+                in: string;
+                name: string;
+                description: string;
+            };
+            masterKey: {
+                type: string;
+                in: string;
+                name: string;
+                description: string;
+            };
+            restApiKey: {
+                type: string;
+                in: string;
+                name: string;
+                description: string;
+            };
+        };
+    };
+    security: ({
+        applicationId: never[];
+        restApiKey?: undefined;
+    } | {
+        restApiKey: never[];
+        applicationId?: undefined;
+    })[];
+};
+/**
+ * Get the Swagger specification as JSON
+ */
+export declare function getSwaggerJson(config: SwaggerConfig): string;
+//# sourceMappingURL=swaggerSpec.d.ts.map

package/dist/swagger/swaggerSpec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swaggerSpec.d.ts","sourceRoot":"","sources":["../../src/swagger/swaggerSpec.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CAEpB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6KxD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,CAE5D"}