counterfact 0.19.0 → 0.20.0

package/.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '43 18 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # counterfact
 
+## 0.20.0
+
+### Minor Changes
+
+- 3c78a07: support for enum values in schemas
+
+### Patch Changes
+
+- b2bf1db: fix duplicate imports of Context object
+- 0f4ead6: don't import HTTPStatusCode if not needed
+- 8e4410c: redirect /counterfact to counterfact/
+
+## 0.19.1
+
+### Patch Changes
+
+- ab730a8: fix an issue where top-level produces in OpenAPI 2 was not working
+
 ## 0.19.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",

package/src/server/start.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-statements */
 import nodePath from "node:path";
 import { pathToFileURL } from "node:url";
 
@@ -105,6 +106,16 @@ export async function start({
     })
   );
 
+  app.use((ctx, next) => {
+    if (ctx.URL.pathname === "/counterfact") {
+      ctx.redirect("/counterfact/");
+
+      return;
+    }
+
+    next();
+  });
+
   app.use(
     page("/counterfact/rapidoc", "rapi-doc", {
       basePath,

package/src/typescript-generator/context-coder.js

@@ -11,6 +11,10 @@ export class ContextCoder extends Coder {
       .replaceAll("~0", "~");
   }
 
+  get id() {
+    return "ContextCoder";
+  }
+
   names() {
     return super.names("Context");
   }

package/src/typescript-generator/operation-type-coder.js

@@ -35,7 +35,7 @@ export class OperationTypeCoder extends Coder {
         if (response.has("schema")) {
           const produces =
             this.requirement?.get("produces")?.data ??
-            this.requirement.specification.requirementAt("#/produces").data;
+            this.requirement.rootRequirement.get("produces").data;
 
           return produces
             .map(

package/src/typescript-generator/response-type-coder.js

@@ -12,6 +12,8 @@ export class ResponseTypeCoder extends Coder {
   }
 
   typeForDefaultStatusCode(listedStatusCodes) {
+    this.needsHttpStatusCodeImport = true;
+
     const definedStatusCodes = listedStatusCodes.filter(
       (key) => key !== "default"
     );
@@ -101,10 +103,13 @@ export class ResponseTypeCoder extends Coder {
       "ResponseBuilderFactory",
       nodePath.join(basePath, "response-builder-factory.js")
     );
-    script.importExternalType(
-      "HttpStatusCode",
-      nodePath.join(basePath, "response-builder-factory.js")
-    );
+
+    if (this.needsHttpStatusCodeImport) {
+      script.importExternalType(
+        "HttpStatusCode",
+        nodePath.join(basePath, "response-builder-factory.js")
+      );
+    }
 
     return `ResponseBuilderFactory<${this.buildResponseObjectType(script)}>`;
   }

package/src/typescript-generator/schema-type-coder.js

@@ -93,6 +93,12 @@ export class SchemaTypeCoder extends Coder {
     return types.join(allOf ? " & " : " | ");
   }
 
+  writeEnum(script, requirement) {
+    return requirement.data
+      .map((item) => (typeof item === "string" ? `"${item}"` : item))
+      .join(" | ");
+  }
+
   modulePath() {
     return `components/${this.requirement.data.$ref.split("/").at(-1)}.ts`;
   }
@@ -108,6 +114,10 @@ export class SchemaTypeCoder extends Coder {
       return this.writeGroup(script, { allOf, anyOf, oneOf });
     }
 
+    if (this.requirement.has("enum")) {
+      return this.writeEnum(script, this.requirement.get("enum"));
+    }
+
     return this.writeType(script, type);
   }
 }

package/src/typescript-generator/specification.js

@@ -36,6 +36,8 @@ export class Specification {
 
     this.cache.set(urlOrPath, data);
 
+    this.rootRequirement = new Requirement(data, `${urlOrPath}#`, this);
+
     return data;
   }
 }

package/test/typescript-generator/__snapshots__/context-coder.test.js.snap

@@ -0,0 +1,6 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`a ContextCoder finds the request method in the URL 1`] = `
+"export { default } from \\"../$.context.js\\";
+"
+`;