chore: wip

Author: glennmichael123

storage/framework/core/storage/src/drivers/aws.ts

@@ -1,5 +1,6 @@
 import type { ChecksumOptions, DirectoryListing, FileContents, MimeTypeOptions, PublicUrlOptions, StatEntry, TemporaryUrlOptions } from '@flystorage/file-storage'
 import type { StorageDriver } from '@stacksjs/types'
+import type { Buffer } from 'node:buffer'
 import { S3Client } from '@aws-sdk/client-s3'
 import { AwsS3StorageAdapter } from '@flystorage/aws-s3'
 import { FileStorage } from '@flystorage/file-storage'
@@ -12,77 +13,92 @@ const adapter = new AwsS3StorageAdapter(client, {
 
 export const awsStorage: FileStorage = new FileStorage(adapter)
 
-export const local: StorageDriver = {
+export const aws: StorageDriver = {
   async write(path: string, contents: FileContents): Promise<void> {
-    await localStorage.write(path, contents)
+    await awsStorage.write(path, contents)
   },
 
   async deleteFile(path: string): Promise<void> {
-    await localStorage.deleteFile(path)
+    await awsStorage.deleteFile(path)
   },
 
   async createDirectory(path: string): Promise<void> {
-    await localStorage.createDirectory(path)
+    await awsStorage.createDirectory(path)
   },
 
   async moveFile(from: string, to: string): Promise<void> {
-    await localStorage.moveFile(from, to)
+    await awsStorage.moveFile(from, to)
   },
 
   async copyFile(from: string, to: string): Promise<void> {
-    await localStorage.copyFile(from, to)
+    await awsStorage.copyFile(from, to)
   },
 
   async stat(path: string): Promise<StatEntry> {
-    return await localStorage.stat(path)
+    return await awsStorage.stat(path)
   },
 
   list(path: string, options: { deep: boolean }): DirectoryListing {
-    return localStorage.list(path, options)
+    return awsStorage.list(path, options)
   },
 
   async changeVisibility(path: string, visibility: string): Promise<void> {
-    await localStorage.changeVisibility(path, visibility)
+    await awsStorage.changeVisibility(path, visibility)
   },
 
   async visibility(path: string): Promise<string> {
-    return await localStorage.visibility(path)
+    return await awsStorage.visibility(path)
   },
 
   async fileExists(path: string): Promise<boolean> {
-    return await localStorage.fileExists(path)
+    return await awsStorage.fileExists(path)
   },
 
   async directoryExists(path: string): Promise<boolean> {
-    return await localStorage.directoryExists(path)
+    return await awsStorage.directoryExists(path)
   },
 
   async publicUrl(path: string, options: PublicUrlOptions): Promise<string> {
-    return await localStorage.publicUrl(path, options)
+    return await awsStorage.publicUrl(path, options)
   },
 
   async temporaryUrl(path: string, options: TemporaryUrlOptions): Promise<string> {
-    return await localStorage.temporaryUrl(path, options)
+    return await awsStorage.temporaryUrl(path, options)
   },
 
   async checksum(path: string, options: ChecksumOptions): Promise<string> {
-    return await localStorage.checksum(path, options)
+    return await awsStorage.checksum(path, options)
   },
 
   async mimeType(path: string, options: MimeTypeOptions): Promise<string> {
-    return await localStorage.mimeType(path, options)
+    return await awsStorage.mimeType(path, options)
   },
 
   async lastModified(path: string): Promise<number> {
-    return await localStorage.lastModified(path)
+    return await awsStorage.lastModified(path)
   },
 
   async fileSize(path: string): Promise<number> {
-    return await localStorage.fileSize(path)
+    return await awsStorage.fileSize(path)
   },
 
   async read(path: string): Promise<FileContents> {
-    const contents = await localStorage.read(path)
+    const contents = await awsStorage.read(path)
+
+    return contents
+  },
+  async readToString(path: string): Promise<string> {
+    const contents = await localStorage.readToString(path)
+
+    return contents
+  },
+  async readToBuffer(path: string): Promise<Buffer> {
+    const contents = await localStorage.readToBuffer(path)
+
+    return contents
+  },
+  async readToUint8Array(path: string): Promise<Uint8Array> {
+    const contents = await localStorage.readToUint8Array(path)
 
     return contents
   },

storage/framework/core/storage/src/drivers/index.ts

@@ -1,3 +1,3 @@
-export * as aws from './aws'
-export * as local from './local'
-export * as memory from './memory'
+export * from './aws'
+export * from './local'
+export * from './memory'

storage/framework/core/storage/src/drivers/local.ts

@@ -1,13 +1,14 @@
 import type { ChecksumOptions, DirectoryListing, FileContents, MimeTypeOptions, PublicUrlOptions, StatEntry, TemporaryUrlOptions } from '@flystorage/file-storage'
 import type { StorageDriver } from '@stacksjs/types'
 
+import type { Buffer } from 'node:buffer'
 import { resolve } from 'node:path'
 
 import process from 'node:process'
 import { FileStorage } from '@flystorage/file-storage'
 import { LocalStorageAdapter } from '@flystorage/local-fs'
 
-const rootDirectory = resolve(process.cwd(), 'my-files')
+const rootDirectory = resolve(process.cwd())
 const adapter = new LocalStorageAdapter(rootDirectory)
 
 export const localStorage: FileStorage = new FileStorage(adapter)
@@ -86,4 +87,20 @@ export const local: StorageDriver = {
 
     return contents
   },
+
+  async readToString(path: string): Promise<string> {
+    const contents = await localStorage.readToString(path)
+
+    return contents
+  },
+  async readToBuffer(path: string): Promise<Buffer> {
+    const contents = await localStorage.readToBuffer(path)
+
+    return contents
+  },
+  async readToUint8Array(path: string): Promise<Uint8Array> {
+    const contents = await localStorage.readToUint8Array(path)
+
+    return contents
+  },
 }

storage/framework/core/storage/src/drivers/memory.ts

@@ -2,6 +2,8 @@ import type { ChecksumOptions, DirectoryListing, FileContents, MimeTypeOptions,
 
 import type { StorageDriver } from '@stacksjs/types'
 
+import type { Buffer } from 'node:buffer'
+
 import { FileStorage } from '@flystorage/file-storage'
 import { InMemoryStorageAdapter } from '@flystorage/in-memory'
 
@@ -81,6 +83,21 @@ export const memory: StorageDriver = {
   async read(path: string): Promise<FileContents> {
     const contents = await localStorage.read(path)
 
+    return contents
+  },
+  async readToString(path: string): Promise<string> {
+    const contents = await localStorage.readToString(path)
+
+    return contents
+  },
+  async readToBuffer(path: string): Promise<Buffer> {
+    const contents = await localStorage.readToBuffer(path)
+
+    return contents
+  },
+  async readToUint8Array(path: string): Promise<Uint8Array> {
+    const contents = await localStorage.readToUint8Array(path)
+
     return contents
   },
 }

storage/framework/core/storage/tests/dirs/sample.txt

@@ -0,0 +1 @@
+test

storage/framework/core/storage/tests/localStorage.test.ts

@@ -1,2 +1,10 @@
 import { describe, expect, it, jest } from 'bun:test'
 import { local } from '../src/drivers'
+
+describe('@stacksjs/storage', () => {
+  it('should read the file', async () => {
+    const contents = await local.readToString('./dirs/sample.txt')
+
+    console.log(contents)
+  })
+})

storage/framework/core/types/src/storage.ts

@@ -1,4 +1,5 @@
 import type { ChecksumOptions, DirectoryListing, FileContents, MimeTypeOptions, PublicUrlOptions, StatEntry, TemporaryUrlOptions } from '@flystorage/file-storage'
+import type { Buffer } from 'node:buffer'
 
 export interface StorageOptions {
   /**
@@ -27,6 +28,9 @@ export interface StorageDriver {
   lastModified: (path: string) => Promise<number>
   fileSize: (path: string) => Promise<number>
   read: (path: string) => Promise<FileContents>
+  readToString: (path: string) => Promise<string>
+  readToBuffer: (path: string) => Promise<Buffer>
+  readToUint8Array: (path: string) => Promise<Uint8Array>
   deleteFile: (path: string) => Promise<void>
   copyFile: (from: string, to: string) => Promise<void>
   moveFile: (from: string, to: string) => Promise<void>