v0.5.1

mnasyrov · Jan 11, 2022 · 7ef89ad · 7ef89ad
1 parent 27420cb
commit 7ef89ad
Show file tree

Hide file tree

Showing 10 changed files with 406 additions and 85 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.5.1](https://github.com/mnasyrov/rx-effects/compare/v0.5.0...v0.5.1) (2022-01-11)
+
+### Bug Fixes
+
+- Do not expose internal stores to extensions ([27420cb](https://github.com/mnasyrov/rx-effects/commit/27420cb152ddfafa48f9d7f75b59e558ba982d64))
+
 # [0.5.0](https://github.com/mnasyrov/rx-effects/compare/v0.4.1...v0.5.0) (2022-01-11)
 
 ### Bug Fixes

diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
-  "version": "0.5.0",
+  "version": "0.5.1",
   "hoist": "**",
   "forceLocal": true,
   "command": {

diff --git a/packages/examples/CHANGELOG.md b/packages/examples/CHANGELOG.md
@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.5.1](https://github.com/mnasyrov/rx-effects/compare/v0.5.0...v0.5.1) (2022-01-11)
+
+**Note:** Version bump only for package rx-effects-examples
+
 # [0.5.0](https://github.com/mnasyrov/rx-effects/compare/v0.4.1...v0.5.0) (2022-01-11)
 
 **Note:** Version bump only for package rx-effects-examples

diff --git a/packages/examples/package.json b/packages/examples/package.json
@@ -1,12 +1,12 @@
 {
   "private": true,
   "name": "rx-effects-examples",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "type": "module",
   "sideEffects": false,
   "dependencies": {
-    "rx-effects": "0.5.0",
-    "rx-effects-react": "0.5.0"
+    "rx-effects": "0.5.1",
+    "rx-effects-react": "0.5.1"
   },
   "peerDependencies": {
     "react": ">=17.0.0",

diff --git a/packages/rx-effects-react/CHANGELOG.md b/packages/rx-effects-react/CHANGELOG.md
@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.5.1](https://github.com/mnasyrov/rx-effects/compare/v0.5.0...v0.5.1) (2022-01-11)
+
+**Note:** Version bump only for package rx-effects-react
+
 # [0.5.0](https://github.com/mnasyrov/rx-effects/compare/v0.4.1...v0.5.0) (2022-01-11)
 
 ### Bug Fixes

diff --git a/packages/rx-effects-react/docs/README.md b/packages/rx-effects-react/docs/README.md
@@ -33,15 +33,15 @@ If the factory is provided, it is called only once.
 
 | Name           | Type             | Description                        |
 | :------------- | :--------------- | :--------------------------------- |
-| `initialValue` | () => `T` \| `T` | a value or a factory for the value |
+| `initialValue` | `T` \| () => `T` | a value or a factory for the value |
 
 #### Returns
 
 `T`
 
 #### Defined in
 
-[rx-effects-react/src/useConst.ts:12](https://github.com/mnasyrov/rx-effects/blob/ed7b2fc/packages/rx-effects-react/src/useConst.ts#L12)
+[rx-effects-react/src/useConst.ts:12](https://github.com/mnasyrov/rx-effects/blob/27420cb/packages/rx-effects-react/src/useConst.ts#L12)
 
 ---
 
@@ -63,18 +63,18 @@ included explicitly when it is needed.
 
 #### Parameters
 
-| Name           | Type        | Description                                            |
-| :------------- | :---------- | :----------------------------------------------------- |
-| `factory`      | () => `T`   | a controller factory                                   |
-| `dependencies` | `unknown`[] | array of hook dependencies to recreate the controller. |
+| Name           | Type        | Default value        | Description                                            |
+| :------------- | :---------- | :------------------- | :----------------------------------------------------- |
+| `factory`      | () => `T`   | `undefined`          | a controller factory                                   |
+| `dependencies` | `unknown`[] | `EMPTY_DEPENDENCIES` | array of hook dependencies to recreate the controller. |
 
 #### Returns
 
 `T`
 
 #### Defined in
 
-[rx-effects-react/src/useController.ts:19](https://github.com/mnasyrov/rx-effects/blob/ed7b2fc/packages/rx-effects-react/src/useController.ts#L19)
+[rx-effects-react/src/useController.ts:18](https://github.com/mnasyrov/rx-effects/blob/27420cb/packages/rx-effects-react/src/useController.ts#L18)
 
 ---
 
@@ -113,7 +113,7 @@ const value = useObservable<string>(source$, undefined);
 
 #### Defined in
 
-[rx-effects-react/src/useObservable.ts:19](https://github.com/mnasyrov/rx-effects/blob/ed7b2fc/packages/rx-effects-react/src/useObservable.ts#L19)
+[rx-effects-react/src/useObservable.ts:19](https://github.com/mnasyrov/rx-effects/blob/27420cb/packages/rx-effects-react/src/useObservable.ts#L19)
 
 ---
 
@@ -153,7 +153,7 @@ useObserver(source$, observer);
 
 #### Defined in
 
-[rx-effects-react/src/useObserver.ts:21](https://github.com/mnasyrov/rx-effects/blob/ed7b2fc/packages/rx-effects-react/src/useObserver.ts#L21)
+[rx-effects-react/src/useObserver.ts:21](https://github.com/mnasyrov/rx-effects/blob/27420cb/packages/rx-effects-react/src/useObserver.ts#L21)
 
 ---
 
@@ -186,20 +186,20 @@ const value = useSelector<{ data: Record<string, string> }>(
 
 #### Parameters
 
-| Name           | Type                                | Description                                                                |
-| :------------- | :---------------------------------- | :------------------------------------------------------------------------- |
-| `source$`      | `Observable`<`S`\>                  | an observable for values                                                   |
-| `initialValue` | `S`                                 | th first value which is returned by the hook                               |
-| `selector`     | (`state`: `S`) => `R`               | a transform function for getting a derived value based on the source value |
-| `comparator`   | (`v1`: `R`, `v2`: `R`) => `boolean` | a comparator for previous and next values                                  |
+| Name           | Type                                | Default value        | Description                                                                |
+| :------------- | :---------------------------------- | :------------------- | :------------------------------------------------------------------------- |
+| `source$`      | `Observable`<`S`\>                  | `undefined`          | an observable for values                                                   |
+| `initialValue` | `S`                                 | `undefined`          | th first value which is returned by the hook                               |
+| `selector`     | (`state`: `S`) => `R`               | `undefined`          | a transform function for getting a derived value based on the source value |
+| `comparator`   | (`v1`: `R`, `v2`: `R`) => `boolean` | `DEFAULT_COMPARATOR` | a comparator for previous and next values                                  |
 
 #### Returns
 
 `R`
 
 #### Defined in
 
-[rx-effects-react/src/useSelector.ts:27](https://github.com/mnasyrov/rx-effects/blob/ed7b2fc/packages/rx-effects-react/src/useSelector.ts#L27)
+[rx-effects-react/src/useSelector.ts:27](https://github.com/mnasyrov/rx-effects/blob/27420cb/packages/rx-effects-react/src/useSelector.ts#L27)
 
 ---
 
@@ -227,4 +227,4 @@ Returns a value which is provided by the query.
 
 #### Defined in
 
-[rx-effects-react/src/useStateQuery.ts:9](https://github.com/mnasyrov/rx-effects/blob/ed7b2fc/packages/rx-effects-react/src/useStateQuery.ts#L9)
+[rx-effects-react/src/useStateQuery.ts:9](https://github.com/mnasyrov/rx-effects/blob/27420cb/packages/rx-effects-react/src/useStateQuery.ts#L9)
diff --git a/packages/rx-effects-react/package.json b/packages/rx-effects-react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "rx-effects-react",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Reactive state and effects management. Tooling for React.js",
   "license": "MIT",
   "author": "Mikhail Nasyrov (https://github.com/mnasyrov)",
@@ -45,7 +45,7 @@
     "build:esm": "tsc -p tsconfig.build.json --outDir dist/esm --module es2015"
   },
   "dependencies": {
-    "rx-effects": "0.5.0"
+    "rx-effects": "0.5.1"
   },
   "peerDependencies": {
     "react": ">=17.0.0",

diff --git a/packages/rx-effects/CHANGELOG.md b/packages/rx-effects/CHANGELOG.md
@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.5.1](https://github.com/mnasyrov/rx-effects/compare/v0.5.0...v0.5.1) (2022-01-11)
+
+### Bug Fixes
+
+- Do not expose internal stores to extensions ([27420cb](https://github.com/mnasyrov/rx-effects/commit/27420cb152ddfafa48f9d7f75b59e558ba982d64))
+
 # [0.5.0](https://github.com/mnasyrov/rx-effects/compare/v0.4.1...v0.5.0) (2022-01-11)
 
 ### Bug Fixes