@knime/utils 1.9.1 → 1.10.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @knime/utils
 
+## 1.10.0
+
+### Minor Changes
+
+- ea3b7e1: Add util to format file-sizes
+
+## 1.9.2
+
+### Patch Changes
+
+- 6d57731: Add option to allow hyperlinks to the sanitization util.
+
 ## 1.9.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/utils",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "description": "Internal utility functions and constants shared across @knime packages.",
   "repository": {
     "type": "git",
@@ -14,7 +14,8 @@
   "dependencies": {
     "date-fns": "2.30.0",
     "date-fns-tz": "2.0.0",
-    "dompurify": "^3.2.7"
+    "dompurify": "^3.2.7",
+    "filesize": "10.0.6"
   },
   "peerDependencies": {
     "consola": "3.x"

package/src/format.ts

@@ -1,3 +1,5 @@
+import { filesize } from "filesize";
+
 import getLocalTimeZone from "./localTimezone";
 /**
  * Converts the specified date String to human readable text containing the day, month, and year.
@@ -95,3 +97,17 @@ export const formatDateTimeString = (
  */
 export const formatLocalDateTimeString = (date: string, showTime: boolean) =>
   showTime ? formatDateTimeString(date, true) : formatDateString(date, true);
+
+export const formatFileSize = (bytes: number, decimals = 1): string => {
+  const safeBytes = Number.isFinite(bytes) && bytes >= 0 ? bytes : 0;
+  const safeDecimals =
+    Number.isFinite(decimals) && decimals >= 0 ? Math.floor(decimals) : 0;
+
+  return filesize(safeBytes, {
+    output: "string",
+    base: 2,
+    standard: "iec",
+    round: safeDecimals,
+    pad: true,
+  }) as string;
+};

package/src/index.ts

@@ -5,6 +5,7 @@ import { filters } from "./filters";
 import {
   formatDateString,
   formatDateTimeString,
+  formatFileSize,
   formatLocalDateTimeString,
   formatTimeString,
 } from "./format";
@@ -55,6 +56,7 @@ export {
   filters,
   formatDateString,
   formatDateTimeString,
+  formatFileSize,
   getDeepActiveElement,
   formatLocalDateTimeString,
   formatTimeString,

package/src/sanitization.ts

@@ -35,16 +35,28 @@ const ALLOWED_TAGS = [
 /**
  * Sanitizes Raw HTML and only allow specific tags to be used, as per OWASP standards.
  * @param rawHTML
+ * @param options.allowStyleAttribute - Allow the style attribute on elements
+ * @param options.allowHyperlinks - Allow anchor tags with href attribute
  * @returns sanitized html
  */
 const sanitizeHTML = (
   rawHTML: string,
-  options: { allowStyleAttribute: boolean } = { allowStyleAttribute: false },
+  options: { allowStyleAttribute?: boolean; allowHyperlinks?: boolean } = {
+    allowStyleAttribute: false,
+    allowHyperlinks: false,
+  },
 ) => {
-  const { allowStyleAttribute } = options;
-  const ALLOWED_ATTR = allowStyleAttribute ? ["style"] : [];
+  const { allowStyleAttribute, allowHyperlinks } = options;
+  const ALLOWED_ATTR = [
+    ...(allowStyleAttribute ? ["style"] : []),
+    ...(allowHyperlinks ? ["href"] : []),
+  ];
+  const allowedTags = allowHyperlinks ? [...ALLOWED_TAGS, "a"] : ALLOWED_TAGS;
 
-  return DomPurify.sanitize(rawHTML, { ALLOWED_TAGS, ALLOWED_ATTR });
+  return DomPurify.sanitize(rawHTML, {
+    ALLOWED_TAGS: allowedTags,
+    ALLOWED_ATTR,
+  });
 };
 
 /**