@wavy/fn 0.0.1 → 0.0.3

package/dist/main.cjs

@@ -55,6 +55,7 @@ __export(main_exports, {
   isEmpty: () => isEmpty,
   isFile: () => isFile,
   isLetter: () => isLetter,
+  isLocalFile: () => isLocalFile,
   isNumber: () => isNumber,
   lastIndex: () => lastIndex,
   map: () => map,
@@ -481,7 +482,7 @@ function format(event, ...args) {
       return event;
   }
 }
-function isFile(obj) {
+function isFile(value) {
   const fileKeys = Object.keys({
     arrayBuffer: null,
     bytes: null,
@@ -494,42 +495,89 @@ function isFile(obj) {
     type: null,
     webkitRelativePath: null
   });
-  if (obj && typeof obj === "object" && fileKeys.every((key) => key in obj))
+  if (value && typeof value === "object" && fileKeys.every((key) => key in value) && fileKeys.length === Object.keys(value).length)
     return true;
   return false;
 }
-function toObject(object, ...args) {
-  if (isFile(object)) {
-    const options = args[0];
+function isLocalFile(value) {
+  const dummyLocalFile = {
+    name: "",
+    description: "",
+    path: "",
+    sizeInBytes: 0,
+    typeAlias: "unknown",
+    uid: "",
+    uploadDate: 0,
+    _metadata: void 0
+  };
+  const optionalKeys = ["description", "_metadata"];
+  const requiredKeys = Object.keys(dummyLocalFile).filter((key) => !optionalKeys.includes(key));
+  const allKeys = [requiredKeys, optionalKeys].flat();
+  if (value && typeof value === "object" && requiredKeys.every((key) => key in value) && Object.keys(value).every((key) => allKeys.includes(key))) {
+    return true;
+  }
+  return false;
+}
+var toObject = new class T {
+  fileToLocalFile(file, options) {
     const fileName = (() => {
-      const fileExt = getFileExt(object.name);
+      const fileExt = getFileExt(file.name);
       if (options?.filename && options.filename.includes(fileExt))
         return options.filename;
       else if (options?.filename) return options.filename.trim() + fileExt;
-      return object.name;
+      return file.name;
     })()?.trim?.();
+    const { name: _, size: __, ..._metadata } = file;
     return {
       uid: (0, import_uuid.v4)(),
       description: options?.description,
-      path: options?.filepath || object.webkitRelativePath,
+      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(object.type)
+          (key) => import_types.LOCAL_FILE_MIME_TYPES[key].includes(file.type)
         ),
         (type) => {
           if (!type) {
-            (0, import_console.log)("An unknown file type was found ", object.type);
+            (0, import_console.log)("An unknown file type was found ", file.type);
             return "unknown";
           }
           return type;
         }
       ),
-      sizeInBytes: object.size,
-      uploadDate: options?.uploadDate === "now" ? Date.now() : options?.uploadDate ?? object.lastModified,
-      name: fileName
+      sizeInBytes: file.size,
+      uploadDate: options?.uploadDate === "now" ? Date.now() : options?.uploadDate ?? file.lastModified,
+      name: fileName,
+      _metadata
     };
   }
-}
+  localFileToFile(localFile) {
+    if ("_metadata" in localFile) {
+      return {
+        name: localFile.name,
+        size: localFile.sizeInBytes,
+        ...localFile._metadata
+      };
+    }
+    return {
+      name: localFile.name,
+      size: localFile.sizeInBytes,
+      webkitRelativePath: localFile.path,
+      lastModified: localFile.uploadDate
+    };
+  }
+  invoke(...args) {
+    if (isFile(args[0])) {
+      return this.fileToLocalFile(
+        ...args
+      );
+    }
+    if (isLocalFile(args[0])) {
+      return this.localFileToFile(
+        ...args
+      );
+    } else throw new Error(`The arguments supplied are insufficient.`);
+  }
+}().invoke;
 function classNameResolver(baseClassName) {
   return (className) => {
     return `${baseClassName}-${className}`;
@@ -1064,6 +1112,7 @@ var serverDataAdapter = new ServerDataAdapter().invoke;
   isEmpty,
   isFile,
   isLetter,
+  isLocalFile,
   isNumber,
   lastIndex,
   map,

package/dist/main.d.cts

@@ -49,16 +49,24 @@ declare const phoneNoToString: (phoneNumber: PhoneNumber | undefined) => string;
 declare const addressToString: (address: Address | undefined, inline?: boolean) => string;
 declare const toMoney: (value: string | number, options?: NumberFormatterTypes["options"]["money"]) => string;
 declare function format<Event extends "date" | "money" | "name" | "phone-number" | "address">(event: Event, ...args: Event extends "date" ? Parameters<typeof dateFormat> : Event extends "money" ? Parameters<typeof toMoney> : Event extends "name" ? Parameters<typeof nameToString> : Event extends "phone-number" ? Parameters<typeof phoneNoToString> : 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 "phone-number" ? ReturnType<typeof phoneNoToString> : Event extends "address" ? ReturnType<typeof addressToString> : never;
-declare function isFile(obj: unknown): obj is File;
-declare function toObject<O extends File>(object: O, ...args: O extends File ? [
-    options?: Partial<{
+declare function isFile(value: unknown): value is File;
+declare function isLocalFile(value: unknown): value is LocalFile;
+declare const toObject: {
+    (file: File, options?: Partial<{
         uploadDate: number | "now";
         description: string;
         filepath: string;
         filename: string;
         typeAlias: LocalFile["typeAlias"];
-    }>
-] : []): O extends File ? LocalFile | undefined : void;
+    }> | undefined): ReturnType<(file: File, options?: Partial<{
+        uploadDate: number | "now";
+        description: string;
+        filepath: string;
+        filename: string;
+        typeAlias: LocalFile["typeAlias"];
+    }>) => LocalFile>;
+    (localFile: LocalFile | SanitizeLocalType<LocalFile>): ReturnType<(<LocalFileType extends LocalFile | SanitizeLocalType<LocalFile>>(localFile: LocalFileType) => LocalFileType extends LocalFile ? File : Partialize<File, "arrayBuffer" | "stream" | "slice" | "text" | "bytes" | "type">)>;
+};
 declare function classNameResolver(baseClassName: string): (className: string) => string;
 declare function classNameExt(rootClassName: string): (className: string) => string;
 declare function range(start: number, end: number): number[];
@@ -174,4 +182,4 @@ declare const serverDataAdapter: {
     }>(event: "unzip", data: DataType): NormalizeFromServer<DataType>;
 };
 
-export { addArticle, arrayWithConst, asyncRun, averageOf, blankSpaces, buildArray, camelCaseToLetter, classNameExt, classNameResolver, coerceIn, copyToClipboard, count, dataSearcher, distinct, drop, dropLast, dropLastWhile, dropWhile, format, formatGCTRegNo, formatInvoiceNo, getCaps, getFileExt, group, hasIndex, ifDefined, ifEmpty, inRange, indexOf, indices, inferFilename, insertAt, isEmpty, isFile, isLetter, isNumber, lastIndex, map, mapToArray, maxOf, minOf, negate, ordinalIndicator, overwrite, pluralize, poll, random, range, readClipboardText, removeAll, repeat, run, serverDataAdapter, someValuesEmpty, sort, strictArray, stringToSearch, subObjectList, sumOf, take, takeLast, takeLastWhile, takeWhile, timeDuration, toNumber, toObject, trimString, undefinedIfEmpty, upperFirst, windowed };
+export { addArticle, arrayWithConst, asyncRun, averageOf, blankSpaces, buildArray, camelCaseToLetter, classNameExt, classNameResolver, coerceIn, copyToClipboard, count, dataSearcher, distinct, drop, dropLast, dropLastWhile, dropWhile, format, formatGCTRegNo, formatInvoiceNo, getCaps, getFileExt, group, hasIndex, ifDefined, ifEmpty, inRange, indexOf, indices, inferFilename, insertAt, isEmpty, isFile, isLetter, isLocalFile, isNumber, lastIndex, map, mapToArray, maxOf, minOf, negate, ordinalIndicator, overwrite, pluralize, poll, random, range, readClipboardText, removeAll, repeat, run, serverDataAdapter, someValuesEmpty, sort, strictArray, stringToSearch, subObjectList, sumOf, take, takeLast, takeLastWhile, takeWhile, timeDuration, toNumber, toObject, trimString, undefinedIfEmpty, upperFirst, windowed };

package/dist/main.d.ts

@@ -49,16 +49,24 @@ declare const phoneNoToString: (phoneNumber: PhoneNumber | undefined) => string;
 declare const addressToString: (address: Address | undefined, inline?: boolean) => string;
 declare const toMoney: (value: string | number, options?: NumberFormatterTypes["options"]["money"]) => string;
 declare function format<Event extends "date" | "money" | "name" | "phone-number" | "address">(event: Event, ...args: Event extends "date" ? Parameters<typeof dateFormat> : Event extends "money" ? Parameters<typeof toMoney> : Event extends "name" ? Parameters<typeof nameToString> : Event extends "phone-number" ? Parameters<typeof phoneNoToString> : 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 "phone-number" ? ReturnType<typeof phoneNoToString> : Event extends "address" ? ReturnType<typeof addressToString> : never;
-declare function isFile(obj: unknown): obj is File;
-declare function toObject<O extends File>(object: O, ...args: O extends File ? [
-    options?: Partial<{
+declare function isFile(value: unknown): value is File;
+declare function isLocalFile(value: unknown): value is LocalFile;
+declare const toObject: {
+    (file: File, options?: Partial<{
         uploadDate: number | "now";
         description: string;
         filepath: string;
         filename: string;
         typeAlias: LocalFile["typeAlias"];
-    }>
-] : []): O extends File ? LocalFile | undefined : void;
+    }> | undefined): ReturnType<(file: File, options?: Partial<{
+        uploadDate: number | "now";
+        description: string;
+        filepath: string;
+        filename: string;
+        typeAlias: LocalFile["typeAlias"];
+    }>) => LocalFile>;
+    (localFile: LocalFile | SanitizeLocalType<LocalFile>): ReturnType<(<LocalFileType extends LocalFile | SanitizeLocalType<LocalFile>>(localFile: LocalFileType) => LocalFileType extends LocalFile ? File : Partialize<File, "arrayBuffer" | "stream" | "slice" | "text" | "bytes" | "type">)>;
+};
 declare function classNameResolver(baseClassName: string): (className: string) => string;
 declare function classNameExt(rootClassName: string): (className: string) => string;
 declare function range(start: number, end: number): number[];
@@ -174,4 +182,4 @@ declare const serverDataAdapter: {
     }>(event: "unzip", data: DataType): NormalizeFromServer<DataType>;
 };
 
-export { addArticle, arrayWithConst, asyncRun, averageOf, blankSpaces, buildArray, camelCaseToLetter, classNameExt, classNameResolver, coerceIn, copyToClipboard, count, dataSearcher, distinct, drop, dropLast, dropLastWhile, dropWhile, format, formatGCTRegNo, formatInvoiceNo, getCaps, getFileExt, group, hasIndex, ifDefined, ifEmpty, inRange, indexOf, indices, inferFilename, insertAt, isEmpty, isFile, isLetter, isNumber, lastIndex, map, mapToArray, maxOf, minOf, negate, ordinalIndicator, overwrite, pluralize, poll, random, range, readClipboardText, removeAll, repeat, run, serverDataAdapter, someValuesEmpty, sort, strictArray, stringToSearch, subObjectList, sumOf, take, takeLast, takeLastWhile, takeWhile, timeDuration, toNumber, toObject, trimString, undefinedIfEmpty, upperFirst, windowed };
+export { addArticle, arrayWithConst, asyncRun, averageOf, blankSpaces, buildArray, camelCaseToLetter, classNameExt, classNameResolver, coerceIn, copyToClipboard, count, dataSearcher, distinct, drop, dropLast, dropLastWhile, dropWhile, format, formatGCTRegNo, formatInvoiceNo, getCaps, getFileExt, group, hasIndex, ifDefined, ifEmpty, inRange, indexOf, indices, inferFilename, insertAt, isEmpty, isFile, isLetter, isLocalFile, isNumber, lastIndex, map, mapToArray, maxOf, minOf, negate, ordinalIndicator, overwrite, pluralize, poll, random, range, readClipboardText, removeAll, repeat, run, serverDataAdapter, someValuesEmpty, sort, strictArray, stringToSearch, subObjectList, sumOf, take, takeLast, takeLastWhile, takeWhile, timeDuration, toNumber, toObject, trimString, undefinedIfEmpty, upperFirst, windowed };

package/dist/main.js

@@ -386,7 +386,7 @@ function format(event, ...args) {
       return event;
   }
 }
-function isFile(obj) {
+function isFile(value) {
   const fileKeys = Object.keys({
     arrayBuffer: null,
     bytes: null,
@@ -399,42 +399,89 @@ function isFile(obj) {
     type: null,
     webkitRelativePath: null
   });
-  if (obj && typeof obj === "object" && fileKeys.every((key) => key in obj))
+  if (value && typeof value === "object" && fileKeys.every((key) => key in value) && fileKeys.length === Object.keys(value).length)
     return true;
   return false;
 }
-function toObject(object, ...args) {
-  if (isFile(object)) {
-    const options = args[0];
+function isLocalFile(value) {
+  const dummyLocalFile = {
+    name: "",
+    description: "",
+    path: "",
+    sizeInBytes: 0,
+    typeAlias: "unknown",
+    uid: "",
+    uploadDate: 0,
+    _metadata: void 0
+  };
+  const optionalKeys = ["description", "_metadata"];
+  const requiredKeys = Object.keys(dummyLocalFile).filter((key) => !optionalKeys.includes(key));
+  const allKeys = [requiredKeys, optionalKeys].flat();
+  if (value && typeof value === "object" && requiredKeys.every((key) => key in value) && Object.keys(value).every((key) => allKeys.includes(key))) {
+    return true;
+  }
+  return false;
+}
+var toObject = new class T {
+  fileToLocalFile(file, options) {
     const fileName = (() => {
-      const fileExt = getFileExt(object.name);
+      const fileExt = getFileExt(file.name);
       if (options?.filename && options.filename.includes(fileExt))
         return options.filename;
       else if (options?.filename) return options.filename.trim() + fileExt;
-      return object.name;
+      return file.name;
     })()?.trim?.();
+    const { name: _, size: __, ..._metadata } = file;
     return {
       uid: v4(),
       description: options?.description,
-      path: options?.filepath || object.webkitRelativePath,
+      path: options?.filepath || file.webkitRelativePath,
       typeAlias: options?.typeAlias || run(
         Object.keys(LOCAL_FILE_MIME_TYPES).find(
-          (key) => LOCAL_FILE_MIME_TYPES[key].includes(object.type)
+          (key) => LOCAL_FILE_MIME_TYPES[key].includes(file.type)
         ),
         (type) => {
           if (!type) {
-            log("An unknown file type was found ", object.type);
+            log("An unknown file type was found ", file.type);
             return "unknown";
           }
           return type;
         }
       ),
-      sizeInBytes: object.size,
-      uploadDate: options?.uploadDate === "now" ? Date.now() : options?.uploadDate ?? object.lastModified,
-      name: fileName
+      sizeInBytes: file.size,
+      uploadDate: options?.uploadDate === "now" ? Date.now() : options?.uploadDate ?? file.lastModified,
+      name: fileName,
+      _metadata
     };
   }
-}
+  localFileToFile(localFile) {
+    if ("_metadata" in localFile) {
+      return {
+        name: localFile.name,
+        size: localFile.sizeInBytes,
+        ...localFile._metadata
+      };
+    }
+    return {
+      name: localFile.name,
+      size: localFile.sizeInBytes,
+      webkitRelativePath: localFile.path,
+      lastModified: localFile.uploadDate
+    };
+  }
+  invoke(...args) {
+    if (isFile(args[0])) {
+      return this.fileToLocalFile(
+        ...args
+      );
+    }
+    if (isLocalFile(args[0])) {
+      return this.localFileToFile(
+        ...args
+      );
+    } else throw new Error(`The arguments supplied are insufficient.`);
+  }
+}().invoke;
 function classNameResolver(baseClassName) {
   return (className) => {
     return `${baseClassName}-${className}`;
@@ -968,6 +1015,7 @@ export {
   isEmpty,
   isFile,
   isLetter,
+  isLocalFile,
   isNumber,
   lastIndex,
   map,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wavy/fn",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "main": "./dist/main.js",
   "module": "./dist/main.cjs",
   "types": "./dist/main.d.ts",
@@ -22,7 +22,7 @@
   "description": "",
   "devDependencies": {
     "@types/node": "^24.5.2",
-    "@wavy/types": "^0.0.22",
+    "@wavy/types": "^0.0.25",
     "tsup": "^8.5.0",
     "typescript": "^5.9.2"
   }

package/prepend.js

@@ -11,3 +11,4 @@ import("fs").then((fs) => {
 
   handlePrepend('import "@wavy/types"');
 });
+