yedra 0.12.4 → 0.12.6

package/dist/routing/path.d.ts

@@ -14,8 +14,7 @@ export declare class Path {
      */
     constructor(path: string);
     /**
-     * Prepends this path with another path. This is equivalent to
-     * `new Path(prefix + path.toString()).
+     * Prepends this path with another path.
      * @param prefix - The prefix to prepend.
      * @returns The prefixed path.
      */

package/dist/routing/path.js

@@ -34,13 +34,12 @@ export class Path {
         }
     }
     /**
-     * Prepends this path with another path. This is equivalent to
-     * `new Path(prefix + path.toString()).
+     * Prepends this path with another path.
      * @param prefix - The prefix to prepend.
      * @returns The prefixed path.
      */
     withPrefix(prefix) {
-        return new Path(prefix + this.toString());
+        return new Path(`${prefix}/${this.expected.join('/')}`);
     }
     /**
      * Returns the path as a string. The segments are joined with `/`, and the
@@ -48,7 +47,7 @@ export class Path {
      * @returns The path as a string.
      */
     toString() {
-        return `/${this.expected.join('/')}`;
+        return `/${this.expected.map((segment) => (segment.startsWith(':') ? `{${segment.substring(1)}}` : segment)).join('/')}`;
     }
     /**
      * Match this API path to a string. If the string matches the path, this

package/dist/routing/rest.js

@@ -2,6 +2,7 @@ import { ValidationError } from '../validation/error.js';
 import { NoneBody, none } from '../validation/none.js';
 import { object } from '../validation/object.js';
 import { BadRequestError } from './errors.js';
+import { paramDocs } from '../util/docs.js';
 class RestEndpoint {
     constructor(method, options) {
         this._method = method;
@@ -116,17 +117,3 @@ export class Delete extends RestEndpoint {
         super('DELETE', { req: none(), ...options });
     }
 }
-const paramDocs = (params, position) => {
-    const result = [];
-    for (const name in params) {
-        const docs = params[name].documentation();
-        result.push({
-            name,
-            in: position,
-            description: 'description' in docs ? docs.description : undefined,
-            required: !params[name].isOptional(),
-            schema: docs,
-        });
-    }
-    return result;
-};

package/dist/routing/websocket.js

@@ -1,6 +1,7 @@
 import { ValidationError } from '../validation/error.js';
 import { object } from '../validation/object.js';
 import { BadRequestError } from './errors.js';
+import { paramDocs } from '../util/docs.js';
 export class WebSocketHandler {
     constructor(open) {
         this.messageCbs = [];
@@ -95,7 +96,40 @@ export class Ws {
         return undefined;
     }
     documentation() {
-        // TODO
-        return {};
+        const parameters = [
+            ...paramDocs(this.options.params, 'path'),
+            ...paramDocs(this.options.query, 'query'),
+        ];
+        return {
+            tags: [this.options.category],
+            summary: this.options.summary,
+            description: this.options.description,
+            parameters,
+            responses: {
+                '101': {
+                    description: 'Switching to WebSocket',
+                },
+                '400': {
+                    description: 'Upgrading to WebSocket failed',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'object',
+                                properties: {
+                                    status: {
+                                        type: 'number',
+                                        example: 400,
+                                    },
+                                    errorMessage: {
+                                        type: 'string',
+                                        example: 'Upgrading to WebSocket failed.',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        };
     }
 }

package/dist/util/docs.d.ts

@@ -0,0 +1,8 @@
+import type { Schema } from '../validation/schema.js';
+/**
+ * Generate OpenAPI documentation for parameters.
+ * @param params - Record of parameters.
+ * @param position - The position of the parameter, e.g. `path`, `query`, `header`. This is passed directly to OpenAPI.
+ * @returns A list of parameter documentations in OpenAPI format.
+ */
+export declare const paramDocs: <Params extends Record<string, Schema<unknown>>>(params: Params, position: string) => object[];

package/dist/util/docs.js

@@ -0,0 +1,20 @@
+/**
+ * Generate OpenAPI documentation for parameters.
+ * @param params - Record of parameters.
+ * @param position - The position of the parameter, e.g. `path`, `query`, `header`. This is passed directly to OpenAPI.
+ * @returns A list of parameter documentations in OpenAPI format.
+ */
+export const paramDocs = (params, position) => {
+    const result = [];
+    for (const name in params) {
+        const docs = params[name].documentation();
+        result.push({
+            name,
+            in: position,
+            description: 'description' in docs ? docs.description : undefined,
+            required: !params[name].isOptional(),
+            schema: docs,
+        });
+    }
+    return result;
+};

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "yedra",
-  "version": "0.12.4",
+  "version": "0.12.6",
   "repository": "github:0codekit/yedra",
   "main": "dist/index.js",
   "devDependencies": {
-    "@biomejs/biome": "^1.9.2",
+    "@biomejs/biome": "^1.9.3",
     "@types/bun": "^1.1.10",
-    "@types/node": "^22.6.1",
+    "@types/node": "^22.7.4",
     "@types/uuid": "^10.0.0",
     "typescript": "^5.6.2"
   },