minimal-shared 0.0.2

package/dist/utils/local-storage/local-storage.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Retrieves a value from local storage by key.
+ *
+ * @param {string} key - The key of the item to retrieve.
+ * @returns {any | null} - The parsed value of the item, or null if not found or an error occurs.
+ *
+ * @example
+ * const user = getStorage('user');
+ * console.log(user); // { name: 'John', age: 30 }
+ */
+declare function getStorage(key: string): any | null;
+/**
+ * Sets a value in local storage with a specified key.
+ *
+ * @template T
+ * @param {string} key - The key of the item to set.
+ * @param {T} value - The value of the item to set.
+ *
+ * @example
+ * setStorage('user', { name: 'John', age: 30 });
+ */
+declare function setStorage<T>(key: string, value: T): void;
+/**
+ * Removes an item from local storage by key.
+ *
+ * @param {string} key - The key of the item to remove.
+ *
+ * @example
+ * removeStorage('user');
+ */
+declare function removeStorage(key: string): void;
+/**
+ * Checks if local storage is available.
+ *
+ * @returns {boolean} - True if local storage is available, false otherwise.
+ *
+ * @example
+ * const isAvailable = localStorageAvailable();
+ * console.log(isAvailable); // true or false
+ */
+declare function localStorageAvailable(): boolean;
+/**
+ * Retrieves a value from local storage by key, with an optional default value.
+ *
+ * @param {string} key - The key of the item to retrieve.
+ * @param {string} [defaultValue=''] - The default value to return if the item is not found.
+ * @returns {string | undefined} - The value of the item, or the default value if not found.
+ *
+ * @example
+ * const value = localStorageGetItem('theme', 'light');
+ * console.log(value); // 'dark' or 'light'
+ */
+declare function localStorageGetItem(key: string, defaultValue?: string): string | undefined;
+
+export { getStorage, localStorageAvailable, localStorageGetItem, removeStorage, setStorage };

package/dist/utils/local-storage/local-storage.js

@@ -0,0 +1,51 @@
+// src/utils/local-storage/local-storage.ts
+function getStorage(key) {
+  const storedValue = localStorageGetItem(key);
+  if (storedValue) {
+    try {
+      return JSON.parse(storedValue);
+    } catch {
+      return storedValue;
+    }
+  }
+  return null;
+}
+function setStorage(key, value) {
+  try {
+    const serializedValue = JSON.stringify(value);
+    window.localStorage.setItem(key, serializedValue);
+  } catch (error) {
+    console.error("Error while setting storage:", error);
+  }
+}
+function removeStorage(key) {
+  try {
+    window.localStorage.removeItem(key);
+  } catch (error) {
+    console.error("Error while removing from storage:", error);
+  }
+}
+function localStorageAvailable() {
+  try {
+    const key = "__some_random_key_you_are_not_going_to_use__";
+    window.localStorage.setItem(key, key);
+    window.localStorage.removeItem(key);
+    return true;
+  } catch {
+    return false;
+  }
+}
+function localStorageGetItem(key, defaultValue = "") {
+  if (!localStorageAvailable()) {
+    return defaultValue;
+  }
+  const value = localStorage.getItem(key);
+  return value ?? defaultValue;
+}
+export {
+  getStorage,
+  localStorageAvailable,
+  localStorageGetItem,
+  removeStorage,
+  setStorage
+};

package/dist/utils/object/index.d.ts

@@ -0,0 +1 @@
+export { hasKeys } from './object.js';

package/dist/utils/object/index.js

@@ -0,0 +1 @@
+export * from './object';

package/dist/utils/object/object.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Checks if the given object contains all the specified keys.
+ *
+ * @template T - The type of the object.
+ * @param {T} obj - The object to check.
+ * @param {Array<keyof T>} keys - An array of keys to check for in the object.
+ * @returns {boolean} - Returns true if the object contains all the specified keys, otherwise false.
+ *
+ * @example
+ * const settings = {
+ *   fontFamily: 'Arial',
+ *   compactLayout: true,
+ *   direction: 'ltr',
+ *   colorScheme: 'light',
+ *   contrast: 'default',
+ *   navColor: 'integrate',
+ *   navLayout: 'vertical',
+ *   primaryColor: 'blue',
+ *};
+ *
+ * console.log(hasKeys(settings, ['fontFamily', 'direction'])); // true
+ * console.log(hasKeys(settings, ['test'])); // false
+ */
+declare function hasKeys<T>(obj: T | null | undefined, keys: (keyof T | string)[]): boolean;
+
+export { hasKeys };

package/dist/utils/object/object.js

@@ -0,0 +1,10 @@
+// src/utils/object/object.ts
+function hasKeys(obj, keys) {
+  if (!obj || !keys.length || typeof obj !== "object") {
+    return false;
+  }
+  return keys.every((key) => key in obj);
+}
+export {
+  hasKeys
+};

package/dist/utils/url/index.d.ts

@@ -0,0 +1 @@
+export { hasParams, isExternalLink, removeLastSlash, removeParams } from './url.js';

package/dist/utils/url/index.js

@@ -0,0 +1 @@
+export * from './url';

package/dist/utils/url/url.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Checks if a URL has query parameters.
+ *
+ * @param {string} url - The URL to check.
+ * @returns {boolean} - True if the URL has query parameters, false otherwise.
+ *
+ * @example
+ * const hasQueryParams = hasParams('https://example.com?page=1');
+ * console.log(hasQueryParams); // true
+ */
+declare const hasParams: (url: string) => boolean;
+/**
+ * Removes the trailing slash from a pathname if it exists.
+ *
+ * @param {string} pathname - The pathname to process.
+ * @returns {string} - The pathname without the trailing slash.
+ *
+ * @example
+ * const cleanPathname = removeLastSlash('/dashboard/calendar/');
+ * console.log(cleanPathname); // '/dashboard/calendar'
+ */
+declare function removeLastSlash(pathname: string): string;
+/**
+ * Removes query parameters from a URL.
+ *
+ * @param {string} url - The URL to process.
+ * @returns {string} - The URL without query parameters.
+ *
+ * @example
+ * const cleanUrl = removeParams('https://example.com/page?param=value');
+ * console.log(cleanUrl); // 'https://example.com/page'
+ */
+declare function removeParams(url: string): string;
+/**
+ * Checks if a URL is an external link.
+ *
+ * @param {string} url - The URL to check.
+ * @returns {boolean} - True if the URL is an external link, false otherwise.
+ *
+ * @example
+ * const isExternal = isExternalLink('https://example.com');
+ * console.log(isExternal); // true
+ */
+declare function isExternalLink(url: string): boolean;
+
+export { hasParams, isExternalLink, removeLastSlash, removeParams };

package/dist/utils/url/url.js

@@ -0,0 +1,28 @@
+// src/utils/url/url.ts
+var hasParams = (url) => {
+  const queryString = url.split("?")[1];
+  return queryString ? new URLSearchParams(queryString).toString().length > 0 : false;
+};
+function removeLastSlash(pathname) {
+  if (pathname !== "/" && pathname.endsWith("/")) {
+    return pathname.slice(0, -1);
+  }
+  return pathname;
+}
+function removeParams(url) {
+  try {
+    const urlObj = new URL(url, window.location.origin);
+    return removeLastSlash(urlObj.pathname);
+  } catch {
+    return url;
+  }
+}
+function isExternalLink(url) {
+  return url.startsWith("http");
+}
+export {
+  hasParams,
+  isExternalLink,
+  removeLastSlash,
+  removeParams
+};

package/dist/utils/uuidv4/index.d.ts

@@ -0,0 +1 @@
+export { uuidv4 } from './uuidv4.js';

package/dist/utils/uuidv4/index.js

@@ -0,0 +1 @@
+export * from './uuidv4';

package/dist/utils/uuidv4/uuidv4.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generates a UUID (version 4).
+ *
+ * @returns {string} - A randomly generated UUID.
+ *
+ * @example
+ * const id = uuidv4();
+ * console.log(id); // '3b12f1df-1c3a-4f3b-8f3d-3f3b1c3a4f3b'
+ */
+declare function uuidv4(): string;
+
+export { uuidv4 };

package/dist/utils/uuidv4/uuidv4.js

@@ -0,0 +1,11 @@
+// src/utils/uuidv4/uuidv4.ts
+function uuidv4() {
+  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => {
+    const r = Math.random() * 16 | 0;
+    const v = c === "x" ? r : r & 3 | 8;
+    return v.toString(16);
+  });
+}
+export {
+  uuidv4
+};

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "minimal-shared",
+  "author": "Minimals",
+  "version": "0.0.2",
+  "description": "Shared hooks and utils used by Mnimal UI and Zone UI.",
+  "keywords": [
+    "typescript",
+    "react",
+    "hooks",
+    "utils"
+  ],
+  "license": "MIT",
+  "sideEffects": false,
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/*",
+        "./dist/*/index"
+      ]
+    }
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./hooks": {
+      "types": "./dist/hooks/index.d.ts",
+      "default": "./dist/hooks/index.js"
+    },
+    "./hooks/*": {
+      "types": "./dist/hooks/*/index.d.ts",
+      "default": "./dist/hooks/*/index.js"
+    },
+    "./utils": {
+      "types": "./dist/utils/index.d.ts",
+      "default": "./dist/utils/index.js"
+    },
+    "./utils/*": {
+      "types": "./dist/utils/*/index.d.ts",
+      "default": "./dist/utils/*/index.js"
+    }
+  },
+  "scripts": {
+    "dev": "NODE_OPTIONS='--max-old-space-size=16384' tsup --watch",
+    "build": "NODE_OPTIONS='--max-old-space-size=16384' tsup",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint \"**/*.{js,jsx,ts,tsx}\"",
+    "lint:fix": "eslint --fix \"**/*.{js,jsx,ts,tsx}\"",
+    "lint:print": "npx eslint --print-config eslint.config.mjs > eslint-current-config.json",
+    "clean": "rm -rf node_modules .turbo .next out dist build",
+    "re:build": "pnpm clean && pnpm install && pnpm build",
+    "tsc:print": "npx tsc --showConfig"
+  },
+  "dependencies": {
+    "es-toolkit": "^1.26.1"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^16.0.1",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^22.8.6",
+    "@types/react": "18.3.12",
+    "chalk": "^5.3.0",
+    "fast-glob": "^3.3.2",
+    "fs-extra": "^11.2.0",
+    "glob": "^11.0.0",
+    "internal-eslint-config": "workspace:*",
+    "internal-ts-config": "workspace:*",
+    "jsdom": "^25.0.1",
+    "react": "^18.3.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.5.4",
+    "vitest": "^2.1.4"
+  },
+  "peerDependencies": {
+    "react": "^17 || ^18"
+  }
+}