@arkstack/filesystem 0.16.3 → 0.16.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/filesystem",
-  "version": "0.16.3",
+  "version": "0.16.5",
   "type": "module",
   "description": "Filesystem module for Arkstack, providing shared file storage and filesystem utitlities for the framework.",
   "homepage": "https://arkstack.toneflix.net",
@@ -20,7 +20,8 @@
     "flydrive"
   ],
   "files": [
-    "dist"
+    "dist",
+    "stubs"
   ],
   "publishConfig": {
     "access": "public"
@@ -40,8 +41,8 @@
     "@aws-sdk/s3-request-presigner": "^3.1011.0",
     "flydrive": "^2.0.0",
     "ssh2-sftp-client": "^12.1.0",
-    "@arkstack/contract": "^0.16.3",
-    "@arkstack/common": "^0.16.3"
+    "@arkstack/common": "^0.16.5",
+    "@arkstack/contract": "^0.16.5"
   },
   "devDependencies": {
     "@types/ssh2-sftp-client": "^9.0.6"

package/stubs/config/filesystem.ts.stub

@@ -0,0 +1,86 @@
+import { Arkstack } from '@arkstack/contract'
+import { FilesystemConfig } from '@arkstack/filesystem'
+import path from 'node:path'
+
+export default (): FilesystemConfig => {
+    return {
+        /**
+         * Default filesystem disk to be used by the framework.
+         */
+        default: env('FILESYSTEM_DISK', 'local'),
+
+        /**
+         * Available disks and their configurations. 
+         * 
+         * You can configure as many disks as you want, and even have multiple disks 
+         * using the same driver.
+         * 
+         * Supported drivers: local, ftp, s3
+         */
+        disks: {
+            local: {
+                driver: 'local',
+                root: path.join(Arkstack.rootDir(), './storage/app'),
+                visibility: 'public',
+            },
+            public: {
+                driver: 'local',
+                root: path.join(Arkstack.rootDir(), './storage/app/public'),
+                visibility: 'public'
+            },
+            ftp: {
+                driver: 'ftp',
+                host: env('FTP_HOST'),
+                username: env('FTP_USERNAME'),
+                password: env('FTP_PASSWORD'),
+                port: env('FTP_PORT', 21),
+                verbose: env('FTP_VERBOSE', false),
+                privateKey: env('FTP_PRIVATE_KEY'),
+            },
+            s3: {
+                driver: 's3',
+                key: env('AWS_ACCESS_KEY_ID'),
+                secret: env('AWS_SECRET_ACCESS_KEY'),
+                region: env('AWS_DEFAULT_REGION'),
+                bucket: env('AWS_BUCKET'),
+                url: env('AWS_URL'),
+                endpoint: env('AWS_ENDPOINT'),
+                visibility: 'public',
+            },
+            gcs: {
+                driver: 'gcs',
+                projectId: env('GOOGLE_CLOUD_PROJECT'),
+                keyFilename: env('GOOGLE_APPLICATION_CREDENTIALS'),
+                bucket: env('GOOGLE_CLOUD_STORAGE_BUCKET'),
+                visibility: 'private',
+                usingUniformAcl: true,
+            }
+        },
+
+        /**
+         * Optional symbolic links to create when the `storage:link` command is executed.
+         * The key of the object represents the link location, while the value represents the target location.  
+         */
+        links: {
+            [path.join(Arkstack.rootDir(), './public/storage')]: path.join(Arkstack.rootDir(), './storage/app/public'),
+        },
+
+        /**
+         * Optional file name generator function. 
+         * If provided, this function will be used to generate unique file names 
+         * for uploaded files when using the `saveFile` method of the Storage class.
+         * 
+         * @param originalName  The original name of the file
+         * @returns             A unique file name
+         *
+         * fileNameGenerator: (originalName: string) => {
+         *     const timestamp = Date.now()
+         *     const randomString = Math.random().toString(36).substring(2, 8)
+         *     const extension = path.extname(originalName)
+         *     const baseName = path.basename(originalName, extension)
+         *
+         *     return `${baseName}-${timestamp}-${randomString}${extension}`
+         * },
+         */
+    }
+}