Merge pull request #6 from johantor/bugfix/underlying-filesystem

fix: underlying filesystem, linting and package updates

Author: wezz

.github/workflows/publish.yml

@@ -12,9 +12,9 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 16
+          node-version: 22
       - run: npm install
-        
+
       - name: Setup GIT
         run: |
           git reset --hard
@@ -23,8 +23,8 @@ jobs:
           git config user.email "wezz@wezz.se"
           git config user.name "Wezz Balk"
         env:
-            GH_EMAIL: ${{secrets.GH_EMAIL}}
-          
+          GH_EMAIL: ${{secrets.GH_EMAIL}}
+
       - name: Bump version
         run: |
           git reset --hard
@@ -35,10 +35,10 @@ jobs:
           git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$GITHUB_REPOSITORY"
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-          
+
       - name: npm publish
         run: |
           npm config set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN
           npm publish --access public
         env:
-            NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
+          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}

.prettierignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

.prettierrc

@@ -0,0 +1,10 @@
+{
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": false,
+  "printWidth": 80,
+  "bracketSpacing": true,
+  "objectWrap": "preserve"
+}

README.md

@@ -1,15 +1,18 @@
 # Fetch Manager
 
-This is a script to ease the use of making fetch requests. 
+This is a script to ease the use of making fetch requests.
 It features the ability to stop consequetive requests, delay a request and parse querystrings from JSON.
 
 ## Installation
+
 ```
 npm install @wezz/fetchmanager
 ```
 
 ## Usage
+
 ### Initialize Fetch Manager
+
 ```
 import { FetchManager } from '@wezz/fetchmanager';
 // On document ready
@@ -20,7 +23,9 @@ const data = response.json();
 ```
 
 ## Options
+
 When doing a fetch request you should define a options object that looks like this:
+
 ```
 {
     "key": "unique request key",
@@ -32,52 +37,61 @@ When doing a fetch request you should define a options object that looks like th
     "json": true
 }
 ```
-*Note that the option fetchoptions is passed down directly to fetch.*<br/>
+
+_Note that the option fetchoptions is passed down directly to fetch._<br/>
 [Click here for the fetch options documentation](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#supplying_request_options)
 
 ### Key
+
 If a key is set then the "signal" will be stored and if another request is being sent with an identical key, the current request will be aborted.
 So if you're doing requests related to a users input (typing in an input field) and sending a request per input, this would stop all the old requests and only deliver the last request made as to stop race conditions.
 
 ### Url
+
 This is the URL you wish to fetch, without parameters
 
 ### Querystring
+
 This can be empty, an object that will be parsed to a querystring, or just a string.
 
 ### Request delay
-This delays a request with the specified amount of miliseconds. 
+
+This delays a request with the specified amount of miliseconds.
 
 ### Cache
+
 If this is enabled then any request will be cached in either local or session storage. Session storage is default.
-You can either send in a boolean, 
+You can either send in a boolean,
 or you can send in an object like this
+
 ```
 { permanent: true, cachekey: 'myCacheKey' }
 ```
 
 If permanent is set to true it will be stored in local storage.
 
 ### JSON
+
 The JSON options will add the header "Content-Type": application/json and it is enabled by default.
-If another content type header has been specified it will not override it. 
+If another content type header has been specified it will not override it.
 
 Set this to false if you need to fetch any mimetype that is not json.
 
 ### Fetch options
+
 Fetch options is standard fetch opions.
 [Read more about fetch options on MDN](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#supplying_request_options).
 
-
 ## Development & Demo
+
 Clone this repo
 Run
-``` npm install ```
-
-To run the interactive demo, run 
-``` npm run demo ```
+`npm install`
 
+To run the interactive demo, run
+`npm run demo`
 
 ## Breaking changes
-In the Version 1 release the response is no longer automatically parsed to JSON. 
+
+In the Version 1 release the response is no longer automatically parsed to JSON.
 Consumers of the package will get the regular response object back just as if they had used the native fetch function.

dist/FetchManager.d.ts

@@ -1 +1,43 @@
-export { default as FetchManager } from './FetchManager';
+declare class FetchManager {
+    moduleName: string;
+    private requestStore;
+    private defaultOptions;
+    private defaultFetchOptions;
+    constructor();
+    ObjToQueryString(params: any): string;
+    Fetch(initOptions: IFetchManagerOption): Promise<any>;
+    GetScript(url: string): Promise<unknown>;
+    CompileUrl(options: IFetchManagerOption): string;
+    private getRequestObj;
+    private getResponseFromCache;
+    private validResponse;
+    private saveResponseToCache;
+    private parseFetchOptions;
+    private getRequestCacheOptions;
+    private getCacheKey;
+    private getKey;
+    private debug;
+}
+export default FetchManager;
+
+declare interface IFetchManagerCacheOption {
+    usecache: boolean;
+    permanent: boolean;
+    pemanent: boolean;
+    cachekey: string;
+    iscached?: boolean;
+}
+
+declare interface IFetchManagerOption {
+    key?: string;
+    url: string;
+    querystring?: object | string;
+    requestdelay?: number;
+    cache?: boolean | IFetchManagerCacheOption;
+    fetchoptions?: RequestInit;
+    signal?: AbortController["signal"];
+    json?: boolean;
+    debug?: boolean;
+}
+
+export { }

dist/fetchmanager.umd.cjs

@@ -1,7 +1,7 @@
 var p = Object.defineProperty;
 var y = (a, e, t) => e in a ? p(a, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : a[e] = t;
-var i = (a, e, t) => (y(a, typeof e != "symbol" ? e + "" : e, t), t);
-var g = Object.defineProperty, b = (a, e, t) => e in a ? g(a, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : a[e] = t, w = (a, e, t) => (b(a, typeof e != "symbol" ? e + "" : e, t), t);
+var i = (a, e, t) => y(a, typeof e != "symbol" ? e + "" : e, t);
+var g = Object.defineProperty, b = (a, e, t) => e in a ? g(a, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : a[e] = t, w = (a, e, t) => (b(a, e + "", t), t);
 class S {
   constructor(e = "cache") {
     w(this, "prefix"), this.prefix = e;
@@ -97,7 +97,10 @@ class v {
     return this.has(e) ? delete this.root[this.storeNamespace][this.storeName][e] : !1;
   }
 }
-const f = new S("fetchmanager"), O = new v("requests", "fetchmanagerstore");
+const f = new S("fetchmanager"), O = new v(
+  "requests",
+  "fetchmanagerstore"
+);
 class $ {
   constructor() {
     i(this, "moduleName", "FetchManager");
@@ -120,8 +123,7 @@ class $ {
     const t = { ...this.defaultOptions, ...e };
     if (!t.url)
       return console.error("Need a url to do a request"), null;
-    const o = this.getKey(t), r = this.getRequestObj(o, t);
-    let s = this.parseFetchOptions(t);
+    const o = this.getKey(t), r = this.getRequestObj(o, t), s = this.parseFetchOptions(t);
     if (t.json && !s.headers) {
       const n = new Headers(s.headers);
       n.has("Content-Type") || (n.append("Content-Type", "application/json"), s.headers = n);
@@ -181,6 +183,7 @@ class $ {
     return this.validResponse(t) ? {
       body: function() {
       },
+      // eslint-disable-line @typescript-eslint/no-empty-function
       bodyUsed: !1,
       headers: {},
       redirected: !1,
@@ -205,7 +208,7 @@ class $ {
   async saveResponseToCache(e) {
     if (e.cache.usecache !== !0 || !e.result)
       return !1;
-    let t = this.validResponse(e.result);
+    const t = this.validResponse(e.result);
     if (this.debug(e.debug, "Storing response in cache ", e.result), !t)
       return console.info(
         "Result was not accepted so it is not saved to cache",
@@ -245,5 +248,5 @@ class $ {
   }
 }
 export {
-  $ as FetchManager
+  $ as default
 };