@quanticjs/files-client 3.4.0

package/dist/files-client.d.ts

@@ -0,0 +1,14 @@
+import { HttpService } from '@nestjs/axios';
+import type { RequestUploadParams, FileUploadResponse, FileConfirmResponse, FileDownloadResponse, ListFilesParams, FileListResponse, InitiateMultipartParams, MultipartInitResponse, SignPartParams, MultipartSignResponse, CompleteMultipartParams } from './types';
+export declare class FilesClient {
+    private readonly http;
+    constructor(http: HttpService);
+    requestUploadUrl(organizationId: string, params: RequestUploadParams): Promise<FileUploadResponse>;
+    confirmUpload(organizationId: string, fileId: string): Promise<FileConfirmResponse>;
+    getDownloadUrl(organizationId: string, fileId: string): Promise<FileDownloadResponse>;
+    listFiles(organizationId: string, params?: ListFilesParams): Promise<FileListResponse>;
+    deleteFile(organizationId: string, fileId: string): Promise<void>;
+    initiateMultipart(organizationId: string, params: InitiateMultipartParams): Promise<MultipartInitResponse>;
+    signPart(organizationId: string, fileId: string, params: SignPartParams): Promise<MultipartSignResponse>;
+    completeMultipart(organizationId: string, fileId: string, params: CompleteMultipartParams): Promise<FileConfirmResponse>;
+}

package/dist/files-client.js

@@ -0,0 +1,71 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilesClient = void 0;
+const common_1 = require("@nestjs/common");
+const axios_1 = require("@nestjs/axios");
+const rxjs_1 = require("rxjs");
+const ORG_HEADER = 'x-organization-id';
+let FilesClient = class FilesClient {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    async requestUploadUrl(organizationId, params) {
+        const { data } = await (0, rxjs_1.firstValueFrom)(this.http.post('/files/upload-url', params, {
+            headers: { [ORG_HEADER]: organizationId },
+        }));
+        return data;
+    }
+    async confirmUpload(organizationId, fileId) {
+        const { data } = await (0, rxjs_1.firstValueFrom)(this.http.post(`/files/${fileId}/confirm`, {}, {
+            headers: { [ORG_HEADER]: organizationId },
+        }));
+        return data;
+    }
+    async getDownloadUrl(organizationId, fileId) {
+        const { data } = await (0, rxjs_1.firstValueFrom)(this.http.get(`/files/${fileId}/download-url`, {
+            headers: { [ORG_HEADER]: organizationId },
+        }));
+        return data;
+    }
+    async listFiles(organizationId, params) {
+        const { data } = await (0, rxjs_1.firstValueFrom)(this.http.get('/files', {
+            headers: { [ORG_HEADER]: organizationId },
+            params,
+        }));
+        return data;
+    }
+    async deleteFile(organizationId, fileId) {
+        await (0, rxjs_1.firstValueFrom)(this.http.delete(`/files/${fileId}`, {
+            headers: { [ORG_HEADER]: organizationId },
+        }));
+    }
+    async initiateMultipart(organizationId, params) {
+        const { data } = await (0, rxjs_1.firstValueFrom)(this.http.post('/files/multipart/initiate', params, {
+            headers: { [ORG_HEADER]: organizationId },
+        }));
+        return data;
+    }
+    async signPart(organizationId, fileId, params) {
+        const { data } = await (0, rxjs_1.firstValueFrom)(this.http.post(`/files/multipart/${fileId}/sign-part`, params, { headers: { [ORG_HEADER]: organizationId } }));
+        return data;
+    }
+    async completeMultipart(organizationId, fileId, params) {
+        const { data } = await (0, rxjs_1.firstValueFrom)(this.http.post(`/files/multipart/${fileId}/complete`, params, { headers: { [ORG_HEADER]: organizationId } }));
+        return data;
+    }
+};
+exports.FilesClient = FilesClient;
+exports.FilesClient = FilesClient = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [axios_1.HttpService])
+], FilesClient);

package/dist/files-client.module.d.ts

@@ -0,0 +1,5 @@
+import { DynamicModule } from '@nestjs/common';
+import type { FilesClientOptions } from './types';
+export declare class FilesClientModule {
+    static forRoot(options: FilesClientOptions): DynamicModule;
+}

package/dist/files-client.module.js

@@ -0,0 +1,32 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var FilesClientModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilesClientModule = void 0;
+const common_1 = require("@nestjs/common");
+const axios_1 = require("@nestjs/axios");
+const files_client_1 = require("./files-client");
+let FilesClientModule = FilesClientModule_1 = class FilesClientModule {
+    static forRoot(options) {
+        return {
+            module: FilesClientModule_1,
+            imports: [
+                axios_1.HttpModule.register({
+                    baseURL: options.url,
+                    timeout: options.timeout ?? 10_000,
+                }),
+            ],
+            providers: [files_client_1.FilesClient],
+            exports: [files_client_1.FilesClient],
+        };
+    }
+};
+exports.FilesClientModule = FilesClientModule;
+exports.FilesClientModule = FilesClientModule = FilesClientModule_1 = __decorate([
+    (0, common_1.Module)({})
+], FilesClientModule);

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { FilesClientModule } from './files-client.module';
+export { FilesClient } from './files-client';
+export { type FilesClientOptions, FileStatus, type FileDto, type RequestUploadParams, type FileUploadResponse, type FileConfirmResponse, type FileDownloadResponse, type ListFilesParams, type FileListResponse, type InitiateMultipartParams, type MultipartInitResponse, type SignPartParams, type MultipartSignResponse, type CompleteMultipartParams, } from './types';

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileStatus = exports.FilesClient = exports.FilesClientModule = void 0;
+var files_client_module_1 = require("./files-client.module");
+Object.defineProperty(exports, "FilesClientModule", { enumerable: true, get: function () { return files_client_module_1.FilesClientModule; } });
+var files_client_1 = require("./files-client");
+Object.defineProperty(exports, "FilesClient", { enumerable: true, get: function () { return files_client_1.FilesClient; } });
+var types_1 = require("./types");
+Object.defineProperty(exports, "FileStatus", { enumerable: true, get: function () { return types_1.FileStatus; } });

package/dist/types.d.ts

@@ -0,0 +1,79 @@
+export interface FilesClientOptions {
+    url: string;
+    timeout?: number;
+}
+export declare enum FileStatus {
+    Uploading = "uploading",
+    Ready = "ready",
+    Quarantined = "quarantined"
+}
+export interface FileDto {
+    id: string;
+    name: string;
+    contentType: string;
+    size: number;
+    status: string;
+    ownerId: string;
+    createdAt: string;
+}
+export interface RequestUploadParams {
+    fileName: string;
+    contentType: string;
+}
+export interface FileUploadResponse {
+    fileId: string;
+    uploadUrl: string;
+    headers: Record<string, string>;
+    expiresAt: string;
+}
+export interface FileConfirmResponse {
+    fileId: string;
+    fileName: string;
+    size: number;
+}
+export interface FileDownloadResponse {
+    url: string;
+    fileName: string;
+    contentType: string;
+    size: number;
+    expiresAt: string;
+}
+export interface ListFilesParams {
+    page?: number;
+    limit?: number;
+    search?: string;
+    status?: FileStatus;
+}
+export interface FileListResponse {
+    items: FileDto[];
+    total: number;
+    page: number;
+    totalPages: number;
+}
+export interface InitiateMultipartParams {
+    fileName: string;
+    contentType: string;
+    totalSize: number;
+}
+export interface MultipartInitResponse {
+    fileId: string;
+    uploadId: string;
+    partSize: number;
+    totalParts: number;
+}
+export interface SignPartParams {
+    uploadId: string;
+    partNumber: number;
+}
+export interface MultipartSignResponse {
+    partNumber: number;
+    uploadUrl: string;
+    expiresAt: string;
+}
+export interface CompleteMultipartParams {
+    uploadId: string;
+    parts: {
+        partNumber: number;
+        etag: string;
+    }[];
+}

package/dist/types.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileStatus = void 0;
+var FileStatus;
+(function (FileStatus) {
+    FileStatus["Uploading"] = "uploading";
+    FileStatus["Ready"] = "ready";
+    FileStatus["Quarantined"] = "quarantined";
+})(FileStatus || (exports.FileStatus = FileStatus = {}));

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@quanticjs/files-client",
+  "version": "3.4.0",
+  "description": "Typed HTTP client for quanticjs-file-service",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "jest --passWithNoTests",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "@nestjs/axios": "^4.0.0",
+    "axios": "^1.6.0"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^10.0.0 || ^11.0.0",
+    "@nestjs/core": "^10.0.0 || ^11.0.0",
+    "rxjs": "^7.0.0"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.0",
+    "jest": "^29.7.0",
+    "rxjs": "^7.8.1",
+    "ts-jest": "^29.2.0",
+    "typescript": "^5.5.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/quanticjs/quanticjs-backend.git",
+    "directory": "packages/files-client"
+  }
+}