@fluentui-react-native/framework-base 0.1.4 → 0.2.0

package/src/immutable-merge/README.md

@@ -0,0 +1,185 @@
+# Immutable Merge package
+
+This package provides a relatively concise routine to handle merging multiple objects together with the following characteristics:
+
+- No modifications will be made to any object
+- Minimal updates. If only one value is updated three levels deep, only that value and the chain of containing objects will be recreated.
+- Empty objects or undefined objects will be ignored and not cause a new branch to be created.
+- Recursion is controllable in a variety of ways
+
+Note that this does not provide a **strict** immutable package on its own. It also doesn't operate or return only readonly objects. This is to provide flexibility. It could easily be wrapped in various ways to provide that type of functionality, but it is provided in a more flexible form to be useful in other scenarios as well.
+
+## Deep Merge via `immutableMerge`
+
+For standard deep merging, this package provides the `immutableMerge` function. The signature is as follows:
+
+```ts
+export function immutableMerge<T extends object>(...objs: (T | undefined)[]): T | undefined;
+```
+
+This takes one or more objects of type `T` and deep merges them. If objects are undefined or null in some manner they will be ignored. Merging via this routine (and all routines in the package) typically follow the semantics of `Object.assign`, with a few extra behaviors.
+
+- all values at a given level will overwrite, with the last writer winning
+- if a key does not exist for an object it is ignored
+- if a key does exist, even if it is `undefined` it will replace the previous value
+- only non-array objects will recurse, arrays will be replaced rather than appended
+- keys which exist and have a value of `undefined` will be deleted
+
+The peculiar pattern of deleting keys which end up as undefined is the only way to delete a key without violating the core principles. An example of key deletion might look like:
+
+```ts
+const newObj = immutableMerge(myObj, { keyToDelete1: undefined, keyToDelete2: undefined });
+```
+
+## Custom Merging via `immutableMergeCore`
+
+In many cases, merges have to follow additional rules to match the structure or behavior of objects passed in. This results in authoring custom merge routines to handle this constraint. This package allows for deep customization of merge behaviors via `immutableMergeCore`.
+
+```ts
+export function immutableMergeCore<T extends object>(options: RecursionOptions | MergeOptions, ...objs: (T | undefined)[]): T | undefined;
+```
+
+### RecursionOptions
+
+Recursion options can be a boolean or a number with behavior interpreted as follows:
+
+- `boolean` - Should this recurse. If the value is `true` it will recurse infinitely, if `false` it will not recurse.
+- `number` - Recursion depth. A value of `0` will not recurse any farther, a positive value will recurse that many additional levels before stopping, a negative value will recurse indefinitely.
+
+### MergeOptions
+
+This object allows very precise control of the recursion. At a given level it matches values by name of the key, or by the resulting type of the property.
+
+```ts
+export interface MergeOptions {
+  [typeOrName: string]: RecursionOptions | RecursionHandlers | MergeOptions;
+}
+```
+
+Matching will happen in the following order:
+
+1. Merged object property key matches a key in MergeOptions.
+2. The type of the key is referenced in MergeOptions. Note that arrays (which are objects) are treated as being of type 'array' for this purpose.
+
+The values within the options can have the following types:
+
+| Type               | Usage                                                                                                                                                                                                                            |
+| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `RecursionOption`  | Behaves as if this value was passed into the recursive call. So 0/false mean merge but don't recurse for the matching child object, less than zero / true means recurse deeply, greater than zero means recurse that many times. |
+| `RecursionHandler` | Run a function to handle the merge or invoke one of the built-in handlers for the library. See below for more information.                                                                                                       |
+| `MergeOptions`     | Forward the child `MergeOptions` to the child level when making the recursive call.                                                                                                                                              |
+
+### RecursionHandler
+
+When merging values for a given key, providing a recursion handler allows custom processing. A handler function has the following signature:
+
+```ts
+export type CustomRecursionHandler = (...vals: any[]) => any;
+```
+
+The vals parameter will have collected all the non-undefined values from the input objects. Note that type checking is the responsibility of the handler function.
+
+#### Built in handlers
+
+Built-in handlers can be referenced by name. The currently supported built-in handlers are as follows:
+
+| Handler       | Description                                 |
+| ------------- | ------------------------------------------- |
+| `appendArray` | Append arrays rather than overwriting them. |
+
+### Example Usage
+
+As an example, imagine props for react components, with a concept called SlotProps that has multiple props in the same object.
+
+```ts
+export interface IStandardProps {
+  classNames?: string;
+  tokens?: ISomeObjectTypeWithoutStyle;
+  style?: CSSVariables | CSSVariables[];
+  // likely more
+}
+
+export interface IMyComponentProps extends IStandardProps {
+  // other stuff here
+}
+
+export interface IComponentSlotProps {
+  root: IMyComponentProps;
+  slot1: ISomeOtherComponentProps;
+  slot2: IYetAnotherComponentProps;
+}
+```
+
+In this case style needs to be merged in a special manner and classNames need to be appended. Deep recursion is not desireable in the case where a prop might be an object as with partial values you might get unexpected behavior. Here are some examples of ways to make merge routines:
+
+```ts
+// all in one function
+export function mergeSlotProps1(...slotProps: ISlotPropsBase[]): ISlotPropsBase {
+  return immutableMergeCore({
+    // match any object
+    object: {
+      // match tokens and merge but don't recurse
+      tokens: 0,
+      // run the string merge routine on classNames
+      classNames: (...names: string[]) => { names.map(name => name.trim()).join(' ') },
+      // run an existing style merge routine on styles
+      style: mergeStyles;
+    }
+  }, ...slotProps);
+}
+
+// this could be broken into two parts, options for props
+const propsOptions: MergeOptions = {
+  tokens: 0,
+  classNames: (...names: string[]) => { names.map(name => name.trim()).join(' ') },
+  style: mergeStyles;
+}
+
+// then options for slotProps that refer to the props object
+const slotPropsOptions: MergeOptions = {
+  object: propsOptions;
+}
+
+// then a wrapper for each
+export function mergeProps<T extends IPropsBase>(...props: T[]): T {
+  return immutableMergeCore(propsOptions, ...props);
+}
+
+export function mergeSlotProps<T extends ISlotPropsBase>(...slotProps: T[]): T {
+  return immutableMergeCore(slotPropsOptions, ...slotProps);
+}
+
+```
+
+## processImmutable
+
+The ability to run a handler on something like a style as a part of merge is useful but in normal usage it has some limitations. If there is only one object in a branch or only one value of that type the handler won't run. If the processors are essential functions, or if it is desireable to run processors on a single object you can use `processImmutable`.
+
+```ts
+export function processImmutable<T extends object>(options: MergeOptions, ...objs: (T | undefined)[]): T | undefined;
+```
+
+This convenience function runs the merge routine as a processor for one or more objects. An example use case might be to turn all style entries into a css class name if it is not already a css class name. This should have the following behavior:
+
+- Style values two levels down should be processed
+- The object should remain unchanged if nothing changed
+- branches which are unchanged should be untouched
+- If a style gets updated the object should be mimally mutated
+
+The usage would be as follows. Given a processor called `myStyleProcessor`:
+
+```ts
+let complexObject: IMyObjtype = getObjectFromSomewhere();
+complexObject = processImmutable(
+  {
+    object: {
+      object: {
+        style: myStyleProcessor,
+      },
+    },
+  },
+  complexObject,
+);
+```
+
+While the primary use case is for a single object this allows merging to happen at the same time if so desired. Merging happens as normal with the exception that processors will still be called in the case where there is only one object.

package/src/index.ts

@@ -20,8 +20,21 @@ export { mergeStyles } from './merge-props/mergeStyles';
 export { mergeProps } from './merge-props/mergeProps';
 
 // component pattern exports
-export { renderSlot } from './component-patterns/renderSlot';
-export type { SlotFn, NativeReactType } from './component-patterns/renderSlot';
+export { renderForClassicRuntime, renderForJsxRuntime, renderSlot } from './component-patterns/render';
+export type {
+  DirectComponent,
+  DirectComponentFunction,
+  LegacyDirectComponent,
+  StagedComponent,
+  StagedRender,
+  TwoStageRender,
+  RenderType,
+  RenderResult,
+  ComposableFunction,
+  FinalRender,
+  SlotFn,
+  NativeReactType,
+} from './component-patterns/render.types';
 export { withSlots } from './component-patterns/withSlots';
-export { stagedComponent } from './component-patterns/stagedComponent';
-export type { FinalRender, StagedRender, ComposableFunction } from './component-patterns/stagedComponent';
+export { stagedComponent, twoStageComponent } from './component-patterns/stagedComponent';
+export { jsx, jsxs } from './jsx-runtime';

package/src/jsx-runtime.ts

@@ -0,0 +1,11 @@
+import type React from 'react';
+import * as ReactJSX from 'react/jsx-runtime';
+import { renderForJsxRuntime } from './component-patterns/render';
+
+export function jsx(type: React.ElementType, props: React.PropsWithChildren<unknown>, key?: React.Key): React.ReactElement {
+  return renderForJsxRuntime(type, props, key, ReactJSX.jsx);
+}
+
+export function jsxs(type: React.ElementType, props: React.PropsWithChildren<unknown>, key?: React.Key): React.ReactElement {
+  return renderForJsxRuntime(type, props, key, ReactJSX.jsxs);
+}

package/src/memo-cache/README.md

@@ -0,0 +1,141 @@
+# @fluentui-react-native/memo-cache
+
+This package implements a hierarchical memoization cache using an API pattern that mimics the react.js useMemo hook. It also provides an implementation of traditional JavaScript memoization built using react style utility.
+
+Memoization is an optimization pattern used when a discrete set of inputs, typically parameters to an expensive function, yield a deterministic output. In this case, if the inputs match a previous call, a cached result can be retrieved. This is typically implemented as a factory function, which wraps a function in a closure, adding implicit caching.
+
+React.js provides a hook called `useMemo` which is shifts to a more explicit model, where the keys are listed explicitly. This allows more control over the inputs than the older pattern. It's worth mentioning that the react `useMemo` hook is not a global cache, it is attached to a given component instance and compares the current execution with the previous one.
+
+### When to Use This
+
+This package can be beneficial in two scenarios:
+
+#### Performance
+
+If the routine to be memoized is expensive, then caching the results can boost performance. Note that cache lookups have cost themselves so memoizing a trivial function will likely be slower.
+
+Also note that every additional key adds a level of depth to the hierarchical cache. This has expense and reduces the likelihood of data being already in the cache. Collapsing the inputs to a manageable set helps optimize this. For instance, if building a style from a theme definition pulls 8 values from a theme, it is more efficient to key the resulting object on the theme, than to key each property individually.
+
+#### Object Identity
+
+The other benefit to this pattern is maintaining object identity between subsequent calls. In react-native the object identity of the style property will sometimes be compared, even if the values within are identical, the shallow props compare will not see the objects as the same.
+
+Similarly if a style is being turned into a CSS class (which is expensive), a `WeakMap` to map style objects to CSS classes will only work if the object identities are maintained.
+
+## Usage guide
+
+The baseline cache pattern is defined by the following type:
+
+```ts
+export type GetMemoValue<T, TGet = any> = (
+  factory: T | () => T,
+  keys: any[]
+) => [T, GetMemoValue<TGet>];
+```
+
+The parameters are used as follows:
+
+| Param     | Description                                                                                                                                                                                                                                                                             |
+| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `factory` | This is typically a function, often a simple closure, which returns a value. This value will be cached for a given set of keys. Subsequent calls will just return the value without executing the function. This can also be a value type in which case that will be returned directly. |
+| `keys`    | Variable parameter list, used as the keys for caching. Note that the order of keys matter. [A, B] resolves differently than [B, A].                                                                                                                                                     |
+
+The return result is a tuple with two elements containing:
+
+- The result of the factory function, or the value of factory if it is not a function
+- A function for caching which is local to the previous keys queried
+
+This recursive calling pattern allows for a natural pipelining of caching and memoization. Because the cache is effectively implemented as a tree, this pattern falls out fairly easily. See the examples below for more detail.
+
+### getMemoCache
+
+To get an instance of the memo cache to work with, a caller starts by calling `getMemoCache`.
+
+```ts
+export function getMemoCache<T = any>(globalKey?: object): GetMemoValue<T>;
+```
+
+This function takes an optional parameter `globalKey` which can be an object to use as a base cache reference.
+
+- If `globalKey` is specified, the same cache will be retrieved from the global call with the same object reference.
+- If `globalKey` is not specified the cache instance will be unique and contained entirely within the returned function.
+
+### memoize
+
+This library also provides a standard memoization wrapper:
+
+```ts
+export function memoize<T extends Function>(fn: T): T;
+```
+
+This should be able to handle any function as an input. It will create its own instance of the cache, use any parameters to the function as key values, and return a closure with the same signature as the input.
+
+This should support the following:
+
+- Function with any number of parameters
+- Functions with no parameters
+- Any return result
+- Void functions
+
+## Examples
+
+The following are some examples for how to use the functions above for various optimizations.
+
+### Merge styles to ensure object identity does not change
+
+Given a function to merge styles together, wrap it in a memoization helper to ensure object identities don't change. Then add a helper for ensuring a CSS rule exists for a set of styles.
+
+```ts
+// standard function which will be memoized
+function mergeStylesWorker(...cssStyles: CSSStyle[]): CSSStyle {
+  // do the work of merging multiple styles together to form a new CSS style
+}
+
+// exported function internally has a caching layer with memoize
+export const mergeStyles = memoize(mergeStylesWorker);
+
+// all-in-one authoring of memoized function, this one to turn a style into a CSS class, traditionally
+// an expensive operation in browsers
+export const createRuleForStyle = memoize((style: CSSStyle) => {
+  const className = // do the work of creating the rule
+  return className;
+});
+```
+
+### Hierarchical Theme Caching
+
+This demonstrates a component called `MyComponent` that:
+
+1. has a unique cache based on the component identity
+2. cached a style computed against a theme
+3. optionally merges a style from props and caches that result
+
+These three levels of caching are effectively instance -> theme -> props.style.
+
+```ts
+import { getMemoCache } from '@fluentui-react-native/memo-cache';
+
+// get a unique cache for this component
+const myComponentCache = getMemoCache();
+
+// component is a function that takes props
+export const MyComponent = (props: IMyComponentProps) => {
+  const theme = useContext(ThemeContext);
+  const newProps = { ...props };
+
+  // get the style, cached against the theme so it will only be called once, note that because
+  const [style, themeLocalCache] = myComponentCache(() => {
+    const colors = theme.colors;
+    return {
+      backgroundColor: colors.neutralBackground,
+      color: colors.neutralForeground,
+      // more stuff from theme
+    };
+  }, [theme]);
+
+  // merge the styles if a style is passed in via props, caching the union to ensure consistent object identity
+  newProps.style = newProps.style ? themeLocalCache(() => mergeStyles(style, newProps.style), [newProps.style])[0] : style;
+
+  return <InnerControl {...newProps} />;
+};
+```

package/src/merge-props/README.md

@@ -0,0 +1,43 @@
+# @fluentui-react-native/merge-props
+
+Utilities for merging styles and props (which contain styles)
+
+## Merging Props
+
+The `mergeProps` routine handles merging props together. Generally this is a standard per property merge identical to the behavior of `Object.assign` with the following two exceptions:
+
+- Objects under `props.style` will be merged using `mergeStyle` above, including caching the resolved styles
+- Strings contained in `props.className` will be joined together using spaces as a delimiter.
+
+## Merging Styles
+
+Styles are defined using the standard react-native pattern and will be merged in a way that maintains object identity where possible.
+
+### StyleProp
+
+This is a copy of the StyleProp definition from `react-native`. This is copied primarily in the case where it is used in web code where adding a dependency on the `react-native` package itself is not desireable.
+
+The StyleProp pattern itself is allows a style to be provided as a style or a recursive array of styles. So the following pattern is allowed:
+
+```ts
+props = {
+  style: [{ ...style1 }, [{ ...style2 }, { ...style3 }, [{ ...style4 }]], { ...style5 }],
+};
+```
+
+In this model merging styles can be effectively deferred by the following:
+
+```ts
+const styleToMerge = { ...values };
+props.style = [props.style, styleToMerge];
+```
+
+### mergeStyles
+
+This routine merges one or more react-native styles together. The inputs are styles in the `StyleProp` format referenced above. The various input styles will be flattened and merged together to produce a single non-flattened output style.
+
+```ts
+function mergeStyles<T>(...styles: StyleProp<T>[]): T;
+```
+
+This routine has a built-in caching layer that will attempt to ensure that object identity remains consistent. This means that style A + style B, where the references to A and B are the same, will always produce object C, where the reference will also be the same.

package/lib/component-patterns/renderSlot.d.ts

@@ -1,21 +0,0 @@
-import * as React from 'react';
-/**
- * Component slots have a marker which allows the slot render handler to know which ones are safe to call as a function.
- */
-export type SlotFn<TProps> = React.FunctionComponent<TProps> & {
-    _canCompose?: boolean;
-};
-/**
- * The standard element type inputs for react and react-native. This might be View or Button, or it might be 'div' in web. Effectively
- * it is what react accepts for React.createElement
- */
-export type NativeReactType = React.ElementType<any> | string;
-/**
- * Renders a slot
- *
- * @param slot - native react type or slot function to render
- * @param extraProps - additional props to mixin
- * @param children - the children to pass down to the slot
- */
-export declare function renderSlot<TProps>(slot: NativeReactType | SlotFn<TProps>, extraProps: TProps, ...children: React.ReactNode[]): React.ReactElement<any, any>;
-//# sourceMappingURL=renderSlot.d.ts.map

package/lib/component-patterns/renderSlot.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"renderSlot.d.ts","sourceRoot":"","sources":["../../src/component-patterns/renderSlot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,GAAG;IAC7D,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;AAE9D;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,KAAK,CAAC,SAAS,EAAE,gCAI5H"}

package/lib/component-patterns/renderSlot.js

@@ -1,14 +0,0 @@
-import * as React from 'react';
-/**
- * Renders a slot
- *
- * @param slot - native react type or slot function to render
- * @param extraProps - additional props to mixin
- * @param children - the children to pass down to the slot
- */
-export function renderSlot(slot, extraProps, ...children) {
-    return typeof slot === 'function' && slot._canCompose
-        ? slot(extraProps, ...children)
-        : React.createElement(slot, extraProps, ...children);
-}
-//# sourceMappingURL=renderSlot.js.map

package/lib/component-patterns/renderSlot.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"renderSlot.js","sourceRoot":"","sources":["../../src/component-patterns/renderSlot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAe/B;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAS,IAAsC,EAAE,UAAkB,EAAE,GAAG,QAA2B;IAC3H,OAAO,OAAO,IAAI,KAAK,UAAU,IAAK,IAAuB,CAAC,WAAW;QACvE,CAAC,CAAE,IAAuB,CAAC,UAAU,EAAE,GAAG,QAAQ,CAAC;QACnD,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC,CAAC;AACzD,CAAC"}

package/lib-commonjs/component-patterns/renderSlot.d.ts

@@ -1,21 +0,0 @@
-import * as React from 'react';
-/**
- * Component slots have a marker which allows the slot render handler to know which ones are safe to call as a function.
- */
-export type SlotFn<TProps> = React.FunctionComponent<TProps> & {
-    _canCompose?: boolean;
-};
-/**
- * The standard element type inputs for react and react-native. This might be View or Button, or it might be 'div' in web. Effectively
- * it is what react accepts for React.createElement
- */
-export type NativeReactType = React.ElementType<any> | string;
-/**
- * Renders a slot
- *
- * @param slot - native react type or slot function to render
- * @param extraProps - additional props to mixin
- * @param children - the children to pass down to the slot
- */
-export declare function renderSlot<TProps>(slot: NativeReactType | SlotFn<TProps>, extraProps: TProps, ...children: React.ReactNode[]): React.ReactElement<any, any>;
-//# sourceMappingURL=renderSlot.d.ts.map

package/lib-commonjs/component-patterns/renderSlot.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"renderSlot.d.ts","sourceRoot":"","sources":["../../src/component-patterns/renderSlot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,GAAG;IAC7D,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;AAE9D;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,KAAK,CAAC,SAAS,EAAE,gCAI5H"}

package/lib-commonjs/component-patterns/renderSlot.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderSlot = void 0;
-const tslib_1 = require("tslib");
-const React = tslib_1.__importStar(require("react"));
-/**
- * Renders a slot
- *
- * @param slot - native react type or slot function to render
- * @param extraProps - additional props to mixin
- * @param children - the children to pass down to the slot
- */
-function renderSlot(slot, extraProps, ...children) {
-    return typeof slot === 'function' && slot._canCompose
-        ? slot(extraProps, ...children)
-        : React.createElement(slot, extraProps, ...children);
-}
-exports.renderSlot = renderSlot;
-//# sourceMappingURL=renderSlot.js.map

package/lib-commonjs/component-patterns/renderSlot.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"renderSlot.js","sourceRoot":"","sources":["../../src/component-patterns/renderSlot.ts"],"names":[],"mappings":";;;;AAAA,qDAA+B;AAe/B;;;;;;GAMG;AACH,SAAgB,UAAU,CAAS,IAAsC,EAAE,UAAkB,EAAE,GAAG,QAA2B;IAC3H,OAAO,OAAO,IAAI,KAAK,UAAU,IAAK,IAAuB,CAAC,WAAW;QACvE,CAAC,CAAE,IAAuB,CAAC,UAAU,EAAE,GAAG,QAAQ,CAAC;QACnD,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC,CAAC;AACzD,CAAC;AAJD,gCAIC"}

package/src/component-patterns/renderSlot.ts

@@ -1,27 +0,0 @@
-import * as React from 'react';
-
-/**
- * Component slots have a marker which allows the slot render handler to know which ones are safe to call as a function.
- */
-export type SlotFn<TProps> = React.FunctionComponent<TProps> & {
-  _canCompose?: boolean;
-};
-
-/**
- * The standard element type inputs for react and react-native. This might be View or Button, or it might be 'div' in web. Effectively
- * it is what react accepts for React.createElement
- */
-export type NativeReactType = React.ElementType<any> | string;
-
-/**
- * Renders a slot
- *
- * @param slot - native react type or slot function to render
- * @param extraProps - additional props to mixin
- * @param children - the children to pass down to the slot
- */
-export function renderSlot<TProps>(slot: NativeReactType | SlotFn<TProps>, extraProps: TProps, ...children: React.ReactNode[]) {
-  return typeof slot === 'function' && (slot as SlotFn<TProps>)._canCompose
-    ? (slot as SlotFn<TProps>)(extraProps, ...children)
-    : React.createElement(slot, extraProps, ...children);
-}

package/src/component-patterns/stagedComponent.ts

@@ -1,53 +0,0 @@
-import * as React from 'react';
-
-/**
- * The final rendering of the props in a staged render. This is the function component signature that matches that of
- * React.createElement, children (if present) will be part of the variable args at the end.
- */
-export type FinalRender<TProps> = (props: TProps, ...children: React.ReactNode[]) => JSX.Element | null;
-
-/**
- * This is a pattern of rendering where a functional component can be executed in two stages rather than in a single pass.
- *
- * The pattern looks like:
- * (props) => {
- *   // handle props
- *   // call hooks, remember these can't be conditional
- *   // build styles and props to pass to child components
- *
- *   return (additionalProps, ...children) => {
- *     // return the actual element tree, this includes conditional branching or rendering
- *     // mixin additional props, props which require logic should be required in phase 1.
- *
- *     // NOTE: This is where children will show up
- *   };
- * }
- */
-
-export type StagedRender<TProps> = (props: TProps, ...args: any[]) => FinalRender<TProps>;
-
-/**
- * A composable function may have a two stage render function as an attached property. This allows the function to work
- * in all the standard react flows, but allows for pulling out the staged render when components understand it.
- */
-export type ComposableFunction<TProps> = React.FunctionComponent<TProps> & { _staged?: StagedRender<TProps> };
-
-function asArray<T>(val: T | T[]): T[] {
-  return Array.isArray(val) ? val : [val];
-}
-
-/**
- * Take a staged render function and make a real component out of it
- *
- * @param staged - staged render function to wrap into a staged component
- * @param memo - optional flag to enable wrapping the created component in a React.memo HOC
- */
-export function stagedComponent<TProps>(staged: StagedRender<TProps>, memo?: boolean): ComposableFunction<TProps> {
-  const component = (props: React.PropsWithChildren<TProps>) => {
-    const { children, ...rest } = props;
-    return staged(rest as TProps)({} as React.PropsWithChildren<TProps>, asArray(children));
-  };
-  const stagedComponent = memo ? React.memo(component) : component;
-  Object.assign(stagedComponent, { _staged: staged });
-  return stagedComponent as ComposableFunction<TProps>;
-}