@alwatr/local-storage 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.0 (2024-01-16)
+
+### Features
+
+* **local-storage:** Rewrite local storage module ([5ed0f39](https://github.com/Alwatr/nanolib/commit/5ed0f39d090c027bb600a5d061ede887b4669198)) by @AliMD
+* **local-storage:** separate package from `@alwatr/util` ([4cc22ed](https://github.com/Alwatr/nanolib/commit/4cc22eda8d89f291783eef3b8917434489b628e1)) by @njfamirm
+
+### Bug Fixes
+
+* **local-storage:** Remove unused dependency and update tsconfig references ([b1caaea](https://github.com/Alwatr/nanolib/commit/b1caaea8565cd497d31d91e4e2ea1becd84a82a4)) by @AliMD

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 S. Ali Mihandoost
+
+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,61 @@
+# localJsonStorage
+
+`localJsonStorage` is a utility object in our TypeScript package that provides methods for interacting with the local storage in a structured and versioned manner.
+
+## Installation
+
+Before you can use `localJsonStorage`, you need to install the package. If you're using npm, you can do this with:
+
+```bash
+npm install @alwatr/local-storage
+```
+
+If you're using Yarn, you can do this with:
+
+```bash
+yarn add @alwatr/local-storage
+```
+
+## Usage
+
+First, you need to import `localJsonStorage` from the package:
+
+```typescript
+import { localJsonStorage } from '@alwatr/local-storage';
+```
+
+Or for CommonJS:
+
+```javascript
+const { localJsonStorage } = require('@alwatr/local-storage');
+```
+
+### Getting an Item
+
+You can get an item from local storage and parse it as JSON using the `getItem` method. If the item is not found, it will return a default value:
+
+```typescript
+const defaultValue = { a: 1, b: 2 };
+const value = localJsonStorage.getItem('item-name', defaultValue);
+```
+
+### Setting an Item
+
+You can set an item in local storage as JSON using the `setItem` method:
+
+```typescript
+const value = { a: 1, b: 2 };
+localJsonStorage.setItem('item-name', value);
+```
+
+### Removing an Item
+
+You can remove an item from local storage using the `removeItem` method:
+
+```typescript
+localJsonStorage.removeItem('item-name');
+```
+
+## Future Plans
+
+We plan to add more methods to `localJsonStorage` for directly interacting with local storage. Stay tuned for updates!

package/dist/main.cjs

@@ -0,0 +1,3 @@
+/* @alwatr/local-storage v1.0.0 */
+"use strict";var l=Object.defineProperty;var i=Object.getOwnPropertyDescriptor;var a=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var g=(t,e)=>{for(var n in e)l(t,n,{get:e[n],enumerable:!0})},u=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of a(e))!c.call(t,o)&&o!==n&&l(t,o,{get:()=>e[o],enumerable:!(r=i(e,o))||r.enumerable});return t};var y=t=>u(l({},"__esModule",{value:!0}),t);var p={};g(p,{localJsonStorage:()=>J});module.exports=y(p);function m(t){try{return JSON.parse(t)}catch(e){return console.error("parseJson","invalid_json",e),null}}var J={key_(t,e=1){return`${t}.v${e}`},getItem(t,e,n=1){let r=this.key_(t,n),o=localStorage.getItem(r);if(o===null)return e;let s=m(o);return s===null||typeof s!="object"?e:s},setItem(t,e,n=1){let r=this.key_(t,n);localStorage.setItem(r,JSON.stringify(e))},removeItem(t,e=1){let n=this.key_(t,e);window.localStorage.removeItem(n)}};0&&(module.exports={localJsonStorage});
+//# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["import type {Json, JsonValue} from '@alwatr/type-helper';\n\n/**\n * Parse json string without throwing error.\n *\n * @param content - json string\n * @returns json object or null if json is invalid\n * @example\n * ```typescript\n * const json = parseJson('{\"a\":1,\"b\":2}');\n * console.log(json.a); // 1\n * ```\n */\nfunction parseJson<T extends JsonValue>(content: string): T | null {\n  try {\n    return JSON.parse(content);\n  }\n  catch (err) {\n    console.error('parseJson', 'invalid_json', err);\n    return null;\n  }\n}\n\n// @TODO: localStorage polyfill (memory fallback)\n\n\n/**\n * A utility object for working with local storage and JSON data.\n */\nexport const localJsonStorage = {\n  /**\n   * Generate local storage key.\n   *\n   * @param name - Name of the item.\n   * @param version - Version of the item (default: 1).\n   * @returns The generated local storage key.\n   * @example\n   * ```typescript\n   * localJsonStorage.key_('myItem', 1); // myItem.v1\n   * ```\n   */\n  key_(name: string, version = 1): string {\n    return `${name}.v${version}`;\n  },\n\n  /**\n   * Get local storage item and parse it as JSON.\n   * If item is not found, return default value.\n   *\n   * @param name - Name of the item.\n   * @param defaultValue - Default value of the item.\n   * @param version - Data structure version of the item (default: 1).\n   * @returns The parsed JSON value or the default value if item is not found.\n   * @example\n   * ```typescript\n   * const value = localJsonStorage.getItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  getItem<T extends Json>(name: string, defaultValue: T, version = 1): T {\n    const key = this.key_(name, version);\n    const value = localStorage.getItem(key);\n    if (value === null) return defaultValue;\n    const json = parseJson<T>(value);\n    if (json === null || typeof json !== 'object') return defaultValue;\n    return json;\n  },\n\n  /**\n   * Set local storage item as JSON.\n   *\n   * @param name - Name of the item.\n   * @param value - Value of the item.\n   * @param version - Version of the item.\n   * @example\n   * ```typescript\n   * localJsonStorage.setItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  setItem<T extends Json>(name: string, value: T, version = 1): void {\n    const key = this.key_(name, version);\n    localStorage.setItem(key, JSON.stringify(value));\n  },\n\n  /**\n   * Removes an item from the local storage.\n   *\n   * @param name - The name of the item to remove.\n   * @param version - The version of the item to remove. Default is 1.\n   * @example\n   * ```typescript\n   * localJsonStorage.removeItem('myItem');\n   * ```\n   */\n  removeItem(name: string, version = 1): void {\n    const key = this.key_(name, version);\n    window.localStorage.removeItem(key);\n  },\n} as const;\n"],
+  "mappings": ";yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,sBAAAE,IAAA,eAAAC,EAAAH,GAaA,SAASI,EAA+BC,EAA2B,CACjE,GAAI,CACF,OAAO,KAAK,MAAMA,CAAO,CAC3B,OACOC,EAAK,CACV,eAAQ,MAAM,YAAa,eAAgBA,CAAG,EACvC,IACT,CACF,CAQO,IAAMJ,EAAmB,CAY9B,KAAKK,EAAcC,EAAU,EAAW,CACtC,MAAO,GAAGD,CAAI,KAAKC,CAAO,EAC5B,EAeA,QAAwBD,EAAcE,EAAiBD,EAAU,EAAM,CACrE,IAAME,EAAM,KAAK,KAAKH,EAAMC,CAAO,EAC7BG,EAAQ,aAAa,QAAQD,CAAG,EACtC,GAAIC,IAAU,KAAM,OAAOF,EAC3B,IAAMG,EAAOR,EAAaO,CAAK,EAC/B,OAAIC,IAAS,MAAQ,OAAOA,GAAS,SAAiBH,EAC/CG,CACT,EAaA,QAAwBL,EAAcI,EAAUH,EAAU,EAAS,CACjE,IAAME,EAAM,KAAK,KAAKH,EAAMC,CAAO,EACnC,aAAa,QAAQE,EAAK,KAAK,UAAUC,CAAK,CAAC,CACjD,EAYA,WAAWJ,EAAcC,EAAU,EAAS,CAC1C,IAAME,EAAM,KAAK,KAAKH,EAAMC,CAAO,EACnC,OAAO,aAAa,WAAWE,CAAG,CACpC,CACF",
+  "names": ["main_exports", "__export", "localJsonStorage", "__toCommonJS", "parseJson", "content", "err", "name", "version", "defaultValue", "key", "value", "json"]
+}

package/dist/main.d.ts

@@ -0,0 +1,56 @@
+import type { Json } from '@alwatr/type-helper';
+/**
+ * A utility object for working with local storage and JSON data.
+ */
+export declare const localJsonStorage: {
+    /**
+     * Generate local storage key.
+     *
+     * @param name - Name of the item.
+     * @param version - Version of the item (default: 1).
+     * @returns The generated local storage key.
+     * @example
+     * ```typescript
+     * localJsonStorage.key_('myItem', 1); // myItem.v1
+     * ```
+     */
+    readonly key_: (name: string, version?: number) => string;
+    /**
+     * Get local storage item and parse it as JSON.
+     * If item is not found, return default value.
+     *
+     * @param name - Name of the item.
+     * @param defaultValue - Default value of the item.
+     * @param version - Data structure version of the item (default: 1).
+     * @returns The parsed JSON value or the default value if item is not found.
+     * @example
+     * ```typescript
+     * const value = localJsonStorage.getItem('myItem', {a: 1, b: 2});
+     * ```
+     */
+    readonly getItem: <T extends Json>(name: string, defaultValue: T, version?: number) => T;
+    /**
+     * Set local storage item as JSON.
+     *
+     * @param name - Name of the item.
+     * @param value - Value of the item.
+     * @param version - Version of the item.
+     * @example
+     * ```typescript
+     * localJsonStorage.setItem('myItem', {a: 1, b: 2});
+     * ```
+     */
+    readonly setItem: <T_1 extends Json>(name: string, value: T_1, version?: number) => void;
+    /**
+     * Removes an item from the local storage.
+     *
+     * @param name - The name of the item to remove.
+     * @param version - The version of the item to remove. Default is 1.
+     * @example
+     * ```typescript
+     * localJsonStorage.removeItem('myItem');
+     * ```
+     */
+    readonly removeItem: (name: string, version?: number) => void;
+};
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,IAAI,EAAY,MAAM,qBAAqB,CAAC;AA0BzD;;GAEG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;;;;;OAUG;0BACQ,MAAM,uBAAgB,MAAM;IAIvC;;;;;;;;;;;;OAYG;6CAC2B,MAAM;IASpC;;;;;;;;;;OAUG;+CAC2B,MAAM,mCAA0B,IAAI;IAKlE;;;;;;;;;OASG;gCACc,MAAM,uBAAgB,IAAI;CAInC,CAAC"}

package/dist/main.mjs

@@ -0,0 +1,3 @@
+/* @alwatr/local-storage v1.0.0 */
+function l(t){try{return JSON.parse(t)}catch(e){return console.error("parseJson","invalid_json",e),null}}var i={key_(t,e=1){return`${t}.v${e}`},getItem(t,e,n=1){let o=this.key_(t,n),s=localStorage.getItem(o);if(s===null)return e;let r=l(s);return r===null||typeof r!="object"?e:r},setItem(t,e,n=1){let o=this.key_(t,n);localStorage.setItem(o,JSON.stringify(e))},removeItem(t,e=1){let n=this.key_(t,e);window.localStorage.removeItem(n)}};export{i as localJsonStorage};
+//# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["import type {Json, JsonValue} from '@alwatr/type-helper';\n\n/**\n * Parse json string without throwing error.\n *\n * @param content - json string\n * @returns json object or null if json is invalid\n * @example\n * ```typescript\n * const json = parseJson('{\"a\":1,\"b\":2}');\n * console.log(json.a); // 1\n * ```\n */\nfunction parseJson<T extends JsonValue>(content: string): T | null {\n  try {\n    return JSON.parse(content);\n  }\n  catch (err) {\n    console.error('parseJson', 'invalid_json', err);\n    return null;\n  }\n}\n\n// @TODO: localStorage polyfill (memory fallback)\n\n\n/**\n * A utility object for working with local storage and JSON data.\n */\nexport const localJsonStorage = {\n  /**\n   * Generate local storage key.\n   *\n   * @param name - Name of the item.\n   * @param version - Version of the item (default: 1).\n   * @returns The generated local storage key.\n   * @example\n   * ```typescript\n   * localJsonStorage.key_('myItem', 1); // myItem.v1\n   * ```\n   */\n  key_(name: string, version = 1): string {\n    return `${name}.v${version}`;\n  },\n\n  /**\n   * Get local storage item and parse it as JSON.\n   * If item is not found, return default value.\n   *\n   * @param name - Name of the item.\n   * @param defaultValue - Default value of the item.\n   * @param version - Data structure version of the item (default: 1).\n   * @returns The parsed JSON value or the default value if item is not found.\n   * @example\n   * ```typescript\n   * const value = localJsonStorage.getItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  getItem<T extends Json>(name: string, defaultValue: T, version = 1): T {\n    const key = this.key_(name, version);\n    const value = localStorage.getItem(key);\n    if (value === null) return defaultValue;\n    const json = parseJson<T>(value);\n    if (json === null || typeof json !== 'object') return defaultValue;\n    return json;\n  },\n\n  /**\n   * Set local storage item as JSON.\n   *\n   * @param name - Name of the item.\n   * @param value - Value of the item.\n   * @param version - Version of the item.\n   * @example\n   * ```typescript\n   * localJsonStorage.setItem('myItem', {a: 1, b: 2});\n   * ```\n   */\n  setItem<T extends Json>(name: string, value: T, version = 1): void {\n    const key = this.key_(name, version);\n    localStorage.setItem(key, JSON.stringify(value));\n  },\n\n  /**\n   * Removes an item from the local storage.\n   *\n   * @param name - The name of the item to remove.\n   * @param version - The version of the item to remove. Default is 1.\n   * @example\n   * ```typescript\n   * localJsonStorage.removeItem('myItem');\n   * ```\n   */\n  removeItem(name: string, version = 1): void {\n    const key = this.key_(name, version);\n    window.localStorage.removeItem(key);\n  },\n} as const;\n"],
+  "mappings": ";AAaA,SAASA,EAA+BC,EAA2B,CACjE,GAAI,CACF,OAAO,KAAK,MAAMA,CAAO,CAC3B,OACOC,EAAK,CACV,eAAQ,MAAM,YAAa,eAAgBA,CAAG,EACvC,IACT,CACF,CAQO,IAAMC,EAAmB,CAY9B,KAAKC,EAAcC,EAAU,EAAW,CACtC,MAAO,GAAGD,CAAI,KAAKC,CAAO,EAC5B,EAeA,QAAwBD,EAAcE,EAAiBD,EAAU,EAAM,CACrE,IAAME,EAAM,KAAK,KAAKH,EAAMC,CAAO,EAC7BG,EAAQ,aAAa,QAAQD,CAAG,EACtC,GAAIC,IAAU,KAAM,OAAOF,EAC3B,IAAMG,EAAOT,EAAaQ,CAAK,EAC/B,OAAIC,IAAS,MAAQ,OAAOA,GAAS,SAAiBH,EAC/CG,CACT,EAaA,QAAwBL,EAAcI,EAAUH,EAAU,EAAS,CACjE,IAAME,EAAM,KAAK,KAAKH,EAAMC,CAAO,EACnC,aAAa,QAAQE,EAAK,KAAK,UAAUC,CAAK,CAAC,CACjD,EAYA,WAAWJ,EAAcC,EAAU,EAAS,CAC1C,IAAME,EAAM,KAAK,KAAKH,EAAMC,CAAO,EACnC,OAAO,aAAa,WAAWE,CAAG,CACpC,CACF",
+  "names": ["parseJson", "content", "err", "localJsonStorage", "name", "version", "defaultValue", "key", "value", "json"]
+}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@alwatr/local-storage",
+  "version": "1.0.0",
+  "description": "`localJsonStorage` is a utility object in our TypeScript package that provides methods for interacting with the local storage in a structured and versioned manner.",
+  "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
+  "keywords": [
+    "local-storage",
+    "storage",
+    "json",
+    "json-storage",
+    "JsonStorage",
+    "local-json-storage",
+    "cross-platform",
+    "ECMAScript",
+    "typescript",
+    "javascript",
+    "browser",
+    "esm",
+    "module",
+    "utility",
+    "util",
+    "utils",
+    "nanolib",
+    "alwatr"
+  ],
+  "type": "module",
+  "main": "./dist/main.cjs",
+  "module": "./dist/main.mjs",
+  "types": "./dist/main.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/main.mjs",
+      "require": "./dist/main.cjs",
+      "types": "./dist/main.d.ts"
+    }
+  },
+  "license": "MIT",
+  "files": [
+    "**/*.{js,mjs,cjs,map,d.ts,html,md}",
+    "!demo/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Alwatr/nanolib",
+    "directory": "packages/local-storage"
+  },
+  "homepage": "https://github.com/Alwatr/nanolib/tree/next/packages/local-storage#readme",
+  "bugs": {
+    "url": "https://github.com/Alwatr/nanolib/issues"
+  },
+  "prettier": "@alwatr/prettier-config",
+  "scripts": {
+    "b": "yarn run build",
+    "w": "yarn run watch",
+    "c": "yarn run clean",
+    "cb": "yarn run clean && yarn run build",
+    "d": "yarn run build:es && yarn node --enable-source-maps --trace-warnings",
+    "build": "yarn run build:ts & yarn run build:es",
+    "build:es": "nano-build --preset=module",
+    "build:ts": "tsc --build",
+    "watch": "yarn run watch:ts & yarn run watch:es",
+    "watch:es": "yarn run build:es --watch",
+    "watch:ts": "yarn run build:ts --watch --preserveWatchOutput",
+    "clean": "rm -rfv dist *.tsbuildinfo"
+  },
+  "devDependencies": {
+    "@alwatr/nano-build": "^1.3.1",
+    "@alwatr/prettier-config": "^1.0.4",
+    "@alwatr/tsconfig-base": "^1.1.1",
+    "@alwatr/type-helper": "^1.1.0",
+    "typescript": "^5.3.3"
+  },
+  "gitHead": "808ba074470a2a1482d692fdb477730b40385c1d"
+}