@wavy/fn 0.0.17 → 0.0.18

package/dist/main.cjs

@@ -98,6 +98,91 @@ module.exports = __toCommonJS(main_exports);
 // src/helper-functions/HelperFunctions.ts
 var import_types2 = require("@wavy/types");
 
+// src/helper-functions/components/ObjectConverter.ts
+var import_uuid = require("uuid");
+var import_types = require("@wavy/types");
+var import_console = require("console");
+function fileToLocalFile(file, options) {
+  const fileExt = getFileExt(file.name);
+  const fileName = (() => {
+    if (options?.filename && options.filename.includes(fileExt))
+      return options.filename;
+    else if (options?.filename) return options.filename.trim() + fileExt;
+    return file.name;
+  })()?.trim?.();
+  const { name: _, size: __, ..._metadata } = file;
+  return {
+    uid: options?.uid || (0, import_uuid.v4)(),
+    description: options?.description,
+    ext: fileExt,
+    path: options?.filepath || file?.webkitRelativePath,
+    typeAlias: options?.typeAlias || run(
+      Object.keys(import_types.LOCAL_FILE_MIME_TYPES).find(
+        (key) => import_types.LOCAL_FILE_MIME_TYPES[key].includes(file.type)
+      ),
+      (type) => {
+        if (!type) {
+          (0, import_console.log)("An unknown file type was found ", file.type);
+          return "unknown";
+        }
+        return type;
+      }
+    ),
+    sizeInBytes: file.size,
+    uploadDate: options?.uploadDate === "now" ? Date.now() : options?.uploadDate ?? file?.lastModified,
+    name: fileName,
+    _metadata
+  };
+}
+function localFileToFile(localFile) {
+  return {
+    name: localFile.name,
+    size: localFile.sizeInBytes,
+    ...localFile._metadata
+  };
+}
+var Overloader = class {
+  invoke(...args) {
+    if (isFile(args[0])) {
+      return fileToLocalFile(...args);
+    }
+    if (isLocalFile(args[0])) {
+      return localFileToFile(...args);
+    } else throw new Error(`The arguments supplied are insufficient.`);
+  }
+};
+var toObject = new Overloader().invoke;
+var ObjectConverter_default = toObject;
+
+// src/helper-functions/components/formatter/FileSizeFormatter.ts
+var FileSizeFormatter = class {
+  constructor(bytes) {
+    this.bytes = bytes;
+  }
+  bytes;
+  toKb() {
+    return { amount: this.scaleUp(this.bytes), unit: "KB" };
+  }
+  toMb() {
+    return { amount: this.scaleUp(this.toKb().amount), unit: "MB" };
+  }
+  toGb() {
+    return { amount: this.scaleUp(this.toMb().amount), unit: "GB" };
+  }
+  toTb() {
+    return { amount: this.scaleUp(this.toGb().amount), unit: "TB" };
+  }
+  format() {
+    const size = [this.toTb(), this.toGb(), this.toMb(), this.toKb()].map(
+      (size2) => ({ ...size2, amount: Math.floor(size2.amount) })
+    ).find((size2) => size2.amount >= 1);
+    return size ? `${size.amount} ${size.unit}` : `${this.bytes} B`;
+  }
+  scaleUp(bytes) {
+    return bytes / 1e3;
+  }
+};
+
 // src/helper-functions/components/formatter/number/NumberFormatter.ts
 var NumberFormatter = class _NumberFormatter {
   static format(value, format2, options) {
@@ -441,62 +526,6 @@ var TimeManager = class _TimeManager {
 };
 var TimeManager_default = TimeManager;
 
-// src/helper-functions/components/ObjectConverter.ts
-var import_uuid = require("uuid");
-var import_types = require("@wavy/types");
-var import_console = require("console");
-function fileToLocalFile(file, options) {
-  const fileExt = getFileExt(file.name);
-  const fileName = (() => {
-    if (options?.filename && options.filename.includes(fileExt))
-      return options.filename;
-    else if (options?.filename) return options.filename.trim() + fileExt;
-    return file.name;
-  })()?.trim?.();
-  const { name: _, size: __, ..._metadata } = file;
-  return {
-    uid: options?.uid || (0, import_uuid.v4)(),
-    description: options?.description,
-    ext: fileExt,
-    path: options?.filepath || file?.webkitRelativePath,
-    typeAlias: options?.typeAlias || run(
-      Object.keys(import_types.LOCAL_FILE_MIME_TYPES).find(
-        (key) => import_types.LOCAL_FILE_MIME_TYPES[key].includes(file.type)
-      ),
-      (type) => {
-        if (!type) {
-          (0, import_console.log)("An unknown file type was found ", file.type);
-          return "unknown";
-        }
-        return type;
-      }
-    ),
-    sizeInBytes: file.size,
-    uploadDate: options?.uploadDate === "now" ? Date.now() : options?.uploadDate ?? file?.lastModified,
-    name: fileName,
-    _metadata
-  };
-}
-function localFileToFile(localFile) {
-  return {
-    name: localFile.name,
-    size: localFile.sizeInBytes,
-    ...localFile._metadata
-  };
-}
-var Overloader = class {
-  invoke(...args) {
-    if (isFile(args[0])) {
-      return fileToLocalFile(...args);
-    }
-    if (isLocalFile(args[0])) {
-      return localFileToFile(...args);
-    } else throw new Error(`The arguments supplied are insufficient.`);
-  }
-};
-var toObject = new Overloader().invoke;
-var ObjectConverter_default = toObject;
-
 // src/helper-functions/HelperFunctions.ts
 var dateFormat = new TimeManager_default().format;
 var timeDuration = new TimeManager_default().getDuration;
@@ -525,6 +554,8 @@ function format(event, ...args) {
       return getCaller(toMoney);
     case "name":
       return getCaller(nameToString);
+    case "file-size":
+      return new FileSizeFormatter(args[0]).format();
     default:
       return event;
   }

package/dist/main.d.cts

@@ -4,6 +4,18 @@ import { LocalFile, SanitizeFile, KnownFileTypeAlias, TaskResult, FromServer, No
 
 type DateFormat = "MMM dd, yyyy" | "MMM dd, yyyy | hh:mm A" | "MMM dd, yyyy at hh:mm A" | "MMMM" | "yyyy" | "MMM yyyy" | "mm/dd/yyyy" | "mm/dd/yyyy hh:mm A" | "hh:mm A" | "hh:mm:ss A";
 
+declare const toObject: {
+    (file: File | Pick<File, "size" | "name" | "type" | "webkitRelativePath" | "lastModified">, options?: Partial<{
+        uid?: string;
+        uploadDate: number | "now";
+        description: string;
+        filepath: string;
+        filename: string;
+        typeAlias: LocalFile["typeAlias"];
+    }> | undefined): LocalFile;
+    (localFile: LocalFile): File;
+};
+
 type NumberFormatterTypes = {
     formats: "money";
     options: {
@@ -34,18 +46,6 @@ declare class StringFormatter {
     static upperFirst(value: string): string;
 }
 
-declare const toObject: {
-    (file: File | Pick<File, "name" | "size" | "type" | "webkitRelativePath" | "lastModified">, options?: Partial<{
-        uid?: string;
-        uploadDate: number | "now";
-        description: string;
-        filepath: string;
-        filename: string;
-        typeAlias: LocalFile["typeAlias"];
-    }> | undefined): LocalFile;
-    (localFile: LocalFile): File;
-};
-
 declare const dateFormat: (time: number | Date | "now", format?: DateFormat) => string;
 declare const timeDuration: (from: number | "now" | Date, to: number | "now" | Date, options?: {
     disableRemainder?: boolean;
@@ -62,7 +62,7 @@ declare const pluralize: typeof StringFormatter.pluralize;
 declare const nameToString: (name: _wavy_types.Name | undefined) => string;
 declare const addressToString: (address: _wavy_types.Address | undefined, inline?: boolean) => string;
 declare const toMoney: (value: string | number, options?: NumberFormatterTypes["options"]["money"]) => string;
-declare function format<Event extends "date" | "money" | "name" | "address">(event: Event, ...args: Event extends "date" ? Parameters<typeof dateFormat> : Event extends "money" ? Parameters<typeof toMoney> : Event extends "name" ? Parameters<typeof nameToString> : Event extends "address" ? Parameters<typeof addressToString> : never): Event extends "date" ? ReturnType<typeof dateFormat> : Event extends "money" ? ReturnType<typeof toMoney> : Event extends "name" ? ReturnType<typeof nameToString> : Event extends "address" ? ReturnType<typeof addressToString> : never;
+declare function format<Event extends "date" | "money" | "name" | "address" | "file-size">(event: Event, ...args: Event extends "date" ? Parameters<typeof dateFormat> : Event extends "money" ? Parameters<typeof toMoney> : Event extends "name" ? Parameters<typeof nameToString> : Event extends "address" ? Parameters<typeof addressToString> : Event extends "file-size" ? [bytes: number] : never): Event extends "date" | "money" | "name" | "address" | "file-size" ? string : never;
 declare function sanitizeLocalFile({ _metadata: _, ...file }: LocalFile): SanitizeFile<LocalFile>;
 declare function isFile(value: unknown): value is File;
 declare function isLocalFile(value: unknown): value is LocalFile;

package/dist/main.d.ts

@@ -4,6 +4,18 @@ import { LocalFile, SanitizeFile, KnownFileTypeAlias, TaskResult, FromServer, No
 
 type DateFormat = "MMM dd, yyyy" | "MMM dd, yyyy | hh:mm A" | "MMM dd, yyyy at hh:mm A" | "MMMM" | "yyyy" | "MMM yyyy" | "mm/dd/yyyy" | "mm/dd/yyyy hh:mm A" | "hh:mm A" | "hh:mm:ss A";
 
+declare const toObject: {
+    (file: File | Pick<File, "size" | "name" | "type" | "webkitRelativePath" | "lastModified">, options?: Partial<{
+        uid?: string;
+        uploadDate: number | "now";
+        description: string;
+        filepath: string;
+        filename: string;
+        typeAlias: LocalFile["typeAlias"];
+    }> | undefined): LocalFile;
+    (localFile: LocalFile): File;
+};
+
 type NumberFormatterTypes = {
     formats: "money";
     options: {
@@ -34,18 +46,6 @@ declare class StringFormatter {
     static upperFirst(value: string): string;
 }
 
-declare const toObject: {
-    (file: File | Pick<File, "name" | "size" | "type" | "webkitRelativePath" | "lastModified">, options?: Partial<{
-        uid?: string;
-        uploadDate: number | "now";
-        description: string;
-        filepath: string;
-        filename: string;
-        typeAlias: LocalFile["typeAlias"];
-    }> | undefined): LocalFile;
-    (localFile: LocalFile): File;
-};
-
 declare const dateFormat: (time: number | Date | "now", format?: DateFormat) => string;
 declare const timeDuration: (from: number | "now" | Date, to: number | "now" | Date, options?: {
     disableRemainder?: boolean;
@@ -62,7 +62,7 @@ declare const pluralize: typeof StringFormatter.pluralize;
 declare const nameToString: (name: _wavy_types.Name | undefined) => string;
 declare const addressToString: (address: _wavy_types.Address | undefined, inline?: boolean) => string;
 declare const toMoney: (value: string | number, options?: NumberFormatterTypes["options"]["money"]) => string;
-declare function format<Event extends "date" | "money" | "name" | "address">(event: Event, ...args: Event extends "date" ? Parameters<typeof dateFormat> : Event extends "money" ? Parameters<typeof toMoney> : Event extends "name" ? Parameters<typeof nameToString> : Event extends "address" ? Parameters<typeof addressToString> : never): Event extends "date" ? ReturnType<typeof dateFormat> : Event extends "money" ? ReturnType<typeof toMoney> : Event extends "name" ? ReturnType<typeof nameToString> : Event extends "address" ? ReturnType<typeof addressToString> : never;
+declare function format<Event extends "date" | "money" | "name" | "address" | "file-size">(event: Event, ...args: Event extends "date" ? Parameters<typeof dateFormat> : Event extends "money" ? Parameters<typeof toMoney> : Event extends "name" ? Parameters<typeof nameToString> : Event extends "address" ? Parameters<typeof addressToString> : Event extends "file-size" ? [bytes: number] : never): Event extends "date" | "money" | "name" | "address" | "file-size" ? string : never;
 declare function sanitizeLocalFile({ _metadata: _, ...file }: LocalFile): SanitizeFile<LocalFile>;
 declare function isFile(value: unknown): value is File;
 declare function isLocalFile(value: unknown): value is LocalFile;

package/dist/main.js

@@ -3,6 +3,91 @@ import {
   LOCAL_FILE_MIME_TYPES as LOCAL_FILE_MIME_TYPES2
 } from "@wavy/types";
 
+// src/helper-functions/components/ObjectConverter.ts
+import { v4 } from "uuid";
+import { LOCAL_FILE_MIME_TYPES } from "@wavy/types";
+import { log } from "console";
+function fileToLocalFile(file, options) {
+  const fileExt = getFileExt(file.name);
+  const fileName = (() => {
+    if (options?.filename && options.filename.includes(fileExt))
+      return options.filename;
+    else if (options?.filename) return options.filename.trim() + fileExt;
+    return file.name;
+  })()?.trim?.();
+  const { name: _, size: __, ..._metadata } = file;
+  return {
+    uid: options?.uid || v4(),
+    description: options?.description,
+    ext: fileExt,
+    path: options?.filepath || file?.webkitRelativePath,
+    typeAlias: options?.typeAlias || run(
+      Object.keys(LOCAL_FILE_MIME_TYPES).find(
+        (key) => LOCAL_FILE_MIME_TYPES[key].includes(file.type)
+      ),
+      (type) => {
+        if (!type) {
+          log("An unknown file type was found ", file.type);
+          return "unknown";
+        }
+        return type;
+      }
+    ),
+    sizeInBytes: file.size,
+    uploadDate: options?.uploadDate === "now" ? Date.now() : options?.uploadDate ?? file?.lastModified,
+    name: fileName,
+    _metadata
+  };
+}
+function localFileToFile(localFile) {
+  return {
+    name: localFile.name,
+    size: localFile.sizeInBytes,
+    ...localFile._metadata
+  };
+}
+var Overloader = class {
+  invoke(...args) {
+    if (isFile(args[0])) {
+      return fileToLocalFile(...args);
+    }
+    if (isLocalFile(args[0])) {
+      return localFileToFile(...args);
+    } else throw new Error(`The arguments supplied are insufficient.`);
+  }
+};
+var toObject = new Overloader().invoke;
+var ObjectConverter_default = toObject;
+
+// src/helper-functions/components/formatter/FileSizeFormatter.ts
+var FileSizeFormatter = class {
+  constructor(bytes) {
+    this.bytes = bytes;
+  }
+  bytes;
+  toKb() {
+    return { amount: this.scaleUp(this.bytes), unit: "KB" };
+  }
+  toMb() {
+    return { amount: this.scaleUp(this.toKb().amount), unit: "MB" };
+  }
+  toGb() {
+    return { amount: this.scaleUp(this.toMb().amount), unit: "GB" };
+  }
+  toTb() {
+    return { amount: this.scaleUp(this.toGb().amount), unit: "TB" };
+  }
+  format() {
+    const size = [this.toTb(), this.toGb(), this.toMb(), this.toKb()].map(
+      (size2) => ({ ...size2, amount: Math.floor(size2.amount) })
+    ).find((size2) => size2.amount >= 1);
+    return size ? `${size.amount} ${size.unit}` : `${this.bytes} B`;
+  }
+  scaleUp(bytes) {
+    return bytes / 1e3;
+  }
+};
+
 // src/helper-functions/components/formatter/number/NumberFormatter.ts
 var NumberFormatter = class _NumberFormatter {
   static format(value, format2, options) {
@@ -346,62 +431,6 @@ var TimeManager = class _TimeManager {
 };
 var TimeManager_default = TimeManager;
 
-// src/helper-functions/components/ObjectConverter.ts
-import { v4 } from "uuid";
-import { LOCAL_FILE_MIME_TYPES } from "@wavy/types";
-import { log } from "console";
-function fileToLocalFile(file, options) {
-  const fileExt = getFileExt(file.name);
-  const fileName = (() => {
-    if (options?.filename && options.filename.includes(fileExt))
-      return options.filename;
-    else if (options?.filename) return options.filename.trim() + fileExt;
-    return file.name;
-  })()?.trim?.();
-  const { name: _, size: __, ..._metadata } = file;
-  return {
-    uid: options?.uid || v4(),
-    description: options?.description,
-    ext: fileExt,
-    path: options?.filepath || file?.webkitRelativePath,
-    typeAlias: options?.typeAlias || run(
-      Object.keys(LOCAL_FILE_MIME_TYPES).find(
-        (key) => LOCAL_FILE_MIME_TYPES[key].includes(file.type)
-      ),
-      (type) => {
-        if (!type) {
-          log("An unknown file type was found ", file.type);
-          return "unknown";
-        }
-        return type;
-      }
-    ),
-    sizeInBytes: file.size,
-    uploadDate: options?.uploadDate === "now" ? Date.now() : options?.uploadDate ?? file?.lastModified,
-    name: fileName,
-    _metadata
-  };
-}
-function localFileToFile(localFile) {
-  return {
-    name: localFile.name,
-    size: localFile.sizeInBytes,
-    ...localFile._metadata
-  };
-}
-var Overloader = class {
-  invoke(...args) {
-    if (isFile(args[0])) {
-      return fileToLocalFile(...args);
-    }
-    if (isLocalFile(args[0])) {
-      return localFileToFile(...args);
-    } else throw new Error(`The arguments supplied are insufficient.`);
-  }
-};
-var toObject = new Overloader().invoke;
-var ObjectConverter_default = toObject;
-
 // src/helper-functions/HelperFunctions.ts
 var dateFormat = new TimeManager_default().format;
 var timeDuration = new TimeManager_default().getDuration;
@@ -430,6 +459,8 @@ function format(event, ...args) {
       return getCaller(toMoney);
     case "name":
       return getCaller(nameToString);
+    case "file-size":
+      return new FileSizeFormatter(args[0]).format();
     default:
       return event;
   }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@wavy/fn",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "main": "./dist/main.js",
   "module": "./dist/main.cjs",
   "types": "./dist/main.d.ts",
   "scripts": {
     "build": "tsup && node prepend",
-    "success": "✨ Successfully published package! ✨",
+    "success": "echo ✨ Successfully published package! ✨",
     "publisher": "npm run build && npm version patch && npm publish && npm run success"
   },
   "repository": {