@faasjs/react 0.0.4-beta.11 → 0.0.4-beta.12

package/README.md

@@ -35,6 +35,7 @@ React plugin for FaasJS.
 - [FaasReactClientInstance](#faasreactclientinstance)
 - [Options](#options)
 - [ResponseHeaders](#responseheaders)
+- [SignalOptions](#signaloptions)
 - [useFaasOptions](#usefaasoptions)
 
 ### Functions
@@ -43,6 +44,7 @@ React plugin for FaasJS.
 - [FaasReactClient](#faasreactclient)
 - [faas](#faas)
 - [getClient](#getclient)
+- [signal](#signal)
 - [useFaas](#usefaas)
 
 ## Type Aliases
@@ -183,6 +185,18 @@ ___
 
 ___
 
+### SignalOptions
+
+Ƭ **SignalOptions**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `debugName?` | `string` |
+
+___
+
 ### useFaasOptions
 
 Ƭ **useFaasOptions**\<`PathOrData`\>: `Object`
@@ -322,6 +336,31 @@ getClient('another-domain')
 
 ___
 
+### signal
+
+▸ **signal**\<`T`\>(`initialValue`, `options?`): `Signal`\<`T`\>
+
+Create a [signal](https://preactjs.com/guide/v10/signals) with options
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `initialValue` | `any` |
+| `options` | [`SignalOptions`](#signaloptions) |
+
+#### Returns
+
+`Signal`\<`T`\>
+
+___
+
 ### useFaas
 
 ▸ **useFaas**\<`PathOrData`\>(`action`, `defaultParams`, `options?`): [`FaasDataInjection`](#faasdatainjection)\<[`FaasData`](#faasdata)\<`PathOrData`\>\>

package/dist/index.d.mts

@@ -4,6 +4,8 @@ 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 { ReactNode, ReactElement, Component } from 'react';
+import * as _preact_signals_core from '@preact/signals-core';
+export { batch, computed, effect, signal as originSignal, useComputed, useSignal, useSignalEffect } from '@preact/signals-react';
 
 type FaasReactClientInstance = {
   id: string
@@ -161,4 +163,25 @@ declare class ErrorBoundary extends Component<ErrorBoundaryProps, {
     render(): string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode>;
 }
 
-export { ErrorBoundary, ErrorBoundaryProps, ErrorChildrenProps, FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, FaasReactClient, FaasReactClientInstance, faas, getClient, useFaas, useFaasOptions };
+type SignalOptions = {
+    debugName?: string;
+};
+/**
+ * Create a [signal](https://preactjs.com/guide/v10/signals) with options
+ *
+ * @param initialValue
+ * @param options
+ * @param options.debugName - debug name for signal, will print signal value to console.debug
+ *
+ * @example
+ * ```ts
+ * import { signal } from '@faasjs/react'
+ *
+ * const count = signal(0, { debugName: 'count' })
+ *
+ * count.value = 1
+ * ```
+ */
+declare function signal<T = any>(initialValue: any, options?: SignalOptions): _preact_signals_core.Signal<T>;
+
+export { ErrorBoundary, ErrorBoundaryProps, ErrorChildrenProps, FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, FaasReactClient, FaasReactClientInstance, SignalOptions, faas, getClient, signal, useFaas, useFaasOptions };

package/dist/index.d.ts

@@ -4,6 +4,8 @@ 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 { ReactNode, ReactElement, Component } from 'react';
+import * as _preact_signals_core from '@preact/signals-core';
+export { batch, computed, effect, signal as originSignal, useComputed, useSignal, useSignalEffect } from '@preact/signals-react';
 
 type FaasReactClientInstance = {
   id: string
@@ -161,4 +163,25 @@ declare class ErrorBoundary extends Component<ErrorBoundaryProps, {
     render(): string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode>;
 }
 
-export { ErrorBoundary, ErrorBoundaryProps, ErrorChildrenProps, FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, FaasReactClient, FaasReactClientInstance, faas, getClient, useFaas, useFaasOptions };
+type SignalOptions = {
+    debugName?: string;
+};
+/**
+ * Create a [signal](https://preactjs.com/guide/v10/signals) with options
+ *
+ * @param initialValue
+ * @param options
+ * @param options.debugName - debug name for signal, will print signal value to console.debug
+ *
+ * @example
+ * ```ts
+ * import { signal } from '@faasjs/react'
+ *
+ * const count = signal(0, { debugName: 'count' })
+ *
+ * count.value = 1
+ * ```
+ */
+declare function signal<T = any>(initialValue: any, options?: SignalOptions): _preact_signals_core.Signal<T>;
+
+export { ErrorBoundary, ErrorBoundaryProps, ErrorChildrenProps, FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, FaasReactClient, FaasReactClientInstance, SignalOptions, faas, getClient, signal, useFaas, useFaasOptions };

package/dist/index.js

@@ -3,6 +3,7 @@
 var react = require('react');
 var browser = require('@faasjs/browser');
 var jsxRuntime = require('react/jsx-runtime');
+var signalsReact = require('@preact/signals-react');
 
 // src/client.tsx
 var clients = {};
@@ -224,10 +225,45 @@ var ErrorBoundary = class extends react.Component {
     return this.props.children;
   }
 };
+function signal(initialValue, options = {}) {
+  const state = signalsReact.signal(initialValue);
+  if (options.debugName)
+    signalsReact.effect(() => console.debug(options.debugName, state.value));
+  return state;
+}
 
+Object.defineProperty(exports, 'batch', {
+  enumerable: true,
+  get: function () { return signalsReact.batch; }
+});
+Object.defineProperty(exports, 'computed', {
+  enumerable: true,
+  get: function () { return signalsReact.computed; }
+});
+Object.defineProperty(exports, 'effect', {
+  enumerable: true,
+  get: function () { return signalsReact.effect; }
+});
+Object.defineProperty(exports, 'originSignal', {
+  enumerable: true,
+  get: function () { return signalsReact.signal; }
+});
+Object.defineProperty(exports, 'useComputed', {
+  enumerable: true,
+  get: function () { return signalsReact.useComputed; }
+});
+Object.defineProperty(exports, 'useSignal', {
+  enumerable: true,
+  get: function () { return signalsReact.useSignal; }
+});
+Object.defineProperty(exports, 'useSignalEffect', {
+  enumerable: true,
+  get: function () { return signalsReact.useSignalEffect; }
+});
 exports.ErrorBoundary = ErrorBoundary;
 exports.FaasDataWrapper = FaasDataWrapper;
 exports.FaasReactClient = FaasReactClient;
 exports.faas = faas;
 exports.getClient = getClient;
+exports.signal = signal;
 exports.useFaas = useFaas;

package/dist/index.mjs

@@ -1,6 +1,8 @@
 import { useState, useEffect, cloneElement, Component } from 'react';
 import { FaasBrowserClient } from '@faasjs/browser';
 import { jsx, jsxs } from 'react/jsx-runtime';
+import { signal as signal$1, effect } from '@preact/signals-react';
+export { batch, computed, effect, signal as originSignal, useComputed, useSignal, useSignalEffect } from '@preact/signals-react';
 
 // src/client.tsx
 var clients = {};
@@ -222,5 +224,11 @@ var ErrorBoundary = class extends Component {
     return this.props.children;
   }
 };
+function signal(initialValue, options = {}) {
+  const state = signal$1(initialValue);
+  if (options.debugName)
+    effect(() => console.debug(options.debugName, state.value));
+  return state;
+}
 
-export { ErrorBoundary, FaasDataWrapper, FaasReactClient, faas, getClient, useFaas };
+export { ErrorBoundary, FaasDataWrapper, FaasReactClient, faas, getClient, signal, useFaas };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/react",
-  "version": "0.0.4-beta.11",
+  "version": "0.0.4-beta.12",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -22,14 +22,17 @@
     "dist"
   ],
   "dependencies": {
-    "@faasjs/browser": "0.0.4-beta.11"
+    "@faasjs/browser": "0.0.4-beta.12"
   },
   "peerDependencies": {
-    "react": "*"
+    "react": "*",
+    "@preact/signals-react": "*"
   },
   "devDependencies": {
     "@types/react": "*",
-    "react": "*"
+    "react": "*",
+    "@preact/signals-react": "*",
+    "@types/use-sync-external-store": "*"
   },
   "engines": {
     "npm": ">=9.0.0",