@unchainedshop/file-upload 2.5.12 → 2.6.1

package/lib/director/FileAdapter.d.ts

@@ -1,2 +1,19 @@
-import { IFileAdapter } from '@unchainedshop/types/files.js';
+/// <reference types="node" resolution-mode="require"/>
+import { IBaseAdapter } from '@unchainedshop/types/common.js';
+import { UnchainedCore } from '@unchainedshop/types/core.js';
+import { File, UploadFileData } from '@unchainedshop/types/files.js';
+import { Readable } from 'stream';
+export interface IFileAdapter extends IBaseAdapter {
+    createSignedURL: (directoryName: string, fileName: string, unchainedAPI: UnchainedCore) => Promise<(UploadFileData & {
+        putURL: string;
+    }) | null>;
+    removeFiles: (files: Array<File>, unchainedContext: UnchainedCore) => Promise<void>;
+    uploadFileFromStream: (directoryName: string, rawFile: any, unchainedAPI: UnchainedCore) => Promise<UploadFileData | null>;
+    uploadFileFromURL: (directoryName: string, fileInput: {
+        fileLink: string;
+        fileName: string;
+        headers?: Record<string, unknown>;
+    }, unchainedAPI: UnchainedCore) => Promise<UploadFileData | null>;
+    createDownloadStream: (file: File, unchainedAPI: UnchainedCore) => Promise<Readable>;
+}
 export declare const FileAdapter: Omit<IFileAdapter, 'key' | 'label' | 'version'>;

package/lib/director/FileAdapter.js

@@ -15,6 +15,11 @@ export const FileAdapter = {
             resolve(null);
         });
     },
+    createDownloadStream() {
+        return new Promise((resolve) => {
+            resolve(null);
+        });
+    },
     uploadFileFromURL() {
         return new Promise((resolve) => {
             resolve(null);

package/lib/director/FileAdapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"FileAdapter.js","sourceRoot":"","sources":["../../src/director/FileAdapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD,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,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":"AAAA,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAyBtD,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,2 +1,14 @@
-import { IFileDirector } from '@unchainedshop/types/files.js';
-export declare const FileDirector: IFileDirector;
+import { UnchainedCore } from '@unchainedshop/types/core.js';
+import { File } from '@unchainedshop/types/files.js';
+import { IFileAdapter } from './FileAdapter.js';
+export type UploadFileCallback = (file: File, unchainedAPI: UnchainedCore) => Promise<void>;
+export declare const FileDirector: {
+    registerFileUploadCallback(directoryName: string, fn: UploadFileCallback): void;
+    getFileUploadCallback(directoryName: string): UploadFileCallback;
+    getAdapters: (options?: {
+        adapterFilter?: (adapter: IFileAdapter) => boolean;
+    }) => IFileAdapter[];
+    getAdapter: (key: string) => IFileAdapter;
+    registerAdapter: (A: IFileAdapter) => void;
+    unregisterAdapter: (key: string) => boolean;
+};

package/lib/director/FileDirector.js.map

@@ -1 +1 @@
-{"version":3,"file":"FileDirector.js","sourceRoot":"","sources":["../../src/director/FileDirector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAA8B,CAAC;AAEjE,MAAM,YAAY,GAAG,YAAY,CAAe,cAAc,CAAC,CAAC;AAEhE,MAAM,CAAC,MAAM,YAAY,GAAkB;IACzC,GAAG,YAAY;IAEf,0BAA0B,CAAC,aAAa,EAAE,EAAE;QAC1C,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,aAAa;QACjC,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;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"}

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

@@ -1,5 +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';
+export { FileAdapter, IFileAdapter } from './director/FileAdapter.js';
 export { buildHashedFilename, resolveExpirationDate };

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,EAAE,MAAM,2BAA2B,CAAC;AACxD,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;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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unchainedshop/file-upload",
-  "version": "2.5.12",
+  "version": "2.6.1",
   "main": "lib/file-upload-index.js",
   "exports": {
     ".": "./lib/file-upload-index.js",
@@ -31,16 +31,16 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/logger": "^2.5.12",
-    "@unchainedshop/utils": "^2.5.12",
+    "@unchainedshop/logger": "^2.6.1",
+    "@unchainedshop/utils": "^2.6.1",
     "base-x": "4.0.0",
     "mime-types": "^2.1.35"
   },
   "devDependencies": {
-    "@types/node": "^20.10.1",
-    "@unchainedshop/types": "^2.5.12",
+    "@types/node": "^20.11.10",
+    "@unchainedshop/types": "^2.6.1",
     "jest": "^29.7.0",
-    "ts-jest": "^29.1.1",
-    "typescript": "^5.3.2"
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.3.3"
   }
 }

package/src/director/FileAdapter.ts

@@ -1,6 +1,28 @@
-import { IFileAdapter } from '@unchainedshop/types/files.js';
 import { log, LogLevel } from '@unchainedshop/logger';
+import { IBaseAdapter } from '@unchainedshop/types/common.js';
+import { UnchainedCore } from '@unchainedshop/types/core.js';
+import { File, UploadFileData } from '@unchainedshop/types/files.js';
+import { Readable } from 'stream';
 
+export interface IFileAdapter extends IBaseAdapter {
+  createSignedURL: (
+    directoryName: string,
+    fileName: string,
+    unchainedAPI: UnchainedCore,
+  ) => Promise<(UploadFileData & { putURL: string }) | null>;
+  removeFiles: (files: Array<File>, unchainedContext: UnchainedCore) => Promise<void>;
+  uploadFileFromStream: (
+    directoryName: string,
+    rawFile: any,
+    unchainedAPI: UnchainedCore,
+  ) => Promise<UploadFileData | null>;
+  uploadFileFromURL: (
+    directoryName: string,
+    fileInput: { fileLink: string; fileName: string; headers?: Record<string, unknown> },
+    unchainedAPI: UnchainedCore,
+  ) => Promise<UploadFileData | null>;
+  createDownloadStream: (file: File, unchainedAPI: UnchainedCore) => Promise<Readable>;
+}
 export const FileAdapter: Omit<IFileAdapter, 'key' | 'label' | 'version'> = {
   createSignedURL() {
     return new Promise<null>((resolve) => {
@@ -18,6 +40,11 @@ export const FileAdapter: Omit<IFileAdapter, 'key' | 'label' | 'version'> = {
       resolve(null);
     });
   },
+  createDownloadStream() {
+    return new Promise<null>((resolve) => {
+      resolve(null);
+    });
+  },
   uploadFileFromURL() {
     return new Promise<null>((resolve) => {
       resolve(null);

package/src/director/FileDirector.ts

@@ -1,20 +1,24 @@
-import { IFileAdapter, IFileDirector, UploadFileCallback } from '@unchainedshop/types/files.js';
 import { BaseDirector } from '@unchainedshop/utils';
+import { UnchainedCore } from '@unchainedshop/types/core.js';
+import { File } from '@unchainedshop/types/files.js';
+import { IFileAdapter } from './FileAdapter.js';
+
+export type UploadFileCallback = (file: File, unchainedAPI: UnchainedCore) => Promise<void>;
 
 const FileUploadRegistry = new Map<string, UploadFileCallback>();
 
 const baseDirector = BaseDirector<IFileAdapter>('FileDirector');
 
-export const FileDirector: IFileDirector = {
+export const FileDirector = {
   ...baseDirector,
 
-  registerFileUploadCallback(directoryName, fn) {
+  registerFileUploadCallback(directoryName: string, fn: UploadFileCallback) {
     if (!FileUploadRegistry.has(directoryName)) {
       FileUploadRegistry.set(directoryName, fn);
     }
   },
 
-  getFileUploadCallback(directoryName) {
+  getFileUploadCallback(directoryName: string): UploadFileCallback {
     return FileUploadRegistry.get(directoryName);
   },
 };

package/src/file-upload-index.ts

@@ -2,5 +2,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';
+export { FileAdapter, IFileAdapter } from './director/FileAdapter.js';
 export { buildHashedFilename, resolveExpirationDate };