Generate useMutate components

[fabien0102]

Why

All the power of this library is the open-api generation, this permit to have auto-completion of our backend api directly in react.
I have the honor to introduce useMutate part of this auto-generation! now every route can be generate and use with hooks 🎉

Example

For the following spec:

post:
      description: Creates a new pet in the store.  Duplicates are allowed
      operationId: addPet
      requestBody:
        description: Pet to add to the store
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NewPet"
      responses:
        "200":
          description: pet response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pet"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"

I will have the following components generated:

export type AddPetProps = Omit<MutateProps<Pet, Error, void, NewPet>, \\"path\\" | \\"verb\\">;


export const AddPet = (props: AddPetProps) => (
  <Mutate<Pet, Error, void, NewPet>
    verb=\\"POST\\"
    path={\`/pets\`}
    {...props}
  />
);

export type UseAddPetProps = Omit<UseMutateProps<Pet, void>, \\"path\\" | \\"verb\\">;


export const useAddPet = (props: UseAddPetProps) => useMutate<Pet, Error, void, NewPet>(\\"POST\\", \`/pets\`, props);

So I can do in my application:

import { useAddPet } from "./petstore-generated";

const App = () => {
  const {mutate: addPet, loading, error} = useAddPet();

  return (<div>
     {loading && <div>Loading…</div>}
     {error && <div>{error.message}</div>}
    <button onClick={() => addPet({name: "Medor"})}>Add a pet</button>
  </div>)
};

This is of course fully typesafe, and you have autocompletion on addPet({name: "Medor"}) 💯

Validator

I also use this branch to continue on our goal to improve the quality and strictness of our specifications.

Now, https://github.com/IBM/openapi-validator is integrate by default, and we can just add a .validaterc in any project to configure the openapi linter 😈

Note: This validator is really strict! I've added a --no-validation flag to be able to have a more smooth migration to this dream 😅

[fabien0102]

data is not anymore optional, so we can define string for DELETE operation.
This is to have a bit more type safety, mutate() is not possible anymore if a body is required.

[contiamo-ci]

	Warnings
⚠️	❗ Big PR

Generated by 🚫 dangerJS

[TejasQ]

Sad that it's not TS.

[TejasQ]

Can we contribute this to @DefinitelyTyped?

[fabien0102]

24 stars on github, I've tried but without a lot of hope 😅 I will contribute to definitelyTyped to add this later.

[TejasQ]

Can we contribute this to @DefinitelyTyped?

[TejasQ]

Maybe export this from that other place you do it?

[fabien0102]

It's more have only one no-console, I prefer to not export this hack ^^ So you need to ask yourself "is it a real usecase or just a console.log for debugging?"

[TejasQ]

?

[fabien0102]

I've disabled the no-console rule for the block, so I re-enable it ^^

[fabien0102]

[TejasQ]

It's great for a first iteration! Let's publish on next and use it 😍