@quanticjs/files-client 4.0.0 → 4.1.0

package/dist/files-client.d.ts

@@ -1,14 +1,21 @@
 import { HttpService } from '@nestjs/axios';
-import type { RequestUploadParams, FileUploadResponse, FileConfirmResponse, FileDownloadResponse, ListFilesParams, FileListResponse, InitiateMultipartParams, MultipartInitResponse, SignPartParams, MultipartSignResponse, CompleteMultipartParams } from './types';
+import type { KeycloakTokenProvider } from './keycloak-token-provider';
+import type { RequestUploadParams, FileUploadResponse, FileConfirmResponse, FileDownloadResponse, ListFilesParams, FileListResponse, InitiateMultipartParams, MultipartInitResponse, SignPartParams, MultipartSignResponse, CompleteMultipartParams, GrantAccessParams, BatchGrantAccessParams } 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>;
+    private readonly tokenProvider?;
+    constructor(http: HttpService, tokenProvider?: KeycloakTokenProvider | undefined);
+    private headers;
+    private resolveToken;
+    requestUploadUrl(organizationId: string, authToken: string, params: RequestUploadParams): Promise<FileUploadResponse>;
+    confirmUpload(organizationId: string, authToken: string, fileId: string): Promise<FileConfirmResponse>;
+    getDownloadUrl(organizationId: string, authToken: string, fileId: string): Promise<FileDownloadResponse>;
+    listFiles(organizationId: string, authToken: string, params?: ListFilesParams): Promise<FileListResponse>;
+    deleteFile(organizationId: string, authToken: string, fileId: string): Promise<void>;
+    grantAccess(organizationId: string, fileId: string, params: GrantAccessParams, authToken?: string): Promise<void>;
+    grantAccessBatch(organizationId: string, fileId: string, params: BatchGrantAccessParams, authToken?: string): Promise<void>;
+    revokeAccess(organizationId: string, fileId: string, granteeType: string, granteeId: string, authToken?: string): Promise<void>;
+    initiateMultipart(organizationId: string, authToken: string, params: InitiateMultipartParams): Promise<MultipartInitResponse>;
+    signPart(organizationId: string, authToken: string, fileId: string, params: SignPartParams): Promise<MultipartSignResponse>;
+    completeMultipart(organizationId: string, authToken: string, fileId: string, params: CompleteMultipartParams): Promise<FileConfirmResponse>;
 }

package/dist/files-client.js

@@ -8,64 +8,103 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
 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';
+const TOKEN_PROVIDER = 'KEYCLOAK_TOKEN_PROVIDER';
 let FilesClient = class FilesClient {
     http;
-    constructor(http) {
+    tokenProvider;
+    constructor(http, tokenProvider) {
         this.http = http;
+        this.tokenProvider = tokenProvider;
+    }
+    headers(organizationId, authToken) {
+        return {
+            [ORG_HEADER]: organizationId,
+            Authorization: authToken,
+        };
+    }
+    async resolveToken(authToken) {
+        if (authToken)
+            return authToken;
+        if (this.tokenProvider)
+            return this.tokenProvider.getToken();
+        throw new Error('No authToken provided and no serviceAccount configured in FilesClientModule');
     }
-    async requestUploadUrl(organizationId, params) {
+    async requestUploadUrl(organizationId, authToken, params) {
         const { data } = await (0, rxjs_1.firstValueFrom)(this.http.post('/files/upload-url', params, {
-            headers: { [ORG_HEADER]: organizationId },
+            headers: this.headers(organizationId, authToken),
         }));
         return data;
     }
-    async confirmUpload(organizationId, fileId) {
+    async confirmUpload(organizationId, authToken, fileId) {
         const { data } = await (0, rxjs_1.firstValueFrom)(this.http.post(`/files/${fileId}/confirm`, {}, {
-            headers: { [ORG_HEADER]: organizationId },
+            headers: this.headers(organizationId, authToken),
         }));
         return data;
     }
-    async getDownloadUrl(organizationId, fileId) {
+    async getDownloadUrl(organizationId, authToken, fileId) {
         const { data } = await (0, rxjs_1.firstValueFrom)(this.http.get(`/files/${fileId}/download-url`, {
-            headers: { [ORG_HEADER]: organizationId },
+            headers: this.headers(organizationId, authToken),
         }));
         return data;
     }
-    async listFiles(organizationId, params) {
+    async listFiles(organizationId, authToken, params) {
         const { data } = await (0, rxjs_1.firstValueFrom)(this.http.get('/files', {
-            headers: { [ORG_HEADER]: organizationId },
+            headers: this.headers(organizationId, authToken),
             params,
         }));
         return data;
     }
-    async deleteFile(organizationId, fileId) {
+    async deleteFile(organizationId, authToken, fileId) {
         await (0, rxjs_1.firstValueFrom)(this.http.delete(`/files/${fileId}`, {
-            headers: { [ORG_HEADER]: organizationId },
+            headers: this.headers(organizationId, authToken),
+        }));
+    }
+    async grantAccess(organizationId, fileId, params, authToken) {
+        const token = await this.resolveToken(authToken);
+        await (0, rxjs_1.firstValueFrom)(this.http.post(`/files/${fileId}/grants`, params, {
+            headers: this.headers(organizationId, token),
+        }));
+    }
+    async grantAccessBatch(organizationId, fileId, params, authToken) {
+        const token = await this.resolveToken(authToken);
+        await (0, rxjs_1.firstValueFrom)(this.http.post(`/files/${fileId}/grants/batch`, params, {
+            headers: this.headers(organizationId, token),
+        }));
+    }
+    async revokeAccess(organizationId, fileId, granteeType, granteeId, authToken) {
+        const token = await this.resolveToken(authToken);
+        await (0, rxjs_1.firstValueFrom)(this.http.delete(`/files/${fileId}/grants/${granteeType}/${granteeId}`, {
+            headers: this.headers(organizationId, token),
         }));
     }
-    async initiateMultipart(organizationId, params) {
+    async initiateMultipart(organizationId, authToken, params) {
         const { data } = await (0, rxjs_1.firstValueFrom)(this.http.post('/files/multipart/initiate', params, {
-            headers: { [ORG_HEADER]: organizationId },
+            headers: this.headers(organizationId, authToken),
         }));
         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 } }));
+    async signPart(organizationId, authToken, fileId, params) {
+        const { data } = await (0, rxjs_1.firstValueFrom)(this.http.post(`/files/multipart/${fileId}/sign-part`, params, { headers: this.headers(organizationId, authToken) }));
         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 } }));
+    async completeMultipart(organizationId, authToken, fileId, params) {
+        const { data } = await (0, rxjs_1.firstValueFrom)(this.http.post(`/files/multipart/${fileId}/complete`, params, { headers: this.headers(organizationId, authToken) }));
         return data;
     }
 };
 exports.FilesClient = FilesClient;
 exports.FilesClient = FilesClient = __decorate([
     (0, common_1.Injectable)(),
-    __metadata("design:paramtypes", [axios_1.HttpService])
+    __param(1, (0, common_1.Optional)()),
+    __param(1, (0, common_1.Inject)(TOKEN_PROVIDER)),
+    __metadata("design:paramtypes", [axios_1.HttpService, Function])
 ], FilesClient);

package/dist/files-client.module.js

@@ -11,8 +11,17 @@ exports.FilesClientModule = void 0;
 const common_1 = require("@nestjs/common");
 const axios_1 = require("@nestjs/axios");
 const files_client_1 = require("./files-client");
+const keycloak_token_provider_1 = require("./keycloak-token-provider");
+const TOKEN_PROVIDER = 'KEYCLOAK_TOKEN_PROVIDER';
 let FilesClientModule = FilesClientModule_1 = class FilesClientModule {
     static forRoot(options) {
+        const providers = [files_client_1.FilesClient];
+        if (options.serviceAccount) {
+            providers.push({
+                provide: TOKEN_PROVIDER,
+                useValue: new keycloak_token_provider_1.KeycloakTokenProvider(options.serviceAccount),
+            });
+        }
         return {
             module: FilesClientModule_1,
             imports: [
@@ -21,7 +30,7 @@ let FilesClientModule = FilesClientModule_1 = class FilesClientModule {
                     timeout: options.timeout ?? 10_000,
                 }),
             ],
-            providers: [files_client_1.FilesClient],
+            providers,
             exports: [files_client_1.FilesClient],
         };
     }

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 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';
+export { KeycloakTokenProvider, type ServiceAccountConfig } from './keycloak-token-provider';
+export { type FilesClientOptions, FileStatus, FilePermission, GranteeType, type FileDto, type RequestUploadParams, type FileUploadResponse, type FileConfirmResponse, type FileDownloadResponse, type ListFilesParams, type FileListResponse, type InitiateMultipartParams, type MultipartInitResponse, type SignPartParams, type MultipartSignResponse, type CompleteMultipartParams, type GrantAccessParams, type GrantEntry, type BatchGrantAccessParams, } from './types';

package/dist/index.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileStatus = exports.FilesClient = exports.FilesClientModule = void 0;
+exports.GranteeType = exports.FilePermission = exports.FileStatus = exports.KeycloakTokenProvider = 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 keycloak_token_provider_1 = require("./keycloak-token-provider");
+Object.defineProperty(exports, "KeycloakTokenProvider", { enumerable: true, get: function () { return keycloak_token_provider_1.KeycloakTokenProvider; } });
 var types_1 = require("./types");
 Object.defineProperty(exports, "FileStatus", { enumerable: true, get: function () { return types_1.FileStatus; } });
+Object.defineProperty(exports, "FilePermission", { enumerable: true, get: function () { return types_1.FilePermission; } });
+Object.defineProperty(exports, "GranteeType", { enumerable: true, get: function () { return types_1.GranteeType; } });

package/dist/keycloak-token-provider.d.ts

@@ -0,0 +1,13 @@
+export interface ServiceAccountConfig {
+    issuerUrl: string;
+    clientId: string;
+    clientSecret: string;
+    scopes?: string[];
+}
+export declare class KeycloakTokenProvider {
+    private readonly config;
+    private cachedToken;
+    private expiresAt;
+    constructor(config: ServiceAccountConfig);
+    getToken(): Promise<string>;
+}

package/dist/keycloak-token-provider.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeycloakTokenProvider = void 0;
+const axios_1 = __importDefault(require("axios"));
+class KeycloakTokenProvider {
+    config;
+    cachedToken = null;
+    expiresAt = 0;
+    constructor(config) {
+        this.config = config;
+    }
+    async getToken() {
+        if (this.cachedToken && Date.now() < this.expiresAt) {
+            return this.cachedToken;
+        }
+        const tokenUrl = `${this.config.issuerUrl}/protocol/openid-connect/token`;
+        const params = new URLSearchParams({
+            grant_type: 'client_credentials',
+            client_id: this.config.clientId,
+            client_secret: this.config.clientSecret,
+        });
+        if (this.config.scopes?.length) {
+            params.set('scope', this.config.scopes.join(' '));
+        }
+        const { data } = await axios_1.default.post(tokenUrl, params.toString(), { headers: { 'Content-Type': 'application/x-www-form-urlencoded' } });
+        this.cachedToken = `Bearer ${data.access_token}`;
+        // Refresh 30 seconds before actual expiry
+        this.expiresAt = Date.now() + (data.expires_in - 30) * 1000;
+        return this.cachedToken;
+    }
+}
+exports.KeycloakTokenProvider = KeycloakTokenProvider;

package/dist/types.d.ts

@@ -1,12 +1,27 @@
 export interface FilesClientOptions {
     url: string;
     timeout?: number;
+    serviceAccount?: {
+        issuerUrl: string;
+        clientId: string;
+        clientSecret: string;
+        scopes?: string[];
+    };
 }
 export declare enum FileStatus {
     Uploading = "uploading",
     Ready = "ready",
     Quarantined = "quarantined"
 }
+export declare enum FilePermission {
+    Read = "read",
+    Write = "write",
+    Admin = "admin"
+}
+export declare enum GranteeType {
+    User = "user",
+    Role = "role"
+}
 export interface FileDto {
     id: string;
     name: string;
@@ -77,3 +92,18 @@ export interface CompleteMultipartParams {
         etag: string;
     }[];
 }
+export interface GrantAccessParams {
+    granteeType: GranteeType;
+    granteeId: string;
+    permission: FilePermission;
+    grantReason?: string;
+}
+export interface GrantEntry {
+    granteeType: GranteeType;
+    granteeId: string;
+    permission: FilePermission;
+}
+export interface BatchGrantAccessParams {
+    grants: GrantEntry[];
+    grantReason?: string;
+}

package/dist/types.js

@@ -1,9 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileStatus = void 0;
+exports.GranteeType = exports.FilePermission = exports.FileStatus = void 0;
 var FileStatus;
 (function (FileStatus) {
     FileStatus["Uploading"] = "uploading";
     FileStatus["Ready"] = "ready";
     FileStatus["Quarantined"] = "quarantined";
 })(FileStatus || (exports.FileStatus = FileStatus = {}));
+var FilePermission;
+(function (FilePermission) {
+    FilePermission["Read"] = "read";
+    FilePermission["Write"] = "write";
+    FilePermission["Admin"] = "admin";
+})(FilePermission || (exports.FilePermission = FilePermission = {}));
+var GranteeType;
+(function (GranteeType) {
+    GranteeType["User"] = "user";
+    GranteeType["Role"] = "role";
+})(GranteeType || (exports.GranteeType = GranteeType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quanticjs/files-client",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Typed HTTP client for quanticjs-file-service",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",