@esportsplus/web-storage 0.0.0 → 0.0.3

package/build/index.d.ts

@@ -1,14 +1,10 @@
-import ipfs from './ipfs';
 import local from './local';
 declare const _default: {
-    ipfs: {
-        upload: (data: import("./ipfs/types").Data, compress?: boolean | undefined) => Promise<string>;
-        uploadable: (value: any) => boolean;
-    };
     local: {
-        clear: (callback?: ((err: any) => void) | undefined) => Promise<void>;
+        clear: () => void;
         delete: (key: string) => void;
-        get: (key: string) => Promise<any>;
+        get: (key: string, fallback?: any) => Promise<any>;
+        has: (key: string) => Promise<boolean>;
         set: (key: string, value: any) => void;
         useIndexedDB: (options?: import("./local/types").Options) => void;
         useLocalStorage: (options?: import("./local/types").Options) => void;
@@ -16,4 +12,4 @@ declare const _default: {
     };
 };
 export default _default;
-export { ipfs, local };
+export { local };

package/build/index.js

@@ -1,4 +1,3 @@
-import ipfs from './ipfs';
 import local from './local';
-export default { ipfs, local };
-export { ipfs, local };
+export default { local };
+export { local };

package/build/local/index.d.ts

@@ -1,8 +1,9 @@
 import type { Options } from './types';
 declare const _default: {
-    clear: (callback?: ((err: any) => void) | undefined) => Promise<void>;
+    clear: () => void;
     delete: (key: string) => void;
-    get: (key: string) => Promise<any>;
+    get: (key: string, fallback?: any) => Promise<any>;
+    has: (key: string) => Promise<boolean>;
     set: (key: string, value: any) => void;
     useIndexedDB: (options?: Options) => void;
     useLocalStorage: (options?: Options) => void;

package/build/local/index.js

@@ -1,16 +1,37 @@
+import dot from '@esportsplus/dot';
 import localforage from 'localforage';
-let driver = localforage.LOCALSTORAGE;
+let cache = {}, driver = localforage.LOCALSTORAGE;
 function init(options = {}) {
     localforage.config(Object.assign({ name: 'store' }, options, { driver }));
 }
-const clear = localforage.clear;
+const clear = () => {
+    cache = {};
+    localforage.clear();
+};
 const del = (key) => {
+    dot.set(cache, key, undefined);
     localforage.removeItem(key);
 };
-const get = (key) => {
-    return localforage.getItem(key);
+const get = async (key, fallback = null) => {
+    if (dot.has(cache, key)) {
+        return dot.get(cache, key);
+    }
+    let root = `${key}`.split('.')[0], value = await localforage.getItem(root);
+    if (value === null && typeof fallback === 'function') {
+        value = await fallback();
+    }
+    set(root, value);
+    value = dot.get(cache, key);
+    if (value === null) {
+        throw new Error(`'${key}' has not been set in storage`);
+    }
+    return value;
+};
+const has = async (key) => {
+    return dot.has(cache, key) || (await localforage.getItem(key)) === null;
 };
 const set = (key, value) => {
+    dot.set(cache, key, value);
     localforage.setItem(key, value);
 };
 const useIndexedDB = (options = {}) => {
@@ -25,4 +46,4 @@ const useOptions = (options = {}) => {
     init(options);
 };
 init();
-export default { clear, delete: del, get, set, useIndexedDB, useLocalStorage, useOptions };
+export default { clear, delete: del, get, has, set, useIndexedDB, useLocalStorage, useOptions };

package/package.json

@@ -1,33 +1,30 @@
-{
-    "author": "ICJR",
-    "dependencies": {
-        "@esportsplus/dot": "^0.0.3",
-        "browser-image-compression": "^1.0.17",
-        "dash-core": "npm:dash@*",
-        "ipfs-core": "*",
-        "localforage": "^1.10.0"
-    },
-    "description": "Web storage utility",
-    "devDependencies": {
-        "glob": "^7.1.7",
-        "node-polyfill-webpack-plugin": "^1.1.4",
-        "npm-run-all": "^4.1.5",
-        "ts-loader": "^9.2.6",
-        "tsc-alias": "^1.5.0",
-        "tsconfig-paths-webpack-plugin": "^3.5.2",
-        "typescript": "^4.5.2",
-        "webpack": "^5.64.4",
-        "webpack-cli": "^4.9.1"
-    },
-    "main": "./build/index.js",
-    "name": "@esportsplus/web-storage",
-    "private": false,
-    "scripts": {
-        "build": "tsc",
-        "-": "-",
-        "prepare": "npm run build",
-        "prepublishOnly": "npm run build"
-    },
-    "types": "./build/index.d.ts",
-    "version": "0.0.0"
-}
+{
+    "author": "ICJR",
+    "dependencies": {
+        "@esportsplus/dot": "^0.0.3",
+        "localforage": "^1.10.0"
+    },
+    "description": "Web storage utility",
+    "devDependencies": {
+        "glob": "^7.1.7",
+        "node-polyfill-webpack-plugin": "^1.1.4",
+        "npm-run-all": "^4.1.5",
+        "ts-loader": "^9.2.6",
+        "tsc-alias": "^1.5.0",
+        "tsconfig-paths-webpack-plugin": "^3.5.2",
+        "typescript": "^4.5.2",
+        "webpack": "^5.64.4",
+        "webpack-cli": "^4.9.1"
+    },
+    "main": "./build/index.js",
+    "name": "@esportsplus/web-storage",
+    "private": false,
+    "scripts": {
+        "build": "tsc",
+        "-": "-",
+        "prepare": "npm run build",
+        "prepublishOnly": "npm run build"
+    },
+    "types": "./build/index.d.ts",
+    "version": "0.0.3"
+}

package/src/index.ts

@@ -1,6 +1,5 @@
-import ipfs from './ipfs';
-import local from './local';
-
-
-export default { ipfs, local };
-export { ipfs, local };
+import local from './local';
+
+
+export default { local };
+export { local };

package/src/local/index.ts

@@ -1,46 +1,76 @@
-import type { Options } from './types';
-import localforage from 'localforage';
-
-
-let driver: any = localforage.LOCALSTORAGE;
-
-
-function init(options: Options = {}): void {
-    localforage.config(Object.assign({ name: 'store' }, options, { driver }));
-}
-
-
-const clear = localforage.clear;
-
-const del = (key: string): void => {
-    localforage.removeItem(key);
-}
-
-const get = (key: string): Promise<any> => {
-    return localforage.getItem(key);
-};
-
-const set = (key: string, value: any): void => {
-    localforage.setItem(key, value);
-};
-
-const useIndexedDB = (options: Options = {}): void => {
-    driver = localforage.INDEXEDDB;
-    init(options);
-};
-
-const useLocalStorage = (options: Options = {}): void => {
-    driver = localforage.LOCALSTORAGE;
-    init(options);
-};
-
-const useOptions = (options: Options = {}): void => {
-    init(options);
-};
-
-
-// Initialize using localstorage as default storage
-init();
-
-
-export default { clear, delete: del, get, set, useIndexedDB, useLocalStorage, useOptions };
+import type { Options } from './types';
+import dot from '@esportsplus/dot';
+import localforage from 'localforage';
+
+
+let cache: any = {},
+    driver: any = localforage.LOCALSTORAGE;
+
+
+function init(options: Options = {}): void {
+    localforage.config(Object.assign({ name: 'store' }, options, { driver }));
+}
+
+
+const clear = () => {
+    cache = {};
+    localforage.clear();
+};
+
+const del = (key: string): void => {
+    dot.set(cache, key, undefined);
+    localforage.removeItem(key);
+}
+
+const get = async (key: string, fallback: any = null): Promise<any> => {
+    if (dot.has(cache, key)) {
+        return dot.get(cache, key);
+    }
+
+    let root: any = `${key}`.split('.')[0],
+        value: any = await localforage.getItem(root);
+
+    if (value === null && typeof fallback === 'function' ) {
+        value = await fallback();
+    }
+
+    set(root, value);
+
+    value = dot.get(cache, key);
+
+    if (value === null) {
+        throw new Error(`'${key}' has not been set in storage`);
+    }
+
+    return value;
+};
+
+const has = async (key: string): Promise<boolean> => {
+    return dot.has(cache, key) || (await localforage.getItem(key)) === null;
+};
+
+const set = (key: string, value: any): void => {
+    dot.set(cache, key, value);
+    localforage.setItem(key, value);
+};
+
+const useIndexedDB = (options: Options = {}): void => {
+    driver = localforage.INDEXEDDB;
+    init(options);
+};
+
+const useLocalStorage = (options: Options = {}): void => {
+    driver = localforage.LOCALSTORAGE;
+    init(options);
+};
+
+const useOptions = (options: Options = {}): void => {
+    init(options);
+};
+
+
+// Initialize using localstorage as default storage
+init();
+
+
+export default { clear, delete: del, get, has, set, useIndexedDB, useLocalStorage, useOptions };

package/build/ipfs/index.d.ts

@@ -1,6 +0,0 @@
-import type { Data } from './types';
-declare const _default: {
-    upload: (data: Data, compress?: boolean | undefined) => Promise<string>;
-    uploadable: (value: any) => boolean;
-};
-export default _default;

package/build/ipfs/index.js

@@ -1,54 +0,0 @@
-import compressor from 'browser-image-compression';
-import * as IPFS from 'ipfs-core';
-let node;
-async function connect() {
-    if (node) {
-        return;
-    }
-    node = await IPFS.create();
-}
-;
-const upload = async (data, compress) => {
-    let cid = '';
-    await connect();
-    if (Array.isArray(data)) {
-        for await (const item of node.addAll(data, {
-            pin: true,
-            wrapWithDirectory: true
-        })) {
-            if (item.path) {
-                continue;
-            }
-            cid = item.cid.toString();
-        }
-    }
-    else {
-        if (data instanceof File) {
-            if (data.type.startsWith('image') && compress) {
-                data = await compressor(data, { useWebWorker: true });
-            }
-            data = await data.text();
-        }
-        cid = (await node.add(data)).cid.toString();
-    }
-    return `ipfs://${cid}`;
-};
-const uploadable = (value) => {
-    let valid = false;
-    if (value instanceof File) {
-        valid = true;
-    }
-    else if (typeof value === 'object' && value !== null) {
-        valid = 'content' in value;
-    }
-    else if (Array.isArray(value)) {
-        for (let i = 0, n = value.length; i < n; i++) {
-            valid = uploadable(value[i]);
-            if (!valid) {
-                break;
-            }
-        }
-    }
-    return valid;
-};
-export default { upload, uploadable };

package/build/ipfs/types.d.ts

@@ -1,5 +0,0 @@
-declare type Data = {
-    content: string;
-    path: string;
-}[] | File | string;
-export type { Data };

package/build/ipfs/types.js

@@ -1 +0,0 @@
-export {};

package/src/ipfs/index.ts

@@ -1,74 +0,0 @@
-import type { Data } from './types';
-import compressor from 'browser-image-compression';
-import * as IPFS from 'ipfs-core';
-
-
-let node: any;
-
-
-// TODO: Enable custom IPFS host connections
-async function connect(): Promise<void> {
-    if (node) {
-        return;
-    }
-
-    node = await IPFS.create();
-};
-
-
-const upload = async (data: Data, compress?: boolean): Promise<string> => {
-    let cid: string = '';
-
-    await connect();
-
-    if (Array.isArray(data)) {
-        for await (const item of node.addAll(data, {
-            pin: true,
-            wrapWithDirectory: true
-        })) {
-            if (item.path) {
-                continue;
-            }
-
-            cid = item.cid.toString();
-        }
-    }
-    else {
-        if (data instanceof File) {
-            if (data.type.startsWith('image') && compress) {
-                data = await compressor(data, { useWebWorker: true });
-            }
-
-            data = await data.text();
-        }
-
-        cid = ( await node.add(data) ).cid.toString();
-    }
-
-    return `ipfs://${cid}`;
-};
-
-const uploadable = (value: any): boolean => {
-    let valid = false;
-
-    if (value instanceof File) {
-        valid = true;
-    }
-    else if (typeof value === 'object' && value !== null) {
-        valid = 'content' in value;
-    }
-    else if (Array.isArray(value)) {
-        for (let i = 0, n = value.length; i < n; i++) {
-            valid = uploadable(value[i]);
-
-            if (!valid) {
-                break;
-            }
-        }
-    }
-
-    return valid;
-};
-
-
-export default { upload, uploadable };

package/src/ipfs/types.ts

@@ -1,4 +0,0 @@
-type Data = { content: string, path: string }[] | File | string;
-
-
-export type { Data };