feat: add type augmentation to RouteHandle

[joncardasis]

Updates RouteHandle from a type to an interface to support property augmentation in TypeScript 5.5+.

RouteHandle was declared as a type instead of an interface, which leads to projects using TypeScript 5.5+ to not allow the object to be augmented with an app's custom properties. Replace type with interface and update docs.

This issue was a result of TypeScript 5.5 fixing a bug, see microsoft/TypeScript#58961. In previous versions, the bug allowed interfaces to override types and override their properties.

Example:

// remix.d.ts
declare module '@remix-run/react/dist/routeModules' {
  export interface RouteHandle { // "Duplicate identifier" ts error when RouteHandle is `type`
    pageType: string
    subscriptionRequired?: boolean
    i18n?: string
  }
}

• Docs
• Tests

[changeset-bot]

⚠️ No Changeset found

Latest commit: 137c468

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[remix-cla-bot]

Hi @joncardasis,

Welcome, and thank you for contributing to Remix!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

[remix-cla-bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳