Type generation improvement

[hi94740]

There are a ton of cms out there. And the reason I chose payload is because of the official type generation support 👍
But I think it could be improved:

An example of the current generated file:

/* tslint:disable */
/**
 * This file was automatically generated by Payload CMS.
 * DO NOT MODIFY IT BY HAND. Instead, modify your source Payload config,
 * and re-run `payload generate:types` to regenerate this file.
 */

export interface Config {}
/**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "users".
 */
export interface User {
  id: string;
  email?: string;
  resetPasswordToken?: string;
  resetPasswordExpiration?: string;
  loginAttempts?: number;
  lockUntil?: string;
}
/**
 * This interface was referenced by `Config`'s JSON-Schema
 * via the `definition` "works".
 */
export interface Work {
  id: string;
  _status?: 'draft' | 'published';
  slug: string;
  title?: string;
  coverImageBackground?: string;
}

The improvement is simply add an interface that has every interface generated above in it and their slugs as property names:

interface PayloadGeneratedTypes {
  users: User
  works: Work
}

export default PayloadGeneratedTypes

With this improvement, I can write something like this:

export const useApi = <
  Slug extends keyof PayloadGeneratedTypes,
  Id extends string | never = never
>(
  slug: Slug,
  id?: Id
) =>
  useFetch<
    Id extends string
      ? PayloadGeneratedTypes[Slug]
      : PaginatedDocs<PayloadGeneratedTypes[Slug]>
  >("https://coolsite.com/api/" + slug + "/" + (id || ""))

This way all my api calls would be correctly typed 😆 (At least for the read operation, not planning on modifying the contents yet)

[jmikrut]

Hey @hi94740 — this is a great idea and would be fairly trivial to implement I think.

We'll slate this into our workload!

[hi94740]

Thank you!