feat(server-runtime): deprecate SerializeFrom type

[brophdawg11]

No description provided.

[changeset-bot]

🦋 Changeset detected

Latest commit: f222092

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 19 packages

Name	Type
@remix-run/server-runtime	Minor
@remix-run/cloudflare	Minor
@remix-run/deno	Minor
@remix-run/dev	Minor
@remix-run/node	Minor
@remix-run/react	Minor
@remix-run/testing	Minor
@remix-run/cloudflare-pages	Minor
@remix-run/cloudflare-workers	Minor
@remix-run/fs-routes	Major
@remix-run/route-config	Major
@remix-run/routes-option-adapter	Major
@remix-run/architect	Minor
@remix-run/express	Minor
@remix-run/serve	Minor
create-remix	Minor
remix	Minor
@remix-run/css-bundle	Minor
@remix-run/eslint-config	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

🤖 Hello there,

We just published version 2.14.0-pre.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

[github-actions]

🤖 Hello there,

We just published version 2.14.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

[kentcdodds]

I'm not sure how to handle these cases without SerializeFrom:

• https://github.com/epicweb-dev/epic-stack/blob/6c7eb1d529a15e0d32c49b310e8b0a7711aa01f9/app/utils/user.ts#L2
• https://github.com/epicweb-dev/epic-stack/blob/6c7eb1d529a15e0d32c49b310e8b0a7711aa01f9/app/routes/settings%2B/profile.connections.tsx#L7
• https://github.com/epicweb-dev/epic-stack/blob/6c7eb1d529a15e0d32c49b310e8b0a7711aa01f9/app/routes/users%2B/%24username_%2B/__note-editor.tsx#L12

And I have some here as well: https://github.com/search?q=repo%3Aepicweb-dev%2Fepicshop%20serializefrom&type=code

Am I missing something?

[bpetetot]

@kentcdodds

I was able to reproduce the behavior of SerializeFrom by doing:

type SerializeFrom<T> = ReturnType<typeof useLoaderData<T>>;

It can be used in the same way as the current SerializeFrom for data from loader functions. You can make an equivalent type with useActionLoader if you need it.

[kentcdodds]

Thanks! That'll work I think.

[artemis-prime]

Please, please, please document this better! What a PITA to have to poke around to use such core functionality!

[felixmokross]

To me it seems the current implementation in RR7 doesn't cover all the use cases which SerializeFrom in Remix used to cover (at least before Single Fetch). I used it in two ways so far:

// Given these type definitions:
type SerializeFrom<T> = ReturnType<typeof useLoaderData<T>>;
type Car = {
  …
  price: Prisma.Decimal;
};

// 1)
type ResultDto = SerializeFrom<typeof loader>;

// 2)
type CarDto = SerializeFrom<Car>;

Use case (1) still works since I upgraded from Remix to React Router (incl. migration to Single Fetch). But if I use it as shown in (2), CarDto just is the same as Car, it doesn't serialize the props. I use Prisma Decimals, where this is an issue.

If I look into the RR7 package, I see the following type definition for the return type of useLoader:

export type SerializeFrom<T> = T extends (...args: infer Args) => unknown
  ? Args extends [ClientLoaderFunctionArgs | ClientActionFunctionArgs]
    ? ClientDataFrom<T>
    : ServerDataFrom<T>
  : T;

So if T is not a function, it just returns T. Shouldn't it return Serialize<T>?

To work around the issue, I see that I could define CarDto like this (assuming we have a car prop on the object returned by the loader):

type CarDto = SerializeFrom<typeof loader>["car"];

But I would like to avoid having to always use a specific loader to define CarDto. I have centralized type files being used in many places which should not depend on specific routes.