Merge pull request #90 from latentflip/integrate-bundles-overwrite

- allow missing selectors in subscribeToSelectors with allowMissing option
- fix `init` being called too early when using `integrateBundles`
- docs updates
- switch to github actions for CI

Author: latentflip

.circleci/config.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build and test
+        run: npm run build && npm test

.github/workflows/ci.yaml

@@ -6,6 +6,6 @@ Created for and used by PWAs that value small bundle sizes, network resilience,
 
 If you pair it with [Preact](https://preactjs.com/) it's ~15kb for an entire app toolkit.
 
-If you want to see an app built with it, check out: [anesthesiacharting.com](https://anesthesiacharting.com).
+If you want to see an app built with it, check out: [xchart.com](https://xchart.com).
 
 See docs site here: https://reduxbundler.com

README.md

@@ -33,9 +33,14 @@ Shortcut for calling `store.select()` but passing in all known selector names.
 
 Add additional bundles after the fact. This will manage updating redux-bundler and internally using redux's `.replaceReducer` to update the store in place.
 
-## `store.subscribeToSelectors(arrayOfSelectors, callback)`
+Any `init` methods on the bundles will be called after the store is configured.
 
-Given an array of selector names, the callback will be called whenever the resulting values change.
+## `store.subscribeToSelectors(arrayOfSelectors, callback, [options])`
+
+Given an array of selector names, the callback will be called whenever the resulting values change. This will _not_ be called with the initial value/state of the selector.
+
+Passing `{ allowMissing: true }` as `options` will let you pass selectors that don't yet exist on the store without throwing an error. This may be helpful if
+a bundle that gets integrated later via `integrateBundle` will add a selector that you want to listen for. If the initial value of the selector when the new bundle is integrated is anything but `undefined` the callback will be fired with the initial value.
 
 Just like Redux's `subscribe()` it returns a function that can be used to unsubscribe.
 

docs/api/store.md

@@ -1,5 +1,9 @@
 # Change Log
 
+- `29.0.0` This release has some changes that are unlikely to be breaking, but for safety releasing as a major bump:
+  - Fixes a bug during `integrateBundles` calls where the new bundles' `init` functions would be called before the store reducer had been replaced; potentially causing the code in the `init` function to throw if it called a selector that depended on the new state. The `init` functions are now called as the final step in `integrateBundles` - this is unlikely to be a breaking but if you are using `integrateBundles` and `init` functions, verifying they are working as expected is advised.
+  - Adds an `allowMissing` option to `subsribeToSelectors`. If passed, you can now subscribe to selectors that don't yet exist without the `subscribeToSelectors` call throwing. If the selector is added later (via `integrateBundles`) then changes to that selector will be emitted to the callback as expected.
+  - Switched CI from circle ci to github actions
 - `28.1.0` Minor non-breaking enhancement to `createRouteBundle` to more easily allow dynamic replacement of routes. Adding `doReplaceRoutes` action creator and explicitly storing cached routes and routeMatcher in a reducer so they can be easily replaced.
 - `28.0.3` No API changes.
   - Replaces all uses of `self` with `globalThis`.