api-spec-generator 0.0.12-alpha → 0.0.13-alpha

package/.github/workflows/unit-tests.yml

@@ -0,0 +1,31 @@
+name: Build and Test
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Run tests
+        run: npm t

package/jest.config.js

@@ -0,0 +1,14 @@
+export default {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testRegex: ".*\\.test\\.ts$",
+  extensionsToTreatAsEsm: [".ts"],
+  transform: {
+    "^.+\\.tsx?$": ["ts-jest", { useESM: true, tsconfig: "tsconfig.jest.json" }],
+  },
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+  collectCoverageFrom: [
+    "src/**/*.ts",
+    "!src/**/*.d.ts",
+  ],
+};

package/package.json

@@ -5,7 +5,9 @@
   "type": "module",
   "scripts": {
     "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage"
   },
   "repository": {
     "type": "git",
@@ -18,7 +20,13 @@
   },
   "homepage": "https://github.com/TheDevOpAl/aws-api-gateway-spec-file-generator#readme",
   "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.2.3",
+    "ts-jest": "^29.4.6",
     "typescript": "^5.9.3"
   },
-  "version": "0.0.12-alpha"
+  "dependencies": {
+    "zod": "^4.3.6"
+  },
+  "version": "0.0.13-alpha"
 }

package/src/OpenApiSpec/openApiSpec.ts

@@ -0,0 +1,40 @@
+import { writeFileSync } from "fs";
+
+export class OpenApiSpec {
+    private openApi: string = "3.0.1";
+
+    private paths: any = {};
+    private components: any = {};
+    private securitySchemes: any = {};
+    private writeToYamlFile: boolean = false;
+    private fileName: string = "openapi-spec";
+    private pathToFiles: string = "./";
+    public getOpenApiSpecContent(): any {
+        return {
+            openapi: this.openApi,
+            paths: this.paths,
+            components: this.components,
+            securitySchemes: this.securitySchemes
+        }
+    }
+
+    constructor() {}
+
+    setOpenApiVersion(version: string): void {
+        this.openApi = version;
+    }
+
+    setFileName(fileName: string): void {
+        this.fileName = fileName;
+    }
+
+    setPathToFiles(pathToFiles: string): void {
+        this.pathToFiles = pathToFiles;
+    }
+
+    writeOpenApiSpec(): void {
+        const specFileContent = this.getOpenApiSpecContent();
+
+        writeFileSync(`${this.pathToFiles}${this.fileName}.${this.writeToYamlFile ? "yaml" : "json"}`, JSON.stringify(specFileContent, null, 2));
+    }
+}

package/src/index.ts

@@ -1,5 +1,2 @@
-const consoleLogHelloWorld = () => {
-    console.log("Hello, World!");
-};
-
-export default consoleLogHelloWorld;
+import { OpenApiSpec } from './OpenApiSpec/openApiSpec.ts';
+export { OpenApiSpec };

package/tests/OpenApiSpec/openApiSpec.test.ts

@@ -0,0 +1,23 @@
+import { OpenApiSpec } from "../../src/index.ts";
+
+describe("OpenApiSpec", () => {
+  let spec: OpenApiSpec;
+
+  beforeEach(() => {
+    spec = new OpenApiSpec();
+  });
+
+  it("should initialize with default OpenAPI version 3.0.1", () => {
+    // Note: You may need to make the openApi property public or add a getter to test this
+
+    const content = spec.getOpenApiSpecContent();
+    expect(content).toEqual({components: {}, openapi: "3.0.1", paths: {}, securitySchemes: {}});
+  });
+
+  it("should allow setting OpenAPI version", () => {
+    spec.setOpenApiVersion("3.1.0");
+    // Note: You may need to add a getter to verify this
+    const content = spec.getOpenApiSpecContent();
+    expect(content).toEqual({components: {}, openapi: "3.1.0", paths: {}, securitySchemes: {}});
+  });
+});

package/tsconfig.jest.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "noEmit": true,
+    "module": "esnext"
+  },
+  "include": ["src", "tests"]
+}

package/tsconfig.json

@@ -9,7 +9,7 @@
     // See also https://aka.ms/tsconfig/module
     "module": "nodenext",
     "target": "esnext",
-    "types": [],
+    "types": ["node", "jest"],
     // For nodejs:
     // "lib": ["esnext"],
     // "types": ["node"],
@@ -19,6 +19,7 @@
     "sourceMap": true,
     "declaration": true,
     "declarationMap": true,
+    "noEmit": true,
 
     // Stricter Typechecking Options
     "noUncheckedIndexedAccess": true,
@@ -40,5 +41,7 @@
     "noUncheckedSideEffectImports": true,
     "moduleDetection": "force",
     "skipLibCheck": true,
-  }
+    "allowImportingTsExtensions": true
+  },
+  "exclude": ["tests", "node_modules", "dist"]
 }

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-declare const consoleLogHelloWorld: () => void;
-export default consoleLogHelloWorld;
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,oBAAoB,YAEzB,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/index.js

@@ -1,5 +0,0 @@
-const consoleLogHelloWorld = () => {
-    console.log("Hello, World!");
-};
-export default consoleLogHelloWorld;
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,oBAAoB,GAAG,GAAG,EAAE;IAC9B,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,eAAe,oBAAoB,CAAC"}