@modern-admin/feature-upload 0.1.0

package/dist/providers/s3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.js","sourceRoot":"","sources":["../../src/providers/s3.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAmD3C,MAAM,OAAO,gBAAgB;IAI3B,YACmB,OAAwB;IACzC,sEAAsE;IACtE,sEAAsE;IAErD,cAAoB;QAJpB,YAAO,GAAP,OAAO,CAAiB;QAIxB,mBAAc,GAAd,cAAc,CAAM;QAP/B,YAAO,GAAQ,IAAI,CAAA;IAQxB,CAAC;IAGI,KAAK,CAAC,MAAM;QAClB,IAAI,IAAI,CAAC,cAAc;YAAE,OAAO,IAAI,CAAC,cAAc,CAAA;QACnD,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC,OAAO,CAAA;QACrC,IAAI,QAAiB,CAAA;QACrB,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,oBAA8B,CAAC,CAAA;YACxD,QAAQ,GAAI,GAA6B,CAAC,QAAQ,CAAA;QACpD,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CACb,8EAA8E;gBAC5E,wCAAwC,CAC3C,CAAA;QACH,CAAC;QACD,MAAM,GAAG,GAA4B;YACnC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;YAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACjE,CAAA;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;YAC7D,GAAG,CAAC,WAAW,GAAG;gBAChB,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;gBACrC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;aAC9C,CAAA;QACH,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,IAAK,QAA0D,CAAC,GAAG,CAAC,CAAA;QACnF,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAkB,EAAE,GAAY;QAC3C,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;QAC7B,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACtC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;QACnE,MAAM,WAAW,GAAG,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,GAAG,EAAE,CAAA;QAEvD,6EAA6E;QAC7E,iEAAiE;QACjE,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,sBAAgC,CAAC,CAAA;YACjE,MAAM,MAAM,GAAI,UAA2F,CAAC,MAAM,CAAA;YAClH,MAAM,KAAK,GAA4B;gBACrC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;gBAC3B,GAAG,EAAE,WAAW;gBAChB,IAAI,EAAE,IAAI,CAAC,MAAM;gBACjB,WAAW,EAAE,IAAI,CAAC,QAAQ;aAC3B,CAAA;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG;gBAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAA;YAClD,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAA;YACzD,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QACvB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,6DAA6D;YAC7D,IAAK,GAAyB,CAAC,IAAI,KAAK,sBAAsB;gBAC1D,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBAC/C,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,oBAA8B,CAAC,CAAA;gBACxD,MAAM,gBAAgB,GAAI,GAAyE,CAAC,gBAAgB,CAAA;gBACpH,MAAM,KAAK,GAA4B;oBACrC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;oBAC3B,GAAG,EAAE,WAAW;oBAChB,IAAI,EAAE,IAAI,CAAC,MAAM;oBACjB,WAAW,EAAE,IAAI,CAAC,QAAQ;oBAC1B,aAAa,EAAE,IAAI,CAAC,IAAI;iBACzB,CAAA;gBACD,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG;oBAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAA;gBAClD,MAAO,CAA+C,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAA;YAC1F,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,CAAA;YACX,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;QACD,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,IAAI,GAAG,EAAE,CAAA;IACzC,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,oBAA8B,CAAC,CAAA;YACxD,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;YAC7B,MAAM,mBAAmB,GAAI,GAA4E,CAAC,mBAAmB,CAAA;YAC7H,MAAO,CAA+C,CAAC,IAAI,CACzD,IAAI,mBAAmB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CACnE,CAAA;QACH,CAAC;QAAC,MAAM,CAAC;YACP,+BAA+B;QACjC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,WAAW;QACT,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,OAAO,SAAS,CAAA;QACzC,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAA;IACxC,CAAC;IAEO,KAAK,CAAC,SAAS,CAAC,GAAW;QACjC,IAAI,YAAqB,CAAA;QACzB,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,+BAAyC,CAAC,CAAA;YACnE,YAAY,GAAI,GAAiC,CAAC,YAAY,CAAA;QAChE,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CACb,mFAAmF;gBACjF,mDAAmD,CACtD,CAAA;QACH,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,oBAA8B,CAAC,CAAA;QACxD,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;QAC7B,MAAM,gBAAgB,GAAI,GAAyE,CAAC,gBAAgB,CAAA;QACpH,MAAM,SAAS,GACb,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,QAAQ;YACrC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,CAAC;YACzC,CAAC,CAAC,IAAI,CAAA;QAEV,OAAQ,YAIa,CAAC,CAAC,EAAE,IAAI,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAA;IAC1G,CAAC;IAEO,aAAa;QACnB,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa;YAAE,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAA;QACjE,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ;YAAE,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAA;QACnF,OAAO,WAAW,IAAI,CAAC,OAAO,CAAC,MAAM,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,gBAAgB,CAAA;IACjF,CAAC;CACF"}

package/dist/registry.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Process-level upload provider registry.
+ *
+ * `uploadFeature()` registers upload configs here (keyed by a generated id) at
+ * feature application time. The NestJS `UploadController` looks up configs by
+ * the id stored in the property's `custom.uploadProviderId` field.
+ *
+ * The registry is intentionally a module-level singleton so it is available
+ * before the NestJS DI container is initialised — the same pattern used by
+ * `ModernAdminFeatureRegistry` in `@modern-admin/nest`.
+ */
+import type { IUploadProvider } from './types.js';
+/** Everything stored per upload property registration. */
+export interface RegisteredUploadConfig {
+    provider: IUploadProvider;
+    /** Optional custom key generator (from `UploadPropertyConfig.uploadPath`). */
+    uploadPath?: (filename: string) => string;
+    /** True for multi-file properties — controller will accept N files per request. */
+    isArray?: boolean;
+}
+export declare const UploadProviderRegistry: {
+    register(id: string, config: RegisteredUploadConfig): void;
+    get(id: string): RegisteredUploadConfig | undefined;
+    /** For test cleanup. */
+    clear(): void;
+};
+//# sourceMappingURL=registry.d.ts.map

package/dist/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD,0DAA0D;AAC1D,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,eAAe,CAAA;IACzB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAA;IACzC,mFAAmF;IACnF,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAID,eAAO,MAAM,sBAAsB;iBACpB,MAAM,UAAU,sBAAsB,GAAG,IAAI;YAIlD,MAAM,GAAG,sBAAsB,GAAG,SAAS;IAInD,wBAAwB;aACf,IAAI;CAGd,CAAA"}

package/dist/registry.js

@@ -0,0 +1,25 @@
+/**
+ * Process-level upload provider registry.
+ *
+ * `uploadFeature()` registers upload configs here (keyed by a generated id) at
+ * feature application time. The NestJS `UploadController` looks up configs by
+ * the id stored in the property's `custom.uploadProviderId` field.
+ *
+ * The registry is intentionally a module-level singleton so it is available
+ * before the NestJS DI container is initialised — the same pattern used by
+ * `ModernAdminFeatureRegistry` in `@modern-admin/nest`.
+ */
+const _registry = new Map();
+export const UploadProviderRegistry = {
+    register(id, config) {
+        _registry.set(id, config);
+    },
+    get(id) {
+        return _registry.get(id);
+    },
+    /** For test cleanup. */
+    clear() {
+        _registry.clear();
+    },
+};
+//# sourceMappingURL=registry.js.map

package/dist/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAaH,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkC,CAAA;AAE3D,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,QAAQ,CAAC,EAAU,EAAE,MAA8B;QACjD,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC3B,CAAC;IAED,GAAG,CAAC,EAAU;QACZ,OAAO,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAC1B,CAAC;IAED,wBAAwB;IACxB,KAAK;QACH,SAAS,CAAC,KAAK,EAAE,CAAA;IACnB,CAAC;CACF,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,130 @@
+/**
+ * Core types for the upload feature plugin.
+ *
+ * `IUploadProvider` is the single port contract that upload backends must
+ * implement. `LocalUploadProvider` and `S3UploadProvider` ship as built-in
+ * adapters; custom providers only need to implement these four methods.
+ */
+/** Parsed file data received from a multipart request. */
+export interface UploadedFile {
+    /** Original filename from the client. */
+    originalName: string;
+    /** MIME type reported by the client (e.g. 'image/jpeg'). */
+    mimeType: string;
+    /** File size in bytes. */
+    size: number;
+    /** Raw file bytes. */
+    buffer: Buffer;
+}
+/** Metadata returned by the upload endpoint. */
+export interface UploadedFileInfo {
+    /** Storage key (relative path or object key). Stored in the DB field. */
+    key: string;
+    /** Public URL for browser display / download. */
+    url: string;
+    /** Original filename. */
+    name: string;
+    /** Size in bytes. */
+    size: number;
+    /** MIME type. */
+    mimeType: string;
+}
+/**
+ * Upload provider port. Implement this interface to add a new storage backend.
+ *
+ * @example
+ * class GcsUploadProvider implements IUploadProvider {
+ *   async upload(file) { ... }
+ *   getUrl(key) { ... }
+ *   async delete(key) { ... }
+ * }
+ */
+export interface IUploadProvider {
+    /**
+     * Upload a file and return its storage key.
+     * The key is the value that will be persisted in the database field.
+     *
+     * @param file  Parsed file data from the multipart request.
+     * @param key   Optional pre-computed storage key (from `uploadPath`). When
+     *              omitted the provider generates a key internally (UUID + extension).
+     */
+    upload(file: UploadedFile, key?: string): Promise<string>;
+    /**
+     * Compute the public URL for a stored key. May be sync or async.
+     * Used both by the upload endpoint (to return the URL) and by the frontend
+     * URL template when `urlTemplate()` is not implemented.
+     */
+    getUrl(key: string): string | Promise<string>;
+    /**
+     * Delete the file identified by `key`. Must not throw if the file does not
+     * exist (e.g. was already deleted or was never stored).
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Optional URL template string for the frontend to construct display URLs
+     * from stored keys without calling the backend.
+     * Use `{key}` as the placeholder, e.g. `'https://cdn.example.com/{key}'`.
+     * Return `undefined` (or omit the method) when URLs cannot be statically
+     * computed (e.g. signed/pre-signed S3 URLs — each URL is unique and time-limited).
+     */
+    urlTemplate?(): string | undefined;
+}
+/** Per-property upload configuration passed to `uploadFeature()`. */
+export interface UploadPropertyConfig {
+    /** Storage provider for this property. */
+    provider: IUploadProvider;
+    /**
+     * Allowed MIME type patterns (same syntax as the HTML `accept` attribute).
+     * Examples: `['image/*']`, `['image/jpeg', 'application/pdf']`.
+     * Enforcement is advisory on the frontend; the controller does not re-validate.
+     */
+    mimeTypes?: string[];
+    /** Maximum upload size in bytes. Advisory (frontend warning only). */
+    maxSize?: number;
+    /**
+     * Treat the property as an array of file keys (multi-file upload).
+     * When true, the property is stored as `string[]`, the editor allows
+     * uploading multiple files (a single multipart request can include several),
+     * and the action hooks diff arrays on edit and delete every key on delete.
+     */
+    isArray?: boolean;
+    /**
+     * Custom storage key generator. Receives the original filename from the
+     * client and returns the key to use for storage.
+     *
+     * Use this to organise files into sub-directories, include the resource
+     * name, add timestamps, etc.  The provider's internal UUID generator is
+     * used when this is omitted.
+     *
+     * @example
+     * // avatars/2024/01/uuid.jpg
+     * uploadPath: (filename) => {
+     *   const ext = filename.split('.').pop()
+     *   const d = new Date()
+     *   return `avatars/${d.getFullYear()}/${String(d.getMonth()+1).padStart(2,'0')}/${uuidv7()}.${ext}`
+     * }
+     *
+     * @example
+     * // resource-specific prefix
+     * uploadPath: (filename) => `products/images/${uuidv7()}-${filename}`
+     */
+    uploadPath?: (filename: string) => string;
+}
+/** Options passed to `uploadFeature()`. */
+export interface UploadFeatureOptions {
+    /**
+     * Map from property path to its upload configuration.
+     * Each entry makes the property a `type: 'file'` field wired to the
+     * specified provider.
+     *
+     * @example
+     * uploadFeature({
+     *   properties: {
+     *     avatar: { provider: new LocalUploadProvider({ uploadDir: './uploads', baseUrl: '/uploads' }) },
+     *     resume: { provider: new S3UploadProvider({ bucket: 'my-bucket', region: 'us-east-1' }), mimeTypes: ['application/pdf'] },
+     *   },
+     * })
+     */
+    properties: Record<string, UploadPropertyConfig>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,0DAA0D;AAC1D,MAAM,WAAW,YAAY;IAC3B,yCAAyC;IACzC,YAAY,EAAE,MAAM,CAAA;IACpB,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,gDAAgD;AAChD,MAAM,WAAW,gBAAgB;IAC/B,yEAAyE;IACzE,GAAG,EAAE,MAAM,CAAA;IACX,iDAAiD;IACjD,GAAG,EAAE,MAAM,CAAA;IACX,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,iBAAiB;IACjB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEzD;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAE7C;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElC;;;;;;OAMG;IACH,WAAW,CAAC,IAAI,MAAM,GAAG,SAAS,CAAA;CACnC;AAED,qEAAqE;AACrE,MAAM,WAAW,oBAAoB;IACnC,0CAA0C;IAC1C,QAAQ,EAAE,eAAe,CAAA;IACzB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAA;CAC1C;AAED,2CAA2C;AAC3C,MAAM,WAAW,oBAAoB;IACnC;;;;;;;;;;;;OAYG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;CACjD"}

package/dist/types.js

@@ -0,0 +1,9 @@
+/**
+ * Core types for the upload feature plugin.
+ *
+ * `IUploadProvider` is the single port contract that upload backends must
+ * implement. `LocalUploadProvider` and `S3UploadProvider` ship as built-in
+ * adapters; custom providers only need to implement these four methods.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/upload-feature.d.ts

@@ -0,0 +1,31 @@
+/**
+ * `uploadFeature` — resource plugin that wires file upload into any resource.
+ *
+ * Returns a `FeatureFn` that, when applied to a resource's `ResourceOptions`,
+ * marks the configured properties as `type: 'file'` (with `isArray` when
+ * configured), registers the upload providers in `UploadProviderRegistry`, and
+ * installs action hooks that:
+ *
+ *   - on `new.after` / `edit.after` — confirm freshly-uploaded keys against
+ *     `PendingUploadsRegistry` so the orphan sweeper leaves them alone;
+ *   - on `edit.after` — delete files whose key was replaced or removed
+ *     (single-value: old !== new; array: keys present in old but missing
+ *     from new);
+ *   - on `delete.after` — delete every file referenced by the deleted record.
+ *
+ * Hooks are **chained**, not replaced: if the incoming `ResourceOptions`
+ * already has hooks (e.g. from another feature), the upload hooks are
+ * appended so all hooks run in order.
+ *
+ * @example
+ * uploadFeature({
+ *   properties: {
+ *     thumbnail: { provider: localProvider, mimeTypes: ['image/*'] },
+ *     gallery:   { provider: localProvider, isArray: true, mimeTypes: ['image/*'] },
+ *   },
+ * })
+ */
+import { type FeatureFn } from '@modern-admin/core';
+import type { UploadFeatureOptions } from './types.js';
+export declare function uploadFeature(options: UploadFeatureOptions): FeatureFn;
+//# sourceMappingURL=upload-feature.d.ts.map

package/dist/upload-feature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-feature.d.ts","sourceRoot":"","sources":["../src/upload-feature.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAmD,KAAK,SAAS,EAAwB,MAAM,oBAAoB,CAAA;AAC1H,OAAO,KAAK,EAAE,oBAAoB,EAAwB,MAAM,YAAY,CAAA;AAiD5E,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,SAAS,CAiItE"}

package/dist/upload-feature.js

@@ -0,0 +1,170 @@
+/**
+ * `uploadFeature` — resource plugin that wires file upload into any resource.
+ *
+ * Returns a `FeatureFn` that, when applied to a resource's `ResourceOptions`,
+ * marks the configured properties as `type: 'file'` (with `isArray` when
+ * configured), registers the upload providers in `UploadProviderRegistry`, and
+ * installs action hooks that:
+ *
+ *   - on `new.after` / `edit.after` — confirm freshly-uploaded keys against
+ *     `PendingUploadsRegistry` so the orphan sweeper leaves them alone;
+ *   - on `edit.after` — delete files whose key was replaced or removed
+ *     (single-value: old !== new; array: keys present in old but missing
+ *     from new);
+ *   - on `delete.after` — delete every file referenced by the deleted record.
+ *
+ * Hooks are **chained**, not replaced: if the incoming `ResourceOptions`
+ * already has hooks (e.g. from another feature), the upload hooks are
+ * appended so all hooks run in order.
+ *
+ * @example
+ * uploadFeature({
+ *   properties: {
+ *     thumbnail: { provider: localProvider, mimeTypes: ['image/*'] },
+ *     gallery:   { provider: localProvider, isArray: true, mimeTypes: ['image/*'] },
+ *   },
+ * })
+ */
+import { uuidv7 } from '@modern-admin/core';
+import { UploadProviderRegistry } from './registry.js';
+import { PendingUploadsRegistry } from './pending-registry.js';
+/** Normalise a hook value (fn | fn[] | undefined) into an array. */
+function toArray(hook) {
+    if (!hook)
+        return [];
+    return Array.isArray(hook) ? hook : [hook];
+}
+/**
+ * Merge `after` hooks from an existing action override with new hooks,
+ * producing an array that runs all of them in order.
+ * If `existing` already defines `after`, the new hooks are appended.
+ */
+function mergeAfterHook(existing, newHook) {
+    const existing_after = toArray(existing?.after);
+    return [...existing_after, newHook];
+}
+// ─── Value helpers ────────────────────────────────────────────────────────────
+/** Return non-empty file keys for the given value (handles single + array). */
+function toKeys(value) {
+    if (value == null || value === '')
+        return [];
+    if (Array.isArray(value)) {
+        return value.flatMap((v) => (v == null || v === '' ? [] : [String(v)]));
+    }
+    return [String(value)];
+}
+// ─── Feature function ─────────────────────────────────────────────────────────
+export function uploadFeature(options) {
+    // Register configs immediately — before the FeatureFn is called.
+    const registered = new Map();
+    for (const [propPath, config] of Object.entries(options.properties)) {
+        const providerId = `up_${uuidv7().replace(/-/g, '')}`;
+        UploadProviderRegistry.register(providerId, {
+            provider: config.provider,
+            uploadPath: config.uploadPath,
+            isArray: config.isArray ?? false,
+        });
+        registered.set(propPath, { providerId, config });
+    }
+    return (resourceOptions) => {
+        // --- Property overrides ---
+        const propOverrides = {};
+        for (const [propPath, { providerId, config }] of registered) {
+            // S3 with signed URLs has no static URL template.
+            const urlTmpl = config.provider.urlTemplate?.() ?? null;
+            propOverrides[propPath] = {
+                type: 'file',
+                ...(config.isArray ? { isArray: true } : {}),
+                custom: {
+                    uploadProviderId: providerId,
+                    uploadUrlTemplate: urlTmpl,
+                    uploadMimeTypes: config.mimeTypes ?? null,
+                    uploadMaxSize: config.maxSize ?? null,
+                },
+            };
+        }
+        // --- Action hooks ---
+        // After new: confirm every freshly-uploaded key against the pending registry.
+        const newAfterHook = (response, _request, _context) => {
+            const rec = response;
+            const params = rec.record?.params ?? {};
+            const newKeys = [];
+            for (const propPath of registered.keys()) {
+                newKeys.push(...toKeys(params[propPath]));
+            }
+            if (newKeys.length > 0)
+                PendingUploadsRegistry.confirm(newKeys);
+            return response;
+        };
+        // After edit: delete keys that disappeared and confirm keys that arrived.
+        const editAfterHook = async (response, _request, context) => {
+            const ctx = context;
+            const rec = response;
+            const params = rec.record?.params ?? {};
+            for (const [propPath, { config }] of registered) {
+                const oldKeys = new Set(toKeys(ctx.record?.get(propPath)));
+                const newKeys = toKeys(params[propPath]);
+                // Confirm new keys (possibly fresh uploads).
+                if (newKeys.length > 0)
+                    PendingUploadsRegistry.confirm(newKeys);
+                // Delete keys that were present before and are gone now.
+                const newSet = new Set(newKeys);
+                for (const k of oldKeys) {
+                    if (!newSet.has(k)) {
+                        try {
+                            await config.provider.delete(k);
+                        }
+                        catch {
+                            // Non-fatal — don't break the action response.
+                        }
+                    }
+                }
+            }
+            return response;
+        };
+        // After delete: delete every file referenced by the (now-removed) record.
+        const deleteAfterHook = async (response, _request, context) => {
+            const ctx = context;
+            for (const [propPath, { config }] of registered) {
+                const keys = toKeys(ctx.record?.get(propPath));
+                for (const k of keys) {
+                    try {
+                        await config.provider.delete(k);
+                    }
+                    catch {
+                        // Non-fatal.
+                    }
+                }
+            }
+            return response;
+        };
+        // Retrieve any existing action overrides so we can chain, not replace.
+        const existingActions = resourceOptions.actions;
+        const existingNew = existingActions?.['new'];
+        const existingEdit = existingActions?.['edit'];
+        const existingDelete = existingActions?.['delete'];
+        const actionOverrides = {
+            new: {
+                ...existingNew,
+                after: mergeAfterHook(existingNew, newAfterHook),
+            },
+            edit: {
+                ...existingEdit,
+                after: mergeAfterHook(existingEdit, editAfterHook),
+            },
+            delete: {
+                ...existingDelete,
+                after: mergeAfterHook(existingDelete, deleteAfterHook),
+            },
+        };
+        return {
+            ...resourceOptions,
+            properties: { ...resourceOptions.properties, ...propOverrides },
+            actions: {
+                ...(resourceOptions.actions ?? {}),
+                ...actionOverrides,
+            },
+        };
+    };
+}
+//# sourceMappingURL=upload-feature.js.map

package/dist/upload-feature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-feature.js","sourceRoot":"","sources":["../src/upload-feature.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,MAAM,EAAiF,MAAM,oBAAoB,CAAA;AAE1H,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AAe9D,oEAAoE;AACpE,SAAS,OAAO,CAAC,IAAa;IAC5B,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAA;IACpB,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,IAAiB,CAAC,CAAC,CAAC,CAAC,IAAc,CAAC,CAAA;AACpE,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CACrB,QAA6C,EAC7C,OAAe;IAEf,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;IAC/C,OAAO,CAAC,GAAG,cAAc,EAAE,OAAO,CAAC,CAAA;AACrC,CAAC;AAED,iFAAiF;AAEjF,+EAA+E;AAC/E,SAAS,MAAM,CAAC,KAAc;IAC5B,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO,EAAE,CAAA;IAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACzE,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;AACxB,CAAC;AAED,iFAAiF;AAEjF,MAAM,UAAU,aAAa,CAAC,OAA6B;IACzD,iEAAiE;IACjE,MAAM,UAAU,GAAG,IAAI,GAAG,EAA0B,CAAA;IAEpD,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACpE,MAAM,UAAU,GAAG,MAAM,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAA;QACrD,sBAAsB,CAAC,QAAQ,CAAC,UAAU,EAAE;YAC1C,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,KAAK;SACjC,CAAC,CAAA;QACF,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAA;IAClD,CAAC;IAED,OAAO,CAAC,eAAgC,EAAmB,EAAE;QAC3D,6BAA6B;QAC7B,MAAM,aAAa,GAAkC,EAAE,CAAA;QACvD,KAAK,MAAM,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC;YAC5D,kDAAkD;YAClD,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,IAAI,IAAI,CAAA;YACvD,aAAa,CAAC,QAAQ,CAAC,GAAG;gBACxB,IAAI,EAAE,MAAM;gBACZ,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5C,MAAM,EAAE;oBACN,gBAAgB,EAAE,UAAU;oBAC5B,iBAAiB,EAAE,OAAO;oBAC1B,eAAe,EAAE,MAAM,CAAC,SAAS,IAAI,IAAI;oBACzC,aAAa,EAAE,MAAM,CAAC,OAAO,IAAI,IAAI;iBACtC;aACF,CAAA;QACH,CAAC;QAED,uBAAuB;QAEvB,8EAA8E;QAC9E,MAAM,YAAY,GAAW,CAC3B,QAAwB,EACxB,QAAuB,EACvB,QAAiB,EACD,EAAE;YAClB,MAAM,GAAG,GAAG,QAA6D,CAAA;YACzE,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE,CAAA;YACvC,MAAM,OAAO,GAAa,EAAE,CAAA;YAC5B,KAAK,MAAM,QAAQ,IAAI,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;gBACzC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;YAC3C,CAAC;YACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;gBAAE,sBAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YAC/D,OAAO,QAAQ,CAAA;QACjB,CAAC,CAAA;QAED,0EAA0E;QAC1E,MAAM,aAAa,GAAW,KAAK,EACjC,QAAwB,EACxB,QAAuB,EACvB,OAAgB,EACS,EAAE;YAC3B,MAAM,GAAG,GAAG,OAAsD,CAAA;YAClE,MAAM,GAAG,GAAG,QAA6D,CAAA;YACzE,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE,CAAA;YACvC,KAAK,MAAM,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC;gBAChD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;gBAC1D,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;gBACxC,6CAA6C;gBAC7C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;oBAAE,sBAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;gBAC/D,yDAAyD;gBACzD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAA;gBAC/B,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;oBACxB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;wBACnB,IAAI,CAAC;4BACH,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;wBACjC,CAAC;wBAAC,MAAM,CAAC;4BACP,+CAA+C;wBACjD,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,OAAO,QAAQ,CAAA;QACjB,CAAC,CAAA;QAED,0EAA0E;QAC1E,MAAM,eAAe,GAAW,KAAK,EACnC,QAAwB,EACxB,QAAuB,EACvB,OAAgB,EACS,EAAE;YAC3B,MAAM,GAAG,GAAG,OAAsD,CAAA;YAClE,KAAK,MAAM,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC;gBAChD,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAA;gBAC9C,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;oBACrB,IAAI,CAAC;wBACH,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;oBACjC,CAAC;oBAAC,MAAM,CAAC;wBACP,aAAa;oBACf,CAAC;gBACH,CAAC;YACH,CAAC;YACD,OAAO,QAAQ,CAAA;QACjB,CAAC,CAAA;QAED,uEAAuE;QACvE,MAAM,eAAe,GAAG,eAAe,CAAC,OAA8D,CAAA;QACtG,MAAM,WAAW,GAAG,eAAe,EAAE,CAAC,KAAK,CAAC,CAAA;QAC5C,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC,MAAM,CAAC,CAAA;QAC9C,MAAM,cAAc,GAAG,eAAe,EAAE,CAAC,QAAQ,CAAC,CAAA;QAElD,MAAM,eAAe,GAAG;YACtB,GAAG,EAAE;gBACH,GAAG,WAAW;gBACd,KAAK,EAAE,cAAc,CAAC,WAAW,EAAE,YAAY,CAAC;aACjD;YACD,IAAI,EAAE;gBACJ,GAAG,YAAY;gBACf,KAAK,EAAE,cAAc,CAAC,YAAY,EAAE,aAAa,CAAC;aACnD;YACD,MAAM,EAAE;gBACN,GAAG,cAAc;gBACjB,KAAK,EAAE,cAAc,CAAC,cAAc,EAAE,eAAe,CAAC;aACvD;SAC4B,CAAA;QAE/B,OAAO;YACL,GAAG,eAAe;YAClB,UAAU,EAAE,EAAE,GAAG,eAAe,CAAC,UAAU,EAAE,GAAG,aAAa,EAAE;YAC/D,OAAO,EAAE;gBACP,GAAG,CAAC,eAAe,CAAC,OAAO,IAAI,EAAE,CAAC;gBAClC,GAAG,eAAe;aACnB;SACF,CAAA;IACH,CAAC,CAAA;AACH,CAAC"}

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@modern-admin/feature-upload",
+  "version": "0.1.0",
+  "description": "File upload feature plugin for Modern Admin (local + S3 providers).",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/modern-admin/modern-admin.git",
+    "directory": "packages/feature-upload"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./nest": {
+      "types": "./dist/nest/index.d.ts",
+      "default": "./dist/nest/index.js"
+    },
+    "./graphql": {
+      "types": "./dist/graphql.d.ts",
+      "default": "./dist/graphql.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "./nest": {
+        "types": "./dist/nest/index.d.ts",
+        "default": "./dist/nest/index.js"
+      },
+      "./graphql": {
+        "types": "./dist/graphql.d.ts",
+        "default": "./dist/graphql.js"
+      }
+    }
+  },
+  "dependencies": {
+    "@modern-admin/core": "0.1.0",
+    "@nestjs/common": "^11.1.19",
+    "@nestjs/core": "^11.1.19",
+    "busboy": "^1.6.0",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.2"
+  },
+  "devDependencies": {
+    "@modern-admin/graphql": "0.1.0",
+    "@modern-admin/nest": "0.1.0",
+    "@modern-admin/tsconfig": "0.1.0",
+    "@nestjs/swagger": "^11.4.2",
+    "@types/bun": "^1.3.13",
+    "@types/busboy": "^1.5.4",
+    "graphql": "^16.11.0",
+    "typescript": "^6.0.3"
+  },
+  "peerDependencies": {
+    "@aws-sdk/client-s3": "^3.0.0",
+    "@modern-admin/graphql": "0.1.0",
+    "@modern-admin/nest": "0.1.0",
+    "@nestjs/swagger": "^11.4.2",
+    "graphql": "^16.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@aws-sdk/client-s3": {
+      "optional": true
+    },
+    "@modern-admin/graphql": {
+      "optional": true
+    },
+    "@modern-admin/nest": {
+      "optional": true
+    },
+    "@nestjs/swagger": {
+      "optional": true
+    },
+    "graphql": {
+      "optional": true
+    }
+  }
+}