@adminforth/upload 2.9.0 → 2.11.0

package/build.log

@@ -11,5 +11,5 @@ custom/preview.vue
 custom/tsconfig.json
 custom/uploader.vue
 
-sent 53,885 bytes  received 134 bytes  108,038.00 bytes/sec
+sent 53,878 bytes  received 134 bytes  108,024.00 bytes/sec
 total size is 53,396  speedup is 0.99

package/dist/index.js

@@ -7,9 +7,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { AdminForthPlugin, Filters, suggestIfTypo } from "adminforth";
+import { AdminForthPlugin, Filters, suggestIfTypo, RateLimiter } from "adminforth";
 import { Readable } from "stream";
-import { RateLimiter } from "adminforth";
 import { randomUUID } from "crypto";
 import { interpretResource } from 'adminforth';
 import { ActionCheckSource } from 'adminforth';
@@ -483,4 +482,104 @@ export default class UploadPlugin extends AdminForthPlugin {
             }),
         });
     }
+    /*
+     * Uploads a file from a buffer, creates a record in the resource, and returns the file path and preview URL.
+     */
+    uploadFromBuffer(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ filename, contentType, buffer, adminUser, extra, recordAttributes, }) {
+            var _b;
+            if (!filename || !contentType || !buffer) {
+                throw new Error('filename, contentType and buffer are required');
+            }
+            const lastDotIndex = filename.lastIndexOf('.');
+            if (lastDotIndex === -1) {
+                throw new Error('filename must contain an extension');
+            }
+            const originalExtension = filename.substring(lastDotIndex + 1).toLowerCase();
+            const originalFilename = filename.substring(0, lastDotIndex);
+            if (this.options.allowedFileExtensions && !this.options.allowedFileExtensions.includes(originalExtension)) {
+                throw new Error(`File extension "${originalExtension}" is not allowed, allowed extensions are: ${this.options.allowedFileExtensions.join(', ')}`);
+            }
+            let nodeBuffer;
+            if (Buffer.isBuffer(buffer)) {
+                nodeBuffer = buffer;
+            }
+            else if (buffer instanceof ArrayBuffer) {
+                nodeBuffer = Buffer.from(buffer);
+            }
+            else if (ArrayBuffer.isView(buffer)) {
+                nodeBuffer = Buffer.from(buffer.buffer, buffer.byteOffset, buffer.byteLength);
+            }
+            else {
+                throw new Error('Unsupported buffer type');
+            }
+            const size = nodeBuffer.byteLength;
+            if (this.options.maxFileSize && size > this.options.maxFileSize) {
+                throw new Error(`File size ${size} is too large. Maximum allowed size is ${this.options.maxFileSize}`);
+            }
+            const filePath = this.options.filePath({
+                originalFilename,
+                originalExtension,
+                contentType,
+                record: undefined,
+            });
+            if (filePath.startsWith('/')) {
+                throw new Error('s3Path should not start with /, please adjust s3path function to not return / at the start of the path');
+            }
+            const { uploadUrl, uploadExtraParams } = yield this.options.storageAdapter.getUploadSignedUrl(filePath, contentType, 1800);
+            const headers = {
+                'Content-Type': contentType,
+            };
+            if (uploadExtraParams) {
+                Object.entries(uploadExtraParams).forEach(([key, value]) => {
+                    headers[key] = value;
+                });
+            }
+            const resp = yield fetch(uploadUrl, {
+                method: 'PUT',
+                headers,
+                body: nodeBuffer,
+            });
+            if (!resp.ok) {
+                let bodyText = '';
+                try {
+                    bodyText = yield resp.text();
+                }
+                catch (e) {
+                    // ignore
+                }
+                throw new Error(`Upload failed with status ${resp.status}: ${bodyText}`);
+            }
+            yield this.markKeyForNotDeletion(filePath);
+            if (!this.resourceConfig) {
+                throw new Error('resourceConfig is not initialized yet');
+            }
+            const { error: createError } = yield this.adminforth.createResourceRecord({
+                resource: this.resourceConfig,
+                record: Object.assign(Object.assign({}, (recordAttributes !== null && recordAttributes !== void 0 ? recordAttributes : {})), { [this.options.pathColumnName]: filePath }),
+                adminUser,
+                extra,
+            });
+            if (createError) {
+                try {
+                    yield this.markKeyForDeletion(filePath);
+                }
+                catch (e) {
+                    // best-effort cleanup, ignore error
+                }
+                throw new Error(`Error creating record after upload: ${createError}`);
+            }
+            let previewUrl;
+            if ((_b = this.options.preview) === null || _b === void 0 ? void 0 : _b.previewUrl) {
+                previewUrl = this.options.preview.previewUrl({ filePath });
+            }
+            else {
+                previewUrl = yield this.options.storageAdapter.getDownloadUrl(filePath, 1800);
+            }
+            return {
+                path: filePath,
+                previewUrl,
+            };
+        });
+    }
 }

package/index.ts

@@ -1,8 +1,7 @@
 
-import { PluginOptions } from './types.js';
-import { AdminForthPlugin, AdminForthResourceColumn, AdminForthResource, Filters, IAdminForth, IHttpServer, suggestIfTypo } from "adminforth";
+import { PluginOptions, UploadFromBufferParams } from './types.js';
+import { AdminForthPlugin, AdminForthResourceColumn, AdminForthResource, Filters, IAdminForth, IHttpServer, suggestIfTypo, RateLimiter, AdminUser, HttpExtra } from "adminforth";
 import { Readable } from "stream";
-import { RateLimiter } from "adminforth";
 import { randomUUID } from "crypto";
 import { interpretResource } from 'adminforth';
 import { ActionCheckSource } from 'adminforth'; 
@@ -555,4 +554,127 @@ export default class UploadPlugin extends AdminForthPlugin {
   }
   
 
+  /*
+   * Uploads a file from a buffer, creates a record in the resource, and returns the file path and preview URL.
+   */
+  async uploadFromBuffer({
+    filename,
+    contentType,
+    buffer,
+    adminUser,
+    extra,
+    recordAttributes,
+  }: UploadFromBufferParams): Promise<{ path: string; previewUrl: string }> {
+    if (!filename || !contentType || !buffer) {
+      throw new Error('filename, contentType and buffer are required');
+    }
+
+    const lastDotIndex = filename.lastIndexOf('.');
+    if (lastDotIndex === -1) {
+      throw new Error('filename must contain an extension');
+    }
+
+    const originalExtension = filename.substring(lastDotIndex + 1).toLowerCase();
+    const originalFilename = filename.substring(0, lastDotIndex);
+
+    if (this.options.allowedFileExtensions && !this.options.allowedFileExtensions.includes(originalExtension)) {
+      throw new Error(
+        `File extension "${originalExtension}" is not allowed, allowed extensions are: ${this.options.allowedFileExtensions.join(', ')}`
+      );
+    }
+
+    let nodeBuffer: Buffer;
+    if (Buffer.isBuffer(buffer)) {
+      nodeBuffer = buffer;
+    } else if (buffer instanceof ArrayBuffer) {
+      nodeBuffer = Buffer.from(buffer);
+    } else if (ArrayBuffer.isView(buffer)) {
+      nodeBuffer = Buffer.from(buffer.buffer, buffer.byteOffset, buffer.byteLength);
+    } else {
+      throw new Error('Unsupported buffer type');
+    }
+
+    const size = nodeBuffer.byteLength;
+    if (this.options.maxFileSize && size > this.options.maxFileSize) {
+      throw new Error(
+        `File size ${size} is too large. Maximum allowed size is ${this.options.maxFileSize}`
+      );
+    }
+    const filePath: string = this.options.filePath({
+      originalFilename,
+      originalExtension,
+      contentType,
+      record: undefined,
+    });
+
+    if (filePath.startsWith('/')) {
+      throw new Error('s3Path should not start with /, please adjust s3path function to not return / at the start of the path');
+    }
+
+    const { uploadUrl, uploadExtraParams } = await this.options.storageAdapter.getUploadSignedUrl(
+      filePath,
+      contentType,
+      1800,
+    );
+
+    const headers: Record<string, string> = {
+      'Content-Type': contentType,
+    };
+    if (uploadExtraParams) {
+      Object.entries(uploadExtraParams).forEach(([key, value]) => {
+        headers[key] = value as string;
+      });
+    }
+
+    const resp = await fetch(uploadUrl as any, {
+      method: 'PUT',
+      headers,
+      body: nodeBuffer as any,
+    });
+
+    if (!resp.ok) {
+      let bodyText = '';
+      try {
+        bodyText = await resp.text();
+      } catch (e) {
+        // ignore
+      }
+      throw new Error(`Upload failed with status ${resp.status}: ${bodyText}`);
+    }
+
+    await this.markKeyForNotDeletion(filePath);
+
+    if (!this.resourceConfig) {
+      throw new Error('resourceConfig is not initialized yet');
+    }
+
+    const { error: createError } = await this.adminforth.createResourceRecord({
+      resource: this.resourceConfig,
+      record: { ...(recordAttributes ?? {}), [this.options.pathColumnName]: filePath },
+      adminUser,
+      extra,
+    });
+
+    if (createError) {
+      try {
+        await this.markKeyForDeletion(filePath);
+      } catch (e) {
+        // best-effort cleanup, ignore error
+      }
+      throw new Error(`Error creating record after upload: ${createError}`);
+    }
+
+    let previewUrl: string;
+    if (this.options.preview?.previewUrl) {
+      previewUrl = this.options.preview.previewUrl({ filePath });
+    } else {
+      previewUrl = await this.options.storageAdapter.getDownloadUrl(filePath, 1800);
+    }
+
+    return {
+      path: filePath,
+      previewUrl,
+    };
+  }
+
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/upload",
-  "version": "2.9.0",
+  "version": "2.11.0",
   "description": "Plugin for uploading files for adminforth",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/types.ts

@@ -1,4 +1,4 @@
-import { AdminUser, ImageGenerationAdapter, StorageAdapter } from "adminforth";
+import { AdminUser, ImageGenerationAdapter, StorageAdapter, HttpExtra } from "adminforth";
 
 export type PluginOptions = {
 
@@ -154,4 +154,49 @@ export type PluginOptions = {
    * For now only S3 adapter is supported.
    */
   storageAdapter: StorageAdapter,
-}
+}
+
+/**
+ * Parameters for the UploadPlugin.uploadFromBuffer API.
+ * Used to upload a binary file buffer, create a record in the resource,
+ * and return the stored path and preview URL.
+ */
+export type UploadFromBufferParams = {
+  /**
+   * Original file name including extension, used to derive storage path
+   * and validate the file extension. Example: "photo.png".
+   */
+  filename: string;
+
+  /**
+   * MIME type of the uploaded file. Will be used as Content-Type
+   * when uploading to the storage adapter. Example: "image/png".
+   */
+  contentType: string;
+
+  /**
+   * Binary contents of the file. Can be a Node.js Buffer, Uint8Array,
+   * or ArrayBuffer. The plugin uploads this directly without converting
+   * to base64.
+   */
+  buffer: Buffer | Uint8Array | ArrayBuffer;
+
+  /**
+   * Authenticated admin user on whose behalf the record is created.
+   * Passed through to AdminForth createResourceRecord hooks.
+   */
+  adminUser: AdminUser;
+
+  /**
+   * Optional HTTP context (headers, IP, etc.) forwarded to AdminForth
+   * createResourceRecord hooks. Needed to execute hooks on creation resource record for the upload.
+   */
+  extra?: HttpExtra;
+
+  /**
+   * Optional additional attributes to set on the created record
+   * together with the path column managed by the plugin.
+   * Values here do NOT affect the generated storage path.
+   */
+  recordAttributes?: Record<string, any>;
+};