fluxie 1.0.0 → 1.2.0

package/.github/workflows/cut-and-release.yml

@@ -15,20 +15,5 @@ jobs:
     steps:
       - uses: googleapis/release-please-action@v4
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          release-type: simple
-
-  deploy-npm:
-    needs: release-please
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version-file: ".nvmrc"
-          registry-url: https://registry.npmjs.org
-      - run: npm install
-      - run: npm run build
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
+          release-type: node

package/.github/workflows/publish-npm.yml

@@ -0,0 +1,20 @@
+on:
+  release:
+    types: [published]
+
+name: publish-npm
+
+jobs:
+  deploy-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          registry-url: "https://registry.npmjs.org"
+      - run: npm install
+      - run: npm run build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## [1.2.0](https://github.com/LesFabricants/Fluxie/compare/v1.1.0...v1.2.0) (2024-06-04)
+
+
+### Features
+
+* **pkg:** add package.json data ([23b1b79](https://github.com/LesFabricants/Fluxie/commit/23b1b79e6a2f5d448cb0e7a6a263b7259a5809c2))
+
+## [1.1.0](https://github.com/LesFabricants/Fluxie/compare/v1.0.0...v1.1.0) (2024-06-04)
+
+
+### Features
+
+* **store:** update store name to prevent conflicts ([5f1662c](https://github.com/LesFabricants/Fluxie/commit/5f1662cae25ba8c70cc3113bd28014c16d8229d9))

package/README.md

@@ -183,5 +183,3 @@ if (!environment.production) {
 ```
 
 Your redux devtool menu will now show all your store actions, the option `storeName` will be the store instance name there (defaults to the class name if not provided), and every service extending the `Store` class will be its own instance in the dropdown at the top.
-
-![The redux devtool window is opened, showing the store called "Users", in the "action" section, "set users" and "toggle user selection" are shown being called multiple times](assets/devtool.png)

package/dist/devtools.d.ts

@@ -0,0 +1,5 @@
+import { BehaviorSubject } from "rxjs";
+export declare let isDevtoolEnabled: boolean;
+export declare function enableReduxDevtools(): void;
+export declare function initializeReduxDevtools(storeName: string, state: BehaviorSubject<any>, initialState: any): false | undefined;
+export declare function sendActionToDevtools(storeName: string, actionName: string, payload: any): false | undefined;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { Store } from "./store";
+export { enableReduxDevtools, isDevtoolEnabled } from "./devtools";

package/dist/index.js

@@ -0,0 +1 @@
+import{BehaviorSubject as p}from"rxjs";var r={},o=!1;function h(){o=!0}function l(i,t,s){if(!d())return!1;let e=window?.__REDUX_DEVTOOLS_EXTENSION__.connect({name:i});e.init(s),e.subscribe(n=>{n.type==="DISPATCH"&&n.payload.type==="JUMP_TO_ACTION"&&t.next(JSON.parse(n.state))}),r[i]=e}function c(i,t,s){if(!d())return!1;if(!o)throw new Error("Devtools not enabled, please call enableReduxDevtools() in app.module.ts");r[i].send(t,s)}function d(){return window?.__REDUX_DEVTOOLS_EXTENSION__!==void 0}import{toSignal as u}from"@angular/core/rxjs-interop";var a=class{options;state;select$;select;db;constructor(t,s){if(this.options={...s,storeName:s?.storeName??this.constructor.name},this.state=new p(t),this.select$=this.state.asObservable(),this.select=u(this.state),s?.cache){let e=globalThis.indexedDB.open("__FLUXIE_STORE",1);e.onerror=()=>{console.error(`IndexedDB error: ${e.error}`)},e.onsuccess=()=>{this.db=e.result,this.initializeFromIndexedDB()},e.onupgradeneeded=n=>{this.db=e.result,n.newVersion===1&&this.db.createObjectStore("cachedData"),this.initializeFromIndexedDB()}}o&&l(this.options.storeName,this.state,this.state.getValue())}setState(t,s){let e=s(this.state.getValue());this.state.next(e),this.options?.cache&&this.sendToIndexedDB(this.state.getValue()),o&&c(this.options.storeName,t,e)}async initializeFromIndexedDB(){let t=this.db.transaction("cachedData").objectStore("cachedData").get(this.options.storeName);t.onsuccess=()=>{let s=t.result;s?this.state.next(s):this.sendToIndexedDB(this.state.getValue())}}async sendToIndexedDB(t){this.db.transaction("cachedData","readwrite").objectStore("cachedData").put(t,this.options.storeName)}};export{a as Store,h as enableReduxDevtools,o as isDevtoolEnabled};

package/dist/store.d.ts

@@ -0,0 +1,18 @@
+import { Observable } from "rxjs";
+import { Signal } from "@angular/core";
+interface Options {
+    storeName: string;
+    cache?: boolean;
+}
+export declare class Store<T = any> {
+    private options;
+    private state;
+    readonly select$: Observable<T>;
+    readonly select: Signal<T | undefined>;
+    private db?;
+    constructor(initialState: T, options?: Partial<Options>);
+    setState(actionName: string, mutationFn: (state: T) => T): void;
+    private initializeFromIndexedDB;
+    private sendToIndexedDB;
+}
+export {};

package/package.json

@@ -2,17 +2,35 @@
   "name": "fluxie",
   "description": "Small helper class to easily implement Flux architecture using angular service, complete with redux devtool and caching support",
   "authors": "Anthony Lenglet",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "type": "module",
-  "main": "dist/main.js",
+  "main": "dist/index.js",
+  "author": {
+    "name": "Anthony Lenglet",
+    "url": "https://github.com/anthonylenglet"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/LesFabricants/Fluxie",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LesFabricants/Fluxie"
+  },
+  "keywords": [
+    "angular",
+    "flux",
+    "redux",
+    "devtool",
+    "caching"
+  ],
   "scripts": {
-    "build": "node esbuild.config.js"
+    "build": "node esbuild.config.js && ./node_modules/.bin/tsc -p tsconfig.json"
   },
   "peerDependencies": {
     "@angular/core": ">=17.0.0",
     "rxjs": ">=5.0.0"
   },
   "devDependencies": {
-    "esbuild": "^0.21.4"
+    "esbuild": "^0.21.4",
+    "typescript": "^5.4.5"
   }
 }

package/dist/main.js

@@ -1 +0,0 @@
-import{BehaviorSubject as p}from"rxjs";var r={},o=!1;function h(){o=!0}function l(i,t,s){if(!d())return!1;let e=window?.__REDUX_DEVTOOLS_EXTENSION__.connect({name:i});e.init(s),e.subscribe(n=>{n.type==="DISPATCH"&&n.payload.type==="JUMP_TO_ACTION"&&t.next(JSON.parse(n.state))}),r[i]=e}function c(i,t,s){if(!d())return!1;if(!o)throw new Error("Devtools not enabled, please call enableReduxDevtools() in app.module.ts");r[i].send(t,s)}function d(){return window?.__REDUX_DEVTOOLS_EXTENSION__!==void 0}import{toSignal as u}from"@angular/core/rxjs-interop";var a=class{options;state;select$;select;db;constructor(t,s){if(this.options={...s,storeName:s?.storeName??this.constructor.name},this.state=new p(t),this.select$=this.state.asObservable(),this.select=u(this.state),s?.cache){let e=globalThis.indexedDB.open("store",1);e.onerror=()=>{console.error(`IndexedDB error: ${e.error}`)},e.onsuccess=()=>{this.db=e.result,this.initializeFromIndexedDB()},e.onupgradeneeded=n=>{this.db=e.result,n.newVersion===1&&this.db.createObjectStore("cachedData"),this.initializeFromIndexedDB()}}o&&l(this.options.storeName,this.state,this.state.getValue())}setState(t,s){let e=s(this.state.getValue());this.state.next(e),this.options?.cache&&this.sendToIndexedDB(this.state.getValue()),o&&c(this.options.storeName,t,e)}async initializeFromIndexedDB(){let t=this.db.transaction("cachedData").objectStore("cachedData").get(this.options.storeName);t.onsuccess=()=>{let s=t.result;s?this.state.next(s):this.sendToIndexedDB(this.state.getValue())}}async sendToIndexedDB(t){this.db.transaction("cachedData","readwrite").objectStore("cachedData").put(t,this.options.storeName)}};export{a as Store,h as enableReduxDevtools,o as isDevtoolEnabled};