@unchainedshop/file-upload 3.0.0-alpha3 → 3.0.0-alpha4

package/lib/director/FileAdapter.d.ts

@@ -1,20 +1,19 @@
-import { UnchainedCore } from '@unchainedshop/core';
-import { File, UploadFileData } from '@unchainedshop/core-files';
 import { Readable } from 'stream';
 import { IBaseAdapter } from '@unchainedshop/utils';
-export interface IFileAdapter extends IBaseAdapter {
-    createSignedURL: (directoryName: string, fileName: string, unchainedAPI: UnchainedCore) => Promise<(UploadFileData & {
+import { UploadedFile, UploadFileData } from '../types.js';
+export interface IFileAdapter<Context = unknown> extends IBaseAdapter {
+    createSignedURL: (directoryName: string, fileName: string, unchainedAPI: Context) => Promise<(UploadFileData & {
         putURL: string;
     }) | null>;
-    removeFiles: (files: Array<File>, unchainedContext: UnchainedCore) => Promise<void>;
-    uploadFileFromStream: (directoryName: string, rawFile: any, unchainedAPI: UnchainedCore) => Promise<UploadFileData | null>;
+    removeFiles: (files: Array<UploadedFile>, unchainedContext: Context) => Promise<void>;
+    uploadFileFromStream: (directoryName: string, rawFile: any, unchainedAPI: Context) => Promise<UploadFileData | null>;
     uploadFileFromURL: (directoryName: string, fileInput: {
         fileLink: string;
         fileName: string;
         fileId?: string;
         headers?: Record<string, unknown>;
-    }, unchainedAPI: UnchainedCore) => Promise<UploadFileData | null>;
-    createDownloadStream: (file: File, unchainedAPI: UnchainedCore) => Promise<Readable>;
+    }, unchainedAPI: Context) => Promise<UploadFileData | null>;
+    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.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FileAdapter.d.ts","sourceRoot":"","sources":["../../src/director/FileAdapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,eAAe,EAAE,CACf,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,aAAa,KACxB,OAAO,CAAC,CAAC,cAAc,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IAC3D,WAAW,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,gBAAgB,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpF,oBAAoB,EAAE,CACpB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,GAAG,EACZ,YAAY,EAAE,aAAa,KACxB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IACpC,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,aAAa,KACxB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IACpC,oBAAoB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,aAAa,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CACtF;AACD,eAAO,MAAM,WAAW,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,GAAG,OAAO,GAAG,SAAS,CA+BvE,CAAC"}
+{"version":3,"file":"FileAdapter.d.ts","sourceRoot":"","sources":["../../src/director/FileAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,MAAM,WAAW,YAAY,CAAC,OAAO,GAAG,OAAO,CAAE,SAAQ,YAAY;IACnE,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,KAAK,CAAC,YAAY,CAAC,EAAE,gBAAgB,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtF,oBAAoB,EAAE,CACpB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,GAAG,EACZ,YAAY,EAAE,OAAO,KAClB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IACpC,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,GAAG,IAAI,CAAC,CAAC;IACpC,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,CA+BvE,CAAC"}

package/lib/director/FileAdapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"FileAdapter.js","sourceRoot":"","sources":["../../src/director/FileAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AA8BtD,MAAM,CAAC,MAAM,WAAW,GAAoD;IAC1E,eAAe;QACb,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,WAAW;QACT,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC;IACD,oBAAoB;QAClB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IACD,oBAAoB;QAClB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IACD,iBAAiB;QACf,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,GAAG,CAAC,OAAe,EAAE,EAAE,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE;QAC9D,OAAO,GAAG,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF,CAAC"}
+{"version":3,"file":"FileAdapter.js","sourceRoot":"","sources":["../../src/director/FileAdapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AA4BtD,MAAM,CAAC,MAAM,WAAW,GAAoD;IAC1E,eAAe;QACb,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,WAAW;QACT,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC;IACD,oBAAoB;QAClB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IACD,oBAAoB;QAClB,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IACD,iBAAiB;QACf,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,GAAG,CAAC,OAAe,EAAE,EAAE,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE;QAC9D,OAAO,GAAG,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF,CAAC"}

package/lib/director/FileDirector.d.ts

@@ -1,15 +1,14 @@
-import { UnchainedCore } from '@unchainedshop/core';
-import { File } from '@unchainedshop/core-files';
 import { IFileAdapter } from './FileAdapter.js';
-export type UploadFileCallback = (file: File, unchainedAPI: UnchainedCore) => Promise<void>;
+import { UploadedFile } from '../types.js';
+export type UploadFileCallback<UnchainedAPI = unknown> = (file: UploadedFile, unchainedAPI: UnchainedAPI) => Promise<void>;
 export declare const FileDirector: {
-    registerFileUploadCallback(directoryName: string, fn: UploadFileCallback): void;
+    registerFileUploadCallback<UnchainedAPI>(directoryName: string, fn: UploadFileCallback<UnchainedAPI>): void;
     getFileUploadCallback(directoryName: string): UploadFileCallback;
     getAdapters: (options?: {
-        adapterFilter?: (adapter: IFileAdapter) => boolean;
-    }) => IFileAdapter[];
-    getAdapter: (key: string) => IFileAdapter;
-    registerAdapter: (A: IFileAdapter) => void;
+        adapterFilter?: (adapter: IFileAdapter<unknown>) => boolean;
+    }) => IFileAdapter<unknown>[];
+    getAdapter: (key: string) => IFileAdapter<unknown>;
+    registerAdapter: (A: IFileAdapter<unknown>) => void;
     unregisterAdapter: (key: string) => boolean;
 };
 //# sourceMappingURL=FileDirector.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"FileDirector.d.ts","sourceRoot":"","sources":["../../src/director/FileDirector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,aAAa,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAM5F,eAAO,MAAM,YAAY;8CAGmB,MAAM,MAAM,kBAAkB;yCAMnC,MAAM,GAAG,kBAAkB;;;;;;;CAGjE,CAAC"}
+{"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,GAAG,kBAAkB;;;;;;;CAGjE,CAAC"}

package/lib/director/FileDirector.js.map

@@ -1 +1 @@
-{"version":3,"file":"FileDirector.js","sourceRoot":"","sources":["../../src/director/FileDirector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAOpD,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,CAAC,aAAqB,EAAE,EAAsB;QACtE,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,CAAC;IAC/C,CAAC;CACF,CAAC"}
+{"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,CAAC;IAC/C,CAAC;CACF,CAAC"}

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

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

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

@@ -1 +1 @@
-{"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"}
+{"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;AACxD,OAAO,mBAAmB,MAAM,8BAA8B,CAAC;AAE/D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,CAAC;AAC3E,mBAAmB,YAAY,CAAC"}

package/lib/file-upload-index.js

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

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

@@ -1 +1 @@
-{"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"}
+{"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;AACxD,OAAO,mBAAmB,MAAM,8BAA8B,CAAC;AAE/D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAgB,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,CAAC"}

package/lib/get-file-from-file-data.d.ts

@@ -0,0 +1,13 @@
+import { UploadFileData } from './types.js';
+export declare const getFileFromFileData: (fileData: UploadFileData, meta: any) => {
+    _id: string;
+    path: string;
+    expires: Date;
+    name: string;
+    size: number;
+    type: string;
+    url: string;
+    meta: any;
+};
+export default getFileFromFileData;
+//# sourceMappingURL=get-file-from-file-data.d.ts.map

package/lib/get-file-from-file-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-file-from-file-data.d.ts","sourceRoot":"","sources":["../src/get-file-from-file-data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,eAAO,MAAM,mBAAmB,aAAc,cAAc,QAAQ,GAAG;;;;;;;;;CASrE,CAAC;AAEH,eAAe,mBAAmB,CAAC"}

package/lib/get-file-from-file-data.js

@@ -0,0 +1,12 @@
+export const getFileFromFileData = (fileData, meta) => ({
+    _id: fileData._id,
+    path: fileData.directoryName,
+    expires: fileData.expiryDate,
+    name: fileData.fileName,
+    size: fileData.size,
+    type: fileData.type || 'application/octet-stream',
+    url: fileData.url,
+    meta,
+});
+export default getFileFromFileData;
+//# sourceMappingURL=get-file-from-file-data.js.map

package/lib/get-file-from-file-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-file-from-file-data.js","sourceRoot":"","sources":["../src/get-file-from-file-data.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAwB,EAAE,IAAS,EAAE,EAAE,CAAC,CAAC;IAC3E,GAAG,EAAE,QAAQ,CAAC,GAAG;IACjB,IAAI,EAAE,QAAQ,CAAC,aAAa;IAC5B,OAAO,EAAE,QAAQ,CAAC,UAAU;IAC5B,IAAI,EAAE,QAAQ,CAAC,QAAQ;IACvB,IAAI,EAAE,QAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,QAAQ,CAAC,IAAI,IAAI,0BAA0B;IACjD,GAAG,EAAE,QAAQ,CAAC,GAAG;IACjB,IAAI;CACL,CAAC,CAAC;AAEH,eAAe,mBAAmB,CAAC"}

package/lib/types.d.ts

@@ -0,0 +1,21 @@
+export interface UploadFileData {
+    _id?: string;
+    directoryName: string;
+    expiryDate: Date;
+    fileName: string;
+    hash: string;
+    hashedName: 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;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,IAAI,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,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

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

package/lib/types.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unchainedshop/file-upload",
-  "version": "3.0.0-alpha3",
+  "version": "3.0.0-alpha4",
   "main": "lib/file-upload-index.js",
   "exports": {
     ".": "./lib/file-upload-index.js",
@@ -24,22 +24,25 @@
     "ecommerce",
     "core"
   ],
-  "author": "Joël Meiller",
+  "authors": [
+    "Joël Meiller",
+    "Pascal Kaufmann"
+  ],
   "license": "EUPL-1.2",
   "bugs": {
     "url": "https://github.com/unchainedshop/unchained/issues"
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/logger": "^3.0.0-alpha3",
-    "@unchainedshop/utils": "^3.0.0-alpha3",
+    "@unchainedshop/logger": "^3.0.0-alpha4",
+    "@unchainedshop/utils": "^3.0.0-alpha4",
     "base-x": "^5.0.0",
     "mime-types": "^2.1.35"
   },
   "devDependencies": {
-    "@types/node": "^22.5.5",
+    "@types/node": "^22.7.8",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
-    "typescript": "^5.6.2"
+    "typescript": "^5.6.3"
   }
 }

package/src/director/FileAdapter.ts

@@ -1,20 +1,19 @@
-import { log, LogLevel } from '@unchainedshop/logger';
-import { UnchainedCore } from '@unchainedshop/core';
-import { File, UploadFileData } from '@unchainedshop/core-files';
 import { Readable } from 'stream';
+import { log, LogLevel } from '@unchainedshop/logger';
 import { IBaseAdapter } from '@unchainedshop/utils';
+import { UploadedFile, UploadFileData } from '../types.js';
 
-export interface IFileAdapter extends IBaseAdapter {
+export interface IFileAdapter<Context = unknown> extends IBaseAdapter {
   createSignedURL: (
     directoryName: string,
     fileName: string,
-    unchainedAPI: UnchainedCore,
+    unchainedAPI: Context,
   ) => Promise<(UploadFileData & { putURL: string }) | null>;
-  removeFiles: (files: Array<File>, unchainedContext: UnchainedCore) => Promise<void>;
+  removeFiles: (files: Array<UploadedFile>, unchainedContext: Context) => Promise<void>;
   uploadFileFromStream: (
     directoryName: string,
     rawFile: any,
-    unchainedAPI: UnchainedCore,
+    unchainedAPI: Context,
   ) => Promise<UploadFileData | null>;
   uploadFileFromURL: (
     directoryName: string,
@@ -24,9 +23,9 @@ export interface IFileAdapter extends IBaseAdapter {
       fileId?: string;
       headers?: Record<string, unknown>;
     },
-    unchainedAPI: UnchainedCore,
+    unchainedAPI: Context,
   ) => Promise<UploadFileData | null>;
-  createDownloadStream: (file: File, unchainedAPI: UnchainedCore) => Promise<Readable>;
+  createDownloadStream: (file: UploadedFile, unchainedAPI: Context) => Promise<Readable>;
 }
 export const FileAdapter: Omit<IFileAdapter, 'key' | 'label' | 'version'> = {
   createSignedURL() {

package/src/director/FileDirector.ts

@@ -1,9 +1,11 @@
 import { BaseDirector } from '@unchainedshop/utils';
-import { UnchainedCore } from '@unchainedshop/core';
-import { File } from '@unchainedshop/core-files';
 import { IFileAdapter } from './FileAdapter.js';
+import { UploadedFile } from '../types.js';
 
-export type UploadFileCallback = (file: File, unchainedAPI: UnchainedCore) => Promise<void>;
+export type UploadFileCallback<UnchainedAPI = unknown> = (
+  file: UploadedFile,
+  unchainedAPI: UnchainedAPI,
+) => Promise<void>;
 
 const FileUploadRegistry = new Map<string, UploadFileCallback>();
 
@@ -12,7 +14,7 @@ const baseDirector = BaseDirector<IFileAdapter>('FileDirector');
 export const FileDirector = {
   ...baseDirector,
 
-  registerFileUploadCallback(directoryName: string, fn: UploadFileCallback) {
+  registerFileUploadCallback<UnchainedAPI>(directoryName: string, fn: UploadFileCallback<UnchainedAPI>) {
     if (!FileUploadRegistry.has(directoryName)) {
       FileUploadRegistry.set(directoryName, fn);
     }

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

@@ -1,8 +1,9 @@
-import buildHashedFilename from "./build-hashed-filename.js";
-
+import buildHashedFilename from './build-hashed-filename.js';
 
 describe('File Uploader', () => {
-  it('Generate unique file name', async () => {
-    expect(buildHashedFilename('root', 'file1.jpg', new Date(new Date("2022-12-04T17:13:09.285Z")))).toEqual("4hI2YuPDacR8ERoR7iM6cQ-file1.jpg")
+  it('Generate unique file name', () => {
+    expect(
+      buildHashedFilename('root', 'file1.jpg', new Date(new Date('2022-12-04T17:13:09.285Z'))),
+    ).toEqual('4hI2YuPDacR8ERoR7iM6cQ-file1.jpg');
   });
 });

package/src/file-upload-index.ts

@@ -1,6 +1,8 @@
 import buildHashedFilename from './build-hashed-filename.js';
 import resolveExpirationDate from './put-expiration.js';
+import getFileFromFileData from './get-file-from-file-data.js';
 
 export { FileDirector } from './director/FileDirector.js';
 export { FileAdapter, IFileAdapter } from './director/FileAdapter.js';
-export { buildHashedFilename, resolveExpirationDate };
+export { buildHashedFilename, resolveExpirationDate, getFileFromFileData };
+export type * from './types.js';

package/src/get-file-from-file-data.ts

@@ -0,0 +1,14 @@
+import { UploadFileData } from './types.js';
+
+export const getFileFromFileData = (fileData: UploadFileData, meta: any) => ({
+  _id: fileData._id,
+  path: fileData.directoryName,
+  expires: fileData.expiryDate,
+  name: fileData.fileName,
+  size: fileData.size,
+  type: fileData.type || 'application/octet-stream',
+  url: fileData.url,
+  meta,
+});
+
+export default getFileFromFileData;

package/src/types.ts

@@ -0,0 +1,21 @@
+export interface UploadFileData {
+  _id?: string;
+  directoryName: string;
+  expiryDate: Date;
+  fileName: string;
+  hash: string;
+  hashedName: 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;
+}