nuxt-file-storage 0.2.3 → 0.2.6

package/README.md

@@ -108,18 +108,20 @@ const submit = async () => {
 using Nitro Server Engine, we will make an api route that recieves the files and stores them in the folder `userFiles`
 ```ts
 export default defineEventHandler(async (event) => {
-	const { file } = await readBody<{ file: File }>(event)
+	const { files } = await readBody<{ files: File[] }>(event)
 
-	await storeFileLocally(
-		file.content, // the stringified version of the file
-		8,            // you can add a name for the file or length of Unique ID that will be automatically generated!
-		'/userFiles'  // the folder the file will be stored in
-	)
+	for ( const file of files ) {
+		await storeFileLocally(
+			file, 		  // the file object
+			8,            // you can add a name for the file or length of Unique ID that will be automatically generated!
+			'/userFiles'  // the folder the file will be stored in
+		)
 
-	// {OR}
+		// {OR}
 
-	// Parses a data URL and returns an object with the binary data and the file extension.
-	const { binaryString, ext } = parseDataUrl(file.content)
+		// Parses a data URL and returns an object with the binary data and the file extension.
+		const { binaryString, ext } = parseDataUrl(file.content)
+	}
 
 	return 'success!'
 })

package/dist/module.d.mts

@@ -2,6 +2,7 @@ import * as _nuxt_schema from '@nuxt/schema';
 
 interface ModuleOptions {
     mount: string;
+    version: string;
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 

package/dist/module.d.ts

@@ -2,6 +2,7 @@ import * as _nuxt_schema from '@nuxt/schema';
 
 interface ModuleOptions {
     mount: string;
+    version: string;
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "nuxt-file-storage",
   "configKey": "fileStorage",
-  "version": "0.2.3"
+  "version": "0.2.6"
 }

package/dist/module.mjs

@@ -1,6 +1,8 @@
-import { defineNuxtModule, createResolver, addImportsDir, addServerScanDir } from '@nuxt/kit';
+import { defineNuxtModule, logger, createResolver, addImportsDir, addServerScanDir } from '@nuxt/kit';
 import defu from 'defu';
 
+const version = "0.2.6";
+
 const module = defineNuxtModule({
   meta: {
     name: "nuxt-file-storage",
@@ -9,13 +11,25 @@ const module = defineNuxtModule({
   //? Default configuration options of the Nuxt module
   //! no defaults for now
   // defaults: {
-  // 	mount: 'userFiles',
+  // 	version: '0.0.0',
   // },
   setup(options, nuxt) {
     const config = nuxt.options.runtimeConfig;
     config.public.fileStorage = defu(config.public.fileStorage, {
       ...options
     });
+    if (nuxt.options.dev) {
+      //! I couldn't find a way to detect new updates to warn one time so it will warn every time the server runs again, if you know how to warn about a breaking change only the first run after an update feel free to open a new pull request
+      const previousVersion = config.public.fileStorage?.version;
+      if (!previousVersion || previousVersion !== version) {
+        logger.warn(
+          `There is a breaking change in the \`fileStoreLocally\` method, link to changelog:
+https://github.com/NyllRE/nuxt-file-storage/releases/tag/v${version}
+`
+        );
+        config.public.fileStorage.version = version;
+      }
+    }
     const resolve = createResolver(import.meta.url).resolve;
     addImportsDir(resolve("runtime/composables"));
     addServerScanDir(resolve("./runtime/server"));

package/dist/runtime/composables/useFileStorage.d.ts

@@ -2,6 +2,7 @@ export default function (): {
     files: import("vue").Ref<{
         content: any;
         name: string;
+        lastModified: string;
         readonly size: number;
         readonly type: string;
         arrayBuffer: () => Promise<ArrayBuffer>;

package/dist/runtime/composables/useFileStorage.mjs

@@ -6,6 +6,10 @@ export default function() {
     reader.onload = (e) => {
       files.value.push({
         ...file,
+        name: file.name,
+        size: file.size,
+        type: file.type,
+        lastModified: file.lastModified,
         content: e.target.result
       });
     };

package/dist/runtime/server/utils/storage.d.ts

@@ -1,10 +1,20 @@
 /// <reference types="node" />
 /**
- * @returns mime type
+ * #### Will store the file in the specified directory
+ * @returns file name: `${filename}`.`${fileExtension}`
+ * @prop file: provide the file object
  * @prop fileNameOrIdLength: you can pass a string or a number, if you enter a string it will be the file name, if you enter a number it will generate a unique ID
+ * @prop filelocation: provide the folder you wish to locate the file in
  */
-export declare const storeFileLocally: (dataurl: string, fileNameOrIdLength: string | number, filelocation?: string) => Promise<string>;
+export declare const storeFileLocally: (file: File, fileNameOrIdLength: string | number, filelocation?: string) => Promise<string>;
 export declare const deleteFile: (filename: string, filelocation?: string) => Promise<void>;
+interface File {
+    name: string;
+    content: string;
+    size: string;
+    type: string;
+    lastModified: string;
+}
 /**
 Parses a data URL and returns an object with the binary data and the file extension.
 @param {string} file - The data URL
@@ -14,3 +24,4 @@ export declare const parseDataUrl: (file: string) => {
     binaryString: Buffer;
     ext: string;
 };
+export {};

package/dist/runtime/server/utils/storage.mjs

@@ -1,14 +1,15 @@
 import { writeFile, rm, mkdir } from "fs/promises";
 import { useRuntimeConfig } from "#imports";
-export const storeFileLocally = async (dataurl, fileNameOrIdLength, filelocation = "") => {
-  const { binaryString, ext } = parseDataUrl(dataurl);
+export const storeFileLocally = async (file, fileNameOrIdLength, filelocation = "") => {
+  const { binaryString, ext } = parseDataUrl(file.content);
   const location = useRuntimeConfig().public.fileStorage.mount;
-  const filename = typeof fileNameOrIdLength == "number" ? generateRandomId(fileNameOrIdLength) : fileNameOrIdLength;
+  const originalExt = file.name.toString().split(".").pop() || ext;
+  const filename = typeof fileNameOrIdLength == "number" ? `${generateRandomId(fileNameOrIdLength)}.${originalExt}` : `${fileNameOrIdLength}.${originalExt}`;
   await mkdir(`${location}${filelocation}`, { recursive: true });
-  await writeFile(`${location}${filelocation}/${filename}.${ext}`, binaryString, {
+  await writeFile(`${location}${filelocation}/${filename}`, binaryString, {
     flag: "w"
   });
-  return `${filename}.${ext}`;
+  return filename;
 };
 export const deleteFile = async (filename, filelocation = "") => {
   const location = useRuntimeConfig().public.fileStorage.mount;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-file-storage",
-  "version": "0.2.3",
+  "version": "0.2.6",
   "description": "Easy solution to store files in your nuxt apps. Be able to upload files from the frontend and recieve them from the backend to then save the files in your project.",
   "repository": "NyllRE/nuxt-file-storage",
   "license": "MIT",