@vida-global/core 2.0.11 → 2.1.0

package/test/server/statusTexts.test.js

@@ -0,0 +1,30 @@
+const { STATUS_TEXTS, statusTextFor } = require('../../lib/server/statusTexts');
+
+
+describe('statusTextFor', () => {
+    it.each([
+        [200, 'ok'],
+        [201, 'created'],
+        [204, 'no content'],
+        [301, 'moved permanently'],
+        [400, 'bad request'],
+        [401, 'unauthorized'],
+        [404, 'not found'],
+        [422, 'unprocessable content'],
+        [429, 'too many requests'],
+        [500, 'server error'],
+        [503, 'service unavailable'],
+    ])('returns the text for status code %i', (code, expected) => {
+        expect(statusTextFor(code)).toBe(expected);
+    });
+
+
+    it ('returns undefined for an unknown status code', () => {
+        expect(statusTextFor(799)).toBeUndefined();
+    });
+
+
+    it ('exposes the underlying map', () => {
+        expect(STATUS_TEXTS[200]).toBe('ok');
+    });
+});

package/test/utils/yamlLoader.test.js

@@ -0,0 +1,43 @@
+jest.mock('fs');
+
+const   fs            = require('fs');
+const { YamlLoader }  = require('../../lib/utils/yamlLoader');
+
+
+afterEach(() => jest.resetAllMocks());
+
+
+describe('YamlLoader', () => {
+    describe('.loadFile', () => {
+        it ('parses YAML content into an object', () => {
+            fs.readFileSync.mockReturnValue('getIndex:\n  summary: List\n');
+            expect(YamlLoader.loadFile('/docs.yaml')).toEqual({ getIndex: { summary: 'List' } });
+        });
+
+
+        it ('returns an empty object for an empty file', () => {
+            fs.readFileSync.mockReturnValue('');
+            expect(YamlLoader.loadFile('/empty.yaml')).toEqual({});
+        });
+
+
+        it ('throws on malformed YAML', () => {
+            fs.readFileSync.mockReturnValue('foo: [unclosed');
+            expect(() => YamlLoader.loadFile('/bad.yaml')).toThrow();
+        });
+    });
+
+
+    describe('.fileExists', () => {
+        it ('returns true when the file is present', () => {
+            fs.existsSync.mockReturnValue(true);
+            expect(YamlLoader.fileExists('/docs.yaml')).toBe(true);
+        });
+
+
+        it ('returns false when the file is absent', () => {
+            fs.existsSync.mockReturnValue(false);
+            expect(YamlLoader.fileExists('/missing.yaml')).toBe(false);
+        });
+    });
+});

package/lib/server/apiDocsGenerator.js

@@ -1,86 +0,0 @@
-const { ControllerImporter } = require('./controllerImporter');
-
-
-class ApiDocsGenerator {
-    #controllerDirectories
-    #controllerClasses;
-    #docs = {};
-    
-    constructor(server) {
-        this.#controllerDirectories = server.controllerDirectories;
-    }
-
-
-    generateDocs() {
-console.log("\n\n");
-        this.controllerClasses.forEach(controllerClass => {
-            controllerClass.actions.forEach(action => {
-                this.generateDocsForAction(action, controllerClass);
-            });
-        });
-console.log("\n");
-    }
-
-
-    generateDocsForAction(action, controllerClass) {
-        const documentationDetails = controllerClass.documentationForAction(action.action);
-        if (!documentationDetails?.description) return;
-
-        const components = this.collectComponents(controllerClass, documentationDetails, action);
-
-        const endpoint       = components.endpoint;
-        this.#docs[endpoint] = this.#docs[endpoint] || {};
-        const actionDocs     = this.#docs[endpoint][action.method.toLowerCase()] = {};
-
-    }
-
-
-    collectComponents(controllerClass, documentationDetails, action) {
-        const components    = {...documentationDetails};
-        components.endpoint = this.formatEndpoint(action);
-        components.method   = action.method;
-
-        const pathParamNames = components.endpoint.match(/{[^}]+}/g).map(p => {
-            return p.replace(/[{}]/g, '')
-        });
-
-        const parameters  = Object.entries(controllerClass.parametersForAction(action.action));
-        const pathParams  = parameters.filter(([param, _]) => pathParamNames.includes(param));
-        const otherParams = parameters.filter(([param, _]) => !pathParamNames.includes(param));
-        console.log(components.endpoint);
-        console.log(pathParams);
-        console.log(components.method);
-        console.log(parameters);
-        console.log(components.description);
-        console.log(components.summary);
-      console.log("\n");
-        //const auth       = controllerClass.authenticationDocumentation(action.action);
-        //const method     = action.method;
-
-        return components;
-    }
-
-
-    get controllerClasses() {
-        if (!this.#controllerClasses) {
-            const controllerImporter = new ControllerImporter(this.#controllerDirectories);
-            this.#controllerClasses  = controllerImporter.controllerClasses;
-        }
-        return [...this.#controllerClasses];
-    }
-
-
-    /***********************************************************************************************
-    * OPENAPI COMPONENTS
-    ***********************************************************************************************/
-    formatEndpoint(action) {
-        const endpoint = action.path.replace(/:([^/]+)/g, '{$1}');
-        return endpoint;
-    }
-
-}
-
-
-module.exports = {
-    ApiDocsGenerator
-}

package/test/server/apiDocsGenerator.test.js

@@ -1,38 +0,0 @@
-const { ApiDocsGenerator } = require('../../lib/server/apiDocsGenerator');
-
-
-describe('ApiDocsGenerator', () => {
-    let generator;
-
-    beforeEach(() => {
-        generator = new ApiDocsGenerator({ controllerDirectories: [] });
-    });
-
-
-    describe('#formatEndpoint', () => {
-        it ('replaces a single :param with {param}', () => {
-            expect(generator.formatEndpoint({ path: '/users/:id' })).toEqual('/users/{id}');
-        });
-
-        it ('replaces multiple :params with {params}', () => {
-            expect(generator.formatEndpoint({ path: '/users/:userId/posts/:postId' }))
-                .toEqual('/users/{userId}/posts/{postId}');
-        });
-
-        it ('returns the path unchanged when there are no params', () => {
-            expect(generator.formatEndpoint({ path: '/users' })).toEqual('/users');
-        });
-
-        it ('handles a trailing :param', () => {
-            expect(generator.formatEndpoint({ path: '/foo/bar/:baz' })).toEqual('/foo/bar/{baz}');
-        });
-
-        it ('handles an empty path', () => {
-            expect(generator.formatEndpoint({ path: '' })).toEqual('');
-        });
-
-        it ('only replaces up to the next slash', () => {
-            expect(generator.formatEndpoint({ path: '/a/:x/b/:y' })).toEqual('/a/{x}/b/{y}');
-        });
-    });
-});