umaki 0.4.0 → 0.4.2

package/README.md

@@ -73,6 +73,8 @@ import { foo } from "umaki";
 - [Wait](#wait)
   - [sleep](#sleep)
   - [waitForAllMediaLoaded](#waitforallmedialoaded)
+- [Security](#security)
+  - [sanitizeHtml](#sanitizehtml)
 
 ## Control
 
@@ -147,11 +149,34 @@ A function that converts a date string to a specific format.
 ```ts
 import { changeDateStringToSpecificFormat } from "umaki";
 
+// Basic usage
 const date = "2023-10-05";
 const formattedDate = changeDateStringToSpecificFormat(date, "MM/DD/YYYY");
 console.log(formattedDate); // '10/05/2023'
+
+// With locale
+import "dayjs/locale/ja";
+const dateWithLocale = "2025-04-25T00:00:00.000Z";
+const formattedDateWithLocale = changeDateStringToSpecificFormat(
+  dateWithLocale,
+  "YYYY年MM月DD日 (ddd)",
+  "ja"
+);
+console.log(formattedDateWithLocale); // '2025年04月25日 (金)'
+
+// With different locale
+import "dayjs/locale/en";
+const formattedDateWithEnLocale = changeDateStringToSpecificFormat(
+  dateWithLocale,
+  "YYYY年MM月DD日 (ddd)",
+  "en"
+);
+console.log(formattedDateWithEnLocale); // '2025年04月25日 (Fri)'
 ```
 
+Note: To use specific locales, you need to import the corresponding locale file in your project.
+Example: `import 'dayjs/locale/ja'`
+
 [View file →](src/libs/convert/changeDateStringToSpecificFormat.ts)
 
 ### jsonStringToJsonObject
@@ -756,27 +781,6 @@ import { waitForAllMediaLoaded } from "umaki";
 
 [View file →](src/libs/wait/waitForAllMediaLoaded.ts)
 
-## Using for framework and tools
-
-Specific usage for frameworks or various tools is described below.
-
-### Astro or Vite
-
-When using with Astro for SSR, add `umaki` to `vite.ssr.noExternal.`
-
-```ts
-// astro.config.ts
-export default defineConfig(({ mode }) => {
-  return {
-    vite: {
-      ssr: {
-        noExternal: ["umaki"],
-      },
-    },
-  };
-});
-```
-
 ## Security
 
 ### sanitizeHtml
@@ -805,3 +809,24 @@ This function uses `isomorphic-dompurify` and has the following features:
 - Can be used on both server-side and client-side
 
 [View file →](src/libs/security/htmlSanitize.ts)
+
+## Using for framework and tools
+
+Specific usage for frameworks or various tools is described below.
+
+### Astro or Vite
+
+When using with Astro for SSR, add `umaki` to `vite.ssr.noExternal.`
+
+```ts
+// astro.config.ts
+export default defineConfig(({ mode }) => {
+  return {
+    vite: {
+      ssr: {
+        noExternal: ["umaki"],
+      },
+    },
+  };
+});
+```

package/dist/_virtual/_commonjsHelpers.cjs.js

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki
@@ -45,6 +45,7 @@ const removeAllHtmlTags = require("./libs/remove/removeAllHtmlTags.cjs.js");
 const removeAttribute = require("./libs/remove/removeAttribute.cjs.js");
 const removeSessionStorage = require("./libs/remove/removeSessionStorage.cjs.js");
 const removeStylePropertyValue = require("./libs/remove/removeStylePropertyValue.cjs.js");
+const htmlSanitize = require("./libs/security/htmlSanitize.cjs.js");
 const set100vh = require("./libs/set/set100vh.cjs.js");
 const set100vw = require("./libs/set/set100vw.cjs.js");
 const setAttribute = require("./libs/set/setAttribute.cjs.js");
@@ -90,6 +91,7 @@ exports.removeAllHtmlTags = removeAllHtmlTags.removeAllHtmlTags;
 exports.removeAttribute = removeAttribute.removeAttribute;
 exports.removeSessionStorage = removeSessionStorage.removeSessionStorage;
 exports.removeStylePropertyValue = removeStylePropertyValue.removeStylePropertyValue;
+exports.htmlSanitize = htmlSanitize.htmlSanitize;
 exports.set100vh = set100vh.set100vh;
 exports.set100vw = set100vw.set100vw;
 exports.setAttribute = setAttribute.setAttribute;

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export * from './libs/eventControl';
 export * from './libs/get';
 export * from './libs/is';
 export * from './libs/remove';
+export * from './libs/security';
 export * from './libs/set';
 export * from './libs/to';
 export * from './libs/transform';

package/dist/index.es.js

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.4.0
+ * version: v0.4.2
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki
@@ -43,6 +43,7 @@ import { removeAllHtmlTags } from "./libs/remove/removeAllHtmlTags.es.js";
 import { removeAttribute } from "./libs/remove/removeAttribute.es.js";
 import { removeSessionStorage } from "./libs/remove/removeSessionStorage.es.js";
 import { removeStylePropertyValue } from "./libs/remove/removeStylePropertyValue.es.js";
+import { htmlSanitize } from "./libs/security/htmlSanitize.es.js";
 import { set100vh } from "./libs/set/set100vh.es.js";
 import { set100vw } from "./libs/set/set100vw.es.js";
 import { setAttribute } from "./libs/set/setAttribute.es.js";
@@ -73,6 +74,7 @@ export {
   getStylePropertyValue,
   getStylePropertyValueToNumber,
   getUaData,
+  htmlSanitize,
   isBetweenDateTime,
   isExistAllElements,
   isIpad,

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

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki
@@ -12,5 +12,8 @@
  */
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const dayjs = require("dayjs");
-const changeDateStringToSpecificFormat = (date, format = "YYYY年MM月DD日") => dayjs(date).format(format);
+const changeDateStringToSpecificFormat = (date, format = "YYYY年MM月DD日", locale = "ja") => {
+  dayjs.locale(locale);
+  return dayjs(date).format(format);
+};
 exports.changeDateStringToSpecificFormat = changeDateStringToSpecificFormat;

package/dist/libs/convert/changeDateStringToSpecificFormat.d.ts

@@ -1,8 +1,12 @@
 /**
  * Converts a date string to a specific format using the dayjs library.
  *
+ * Note: To use specific locales, you need to import the corresponding locale file in your project.
+ * Example: import 'dayjs/locale/ja'
+ *
  * @param date - The date string to be converted.
  * @param format - The format to convert the date string to. Defaults to 'YYYY年MM月DD日'.
+ * @param locale - The locale to use for formatting. Defaults to 'ja'.
  * @returns The formatted date string.
  */
-export declare const changeDateStringToSpecificFormat: (date: string, format?: string) => string;
+export declare const changeDateStringToSpecificFormat: (date: string, format?: string, locale?: string) => string;

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

@@ -1,6 +1,6 @@
 /*!
  * name: umaki
- * version: v0.4.0
+ * version: v0.4.2
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki
@@ -10,7 +10,10 @@
  * For license information, please see LICENSE.txt
  */
 import dayjs from "dayjs";
-const changeDateStringToSpecificFormat = (date, format = "YYYY年MM月DD日") => dayjs(date).format(format);
+const changeDateStringToSpecificFormat = (date, format = "YYYY年MM月DD日", locale = "ja") => {
+  dayjs.locale(locale);
+  return dayjs(date).format(format);
+};
 export {
   changeDateStringToSpecificFormat
 };

package/dist/libs/convert/changeDateStringToSpecificFormat.test.d.ts

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

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

@@ -1,7 +1,7 @@
 "use strict";
 /*!
  * name: umaki
- * version: v0.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * 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.4.0
+ * version: v0.4.2
  * description: A utility that is often used in web production.
  * author: TsubasaHiga
  * homepage: https://github.com/TsubasaHiga/umaki

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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