@marianmeres/fetch-store 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Marian Meres
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,83 @@
+# @marianmeres/fetch-store
+
+[Store](https://github.com/marianmeres/store) utility for collecting results and meta info
+of any type of async work. Typically used for http requests.
+
+## Install
+```shell
+$ npm i @marianmeres/fetch-store
+```
+
+## Basic example
+
+```javascript
+// foo-store.js
+const foo = createFetchStore(
+    async () => {
+         const r = await fetch('foo.json');
+         if (!r.ok) throw new Error('Not OK!');
+         return await r.json()
+    }
+);
+```
+```sveltehtml
+<!--FooComponent.svelte-->
+<script>
+    onMount(foo.fetch)
+</script>
+
+{#if $foo.isFetching}
+    <Spinner />
+{:else if $foo.lastFetchError}
+    <Error error={$foo.lastFetchError} />
+{:else}
+    <Foo foo={$foo.data} />
+{/if}
+```
+
+## Api
+
+```typescript
+const store = createFetchStore<T>(
+    // the async worker
+    fetchWorker: (...args) => Promise<any>,
+    // optional, initial `data` value of the store
+    initial?: T = null,
+    // optional, used to modify data returned by fetchWorker... (usefull for various
+    // data update strategies, like merge/deepmerge/set etc)
+    dataFactory?: (raw: any, old?: any) => T = null,
+    // options (see source)
+    options? = null
+);
+
+// subscription
+store.subscribe((v) => {
+    // main result
+    // v.data: T;
+
+    // meta
+    // v.isFetching: boolean;
+    // v.lastFetchStart: Date;
+    // v.lastFetchEnd: Date;
+    // v.lastFetchError: Date;
+    // v.successCounter: number;
+});
+
+// instance api
+
+// do the async work
+store.fetch: (...args) => Promise<void>;
+
+// do the async work, but do not update meta
+store.fetchSilent: (...args) => Promise<void>;
+
+// fetch only once (if within threshold since last)
+store.fetchOnce: (args: any[], thresholdMs: number) => Promise<void>;
+
+// to reset internal meta store
+store.reset: Function;
+store.resetError: Function;
+
+// for manual hackings
+store.getInternalDataStore();
+```

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";const e=e=>"function"==typeof e,t=(t,r="")=>{if(!e(t))throw new TypeError(`${r} Expecting function arg`.trim())},r=t=>e(t.subscribe),s=(r=undefined,s=null)=>{const n=t=>e(s?.persist)&&s.persist(t);let c=(()=>{const e=new Map,t=t=>(e.has(t)||e.set(t,new Set),e.get(t)),r=(e,r)=>{if("function"!=typeof r)throw new TypeError("Expecting callback function as second argument");return t(e).add(r),()=>t(e).delete(r)};return{publish:(e,r={})=>{t(e).forEach((e=>e(r)))},subscribe:r,subscribeOnce:(e,t)=>{const s=r(e,(e=>{t(e),s()}));return s},unsubscribeAll:t=>e.delete(t)}})(),a=r;n(a);const l=()=>a,i=e=>{a!==e&&(a=e,n(a),c.publish("change",a))};return{set:i,get:l,update:e=>{t(e,"[update]"),i(e(l()))},subscribe:e=>(t(e,"[subscribe]"),e(a),c.subscribe("change",e))}},n={fetchSilentDefaultThresholdMs:3e5},c=e=>"function"==typeof e;exports.createFetchStore=(a,l=null,i=null,u=null)=>{const{logger:o,onError:h,onSilentError:g,afterCreate:b,fetchSilentDefaultThresholdMs:f}={...n,...u||{}},p=(e,t)=>c(i)?i(e,t):e,E=s(p(l)),d=s({isFetching:!1,lastFetchStart:null,lastFetchEnd:null,lastFetchError:null,successCounter:0}),{subscribe:w,get:F}=((n,c,a=null)=>{const l=t=>e(a?.persist)&&a.persist(t),i=s(a?.initialValue),u=[];if(n.forEach((e=>{if(!r(e))throw new TypeError("Expecting array of StoreLike objects");e.subscribe((e=>u.push(e)))()})),!e(c))throw new TypeError("Expecting second argument to be the derivative function");if(!c.length||c.length>2)throw new TypeError("Expecting the derivative function to have exactly 1 or 2 arguments");let o=0,h=[];return{get:i.get,subscribe:e=>{t(e,"[derived.subscribe]"),o++||n.forEach(((e,t)=>{h.push(e.subscribe((e=>{u[t]=e,1===c.length?(i.set(c(u)),l(i.get())):c(u,(e=>{i.set(e),l(i.get())}))})))}));const r=i.subscribe(e);return()=>{--o||(h.forEach((e=>e())),h=[]),r()}}}})([E,d],(([e,t])=>({data:e,...t})));w((()=>null));const y=async(...e)=>{let t=E.get(),r=d.get();const s=new Date;let n=null;d.set({...r,isFetching:!0,lastFetchStart:s,lastFetchEnd:null,lastFetchError:n});try{t=p(await a(...e),t),r.successCounter++}catch(e){n=e}E.set(t),d.set({...r,isFetching:!1,lastFetchStart:s,lastFetchEnd:new Date,lastFetchError:n}),n&&c(h)&&h(n)},S={subscribe:w,get:F,fetch:y,fetchSilent:async(...e)=>{try{E.set(p(await a(...e),E.get()))}catch(e){((...e)=>{c(o)&&o.apply(null,e)})("silent fetch error",e),c(g)&&g(e)}},fetchOnce:async(e=[],t=f)=>{const{successCounter:r,isFetching:s,lastFetchStart:n}=d.get();return Array.isArray(e)||(e=[e]),r||s?t&&!s&&n&&Date.now()-new Date(n).valueOf()>t?await y(...e):void 0:await y(...e)},reset:()=>{E.set(p(l)),d.set({isFetching:!1,lastFetchStart:null,lastFetchEnd:null,lastFetchError:null,successCounter:0})},resetError:()=>d.update((e=>({...e,lastFetchError:null}))),getInternalDataStore:()=>E};return c(b)&&b(S),S};

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import { StoreLike, StoreReadable } from '@marianmeres/store';
+export interface FetchStoreMeta {
+    isFetching: boolean;
+    lastFetchStart: Date;
+    lastFetchEnd: Date;
+    lastFetchError: Date;
+    successCounter: number;
+}
+export interface FetchStoreValue<T> extends FetchStoreMeta {
+    data: T;
+}
+export interface FetchStore<T, V> extends StoreReadable<T> {
+    fetch: (...args: any[]) => Promise<void>;
+    fetchSilent: (...args: any[]) => Promise<void>;
+    fetchOnce: (args: any[], thresholdMs: number) => Promise<void>;
+    reset: Function;
+    resetError: Function;
+    getInternalDataStore: () => StoreLike<V>;
+}
+interface FetchStoreOptions {
+    logger: (...args: any[]) => void;
+    afterCreate: (fetchStoreInstance: any) => void;
+    fetchSilentDefaultThresholdMs: number;
+    onError: (e: any) => void;
+    onSilentError: (e: any) => void;
+}
+export declare const createFetchStore: <T>(fetchWorker: (...args: any[]) => Promise<any>, initial?: T, dataFactory?: (raw: any, old?: any) => T, options?: Partial<FetchStoreOptions>) => FetchStore<FetchStoreValue<T>, T>;
+export {};

package/dist/index.js

@@ -0,0 +1 @@
+const e=e=>"function"==typeof e,t=(t,r="")=>{if(!e(t))throw new TypeError(`${r} Expecting function arg`.trim())},r=t=>e(t.subscribe),s=(r=undefined,s=null)=>{const n=t=>e(s?.persist)&&s.persist(t);let c=(()=>{const e=new Map,t=t=>(e.has(t)||e.set(t,new Set),e.get(t)),r=(e,r)=>{if("function"!=typeof r)throw new TypeError("Expecting callback function as second argument");return t(e).add(r),()=>t(e).delete(r)};return{publish:(e,r={})=>{t(e).forEach((e=>e(r)))},subscribe:r,subscribeOnce:(e,t)=>{const s=r(e,(e=>{t(e),s()}));return s},unsubscribeAll:t=>e.delete(t)}})(),l=r;n(l);const a=()=>l,i=e=>{l!==e&&(l=e,n(l),c.publish("change",l))};return{set:i,get:a,update:e=>{t(e,"[update]"),i(e(a()))},subscribe:e=>(t(e,"[subscribe]"),e(l),c.subscribe("change",e))}},n={fetchSilentDefaultThresholdMs:3e5},c=e=>"function"==typeof e,l=(l,a=null,i=null,u=null)=>{const{logger:o,onError:h,onSilentError:g,afterCreate:b,fetchSilentDefaultThresholdMs:f}={...n,...u||{}},p=(e,t)=>c(i)?i(e,t):e,E=s(p(a)),d=s({isFetching:!1,lastFetchStart:null,lastFetchEnd:null,lastFetchError:null,successCounter:0}),{subscribe:w,get:F}=((n,c,l=null)=>{const a=t=>e(l?.persist)&&l.persist(t),i=s(l?.initialValue),u=[];if(n.forEach((e=>{if(!r(e))throw new TypeError("Expecting array of StoreLike objects");e.subscribe((e=>u.push(e)))()})),!e(c))throw new TypeError("Expecting second argument to be the derivative function");if(!c.length||c.length>2)throw new TypeError("Expecting the derivative function to have exactly 1 or 2 arguments");let o=0,h=[];return{get:i.get,subscribe:e=>{t(e,"[derived.subscribe]"),o++||n.forEach(((e,t)=>{h.push(e.subscribe((e=>{u[t]=e,1===c.length?(i.set(c(u)),a(i.get())):c(u,(e=>{i.set(e),a(i.get())}))})))}));const r=i.subscribe(e);return()=>{--o||(h.forEach((e=>e())),h=[]),r()}}}})([E,d],(([e,t])=>({data:e,...t})));w((()=>null));const y=async(...e)=>{let t=E.get(),r=d.get();const s=new Date;let n=null;d.set({...r,isFetching:!0,lastFetchStart:s,lastFetchEnd:null,lastFetchError:n});try{t=p(await l(...e),t),r.successCounter++}catch(e){n=e}E.set(t),d.set({...r,isFetching:!1,lastFetchStart:s,lastFetchEnd:new Date,lastFetchError:n}),n&&c(h)&&h(n)},S={subscribe:w,get:F,fetch:y,fetchSilent:async(...e)=>{try{E.set(p(await l(...e),E.get()))}catch(e){((...e)=>{c(o)&&o.apply(null,e)})("silent fetch error",e),c(g)&&g(e)}},fetchOnce:async(e=[],t=f)=>{const{successCounter:r,isFetching:s,lastFetchStart:n}=d.get();return Array.isArray(e)||(e=[e]),r||s?t&&!s&&n&&Date.now()-new Date(n).valueOf()>t?await y(...e):void 0:await y(...e)},reset:()=>{E.set(p(a)),d.set({isFetching:!1,lastFetchStart:null,lastFetchEnd:null,lastFetchError:null,successCounter:0})},resetError:()=>d.update((e=>({...e,lastFetchError:null}))),getInternalDataStore:()=>E};return c(b)&&b(S),S};export{l as createFetchStore};

package/dist/index.umd.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).ticker={})}(this,(function(e){"use strict";const t=e=>"function"==typeof e,r=(e,r="")=>{if(!t(e))throw new TypeError(`${r} Expecting function arg`.trim())},n=e=>t(e.subscribe),s=(e=undefined,n=null)=>{const s=e=>t(n?.persist)&&n.persist(e);let c=(()=>{const e=new Map,t=t=>(e.has(t)||e.set(t,new Set),e.get(t)),r=(e,r)=>{if("function"!=typeof r)throw new TypeError("Expecting callback function as second argument");return t(e).add(r),()=>t(e).delete(r)};return{publish:(e,r={})=>{t(e).forEach((e=>e(r)))},subscribe:r,subscribeOnce:(e,t)=>{const n=r(e,(e=>{t(e),n()}));return n},unsubscribeAll:t=>e.delete(t)}})(),l=e;s(l);const i=()=>l,a=e=>{l!==e&&(l=e,s(l),c.publish("change",l))};return{set:a,get:i,update:e=>{r(e,"[update]"),a(e(i()))},subscribe:e=>(r(e,"[subscribe]"),e(l),c.subscribe("change",e))}},c={fetchSilentDefaultThresholdMs:3e5},l=e=>"function"==typeof e;e.createFetchStore=(e,i=null,a=null,o=null)=>{const{logger:u,onError:h,onSilentError:f,afterCreate:b,fetchSilentDefaultThresholdMs:g}={...c,...o||{}},p=(e,t)=>l(a)?a(e,t):e,d=s(p(i)),E=s({isFetching:!1,lastFetchStart:null,lastFetchEnd:null,lastFetchError:null,successCounter:0}),{subscribe:y,get:w}=((e,c,l=null)=>{const i=e=>t(l?.persist)&&l.persist(e),a=s(l?.initialValue),o=[];if(e.forEach((e=>{if(!n(e))throw new TypeError("Expecting array of StoreLike objects");e.subscribe((e=>o.push(e)))()})),!t(c))throw new TypeError("Expecting second argument to be the derivative function");if(!c.length||c.length>2)throw new TypeError("Expecting the derivative function to have exactly 1 or 2 arguments");let u=0,h=[];return{get:a.get,subscribe:t=>{r(t,"[derived.subscribe]"),u++||e.forEach(((e,t)=>{h.push(e.subscribe((e=>{o[t]=e,1===c.length?(a.set(c(o)),i(a.get())):c(o,(e=>{a.set(e),i(a.get())}))})))}));const n=a.subscribe(t);return()=>{--u||(h.forEach((e=>e())),h=[]),n()}}}})([d,E],(([e,t])=>({data:e,...t})));y((()=>null));const F=async(...t)=>{let r=d.get(),n=E.get();const s=new Date;let c=null;E.set({...n,isFetching:!0,lastFetchStart:s,lastFetchEnd:null,lastFetchError:c});try{r=p(await e(...t),r),n.successCounter++}catch(e){c=e}d.set(r),E.set({...n,isFetching:!1,lastFetchStart:s,lastFetchEnd:new Date,lastFetchError:c}),c&&l(h)&&h(c)},S={subscribe:y,get:w,fetch:F,fetchSilent:async(...t)=>{try{d.set(p(await e(...t),d.get()))}catch(e){((...e)=>{l(u)&&u.apply(null,e)})("silent fetch error",e),l(f)&&f(e)}},fetchOnce:async(e=[],t=g)=>{const{successCounter:r,isFetching:n,lastFetchStart:s}=E.get();return Array.isArray(e)||(e=[e]),r||n?t&&!n&&s&&Date.now()-new Date(s).valueOf()>t?await F(...e):void 0:await F(...e)},reset:()=>{d.set(p(i)),E.set({isFetching:!1,lastFetchStart:null,lastFetchEnd:null,lastFetchError:null,successCounter:0})},resetError:()=>E.update((e=>({...e,lastFetchError:null}))),getInternalDataStore:()=>d};return l(b)&&b(S),S}}));

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@marianmeres/fetch-store",
+  "version": "1.0.2",
+  "description": "",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "browser": "./dist/index.umd.js",
+  "exports": {
+    "require": "./dist/index.cjs",
+    "import": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist/*",
+    "prettier": "prettier --write \"{src,tests}/**/*.{js,ts,json}\"",
+    "release": "release",
+    "test": "node --loader ts-node/esm tests/index.ts",
+    "test:watch": "nodemon --delay 0.5 -q -w \"src/**/*.*\" -w \"tests/**/*.*\" -x \"node --loader ts-node/esm tests/index.ts\" --",
+    "build": "npm run clean && rollup -c",
+    "dev": "npm run clean && rollup -c -w"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/marianmeres/fetch-store.git"
+  },
+  "keywords": [
+    "interval"
+  ],
+  "author": "Marian Meres <marian@meres.sk>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/marianmeres/ticker/issues"
+  },
+  "homepage": "https://github.com/marianmeres/ticker#readme",
+  "devDependencies": {
+    "@marianmeres/clog": "^1.0.0",
+    "@marianmeres/release": "^1.0.0",
+    "@marianmeres/test-runner": "^2.0.15",
+    "@rollup/plugin-commonjs": "^24.0.1",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-terser": "^0.4.0",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "@types/node": "^18.15.1",
+    "mkdirp": "^2.1.5",
+    "nodemon": "^2.0.21",
+    "prettier": "^2.8.4",
+    "rimraf": "^4.4.0",
+    "rollup": "^3.19.1",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.5.0",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "@marianmeres/store": "^1.2.0"
+  }
+}