@furystack/rest-service 12.2.0 → 12.3.0

package/src/swagger/generate-swagger-json.spec.ts

@@ -1,6 +1,6 @@
 import type { ApiEndpointSchema, ParameterObject, ReferenceObject, ResponseObject } from '@furystack/rest'
 import { describe, expect, it } from 'vitest'
-import { generateSwaggerJsonFromApiSchema } from './generate-swagger-json.js'
+import { generateSwaggerJsonFromApiSchema } from '../openapi/generate-openapi-document.js'
 
 describe('generateSwaggerJsonFromApiSchema', () => {
   it('Should generate a basic Swagger document with correct OpenAPI structure', () => {

package/src/validate.integration.spec.ts

@@ -3,7 +3,7 @@ import { getStoreManager, InMemoryStore, User } from '@furystack/core'
 import { getPort } from '@furystack/core/port-generator'
 import { Injector } from '@furystack/inject'
 import { getRepository } from '@furystack/repository'
-import type { SwaggerDocument, WithSchemaAction } from '@furystack/rest'
+import type { OpenApiDocument, WithSchemaAction } from '@furystack/rest'
 import { createClient, ResponseError } from '@furystack/rest-client-fetch'
 import { usingAsync } from '@furystack/utils'
 import type Ajv from 'ajv'
@@ -14,7 +14,7 @@ import { createGetEntityEndpoint } from './endpoint-generators/create-get-entity
 import { createPatchEndpoint } from './endpoint-generators/create-patch-endpoint.js'
 import { createPostEndpoint } from './endpoint-generators/create-post-endpoint.js'
 import { MockClass } from './endpoint-generators/utils.js'
-import { useRestService } from './helpers.js'
+import { useHttpAuthentication, useRestService } from './helpers.js'
 import { DefaultSession } from './models/default-session.js'
 import { JsonResult } from './request-action-implementation.js'
 import type { ValidationApi } from './validate.integration.schema.js'
@@ -109,24 +109,23 @@ const createValidateApi = async (options = { enableGetSchema: false }) => {
 }
 
 describe('Validation integration tests', () => {
-  describe('swagger.json schema definition', () => {
-    it('Should include name, description and version in the generated swagger.json', async () => {
+  describe('openapi.json schema definition', () => {
+    it('Should include name, description and version in the generated openapi.json', async () => {
       await usingAsync(await createValidateApi({ enableGetSchema: true }), async ({ client }) => {
         const result = await (client as ReturnType<typeof createClient<any>>)({
           method: 'GET',
-          action: '/swagger.json',
+          action: '/openapi.json',
         })
 
         expect(result.response.status).toBe(200)
         expect(result.result).toBeDefined()
 
-        // Verify swagger document structure
-        const swaggerJson = result.result as SwaggerDocument
-        expect(swaggerJson.openapi).toBe('3.1.0')
-        expect(swaggerJson.info).toBeDefined()
-        expect(swaggerJson.info?.title).toBe(name)
-        expect(swaggerJson.info?.description).toBe(description)
-        expect(swaggerJson.info?.version).toBe(version)
+        const openApiDoc = result.result as OpenApiDocument
+        expect(openApiDoc.openapi).toBe('3.1.0')
+        expect(openApiDoc.info).toBeDefined()
+        expect(openApiDoc.info?.title).toBe(name)
+        expect(openApiDoc.info?.description).toBe(description)
+        expect(openApiDoc.info?.version).toBe(version)
       })
     })
 
@@ -135,7 +134,7 @@ describe('Validation integration tests', () => {
         try {
           await (client as ReturnType<typeof createClient<any>>)({
             method: 'GET',
-            action: '/swagger.json',
+            action: '/openapi.json',
           })
           expect.fail('Expected response error but got success')
         } catch (error) {
@@ -145,44 +144,89 @@ describe('Validation integration tests', () => {
       })
     })
 
-    it('Should return a generated swagger.json when enabled', async () => {
+    it('Should return a generated openapi.json when enabled', async () => {
       await usingAsync(await createValidateApi({ enableGetSchema: true }), async ({ client }) => {
         const result = await (client as ReturnType<typeof createClient<any>>)({
           method: 'GET',
-          action: '/swagger.json',
+          action: '/openapi.json',
         })
 
         expect(result.response.status).toBe(200)
         expect(result.result).toBeDefined()
 
-        // Verify swagger document structure
-        const swaggerJson = result.result as SwaggerDocument
-        expect(swaggerJson.openapi).toBe('3.1.0')
-        expect(swaggerJson.info).toBeDefined()
-        expect(swaggerJson.info?.title).toBe(name)
-        expect(swaggerJson.info?.description).toBe(description)
-        expect(swaggerJson.info?.version).toBe(version)
-        expect(swaggerJson.paths).toBeDefined()
+        const openApiDoc = result.result as OpenApiDocument
+        expect(openApiDoc.openapi).toBe('3.1.0')
+        expect(openApiDoc.info).toBeDefined()
+        expect(openApiDoc.info?.title).toBe(name)
+        expect(openApiDoc.info?.description).toBe(description)
+        expect(openApiDoc.info?.version).toBe(version)
+        expect(openApiDoc.paths).toBeDefined()
 
         // Verify our API endpoints are included
-        expect(swaggerJson.paths?.['/validate-query']).toBeDefined()
-        expect(swaggerJson.paths?.['/validate-url/{id}']).toBeDefined()
-        expect(swaggerJson.paths?.['/validate-headers']).toBeDefined()
-        expect(swaggerJson.paths?.['/validate-body']).toBeDefined()
+        expect(openApiDoc.paths?.['/validate-query']).toBeDefined()
+        expect(openApiDoc.paths?.['/validate-url/{id}']).toBeDefined()
+        expect(openApiDoc.paths?.['/validate-headers']).toBeDefined()
+        expect(openApiDoc.paths?.['/validate-body']).toBeDefined()
 
         // Verify components section
-        expect(swaggerJson.components).toBeDefined()
-        expect(swaggerJson.components?.schemas).toBeDefined()
-        expect(swaggerJson.components?.schemas?.ValidateQuery).toBeDefined()
-        expect(swaggerJson.components?.schemas?.ValidateUrl).toBeDefined()
-        expect(swaggerJson.components?.schemas?.ValidateHeaders).toBeDefined()
-        expect(swaggerJson.components?.schemas?.ValidateBody).toBeDefined()
+        expect(openApiDoc.components).toBeDefined()
+        expect(openApiDoc.components?.schemas).toBeDefined()
+        expect(openApiDoc.components?.schemas?.ValidateQuery).toBeDefined()
+        expect(openApiDoc.components?.schemas?.ValidateUrl).toBeDefined()
+        expect(openApiDoc.components?.schemas?.ValidateHeaders).toBeDefined()
+        expect(openApiDoc.components?.schemas?.ValidateBody).toBeDefined()
+      })
+    })
+  })
+
+  describe('swagger.json backward compatibility', () => {
+    it('Should serve the same OpenAPI document at /swagger.json when enabled', async () => {
+      await usingAsync(await createValidateApi({ enableGetSchema: true }), async ({ client }) => {
+        const result = await (client as ReturnType<typeof createClient<any>>)({
+          method: 'GET',
+          action: '/swagger.json',
+        })
+
+        expect(result.response.status).toBe(200)
+        expect(result.result).toBeDefined()
+
+        const openApiDoc = result.result as OpenApiDocument
+        expect(openApiDoc.openapi).toBe('3.1.0')
+        expect(openApiDoc.info?.title).toBe(name)
+      })
+    })
+
+    it('Should include Deprecation header on /swagger.json', async () => {
+      await usingAsync(await createValidateApi({ enableGetSchema: true }), async ({ client }) => {
+        const result = await (client as ReturnType<typeof createClient<any>>)({
+          method: 'GET',
+          action: '/swagger.json',
+        })
+
+        expect(result.response.headers.get('deprecation')).toBe('true')
+        expect(result.response.headers.get('link')).toContain('/openapi.json')
+      })
+    })
+
+    it('Should return a 404 for /swagger.json when not enabled', async () => {
+      await usingAsync(await createValidateApi({ enableGetSchema: false }), async ({ client }) => {
+        try {
+          await (client as ReturnType<typeof createClient<any>>)({
+            method: 'GET',
+            action: '/swagger.json',
+          })
+          expect.fail('Expected response error but got success')
+        } catch (error) {
+          expect(error).toBeInstanceOf(ResponseError)
+          expect((error as ResponseError).response.status).toBe(404)
+        }
       })
     })
   })
 
   describe('Validation metadata', () => {
     it('Should return 404 when not enabled', async () => {
+      expect.assertions(2)
       await usingAsync(await createValidateApi({ enableGetSchema: false }), async ({ client }) => {
         try {
           await (client as ReturnType<typeof createClient<WithSchemaAction<ValidationApi>>>)({
@@ -192,6 +236,7 @@ describe('Validation integration tests', () => {
               accept: 'application/schema+json',
             },
           })
+          expect.fail('Expected response error but got success')
         } catch (error) {
           expect(error).toBeInstanceOf(ResponseError)
           expect((error as ResponseError).response.status).toBe(404)
@@ -444,4 +489,110 @@ describe('Validation integration tests', () => {
       })
     })
   })
+
+  describe('OpenAPI security schemes from authentication providers', () => {
+    const createApiWithAuth = async () => {
+      const injector = new Injector()
+      const port = getPort()
+
+      getStoreManager(injector).addStore(new InMemoryStore({ model: User, primaryKey: 'username' }))
+      getStoreManager(injector).addStore(new InMemoryStore({ model: DefaultSession, primaryKey: 'sessionId' }))
+      getStoreManager(injector).addStore(new InMemoryStore({ model: MockClass, primaryKey: 'id' }))
+      getRepository(injector).createDataSet(MockClass, 'id')
+      getRepository(injector).createDataSet(User, 'username')
+      getRepository(injector).createDataSet(DefaultSession, 'sessionId')
+
+      useHttpAuthentication(injector)
+
+      await useRestService<ValidationApi>({
+        injector,
+        enableGetSchema: true,
+        name,
+        description,
+        version,
+        api: {
+          GET: {
+            '/validate-query': Validate({ schema, schemaName: 'ValidateQuery' })(async ({ getQuery }) =>
+              JsonResult({ ...getQuery() }),
+            ),
+            '/validate-url/:id': Validate({ schema, schemaName: 'ValidateUrl' })(async ({ getUrlParams }) =>
+              JsonResult({ ...getUrlParams() }),
+            ),
+            '/validate-headers': Validate({ schema, schemaName: 'ValidateHeaders' })(async ({ headers }) =>
+              JsonResult({ ...headers }),
+            ),
+            '/mock': Validate({ schema, schemaName: 'GetMockCollectionEndpoint' })(
+              createGetCollectionEndpoint({ model: MockClass, primaryKey: 'id' }),
+            ),
+            '/mock/:id': Validate({ schema, schemaName: 'GetMockEntityEndpoint' })(
+              createGetEntityEndpoint({ model: MockClass, primaryKey: 'id' }),
+            ),
+          },
+          POST: {
+            '/validate-body': Validate({ schema, schemaName: 'ValidateBody' })(async ({ getBody }) => {
+              const body = await getBody()
+              return JsonResult({ ...body })
+            }),
+            '/mock': Validate({ schema, schemaName: 'PostMockEndpoint' })(
+              createPostEndpoint({ model: MockClass, primaryKey: 'id' }),
+            ),
+          },
+          PATCH: {
+            '/mock/:id': Validate({ schema, schemaName: 'PatchMockEndpoint' })(
+              createPatchEndpoint({ model: MockClass, primaryKey: 'id' }),
+            ),
+          },
+          DELETE: {
+            '/mock/:id': Validate({ schema, schemaName: 'DeleteMockEndpoint' })(
+              createDeleteEndpoint({ model: MockClass, primaryKey: 'id' }),
+            ),
+          },
+        },
+        port,
+        root: '/api',
+      })
+      const client = createClient<ValidationApi>({ endpointUrl: `http://127.0.0.1:${port}/api` })
+
+      return {
+        [Symbol.asyncDispose]: injector[Symbol.asyncDispose].bind(injector),
+        injector,
+        client,
+      }
+    }
+
+    it('Should include detected security schemes in the OpenAPI document', async () => {
+      await usingAsync(await createApiWithAuth(), async ({ client }) => {
+        const result = await (client as ReturnType<typeof createClient<any>>)({
+          method: 'GET',
+          action: '/openapi.json',
+        })
+
+        const openApiDoc = result.result as OpenApiDocument
+        expect(openApiDoc.components?.securitySchemes).toBeDefined()
+        expect(openApiDoc.components?.securitySchemes?.basicAuth).toEqual({ type: 'http', scheme: 'basic' })
+        expect(openApiDoc.components?.securitySchemes?.cookieAuth).toEqual({
+          type: 'apiKey',
+          in: 'cookie',
+          name: 'session',
+        })
+      })
+    })
+
+    it('Should include detected security schemes in the deprecated /swagger.json endpoint', async () => {
+      await usingAsync(await createApiWithAuth(), async ({ client }) => {
+        const result = await (client as ReturnType<typeof createClient<any>>)({
+          method: 'GET',
+          action: '/swagger.json',
+        })
+
+        const openApiDoc = result.result as OpenApiDocument
+        expect(openApiDoc.components?.securitySchemes?.basicAuth).toEqual({ type: 'http', scheme: 'basic' })
+        expect(openApiDoc.components?.securitySchemes?.cookieAuth).toEqual({
+          type: 'apiKey',
+          in: 'cookie',
+          name: 'session',
+        })
+      })
+    })
+  })
 })

package/esm/endpoint-generators/create-get-swagger-json-action.d.ts

@@ -1,14 +0,0 @@
-import { type ApiEndpointSchema, type SwaggerDocument } from '@furystack/rest';
-import type { RestApiImplementation } from '../api-manager.js';
-import { type RequestAction } from '../request-action-implementation.js';
-export type GetSchemaResult = ApiEndpointSchema['endpoints'];
-/**
- * Generates a RequestAction that retrieves the Swagger JSON schema from a FuryStack API implementation.
- *
- * @param api - The API implementation from which to extract the schema.
- * @returns A RequestAction that handles the GET request for the schema.
- */
-export declare const CreateGetSwaggerJsonAction: <T extends RestApiImplementation<any>>(api: T, name?: string, description?: string, version?: string) => RequestAction<{
-    result: GetSchemaResult | SwaggerDocument;
-}>;
-//# sourceMappingURL=create-get-swagger-json-action.d.ts.map

package/esm/endpoint-generators/create-get-swagger-json-action.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"create-get-swagger-json-action.d.ts","sourceRoot":"","sources":["../../src/endpoint-generators/create-get-swagger-json-action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAC9E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAE9D,OAAO,EAAc,KAAK,aAAa,EAAE,MAAM,qCAAqC,CAAA;AAGpF,MAAM,MAAM,eAAe,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAA;AAE5D;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,GAAI,CAAC,SAAS,qBAAqB,CAAC,GAAG,CAAC,EAC7E,KAAK,CAAC,EACN,aAAsB,EACtB,oBAAqE,EACrE,gBAAiB,KAChB,aAAa,CAAC;IAAE,MAAM,EAAE,eAAe,GAAG,eAAe,CAAA;CAAE,CAM7D,CAAA"}

package/esm/endpoint-generators/create-get-swagger-json-action.js

@@ -1,18 +0,0 @@
-import {} from '@furystack/rest';
-import { getSchemaFromApi } from '../get-schema-from-api.js';
-import { JsonResult } from '../request-action-implementation.js';
-import { generateSwaggerJsonFromApiSchema } from '../swagger/generate-swagger-json.js';
-/**
- * Generates a RequestAction that retrieves the Swagger JSON schema from a FuryStack API implementation.
- *
- * @param api - The API implementation from which to extract the schema.
- * @returns A RequestAction that handles the GET request for the schema.
- */
-export const CreateGetSwaggerJsonAction = (api, name = 'FuryStack API', description = 'API documentation generated from FuryStack API schema', version = '1.0.0') => {
-    const { endpoints } = getSchemaFromApi({ api, name, description, version });
-    const swaggerJson = generateSwaggerJsonFromApiSchema({ api: endpoints, title: name, description, version });
-    return async () => {
-        return JsonResult(swaggerJson, 200);
-    };
-};
-//# sourceMappingURL=create-get-swagger-json-action.js.map

package/esm/endpoint-generators/create-get-swagger-json-action.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"create-get-swagger-json-action.js","sourceRoot":"","sources":["../../src/endpoint-generators/create-get-swagger-json-action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgD,MAAM,iBAAiB,CAAA;AAE9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAC5D,OAAO,EAAE,UAAU,EAAsB,MAAM,qCAAqC,CAAA;AACpF,OAAO,EAAE,gCAAgC,EAAE,MAAM,qCAAqC,CAAA;AAItF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,GAAM,EACN,IAAI,GAAG,eAAe,EACtB,WAAW,GAAG,uDAAuD,EACrE,OAAO,GAAG,OAAO,EAC6C,EAAE;IAChE,MAAM,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAA;IAC3E,MAAM,WAAW,GAAG,gCAAgC,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAA;IAC3G,OAAO,KAAK,IAAI,EAAE;QAChB,OAAO,UAAU,CAAC,WAAW,EAAE,GAAG,CAAC,CAAA;IACrC,CAAC,CAAA;AACH,CAAC,CAAA"}

package/esm/endpoint-generators/with-schema-and-swagger-action.d.ts

@@ -1,21 +0,0 @@
-import type { RestApi, SwaggerDocument } from '@furystack/rest';
-/**
- * Extends a RestApi with endpoints for both schema.json and swagger.json
- */
-export type WithSchemaAndSwaggerAction<T extends RestApi> = T & {
-    GET: {
-        '/schema': {
-            result: Record<string, any>;
-            headers: {
-                accept: 'application/schema+json';
-            };
-        };
-        '/swagger.json': {
-            result: SwaggerDocument;
-            headers: {
-                accept: 'application/swagger+json';
-            };
-        };
-    };
-};
-//# sourceMappingURL=with-schema-and-swagger-action.d.ts.map

package/esm/endpoint-generators/with-schema-and-swagger-action.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"with-schema-and-swagger-action.d.ts","sourceRoot":"","sources":["../../src/endpoint-generators/with-schema-and-swagger-action.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAE/D;;GAEG;AACH,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,OAAO,IAAI,CAAC,GAAG;IAC9D,GAAG,EAAE;QACH,SAAS,EAAE;YAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAAC,OAAO,EAAE;gBAAE,MAAM,EAAE,yBAAyB,CAAA;aAAE,CAAA;SAAE,CAAA;QAC1F,eAAe,EAAE;YAAE,MAAM,EAAE,eAAe,CAAC;YAAC,OAAO,EAAE;gBAAE,MAAM,EAAE,0BAA0B,CAAA;aAAE,CAAA;SAAE,CAAA;KAC9F,CAAA;CACF,CAAA"}

package/esm/endpoint-generators/with-schema-and-swagger-action.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=with-schema-and-swagger-action.js.map

package/esm/endpoint-generators/with-schema-and-swagger-action.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"with-schema-and-swagger-action.js","sourceRoot":"","sources":["../../src/endpoint-generators/with-schema-and-swagger-action.ts"],"names":[],"mappings":""}

package/esm/swagger/generate-swagger-json.d.ts

@@ -1,14 +0,0 @@
-import type { ApiEndpointSchema, SwaggerDocument } from '@furystack/rest';
-/**
- * Converts a FuryStack API schema to an OpenAPI 3.1 compatible document
- *
- * @param schema - The FuryStack API schema to convert
- * @returns A SwaggerDocument in OpenAPI 3.1 format
- */
-export declare const generateSwaggerJsonFromApiSchema: ({ api, title, description, version, }: {
-    api: ApiEndpointSchema["endpoints"];
-    title?: string;
-    description?: string;
-    version?: string;
-}) => SwaggerDocument;
-//# sourceMappingURL=generate-swagger-json.d.ts.map

package/esm/swagger/generate-swagger-json.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate-swagger-json.d.ts","sourceRoot":"","sources":["../../src/swagger/generate-swagger-json.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,iBAAiB,EAIjB,eAAe,EAChB,MAAM,iBAAiB,CAAA;AAExB;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,GAAI,uCAK9C;IACD,GAAG,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;IACnC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,KAAG,eA0GH,CAAA"}

package/esm/swagger/generate-swagger-json.js

@@ -1,108 +0,0 @@
-/**
- * Converts a FuryStack API schema to an OpenAPI 3.1 compatible document
- *
- * @param schema - The FuryStack API schema to convert
- * @returns A SwaggerDocument in OpenAPI 3.1 format
- */
-export const generateSwaggerJsonFromApiSchema = ({ api, title = 'FuryStack API', description = 'API documentation generated from FuryStack API schema', version = '1.0.0', }) => {
-    const swaggerJson = {
-        openapi: '3.1.0',
-        info: {
-            title,
-            version,
-            description,
-        },
-        jsonSchemaDialect: 'https://spec.openapis.org/oas/3.1/dialect/base',
-        servers: [{ url: '/' }],
-        tags: [],
-        paths: {},
-        components: {
-            schemas: {},
-            securitySchemes: {
-                cookieAuth: {
-                    type: 'apiKey',
-                    in: 'cookie',
-                    name: 'session',
-                },
-            },
-        },
-    };
-    for (const [methodKey, paths] of Object.entries(api)) {
-        for (const [path, definition] of Object.entries(paths)) {
-            // Normalize path to OpenAPI format (convert :param to {param})
-            const normalizedPath = path.replace(/:([^/]+)/g, '{$1}');
-            if (!swaggerJson.paths[normalizedPath]) {
-                swaggerJson.paths[normalizedPath] = {};
-            }
-            // Extract path parameters
-            const pathParams = Array.from(path.matchAll(/:([^/]+)/g), (m) => m[1]);
-            const parameters = pathParams.map((param) => ({
-                name: param,
-                in: 'path',
-                required: true,
-                description: `Path parameter: ${param}`,
-                schema: { type: 'string' },
-            }));
-            // Build operation
-            const method = methodKey.toLowerCase();
-            const operation = {
-                summary: `${methodKey} ${path}`,
-                description: `Endpoint for ${path}`,
-                operationId: `${method}${path.replace(/\//g, '_').replace(/:/g, '').replace(/-/g, '_')}`,
-                security: definition.isAuthenticated ? [{ cookieAuth: [] }] : [],
-                parameters,
-                responses: {
-                    '200': {
-                        description: 'Successful operation',
-                        content: {
-                            'application/json': {
-                                schema: definition.schemaName
-                                    ? { $ref: `#/components/schemas/${definition.schemaName}` }
-                                    : { type: 'object' },
-                            },
-                        },
-                    },
-                    '401': { description: 'Unauthorized' },
-                    '500': { description: 'Internal server error' },
-                },
-            };
-            // Add schema to components if not already there
-            if (definition.schema && definition.schemaName) {
-                swaggerJson.components.schemas[definition.schemaName] = definition.schema;
-            }
-            // Assign the operation to the correct HTTP method property of PathItem
-            const pathItem = swaggerJson.paths[normalizedPath];
-            switch (method) {
-                case 'get':
-                    pathItem.get = operation;
-                    break;
-                case 'put':
-                    pathItem.put = operation;
-                    break;
-                case 'post':
-                    pathItem.post = operation;
-                    break;
-                case 'delete':
-                    pathItem.delete = operation;
-                    break;
-                case 'options':
-                    pathItem.options = operation;
-                    break;
-                case 'head':
-                    pathItem.head = operation;
-                    break;
-                case 'patch':
-                    pathItem.patch = operation;
-                    break;
-                case 'trace':
-                    pathItem.trace = operation;
-                    break;
-                default:
-                    // Ignore unknown methods
-                    break;
-            }
-        }
-    }
-    return swaggerJson;
-};
-//# sourceMappingURL=generate-swagger-json.js.map

package/esm/swagger/generate-swagger-json.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate-swagger-json.js","sourceRoot":"","sources":["../../src/swagger/generate-swagger-json.ts"],"names":[],"mappings":"AASA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,EAC/C,GAAG,EACH,KAAK,GAAG,eAAe,EACvB,WAAW,GAAG,uDAAuD,EACrE,OAAO,GAAG,OAAO,GAMlB,EAAmB,EAAE;IACpB,MAAM,WAAW,GAAoB;QACnC,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACJ,KAAK;YACL,OAAO;YACP,WAAW;SACZ;QACD,iBAAiB,EAAE,gDAAgD;QACnE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;QACvB,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,EAAE;QACT,UAAU,EAAE;YACV,OAAO,EAAE,EAAE;YACX,eAAe,EAAE;gBACf,UAAU,EAAE;oBACV,IAAI,EAAE,QAAQ;oBACd,EAAE,EAAE,QAAQ;oBACZ,IAAI,EAAE,SAAS;iBAChB;aACF;SACF;KACF,CAAA;IAED,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAA2D,EAAE,CAAC;QAC/G,KAAK,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,+DAA+D;YAC/D,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;YACxD,IAAI,CAAC,WAAW,CAAC,KAAM,CAAC,cAAc,CAAC,EAAE,CAAC;gBACxC,WAAW,CAAC,KAAM,CAAC,cAAc,CAAC,GAAG,EAAE,CAAA;YACzC,CAAC;YAED,0BAA0B;YAC1B,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACtE,MAAM,UAAU,GAAsB,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAC/D,IAAI,EAAE,KAAK;gBACX,EAAE,EAAE,MAAM;gBACV,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,mBAAmB,KAAK,EAAE;gBACvC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;aAC3B,CAAC,CAAC,CAAA;YAEH,kBAAkB;YAClB,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,EAAE,CAAA;YACtC,MAAM,SAAS,GAAc;gBAC3B,OAAO,EAAE,GAAG,SAAS,IAAI,IAAI,EAAE;gBAC/B,WAAW,EAAE,gBAAgB,IAAI,EAAE;gBACnC,WAAW,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE;gBACxF,QAAQ,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE;gBAChE,UAAU;gBACV,SAAS,EAAE;oBACT,KAAK,EAAE;wBACL,WAAW,EAAE,sBAAsB;wBACnC,OAAO,EAAE;4BACP,kBAAkB,EAAE;gCAClB,MAAM,EAAE,UAAU,CAAC,UAAU;oCAC3B,CAAC,CAAC,EAAE,IAAI,EAAE,wBAAwB,UAAU,CAAC,UAAU,EAAE,EAAE;oCAC3D,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE;6BACvB;yBACF;qBACF;oBACD,KAAK,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE;oBACtC,KAAK,EAAE,EAAE,WAAW,EAAE,uBAAuB,EAAE;iBAChD;aACF,CAAA;YAED,gDAAgD;YAChD,IAAI,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;gBAC/C,WAAW,CAAC,UAAW,CAAC,OAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC,MAAM,CAAA;YAC7E,CAAC;YAED,uEAAuE;YACvE,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAM,CAAC,cAAc,CAAC,CAAA;YACnD,QAAQ,MAAM,EAAE,CAAC;gBACf,KAAK,KAAK;oBACR,QAAQ,CAAC,GAAG,GAAG,SAAS,CAAA;oBACxB,MAAK;gBACP,KAAK,KAAK;oBACR,QAAQ,CAAC,GAAG,GAAG,SAAS,CAAA;oBACxB,MAAK;gBACP,KAAK,MAAM;oBACT,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAA;oBACzB,MAAK;gBACP,KAAK,QAAQ;oBACX,QAAQ,CAAC,MAAM,GAAG,SAAS,CAAA;oBAC3B,MAAK;gBACP,KAAK,SAAS;oBACZ,QAAQ,CAAC,OAAO,GAAG,SAAS,CAAA;oBAC5B,MAAK;gBACP,KAAK,MAAM;oBACT,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAA;oBACzB,MAAK;gBACP,KAAK,OAAO;oBACV,QAAQ,CAAC,KAAK,GAAG,SAAS,CAAA;oBAC1B,MAAK;gBACP,KAAK,OAAO;oBACV,QAAQ,CAAC,KAAK,GAAG,SAAS,CAAA;oBAC1B,MAAK;gBACP;oBACE,yBAAyB;oBACzB,MAAK;YACT,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,WAAW,CAAA;AACpB,CAAC,CAAA"}

package/src/endpoint-generators/create-get-swagger-json-action.ts

@@ -1,26 +0,0 @@
-import { type ApiEndpointSchema, type SwaggerDocument } from '@furystack/rest'
-import type { RestApiImplementation } from '../api-manager.js'
-import { getSchemaFromApi } from '../get-schema-from-api.js'
-import { JsonResult, type RequestAction } from '../request-action-implementation.js'
-import { generateSwaggerJsonFromApiSchema } from '../swagger/generate-swagger-json.js'
-
-export type GetSchemaResult = ApiEndpointSchema['endpoints']
-
-/**
- * Generates a RequestAction that retrieves the Swagger JSON schema from a FuryStack API implementation.
- *
- * @param api - The API implementation from which to extract the schema.
- * @returns A RequestAction that handles the GET request for the schema.
- */
-export const CreateGetSwaggerJsonAction = <T extends RestApiImplementation<any>>(
-  api: T,
-  name = 'FuryStack API',
-  description = 'API documentation generated from FuryStack API schema',
-  version = '1.0.0',
-): RequestAction<{ result: GetSchemaResult | SwaggerDocument }> => {
-  const { endpoints } = getSchemaFromApi({ api, name, description, version })
-  const swaggerJson = generateSwaggerJsonFromApiSchema({ api: endpoints, title: name, description, version })
-  return async () => {
-    return JsonResult(swaggerJson, 200)
-  }
-}

package/src/endpoint-generators/with-schema-and-swagger-action.ts

@@ -1,11 +0,0 @@
-import type { RestApi, SwaggerDocument } from '@furystack/rest'
-
-/**
- * Extends a RestApi with endpoints for both schema.json and swagger.json
- */
-export type WithSchemaAndSwaggerAction<T extends RestApi> = T & {
-  GET: {
-    '/schema': { result: Record<string, any>; headers: { accept: 'application/schema+json' } }
-    '/swagger.json': { result: SwaggerDocument; headers: { accept: 'application/swagger+json' } }
-  }
-}