@faasjs/react 2.6.1 → 2.7.0

package/README.md

@@ -54,6 +54,7 @@ const client = FaasReactClient({
 - [FaasParams](type-aliases/FaasParams.md)
 - [FaasReactClientInstance](type-aliases/FaasReactClientInstance.md)
 - [FaasReactClientOptions](type-aliases/FaasReactClientOptions.md)
+- [OptionalWrapperProps](type-aliases/OptionalWrapperProps.md)
 - [Options](type-aliases/Options.md)
 - [ResponseHeaders](type-aliases/ResponseHeaders.md)
 - [useFaasOptions](type-aliases/useFaasOptions.md)
@@ -62,6 +63,7 @@ const client = FaasReactClient({
 
 - [FaasDataWrapper](functions/FaasDataWrapper.md)
 - [FaasReactClient](functions/FaasReactClient.md)
+- [OptionalWrapper](functions/OptionalWrapper.md)
 - [createSplitedContext](functions/createSplitedContext.md)
 - [createSplittingContext](functions/createSplittingContext.md)
 - [faas](functions/faas.md)

package/dist/index.d.mts

@@ -3,7 +3,7 @@ export { FaasAction, FaasData, FaasParams } from '@faasjs/types';
 import { Options, ResponseError, Response as Response$1 } from '@faasjs/browser';
 export { Options, Response, ResponseError, ResponseHeaders } from '@faasjs/browser';
 import * as react from 'react';
-import { ReactNode, ReactElement, Component } from 'react';
+import { ReactNode, ReactElement, Component, ComponentType, ComponentProps } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
@@ -240,4 +240,34 @@ declare class ErrorBoundary extends Component<ErrorBoundaryProps, {
     render(): string | number | boolean | Iterable<ReactNode> | react_jsx_runtime.JSX.Element;
 }
 
-export { ErrorBoundary, type ErrorBoundaryProps, type ErrorChildrenProps, type FaasDataInjection, FaasDataWrapper, type FaasDataWrapperProps, FaasReactClient, type FaasReactClientInstance, type FaasReactClientOptions, createSplitedContext, createSplittingContext, faas, getClient, useConstant, useFaas, type useFaasOptions };
+type OptionalWrapperProps<TWrapper extends ComponentType<{
+    children: ReactNode;
+}> = any> = {
+    condition: boolean;
+    Wrapper: TWrapper;
+    wrapperProps?: ComponentProps<TWrapper>;
+    children: ReactNode;
+};
+/**
+ * A wrapper component that conditionally wraps its children with a provided wrapper component.
+ *
+ * @example
+ * ```tsx
+ * import { OptionalWrapper } from '@faasjs/react'
+ *
+ * const Wrapper = ({ children }: { children: React.ReactNode }) => (
+ *   <div className='wrapper'>{children}</div>
+ * )
+ *
+ * const App = () => (
+ *   <OptionalWrapper condition={true} Wrapper={Wrapper}>
+ *     <span>Test</span>
+ *   </OptionalWrapper>
+ * )
+ * ```
+ */
+declare const OptionalWrapper: React.FC<OptionalWrapperProps> & {
+    whyDidYouRender: boolean;
+};
+
+export { ErrorBoundary, type ErrorBoundaryProps, type ErrorChildrenProps, type FaasDataInjection, FaasDataWrapper, type FaasDataWrapperProps, FaasReactClient, type FaasReactClientInstance, type FaasReactClientOptions, OptionalWrapper, type OptionalWrapperProps, createSplitedContext, createSplittingContext, faas, getClient, useConstant, useFaas, type useFaasOptions };

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { FaasAction, FaasData, FaasParams } from '@faasjs/types';
 import { Options, ResponseError, Response as Response$1 } from '@faasjs/browser';
 export { Options, Response, ResponseError, ResponseHeaders } from '@faasjs/browser';
 import * as react from 'react';
-import { ReactNode, ReactElement, Component } from 'react';
+import { ReactNode, ReactElement, Component, ComponentType, ComponentProps } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
@@ -240,4 +240,34 @@ declare class ErrorBoundary extends Component<ErrorBoundaryProps, {
     render(): string | number | boolean | Iterable<ReactNode> | react_jsx_runtime.JSX.Element;
 }
 
-export { ErrorBoundary, type ErrorBoundaryProps, type ErrorChildrenProps, type FaasDataInjection, FaasDataWrapper, type FaasDataWrapperProps, FaasReactClient, type FaasReactClientInstance, type FaasReactClientOptions, createSplitedContext, createSplittingContext, faas, getClient, useConstant, useFaas, type useFaasOptions };
+type OptionalWrapperProps<TWrapper extends ComponentType<{
+    children: ReactNode;
+}> = any> = {
+    condition: boolean;
+    Wrapper: TWrapper;
+    wrapperProps?: ComponentProps<TWrapper>;
+    children: ReactNode;
+};
+/**
+ * A wrapper component that conditionally wraps its children with a provided wrapper component.
+ *
+ * @example
+ * ```tsx
+ * import { OptionalWrapper } from '@faasjs/react'
+ *
+ * const Wrapper = ({ children }: { children: React.ReactNode }) => (
+ *   <div className='wrapper'>{children}</div>
+ * )
+ *
+ * const App = () => (
+ *   <OptionalWrapper condition={true} Wrapper={Wrapper}>
+ *     <span>Test</span>
+ *   </OptionalWrapper>
+ * )
+ * ```
+ */
+declare const OptionalWrapper: React.FC<OptionalWrapperProps> & {
+    whyDidYouRender: boolean;
+};
+
+export { ErrorBoundary, type ErrorBoundaryProps, type ErrorChildrenProps, type FaasDataInjection, FaasDataWrapper, type FaasDataWrapperProps, FaasReactClient, type FaasReactClientInstance, type FaasReactClientOptions, OptionalWrapper, type OptionalWrapperProps, createSplitedContext, createSplittingContext, faas, getClient, useConstant, useFaas, type useFaasOptions };

package/dist/index.js

@@ -268,10 +268,16 @@ var ErrorBoundary = class extends react.Component {
 };
 ErrorBoundary.whyDidYouRender = true;
 ErrorBoundary.whyDidYouRender = true;
+var OptionalWrapper = ({ condition, Wrapper, wrapperProps, children }) => {
+  console.debug("[OptionalWrapper] %s %s", Wrapper.name, condition);
+  return condition ? /* @__PURE__ */ jsxRuntime.jsx(Wrapper, { ...wrapperProps, children }) : /* @__PURE__ */ jsxRuntime.jsx(jsxRuntime.Fragment, { children });
+};
+OptionalWrapper.whyDidYouRender = true;
 
 exports.ErrorBoundary = ErrorBoundary;
 exports.FaasDataWrapper = FaasDataWrapper;
 exports.FaasReactClient = FaasReactClient;
+exports.OptionalWrapper = OptionalWrapper;
 exports.createSplitedContext = createSplitedContext;
 exports.createSplittingContext = createSplittingContext;
 exports.faas = faas;

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { useRef, createContext, useState, useEffect, Component, cloneElement, useContext, useCallback, useMemo } from 'react';
-import { jsx, jsxs } from 'react/jsx-runtime';
+import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import { FaasBrowserClient } from '@faasjs/browser';
 
 // src/constant.ts
@@ -266,5 +266,10 @@ var ErrorBoundary = class extends Component {
 };
 ErrorBoundary.whyDidYouRender = true;
 ErrorBoundary.whyDidYouRender = true;
+var OptionalWrapper = ({ condition, Wrapper, wrapperProps, children }) => {
+  console.debug("[OptionalWrapper] %s %s", Wrapper.name, condition);
+  return condition ? /* @__PURE__ */ jsx(Wrapper, { ...wrapperProps, children }) : /* @__PURE__ */ jsx(Fragment, { children });
+};
+OptionalWrapper.whyDidYouRender = true;
 
-export { ErrorBoundary, FaasDataWrapper, FaasReactClient, createSplitedContext, createSplittingContext, faas, getClient, useConstant, useFaas };
+export { ErrorBoundary, FaasDataWrapper, FaasReactClient, OptionalWrapper, createSplitedContext, createSplittingContext, faas, getClient, useConstant, useFaas };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/react",
-  "version": "2.6.1",
+  "version": "2.7.0",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -17,7 +17,7 @@
       }
     }
   },
-  "homepage": "https://faasjs.com/doc/react",
+  "homepage": "https://faasjs.com/doc/react/",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/faasjs/faasjs.git",
@@ -34,7 +34,7 @@
     "dist"
   ],
   "dependencies": {
-    "@faasjs/browser": "2.6.1"
+    "@faasjs/browser": "2.7.0"
   },
   "peerDependencies": {
     "react": "*"