From ca992c66576cf9a5873c4413da351f26933bfe05 Mon Sep 17 00:00:00 2001
From: Erik Demaine <edemaine@mit.edu>
Date: Sun, 6 Mar 2022 20:00:36 -0500
Subject: [PATCH] Revised Component types (children, readonly, ref)

* Rename past `Component` type to `ComponentWithChildren`.
  Motivation: Most components don't actually support children.
  This causes a type error upon accidental passing of children /
  forces you to think about which components support children.
* Added second parameter to `ComponentWithChildren`
  to make it easier to give a custom type for `children`
  (but still defaults to useful `JSX.Element`).
* New `Component` type does not have automatic `children` property
  (like React's preferred `VoidFunctionalComponent`),
  offering another natural way to type `props.children`:
  `Component<{children: JSX.Element}>`.
* `props` argument in both `Component` and `ComponentWithChildren`
  automatically cast to `readonly` (shallow one level only),
  to avoid accidental assignment to `props.foo` (usually a getter)
  while still allowing passing mutables in props.
  Add `Props<T>` helper for this transformation.
* Add @LXSMNSYC's `Ref<T>` type so it's easy to type `props.ref`:
  `Component<{ref: Ref<Element>}>`.
  <https://github.com/solidjs/solid/issues/778#issuecomment-1003236081>
  Fixes #778.
---
 packages/solid/src/render/component.ts | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/packages/solid/src/render/component.ts b/packages/solid/src/render/component.ts
index 43b7c5400..8647611ec 100644
--- a/packages/solid/src/render/component.ts
+++ b/packages/solid/src/render/component.ts
@@ -15,8 +15,12 @@ export function enableHydration() {
   hydrationEnabled = true;
 }
 
-export type PropsWithChildren<P = {}> = P & { children?: JSX.Element };
-export type Component<P = {}> = (props: PropsWithChildren<P>) => JSX.Element;
+export type Props<P = {}> = Readonly<P>;
+export type PropsWithChildren<P = {}, C = JSX.Element> =
+  Props<P> & { readonly children?: C };
+export type Component<P = {}> = (props: Props<P>) => JSX.Element;
+export type ComponentWithChildren<P = {}, C = JSX.Element> =
+  (props: PropsWithChildren<P, C>) => JSX.Element;
 /**
  * Takes the props of the passed component and returns its type
  *
@@ -30,6 +34,12 @@ export type ComponentProps<T extends keyof JSX.IntrinsicElements | Component<any
     : T extends keyof JSX.IntrinsicElements
     ? JSX.IntrinsicElements[T]
     : {};
+/** Type of `props.ref`, for use in `Props`.
+ *
+ * @example Props<{ref: Ref<Element>}>
+ */
+export type Ref<T> = T | ((val: T) => void);
+
 export function createComponent<T>(Comp: (props: T) => JSX.Element, props: T): JSX.Element {
   if (hydrationEnabled) {
     if (sharedConfig.context) {