umaki 0.1.0

package/dist/libs/is/isIpad.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Determines if the device is an iPad.
+ *
+ * @param orientation - The desired screen orientation ('portrait' or 'landscape'). Defaults to 'portrait'.
+ * @returns `true` if the device is an iPad with the specified orientation, otherwise `false`.
+ */
+export declare const isIpad: (orientation?: string) => boolean;

package/dist/libs/is/isIpad.test.d.ts

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

package/dist/libs/is/isKeyExists.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Checks if a specific key exists in an object.
+ *
+ * @template T - The type of the object.
+ * @template U - The type of the key.
+ * @param {T} obj - The object to check.
+ * @param {U} key - The key to check for.
+ * @returns {obj is T & Record<U, unknown>} - Returns true if the key exists in the object, otherwise false.
+ */
+export declare const isKeyExists: <T extends Record<string, unknown>, U extends string>(obj: T, key: U) => obj is T & Record<U, unknown>;

package/dist/libs/is/isKeyExists.test.d.ts

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

package/dist/libs/is/isProduction.d.ts

@@ -0,0 +1 @@
+export declare const isProduction: () => boolean;

package/dist/libs/is/isProduction.test.d.ts

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

package/dist/libs/is/isSafari.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Determines if the browser is Safari.
+ *
+ * @param includeMobileSafari - A boolean indicating whether to include Mobile Safari in the check. Defaults to true.
+ * @returns A boolean indicating if the browser is Safari or Mobile Safari (if includeMobileSafari is true).
+ */
+export declare const isSafari: (includeMobileSafari?: boolean) => boolean;

package/dist/libs/is/isSafari.test.d.ts

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

package/dist/libs/is/isScrollable.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Determines if an element is scrollable.
+ *
+ * @param element - The HTML element to check for scrollability.
+ * @returns `true` if the element is scrollable either horizontally or vertically, otherwise `false`.
+ */
+export declare const isScrollable: (element: HTMLElement) => boolean;

package/dist/libs/is/isScrollable.test.d.ts

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

package/dist/libs/is/isTouchSupport.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Determines if the device supports touch input.
+ *
+ * @returns {boolean} True if the device supports touch input, otherwise false.
+ */
+export declare const isTouchSupport: () => boolean;

package/dist/libs/remove/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Remove functions
+ */
+export { removeAllHtmlTags } from './removeAllHtmlTags';
+export { removeAttribute } from './removeAttribute';
+export { removeSessionStorage } from './removeSessionStorage';
+export { removeStylePropertyValue } from './removeStylePropertyValue';

package/dist/libs/remove/removeAllHtmlTags.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Removes all HTML tags from the given string.
+ *
+ * @param string - The input string from which HTML tags should be removed.
+ * @returns The sanitized string with all HTML tags removed.
+ */
+export declare const removeAllHtmlTags: (string: string) => string;

package/dist/libs/remove/removeAllHtmlTags.test.d.ts

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

package/dist/libs/remove/removeAttribute.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Removes the specified attribute from the given HTML element.
+ *
+ * @param element - The HTML element from which the attribute will be removed.
+ * @param attribute - The name of the attribute to be removed.
+ */
+export declare const removeAttribute: (element: HTMLElement, attribute: string) => void;

package/dist/libs/remove/removeAttribute.test.d.ts

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

package/dist/libs/remove/removeSessionStorage.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Removes an item from session storage.
+ *
+ * @param key - The key of the item to remove from session storage.
+ */
+export declare const removeSessionStorage: (key: string) => void;

package/dist/libs/remove/removeSessionStorage.test.d.ts

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

package/dist/libs/remove/removeStylePropertyValue.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Removes a CSS custom property from the root element.
+ *
+ * @param key - The name of the CSS custom property to remove.
+ */
+export declare const removeStylePropertyValue: (key: string) => void;

package/dist/libs/remove/removeStylePropertyValue.test.d.ts

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

package/dist/libs/set/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Set functions
+ */
+export { set100vh } from './set100vh';
+export { set100vw } from './set100vw';
+export { setAttribute } from './setAttribute';
+export { setScrollPositionToCenter } from './setScrollPositionToCenter';
+export { setSessionStorage } from './setSessionStorage';
+export { setStylePropertyValue } from './setStylePropertyValue';

package/dist/libs/set/set100vh.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Sets a CSS variable to 100vh to handle viewport units on mobile devices.
+ *
+ * This function calculates 1% of the viewport height and sets it as a CSS variable.
+ * This is useful for handling issues with viewport units on mobile devices.
+ *
+ * @param {string} [setProperty='--vh'] - The name of the CSS variable to set.
+ *
+ * @link https://css-tricks.com/the-trick-to-viewport-units-on-mobile/
+ */
+export declare const set100vh: (setProperty?: string) => void;

package/dist/libs/set/set100vh.test.d.ts

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

package/dist/libs/set/set100vw.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Sets a CSS variable to the value of 100vw (excluding the scrollbar width).
+ *
+ * @param setProperty - The name of the CSS variable to set. Defaults to '--vw'.
+ */
+export declare const set100vw: (setProperty?: string) => void;

package/dist/libs/set/set100vw.test.d.ts

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

package/dist/libs/set/setAttribute.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Sets an attribute on a given HTML element.
+ *
+ * @param element - The HTML element on which the attribute will be set.
+ * @param attribute - The name of the attribute to set.
+ * @param value - The value of the attribute to set.
+ */
+export declare const setAttribute: (element: HTMLElement, attribute: string, value: string) => void;

package/dist/libs/set/setAttribute.test.d.ts

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

package/dist/libs/set/setScrollPositionToCenter.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Sets the horizontal scroll position of a root element to center a target element within it.
+ *
+ * @param rootElement - The root HTML element whose scroll position will be adjusted.
+ * @param targetElement - The target HTML element that should be centered within the root element.
+ * @param behavior - The scrolling behavior, either 'auto' or 'smooth'. Defaults to 'smooth'.
+ */
+export declare const setScrollPositionToCenter: (rootElement: HTMLElement, targetElement: HTMLElement, behavior?: "auto" | "smooth") => void;

package/dist/libs/set/setScrollPositionToCenter.test.d.ts

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

package/dist/libs/set/setSessionStorage.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Sets a value in session storage.
+ *
+ * @param key - The key under which the value is stored.
+ * @param value - The value to store.
+ */
+export declare const setSessionStorage: (key: string, value: string) => void;

package/dist/libs/set/setSessionStorage.test.d.ts

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

package/dist/libs/set/setStylePropertyValue.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Sets a CSS custom property on the root element.
+ *
+ * @param key - The name of the CSS custom property to set.
+ * @param value - The value to set for the CSS custom property.
+ */
+export declare const setStylePropertyValue: (key: string, value: string) => void;

package/dist/libs/set/setStylePropertyValue.test.d.ts

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

package/dist/libs/to/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * To functions
+ */
+export { toBoolean } from './toBoolean';
+export { toPositiveNumber } from './toPositiveNumber';

package/dist/libs/to/toBoolean.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts a string to a boolean value.
+ *
+ * @param booleanStr - The string to convert to a boolean. If the string is 'true' (case insensitive), it returns true. For any other value, it returns false. If the input is null, it also returns false.
+ * @returns A boolean value based on the input string.
+ */
+export declare const toBoolean: (booleanStr: string | null) => boolean;

package/dist/libs/to/toBoolean.test.d.ts

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

package/dist/libs/to/toPositiveNumber.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts a given number to a positive number.
+ *
+ * @param n - The number to be converted. If the number is negative or zero, it will be converted to its absolute value.
+ * @returns The positive number.
+ */
+export declare const toPositiveNumber: (n: number) => number;

package/dist/libs/to/toPositiveNumber.test.d.ts

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

package/dist/libs/transform/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Transform functions
+ */
+export { wrapTextWithSpans } from './wrapTextWithSpans';

package/dist/libs/transform/wrapTextWithSpans.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Wraps each character of the text content of an HTML element with individual <span> elements.
+ *
+ * @param element - The HTML element whose text content will be wrapped with <span> elements.
+ *
+ * This function recursively processes the given element and its child nodes. If the node is a text node,
+ * it replaces the text content with a series of <span> elements, each containing a single character from the text.
+ * If the node is an element node, it recursively processes its child nodes.
+ */
+export declare const wrapTextWithSpans: (element: HTMLElement) => void;

package/dist/libs/transform/wrapTextWithSpans.test.d.ts

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

package/dist/libs/wait/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Wait functions
+ */
+export { sleep } from './sleep';
+export { waitForAllMediaLoaded } from './waitForAllMediaLoaded';

package/dist/libs/wait/sleep.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Pauses the execution for a specified amount of time.
+ *
+ * @param time - The duration to sleep in seconds.
+ * @returns A promise that resolves after the specified time.
+ */
+export declare const sleep: (time: number) => Promise<void>;

package/dist/libs/wait/sleep.test.d.ts

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

package/dist/libs/wait/waitForAllMediaLoaded.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Waits for all images and videos in the document to be fully loaded.
+ *
+ * @param firstViewOnly - If true, only considers media elements within the first view (viewport height).
+ * @returns A promise that resolves to true when all media elements are loaded.
+ */
+export declare const waitForAllMediaLoaded: (firstViewOnly?: boolean) => Promise<boolean>;

package/dist/libs/wait/waitForAllMediaLoaded.test.d.ts

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

package/dist/vite.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "umaki",
+  "version": "0.1.0",
+  "description": "A utility that is often used in web production.",
+  "author": "TsubasaHiga",
+  "homepage": "https://github.com/TsubasaHiga/umaki",
+  "license": "MIT",
+  "keywords": [
+    "utility",
+    "web"
+  ],
+  "packageManager": "yarn@4.1.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TsubasaHiga/umaki"
+  },
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.umd.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js",
+    "require": "./dist/index.umd.cjs"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "test": "vitest",
+    "coverage": "vitest run --coverage",
+    "lint": "biome lint",
+    "format": "biome format"
+  },
+  "dependencies": {
+    "dayjs": "^1.11.13",
+    "image-size": "^1.1.1",
+    "is-touch-device": "^1.0.1",
+    "isomorphic-dompurify": "^2.16.0",
+    "query-string": "^9.1.1",
+    "runes2": "^1.1.4",
+    "store2": "^2.14.3",
+    "ua-parser-js": "^1.0.39"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "@types/is-touch-device": "^1",
+    "@types/node": "^22.8.6",
+    "@types/ua-parser-js": "^0.7.39",
+    "@vitest/coverage-v8": "2.1.4",
+    "happy-dom": "^15.7.4",
+    "typescript": "~5.6.3",
+    "vite": "^5.4.10",
+    "vite-plugin-dts": "^4.3.0",
+    "vite-tsconfig-paths": "^5.0.1",
+    "vitest": "^2.1.4"
+  }
+}