Typescript playwright (#25282)

* adding openapi to playwright typescript support

* fixes

* [typescript-playwright] address PR review feedback

- runtime: resolve BASE_PATH from the BASE_URL env var at runtime so the
  target server can actually be overridden (previously ignored)
- runtime/apis: build form and multipart bodies from a FormData so
  collectionFormat=multi array fields emit one repeated field per element;
  file parts are appended as Blobs and object parts as application/json
  (via a JSONPart wrapper) instead of untyped text
- runtime: JSON-encode bare-primitive request bodies when the Content-Type
  is JSON (Playwright otherwise sends the string verbatim)
- generated specs: escape operation summaries and enum example values so
  titles containing apostrophes/backslashes/newlines produce valid TypeScript
- package.json: only emit "private": true when no npmRepository is set, and
  require TypeScript >= 4.7 to match the ES2021 compile target
- README: correct layout note (one describe block per API, one test per operation)
- regenerate petstore sample

* [CI] fix invalid samples-r workflow

`working-directory` is only valid on `run` steps; on the
setup-r-dependencies action it must be passed as a `with` input.
This fixes the "Unexpected value 'working-directory'" parse error
that marks the workflow invalid on every PR.

* [CI] add typescript-playwright client sample workflow

* remove accidentally committed effective-pom.xml

* [CI] run typescript-playwright tests against echo server

* [CI] wait for echo server readiness before running playwright tests

Author: roydekleijn

.github/workflows/samples-r.yaml

@@ -29,9 +29,9 @@ jobs:
         with:
           r-version: 3.6.1
       - uses: r-lib/actions/setup-r-dependencies@v2
-        working-directory: ${{ matrix.sample }}
         with:
           cache-version: 2
+          working-directory: ${{ matrix.sample }}
       - name: Install curl
         run: sudo apt-get install -y r-cran-curl
       - name: build and test

.github/workflows/samples-typescript-playwright.yaml

@@ -0,0 +1,63 @@
+name: Samples TypeScript Playwright Client
+
+on:
+  push:
+    paths:
+      - samples/client/petstore/typescript-playwright/**
+      - .github/workflows/samples-typescript-playwright.yaml
+  pull_request:
+    paths:
+      - samples/client/petstore/typescript-playwright/**
+      - .github/workflows/samples-typescript-playwright.yaml
+jobs:
+  build:
+    name: Build TypeScript Playwright client
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node:
+          - "18.x"
+          - "20.x"
+          - "22.x"
+        sample:
+          - samples/client/petstore/typescript-playwright/
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Run echo server
+        # The generated tests issue real HTTP requests and assert on the response
+        # status. Point them at wing328's echo server (which answers 200 to any
+        # request) so the Playwright client is exercised at runtime, deterministically.
+        run: |
+          git clone https://github.com/wing328/http-echo-server -b openapi-generator-test-server
+          cd http-echo-server
+          git checkout 15a684c41d4de692878636f47fcc1670af309a0f
+          npm install
+          # Background only the server itself; it keeps running for later steps.
+          npm start &
+          # Wait until it is actually listening before moving on, so the test
+          # step never races server startup.
+          for i in $(seq 1 30); do
+            if curl --fail --silent http://localhost:3000 >/dev/null; then
+              echo "Echo server is ready"
+              exit 0
+            fi
+            sleep 1
+          done
+          echo "Echo server did not become ready" >&2
+          exit 1
+      - name: npm install
+        working-directory: ${{ matrix.sample }}
+        run: npm install
+      - name: Type-check generated client and tests
+        working-directory: ${{ matrix.sample }}
+        run: npm run typecheck
+      - name: Test
+        working-directory: ${{ matrix.sample }}
+        env:
+          BASE_URL: http://localhost:3000
+        run: npm test

bin/configs/typescript-playwright.yaml

@@ -1,4 +1,4 @@
 generatorName: typescript-playwright
-outputDir: samples/client/petstore/typescript-wright/
+outputDir: samples/client/petstore/typescript-playwright
 inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
 templateDir: modules/openapi-generator/src/main/resources/typescript-playwright

docs/generators/typescript-playwright.md

@@ -36,7 +36,6 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |paramNaming|Naming convention for parameters: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name| |camelCase|
 |prefixParameterInterfaces|Setting this property to true will generate parameter interface declarations prefixed with API class name to avoid name conflicts.| |false|
 |prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
-|sagasAndRecords|Setting this property to true will generate additional files for use with redux-saga and immutablejs.| |false|
 |snapshot|When setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |false|
 |sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java

@@ -240,24 +240,18 @@ protected String nullableQuotedJSString(@Nullable String string) {
     @SuppressWarnings("squid:S5164")
     protected static final ThreadLocal<SimpleDateFormat> SNAPSHOT_SUFFIX_FORMAT = ThreadLocal.withInitial(() -> new SimpleDateFormat("yyyyMMddHHmm", Locale.ROOT));
 
-    @Getter
-    protected MODEL_PROPERTY_NAMING_TYPE modelPropertyNaming = MODEL_PROPERTY_NAMING_TYPE.original;
+    @Getter protected MODEL_PROPERTY_NAMING_TYPE modelPropertyNaming = MODEL_PROPERTY_NAMING_TYPE.original;
     protected ENUM_PROPERTY_NAMING_TYPE enumPropertyNaming = ENUM_PROPERTY_NAMING_TYPE.PascalCase;
-    @Getter
-    protected PARAM_NAMING_TYPE paramNaming = PARAM_NAMING_TYPE.camelCase;
+    @Getter protected PARAM_NAMING_TYPE paramNaming = PARAM_NAMING_TYPE.camelCase;
     protected boolean enumPropertyNamingReplaceSpecialChar = false;
-    @Getter
-    @Setter
+    @Getter @Setter
     protected Boolean supportsES6 = false;
-    @Getter
-    @Setter
+    @Getter @Setter
     protected Boolean nullSafeAdditionalProps = false;
     protected HashSet<String> languageGenericTypes;
-    @Getter
-    @Setter
+    @Getter @Setter
     protected String npmName = null;
-    @Getter
-    @Setter
+    @Getter @Setter
     protected String npmVersion = "1.0.0";
 
     protected String enumSuffix = "Enum";
@@ -1157,4 +1151,4 @@ protected List<String> getTypesFromSchemas(List<Schema> schemas) {
     public GeneratorLanguage generatorLanguage() {
         return GeneratorLanguage.TYPESCRIPT;
     }
-}
+}