@faasjs/react 2.2.0 → 2.3.0

package/README.md

@@ -7,6 +7,13 @@ React plugin for FaasJS.
 
 **If you use [SWR](https://swr.vercel.app) or [React Query / TanStack Query](https://tanstack.com/query), please use [`@faasjs/browser`](https://faasjs.com/doc/browser) directly.**
 
+## Features
+
+- Support [FaasJS Request Specifications](https://faasjs.com/guide/request-spec.html).
+- Support global and per-request configurations.
+- Capiable with [why-did-you-render](https://github.com/welldone-software/why-did-you-render).
+- Additional functions for React.
+
 ## Install
 
 ```sh

package/dist/index.d.mts

@@ -2,8 +2,9 @@ import { FaasAction as FaasAction$1, FaasParams as FaasParams$1, FaasData as Faa
 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_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
 import { ReactNode, ReactElement, Component } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
  * Returns a constant value that is created by the given function.
@@ -16,15 +17,14 @@ declare namespace useConstant {
 /**
  * Creates a splited context with the given default value.
  *
- * @template T - The type of the default value.
- * @param {T} defaultValue - The default value for the split context.
- * @returns {Object} - An object containing the Provider and use functions.
- *
  * @example
  * ```tsx
- * const { Provider, use } = createSplitedContext({
+ * const { Provider, use } = createSplitedContext<{
+ *   value: number
+ *   setValue: React.Dispatch<React.SetStateAction<number>>
+ * }>({
  *   value: 0,
- *   setValue: (_: any) => {},
+ *   setValue: null,
  * })
  *
  * function ReaderComponent() {
@@ -43,38 +43,26 @@ declare namespace useConstant {
  *   )
  * }
  *
- * const App = memo(() => {
- *   return (
- *     <>
- *       <ReaderComponent />
- *       <WriterComponent />
- *     </>
- *   )
- * })
- *
- * function Container() {
+ * function App() {
  *   const [value, setValue] = useState(0)
  *
  *   return (
  *     <Provider value={{ value, setValue }}>
- *       <App />
+ *       <ReaderComponent />
+ *       <WriterComponent />
  *     </Provider>
  *   )
  * }
  * ```
  */
-declare function createSplitedContext<T extends Record<string, any>>(defaultValue: T): {
-    Provider: {
-        (props: {
-            value: T;
-            children: React.ReactNode;
-        }): react_jsx_runtime.JSX.Element;
-        whyDidYouRender: boolean;
-    };
-    use: {
-        (): Readonly<T>;
-        whyDidYouRender: boolean;
-    };
+declare function createSplitedContext<T extends Record<string, any>>(defaultValue: {
+    [K in keyof T]: Partial<T[K]>;
+}): {
+    Provider: (props: {
+        value?: Partial<T>;
+        children: React.ReactNode;
+    }) => react.ReactNode;
+    use: () => Readonly<T>;
 };
 
 type FaasReactClientInstance = {

package/dist/index.d.ts

@@ -2,8 +2,9 @@ import { FaasAction as FaasAction$1, FaasParams as FaasParams$1, FaasData as Faa
 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_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
 import { ReactNode, ReactElement, Component } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
  * Returns a constant value that is created by the given function.
@@ -16,15 +17,14 @@ declare namespace useConstant {
 /**
  * Creates a splited context with the given default value.
  *
- * @template T - The type of the default value.
- * @param {T} defaultValue - The default value for the split context.
- * @returns {Object} - An object containing the Provider and use functions.
- *
  * @example
  * ```tsx
- * const { Provider, use } = createSplitedContext({
+ * const { Provider, use } = createSplitedContext<{
+ *   value: number
+ *   setValue: React.Dispatch<React.SetStateAction<number>>
+ * }>({
  *   value: 0,
- *   setValue: (_: any) => {},
+ *   setValue: null,
  * })
  *
  * function ReaderComponent() {
@@ -43,38 +43,26 @@ declare namespace useConstant {
  *   )
  * }
  *
- * const App = memo(() => {
- *   return (
- *     <>
- *       <ReaderComponent />
- *       <WriterComponent />
- *     </>
- *   )
- * })
- *
- * function Container() {
+ * function App() {
  *   const [value, setValue] = useState(0)
  *
  *   return (
  *     <Provider value={{ value, setValue }}>
- *       <App />
+ *       <ReaderComponent />
+ *       <WriterComponent />
  *     </Provider>
  *   )
  * }
  * ```
  */
-declare function createSplitedContext<T extends Record<string, any>>(defaultValue: T): {
-    Provider: {
-        (props: {
-            value: T;
-            children: React.ReactNode;
-        }): react_jsx_runtime.JSX.Element;
-        whyDidYouRender: boolean;
-    };
-    use: {
-        (): Readonly<T>;
-        whyDidYouRender: boolean;
-    };
+declare function createSplitedContext<T extends Record<string, any>>(defaultValue: {
+    [K in keyof T]: Partial<T[K]>;
+}): {
+    Provider: (props: {
+        value?: Partial<T>;
+        children: React.ReactNode;
+    }) => react.ReactNode;
+    use: () => Readonly<T>;
 };
 
 type FaasReactClientInstance = {

package/dist/index.js

@@ -15,18 +15,19 @@ function useConstant(fn) {
 useConstant.whyDidYouRender = true;
 function createSplitedContext(defaultValue) {
   const contexts = {};
-  for (const key of Object.keys(defaultValue))
+  const keys = Object.keys(defaultValue);
+  for (const key of keys)
     contexts[key] = react.createContext(defaultValue[key]);
   function Provider(props) {
+    var _a, _b;
     let children = props.children;
-    for (const key of Object.keys(props.value)) {
+    for (const key of keys) {
       const Context = contexts[key];
-      Context.Provider.whyDidYouRender = true;
-      children = /* @__PURE__ */ jsxRuntime.jsx(Context.Provider, { value: props.value[key], children });
+      const value = (_b = (_a = props.value) == null ? void 0 : _a[key]) != null ? _b : defaultValue[key];
+      children = /* @__PURE__ */ jsxRuntime.jsx(Context.Provider, { value, children });
     }
-    return /* @__PURE__ */ jsxRuntime.jsx(jsxRuntime.Fragment, { children });
+    return children;
   }
-  Provider.whyDidYouRender = true;
   function use() {
     return useConstant(() => {
       const obj = /* @__PURE__ */ Object.create(null);
@@ -38,7 +39,6 @@ function createSplitedContext(defaultValue) {
       return Object.freeze(obj);
     });
   }
-  use.whyDidYouRender = true;
   return {
     Provider,
     use

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { useRef, createContext, useState, useEffect, Component, cloneElement, useContext, useCallback, useMemo } from 'react';
-import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
+import { jsx, jsxs } from 'react/jsx-runtime';
 import { FaasBrowserClient } from '@faasjs/browser';
 
 // src/constant.ts
@@ -13,18 +13,19 @@ function useConstant(fn) {
 useConstant.whyDidYouRender = true;
 function createSplitedContext(defaultValue) {
   const contexts = {};
-  for (const key of Object.keys(defaultValue))
+  const keys = Object.keys(defaultValue);
+  for (const key of keys)
     contexts[key] = createContext(defaultValue[key]);
   function Provider(props) {
+    var _a, _b;
     let children = props.children;
-    for (const key of Object.keys(props.value)) {
+    for (const key of keys) {
       const Context = contexts[key];
-      Context.Provider.whyDidYouRender = true;
-      children = /* @__PURE__ */ jsx(Context.Provider, { value: props.value[key], children });
+      const value = (_b = (_a = props.value) == null ? void 0 : _a[key]) != null ? _b : defaultValue[key];
+      children = /* @__PURE__ */ jsx(Context.Provider, { value, children });
     }
-    return /* @__PURE__ */ jsx(Fragment, { children });
+    return children;
   }
-  Provider.whyDidYouRender = true;
   function use() {
     return useConstant(() => {
       const obj = /* @__PURE__ */ Object.create(null);
@@ -36,7 +37,6 @@ function createSplitedContext(defaultValue) {
       return Object.freeze(obj);
     });
   }
-  use.whyDidYouRender = true;
   return {
     Provider,
     use

package/package.json

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