Add typescript-wright client generator (#19038)

* add typescript-wright generator

* add api, model tests

* 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

* remove invalid code

* update samples, docs

---------

Co-authored-by: Roy de Kleijn <dekleijn.roy@gmail.com>

Author: wing328

.github/workflows/samples-r.yaml

@@ -52,6 +52,13 @@ jobs:
 
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
+          cache-version: 2
+          working-directory: ${{ matrix.sample }}
+
+      - name: Install curl
+        run: sudo apt-get install -y r-cran-curl
+
+      - name: build and test
           working-directory: ${{ matrix.sample }}
           extra-packages: any::rcmdcheck
           needs: check

.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

@@ -0,0 +1,4 @@
+generatorName: typescript-playwright
+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.md

@@ -82,6 +82,7 @@ The following generators are available:
 * [typescript-jquery](generators/typescript-jquery.md)  
 * [typescript-nestjs (experimental)](generators/typescript-nestjs.md)  
 * [typescript-node](generators/typescript-node.md)  
+* [typescript-playwright](generators/typescript-playwright.md)  
 * [typescript-redux-query](generators/typescript-redux-query.md)  
 * [typescript-rxjs](generators/typescript-rxjs.md)  
 * [xojo-client](generators/xojo-client.md)