@getsoda/core 0.2.1 → 0.3.0

package/dist/openapi/document.js

@@ -0,0 +1,135 @@
+/**
+ * @module
+ * Building an OpenAPI 3.1 document from the routes of an application.
+ *
+ * Schemas come from what validates requests: argument parsers (`int()`,
+ * `uuid()`...) and Standard Schemas implementing Standard JSON Schema, as zod
+ * does. Paths with optional parameters give one path per form, as OpenAPI has
+ * no optional path parameters; `@All()` routes are left out, OpenAPI has no
+ * such method.
+ */
+import { isStandardSchema } from '../http/schema.js';
+import { expandOptional, parsePath } from '../routing/path.js';
+import { KEYS } from './decorators.js';
+const METHODS = new Set(['GET', 'PUT', 'POST', 'DELETE', 'OPTIONS', 'HEAD', 'PATCH', 'TRACE']);
+const IN = { query: 'query', header: 'header', cookie: 'cookie' };
+const STRING = { type: 'string' };
+const FORM_TYPES = ['multipart/form-data', 'application/x-www-form-urlencoded'];
+/** JSON Schema of what a parser or schema accepts, `{}` when it cannot tell. */
+const toJsonSchema = (source) => {
+    if (source === undefined) {
+        return STRING;
+    }
+    if (!isStandardSchema(source)) {
+        return source.jsonSchema ?? STRING;
+    }
+    const converter = source['~standard'].jsonSchema;
+    if (converter === undefined) {
+        return {};
+    }
+    const { $schema: _, ...schema } = converter.input({ target: 'draft-2020-12' });
+    return schema;
+};
+/** A value may be missing when its parser says so, or its schema accepts `undefined`. */
+const isOptional = (source) => {
+    if (source === undefined) {
+        return true;
+    }
+    if (!isStandardSchema(source)) {
+        return source.optional === true;
+    }
+    const result = source['~standard'].validate(undefined);
+    return !(result instanceof Promise) && result.issues === undefined;
+};
+const toOpenApiPath = (segments) => `/${segments
+    .map((segment) => segment.type === 'static' ? decodeURIComponent(segment.value) : `{${segment.type === 'param' ? segment.name : (segment.name ?? 'wildcard')}}`)
+    .join('/')}`;
+const pathParameters = (segments, args) => {
+    const parameters = [];
+    for (const segment of segments) {
+        if (segment.type === 'static') {
+            continue;
+        }
+        const name = segment.type === 'param' ? segment.name : (segment.name ?? 'wildcard');
+        const declared = args.find((arg) => arg.kind === 'param' && arg.name === name);
+        const pattern = segment.type === 'param' && segment.pattern !== undefined ? { pattern: `^(?:${segment.pattern})$` } : {};
+        parameters.push({ name, in: 'path', required: true, schema: { ...toJsonSchema(declared?.source), ...pattern } });
+    }
+    return parameters;
+};
+const requestBody = (args) => {
+    const body = args.find((arg) => arg.kind === 'body');
+    if (body === undefined) {
+        return undefined;
+    }
+    const schema = body.source === undefined ? {} : toJsonSchema(body.source);
+    const types = body.multipart === true ? FORM_TYPES : ['application/json'];
+    return { required: !isOptional(body.source), content: Object.fromEntries(types.map((type) => [type, { schema }])) };
+};
+const responsesOf = (route) => {
+    const declared = route.info.metadata.get(KEYS.responses);
+    if (declared === undefined) {
+        return route.sse
+            ? { 200: { description: 'Event stream', content: { 'text/event-stream': { schema: STRING } } } }
+            : { [route.status]: { description: 'Success' } };
+    }
+    return Object.fromEntries(Object.entries(declared).map(([status, response]) => [
+        status,
+        response.schema === undefined
+            ? { description: response.description }
+            : { description: response.description, content: { 'application/json': { schema: toJsonSchema(response.schema) } } },
+    ]));
+};
+const operationOf = (route, segments, suffix) => {
+    const { info } = route;
+    const args = route.args ?? [];
+    const parameters = pathParameters(segments, args);
+    for (const arg of args) {
+        if (arg.kind === 'query' || arg.kind === 'header' || arg.kind === 'cookie') {
+            parameters.push({ name: arg.name, in: IN[arg.kind], required: !isOptional(arg.source), schema: toJsonSchema(arg.source) });
+        }
+    }
+    const options = info.metadata.get(KEYS.operation) ?? {};
+    const tags = info.metadata.get(KEYS.tags);
+    const body = requestBody(args);
+    return {
+        operationId: `${info.controller.name}_${info.handler}${suffix}`,
+        ...options,
+        ...(tags === undefined ? {} : { tags }),
+        ...(parameters.length === 0 ? {} : { parameters }),
+        ...(body === undefined ? {} : { requestBody: body }),
+        responses: responsesOf(route),
+        ...(info.metadata.get(KEYS.bearer) === true ? { security: [{ bearer: [] }] } : {}),
+    };
+};
+/** Adds the operations of `route` to `paths`, one per form of its path; `false` when it is left out. */
+const addRoute = (paths, route) => {
+    const { info } = route;
+    if (!METHODS.has(info.method) || info.metadata.get(KEYS.exclude) === true) {
+        return false;
+    }
+    for (const [index, segments] of expandOptional(info.path, parsePath(info.path)).entries()) {
+        const path = toOpenApiPath(segments);
+        paths[path] ??= {};
+        paths[path][info.method.toLowerCase()] = operationOf(route, segments, index === 0 ? '' : `_${index}`);
+    }
+    return true;
+};
+/** The OpenAPI document of `controllers`, as `inject(ROUTES).controllers` lists them. */
+export const createOpenApiDocument = (controllers, options) => {
+    const paths = {};
+    let bearer = false;
+    for (const controller of controllers) {
+        for (const route of controller.routes) {
+            bearer = (addRoute(paths, route) && route.info.metadata.get(KEYS.bearer) === true) || bearer;
+        }
+    }
+    return {
+        openapi: '3.1.0',
+        info: options.info,
+        ...(options.servers === undefined ? {} : { servers: options.servers }),
+        paths,
+        ...(bearer ? { components: { securitySchemes: { bearer: { type: 'http', scheme: 'bearer', bearerFormat: 'JWT' } } } } : {}),
+    };
+};
+//# sourceMappingURL=document.js.map

package/dist/openapi/document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.js","sourceRoot":"","sources":["../../src/openapi/document.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAKH,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAEpD,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9D,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAqCtC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;AAC9F,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAW,CAAA;AAC1E,MAAM,MAAM,GAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;AAC7C,MAAM,UAAU,GAAG,CAAC,qBAAqB,EAAE,mCAAmC,CAAC,CAAA;AAO/E,gFAAgF;AAChF,MAAM,YAAY,GAAG,CAAC,MAAmC,EAAc,EAAE;IACvE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,MAAM,CAAA;IACf,CAAC;IAED,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,OAAQ,MAA0B,CAAC,UAAU,IAAI,MAAM,CAAA;IACzD,CAAC;IAED,MAAM,SAAS,GAAI,MAAyB,CAAC,WAAW,CAAC,CAAC,UAAU,CAAA;IAEpE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,CAAA;IAE9E,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,yFAAyF;AACzF,MAAM,UAAU,GAAG,CAAC,MAAmC,EAAW,EAAE;IAClE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,OAAQ,MAA0B,CAAC,QAAQ,KAAK,IAAI,CAAA;IACtD,CAAC;IAED,MAAM,MAAM,GAAI,MAA2B,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;IAE5E,OAAO,CAAC,CAAC,MAAM,YAAY,OAAO,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,CAAA;AACpE,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,CAAC,QAA4B,EAAU,EAAE,CAC7D,IAAI,QAAQ;KACT,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACf,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,UAAU,CAAC,GAAG,CAC9I;KACA,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;AAEhB,MAAM,cAAc,GAAG,CAAC,QAA4B,EAAE,IAAkC,EAAsB,EAAE;IAC9G,MAAM,UAAU,GAAuB,EAAE,CAAA;IAEzC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC9B,SAAQ;QACV,CAAC;QAED,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,UAAU,CAAC,CAAA;QACnF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,OAAO,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;QAC9E,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,KAAK,OAAO,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QAExH,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,GAAG,OAAO,EAAE,EAAE,CAAC,CAAA;IAClH,CAAC;IAED,OAAO,UAAU,CAAA;AACnB,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,IAAkC,EAAmC,EAAE;IAC1F,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,CAAA;IAEpD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACzE,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAA;IAEzE,OAAO,EAAE,QAAQ,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;AACrH,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,KAAkB,EAAiC,EAAE;IACxE,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAA6D,CAAA;IAEpH,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC,GAAG;YACd,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,EAAE,mBAAmB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE;YAChG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,CAAA;IACpD,CAAC;IAED,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC;QACnD,MAAM;QACN,QAAQ,CAAC,MAAM,KAAK,SAAS;YAC3B,CAAC,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE;YACvC,CAAC,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE;KACtH,CAAC,CACH,CAAA;AACH,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,KAAkB,EAAE,QAA4B,EAAE,MAAc,EAAoB,EAAE;IACzG,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IACtB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAA;IAC7B,MAAM,UAAU,GAAG,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAEjD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3E,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QAC5H,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAqC,IAAI,EAAE,CAAA;IAC5F,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAkC,CAAA;IAC1E,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAA;IAE9B,OAAO;QACL,WAAW,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,GAAG,MAAM,EAAE;QAC/D,GAAG,OAAO;QACV,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;QACvC,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC;QAClD,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;QACpD,SAAS,EAAE,WAAW,CAAC,KAAK,CAAC;QAC7B,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACnF,CAAA;AACH,CAAC,CAAA;AAED,wGAAwG;AACxG,MAAM,QAAQ,GAAG,CAAC,KAAuD,EAAE,KAAkB,EAAW,EAAE;IACxG,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IAEtB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;QAC1E,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QAC1F,MAAM,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;QAEpC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;QAClB,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAA;IACvG,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED,yFAAyF;AACzF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,WAAwC,EAAE,OAAuB,EAAmB,EAAE;IAC1H,MAAM,KAAK,GAAqD,EAAE,CAAA;IAClE,IAAI,MAAM,GAAG,KAAK,CAAA;IAElB,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACtC,MAAM,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,IAAI,MAAM,CAAA;QAC9F,CAAC;IACH,CAAC;IAED,OAAO;QACL,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;QACtE,KAAK;QACL,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,eAAe,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5H,CAAA;AACH,CAAC,CAAA"}

package/dist/openapi/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @module
+ * OpenAPI documents of an application, and a Swagger UI page, as `@nestjs/swagger`.
+ */
+export { ApiBearerAuth, ApiExclude, ApiOperation, ApiResponses, ApiTags } from './decorators.ts';
+export type { ApiOperationOptions, ApiResponseOptions } from './decorators.ts';
+export { createOpenApiDocument } from './document.ts';
+export type { JsonSchema, OpenApiDocument, OpenApiOperation, OpenApiOptions, OpenApiParameter } from './document.ts';
+export { OpenApiModule } from './module.ts';
+export type { OpenApiModuleOptions } from './module.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/openapi/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAChG,YAAY,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAC9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAA;AACrD,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AACpH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,YAAY,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA"}

package/dist/openapi/index.js

@@ -0,0 +1,8 @@
+/**
+ * @module
+ * OpenAPI documents of an application, and a Swagger UI page, as `@nestjs/swagger`.
+ */
+export { ApiBearerAuth, ApiExclude, ApiOperation, ApiResponses, ApiTags } from './decorators.js';
+export { createOpenApiDocument } from './document.js';
+export { OpenApiModule } from './module.js';
+//# sourceMappingURL=index.js.map

package/dist/openapi/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/openapi/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAEhG,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAA;AAErD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA"}

package/dist/openapi/module.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @module
+ * `OpenApiModule`: serves the OpenAPI document of the application, and a
+ * Swagger UI page, as `SwaggerModule.setup()` of `@nestjs/swagger` does.
+ */
+import type { DynamicModule } from '../di/index.ts';
+import type { OpenApiOptions } from './document.ts';
+export interface OpenApiModuleOptions extends OpenApiOptions {
+    /** Path of the JSON document. Defaults to `/openapi.json`. */
+    readonly path?: string;
+    /** Path of a Swagger UI page reading the document, such as `/docs`. None by default. */
+    readonly ui?: string;
+}
+/**
+ * ```ts
+ * @Module({ imports: [OpenApiModule.forRoot({ info: { title: 'Shop', version: '1.0.0' }, ui: '/docs' })] })
+ * class AppModule {}
+ * ```
+ *
+ * The document is built on the first request, from every route of the
+ * application (these two excepted), and kept.
+ */
+export declare class OpenApiModule {
+    static forRoot(options: OpenApiModuleOptions): DynamicModule;
+}
+//# sourceMappingURL=module.d.ts.map

package/dist/openapi/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../src/openapi/module.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAKnD,OAAO,KAAK,EAAmB,cAAc,EAAE,MAAM,eAAe,CAAA;AAEpE,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IACtB,wFAAwF;IACxF,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CACrB;AAqBD;;;;;;;;GAQG;AACH,qBACa,aAAa;IACxB,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,oBAAoB,GAAG,aAAa,CA0C3D;CACF"}

package/dist/openapi/module.js

@@ -0,0 +1,73 @@
+/**
+ * @module
+ * `OpenApiModule`: serves the OpenAPI document of the application, and a
+ * Swagger UI page, as `SwaggerModule.setup()` of `@nestjs/swagger` does.
+ */
+import { inject, Module } from '../di/index.js';
+import { Controller, Get } from '../http/decorators.js';
+import { ROUTES } from '../http/routes.js';
+import { ApiExclude } from './decorators.js';
+import { createOpenApiDocument } from './document.js';
+/** Swagger UI, from a CDN at a fixed version. */
+const SWAGGER_UI = 'https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.34.0';
+const page = (title, documentUrl) => `<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<title>${Bun.escapeHTML(title)}</title>
+<link rel="stylesheet" href="${SWAGGER_UI}/swagger-ui.css">
+</head>
+<body>
+<div id="docs"></div>
+<script src="${SWAGGER_UI}/swagger-ui-bundle.js" crossorigin></script>
+<script>SwaggerUIBundle({ url: ${JSON.stringify(documentUrl)}, dom_id: '#docs' })</script>
+</body>
+</html>
+`;
+/**
+ * ```ts
+ * @Module({ imports: [OpenApiModule.forRoot({ info: { title: 'Shop', version: '1.0.0' }, ui: '/docs' })] })
+ * class AppModule {}
+ * ```
+ *
+ * The document is built on the first request, from every route of the
+ * application (these two excepted), and kept.
+ */
+@Module({})
+export class OpenApiModule {
+    static forRoot(options) {
+        const documentPath = options.path ?? '/openapi.json';
+        @Controller()
+        @ApiExclude()
+        class OpenApiController {
+            #routes = inject(ROUTES);
+            #document;
+            @Get(documentPath)
+            document() {
+                this.#document ??= createOpenApiDocument(this.#routes.controllers, options);
+                return this.#document;
+            }
+        }
+        const controllers = [OpenApiController];
+        if (options.ui !== undefined) {
+            const ui = options.ui;
+            @Controller()
+            @ApiExclude()
+            class OpenApiUiController {
+                #routes = inject(ROUTES);
+                @Get(ui)
+                page() {
+                    // The document's own path, global prefix included.
+                    const documentUrl = this.#routes.controllers.find((mapped) => mapped.controller === OpenApiController)?.routes[0]?.info.path;
+                    return new Response(page(options.info.title, documentUrl ?? documentPath), {
+                        headers: { 'content-type': 'text/html;charset=utf-8' },
+                    });
+                }
+            }
+            controllers.push(OpenApiUiController);
+        }
+        return { module: OpenApiModule, controllers };
+    }
+}
+//# sourceMappingURL=module.js.map

package/dist/openapi/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/openapi/module.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAE/C,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAA;AAUrD,iDAAiD;AACjD,MAAM,UAAU,GAAG,qDAAqD,CAAA;AAExE,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,WAAmB,EAAU,EAAE,CAAC;;;;;SAKpD,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC;+BACC,UAAU;;;;eAI1B,UAAU;iCACQ,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;;;CAG3D,CAAA;AAED;;;;;;;;GAQG;AACH,CAAC,MAAM,CAAC,EAAE,CAAC;AACX,MAAM,OAAO,aAAa;IACxB,MAAM,CAAC,OAAO,CAAC,OAA6B;QAC1C,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,IAAI,eAAe,CAAA;QAEpD,CAAC,UAAU,EAAE;QACb,CAAC,UAAU,EAAE;cACP,iBAAiB;YACZ,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;YACjC,SAAS,CAA6B;YAEtC,CAAC,GAAG,CAAC,YAAY,CAAC;YAClB,QAAQ;gBACN,IAAI,CAAC,SAAS,KAAK,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,CAAA;gBAE3E,OAAO,IAAI,CAAC,SAAS,CAAA;YACvB,CAAC;SACF;QAED,MAAM,WAAW,GAA0B,CAAC,iBAAiB,CAAC,CAAA;QAE9D,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAA;YAErB,CAAC,UAAU,EAAE;YACb,CAAC,UAAU,EAAE;kBACP,mBAAmB;gBACd,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;gBAEjC,CAAC,GAAG,CAAC,EAAE,CAAC;gBACR,IAAI;oBACF,mDAAmD;oBACnD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,KAAK,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAA;oBAE5H,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,IAAI,YAAY,CAAC,EAAE;wBACzE,OAAO,EAAE,EAAE,cAAc,EAAE,yBAAyB,EAAE;qBACvD,CAAC,CAAA;gBACJ,CAAC;aACF;YAED,WAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QACvC,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,CAAA;IAC/C,CAAC;CACF"}

package/dist/routing/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/routing/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,gBAAgB,GAAG,UAAU,GAAG,aAAa,CAAA;AAErF;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,KAAK;IAIjC,QAAQ,CAAC,IAAI,EAAE,cAAc;IAH/B,SAAkB,IAAI,gBAAe;IAErC,YACW,IAAI,EAAE,cAAc,EAC7B,OAAO,EAAE,MAAM,EAGhB;CACF"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/routing/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,gBAAgB,GAAG,UAAU,GAAG,aAAa,CAAA;AAErF;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,KAAK;IAIjC,QAAQ,CAAC,IAAI,EAAE,cAAc;IAH/B,SAAkB,IAAI,gBAAe;IAErC,YACW,IAAI,EAAE,cAAc,EAC7B,OAAO,EAAE,MAAM,EAIhB;CACF"}

package/dist/routing/errors.js

@@ -2,6 +2,7 @@
  * @module
  * Errors raised by the route compiler.
  */
+import { hideFrameworkFrames } from '../utils/errors.js';
 /**
  * Error thrown by `compileRoutes`.
  *
@@ -13,6 +14,7 @@ export class RouteError extends Error {
     constructor(code, message) {
         super(message);
         this.code = code;
+        hideFrameworkFrames(this);
     }
 }
 //# sourceMappingURL=errors.js.map

package/dist/routing/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/routing/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH;;;;GAIG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IAIxB,IAAI;IAHG,IAAI,GAAG,YAAY,CAAA;IAErC,YACW,IAAoB,EAC7B,OAAe;QAEf,KAAK,CAAC,OAAO,CAAC,CAAA;oBAHL,IAAI;IAIf,CAAC;CACF"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/routing/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAYxD;;;;GAIG;AACH,MAAM,OAAO,UAAW,SAAQ,KAAK;IAIxB,IAAI;IAHG,IAAI,GAAG,YAAY,CAAA;IAErC,YACW,IAAoB,EAC7B,OAAe;QAEf,KAAK,CAAC,OAAO,CAAC,CAAA;oBAHL,IAAI;QAIb,mBAAmB,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;CACF"}

package/dist/testing/index.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @module
+ * Testing an application over HTTP, as Nest's `Test.createTestingModule()`
+ * with supertest does, on a real Bun server bound to a free port.
+ *
+ * ```ts
+ * import { createTestApp } from '@getsoda/core/testing'
+ *
+ * const app = await createTestApp(AppModule, {
+ *   overrides: [provide(UsersRepository, { useValue: new MemoryUsersRepository() })],
+ * })
+ *
+ * afterAll(() => app.close())
+ *
+ * test('creates a user', async () => {
+ *   const response = await app.request('/users', { method: 'POST', json: { name: 'Bo' } })
+ *
+ *   expect(response.status).toBe(201)
+ * })
+ * ```
+ *
+ * A single service needs no server: `createContainer(Module, { overrides })`.
+ */
+import type { App, AppOptions } from '../app/app.ts';
+import type { ModuleImport, Token } from '../di/index.ts';
+export interface TestRequestInit extends RequestInit {
+    /** Sent as the JSON body, with `Content-Type: application/json`. */
+    readonly json?: unknown;
+}
+/** A started application, closed by `close()` or at the end of an `await using` block. */
+export interface TestApp extends AsyncDisposable {
+    readonly app: App;
+    /** Where the application listens, on a free port of localhost. */
+    readonly url: URL;
+    /** `app.container.get()`: a provider as the root module sees it. */
+    get<T>(token: Token<T>): T;
+    /** Sends a request to `path`, relative to the application. */
+    request(path: string, init?: TestRequestInit): Promise<Response>;
+    close(): Promise<void>;
+}
+/**
+ * Creates `root` and serves it on a free port. Options are those of
+ * `createApp`: `overrides` replace providers; the logger is silent unless one is given.
+ */
+export declare const createTestApp: (root: ModuleImport, options?: AppOptions) => Promise<TestApp>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAEzD,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,oEAAoE;IACpE,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,0FAA0F;AAC1F,MAAM,WAAW,OAAQ,SAAQ,eAAe;IAC9C,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;IACjB,kEAAkE;IAClE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;IACjB,oEAAoE;IACpE,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;IAC1B,8DAA8D;IAC9D,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAChE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACvB;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,SAAgB,YAAY,YAAW,UAAU,KAAQ,OAAO,CAAC,OAAO,CAuBjG,CAAA"}

package/dist/testing/index.js

@@ -0,0 +1,49 @@
+/**
+ * @module
+ * Testing an application over HTTP, as Nest's `Test.createTestingModule()`
+ * with supertest does, on a real Bun server bound to a free port.
+ *
+ * ```ts
+ * import { createTestApp } from '@getsoda/core/testing'
+ *
+ * const app = await createTestApp(AppModule, {
+ *   overrides: [provide(UsersRepository, { useValue: new MemoryUsersRepository() })],
+ * })
+ *
+ * afterAll(() => app.close())
+ *
+ * test('creates a user', async () => {
+ *   const response = await app.request('/users', { method: 'POST', json: { name: 'Bo' } })
+ *
+ *   expect(response.status).toBe(201)
+ * })
+ * ```
+ *
+ * A single service needs no server: `createContainer(Module, { overrides })`.
+ */
+import { createApp } from '../app/app.js';
+/**
+ * Creates `root` and serves it on a free port. Options are those of
+ * `createApp`: `overrides` replace providers; the logger is silent unless one is given.
+ */
+export const createTestApp = async (root, options = {}) => {
+    const app = await createApp(root, { logger: false, ...options });
+    const server = await app.listen({ port: 0, hostname: '127.0.0.1' });
+    const close = () => app.close();
+    return {
+        app,
+        url: server.url,
+        get: (token) => app.container.get(token),
+        request: (path, { json, ...init } = {}) => {
+            if (json === undefined) {
+                return fetch(new URL(path, server.url), init);
+            }
+            const headers = new Headers(init.headers);
+            headers.set('content-type', 'application/json');
+            return fetch(new URL(path, server.url), { ...init, headers, body: JSON.stringify(json) });
+        },
+        close,
+        [Symbol.asyncDispose]: close,
+    };
+};
+//# sourceMappingURL=index.js.map

package/dist/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAqBzC;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAAE,IAAkB,EAAE,OAAO,GAAe,EAAE,EAAoB,EAAE;IACpG,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAA;IAChE,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAA;IACnE,MAAM,KAAK,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,CAAA;IAE/B,OAAO;QACL,GAAG;QACH,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC;QACxC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE;YACxC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,OAAO,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA;YAC/C,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAEzC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAA;YAE/C,OAAO,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC3F,CAAC;QACD,KAAK;QACL,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,KAAK;KAC7B,CAAA;AACH,CAAC,CAAA"}

package/dist/utils/errors.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @module
+ * Error utilities.
+ */
+/**
+ * Removes the frames of the framework from the stack of an error about the
+ * application's code (a missing provider, an invalid route): the runtime then
+ * points at the application, not at the framework, and the message says the rest.
+ */
+export declare const hideFrameworkFrames: (error: Error) => void;
+//# sourceMappingURL=errors.d.ts.map

package/dist/utils/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,UAAW,KAAK,KAAG,IASlD,CAAA"}

package/dist/utils/errors.js

@@ -0,0 +1,22 @@
+/**
+ * @module
+ * Error utilities.
+ */
+import { fileURLToPath } from 'node:url';
+/** Where the framework's own files are: `src/` from sources, `dist/` once built. */
+const FRAMEWORK = fileURLToPath(new URL('../', import.meta.url));
+/**
+ * Removes the frames of the framework from the stack of an error about the
+ * application's code (a missing provider, an invalid route): the runtime then
+ * points at the application, not at the framework, and the message says the rest.
+ */
+export const hideFrameworkFrames = (error) => {
+    if (error.stack === undefined) {
+        return;
+    }
+    error.stack = error.stack
+        .split('\n')
+        .filter((line) => !(line.trimStart().startsWith('at ') && line.includes(FRAMEWORK)))
+        .join('\n');
+};
+//# sourceMappingURL=errors.js.map

package/dist/utils/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/utils/errors.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,oFAAoF;AACpF,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,KAAK,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;AAEhE;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,KAAY,EAAQ,EAAE;IACxD,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAM;IACR,CAAC;IAED,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK;SACtB,KAAK,CAAC,IAAI,CAAC;SACX,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;SACnF,IAAI,CAAC,IAAI,CAAC,CAAA;AACf,CAAC,CAAA"}

package/dist/utils/object.d.ts

@@ -11,4 +11,8 @@
  * ```
  */
 export declare const createNullObject: <T extends object>() => T;
+/**
+ * Public method names along the prototype chain, most derived first, without duplicates.
+ */
+export declare const methodNames: (instance: object) => string[];
 //# sourceMappingURL=object.d.ts.map

package/dist/utils/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/utils/object.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,SAAS,MAAM,OAAK,CAA6B,CAAA"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/utils/object.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAAI,CAAC,SAAS,MAAM,OAAK,CAA6B,CAAA;AAEnF;;GAEG;AACH,eAAO,MAAM,WAAW,aAAc,MAAM,KAAG,MAAM,EAkBpD,CAAA"}

package/dist/utils/object.js

@@ -11,4 +11,20 @@
  * ```
  */
 export const createNullObject = () => Object.create(null);
+/**
+ * Public method names along the prototype chain, most derived first, without duplicates.
+ */
+export const methodNames = (instance) => {
+    const names = [];
+    const seen = new Set(['constructor']);
+    for (let prototype = Object.getPrototypeOf(instance); prototype !== null && prototype !== Object.prototype; prototype = Object.getPrototypeOf(prototype)) {
+        for (const name of Object.getOwnPropertyNames(prototype)) {
+            if (!seen.has(name)) {
+                seen.add(name);
+                names.push(name);
+            }
+        }
+    }
+    return names;
+};
 //# sourceMappingURL=object.js.map

package/dist/utils/object.js.map

@@ -1 +1 @@
-{"version":3,"file":"object.js","sourceRoot":"","sources":["../../src/utils/object.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAwB,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAM,CAAA"}
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../src/utils/object.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAwB,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAM,CAAA;AAEnF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAY,EAAE;IACxD,MAAM,KAAK,GAAa,EAAE,CAAA;IAC1B,MAAM,IAAI,GAAG,IAAI,GAAG,CAAS,CAAC,aAAa,CAAC,CAAC,CAAA;IAE7C,KACE,IAAI,SAAS,GAAkB,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,EAC9D,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,MAAM,CAAC,SAAS,EACpD,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,EAC5C,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC;YACzD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;gBACd,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAClB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA"}

package/dist/websocket/decorators.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @module
+ * Decorators of WebSocket gateways, as in `@nestjs/websockets`.
+ */
+import type { Constructor } from '../di/index.ts';
+/**
+ * Declares a gateway: WebSocket connections upgraded from `GET path`. List it
+ * in the `controllers` of its module: like a controller, it is an entry point
+ * the framework creates, and its guards run on the handshake.
+ *
+ * ```ts
+ * @WebSocketGateway('/chat')
+ * @UseGuards(JwtGuard)
+ * class ChatGateway {
+ *   @SubscribeMessage('message')
+ *   message(data: unknown, socket: GatewaySocket) {
+ *     return { event: 'message', data }
+ *   }
+ * }
+ * ```
+ */
+export declare const WebSocketGateway: (path: string) => (target: Constructor<unknown>, _context: ClassDecoratorContext<Constructor<unknown>>) => void;
+/**
+ * Handles the frames `{ "event": event, "data": ... }` of a gateway. The
+ * method receives `(data, socket)`; what it returns, unless `undefined`, is
+ * sent back as JSON.
+ */
+export declare const SubscribeMessage: (event: string) => <This, M extends (this: This, ...args: any[]) => unknown>(method: M, context: ClassMethodDecoratorContext<This, M>) => void;
+export declare const getGatewayPath: (target: Constructor<unknown>) => string | undefined;
+export declare const getSubscribedEvent: (method: object) => string | undefined;
+//# sourceMappingURL=decorators.d.ts.map

package/dist/websocket/decorators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../src/websocket/decorators.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAMjD;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,gBAAgB,SACpB,MAAM,cACJ,WAAW,CAAC,OAAO,CAAC,YAAY,qBAAqB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAG,IAMtF,CAAA;AAEH;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,UACnB,MAAM,MACb,IAAI,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,UAAU,CAAC,WAAW,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC,KAAG,IAMpH,CAAA;AAEH,eAAO,MAAM,cAAc,WAAY,WAAW,CAAC,OAAO,CAAC,KAAG,MAAM,GAAG,SAAiC,CAAA;AAExG,eAAO,MAAM,kBAAkB,WAAY,MAAM,KAAG,MAAM,GAAG,SAA+B,CAAA"}

package/dist/websocket/decorators.js

@@ -0,0 +1,43 @@
+/**
+ * @module
+ * Decorators of WebSocket gateways, as in `@nestjs/websockets`.
+ */
+import { ControllerError } from '../http/errors.js';
+const gateways = new WeakMap();
+const events = new WeakMap();
+/**
+ * Declares a gateway: WebSocket connections upgraded from `GET path`. List it
+ * in the `controllers` of its module: like a controller, it is an entry point
+ * the framework creates, and its guards run on the handshake.
+ *
+ * ```ts
+ * @WebSocketGateway('/chat')
+ * @UseGuards(JwtGuard)
+ * class ChatGateway {
+ *   @SubscribeMessage('message')
+ *   message(data: unknown, socket: GatewaySocket) {
+ *     return { event: 'message', data }
+ *   }
+ * }
+ * ```
+ */
+export const WebSocketGateway = (path) => (target, _context) => {
+    if (!path.startsWith('/') || /[:*?]/.test(path)) {
+        throw new ControllerError('INVALID_PATH', `@WebSocketGateway('${path}'): a gateway path is static and starts with "/"`);
+    }
+    gateways.set(target, path);
+};
+/**
+ * Handles the frames `{ "event": event, "data": ... }` of a gateway. The
+ * method receives `(data, socket)`; what it returns, unless `undefined`, is
+ * sent back as JSON.
+ */
+export const SubscribeMessage = (event) => (method, context) => {
+    if (context.static || context.private) {
+        throw new ControllerError('INVALID_HANDLER', `@SubscribeMessage('${event}') must decorate a public instance method`);
+    }
+    events.set(method, event);
+};
+export const getGatewayPath = (target) => gateways.get(target);
+export const getSubscribedEvent = (method) => events.get(method);
+//# sourceMappingURL=decorators.js.map

package/dist/websocket/decorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/websocket/decorators.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD,MAAM,QAAQ,GAAG,IAAI,OAAO,EAAgC,CAAA;AAC5D,MAAM,MAAM,GAAG,IAAI,OAAO,EAAkB,CAAA;AAE5C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAC3B,CAAC,IAAY,EAAE,EAAE,CACjB,CAAC,MAA4B,EAAE,QAAqD,EAAQ,EAAE;IAC5F,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,eAAe,CAAC,cAAc,EAAE,sBAAsB,IAAI,kDAAkD,CAAC,CAAA;IACzH,CAAC;IAED,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;AAC5B,CAAC,CAAA;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAC3B,CAAC,KAAa,EAAE,EAAE,CAClB,CAA0D,MAAS,EAAE,OAA6C,EAAQ,EAAE;IAC1H,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,MAAM,IAAI,eAAe,CAAC,iBAAiB,EAAE,sBAAsB,KAAK,2CAA2C,CAAC,CAAA;IACtH,CAAC;IAED,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAC3B,CAAC,CAAA;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAA4B,EAAsB,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;AAExG,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,MAAc,EAAsB,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA"}