@unchainedshop/file-upload 4.3.4 → 4.4.0

package/README.md

@@ -1 +1,135 @@
-# File Upload (Unchained)
+[![npm version](https://img.shields.io/npm/v/@unchainedshop/file-upload.svg)](https://npmjs.com/package/@unchainedshop/file-upload)
+[![License: EUPL-1.2](https://img.shields.io/badge/License-EUPL--1.2-blue.svg)](https://opensource.org/licenses/EUPL-1.2)
+
+# @unchainedshop/file-upload
+
+File upload abstraction layer for the Unchained Engine. Provides a pluggable system for handling file uploads with support for signed URLs, streaming, and multiple storage backends.
+
+## Installation
+
+```bash
+npm install @unchainedshop/file-upload
+```
+
+## Usage
+
+```typescript
+import { FileDirector, FileAdapter, type IFileAdapter } from '@unchainedshop/file-upload';
+
+// Create a custom file adapter
+const MyStorageAdapter: IFileAdapter = {
+  ...FileAdapter,
+  key: 'my-storage',
+  label: 'My Storage Backend',
+  version: '1.0.0',
+
+  async createSignedURL(directoryName, fileName, unchainedAPI) {
+    // Return signed URL for direct upload
+    return {
+      _id: 'file-id',
+      directoryName,
+      fileName,
+      type: 'application/octet-stream',
+      url: 'https://storage.example.com/file',
+      putURL: 'https://storage.example.com/upload',
+      expiryDate: new Date(Date.now() + 3600000),
+    };
+  },
+
+  async createDownloadURL(file, expiry) {
+    return `https://storage.example.com/${file.path}`;
+  },
+};
+
+// Register the adapter
+FileDirector.registerAdapter(MyStorageAdapter);
+
+// Register upload callback for a directory
+FileDirector.registerFileUploadCallback('product-images', async (file, unchainedAPI) => {
+  // Process uploaded file
+  console.log('File uploaded:', file.name);
+});
+```
+
+## API Overview
+
+### FileDirector
+
+| Method | Description |
+|--------|-------------|
+| `registerAdapter` | Register a file storage adapter |
+| `getAdapter` | Get adapter by key |
+| `getAdapters` | Get all registered adapters |
+| `unregisterAdapter` | Remove an adapter |
+| `registerFileUploadCallback` | Register callback for upload completion |
+| `getFileUploadCallback` | Get registered callback for directory |
+
+### FileAdapter Base
+
+Base implementation for file adapters. Override these methods:
+
+| Method | Description |
+|--------|-------------|
+| `createSignedURL` | Generate signed URL for direct upload |
+| `createDownloadURL` | Generate download URL for a file |
+| `createDownloadStream` | Get readable stream for file download |
+| `uploadFileFromStream` | Upload file from a stream |
+| `uploadFileFromURL` | Upload file from external URL |
+| `removeFiles` | Delete files from storage |
+
+### Utility Functions
+
+| Export | Description |
+|--------|-------------|
+| `buildHashedFilename` | Generate hashed filename for storage |
+| `resolveExpirationDate` | Calculate expiration date for signed URLs |
+
+### Types
+
+| Export | Description |
+|--------|-------------|
+| `IFileAdapter` | Interface for file adapter implementations |
+| `UploadFileData` | Data returned after file upload |
+| `UploadedFile` | Representation of an uploaded file |
+| `UploadFileCallback` | Callback function type for upload events |
+
+## Implementing a Custom Adapter
+
+```typescript
+import { FileAdapter, type IFileAdapter } from '@unchainedshop/file-upload';
+
+const S3Adapter: IFileAdapter = {
+  ...FileAdapter,
+  key: 's3-adapter',
+  label: 'AWS S3 Storage',
+  version: '1.0.0',
+
+  async createSignedURL(directoryName, fileName, unchainedAPI) {
+    // Generate presigned S3 URL
+  },
+
+  async createDownloadURL(file, expiry) {
+    // Generate presigned download URL
+  },
+
+  async uploadFileFromStream(directoryName, rawFile, unchainedAPI) {
+    // Stream upload to S3
+  },
+
+  async removeFiles(files, unchainedContext) {
+    // Delete objects from S3
+  },
+
+  async createDownloadStream(file, unchainedAPI) {
+    // Return S3 object as stream
+  },
+
+  async uploadFileFromURL(directoryName, fileInput, unchainedAPI) {
+    // Fetch and upload from URL
+  },
+};
+```
+
+## License
+
+EUPL-1.2

package/lib/build-hashed-filename.d.ts

@@ -1,2 +1 @@
 export default function buildHashedFilename(directoryName: string, fileName: string, expiryDate: Date): Promise<string>;
-//# sourceMappingURL=build-hashed-filename.d.ts.map

package/lib/build-hashed-filename.js

@@ -12,4 +12,3 @@ export default async function buildHashedFilename(directoryName, fileName, expir
     const b62converted = b62.encode(hashed);
     return `${b62converted}-${slugifiedFilenameWithExtension}`;
 }
-//# sourceMappingURL=build-hashed-filename.js.map

package/lib/director/FileAdapter.d.ts

@@ -1,6 +1,6 @@
 import type { Readable } from 'node:stream';
-import { IBaseAdapter } from '@unchainedshop/utils';
-import { UploadedFile, UploadFileData } from '../types.js';
+import { type IBaseAdapter } from '@unchainedshop/utils';
+import type { UploadedFile, UploadFileData } from '../types.ts';
 export interface IFileAdapter<Context = unknown> extends IBaseAdapter {
     createDownloadURL: (file: UploadedFile, expiry?: number) => Promise<string | null>;
     createSignedURL: (directoryName: string, fileName: string, unchainedAPI: Context) => Promise<(UploadFileData & {
@@ -17,4 +17,3 @@ export interface IFileAdapter<Context = unknown> extends IBaseAdapter {
     createDownloadStream: (file: UploadedFile, unchainedAPI: Context) => Promise<Readable>;
 }
 export declare const FileAdapter: Omit<IFileAdapter, 'key' | 'label' | 'version'>;
-//# sourceMappingURL=FileAdapter.d.ts.map

package/lib/director/FileAdapter.js

@@ -20,4 +20,3 @@ export const FileAdapter = {
         throw new Error('Method not implemented');
     },
 };
-//# sourceMappingURL=FileAdapter.js.map

package/lib/director/FileDirector.d.ts

@@ -1,5 +1,5 @@
-import { IFileAdapter } from './FileAdapter.js';
-import { UploadedFile } from '../types.js';
+import type { IFileAdapter } from './FileAdapter.ts';
+import type { UploadedFile } from '../types.ts';
 export type UploadFileCallback<UnchainedAPI = unknown> = (file: UploadedFile, unchainedAPI: UnchainedAPI) => Promise<void>;
 export declare const FileDirector: {
     registerFileUploadCallback<UnchainedAPI>(directoryName: string, fn: UploadFileCallback<UnchainedAPI>): void;
@@ -11,4 +11,3 @@ export declare const FileDirector: {
     registerAdapter: (A: IFileAdapter<unknown>) => void;
     unregisterAdapter: (key: string) => boolean;
 };
-//# sourceMappingURL=FileDirector.d.ts.map

package/lib/director/FileDirector.js

@@ -12,4 +12,3 @@ export const FileDirector = {
         return FileUploadRegistry.get(directoryName) || null;
     },
 };
-//# sourceMappingURL=FileDirector.js.map

package/lib/file-upload-index.d.ts

@@ -1,7 +1,6 @@
-import buildHashedFilename from './build-hashed-filename.js';
-import resolveExpirationDate from './put-expiration.js';
-export { FileDirector } from './director/FileDirector.js';
-export { FileAdapter, IFileAdapter } from './director/FileAdapter.js';
+import buildHashedFilename from './build-hashed-filename.ts';
+import resolveExpirationDate from './put-expiration.ts';
+export { FileDirector } from './director/FileDirector.ts';
+export { FileAdapter, type IFileAdapter } from './director/FileAdapter.ts';
 export { buildHashedFilename, resolveExpirationDate };
-export type * from './types.js';
-//# sourceMappingURL=file-upload-index.d.ts.map
+export type * from './types.ts';

package/lib/file-upload-index.js

@@ -1,6 +1,5 @@
-import buildHashedFilename from './build-hashed-filename.js';
-import resolveExpirationDate from './put-expiration.js';
-export { FileDirector } from './director/FileDirector.js';
-export { FileAdapter } from './director/FileAdapter.js';
+import buildHashedFilename from "./build-hashed-filename.js";
+import resolveExpirationDate from "./put-expiration.js";
+export { FileDirector } from "./director/FileDirector.js";
+export { FileAdapter } from "./director/FileAdapter.js";
 export { buildHashedFilename, resolveExpirationDate };
-//# sourceMappingURL=file-upload-index.js.map

package/lib/put-expiration.d.ts

@@ -1,4 +1,3 @@
 export declare const expiryOffsetInMs: () => number;
 declare const resolveExpirationDate: () => Date;
 export default resolveExpirationDate;
-//# sourceMappingURL=put-expiration.d.ts.map

package/lib/put-expiration.js

@@ -2,4 +2,3 @@ const { UNCHAINED_PUT_URL_EXPIRY = '86400000' } = process.env;
 export const expiryOffsetInMs = () => parseInt(UNCHAINED_PUT_URL_EXPIRY, 10) || 24 * 60 * 60 * 1000;
 const resolveExpirationDate = () => new Date(new Date().getTime() + expiryOffsetInMs());
 export default resolveExpirationDate;
-//# sourceMappingURL=put-expiration.js.map

package/lib/types.d.ts

@@ -16,4 +16,3 @@ export interface UploadedFile {
     type?: string;
     url?: string;
 }
-//# sourceMappingURL=types.d.ts.map

package/lib/types.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=types.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unchainedshop/file-upload",
-  "version": "4.3.4",
+  "version": "4.4.0",
   "main": "lib/file-upload-index.js",
   "types": "lib/file-upload-index.d.ts",
   "type": "module",
@@ -9,8 +9,8 @@
     "build": "tsc -b",
     "prepublishOnly": "npm run clean && npm run build",
     "watch": "tsc -w",
-    "test": "tsx --test",
-    "test:watch": "tsx --test --watch"
+    "test": "node --test",
+    "test:watch": "node --test --watch"
   },
   "repository": {
     "type": "git",
@@ -22,8 +22,10 @@
     "core"
   ],
   "authors": [
-    "Joël Meiller",
-    "Pascal Kaufmann"
+    "Pascal Kaufmann",
+    "Mikael Araya",
+    "Vedran Rudelj",
+    "Joël Meiller"
   ],
   "license": "EUPL-1.2",
   "bugs": {
@@ -31,13 +33,12 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/logger": "^4.3.0",
-    "@unchainedshop/utils": "^4.3.0",
+    "@unchainedshop/logger": "^4.4.0",
+    "@unchainedshop/utils": "^4.4.0",
     "base-x": "^5.0.1"
   },
   "devDependencies": {
-    "@types/node": "^24.0.13",
-    "tsx": "^4.20.3",
+    "@types/node": "^25.0.0",
     "typescript": "^5.8.3"
   }
 }

package/lib/build-hashed-filename.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"build-hashed-filename.d.ts","sourceRoot":"","sources":["../src/build-hashed-filename.ts"],"names":[],"mappings":"AAKA,wBAA8B,mBAAmB,CAC/C,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,IAAI,GACf,OAAO,CAAC,MAAM,CAAC,CAYjB"}

package/lib/build-hashed-filename.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"build-hashed-filename.js","sourceRoot":"","sources":["../src/build-hashed-filename.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,MAAM,QAAQ,CAAC;AAE3B,MAAM,GAAG,GAAG,KAAK,CAAC,gEAAgE,CAAC,CAAC;AAEpF,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,mBAAmB,CAC/C,aAAqB,EACrB,QAAgB,EAChB,UAAgB;IAEhB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,aAAa,GAAG,QAAQ,GAAG,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAEhF,MAAM,gBAAgB,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7C,MAAM,GAAG,GAAG,gBAAgB,EAAE,GAAG,EAAE,CAAC;IACpC,MAAM,wBAAwB,GAAG,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAClE,MAAM,8BAA8B,GAAG,CAAC,OAAO,CAAC,wBAAwB,CAAC,EAAE,GAAG,CAAC;SAC5E,MAAM,CAAC,OAAO,CAAC;SACf,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAExC,OAAO,GAAG,YAAY,IAAI,8BAA8B,EAAE,CAAC;AAC7D,CAAC"}

package/lib/director/FileAdapter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FileAdapter.d.ts","sourceRoot":"","sources":["../../src/director/FileAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAe,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,MAAM,WAAW,YAAY,CAAC,OAAO,GAAG,OAAO,CAAE,SAAQ,YAAY;IACnE,iBAAiB,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACnF,eAAe,EAAE,CACf,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,OAAO,KAClB,OAAO,CAAC,CAAC,cAAc,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IAC3D,WAAW,EAAE,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,gBAAgB,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACjF,oBAAoB,EAAE,CACpB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,GAAG,EACZ,YAAY,EAAE,OAAO,EACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC1B,OAAO,CAAC,cAAc,CAAC,CAAC;IAC7B,iBAAiB,EAAE,CACjB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE;QACT,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC,EACD,YAAY,EAAE,OAAO,KAClB,OAAO,CAAC,cAAc,CAAC,CAAC;IAC7B,oBAAoB,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CACxF;AACD,eAAO,MAAM,WAAW,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,GAAG,OAAO,GAAG,SAAS,CAqBvE,CAAC"}

package/lib/director/FileAdapter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FileAdapter.js","sourceRoot":"","sources":["../../src/director/FileAdapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAgB,MAAM,sBAAsB,CAAC;AA6BjE,MAAM,CAAC,MAAM,WAAW,GAAoD;IAC1E,GAAG,WAAW;IAEd,KAAK,CAAC,eAAe;QACnB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IACD,KAAK,CAAC,WAAW;QACf,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IACD,KAAK,CAAC,iBAAiB;QACrB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IACD,KAAK,CAAC,oBAAoB;QACxB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IACD,KAAK,CAAC,oBAAoB;QACxB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IACD,KAAK,CAAC,iBAAiB;QACrB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;CACF,CAAC"}

package/lib/director/FileDirector.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FileDirector.d.ts","sourceRoot":"","sources":["../../src/director/FileDirector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,MAAM,MAAM,kBAAkB,CAAC,YAAY,GAAG,OAAO,IAAI,CACvD,IAAI,EAAE,YAAY,EAClB,YAAY,EAAE,YAAY,KACvB,OAAO,CAAC,IAAI,CAAC,CAAC;AAMnB,eAAO,MAAM,YAAY;+BAGI,YAAY,iBAAiB,MAAM,MAAM,kBAAkB,CAAC,YAAY,CAAC;yCAM/D,MAAM;;;;;;;CAG5C,CAAC"}

package/lib/director/FileDirector.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FileDirector.js","sourceRoot":"","sources":["../../src/director/FileDirector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AASpD,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAA8B,CAAC;AAEjE,MAAM,YAAY,GAAG,YAAY,CAAe,cAAc,CAAC,CAAC;AAEhE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,GAAG,YAAY;IAEf,0BAA0B,CAAe,aAAqB,EAAE,EAAoC;QAClG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;YAC3C,kBAAkB,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,qBAAqB,CAAC,aAAqB;QACzC,OAAO,kBAAkB,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC;IACvD,CAAC;CACF,CAAC"}

package/lib/file-upload-index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"file-upload-index.d.ts","sourceRoot":"","sources":["../src/file-upload-index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,4BAA4B,CAAC;AAC7D,OAAO,qBAAqB,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,CAAC;AACtD,mBAAmB,YAAY,CAAC"}

package/lib/file-upload-index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"file-upload-index.js","sourceRoot":"","sources":["../src/file-upload-index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,4BAA4B,CAAC;AAC7D,OAAO,qBAAqB,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAgB,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,CAAC"}

package/lib/put-expiration.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"put-expiration.d.ts","sourceRoot":"","sources":["../src/put-expiration.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,gBAAgB,cAAsE,CAAC;AAEpG,QAAA,MAAM,qBAAqB,YAA4D,CAAC;AAExF,eAAe,qBAAqB,CAAC"}

package/lib/put-expiration.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"put-expiration.js","sourceRoot":"","sources":["../src/put-expiration.ts"],"names":[],"mappings":"AAAA,MAAM,EAAE,wBAAwB,GAAG,UAAU,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;AAE9D,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,wBAAwB,EAAE,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEpG,MAAM,qBAAqB,GAAG,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,gBAAgB,EAAE,CAAC,CAAC;AAExF,eAAe,qBAAqB,CAAC"}

package/lib/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;CACd"}

package/lib/types.js.map

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

package/src/build-hashed-filename.ts

@@ -1,22 +0,0 @@
-import { sha1, slugify } from '@unchainedshop/utils';
-import baseX from 'base-x';
-
-const b62 = baseX('0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ');
-
-export default async function buildHashedFilename(
-  directoryName: string,
-  fileName: string,
-  expiryDate: Date,
-): Promise<string> {
-  const hashed = await sha1(`${directoryName}${fileName}${expiryDate.getTime()}`);
-
-  const splittedFilename = fileName.split('.');
-  const ext = splittedFilename?.pop();
-  const fileNameWithoutExtension = splittedFilename.join('.') || '';
-  const slugifiedFilenameWithExtension = [slugify(fileNameWithoutExtension), ext]
-    .filter(Boolean)
-    .join('.');
-  const b62converted = b62.encode(hashed);
-
-  return `${b62converted}-${slugifiedFilenameWithExtension}`;
-}

package/src/director/FileAdapter.ts

@@ -1,52 +0,0 @@
-import type { Readable } from 'node:stream';
-import { BaseAdapter, IBaseAdapter } from '@unchainedshop/utils';
-import { UploadedFile, UploadFileData } from '../types.js';
-
-export interface IFileAdapter<Context = unknown> extends IBaseAdapter {
-  createDownloadURL: (file: UploadedFile, expiry?: number) => Promise<string | null>;
-  createSignedURL: (
-    directoryName: string,
-    fileName: string,
-    unchainedAPI: Context,
-  ) => Promise<(UploadFileData & { putURL: string }) | null>;
-  removeFiles: (files: UploadedFile[], unchainedContext: Context) => Promise<void>;
-  uploadFileFromStream: (
-    directoryName: string,
-    rawFile: any,
-    unchainedAPI: Context,
-    options?: Record<string, any>,
-  ) => Promise<UploadFileData>;
-  uploadFileFromURL: (
-    directoryName: string,
-    fileInput: {
-      fileLink: string;
-      fileName: string;
-      fileId?: string;
-      headers?: Record<string, unknown>;
-    },
-    unchainedAPI: Context,
-  ) => Promise<UploadFileData>;
-  createDownloadStream: (file: UploadedFile, unchainedAPI: Context) => Promise<Readable>;
-}
-export const FileAdapter: Omit<IFileAdapter, 'key' | 'label' | 'version'> = {
-  ...BaseAdapter,
-
-  async createSignedURL() {
-    throw new Error('Method not implemented');
-  },
-  async removeFiles() {
-    throw new Error('Method not implemented');
-  },
-  async createDownloadURL() {
-    throw new Error('Method not implemented');
-  },
-  async uploadFileFromStream() {
-    throw new Error('Method not implemented');
-  },
-  async createDownloadStream() {
-    throw new Error('Method not implemented');
-  },
-  async uploadFileFromURL() {
-    throw new Error('Method not implemented');
-  },
-};

package/src/director/FileDirector.ts

@@ -1,26 +0,0 @@
-import { BaseDirector } from '@unchainedshop/utils';
-import { IFileAdapter } from './FileAdapter.js';
-import { UploadedFile } from '../types.js';
-
-export type UploadFileCallback<UnchainedAPI = unknown> = (
-  file: UploadedFile,
-  unchainedAPI: UnchainedAPI,
-) => Promise<void>;
-
-const FileUploadRegistry = new Map<string, UploadFileCallback>();
-
-const baseDirector = BaseDirector<IFileAdapter>('FileDirector');
-
-export const FileDirector = {
-  ...baseDirector,
-
-  registerFileUploadCallback<UnchainedAPI>(directoryName: string, fn: UploadFileCallback<UnchainedAPI>) {
-    if (!FileUploadRegistry.has(directoryName)) {
-      FileUploadRegistry.set(directoryName, fn);
-    }
-  },
-
-  getFileUploadCallback(directoryName: string) {
-    return FileUploadRegistry.get(directoryName) || null;
-  },
-};

package/src/file-upload-index.test.ts

@@ -1,12 +0,0 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
-import buildHashedFilename from './build-hashed-filename.js';
-
-describe('File Uploader', () => {
-  it('Generate unique file name', async () => {
-    assert.equal(
-      await buildHashedFilename('root', 'file1.jpg', new Date(new Date('2022-12-04T17:13:09.285Z'))),
-      'NFJAbVaH6tRDuGDn4IPZYqh0AP-file1.jpg',
-    );
-  });
-});

package/src/file-upload-index.ts

@@ -1,7 +0,0 @@
-import buildHashedFilename from './build-hashed-filename.js';
-import resolveExpirationDate from './put-expiration.js';
-
-export { FileDirector } from './director/FileDirector.js';
-export { FileAdapter, IFileAdapter } from './director/FileAdapter.js';
-export { buildHashedFilename, resolveExpirationDate };
-export type * from './types.js';

package/src/put-expiration.ts

@@ -1,7 +0,0 @@
-const { UNCHAINED_PUT_URL_EXPIRY = '86400000' } = process.env;
-
-export const expiryOffsetInMs = () => parseInt(UNCHAINED_PUT_URL_EXPIRY, 10) || 24 * 60 * 60 * 1000;
-
-const resolveExpirationDate = () => new Date(new Date().getTime() + expiryOffsetInMs());
-
-export default resolveExpirationDate;

package/src/types.ts

@@ -1,19 +0,0 @@
-export interface UploadFileData {
-  _id: string;
-  directoryName: string;
-  expiryDate: Date | null;
-  fileName: string;
-  size?: number;
-  type: string;
-  url: string;
-}
-
-export interface UploadedFile {
-  _id: string;
-  path: string;
-  meta?: Record<string, unknown>;
-  name: string;
-  size?: number;
-  type?: string;
-  url?: string;
-}

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../shared/base.tsconfig.json",
-  "compilerOptions": {
-    "declarationDir": "./lib",
-    "rootDir": "./src",
-    "outDir": "./lib"
-  },
-  "exclude": ["**/*.test.ts", "**/*.test.js", "tests", "lib"]
-}