@wild-framework/openapi 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wild Framework contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+# @wild-framework/openapi
+
+Auto-generated **OpenAPI 3.0 docs + Swagger UI** for [Wild Framework](https://github.com/KhandaSoftware/wild-framework) apps.
+
+Generates an OpenAPI spec from your routes and Zod validators — **no hand-written spec files**. The docs always match your code.
+
+## Install
+
+```bash
+pnpm add @wild-framework/openapi
+```
+
+## Quick start
+
+Register the provider **last** (after all feature providers) so it sees every route:
+
+```ts
+import { createApplication } from "@wild-framework/core";
+import { ContainerProvider } from "@wild-framework/container";
+import { ConfigProvider } from "@wild-framework/config";
+import { HttpProvider } from "@wild-framework/http";
+import { OpenApiProvider } from "@wild-framework/openapi";
+
+const app = createApplication();
+
+app.register(ContainerProvider);
+app.register(ConfigProvider);
+app.register(HttpProvider);
+app.register(UserProvider);          // your routes
+
+OpenApiProvider.options = { title: "My API", version: "1.0.0" };
+app.register(OpenApiProvider);       // last
+
+await app.boot();
+```
+
+Now available:
+
+- **`GET /docs`** → interactive Swagger UI
+- **`GET /openapi.json`** → the generated OpenAPI 3.0 spec
+
+## What it generates
+
+Every route registered via the `Router` becomes an OpenAPI operation:
+
+- Path: `/users/:id` → `/users/{id}`
+- Request body: from your Zod validator classes (`CreateUserRequest` etc.)
+- Operation ID: from the controller action (`UserController.index`)
+- Bearer security scheme by default
+
+See it live in [`examples/shop`](../../examples/shop) — run `pnpm example:shop` and open `http://localhost:3200/docs`.
+
+## Config
+
+Set `OpenApiProvider.options` before registering:
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `specPath` | `/openapi.json` | Where the JSON spec is served |
+| `uiPath` | `/docs` | Where Swagger UI is served |
+| `title` | `Wild Framework API` | Spec `info.title` |
+| `version` | `1.0.0` | Spec `info.version` |
+| `description` | — | Spec `info.description` |
+| `bearerAuth` | `true` | Add a bearer security scheme |
+
+## Programmatic use
+
+```ts
+import { generateOpenApi } from "@wild-framework/openapi";
+import { Router } from "@wild-framework/http";
+
+const spec = generateOpenApi(router, { title: "My API", version: "1.0.0" });
+```

package/dist/generator.d.ts

@@ -0,0 +1,29 @@
+import type { Router } from "@wild-framework/http";
+/**
+ * Options for building an OpenAPI document.
+ */
+export interface OpenApiOptions {
+    title: string;
+    version: string;
+    description?: string;
+    /** Whether to advertise a bearer security scheme. */
+    bearerAuth?: boolean;
+}
+/**
+ * A complete OpenAPI 3.0.x document (plain object, JSON-serializable).
+ */
+export type OpenApiDocument = Record<string, unknown>;
+/**
+ * Build an OpenAPI 3.0 document from a Router's registered routes.
+ *
+ * Every route's path, HTTP method, request validator (Zod → schema), and
+ * controller action are turned into OpenAPI operations. Responses are
+ * generic 200 + the framework's structured error shape by default.
+ */
+export declare function generateOpenApi(router: Router, options: OpenApiOptions): OpenApiDocument;
+/**
+ * Convert an Express-style path (`/users/:id`) to an OpenAPI path
+ * (`/users/{id}`).
+ */
+export declare function normalizePath(path: string): string;
+//# sourceMappingURL=generator.d.ts.map

package/dist/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAmB,MAAM,sBAAsB,CAAC;AAGpE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qDAAqD;IACrD,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEtD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,eAAe,CA6CxF;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElD"}

package/dist/generator.js

@@ -0,0 +1,128 @@
+import { zodSchemaToOpenApi } from "./zod-to-schema.js";
+/**
+ * Build an OpenAPI 3.0 document from a Router's registered routes.
+ *
+ * Every route's path, HTTP method, request validator (Zod → schema), and
+ * controller action are turned into OpenAPI operations. Responses are
+ * generic 200 + the framework's structured error shape by default.
+ */
+export function generateOpenApi(router, options) {
+    const paths = {};
+    const components = { schemas: {} };
+    const schemaNames = new Set();
+    // First pass: collect named schemas from validator classes so every
+    // validator ends up in components.schemas (and the frontend generator
+    // can produce real TS types).
+    for (const route of router.getRegisteredRoutes()) {
+        if (route.validator && route.validatorName) {
+            schemaNames.add(route.validatorName);
+            components.schemas[route.validatorName] =
+                zodSchemaToOpenApi(route.validator);
+        }
+    }
+    for (const route of router.getRegisteredRoutes()) {
+        const operation = buildOperation(route, schemaNames);
+        const pathKey = normalizePath(route.path);
+        if (!paths[pathKey]) {
+            paths[pathKey] = {};
+        }
+        paths[pathKey][route.method] = operation;
+    }
+    const doc = {
+        openapi: "3.0.3",
+        info: {
+            title: options.title,
+            version: options.version,
+            ...(options.description ? { description: options.description } : {}),
+        },
+        paths,
+        components,
+    };
+    if (options.bearerAuth !== false) {
+        doc.components.securitySchemes = {
+            bearerAuth: { type: "http", scheme: "bearer", bearerFormat: "JWT" },
+        };
+        doc.security = [{ bearerAuth: [] }];
+    }
+    return doc;
+}
+/**
+ * Convert an Express-style path (`/users/:id`) to an OpenAPI path
+ * (`/users/{id}`).
+ */
+export function normalizePath(path) {
+    return path.replace(/:([A-Za-z0-9_]+)/g, "{$1}");
+}
+function buildOperation(route, schemaNames) {
+    const operation = {
+        responses: {
+            "200": { description: "OK" },
+            "400": {
+                description: "Bad Request",
+                content: {
+                    "application/json": {
+                        schema: errorSchema(),
+                    },
+                },
+            },
+            "404": {
+                description: "Not Found",
+                content: {
+                    "application/json": {
+                        schema: errorSchema(),
+                    },
+                },
+            },
+            "422": {
+                description: "Validation failed",
+                content: {
+                    "application/json": {
+                        schema: errorSchema(),
+                    },
+                },
+            },
+        },
+    };
+    // OperationId from controller action, e.g. "UserController.index"
+    if (route.action) {
+        const ctor = route.action.controller;
+        operation.operationId = `${ctor.name ?? "Controller"}.${route.action.method}`;
+        operation.summary = `${route.method.toUpperCase()} ${route.path}`;
+    }
+    // Request body from the validator schema — reference the named component
+    // schema when one exists so frontend generators can type it.
+    if (route.validator) {
+        if (route.validatorName && schemaNames.has(route.validatorName)) {
+            operation.requestBody = {
+                required: true,
+                content: {
+                    "application/json": {
+                        schema: { $ref: `#/components/schemas/${route.validatorName}` },
+                    },
+                },
+            };
+        }
+        else {
+            const schema = zodSchemaToOpenApi(route.validator);
+            operation.requestBody = {
+                required: true,
+                content: {
+                    "application/json": { schema },
+                },
+            };
+        }
+    }
+    return operation;
+}
+function errorSchema() {
+    return {
+        type: "object",
+        properties: {
+            error: { type: "string" },
+            message: { type: "string" },
+            statusCode: { type: "integer" },
+        },
+        required: ["error", "message", "statusCode"],
+    };
+}
+//# sourceMappingURL=generator.js.map

package/dist/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAkBxD;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,MAAc,EAAE,OAAuB;IACnE,MAAM,KAAK,GAA4C,EAAE,CAAC;IAC1D,MAAM,UAAU,GAA4B,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAC5D,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IAEtC,oEAAoE;IACpE,sEAAsE;IACtE,8BAA8B;IAC9B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;QAC/C,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACzC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YACpC,UAAU,CAAC,OAAmC,CAAC,KAAK,CAAC,aAAa,CAAC;gBAChE,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;IACL,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;QAC/C,MAAM,SAAS,GAAG,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACrD,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACxB,CAAC;QACD,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC7C,CAAC;IAED,MAAM,GAAG,GAAoB;QACzB,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACF,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACvE;QACD,KAAK;QACL,UAAU;KACb,CAAC;IAEF,IAAI,OAAO,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;QAC9B,GAAG,CAAC,UAAsC,CAAC,eAAe,GAAG;YAC1D,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,EAAE;SACtE,CAAC;QACF,GAAG,CAAC,QAAQ,GAAG,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,cAAc,CAAC,KAAsB,EAAE,WAAwB;IACpE,MAAM,SAAS,GAA4B;QACvC,SAAS,EAAE;YACP,KAAK,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE;YAC5B,KAAK,EAAE;gBACH,WAAW,EAAE,aAAa;gBAC1B,OAAO,EAAE;oBACL,kBAAkB,EAAE;wBAChB,MAAM,EAAE,WAAW,EAAE;qBACxB;iBACJ;aACJ;YACD,KAAK,EAAE;gBACH,WAAW,EAAE,WAAW;gBACxB,OAAO,EAAE;oBACL,kBAAkB,EAAE;wBAChB,MAAM,EAAE,WAAW,EAAE;qBACxB;iBACJ;aACJ;YACD,KAAK,EAAE;gBACH,WAAW,EAAE,mBAAmB;gBAChC,OAAO,EAAE;oBACL,kBAAkB,EAAE;wBAChB,MAAM,EAAE,WAAW,EAAE;qBACxB;iBACJ;aACJ;SACJ;KACJ,CAAC;IAEF,kEAAkE;IAClE,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACf,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,UAA0C,CAAC;QACrE,SAAS,CAAC,WAAW,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,YAAY,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAC9E,SAAS,CAAC,OAAO,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;IACtE,CAAC;IAED,yEAAyE;IACzE,6DAA6D;IAC7D,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QAClB,IAAI,KAAK,CAAC,aAAa,IAAI,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;YAC9D,SAAS,CAAC,WAAW,GAAG;gBACpB,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACL,kBAAkB,EAAE;wBAChB,MAAM,EAAE,EAAE,IAAI,EAAE,wBAAwB,KAAK,CAAC,aAAa,EAAE,EAAE;qBAClE;iBACJ;aACJ,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACnD,SAAS,CAAC,WAAW,GAAG;gBACpB,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACL,kBAAkB,EAAE,EAAE,MAAM,EAAE;iBACjC;aACJ,CAAC;QACN,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,SAAS,WAAW;IAChB,OAAO;QACH,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACR,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACzB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC3B,UAAU,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;SAClC;QACD,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,YAAY,CAAC;KAC/C,CAAC;AACN,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { OpenApiProvider, type OpenApiProviderOptions } from "./provider.js";
+export { generateOpenApi, normalizePath, type OpenApiDocument, type OpenApiOptions, } from "./generator.js";
+export { zodSchemaToOpenApi } from "./zod-to-schema.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,KAAK,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAC7E,OAAO,EACH,eAAe,EACf,aAAa,EACb,KAAK,eAAe,EACpB,KAAK,cAAc,GACtB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { OpenApiProvider } from "./provider.js";
+export { generateOpenApi, normalizePath, } from "./generator.js";
+export { zodSchemaToOpenApi } from "./zod-to-schema.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAA+B,MAAM,eAAe,CAAC;AAC7E,OAAO,EACH,eAAe,EACf,aAAa,GAGhB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/provider.d.ts

@@ -0,0 +1,37 @@
+import type { Provider, Application } from "@wild-framework/core";
+/**
+ * OpenApiProvider options.
+ */
+export interface OpenApiProviderOptions {
+    /** Path where the generated JSON spec is served. Default: "/openapi.json". */
+    specPath?: string;
+    /** Path where Swagger UI is served. Default: "/docs". */
+    uiPath?: string;
+    title?: string;
+    version?: string;
+    description?: string;
+    bearerAuth?: boolean;
+}
+/**
+ * Registers OpenAPI endpoints on the app's Router.
+ *
+ * - `register()`: nothing (routes must be registered before boot)
+ * - `boot()`: generates the spec from the Router's registered routes,
+ *   then serves `GET /openapi.json` and `GET /docs` (Swagger UI)
+ *
+ * Register this provider LAST, after all feature providers.
+ *
+ * Configure via the static `options` before registering (the framework
+ * instantiates providers with a no-arg constructor):
+ *
+ * ```ts
+ * OpenApiProvider.options = { title: "Shop API", version: "1.0.0" };
+ * app.register(OpenApiProvider);
+ * ```
+ */
+export declare class OpenApiProvider implements Provider {
+    /** Static configuration — set before `app.register(OpenApiProvider)`. */
+    static options: OpenApiProviderOptions;
+    boot(app: Application): void;
+}
+//# sourceMappingURL=provider.d.ts.map

package/dist/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAKlE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAgCD;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,eAAgB,YAAW,QAAQ;IAC5C,yEAAyE;IACzE,MAAM,CAAC,OAAO,EAAE,sBAAsB,CAAM;IAE5C,IAAI,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;CA2B/B"}

package/dist/provider.js

@@ -0,0 +1,76 @@
+import { Container } from "@wild-framework/container";
+import { Router } from "@wild-framework/http";
+import { generateOpenApi } from "./generator.js";
+/**
+ * A minimal Swagger UI HTML page that loads the spec from `specPath`.
+ *
+ * Uses the CDN-hosted swagger-ui-dist assets — no bundling needed.
+ */
+function swaggerUiHtml(specPath) {
+    return `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <title>API Docs</title>
+  <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css" />
+</head>
+<body>
+  <div id="swagger-ui"></div>
+  <script src="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
+  <script>
+    window.onload = () => {
+      window.ui = SwaggerUIBundle({
+        url: ${JSON.stringify(specPath)},
+        dom_id: '#swagger-ui',
+        deepLinking: true,
+        presets: [SwaggerUIBundle.presets.apis],
+      });
+    };
+  </script>
+</body>
+</html>`;
+}
+/**
+ * Registers OpenAPI endpoints on the app's Router.
+ *
+ * - `register()`: nothing (routes must be registered before boot)
+ * - `boot()`: generates the spec from the Router's registered routes,
+ *   then serves `GET /openapi.json` and `GET /docs` (Swagger UI)
+ *
+ * Register this provider LAST, after all feature providers.
+ *
+ * Configure via the static `options` before registering (the framework
+ * instantiates providers with a no-arg constructor):
+ *
+ * ```ts
+ * OpenApiProvider.options = { title: "Shop API", version: "1.0.0" };
+ * app.register(OpenApiProvider);
+ * ```
+ */
+export class OpenApiProvider {
+    /** Static configuration — set before `app.register(OpenApiProvider)`. */
+    static options = {};
+    boot(app) {
+        const container = app.resolve(Container);
+        const router = container.resolve(Router);
+        const options = OpenApiProvider.options;
+        const specPath = options.specPath ?? "/openapi.json";
+        const uiPath = options.uiPath ?? "/docs";
+        const opts = {
+            title: options.title ?? "Wild Framework API",
+            version: options.version ?? "1.0.0",
+            description: options.description,
+            bearerAuth: options.bearerAuth,
+        };
+        const spec = generateOpenApi(router, opts);
+        // Serve the JSON spec
+        router.get(specPath, (_req, res) => {
+            res.json(spec);
+        });
+        // Serve Swagger UI
+        router.get(uiPath, (_req, res) => {
+            res.type("html").send(swaggerUiHtml(specPath));
+        });
+    }
+}
+//# sourceMappingURL=provider.js.map

package/dist/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAA6C,MAAM,gBAAgB,CAAC;AAgB5F;;;;GAIG;AACH,SAAS,aAAa,CAAC,QAAgB;IACnC,OAAO;;;;;;;;;;;;;eAaI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;;;;;;;;QAQ/B,CAAC;AACT,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,eAAe;IACxB,yEAAyE;IACzE,MAAM,CAAC,OAAO,GAA2B,EAAE,CAAC;IAE5C,IAAI,CAAC,GAAgB;QACjB,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAY,SAAS,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAS,MAAM,CAAC,CAAC;QAEjD,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC;QACxC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAC;QACrD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC;QAEzC,MAAM,IAAI,GAAmB;YACzB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,oBAAoB;YAC5C,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,OAAO;YACnC,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,UAAU,EAAE,OAAO,CAAC,UAAU;SACjC,CAAC;QAEF,MAAM,IAAI,GAAoB,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAE5D,sBAAsB;QACtB,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC/B,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,mBAAmB;QACnB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC7B,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACP,CAAC"}

package/dist/zod-to-schema.d.ts

@@ -0,0 +1,9 @@
+import type { ZodSchema } from "zod";
+/**
+ * Convert a Zod schema to an OpenAPI/JSON Schema object.
+ *
+ * Uses `zod-to-json-schema` (mature library — per the "don't reinvent"
+ * principle). The result is suitable for OpenAPI `schema` fields.
+ */
+export declare function zodSchemaToOpenApi(schema: ZodSchema, name?: string): Record<string, unknown>;
+//# sourceMappingURL=zod-to-schema.d.ts.map

package/dist/zod-to-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zod-to-schema.d.ts","sourceRoot":"","sources":["../src/zod-to-schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAGrC;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAqB5F"}

package/dist/zod-to-schema.js

@@ -0,0 +1,26 @@
+import { zodToJsonSchema } from "zod-to-json-schema";
+/**
+ * Convert a Zod schema to an OpenAPI/JSON Schema object.
+ *
+ * Uses `zod-to-json-schema` (mature library — per the "don't reinvent"
+ * principle). The result is suitable for OpenAPI `schema` fields.
+ */
+export function zodSchemaToOpenApi(schema, name) {
+    const resolvedName = name ?? "schema";
+    const json = zodToJsonSchema(schema, resolvedName);
+    // zod-to-json-schema wraps in { $schema, definitions, $ref }. Unwrap the
+    // top-level definition for a clean inline schema.
+    if (resolvedName && typeof json === "object" && json !== null) {
+        const defs = json.definitions;
+        const ref = json.$ref;
+        if (defs && ref) {
+            const key = ref.replace("#/definitions/", "");
+            const def = defs[key];
+            if (def && typeof def === "object") {
+                return def;
+            }
+        }
+    }
+    return json;
+}
+//# sourceMappingURL=zod-to-schema.js.map

package/dist/zod-to-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zod-to-schema.js","sourceRoot":"","sources":["../src/zod-to-schema.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAiB,EAAE,IAAa;IAC/D,MAAM,YAAY,GAAG,IAAI,IAAI,QAAQ,CAAC;IACtC,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAEnD,yEAAyE;IACzE,kDAAkD;IAClD,IAAI,YAAY,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC5D,MAAM,IAAI,GAAI,IAAgC,CAAC,WAEhC,CAAC;QAChB,MAAM,GAAG,GAAI,IAAgC,CAAC,IAA0B,CAAC;QACzE,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC;YACd,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;YAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACtB,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBACjC,OAAO,GAA8B,CAAC;YAC1C,CAAC;QACL,CAAC;IACL,CAAC;IAED,OAAO,IAA+B,CAAC;AAC3C,CAAC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@wild-framework/openapi",
+  "version": "0.2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "author": "Sphah",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KhandaSoftware/wild-framework.git"
+  },
+  "description": "Auto-generated OpenAPI 3.0 docs and Swagger UI for Wild Framework apps.",
+  "keywords": [
+    "wild",
+    "framework",
+    "openapi",
+    "swagger",
+    "docs",
+    "api"
+  ],
+  "dependencies": {
+    "zod": "^3.24.0",
+    "zod-to-json-schema": "^3.24.0",
+    "@wild-framework/core": "0.2.0",
+    "@wild-framework/container": "0.2.0",
+    "@wild-framework/http": "0.2.0",
+    "@wild-framework/config": "0.2.0"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "express": "^5.1.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "test": "vitest run"
+  }
+}