Merge pull request #1 from web-bee-ru/feature/openapi-axios

feat: Initial Codebase for openapi-axios Library with Integration Tests

.changeset/config.json

@@ -2,7 +2,7 @@
   "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
   "changelog": [
     "@changesets/changelog-github",
-    { "repo": "christoph-fricke/openapi-msw" }
+    { "repo": "web-bee-ru/openapi-axios" }
   ],
   "commit": false,
   "access": "public",

.changeset/spotty-mangos-jam.md

@@ -0,0 +1,5 @@
+---
+"@web-bee-ru/openapi-axios": patch
+---
+
+test

.github/workflows/ci.yml

@@ -24,11 +24,11 @@ jobs:
         run: npm ci
       - name: Lint Project
         run: npm run lint
-      - name: Run Unit Tests
-        run: npm run test:unit
-      - name: Build Package
-        run: npm run build
+      # - name: Run Unit Tests # there's no tests yet
+      #   run: npm run test:unit
       - name: Generate Test Fixtures
         run: npm run generate
       - name: Run Integration Tests
-        run: npm run test:int
+        run: npm run test:int -- --run
+      - name: Build Package
+        run: npm run build

.github/workflows/release.yml → .github/workflows/publish.yml

@@ -1,9 +1,7 @@
-name: release
+name: Publish to npm
 
 on:
-  push:
-    branches:
-      - main
+  workflow_dispatch:
 
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
@@ -14,9 +12,8 @@ permissions:
   pull-requests: write #  to create pull request (changesets/action)
 
 jobs:
-  release:
-    if: github.repository == 'christoph-fricke/openapi-msw'
-    runs-on: macos-latest
+  publish:
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.gitignore

@@ -2,4 +2,5 @@ coverage
 cjs
 dist
 node_modules
-test/fixtures/*.ts
+test/fixtures/*.ts
+tsconfig.vitest-temp.json

.husky/pre-commit

@@ -4,6 +4,9 @@ echo "Starting pre-commit hook..."
 echo "Running Prettier and ESLint on staged files..."
 npx lint-staged
 
+echo "Running integration tests..."
+npm run test:int -- --run || exit 1
+
 echo ""
 echo "All checks successful."
 echo ""

.node-version

@@ -1 +1 @@
-v20.13.1
+v16.20.2

CHANGELOG.md

@@ -1,247 +0,0 @@
-# openapi-msw
-
-## 0.7.0
-
-### Minor Changes
-
-- [#58](https://github.com/christoph-fricke/openapi-msw/pull/58) [`f08acf1`](https://github.com/christoph-fricke/openapi-msw/commit/f08acf19a6e792ab36214bf8c1925447c2489704) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Added "content-length" header for `response(...).empty()`. If no "content-length" header is provided in the response init, the "content-length" header is now set with the value "0". See #56 for more details.
-
-## 0.6.1
-
-### Patch Changes
-
-- [#54](https://github.com/christoph-fricke/openapi-msw/pull/54) [`6793dcc`](https://github.com/christoph-fricke/openapi-msw/commit/6793dccff4641dedc266f8096ede373dc95fca8f) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Fixed type-exports for CommonJS refer to a non-existing file.
-
-## 0.6.0
-
-### Minor Changes
-
-- [#50](https://github.com/christoph-fricke/openapi-msw/pull/50) [`37da681`](https://github.com/christoph-fricke/openapi-msw/commit/37da6814e65105cfc5c38067bdf32ba1c6208d8f) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Added compilation and exports for CommonJS modules. This makes OpenAPI-MSW usable in projects that still use CommonJS as their module system.
-
-- [#52](https://github.com/christoph-fricke/openapi-msw/pull/52) [`88ca9da`](https://github.com/christoph-fricke/openapi-msw/commit/88ca9da973ac0a9d25a3185e1cf05b88722c717d) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Added enhanced typing for the `request` object. Now, `request.json()` and `request.text()` infer their return type from the given OpenAPI request-body content schema. Previously, only `request.json()` has been inferred without considering the content-type.
-
-## 0.5.0
-
-### Minor Changes
-
-- [#41](https://github.com/christoph-fricke/openapi-msw/pull/41) [`fe70d20`](https://github.com/christoph-fricke/openapi-msw/commit/fe70d20494692df764188c35105cbf6be178d687) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Added `response` helper to the resolver-info argument. It provides an granular type-safety when creating HTTP responses. Instead of being able to return any status code, `response` limits status codes, content types, and their response bodies to the combinations defined by the given OpenAPI spec.
-
-  ```typescript
-  /*
-  Imagine this endpoint specification for the following example:
-  
-  /response-example:
-    get:
-      summary: Get Resource
-      operationId: getResource
-      responses:
-        200:
-          description: Success
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/Resource"
-            text/plain:
-              schema:
-                type: string
-                enum: ["Hello", "Goodbye"]
-        204:
-          description: NoContent
-        "5XX":
-          description: Error
-          content:
-            text/plain:
-              schema:
-                type: string
-  */
-
-  const handler = http.get("/response-example", ({ response }) => {
-    // Error: Status Code 204 only allows empty responses
-    const invalidRes = response(204).text("Hello");
-
-    // Error: Status Code 200 only allows "Hello" as text
-    const invalidRes = response(200).text("Some other string");
-
-    // No Error: This combination is part of the defined OpenAPI spec
-    const validRes = response(204).empty();
-
-    // No Error: This combination is part of the defined OpenAPI spec
-    const validRes = response(200).text("Hello");
-
-    // Using a wildcard requires you to provide a matching status code for the response
-    const validRes = response("5XX").text("Fatal Error", { status: 503 });
-  });
-  ```
-
-## 0.4.0
-
-### Minor Changes
-
-- [#42](https://github.com/christoph-fricke/openapi-msw/pull/42) [`c466bbc`](https://github.com/christoph-fricke/openapi-msw/commit/c466bbcf4c27dea2e4c6928bf92369abf138fb47) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Changed response body types to be a union of all response bodies for all status codes and media types. This makes it possible to return responses for specified error codes without requiring a type cast. Imagine the following endpoint. Its response body is now typed as `StrictResponse<{ id: string, value: number } | string | null>`.
-
-  ```yaml
-  /resource:
-    get:
-      summary: Get Resource
-      operationId: getResource
-      responses:
-        200:
-          description: Success
-          content:
-            application/json:
-              schema:
-                type: object
-                required: [id, value]
-                properties:
-                  id:
-                    type: string
-                  value:
-                    type: integer
-        202:
-          description: Accepted
-          content:
-            text/plain:
-              schema:
-                type: string
-        418:
-          description: NoContent
-  ```
-
-### Patch Changes
-
-- [#44](https://github.com/christoph-fricke/openapi-msw/pull/44) [`a9338b5`](https://github.com/christoph-fricke/openapi-msw/commit/a9338b5bcb289ceaab0e5538a4131995c10dd5f0) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Fixed endpoints with no specified query params allow any query key in the `query` helper methods. Now, providing any query key causes a type error.
-
-## 0.3.0
-
-### Minor Changes
-
-- [#33](https://github.com/christoph-fricke/openapi-msw/pull/33) [`1f3958d`](https://github.com/christoph-fricke/openapi-msw/commit/1f3958dee1fce818b20c37bf486d6d73a0fcd1ea) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Added `query` helper to resolver-info argument. It provides a type-safe wrapper around `URLSearchParams` for reading search parameters. As usual, the information about available parameters is inferred from your OpenAPI spec.
-
-  ```typescript
-  /*
-  Imagine this endpoint specification for the following example:
-  
-  /query-example:
-    get:
-      summary: Query Example
-      operationId: getQueryExample
-      parameters:
-        - name: filter
-          in: query
-          required: true
-          schema:
-            type: string
-        - name: page
-          in: query
-          schema:
-            type: number
-        - name: sort
-          in: query
-          required: false
-          schema:
-            type: string
-            enum: ["asc", "desc"]
-        - name: sortBy
-          in: query
-          schema:
-            type: array
-            items:
-              type: string
-  */
-
-  const handler = http.get("/query-example", ({ query }) => {
-    const filter = query.get("filter"); // Typed as string
-    const page = query.get("page"); // Typed as string | null since it is not required
-    const sort = query.get("sort"); // Typed as "asc" | "desc" | null
-    const sortBy = query.getAll("sortBy"); // Typed as string[]
-
-    // Supported methods from URLSearchParams: get(), getAll(), has(), size
-    if (query.has("sort", "asc")) {
-      /* ... */
-    }
-
-    return HttpResponse.json({
-      /* ... */
-    });
-  });
-  ```
-
-- [#35](https://github.com/christoph-fricke/openapi-msw/pull/35) [`07fa9b0`](https://github.com/christoph-fricke/openapi-msw/commit/07fa9b0822c441708c70d3e0698a6dbe7577f58c) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Restructured the library to add support for additional response resolver info. The enhanced `ResponseResolver` type and `ResponseResolverInfo` are available as exports.
-
-## 0.2.2
-
-### Patch Changes
-
-- [#31](https://github.com/christoph-fricke/openapi-msw/pull/31) [`556dfca`](https://github.com/christoph-fricke/openapi-msw/commit/556dfca3a2c87eeec6f1f7acd2db63af52df2806) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Fixed a type mismatch between path fragment types and the values provided at runtime, which are always strings. Now all path-fragments are typed as string. If a fragment's schema is a string constrained by an enum, the resulting string literals are preserved. This fixes bug [#22](https://github.com/christoph-fricke/openapi-msw/issues/22).
-
-  ```typescript
-  const handler = http.get("/resource/{id}", ({ params }) => {
-    // Previously calling "parseInt(...)" caused a type error
-    // when the schema type for "id" is defined as number.
-    const id = parseInt(params.id);
-
-    return HttpResponse.json({ id });
-  });
-  ```
-
-## 0.2.1
-
-### Patch Changes
-
-- [#27](https://github.com/christoph-fricke/openapi-msw/pull/27) [`232ae11`](https://github.com/christoph-fricke/openapi-msw/commit/232ae11b46bda40ec493b4eed6c270e4a9160a00) Thanks [@luchsamapparat](https://github.com/luchsamapparat)! - Fixed a compilation warning in projects using OpenAPI-MSW, which was caused by missing sources in source maps.
-
-## 0.2.0
-
-### Minor Changes
-
-- [#24](https://github.com/christoph-fricke/openapi-msw/pull/24) [`bfd7a99`](https://github.com/christoph-fricke/openapi-msw/commit/bfd7a997c662c29bac8a91ea0952993c20dadee8) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Added JSDoc comments to public API for improved DX.
-
-### Patch Changes
-
-- [#23](https://github.com/christoph-fricke/openapi-msw/pull/23) [`29ecb9c`](https://github.com/christoph-fricke/openapi-msw/commit/29ecb9cbccff09d042fe3e55552c906e22f6054c) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Fixed a small naming mistake in the "Getting Started" code example.
-
-## 0.1.2
-
-### Patch Changes
-
-- [#17](https://github.com/christoph-fricke/openapi-msw/pull/17) [`2931f0c`](https://github.com/christoph-fricke/openapi-msw/commit/2931f0c37e5ca66378ec2a9596e07736b417a96b) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Fixed OpenAPI operations with no-content responses cannot return a response. Now they are required to return an empty response, i.e. `null` as response body.
-
-  ```typescript
-  const http = createOpenApiHttp<paths>();
-
-  // Resolver function is required to return a `StrictResponse<null>` (empty response)
-  // if the OpenAPI operation specifies `content?: never` for the response.
-  const noContent = http.delete("/resource", ({ params }) => {
-    return HttpResponse.json(null, { status: 204 });
-  });
-  ```
-
-## 0.1.1
-
-### Patch Changes
-
-- [#12](https://github.com/christoph-fricke/openapi-msw/pull/12) [`96ce15c`](https://github.com/christoph-fricke/openapi-msw/commit/96ce15c5f81535fb1091143dab2dce671ba65836) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Add legacy entrypoint definitions (types, module) for tools and bundlers that do not understand package.json#exports fields.
-
-## 0.1.0
-
-### Minor Changes
-
-- [#9](https://github.com/christoph-fricke/openapi-msw/pull/9) [`6364870`](https://github.com/christoph-fricke/openapi-msw/commit/636487083c131f582507b096318d114c97131630) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Added installation and complete usage guide to the documentation.
-
-- [#5](https://github.com/christoph-fricke/openapi-msw/pull/5) [`d15a0c2`](https://github.com/christoph-fricke/openapi-msw/commit/d15a0c2720f4d51415309f432cdc50aefb90f25f) Thanks [@christoph-fricke](https://github.com/christoph-fricke)! - Added `createOpenApiHttp(...)` to create a thin, type-safe wrapper around [MSW](https://mswjs.io/)'s `http` that uses [openapi-ts](https://openapi-ts.pages.dev/introduction/) `paths`:
-
-  ```ts
-  import type { paths } from "./openapi-ts-definitions";
-
-  const http = createOpenApiHttp<paths>();
-
-  // Define handlers with fully typed paths, path params, and request/response bodies
-  const handler = http.get("/pets/{id}", () => {
-    /* ... */
-  });
-
-  // Fallback to default http implementation
-  const catchAll = http.untyped.all("*", () => {
-    /* ... */
-  });
-  ```