RTK Query Plugin

[smoores-dev]

Description

Howdy folks!

Is there any interest in an RTK Query plugin, similar to the Tanstack Query plugin?

RTK Query has a comparable feature set to Tanstack Query, but it allows for first class integration with Redux state management. It's useful for complex, state-driven UIs that also have server-side data dependencies.

If this is something that you all would accept a PR for, I would be interested in taking a stab at it myself. We're looking into adding schema validation and OpenAPI-based documentation to Storyteller, which uses RTK Query, and it would be great to be able to use Hey API to generate the RTK Query spec.

[mrlubos]

@smoores-dev why are you considering building a Hey API plugin instead of using their generator? https://redux-toolkit.js.org/rtk-query/usage/code-generation

[mrlubos]

@smoores-dev for what it's worth, I did message @EskiMojo14 in July 2024 about handling code generation for them but never heard back

[smoores-dev]

Ah, I didn't realize RTK Query had its own generator, actually! Thanks for the pointer. Maybe there is no reason to add this, then — it seems like that implementation has several RTK Query-specific features already. I don't know how the generated types compare, but I imagine it's not a huge difference. Feel free to close if you like!

[mrlubos]

Yeah, in an ideal world their OpenAPI codegen would point to a Hey API plugin the same way they have the GraphQL plugin, but Hey API didn't exist yet when they worked on that generator

[mrlubos]

@smoores-dev to give you (and me) some closure, I'd appreciate if you could come back and update here once you tried their generator. If you spot areas that could benefit from Hey API's plugin system, we could make a case for a new plugin and I'd guide you through developing it.

[smoores-dev]

Sounds good, I will do just that!

[EskiMojo14]

@smoores-dev for what it's worth, I did message @EskiMojo14 in July 2024 about handling code generation for them but never heard back

sorry I never responded - we had a brief internal discussion but i must have let it slip away from me

looking back at the discussion, it looks like the verdict was that we like the output from oazapafts more:

in my experience, oazapafts and the underlying components for generating types and such is the best i've found so far, especially when going from openapi -> defs. it handles cases every other generator i've seen fails to do. as an immediate example:

we'll generate this:

export type ResourceMeta =
  | {
      description?: string | null;
      name: string;
    }
  | {
      unknown: true;
    };
export type PermissionsList = string[];
export type ResourcePermissions = {
  [key: string]: {
    __meta?: ResourceMeta;
  } & (
    | PermissionsList
    | {
        [key: string]: PermissionsList | ResourcePermissions;
      }
  );
};
export type Permissions = {
  [key: string]: ResourcePermissions;
};

hey-api will generate this;

export type Permissions = Record<string, ResourcePermissions>;
export type ResourcePermissions = {
};

zodios will generate Permissions = never;, etc etc etc. same with orval.

of course that was over a year ago at this point, so things might have changed. you're very welcome to write an RTKQ plugin for Hey API regardless :)

[mrlubos]

@EskiMojo14 which spec are you using? I could look into polishing any of those types if they still lack in quality.

As I noted above, I understand the exiting generator was done before Hey API time. Unless you're aware of major pain areas (?), I don't think it's worth the effort to rewrite today.