nuxt-file-storage 0.2.9 → 0.3.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024-Present Nuxt File Storage Project
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2024-Present Nuxt File Storage Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,188 +1,193 @@
-![Nuxt File Storage Banner](./playground/public/nuxt-file-storage-banner.svg)
-
-# Nuxt File Storage
-
-[![Visits Badge](https://badges.pufler.dev/visits/nyllre/nuxt-file-storage)](https://badges.pufler.dev)
-[![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![License][license-src]][license-href]
-[![Nuxt][nuxt-src]][nuxt-href]
-
-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.
-
--  [✨  Release Notes](/CHANGELOG.md)
--  [🏀 Online playground](https://stackblitz.com/github/NyllRE/nuxt-file-storage?file=playground%2Fapp.vue)
-<!-- - [📖 &nbsp;Documentation](https://example.com) -->
-
-## Features
-
-<!-- Highlight some of the features your module provide here -->
-
--  📁 &nbsp;Get files from file input and make them ready to send to backend
--  ⚗️ &nbsp;Serialize files in the backend to be able to use them appropriately
--  🖴 &nbsp;Store files in a specified location in your Nuxt backend with Nitro Engine
-
-## Quick Setup
-
-1. Add `nuxt-file-storage` dependency to your project
-
-```bash
-# Using pnpm
-pnpm add -D nuxt-file-storage
-
-# Using yarn
-yarn add --dev nuxt-file-storage
-
-# Using npm
-npm install --save-dev nuxt-file-storage
-```
-
-2. Add `nuxt-file-storage` to the `modules` section of `nuxt.config.ts`
-
-```js
-export default defineNuxtConfig({
-	modules: ['nuxt-file-storage'],
-})
-```
-
-That's it! You can now use Nuxt Storage in your Nuxt app ✨
-
-## Configuration
-
-You can currently configure a single setting of the `nuxt-file-storage` module. Here is the config interface:
-
-```js
-export default defineNuxtConfig({
-	modules: ['nuxt-file-storage'],
-	fileStorage: {
-		// enter the absolute path to the location of your storage
-		mount: '/home/$USR/development/nuxt-file-storage/server/files',
-
-		// {OR} use environment variables (recommended)
-		mount: process.env.mount
-		// you need to set the mount in your .env file at the root of your project
-	},
-})
-```
-
-## Usage
-
-### Handling Files in the frontend
-You can use Nuxt Storage to get the files from the `<input>` tag:
-
-```html
-<template>
-	<input type="file" @input="handleFileInput" />
-</template>
-
-<script setup>
-	// handleFileInput can handle multiple files
-	// clearOldFiles: true by default, each time the user adds files the `files` ref will be cleared
-	const { handleFileInput, files } = useFileStorage({ clearOldFiles: false })
-</script>
-```
-The `files` return a ref object that contains the files
-
-> `handleFileInput` returns a promise in case you need to check if the file input has concluded
-
-<br>
-
-Here's an example of using files to send them to the backend
-```html
-<template>
-	<input type="file" @input="handleFileInput" />
-	<button @click="submit">submit</button>
-</template>
-
-<script setup>
-const { handleFileInput, files } = useFileStorage()
-
-const submit = async () => {
-	const response = await $fetch('/api/files', {
-		method: 'POST',
-		body: {
-			files: files.value
-		}
-	})
-}
-</script>
-```
-<br>
-
-#### Handling multiple file input fields
-You have to create a new instance of `useFileStorage` for each input field
-
-
-```html
-<template>
-	<input type="file" @input="handleFileInput" multiple />   ← | 1 |
-	<input type="file" @input="profileInputHandler" />                 ← | 2 |
-</template>
-
-<script setup>
-	const { handleFileInput, files } = useFileStorage()       ← | 1 |
-
-	const {
-		handleFileInput: profileInputHandler,
-		files: profileImage
-	} = useFileStorage()                                               ← | 2 |
-</script>
-```
-by calling a new `useFileStorage` instance you seperate the internal logic between the inputs
-
-### Handling files in the backend
-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 { files } = await readBody<{ files: File[] }>(event)
-
-	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}
-
-		// Parses a data URL and returns an object with the binary data and the file extension.
-		const { binaryString, ext } = parseDataUrl(file.content)
-	}
-
-	return 'success!'
-})
-
-interface File {
-	name: string
-	content: string
-}
-```
-
-And that's it! Now you can store any file in your nuxt project from the user ✨
-
-## Contribution
-Run into a problem? Open a [new issue](https://github.com/NyllRE/nuxt-file-storage/issues/new). I'll try my best to include all the features requested if it is fitting to the scope of the project.
-
-Want to add some feature? PRs are welcome!
-- Clone this repository
-- install the dependencies
-- prepare the project
-- run dev server
-```bash
-git clone https://github.com/NyllRE/nuxt-file-storage && cd nuxt-file-storage
-npm i
-npm run dev:prepare
-npm run dev
-```
-
-
-<!-- Badges -->
-
-[npm-version-src]: https://img.shields.io/npm/v/nuxt-file-storage/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
-[npm-version-href]: https://npmjs.com/package/nuxt-file-storage
-[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-file-storage.svg?style=flat&colorA=18181B&colorB=28CF8D
-[npm-downloads-href]: https://npmjs.com/package/nuxt-file-storage
-[license-src]: https://img.shields.io/npm/l/nuxt-file-storage.svg?style=flat&colorA=18181B&colorB=28CF8D
-[license-href]: https://npmjs.com/package/nuxt-file-storage
-[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
-[nuxt-href]: https://nuxt.com/modules/nuxt-file-storage
+![Nuxt File Storage Banner](./playground/public/nuxt-file-storage-banner.svg)
+
+# Nuxt File Storage
+
+[![Visits Badge](https://badges.pufler.dev/visits/nyllre/nuxt-file-storage)](https://badges.pufler.dev)
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+Easy solution to store files in your nuxt apps. Be able to upload files from the frontend and receive them from the backend to then save the files in your project.
+
+-  [✨ &nbsp;Release Notes](/CHANGELOG.md)
+-  [🏀 Online playground](https://stackblitz.com/github/NyllRE/nuxt-file-storage?file=playground%2Fapp.vue)
+<!-- - [📖 &nbsp;Documentation](https://example.com) -->
+
+## Features
+
+<!-- Highlight some of the features your module provide here -->
+
+-  📁 &nbsp;Get files from file input and make them ready to send to backend
+-  ⚗️ &nbsp;Serialize files in the backend to be able to use them appropriately
+-  🖴 &nbsp;Store files in a specified location in your Nuxt backend with Nitro Engine
+
+## Quick Setup
+
+1. Add `nuxt-file-storage` dependency to your project
+
+```bash
+# Using pnpm
+pnpm add -D nuxt-file-storage
+
+# Using yarn
+yarn add --dev nuxt-file-storage
+
+# Using npm
+npm install --save-dev nuxt-file-storage
+```
+
+2. Add `nuxt-file-storage` to the `modules` section of `nuxt.config.ts`
+
+```js
+export default defineNuxtConfig({
+	modules: ['nuxt-file-storage'],
+})
+```
+
+That's it! You can now use Nuxt Storage in your Nuxt app ✨
+
+## Configuration
+
+You can currently configure a single setting of the `nuxt-file-storage` module. Here is the config interface:
+
+```js
+export default defineNuxtConfig({
+	modules: ['nuxt-file-storage'],
+	fileStorage: {
+		// enter the absolute path to the location of your storage
+		mount: '/home/$USR/development/nuxt-file-storage/server/files',
+
+		// {OR} use environment variables (recommended)
+		mount: process.env.mount
+		// you need to set the mount in your .env file at the root of your project
+	},
+})
+```
+
+## Usage
+
+### Handling Files in the frontend
+You can use Nuxt Storage to get the files from the `<input>` tag:
+
+```html
+<template>
+	<input type="file" @input="handleFileInput" />
+</template>
+
+<script setup>
+	// handleFileInput can handle multiple files
+	// clearOldFiles: true by default, each time the user adds files the `files` ref will be cleared
+	const { handleFileInput, files } = useFileStorage({ clearOldFiles: false })
+</script>
+```
+The `files` return a ref object that contains the files
+
+> `handleFileInput` returns a promise in case you need to check if the file input has concluded
+
+<br>
+
+Here's an example of using files to send them to the backend
+```html
+<template>
+	<input type="file" @input="handleFileInput" />
+	<button @click="submit">submit</button>
+</template>
+
+<script setup>
+const { handleFileInput, files } = useFileStorage()
+
+const submit = async () => {
+	const response = await $fetch('/api/files', {
+		method: 'POST',
+		body: {
+			files: files.value
+		}
+	})
+}
+</script>
+```
+<br>
+
+#### Handling multiple file input fields
+You have to create a new instance of `useFileStorage` for each input field
+
+
+```html
+<template>
+	<input type="file" @input="handleFileInput" multiple />   ← | 1 |
+	<input type="file" @input="profileInputHandler" />                 ← | 2 |
+</template>
+
+<script setup>
+	const { handleFileInput, files } = useFileStorage()       ← | 1 |
+
+	const {
+		handleFileInput: profileInputHandler,
+		files: profileImage
+	} = useFileStorage()                                               ← | 2 |
+</script>
+```
+by calling a new `useFileStorage` instance you separate the internal logic between the inputs
+
+### Handling files in the backend
+using Nitro Server Engine, we will make an api route that receives the files and stores them in the folder `userFiles`
+```ts
+import { ServerFile } from "nuxt-file-storage";
+
+export default defineEventHandler(async (event) => {
+	const { files } = await readBody<{ files: ServerFile[] }>(event)
+
+	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}
+
+		// Parses a data URL and returns an object with the binary data and the file extension.
+		const { binaryString, ext } = parseDataUrl(file.content)
+	}
+
+	// Deleting Files
+	await deleteFile('requiredFile.txt', '/userFiles')
+
+	// Get file path
+	await getFileLocally('requiredFile.txt', '/userFiles')
+	// returns: {AbsolutePath}/userFiles/requiredFile.txt
+
+	// Get all files in a folder
+	await getFilesLocally('/userFiles')
+})
+```
+
+And that's it! Now you can store any file in your nuxt project from the user ✨
+
+## Contribution
+Run into a problem? Open a [new issue](https://github.com/NyllRE/nuxt-file-storage/issues/new). I'll try my best to include all the features requested if it is fitting to the scope of the project.
+
+Want to add some feature? PRs are welcome!
+- Clone this repository
+- install the dependencies
+- prepare the project
+- run dev server
+```bash
+git clone https://github.com/NyllRE/nuxt-file-storage && cd nuxt-file-storage
+npm i
+npm run dev:prepare
+npm run dev
+```
+
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/nuxt-file-storage/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/nuxt-file-storage
+[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-file-storage.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npmjs.com/package/nuxt-file-storage
+[license-src]: https://img.shields.io/npm/l/nuxt-file-storage.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://npmjs.com/package/nuxt-file-storage
+[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
+[nuxt-href]: https://nuxt.com/modules/nuxt-file-storage

package/dist/module.d.mts

@@ -1,24 +1,24 @@
 import * as _nuxt_schema from '@nuxt/schema';
 
-interface ServerFile {
-	name: string
-	content: string
-	size: string
-	type: string
-	lastModified: string
+interface ServerFile {
+	name: string
+	content: string
+	size: string
+	type: string
+	lastModified: string
+}
+
+interface ClientFile extends Blob {
+	content: string | ArrayBuffer | null | undefined
+	name: string
+	lastModified: number
+}
+
+interface ModuleOptions {
+	mount: string
+	version: string
 }
 
-interface ClientFile extends Blob {
-	content: string | ArrayBuffer | null | undefined
-	name: string
-	lastModified: number
-}
-
-interface ModuleOptions {
-	mount: string
-	version: string
-}
-
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
 export { type ClientFile, type ModuleOptions, type ServerFile, _default as default };

package/dist/module.d.ts

@@ -1,24 +1,24 @@
 import * as _nuxt_schema from '@nuxt/schema';
 
-interface ServerFile {
-	name: string
-	content: string
-	size: string
-	type: string
-	lastModified: string
+interface ServerFile {
+	name: string
+	content: string
+	size: string
+	type: string
+	lastModified: string
+}
+
+interface ClientFile extends Blob {
+	content: string | ArrayBuffer | null | undefined
+	name: string
+	lastModified: number
+}
+
+interface ModuleOptions {
+	mount: string
+	version: string
 }
 
-interface ClientFile extends Blob {
-	content: string | ArrayBuffer | null | undefined
-	name: string
-	lastModified: number
-}
-
-interface ModuleOptions {
-	mount: string
-	version: string
-}
-
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
 export { type ClientFile, type ModuleOptions, type ServerFile, _default as default };

package/dist/module.json

@@ -1,5 +1,9 @@
 {
   "name": "nuxt-file-storage",
   "configKey": "fileStorage",
-  "version": "0.2.9"
+  "version": "0.3.0",
+  "builder": {
+    "@nuxt/module-builder": "0.8.4",
+    "unbuild": "2.0.0"
+  }
 }

package/dist/module.mjs

@@ -1,8 +1,6 @@
 import { defineNuxtModule, logger, createResolver, addImportsDir, addServerScanDir } from '@nuxt/kit';
 import defu from 'defu';
 
-const version = "0.2.9";
-
 const module = defineNuxtModule({
   meta: {
     name: "nuxt-file-storage",
@@ -18,17 +16,14 @@ const module = defineNuxtModule({
     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 \`storeFileLocally\` method, link to changelog:
-https://github.com/NyllRE/nuxt-file-storage/releases/tag/v${version}
-`
-        );
-        config.public.fileStorage.version = version;
-      }
+    if (!config.public.fileStorage.mount) {
+      logger.error(
+        "Please provide a mount path for the file storage module in your nuxt.config.js"
+      );
+    } else {
+      logger.ready(
+        `Nuxt File Storage has mounted successfully`
+      );
     }
     const resolve = createResolver(import.meta.url).resolve;
     addImportsDir(resolve("runtime/composables"));

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

@@ -1,3 +1,4 @@
+import type { ClientFile } from '../../types.js';
 type Options = {
     clearOldFiles: boolean;
 };
@@ -16,7 +17,22 @@ export default function (options?: Options): {
         slice: (start?: number | undefined, end?: number | undefined, contentType?: string | undefined) => Blob;
         stream: () => ReadableStream<Uint8Array>;
         text: () => Promise<string>;
+    }[], ClientFile[] | {
+        content: string | {
+            readonly byteLength: number;
+            slice: (begin: number, end?: number | undefined) => ArrayBuffer;
+            readonly [Symbol.toStringTag]: string;
+        } | null | undefined;
+        name: string;
+        lastModified: number;
+        readonly size: number;
+        readonly type: string;
+        arrayBuffer: () => Promise<ArrayBuffer>;
+        slice: (start?: number | undefined, end?: number | undefined, contentType?: string | undefined) => Blob;
+        stream: () => ReadableStream<Uint8Array>;
+        text: () => Promise<string>;
     }[]>;
     handleFileInput: (event: any) => Promise<void>;
+    clearFiles: () => void;
 };
 export {};

package/dist/runtime/composables/{useFileStorage.mjs → useFileStorage.js}

@@ -21,9 +21,12 @@ export default function(options = { clearOldFiles: true }) {
       reader.readAsDataURL(file);
     });
   };
+  const clearFiles = () => {
+    files.value.splice(0, files.value.length);
+  };
   const handleFileInput = async (event) => {
     if (options.clearOldFiles) {
-      files.value.splice(0, files.value.length);
+      clearFiles();
     }
     const promises = [];
     for (const file of event.target.files) {
@@ -33,6 +36,7 @@ export default function(options = { clearOldFiles: true }) {
   };
   return {
     files,
-    handleFileInput
+    handleFileInput,
+    clearFiles
   };
 }

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

@@ -1,23 +1,58 @@
 /// <reference types="node" />
-import type { ServerFile } from '../../../types';
+/// <reference types="node" />
+import type { ServerFile } from '../../../types.js';
 /**
- * #### Will store the file in the specified directory
+ * @description Will store the file in the specified directory
+ * @param file provide the file object
+ * @param 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
+ * @param filelocation provide the folder you wish to locate the file in
  * @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
+ *
+ *
+ * [Documentation](https://github.com/NyllRE/nuxt-file-storage#handling-files-in-the-backend)
+ *
+ *
+ * @example
+ * ```ts
+ * import { ServerFile } from "nuxt-file-storage";
+ *
+ * const { file } = await readBody<{ files: ServerFile }>(event)
+
+ * await storeFileLocally( file, 8, '/userFiles' )
+ * ```
  */
 export declare const storeFileLocally: (file: ServerFile, fileNameOrIdLength: string | number, filelocation?: string) => Promise<string>;
 /**
- *
- * @param `filename`: the name of the file you want to delete
- * @param `filelocation`: the folder where the file is located, if it is in the root folder you can leave it empty, if it is in a subfolder you can pass the name of the subfolder with a preceding slash: `/subfolder`
+ * @description Get file path in the specified directory
+ * @param filename provide the file name (return of storeFileLocally)
+ * @param filelocation provide the folder you wish to locate the file in
+ * @returns file path: `${config.fileStorage.mount}/${filelocation}/${filename}`
+ */
+export declare const getFileLocally: (filename: string, filelocation?: string) => string;
+/**
+ * @description Get all files in the specified directory
+ * @param filelocation provide the folder you wish to locate the file in
+ * @returns all files in filelocation: `${config.fileStorage.mount}/${filelocation}`
+ */
+export declare const getFilesLocally: (filelocation?: string) => Promise<string[]>;
+/**
+ * @param filename the name of the file you want to delete
+ * @param filelocation the folder where the file is located, if it is in the root folder you can leave it empty, if it is in a subfolder you can pass the name of the subfolder with a preceding slash: `/subfolder`
+ * @example
+ * ```ts
+ * await deleteFile('/userFiles', 'requiredFile.txt')
+ * ```
  */
 export declare const deleteFile: (filename: string, filelocation?: string) => Promise<void>;
 /**
-Parses a data URL and returns an object with the binary data and the file extension.
-@param {string} file - The data URL
-@returns {{ binaryString: Buffer, ext: string }} - An object with the binary data and the file extension
+ * @description Parses a data URL and returns an object with the binary data and the file extension.
+ * @param {string} file - The data URL
+ * @returns {{binaryString: Buffer, ext: string}} An object with the binary data - file extension
+ *
+ * @example
+ * ```ts
+ *   const { binaryString, ext } = parseDataUrl(file.content)
+ * ```
  */
 export declare const parseDataUrl: (file: string) => {
     binaryString: Buffer;

package/dist/runtime/server/utils/{storage.mjs → storage.js}

@@ -1,19 +1,31 @@
-import { writeFile, rm, mkdir } from "fs/promises";
+import { writeFile, rm, mkdir, readdir } from "fs/promises";
 import { useRuntimeConfig } from "#imports";
+import { join } from "path";
 export const storeFileLocally = async (file, fileNameOrIdLength, filelocation = "") => {
   const { binaryString, ext } = parseDataUrl(file.content);
   const location = useRuntimeConfig().public.fileStorage.mount;
   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}`, binaryString, {
+  await mkdir(join(location, filelocation), { recursive: true });
+  await writeFile(join(location, filelocation, filename), binaryString, {
     flag: "w"
   });
   return filename;
 };
+export const getFileLocally = (filename, filelocation = "") => {
+  const location = useRuntimeConfig().public.fileStorage.mount;
+  const normalizedFilelocation = filelocation.startsWith("/") ? filelocation.slice(1) : filelocation;
+  return join(location, normalizedFilelocation, filename);
+};
+export const getFilesLocally = async (filelocation = "") => {
+  const location = useRuntimeConfig().public.fileStorage.mount;
+  const normalizedFilelocation = filelocation.startsWith("/") ? filelocation.slice(1) : filelocation;
+  return await readdir(join(location, normalizedFilelocation)).catch(() => []);
+};
 export const deleteFile = async (filename, filelocation = "") => {
   const location = useRuntimeConfig().public.fileStorage.mount;
-  await rm(`${location}${filelocation}/${filename}`);
+  const normalizedFilelocation = filelocation.startsWith("/") ? filelocation.slice(1) : filelocation;
+  await rm(join(location, normalizedFilelocation, filename));
 };
 const generateRandomId = (length) => {
   const characters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";

package/dist/types.d.mts

@@ -1,16 +1 @@
-
-import type { ModuleOptions } from './module.js'
-
-
-declare module '@nuxt/schema' {
-  interface NuxtConfig { ['fileStorage']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['fileStorage']?: ModuleOptions }
-}
-
-declare module 'nuxt/schema' {
-  interface NuxtConfig { ['fileStorage']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['fileStorage']?: ModuleOptions }
-}
-
-
-export type { ClientFile, ModuleOptions, ServerFile, default } from './module.js'
+export { type ClientFile, type ModuleOptions, type ServerFile, default } from './module.js'

package/dist/types.d.ts

@@ -1,16 +1 @@
-
-import type { ModuleOptions } from './module'
-
-
-declare module '@nuxt/schema' {
-  interface NuxtConfig { ['fileStorage']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['fileStorage']?: ModuleOptions }
-}
-
-declare module 'nuxt/schema' {
-  interface NuxtConfig { ['fileStorage']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['fileStorage']?: ModuleOptions }
-}
-
-
-export type { ClientFile, ModuleOptions, ServerFile, default } from './module'
+export { type ClientFile, type ModuleOptions, type ServerFile, default } from './module'

package/package.json

@@ -1,46 +1,46 @@
 {
-  "name": "nuxt-file-storage",
-  "version": "0.2.9",
-  "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",
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./dist/types.d.ts",
-      "import": "./dist/module.mjs",
-      "require": "./dist/module.cjs"
-    }
-  },
-  "main": "./dist/module.cjs",
-  "types": "./dist/types.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "prepack": "nuxt-module-build build",
-    "dev": "nuxi dev playground",
-    "dev:build": "nuxi build playground",
-    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
-    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
-    "lint": "eslint .",
-    "test": "vitest run",
-    "test:watch": "vitest watch"
-  },
-  "dependencies": {
-    "@nuxt/kit": "^3.9.3",
-    "defu": "^6.1.4"
-  },
-  "devDependencies": {
-    "@nuxt/devtools": "latest",
-    "@nuxt/eslint-config": "^0.2.0",
-    "@nuxt/module-builder": "^0.8.3",
-    "@nuxt/schema": "^3.9.3",
-    "@nuxt/test-utils": "^3.9.0",
-    "@types/node": "^20.11.5",
-    "changelogen": "^0.5.5",
-    "eslint": "^8.56.0",
-    "nuxt": "^3.9.3",
-    "vitest": "^1.0.0"
-  }
-}
+	"name": "nuxt-file-storage",
+	"version": "0.3.0",
+	"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",
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./dist/types.d.ts",
+			"import": "./dist/module.mjs",
+			"require": "./dist/module.cjs"
+		}
+	},
+	"main": "./dist/module.cjs",
+	"types": "./dist/types.d.ts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"prepack": "nuxt-module-build build",
+		"dev": "nuxi dev playground",
+		"dev:build": "nuxi build playground",
+		"dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+		"release": "npm run lint && npm run prepack && changelogen && npm publish && git push --follow-tags",
+		"lint": "eslint .",
+		"test": "vitest run",
+		"test:watch": "vitest watch"
+	},
+	"dependencies": {
+		"@nuxt/kit": "^3.15.4",
+		"defu": "^6.1.4"
+	},
+	"devDependencies": {
+		"@nuxt/devtools": "latest",
+		"@nuxt/eslint-config": "^0.2.0",
+		"@nuxt/module-builder": "^0.8.4",
+		"@nuxt/schema": "^3.15.4",
+		"@nuxt/test-utils": "^3.17.0",
+		"@types/node": "^20.17.19",
+		"changelogen": "^0.5.7",
+		"eslint": "^8.57.1",
+		"nuxt": "^3.15.4",
+		"vitest": "^1.6.1"
+	}
+}