@faasjs/react 2.3.1 → 2.4.0

package/README.md

@@ -63,6 +63,7 @@ const client = FaasReactClient({
 - [FaasDataWrapper](functions/FaasDataWrapper.md)
 - [FaasReactClient](functions/FaasReactClient.md)
 - [createSplitedContext](functions/createSplitedContext.md)
+- [createSplittingContext](functions/createSplittingContext.md)
 - [faas](functions/faas.md)
 - [getClient](functions/getClient.md)
 - [useConstant](functions/useConstant.md)

package/dist/index.d.mts

@@ -15,11 +15,14 @@ declare namespace useConstant {
 }
 
 /**
- * Creates a splited context with the given default value.
+ * Creates a splitting context with the given default value.
+ *
+ * @param defaultValue The default value of the splitting context.
+ * @returns The provider component and the hook to use the splitting context.
  *
  * @example
  * ```tsx
- * const { Provider, use } = createSplitedContext<{
+ * const { Provider, use } = createSplittingContext<{
  *   value: number
  *   setValue: React.Dispatch<React.SetStateAction<number>>
  * }>({
@@ -55,7 +58,7 @@ declare namespace useConstant {
  * }
  * ```
  */
-declare function createSplitedContext<T extends Record<string, any>>(defaultValue: {
+declare function createSplittingContext<T extends Record<string, any>>(defaultValue: {
     [K in keyof T]: Partial<T[K]> | null;
 }): {
     Provider: (props: {
@@ -64,6 +67,10 @@ declare function createSplitedContext<T extends Record<string, any>>(defaultValu
     }) => react.ReactNode;
     use: () => Readonly<T>;
 };
+/**
+ * @deprecated Use `createSplittingContext` instead.
+ */
+declare const createSplitedContext: typeof createSplittingContext;
 
 type FaasReactClientInstance = {
   id: string
@@ -233,4 +240,4 @@ 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, faas, getClient, useConstant, useFaas, type useFaasOptions };
+export { ErrorBoundary, type ErrorBoundaryProps, type ErrorChildrenProps, type FaasDataInjection, FaasDataWrapper, type FaasDataWrapperProps, FaasReactClient, type FaasReactClientInstance, type FaasReactClientOptions, createSplitedContext, createSplittingContext, faas, getClient, useConstant, useFaas, type useFaasOptions };

package/dist/index.d.ts

@@ -15,11 +15,14 @@ declare namespace useConstant {
 }
 
 /**
- * Creates a splited context with the given default value.
+ * Creates a splitting context with the given default value.
+ *
+ * @param defaultValue The default value of the splitting context.
+ * @returns The provider component and the hook to use the splitting context.
  *
  * @example
  * ```tsx
- * const { Provider, use } = createSplitedContext<{
+ * const { Provider, use } = createSplittingContext<{
  *   value: number
  *   setValue: React.Dispatch<React.SetStateAction<number>>
  * }>({
@@ -55,7 +58,7 @@ declare namespace useConstant {
  * }
  * ```
  */
-declare function createSplitedContext<T extends Record<string, any>>(defaultValue: {
+declare function createSplittingContext<T extends Record<string, any>>(defaultValue: {
     [K in keyof T]: Partial<T[K]> | null;
 }): {
     Provider: (props: {
@@ -64,6 +67,10 @@ declare function createSplitedContext<T extends Record<string, any>>(defaultValu
     }) => react.ReactNode;
     use: () => Readonly<T>;
 };
+/**
+ * @deprecated Use `createSplittingContext` instead.
+ */
+declare const createSplitedContext: typeof createSplittingContext;
 
 type FaasReactClientInstance = {
   id: string
@@ -233,4 +240,4 @@ 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, faas, getClient, useConstant, useFaas, type useFaasOptions };
+export { ErrorBoundary, type ErrorBoundaryProps, type ErrorChildrenProps, type FaasDataInjection, FaasDataWrapper, type FaasDataWrapperProps, FaasReactClient, type FaasReactClientInstance, type FaasReactClientOptions, createSplitedContext, createSplittingContext, faas, getClient, useConstant, useFaas, type useFaasOptions };

package/dist/index.js

@@ -13,11 +13,10 @@ function useConstant(fn) {
   return ref.current.v;
 }
 useConstant.whyDidYouRender = true;
-function createSplitedContext(defaultValue) {
+function createSplittingContext(defaultValue) {
   const contexts = {};
   const keys = Object.keys(defaultValue);
-  for (const key of keys)
-    contexts[key] = react.createContext(defaultValue[key]);
+  for (const key of keys) contexts[key] = react.createContext(defaultValue[key]);
   function Provider(props) {
     var _a, _b;
     let children = props.children;
@@ -44,6 +43,7 @@ function createSplitedContext(defaultValue) {
     use
   };
 }
+var createSplitedContext = createSplittingContext;
 var clients = {};
 function FaasReactClient({
   domain,
@@ -60,8 +60,7 @@ function FaasReactClient({
     return client.action(action, params);
   }
   function useFaas2(action, defaultParams, options2) {
-    if (!options2)
-      options2 = {};
+    if (!options2) options2 = {};
     const [loading, setLoading] = react.useState(true);
     const [data, setData] = react.useState();
     const [error, setError] = react.useState();
@@ -115,8 +114,7 @@ function FaasReactClient({
             } catch (error2) {
               setError(error2);
             }
-          else
-            setError(e);
+          else setError(e);
           setLoading(false);
           return Promise.reject(e);
         });
@@ -137,8 +135,7 @@ function FaasReactClient({
     }, [action, JSON.stringify(options2.params || params), reloadTimes, skip]);
     const reload = react.useCallback(
       (params2) => {
-        if (params2)
-          setParams(params2);
+        if (params2) setParams(params2);
         setReloadTimes((prev) => prev + 1);
         return promise;
       },
@@ -176,19 +173,15 @@ function FaasReactClient({
     });
     const [loaded, setLoaded] = react.useState(false);
     react.useEffect(() => {
-      if (!loaded && !request.loading)
-        setLoaded(true);
+      if (!loaded && !request.loading) setLoaded(true);
     }, [request.loading]);
     react.useEffect(() => {
-      if (onDataChange)
-        onDataChange(request);
+      if (onDataChange) onDataChange(request);
     }, [JSON.stringify(request.data)]);
     const child = react.useMemo(() => {
       if (loaded) {
-        if (children)
-          return react.cloneElement(children, request);
-        if (render)
-          return render(request);
+        if (children) return react.cloneElement(children, request);
+        if (render) return render(request);
       }
       return fallback || null;
     }, [
@@ -213,8 +206,7 @@ function FaasReactClient({
 }
 function getClient(domain) {
   const client = clients[domain || Object.keys(clients)[0]];
-  if (!client)
-    throw Error("FaasReactClient is not initialized");
+  if (!client) throw Error("FaasReactClient is not initialized");
   return client;
 }
 async function faas(action, params) {
@@ -226,12 +218,10 @@ function useFaas(action, defaultParams, options) {
 function FaasDataWrapper(props) {
   const [client, setClient] = react.useState();
   react.useEffect(() => {
-    if (client)
-      return;
+    if (client) return;
     setClient(getClient());
   }, []);
-  if (!client)
-    return props.fallback || null;
+  if (!client) return props.fallback || null;
   return /* @__PURE__ */ jsxRuntime.jsx(client.FaasDataWrapper, { ...props });
 }
 FaasDataWrapper.whyDidYouRender = true;
@@ -278,6 +268,7 @@ exports.ErrorBoundary = ErrorBoundary;
 exports.FaasDataWrapper = FaasDataWrapper;
 exports.FaasReactClient = FaasReactClient;
 exports.createSplitedContext = createSplitedContext;
+exports.createSplittingContext = createSplittingContext;
 exports.faas = faas;
 exports.getClient = getClient;
 exports.useConstant = useConstant;

package/dist/index.mjs

@@ -11,11 +11,10 @@ function useConstant(fn) {
   return ref.current.v;
 }
 useConstant.whyDidYouRender = true;
-function createSplitedContext(defaultValue) {
+function createSplittingContext(defaultValue) {
   const contexts = {};
   const keys = Object.keys(defaultValue);
-  for (const key of keys)
-    contexts[key] = createContext(defaultValue[key]);
+  for (const key of keys) contexts[key] = createContext(defaultValue[key]);
   function Provider(props) {
     var _a, _b;
     let children = props.children;
@@ -42,6 +41,7 @@ function createSplitedContext(defaultValue) {
     use
   };
 }
+var createSplitedContext = createSplittingContext;
 var clients = {};
 function FaasReactClient({
   domain,
@@ -58,8 +58,7 @@ function FaasReactClient({
     return client.action(action, params);
   }
   function useFaas2(action, defaultParams, options2) {
-    if (!options2)
-      options2 = {};
+    if (!options2) options2 = {};
     const [loading, setLoading] = useState(true);
     const [data, setData] = useState();
     const [error, setError] = useState();
@@ -113,8 +112,7 @@ function FaasReactClient({
             } catch (error2) {
               setError(error2);
             }
-          else
-            setError(e);
+          else setError(e);
           setLoading(false);
           return Promise.reject(e);
         });
@@ -135,8 +133,7 @@ function FaasReactClient({
     }, [action, JSON.stringify(options2.params || params), reloadTimes, skip]);
     const reload = useCallback(
       (params2) => {
-        if (params2)
-          setParams(params2);
+        if (params2) setParams(params2);
         setReloadTimes((prev) => prev + 1);
         return promise;
       },
@@ -174,19 +171,15 @@ function FaasReactClient({
     });
     const [loaded, setLoaded] = useState(false);
     useEffect(() => {
-      if (!loaded && !request.loading)
-        setLoaded(true);
+      if (!loaded && !request.loading) setLoaded(true);
     }, [request.loading]);
     useEffect(() => {
-      if (onDataChange)
-        onDataChange(request);
+      if (onDataChange) onDataChange(request);
     }, [JSON.stringify(request.data)]);
     const child = useMemo(() => {
       if (loaded) {
-        if (children)
-          return cloneElement(children, request);
-        if (render)
-          return render(request);
+        if (children) return cloneElement(children, request);
+        if (render) return render(request);
       }
       return fallback || null;
     }, [
@@ -211,8 +204,7 @@ function FaasReactClient({
 }
 function getClient(domain) {
   const client = clients[domain || Object.keys(clients)[0]];
-  if (!client)
-    throw Error("FaasReactClient is not initialized");
+  if (!client) throw Error("FaasReactClient is not initialized");
   return client;
 }
 async function faas(action, params) {
@@ -224,12 +216,10 @@ function useFaas(action, defaultParams, options) {
 function FaasDataWrapper(props) {
   const [client, setClient] = useState();
   useEffect(() => {
-    if (client)
-      return;
+    if (client) return;
     setClient(getClient());
   }, []);
-  if (!client)
-    return props.fallback || null;
+  if (!client) return props.fallback || null;
   return /* @__PURE__ */ jsx(client.FaasDataWrapper, { ...props });
 }
 FaasDataWrapper.whyDidYouRender = true;
@@ -272,4 +262,4 @@ var ErrorBoundary = class extends Component {
 ErrorBoundary.whyDidYouRender = true;
 ErrorBoundary.whyDidYouRender = true;
 
-export { ErrorBoundary, FaasDataWrapper, FaasReactClient, createSplitedContext, faas, getClient, useConstant, useFaas };
+export { ErrorBoundary, FaasDataWrapper, FaasReactClient, createSplitedContext, createSplittingContext, faas, getClient, useConstant, useFaas };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/react",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -22,7 +22,7 @@
     "dist"
   ],
   "dependencies": {
-    "@faasjs/browser": "2.3.1"
+    "@faasjs/browser": "2.4.0"
   },
   "peerDependencies": {
     "react": "*"