@ribbon-studios/js-utils 3.0.1 → 3.1.1

package/README.md

@@ -30,6 +30,8 @@ Collection of generic javascript utilities curated by the Ribbon Studios Team~
     - [`rfetch.interceptors.request`](#rfetchinterceptorsrequest)
     - [`rfetch.interceptors.reject`](#rfetchinterceptorsreject)
     - [`rfetch.delimiters`](#rfetchdelimiters)
+- [Storage](#storage)
+  - [`RibbonStorage`](#ribbonstorage)
 
 ## Promises
 
@@ -284,6 +286,22 @@ try {
 }
 ```
 
+## Storage
+
+### `RibbonStorage`
+
+A small wrapper around local / session storage that automatically stringifies and parses responses.
+
+```ts
+import { RibbonStorage } from '@ribbon-studios/js-utils';
+
+RibbonStorage.local.set('hello', 'world'); // Sets 'hello' key in localStorage to '"world"'
+RibbonStorage.local.get('hello'); // 'world'
+
+RibbonStorage.session.set('hello', 'world'); // Sets 'hello' key in sessionStorage to '"world"'
+RibbonStorage.session.get('hello'); // 'world'
+```
+
 [_**Want to Contribute?**_](/CONTRIBUTING.md)
 
 [npm-version-image]: https://img.shields.io/npm/v/@ribbon-studios/js-utils.svg

package/dist/__tests__/storage.spec.d.ts

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

package/dist/index.cjs

@@ -43,7 +43,7 @@ async function retry(fn, n) {
 }
 class RibbonFetchError extends Error {
   constructor({ status, content }) {
-    super(content);
+    super(content?.toString());
     this.status = status;
     this.content = content;
   }
@@ -59,7 +59,6 @@ const fetchInterceptors = {
 };
 let delimiter = 1;
 async function rfetch(url, { params, body, ...options } = {}) {
-  var _a, _b;
   const requestInit = {
     method: "GET",
     ...options
@@ -105,7 +104,7 @@ async function rfetch(url, { params, body, ...options } = {}) {
       Promise.resolve(requestInit)
     )
   );
-  const content = ((_b = (_a = response.headers.get("Content-Type")) == null ? void 0 : _a.toLowerCase()) == null ? void 0 : _b.includes("json")) ? await response.json() : await response.text();
+  const content = response.headers.get("Content-Type")?.toLowerCase()?.includes("json") ? await response.json() : await response.text();
   if (response.ok) {
     if (response.status === 204) return void 0;
     return content;
@@ -203,8 +202,36 @@ rfetch.delete = (url, options) => {
     is2.error = error;
   })(rfetch2.is || (rfetch2.is = {}));
 })(rfetch || (rfetch = {}));
+const _RibbonStorage = class _RibbonStorage {
+  static get(storage, key, defaultValue = null) {
+    try {
+      const value = storage.getItem(key);
+      if (!value) return defaultValue;
+      return JSON.parse(value);
+    } catch {
+      return defaultValue;
+    }
+  }
+  static set(storage, key, value) {
+    if (value === void 0 || value === null) {
+      storage.removeItem(key);
+    } else {
+      storage.setItem(key, JSON.stringify(value));
+    }
+  }
+};
+_RibbonStorage.local = {
+  get: _RibbonStorage.get.bind(Storage, localStorage),
+  set: _RibbonStorage.set.bind(Storage, localStorage)
+};
+_RibbonStorage.session = {
+  get: _RibbonStorage.get.bind(Storage, sessionStorage),
+  set: _RibbonStorage.set.bind(Storage, sessionStorage)
+};
+let RibbonStorage = _RibbonStorage;
 exports.DelimiterType = DelimiterType;
 exports.RibbonFetchError = RibbonFetchError;
+exports.RibbonStorage = RibbonStorage;
 exports.assert = assert;
 exports.delay = delay;
 exports.never = never;

package/dist/index.d.cts

@@ -1,2 +1,3 @@
 export * from './promises';
 export * from './rfetch';
+export * from './storage';

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './promises';
 export * from './rfetch';
+export * from './storage';

package/dist/index.js

@@ -41,7 +41,7 @@ async function retry(fn, n) {
 }
 class RibbonFetchError extends Error {
   constructor({ status, content }) {
-    super(content);
+    super(content?.toString());
     this.status = status;
     this.content = content;
   }
@@ -57,7 +57,6 @@ const fetchInterceptors = {
 };
 let delimiter = 1;
 async function rfetch(url, { params, body, ...options } = {}) {
-  var _a, _b;
   const requestInit = {
     method: "GET",
     ...options
@@ -103,7 +102,7 @@ async function rfetch(url, { params, body, ...options } = {}) {
       Promise.resolve(requestInit)
     )
   );
-  const content = ((_b = (_a = response.headers.get("Content-Type")) == null ? void 0 : _a.toLowerCase()) == null ? void 0 : _b.includes("json")) ? await response.json() : await response.text();
+  const content = response.headers.get("Content-Type")?.toLowerCase()?.includes("json") ? await response.json() : await response.text();
   if (response.ok) {
     if (response.status === 204) return void 0;
     return content;
@@ -201,9 +200,37 @@ rfetch.delete = (url, options) => {
     is2.error = error;
   })(rfetch2.is || (rfetch2.is = {}));
 })(rfetch || (rfetch = {}));
+const _RibbonStorage = class _RibbonStorage {
+  static get(storage, key, defaultValue = null) {
+    try {
+      const value = storage.getItem(key);
+      if (!value) return defaultValue;
+      return JSON.parse(value);
+    } catch {
+      return defaultValue;
+    }
+  }
+  static set(storage, key, value) {
+    if (value === void 0 || value === null) {
+      storage.removeItem(key);
+    } else {
+      storage.setItem(key, JSON.stringify(value));
+    }
+  }
+};
+_RibbonStorage.local = {
+  get: _RibbonStorage.get.bind(Storage, localStorage),
+  set: _RibbonStorage.set.bind(Storage, localStorage)
+};
+_RibbonStorage.session = {
+  get: _RibbonStorage.get.bind(Storage, sessionStorage),
+  set: _RibbonStorage.set.bind(Storage, sessionStorage)
+};
+let RibbonStorage = _RibbonStorage;
 export {
   DelimiterType,
   RibbonFetchError,
+  RibbonStorage,
   assert,
   delay,
   never,

package/dist/storage.d.ts

@@ -0,0 +1,18 @@
+export declare class RibbonStorage {
+    static get<T>(storage: globalThis.Storage, key: string, defaultValue?: T): T;
+    static set<T>(storage: globalThis.Storage, key: string, value: T): void;
+    /**
+     * Shorthands for getting / setting from {@link localStorage}
+     */
+    static local: {
+        get: any;
+        set: any;
+    };
+    /**
+     * Shorthands for getting / setting from {@link sessionStorage}
+     */
+    static session: {
+        get: any;
+        set: any;
+    };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ribbon-studios/js-utils",
-  "version": "3.0.1",
-  "description": "Collection of generic javascript utilities curated by the Rainbow Cafe~",
+  "version": "3.1.1",
+  "description": "Collection of generic javascript utilities curated by the Ribbon Studios Team~",
   "type": "module",
   "source": "src/*.ts",
   "main": "./dist/index.cjs",
@@ -28,23 +28,23 @@
     "build": "rm -rf dist && vite build"
   },
   "devDependencies": {
-    "@eslint/js": "^9.22.0",
-    "@types/chance": "^1.1.6",
-    "@types/node": "^22.13.10",
-    "@typescript-eslint/eslint-plugin": "^8.26.0",
-    "@typescript-eslint/parser": "^8.26.0",
-    "@vitest/coverage-v8": "^3.0.8",
-    "ajv": "^8.17.1",
-    "chance": "^1.1.12",
-    "eslint-plugin-unused-imports": "^4.1.4",
-    "happy-dom": "^17.4.1",
-    "jiti": "^2.4.2",
-    "typescript": "^5.8.2",
-    "typescript-eslint": "^8.26.0",
-    "vite": "^6.2.1",
-    "vite-plugin-dts": "^4.5.3",
+    "@eslint/js": "^10.0.1",
+    "@types/chance": "^1.1.7",
+    "@types/node": "^22.19.15",
+    "@typescript-eslint/eslint-plugin": "^8.56.1",
+    "@typescript-eslint/parser": "^8.56.1",
+    "@vitest/coverage-v8": "^4.0.18",
+    "ajv": "^8.18.0",
+    "chance": "^1.1.13",
+    "eslint-plugin-unused-imports": "^4.4.1",
+    "happy-dom": "^20.8.3",
+    "jiti": "^2.6.1",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.56.1",
+    "vite": "^7.3.1",
+    "vite-plugin-dts": "^4.5.4",
     "vite-plugin-lib-types": "^3.1.2",
-    "vitest": "^3.0.8",
+    "vitest": "^4.0.18",
     "vitest-dom": "^0.1.1"
   },
   "publishConfig": {