@nxgt/shared-storage 1.0.0

package/dist/services/gridfs.service.d.ts

@@ -0,0 +1,46 @@
+import type { CursorPaginationParams } from '@nxgt/shared/helpers';
+import { type mongo, mongoose } from '@nxgt/shared-mongo';
+export type GridFSBucketNames = 'avatars' | 'uploads' | 'images' | 'videos' | 'files' | string;
+export interface IBucketOptions {
+    bucketName?: GridFSBucketNames;
+    bucket?: mongoose.mongo.GridFSBucket;
+}
+export declare class GridFSService {
+    uploads: mongoose.mongo.GridFSBucket;
+    avatars: mongoose.mongo.GridFSBucket;
+    images: mongoose.mongo.GridFSBucket;
+    videos: mongoose.mongo.GridFSBucket;
+    files: mongoose.mongo.GridFSBucket;
+    buckets: Record<GridFSBucketNames, mongoose.mongo.GridFSBucket>;
+    constructor();
+    paginate(filter?: mongoose.mongo.Filter<mongoose.mongo.GridFSFile>, options?: CursorPaginationParams & IBucketOptions): Promise<{
+        data: mongo.GridFSFile[];
+        metadata: {
+            startCursor: string | null | undefined;
+            endCursor: string | null | undefined;
+            hasNextPage: boolean;
+            totalElements: number;
+        };
+    }>;
+    findById(id: string, options?: IBucketOptions): Promise<mongoose.mongo.GridFSFile | null>;
+    find(filter?: mongoose.mongo.Filter<mongoose.mongo.GridFSFile>, options?: mongoose.mongo.FindOptions & IBucketOptions): Promise<mongo.GridFSFile[]>;
+    delete(id: string, options?: IBucketOptions): Promise<void>;
+    download(id: string, { user, ...options }?: IBucketOptions & {
+        user?: string;
+    }): Promise<mongo.GridFSBucketReadStream>;
+    rename(id: string, name: string, { user, ...options }?: IBucketOptions & {
+        user?: string;
+    }): Promise<mongo.GridFSFile>;
+    upload(file: File, options?: IBucketOptions & {
+        metadata?: object;
+    }): Promise<mongo.ObjectId>;
+    private bucket;
+    /**
+     * Determines the category for a given file MIME type.
+     * This is a private helper method.
+     * @param mimetype The MIME type of the file.
+     * @returns A string representing the file type category (e.g., 'images', 'documents', 'other').
+     */
+    private resolveFileTypeCategory;
+}
+//# sourceMappingURL=gridfs.service.d.ts.map

package/dist/services/gridfs.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gridfs.service.d.ts","sourceRoot":"","sources":["../../src/services/gridfs.service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEnE,OAAO,EAAE,KAAK,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAM1D,MAAM,MAAM,iBAAiB,GAC1B,SAAS,GACT,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,MAAM,CAAC;AAEV,MAAM,WAAW,cAAc;IAC9B,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,MAAM,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC;CACrC;AAED,qBAAa,aAAa;IACzB,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC;IACrC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC;IACrC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC;IACpC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC;IACpC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC;IAEnC,OAAO,EAAE,MAAM,CAAC,iBAAiB,EAAE,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;;IA+B1D,QAAQ,CACb,MAAM,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,EACzD,OAAO,CAAC,EAAE,sBAAsB,GAAG,cAAc;;;;;;;;;IAiF5C,QAAQ,CACb,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GACtB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;IAOtC,IAAI,CACT,MAAM,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,EACzD,OAAO,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,WAAW,GAAG,cAAc;IAOhD,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3D,QAAQ,CACb,EAAE,EAAE,MAAM,EACV,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,GAAE,cAAc,GAAG;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO;IA0BxD,MAAM,CACX,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,GAAE,cAAc,GAAG;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO,GAC3D,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;IA8BtB,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE;IAmCzE,OAAO,CAAC,MAAM;IAed;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;CA+B/B"}

package/dist/services/index.d.ts

@@ -0,0 +1,5 @@
+export * from './create-lazy-storage';
+export * from './gridfs.service';
+export * from './minio.service';
+export * from './storage.service';
+//# sourceMappingURL=index.d.ts.map

package/dist/services/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC"}

package/dist/services/minio.service.d.ts

@@ -0,0 +1,43 @@
+import { Client, type ICopyDestinationOptions, type ICopySourceOptions, type ItemBucketMetadata, type RemoveOptions } from 'minio';
+type PreSignRequestParams = Record<string, string>;
+type PutObjectResult = Awaited<ReturnType<Client['putObject']>>;
+type CopyObjectResult = Awaited<ReturnType<Client['copyObject']>>;
+type ListObjectsResult = ReturnType<Client['listObjects']>;
+import { type S3ClientWriteBody } from './storage.service';
+export type MinioPutBody = Parameters<Client['putObject']>[2];
+export type GetObjectOptions = Parameters<Client['getObject']>[2];
+export type ListObjectQueryOptions = Parameters<Client['listObjects']>[3];
+export declare class MinioService {
+    minio: Client;
+    private bucket;
+    private logger;
+    constructor(bucket?: string);
+    ensureBucketExists(bucket?: string): Promise<void>;
+    convert(body: S3ClientWriteBody): Promise<MinioPutBody>;
+    putObject(key: string, body: MinioPutBody, size?: number, metadata?: ItemBucketMetadata): Promise<PutObjectResult>;
+    getObject(key: string, options?: GetObjectOptions): Promise<import("node:stream").Readable>;
+    fPutObject(key: string, filePath: string, metadata?: ItemBucketMetadata): Promise<PutObjectResult>;
+    fGetObject(key: string, filePath: string, options?: GetObjectOptions): Promise<void>;
+    findUploadId(key: string): Promise<string | undefined>;
+    copyObject(source: Omit<ICopySourceOptions, 'Bucket'> & {
+        Bucket?: string;
+    }, destination: Omit<ICopyDestinationOptions, 'Bucket'> & {
+        Bucket?: string;
+    }): Promise<CopyObjectResult>;
+    deleteObject(key: string, options?: RemoveOptions): Promise<void>;
+    listObjects(prefix?: string, recursive?: boolean, options?: ListObjectQueryOptions): Promise<ListObjectsResult>;
+    listObjectsV2(prefix?: string, recursive?: boolean, startAfter?: string): Promise<import("minio").BucketStream<import("minio").BucketItem>>;
+    /**
+     * Presigned GET URL supporting response-header overrides (e.g.
+     * `response-content-disposition`) — Bun's native `S3Client.presign()`
+     * (used by `StorageService.presing()`) has no equivalent, so callers that
+     * need per-request Content-Disposition/Content-Type overrides (attachment
+     * vs inline downloads) must go through this instead.
+     */
+    presignedGetObject(key: string, expiresIn?: number, respHeaders?: PreSignRequestParams): Promise<string>;
+    presignedPutObject(key: string, expiresIn?: number): Promise<string>;
+    bucketExists(bucket?: string): Promise<boolean>;
+    makeBucket(bucket?: string): Promise<void>;
+}
+export {};
+//# sourceMappingURL=minio.service.d.ts.map

package/dist/services/minio.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"minio.service.d.ts","sourceRoot":"","sources":["../../src/services/minio.service.ts"],"names":[],"mappings":"AAEA,OAAO,EACN,MAAM,EAGN,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAClB,MAAM,OAAO,CAAC;AAIf,KAAK,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAQnD,KAAK,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;AAChE,KAAK,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;AAClE,KAAK,iBAAiB,GAAG,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC;AAE3D,OAAO,EAAkB,KAAK,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE3E,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9D,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClE,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE1E,qBAAa,YAAY;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO,CAAC,MAAM,CAAe;gBAEjB,MAAM,CAAC,EAAE,MAAM;IAerB,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM;IAOlC,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC;IAyBvD,SAAS,CACd,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,YAAY,EAClB,IAAI,CAAC,EAAE,MAAM,EACb,QAAQ,GAAE,kBAAuB,GAC/B,OAAO,CAAC,eAAe,CAAC;IAKrB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB;IAKrD,UAAU,CACf,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,kBAAuB,GAC/B,OAAO,CAAC,eAAe,CAAC;IAOrB,UAAU,CACf,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,gBAAqB;IAQzB,YAAY,CAAC,GAAG,EAAE,MAAM;IAOxB,UAAU,CACf,MAAM,EAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,EAChE,WAAW,EAAE,IAAI,CAAC,uBAAuB,EAAE,QAAQ,CAAC,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GACxE,OAAO,CAAC,gBAAgB,CAAC;IAgBtB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAKjD,WAAW,CAChB,MAAM,GAAE,MAAW,EACnB,SAAS,GAAE,OAAe,EAC1B,OAAO,CAAC,EAAE,sBAAsB,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAOvB,aAAa,CAClB,MAAM,GAAE,MAAW,EACnB,SAAS,GAAE,OAAe,EAC1B,UAAU,CAAC,EAAE,MAAM;IAQpB;;;;;;OAMG;IACG,kBAAkB,CACvB,GAAG,EAAE,MAAM,EACX,SAAS,SAAmB,EAC5B,WAAW,GAAE,oBAAyB;IAajC,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,SAAmB;IAO5D,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM;IAK5B,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM;CAIhC"}

package/dist/services/storage.service.d.ts

@@ -0,0 +1,28 @@
+import { S3Client, type S3FilePresignOptions, type S3ListObjectsOptions, type S3Options } from 'bun';
+import { MinioService } from './minio.service';
+export declare const S3_CREDENTIALS: {
+    endpoint: string;
+    bucket: string;
+    accessKeyId: string;
+    secretAccessKey: string;
+};
+export type S3ClientWriteBody = Parameters<S3Client['write']>[1];
+export declare class StorageService {
+    s3: S3Client;
+    private bucket;
+    private logger;
+    minio: MinioService;
+    constructor(bucket?: string);
+    write(key: string, body: S3ClientWriteBody, options?: S3Options): Promise<number>;
+    list(input?: S3ListObjectsOptions, options?: S3Options): Promise<Bun.S3ListObjectsResponse>;
+    file(key: string, options?: S3Options): Bun.S3File;
+    exists(key: string, options?: S3Options): Promise<boolean>;
+    presing(key: string, options?: S3FilePresignOptions): string;
+    delete(key: string, options?: S3Options): Promise<void>;
+    size(key: string, options?: S3Options): Promise<number>;
+    stat(key: string, options?: S3Options): Promise<Bun.S3Stats>;
+    unlink(key: string, options?: S3Options): Promise<void>;
+    fetch(input: string, { bucket, ...options }?: BunFetchRequestInit & Pick<S3Options, 'bucket'>): Promise<Response>;
+    private ensureExists;
+}
+//# sourceMappingURL=storage.service.d.ts.map

package/dist/services/storage.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.service.d.ts","sourceRoot":"","sources":["../../src/services/storage.service.ts"],"names":[],"mappings":"AAGA,OAAO,EAEN,QAAQ,EACR,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,SAAS,EACd,MAAM,KAAK,CAAC;AAGb,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,eAAO,MAAM,cAAc;;;;;CAK1B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjE,qBAAa,cAAc;IAC1B,EAAE,EAAE,QAAQ,CAAC;IACb,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAe;IAC7B,KAAK,EAAE,YAAY,CAAC;gBAER,MAAM,CAAC,EAAE,MAAM;IAcrB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,GAAE,SAAc;IAYnE,IAAI,CAAC,KAAK,GAAE,oBAAyB,EAAE,OAAO,GAAE,SAAc;IAYpE,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,SAAc;IAYnC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,SAAc;IAYjD,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB;IAYjD,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,SAAc;IAa3C,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,SAAc;IAazC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,SAAc;IAazC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,SAAc;IAa3C,KAAK,CACV,KAAK,EAAE,MAAM,EACb,EACC,MAAM,EACN,GAAG,OAAO,EACV,GAAE,mBAAmB,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAM;YAoB1C,YAAY;CAO1B"}

package/package.json

@@ -0,0 +1,57 @@
+{
+	"name": "@nxgt/shared-storage",
+	"version": "1.0.0",
+	"license": "UNLICENSED",
+	"type": "module",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"files": [
+		"dist",
+		"README.md",
+		"package.json"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"default": "./dist/index.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/softistx/nxgt-core.git",
+		"directory": "packages/shared-storage"
+	},
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org",
+		"access": "public"
+	},
+	"scripts": {
+		"build": "bun run ../../build.ts",
+		"typecheck": "tsc --noEmit"
+	},
+	"nxgt": {
+		"entrypoints": [
+			"src/index.ts"
+		]
+	},
+	"dependencies": {
+		"@nxgt/i18n": "1.0.0",
+		"@nxgt/shared": "1.0.0",
+		"@nxgt/shared-exceptions": "1.0.0",
+		"@nxgt/shared-logging": "1.0.0",
+		"@nxgt/shared-mongo": "1.0.0",
+		"bson": "^7.3.2",
+		"lodash": "^4.18.1",
+		"minio": "^8.0.7",
+		"zod": "^4.4.3"
+	},
+	"devDependencies": {
+		"@types/bun": "^1.4.0",
+		"@types/lodash": "^4.17.25"
+	},
+	"peerDependencies": {
+		"typescript": "^6.0.3"
+	}
+}