@webiny/react-composition 6.0.0-beta.0 → 6.0.0-rc.0

package/types.d.ts

@@ -1,29 +1,35 @@
-import React from "react";
-export declare type GenericHook<TParams = any, TReturn = any> = (...args: TParams[]) => TReturn;
-export declare type GenericComponent<T = any> = React.FunctionComponent<T>;
-export declare type ComposedFunction = GenericHook;
-export declare type Decorator<T> = (decoratee: T) => T;
+import type React from "react";
+export type GenericHook<TParams = any, TReturn = any> = (...args: TParams[]) => TReturn;
+export type GenericComponent<T = any> = React.FunctionComponent<T>;
+export type ComposedFunction = GenericHook;
+export type Decorator<T> = (decoratee: T) => T;
+/**
+ * Some decoratable components will always return `null`, by design.
+ * To allow you to decorate these components, we must tell TS that the decorator is allowed to return not just `null`
+ * (which is inferred from the component type), but also a JSX.Element.
+ */
+export type ComponentDecorator<T> = (decoratee: T) => CanReturnNullOrElement<T>;
 /**
  * @deprecated
  */
-export declare type ComposableFC<T> = T & {
+export type ComposableFC<T> = T & {
     displayName?: string;
     original: T;
     originalName: string;
 };
-export declare type Enumerable<T> = T extends Array<infer D> ? Array<D> : never;
-export declare type ComposeWith = Decorator<GenericComponent> | Decorator<GenericComponent>[] | Decorator<GenericHook> | Decorator<GenericHook>[];
-export declare type DecoratableHook<T extends GenericHook = GenericHook> = T & {
+export type Enumerable<T> = T extends Array<infer D> ? Array<D> : never;
+export type ComposeWith = Decorator<GenericComponent> | Decorator<GenericComponent>[] | Decorator<GenericHook> | Decorator<GenericHook>[];
+export type DecoratableHook<T extends GenericHook = GenericHook> = T & {
     original: T;
     originalName: string;
 };
-export declare type DecoratableComponent<T = GenericComponent> = T & {
+export type DecoratableComponent<T = GenericComponent> = T & {
     original: T;
     originalName: string;
     displayName: string;
 };
-export declare type Decoratable = DecoratableComponent | DecoratableHook;
+export type Decoratable = DecoratableComponent | DecoratableHook;
 /**
  * @internal Add `null` to the ReturnType of the given function.
  */
-export declare type CanReturnNull<T> = T extends (...args: any) => any ? (...args: Parameters<T>) => ReturnType<T> | null : never;
+export type CanReturnNullOrElement<T> = T extends (...args: any) => any ? (...args: Parameters<T>) => JSX.Element | null : never;

package/types.js

@@ -1,7 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+export {};
 
 //# sourceMappingURL=types.js.map

package/types.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import React from \"react\";\n\nexport type GenericHook<TParams = any, TReturn = any> = (...args: TParams[]) => TReturn;\n\nexport type GenericComponent<T = any> = React.FunctionComponent<T>;\n\nexport type ComposedFunction = GenericHook;\n\nexport type Decorator<T> = (decoratee: T) => T;\n\n/**\n * @deprecated\n */\nexport type ComposableFC<T> = T & {\n    displayName?: string;\n    original: T;\n    originalName: string;\n};\n\nexport type Enumerable<T> = T extends Array<infer D> ? Array<D> : never;\n\nexport type ComposeWith =\n    | Decorator<GenericComponent>\n    | Decorator<GenericComponent>[]\n    | Decorator<GenericHook>\n    | Decorator<GenericHook>[];\n\nexport type DecoratableHook<T extends GenericHook = GenericHook> = T & {\n    original: T;\n    originalName: string;\n};\n\nexport type DecoratableComponent<T = GenericComponent> = T & {\n    original: T;\n    originalName: string;\n    displayName: string;\n};\n\nexport type Decoratable = DecoratableComponent | DecoratableHook;\n\n/**\n * @internal Add `null` to the ReturnType of the given function.\n */\nexport type CanReturnNull<T> = T extends (...args: any) => any\n    ? (...args: Parameters<T>) => ReturnType<T> | null\n    : never;\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type React from \"react\";\n\nexport type GenericHook<TParams = any, TReturn = any> = (...args: TParams[]) => TReturn;\n\nexport type GenericComponent<T = any> = React.FunctionComponent<T>;\n\nexport type ComposedFunction = GenericHook;\n\nexport type Decorator<T> = (decoratee: T) => T;\n\n/**\n * Some decoratable components will always return `null`, by design.\n * To allow you to decorate these components, we must tell TS that the decorator is allowed to return not just `null`\n * (which is inferred from the component type), but also a JSX.Element.\n */\nexport type ComponentDecorator<T> = (decoratee: T) => CanReturnNullOrElement<T>;\n\n/**\n * @deprecated\n */\nexport type ComposableFC<T> = T & {\n    displayName?: string;\n    original: T;\n    originalName: string;\n};\n\nexport type Enumerable<T> = T extends Array<infer D> ? Array<D> : never;\n\nexport type ComposeWith =\n    | Decorator<GenericComponent>\n    | Decorator<GenericComponent>[]\n    | Decorator<GenericHook>\n    | Decorator<GenericHook>[];\n\nexport type DecoratableHook<T extends GenericHook = GenericHook> = T & {\n    original: T;\n    originalName: string;\n};\n\nexport type DecoratableComponent<T = GenericComponent> = T & {\n    original: T;\n    originalName: string;\n    displayName: string;\n};\n\nexport type Decoratable = DecoratableComponent | DecoratableHook;\n\n/**\n * @internal Add `null` to the ReturnType of the given function.\n */\nexport type CanReturnNullOrElement<T> = T extends (...args: any) => any\n    ? (...args: Parameters<T>) => JSX.Element | null\n    : never;\n"],"mappings":"","ignoreList":[]}