umaki 0.5.0 → 0.6.0

package/README.md

@@ -18,6 +18,10 @@ import { foo } from "umaki";
 
 ## List of Utilities
 
+- [Configuration](#configuration)
+  - [setConfig](#setconfig)
+  - [getConfig](#getconfig)
+  - [getConfigValue](#getconfigvalue)
 - [Control](#control)
   - [bgScrollStop](#bgscrollstop)
   - [pd](#pd)
@@ -77,6 +81,50 @@ import { foo } from "umaki";
 - [Security](#security)
   - [sanitizeHtml](#sanitizehtml)
 
+## Configuration
+
+### setConfig
+
+A function to set or update global configuration options for the umaki library.
+
+```ts
+import { setConfig } from "umaki";
+
+// Set a custom breakpoint value
+setConfig({ BREAKPOINT: 1024 });
+
+// You can also add custom configuration properties
+setConfig({ customValue: "example" });
+```
+
+[View file →](src/libs/config/setConfig.ts)
+
+### getConfig
+
+A function to retrieve the entire current configuration object.
+
+```ts
+import { getConfig } from "umaki";
+
+const config = getConfig();
+console.log(config.BREAKPOINT); // e.g. 768 (default) or custom value if set
+```
+
+[View file →](src/libs/config/getConfig.ts)
+
+### getConfigValue
+
+A function to retrieve a specific configuration value by key.
+
+```ts
+import { getConfigValue } from "umaki";
+
+const breakpoint = getConfigValue('BREAKPOINT');
+console.log(breakpoint); // e.g. 768 (default) or custom value if set
+```
+
+[View file →](src/libs/config/getConfig.ts)
+
 ## Control
 
 ### bgScrollStop
@@ -451,6 +499,25 @@ console.log(uaData);
 
 ## Is
 
+### checkDeviceSize
+
+A function that checks the current device size based on window width and the configured breakpoint.
+
+```ts
+import { checkDeviceSize, setConfig } from "umaki";
+
+// Using default breakpoint (768px)
+const deviceSize = checkDeviceSize();
+console.log(deviceSize); // 'md' if window.innerWidth > 768, otherwise 'sm'
+
+// Customize the breakpoint
+setConfig({ BREAKPOINT: 1024 });
+const newDeviceSize = checkDeviceSize();
+console.log(newDeviceSize); // 'md' if window.innerWidth > 1024, otherwise 'sm'
+```
+
+[View file →](src/libs/is/checkDeviceSize.ts)
+
 ### isAfterDateTime
 
 A function that checks if the current date is after a specified date.

package/dist/_virtual/_commonjsHelpers.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/_virtual/_commonjsHelpers.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/_virtual/isBetween.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/_virtual/isBetween.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/_virtual/timezone.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/_virtual/timezone.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/_virtual/utc.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/_virtual/utc.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/index.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki
@@ -11,6 +11,9 @@
  * For license information, please see LICENSE.txt
  */
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const getConfig = require("./libs/config/getConfig.cjs.js");
+const setConfig = require("./libs/config/setConfig.cjs.js");
+const defaultConfig = require("./libs/config/defaultConfig.cjs.js");
 const bgScrollStop = require("./libs/control/bgScrollStop.cjs.js");
 const pd = require("./libs/control/pd.cjs.js");
 const scrollToHash = require("./libs/control/scrollToHash.cjs.js");
@@ -36,6 +39,7 @@ const getStylePropertyValueToNumber = require("./libs/get/getStylePropertyValueT
 const getUaData = require("./libs/get/getUaData.cjs.js");
 const isAfterDateTime = require("./libs/is/isAfterDateTime.cjs.js");
 const isBetweenDateTime = require("./libs/is/isBetweenDateTime.cjs.js");
+const checkDeviceSize = require("./libs/is/checkDeviceSize.cjs.js");
 const isExistAllElements = require("./libs/is/isExistAllElements.cjs.js");
 const isIpad = require("./libs/is/isIpad.cjs.js");
 const isKeyExists = require("./libs/is/isKeyExists.cjs.js");
@@ -58,6 +62,10 @@ const toPositiveNumber = require("./libs/to/toPositiveNumber.cjs.js");
 const wrapTextWithSpans = require("./libs/transform/wrapTextWithSpans.cjs.js");
 const sleep = require("./libs/wait/sleep.cjs.js");
 const waitForAllMediaLoaded = require("./libs/wait/waitForAllMediaLoaded.cjs.js");
+exports.getConfig = getConfig.getConfig;
+exports.getConfigValue = getConfig.getConfigValue;
+exports.setConfig = setConfig.setConfig;
+exports.defaultConfig = defaultConfig.defaultConfig;
 exports.bgScrollStop = bgScrollStop.bgScrollStop;
 exports.pd = pd.pd;
 exports.scrollToHash = scrollToHash.scrollToHash;
@@ -83,6 +91,7 @@ exports.getStylePropertyValueToNumber = getStylePropertyValueToNumber.getStylePr
 exports.getUaData = getUaData.getUaData;
 exports.isAfterDateTime = isAfterDateTime.isAfterDateTime;
 exports.isBetweenDateTime = isBetweenDateTime.isBetweenDateTime;
+exports.checkDeviceSize = checkDeviceSize.checkDeviceSize;
 exports.isExistAllElements = isExistAllElements.isExistAllElements;
 exports.isIpad = isIpad.isIpad;
 exports.isKeyExists = isKeyExists.isKeyExists;

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from './libs/config';
 export * from './libs/control';
 export * from './libs/convert';
 export * from './libs/eventControl';

package/dist/index.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki
@@ -9,6 +9,9 @@
  * This software includes dependencies licensed under MIT, ISC, BSD-3-Clause, and Apache-2.0.
  * For license information, please see LICENSE.txt
  */
+import { getConfig, getConfigValue } from "./libs/config/getConfig.es.js";
+import { setConfig } from "./libs/config/setConfig.es.js";
+import { defaultConfig } from "./libs/config/defaultConfig.es.js";
 import { bgScrollStop } from "./libs/control/bgScrollStop.es.js";
 import { pd } from "./libs/control/pd.es.js";
 import { scrollToHash } from "./libs/control/scrollToHash.es.js";
@@ -34,6 +37,7 @@ import { getStylePropertyValueToNumber } from "./libs/get/getStylePropertyValueT
 import { getUaData } from "./libs/get/getUaData.es.js";
 import { isAfterDateTime } from "./libs/is/isAfterDateTime.es.js";
 import { isBetweenDateTime } from "./libs/is/isBetweenDateTime.es.js";
+import { checkDeviceSize } from "./libs/is/checkDeviceSize.es.js";
 import { isExistAllElements } from "./libs/is/isExistAllElements.es.js";
 import { isIpad } from "./libs/is/isIpad.es.js";
 import { isKeyExists } from "./libs/is/isKeyExists.es.js";
@@ -59,9 +63,13 @@ import { waitForAllMediaLoaded } from "./libs/wait/waitForAllMediaLoaded.es.js";
 export {
   bgScrollStop,
   changeDateStringToSpecificFormat,
+  checkDeviceSize,
   debounce,
+  defaultConfig,
   getAspectRatio,
   getClassNames,
+  getConfig,
+  getConfigValue,
   getDocumentHeight,
   getEventPaths,
   getGcd,
@@ -94,6 +102,7 @@ export {
   set100vh,
   set100vw,
   setAttribute,
+  setConfig,
   setScrollPositionToCenter,
   setSessionStorage,
   setStylePropertyValue,

package/dist/libs/config/config.test.d.ts

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

package/dist/libs/config/defaultConfig.cjs.js

@@ -0,0 +1,17 @@
+"use strict";
+/*!
+ * name: umaki
+ * version: v0.6.0
+ * description: A utility that is often used in web production.
+ * author: TsubasaHiga
+ * homepage: https://github.com/TsubasaHiga/umaki
+ * Released under the MIT License
+ *
+ * This software includes dependencies licensed under MIT, ISC, BSD-3-Clause, and Apache-2.0.
+ * For license information, please see LICENSE.txt
+ */
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const defaultConfig = {
+  BREAKPOINT: 768
+};
+exports.defaultConfig = defaultConfig;

package/dist/libs/config/defaultConfig.d.ts

@@ -0,0 +1,5 @@
+import { UmakiConfig } from './types';
+/**
+ * Default configuration values for umaki
+ */
+export declare const defaultConfig: UmakiConfig;

package/dist/libs/config/defaultConfig.es.js

@@ -0,0 +1,17 @@
+/*!
+ * name: umaki
+ * version: v0.6.0
+ * description: A utility that is often used in web production.
+ * author: TsubasaHiga
+ * homepage: https://github.com/TsubasaHiga/umaki
+ * Released under the MIT License
+ *
+ * This software includes dependencies licensed under MIT, ISC, BSD-3-Clause, and Apache-2.0.
+ * For license information, please see LICENSE.txt
+ */
+const defaultConfig = {
+  BREAKPOINT: 768
+};
+export {
+  defaultConfig
+};

package/dist/libs/config/getConfig.cjs.js

@@ -0,0 +1,24 @@
+"use strict";
+/*!
+ * name: umaki
+ * version: v0.6.0
+ * description: A utility that is often used in web production.
+ * author: TsubasaHiga
+ * homepage: https://github.com/TsubasaHiga/umaki
+ * Released under the MIT License
+ *
+ * This software includes dependencies licensed under MIT, ISC, BSD-3-Clause, and Apache-2.0.
+ * For license information, please see LICENSE.txt
+ */
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const defaultConfig = require("./defaultConfig.cjs.js");
+const currentConfig = { ...defaultConfig.defaultConfig };
+const getConfig = () => {
+  return { ...currentConfig };
+};
+const getConfigValue = (key) => {
+  return currentConfig[key];
+};
+exports.currentConfig = currentConfig;
+exports.getConfig = getConfig;
+exports.getConfigValue = getConfigValue;

package/dist/libs/config/getConfig.d.ts

@@ -0,0 +1,14 @@
+import { UmakiConfig } from './types';
+declare const currentConfig: UmakiConfig;
+/**
+ * Get the current configuration
+ * @returns The current configuration object
+ */
+export declare const getConfig: () => UmakiConfig;
+/**
+ * Get a specific configuration value by key
+ * @param key - The configuration key to retrieve
+ * @returns The value for the specified key, or undefined if the key doesn't exist
+ */
+export declare const getConfigValue: <K extends keyof UmakiConfig>(key: K) => UmakiConfig[K];
+export { currentConfig };

package/dist/libs/config/getConfig.es.js

@@ -0,0 +1,24 @@
+/*!
+ * name: umaki
+ * version: v0.6.0
+ * description: A utility that is often used in web production.
+ * author: TsubasaHiga
+ * homepage: https://github.com/TsubasaHiga/umaki
+ * Released under the MIT License
+ *
+ * This software includes dependencies licensed under MIT, ISC, BSD-3-Clause, and Apache-2.0.
+ * For license information, please see LICENSE.txt
+ */
+import { defaultConfig } from "./defaultConfig.es.js";
+const currentConfig = { ...defaultConfig };
+const getConfig = () => {
+  return { ...currentConfig };
+};
+const getConfigValue = (key) => {
+  return currentConfig[key];
+};
+export {
+  currentConfig,
+  getConfig,
+  getConfigValue
+};

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

@@ -0,0 +1,7 @@
+/**
+ * Configuration functions
+ */
+export { getConfig, getConfigValue } from './getConfig';
+export { setConfig } from './setConfig';
+export { defaultConfig } from './defaultConfig';
+export type { UmakiConfig } from './types';

package/dist/libs/config/setConfig.cjs.js

@@ -0,0 +1,19 @@
+"use strict";
+/*!
+ * name: umaki
+ * version: v0.6.0
+ * description: A utility that is often used in web production.
+ * author: TsubasaHiga
+ * homepage: https://github.com/TsubasaHiga/umaki
+ * Released under the MIT License
+ *
+ * This software includes dependencies licensed under MIT, ISC, BSD-3-Clause, and Apache-2.0.
+ * For license information, please see LICENSE.txt
+ */
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const getConfig = require("./getConfig.cjs.js");
+const setConfig = (config) => {
+  Object.assign(getConfig.currentConfig, config);
+  return { ...getConfig.currentConfig };
+};
+exports.setConfig = setConfig;

package/dist/libs/config/setConfig.d.ts

@@ -0,0 +1,7 @@
+import { UmakiConfig } from './types';
+/**
+ * Set or update the configuration
+ * @param config - Configuration object with values to update
+ * @returns The updated configuration object
+ */
+export declare const setConfig: (config: Partial<UmakiConfig>) => UmakiConfig;

package/dist/libs/config/setConfig.es.js

@@ -0,0 +1,19 @@
+/*!
+ * name: umaki
+ * version: v0.6.0
+ * description: A utility that is often used in web production.
+ * author: TsubasaHiga
+ * homepage: https://github.com/TsubasaHiga/umaki
+ * Released under the MIT License
+ *
+ * This software includes dependencies licensed under MIT, ISC, BSD-3-Clause, and Apache-2.0.
+ * For license information, please see LICENSE.txt
+ */
+import { currentConfig } from "./getConfig.es.js";
+const setConfig = (config) => {
+  Object.assign(currentConfig, config);
+  return { ...currentConfig };
+};
+export {
+  setConfig
+};

package/dist/libs/config/types.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Configuration options for the umaki library
+ */
+export interface UmakiConfig {
+    /**
+     * Breakpoint value in pixels used for responsive design functions
+     * @default 768
+     */
+    BREAKPOINT: number;
+    /**
+     * Any additional custom configuration properties
+     */
+    [key: string]: unknown;
+}

package/dist/libs/control/bgScrollStop.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/bgScrollStop.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/pd.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/pd.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/scrollToHash.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/scrollToHash.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/videoPlayControl.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/control/videoPlayControl.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/convert/changeDateStringToSpecificFormat.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/convert/changeDateStringToSpecificFormat.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/convert/jsonStringToJsonObject.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/convert/jsonStringToJsonObject.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/eventControl/debounce.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/eventControl/debounce.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/eventControl/throttle.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/eventControl/throttle.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getAspectRatio.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getAspectRatio.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getClassNames.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getClassNames.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

package/dist/libs/get/getDocumentHeight.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.5.0
+ * version: v0.6.0
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki