feat: implement function generation using useSWRMutation

[soartec-lab]

Status

READY

Description

fix #1013

Originally, in generateSwrHook, if verb was other than Verbs.GET, processing was skipped, but we implemented a function to generate a function using useSWRMutation.

Since the processing required for mutation is different from query, we have newly added generateSwrMutationImplementation, which is a function for generating the string of the function itself, and generateSwrMutationArguments, which generates arguments.
Also, since useSWRMutation requires a dedicated Fetcher as the second argument, I reused it by wrapping the http function. This allows reuse of mock and customization of http client using global mutator.

Related PRs

none

Todos

• Tests
• Documentation
• Changelog Entry (unreleased)

Steps to Test or Reproduce

1. Prepare an OpenAPI definition for petstore that defines mutation.

openapi: '3.0.0'
info:
  version: 1.0.0
  title: Swagger Petstore
  license:
    name: MIT
servers:
  - url: http://petstore.swagger.io/v1
paths:
  /pets:
    post:
      summary: Create a pet
      operationId: createPets
      tags:
        - pets
      requestBody:
        description: post body
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PetParams'
      responses:
        '201':
          description: Null response
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /pets/{petId}:
    patch:
      summary: Update for a specific pet
      operationId: updatePetByParams
      tags:
        - pets
      parameters:
        - name: petId
          in: path
          required: true
          description: The id of the pet to retrieve
          schema:
            type: string
      requestBody:
        description: post body
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PetParams'
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    PetParams:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        tag:
          type: string
    Pet:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        tag:
          type: string
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string

2. Prepare orval.config.js

module.exports = {
  'petstore-file': {
    input: {
      target: './petstore.yaml',
    },
    output: {
      mode: 'tags-split',
      client: 'swr',
      baseUrl: 'http://localhost:8000',
      target: 'src/gen/endpoints',
      schemas: 'src/gen/model',
    },
  },
};

3. execute orval

orval

4. generated custom hook

for example:

export const getCreatePetsMutationFetcher = (options?: AxiosRequestConfig) => {
  return (
    _: string,
    { arg }: { arg: Arguments },
  ): Promise<AxiosResponse<void>> => {
    return createPets(arg as PetParams, options);
  };
};
export const getCreatePetsMutationKey = () =>
  `http://localhost:8000/pets` as const;

export type CreatePetsMutationResult = NonNullable<
  Awaited<ReturnType<typeof createPets>>
>;
export type CreatePetsMutationError = AxiosError<Error>;

/**
 * @summary Create a pet
 */
export const useCreatePets = <TError = AxiosError<Error>>(options?: {
  swr?: SWRMutationConfiguration<
    Awaited<ReturnType<typeof createPets>>,
    TError,
    string,
    Arguments,
    Awaited<ReturnType<typeof createPets>>
  > & { swrKey?: string };
  axios?: AxiosRequestConfig;
}) => {
  const { swr: swrOptions, axios: axiosOptions } = options ?? {};

  const swrKey = swrOptions?.swrKey ?? getCreatePetsMutationKey();
  const swrFn = getCreatePetsMutationFetcher(axiosOptions);

  const query = useSWRMutation(swrKey, swrFn, swrOptions);

  return {
    swrKey,
    ...query,
  };
};

[melloware]

Looks good so far I see you are still working on the failing tests. Appreciate your effort on this!

[soartec-lab]

Thank you for comment ✨ There are still some problems, I'll let you know when I fix them.

[soartec-lab]

@melloware @anymaniax
This PR is Ready 🙌 So could you review?