Move RequestEventLocals type definition into a namespace to make the retyping easier for users

[AirBorne04]

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

• Other... Type changes that require minor adjustments

What is the current behavior?

When defining a RequestEventLocals type for a custom app typescript does not pickup the types until it the file also contains a top level import/export.

What is the new behavior?

Now instead of declare module we declare a namespace that does not confuse typescript and makes sure the global.d.ts is interpreted as an augmentation module (not ambient as before)

Other information

Related to #1466 unfortunately this would require current users to re-config their typings. (from module to namespace)

[changeset-bot]

🦋 Changeset detected

Latest commit: ee0e659

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

This PR includes changesets to release 1 package

Name	Type
@solidjs/start	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

[ryansolid]

I haven't touched this one since it is marked as draft. Are there more changes, or things that need to be verified?

[AirBorne04]

hi @ryansolid mainly looking for approval, and adjustment on the docs side? Any thoughts?

I have tested again today, since its been a while, it all looks good still. The one docs adjustment that we would need is to now define the RequestEventLocals in the project like this:

declare module App {
  interface RequestEventLocals {
    myNumber: number
    someString: string
  }
}

Also added this into the todomvc example app for further reference.

[ryansolid]

Ok I like it. We probably have to wait for minor given how this could break types. I've broken types on patch releases before but I feel like we should be cautious here.

[AirBorne04]

Ok I like it. We probably have to wait for minor given how this could break types. I've broken types on patch releases before but I feel like we should be cautious here.

Perfect, I feel the same, I have updated the changeset accordingly.

[pkg-pr-new]

Open in Stackblitz

More templates

• example-bare
• example-basic
• example-experiments
• example-hackernews
• example-notes
• example-todomvc
• example-with-auth
• example-with-authjs
• example-with-drizzle
• example-with-mdx
• example-with-prisma
• example-with-solid-styled
• example-with-tailwindcss
• example-with-trpc
• example-with-unocss
• example-with-vitest

npm i https://pkg.pr.new/@solidjs/start@1469

commit: 7d44f7c

[atilafassina]

hey @ryansolid , we just merged #1683 - which should also be a minor.

How about we merge this one too?

[apatrida]

This broke the typing in TypeScript in 1.0.0, nothing can be done to use this module and override it.

I note the PR doesn't even show it being used, just an empty shell where it might work.