@ackplus/nest-file-storage 0.0.2

package/dist/lib/types.d.ts

@@ -0,0 +1,91 @@
+import { ModuleMetadata, Type } from '@nestjs/common';
+import { Request } from 'express';
+export declare enum FileStorageEnum {
+    LOCAL = "local",
+    S3 = "s3",
+    AZURE = "azure"
+}
+export interface FileStorageOptions {
+    prefix?: string;
+    fileName?: (file: any, req: Request) => string;
+    fileDist?: (file: any, req: Request) => string;
+    transformUploadedFileObject?: (file: any) => any;
+}
+export interface S3StorageOptions extends FileStorageOptions {
+    accessKeyId: string;
+    secretAccessKey: string;
+    region: string;
+    bucket: string;
+    endpoint?: string;
+    cloudFrontUrl?: string;
+}
+export interface LocalStorageOptions extends FileStorageOptions {
+    rootPath: string;
+    baseUrl: string;
+}
+export interface AzureStorageOptions extends FileStorageOptions {
+    account: string;
+    accountKey: string;
+    container: string;
+}
+export type StorageOptions = S3StorageOptions | AzureStorageOptions | LocalStorageOptions;
+export type FileStorageConfigOptions = {
+    storage: FileStorageEnum.LOCAL;
+    localConfig: LocalStorageOptions;
+} | {
+    storage: FileStorageEnum.S3;
+    s3Config: S3StorageOptions;
+} | {
+    storage: FileStorageEnum.AZURE;
+    azureConfig: AzureStorageOptions;
+};
+export interface FileStorageClassOptions {
+    storageFactory: () => Promise<new (...args: any[]) => Storage> | (new (...args: any[]) => Storage);
+    options?: any;
+}
+export type FileStorageModuleOptions = FileStorageConfigOptions | FileStorageClassOptions;
+export interface FileStorageAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    /**
+     * The `useExisting` syntax allows you to create aliases for existing providers.
+     */
+    useExisting?: Type<FileStorageOptionsFactory>;
+    /**
+     * The `useClass` syntax allows you to dynamically determine a class
+     * that a token should resolve to.
+     */
+    useClass?: Type<FileStorageOptionsFactory>;
+    /**
+     * The `useFactory` syntax allows for creating providers dynamically.
+     */
+    useFactory?: (...args: any[]) => Promise<FileStorageModuleOptions> | FileStorageModuleOptions;
+    /**
+     * Optional list of providers to be injected into the context of the Factory function.
+     */
+    inject?: any[];
+}
+export interface FileStorageOptionsFactory {
+    createFileStorageOptions(): Promise<FileStorageModuleOptions> | FileStorageModuleOptions;
+}
+export interface UploadedFile {
+    fieldName?: string;
+    fieldname?: string;
+    fileName: string;
+    originalName: string;
+    size: number;
+    mimetype?: string;
+    buffer?: Buffer;
+    key: string;
+    url: string;
+    fullPath: string;
+    encoding?: string;
+}
+export interface Storage {
+    getFile(key: string): Promise<Buffer> | Buffer;
+    deleteFile(key: string): Promise<void> | void;
+    putFile(fileContent: Buffer, key: string): Promise<UploadedFile> | UploadedFile;
+    path?(filePath: string): Promise<string> | string;
+    getUrl(key: string): Promise<string> | string;
+    getSignedUrl?(key: string, options: any): Promise<string> | string;
+    copyFile(oldKey: string, newKey: string): Promise<UploadedFile>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC,oBAAY,eAAe;IACvB,KAAK,UAAU;IACf,EAAE,OAAO;IACT,KAAK,UAAU;CAClB;AAED,MAAM,WAAW,kBAAkB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,KAAK,MAAM,CAAC;IAC/C,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,KAAK,MAAM,CAAC;IAC/C,2BAA2B,CAAC,EAAE,CAAC,IAAI,KAAA,KAAK,GAAG,CAAC;CAC/C;AAED,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IACxD,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC3D,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC3D,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAG1F,MAAM,MAAM,wBAAwB,GAC9B;IAAE,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC;IAAC,WAAW,EAAE,mBAAmB,CAAC;CAAE,GACrE;IAAE,OAAO,EAAE,eAAe,CAAC,EAAE,CAAC;IAAC,QAAQ,EAAE,gBAAgB,CAAC;CAAE,GAC5D;IAAE,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC;IAAC,WAAW,EAAE,mBAAmB,CAAC;CAAE,CAAC;AAG5E,MAAM,WAAW,uBAAuB;IACpC,cAAc,EAAE,MAAM,OAAO,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,CAAC;IACnG,OAAO,CAAC,EAAE,GAAG,CAAC;CACjB;AAGD,MAAM,MAAM,wBAAwB,GAAG,wBAAwB,GAAG,uBAAuB,CAAC;AAG1F,MAAM,WAAW,uBAAwB,SAAQ,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC;IAC5E;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAC9C;;;OAGG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAC3C;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,wBAAwB,CAAC,GAAG,wBAAwB,CAAC;IAC9F;;OAEG;IACH,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACtC,wBAAwB,IAAI,OAAO,CAAC,wBAAwB,CAAC,GAAG,wBAAwB,CAAC;CAC5F;AAGD,MAAM,WAAW,YAAY;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,OAAO;IACpB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC/C,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC9C,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC;IAChF,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAClD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC9C,YAAY,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IACnE,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;CAClE"}

package/dist/lib/types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileStorageEnum = void 0;
+var FileStorageEnum;
+(function (FileStorageEnum) {
+    FileStorageEnum["LOCAL"] = "local";
+    FileStorageEnum["S3"] = "s3";
+    FileStorageEnum["AZURE"] = "azure";
+})(FileStorageEnum || (exports.FileStorageEnum = FileStorageEnum = {}));
+//# sourceMappingURL=types.js.map

package/dist/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":";;;AAIA,IAAY,eAIX;AAJD,WAAY,eAAe;IACvB,kCAAe,CAAA;IACf,4BAAS,CAAA;IACT,kCAAe,CAAA;AACnB,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@ackplus/nest-file-storage",
+  "version": "0.0.2",
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ack-solutions/packages.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/ack-solutions/packages.git#readme",
+  "peerDependencies": {
+    "typeorm": "^0.3.23",
+    "@nestjs/typeorm": "^11.0.0",
+    "@nestjs/common": "^10.0.0 || ^11.0.0",
+    "@nestjs/core": "^10.0.0 || ^11.0.0",
+    "@azure/storage-blob": "^12.0.0",
+    "@aws-sdk/client-s3": "^3.0.0",
+    "@aws-sdk/s3-request-presigner": "^3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@azure/storage-blob": {
+      "optional": true
+    },
+    "@aws-sdk/client-s3": {
+      "optional": true
+    },
+    "@aws-sdk/s3-request-presigner": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "typeorm": "^0.3.23",
+    "@nestjs/typeorm": "^11.0.0",
+    "@nestjs/common": "^11.1.3",
+    "@nestjs/core": "^11.1.3",
+    "@types/multer": "^2.0.0",
+    "@types/node": "^20.0.0",
+    "@types/uuid": "^9.0.0",
+    "@types/concat-stream": "^2.0.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0",
+    "deepmerge": "4.3.1",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
+    "pluralize": "8.0.0",
+    "lodash": "^4.17.21",
+    "rxjs": "^7.8.0",
+    "multer": "^2.0.1",
+    "moment": "^2.30.1",
+    "uuid": "^9.0.0",
+    "concat-stream": "^2.0.0"
+  },
+  "scripts": {
+    "build": "pnpm run clean && tsc -p tsconfig.lib.json",
+    "clean": "rimraf dist",
+    "dev": "tsc -p tsconfig.lib.json --watch --preserveWatchOutput"
+  }
+}