@flashbacktech/flashbackclient 0.0.96 → 0.0.98

package/README.md

@@ -12,6 +12,10 @@ TypeScript/JavaScript client for:
 npm install @flashbacktech/flashbackclient
 ```
 
+## Documentation
+
+For comprehensive API documentation, examples, and usage instructions, see the [Documentation](./docs/index.md).
+
 ## Usage
 
 ### Client Library

package/dist/api/client.d.ts

@@ -1,7 +1,7 @@
 import { CreateUnitRequest, CreateUnitResponse, CreateRepoRequest, CreateRepoResponse, StorageUnit, CreateRepoKeyRequest, CreateRepoKeyResponse, GetUnitsResponse, GetReposResponse, GetRepoKeysResponse, UpdateUnitRequest, UpdateUnitResponse, ActionResponse, UpdateRepoRequest, UpdateRepoResponse, UpdateRepoKeyRequest, UpdateRepoKeyResponse, ValidateUnitRequest, ValidateUnitResponse, ValidateRepoUnitsRequest, ValidateRepoUnitsResponse, StorageUnitStatusResponse, GetUnitNodeStatsResponse, GetUnitNodeStatsRequest } from './types/storage';
 import { IApiClient, ProviderType } from './interfaces';
 import { ActivateResponse, DeactivateResponse, LoginBody, LoginResponse, LogoutResponse, OAuth2ResponseDTO, RefreshTokenErrorResponse, RefreshTokenResponse, RegisterBody, RegisterResponse } from './types/auth';
-import { StatsQueryParams, StatsResponse } from './types/stats';
+import { StatsQueryParams, StatsResponse, NodeStatsMinuteResponse, NodeStatsDailyResponse, NodeStatsQueryParams, UnitStatsResponse, RepoStatsResponse } from './types/stats';
 interface ErrorResponse {
     message?: string;
     [key: string]: any;
@@ -63,5 +63,13 @@ export declare class ApiClient implements IApiClient {
     private validateDateRange;
     getDailyStats: (params: StatsQueryParams) => Promise<StatsResponse>;
     getMinuteStats: (params: StatsQueryParams) => Promise<StatsResponse>;
+    getNodeStatsMinute: (params?: NodeStatsQueryParams) => Promise<NodeStatsMinuteResponse>;
+    getNodeStatsDaily: (params?: NodeStatsQueryParams) => Promise<NodeStatsDailyResponse>;
+    getRepoStats: (params?: {
+        repoId?: string[];
+    }) => Promise<RepoStatsResponse>;
+    getUnitStats: (params?: {
+        unitId?: string[];
+    }) => Promise<UnitStatsResponse>;
 }
 export {};

package/dist/api/client.js

@@ -137,7 +137,9 @@ class ApiClient {
             return this.makeRequest('auth/github', 'POST', { code });
         };
         this.refreshGoogleToken = async (refreshToken) => {
-            return this.makeRequest('auth/google/refresh', 'POST', { refresh_token: refreshToken });
+            return this.makeRequest('auth/google/refresh', 'POST', {
+                refresh_token: refreshToken,
+            });
         };
         this.exchangeGoogleCode = async (code) => {
             return this.makeRequest('auth/google/exchange', 'POST', { code });
@@ -248,6 +250,43 @@ class ApiClient {
                 queryParams.append('unitId', params.unitId.join(','));
             return this.makeRequest(`stats/minute?${queryParams.toString()}`, 'GET', null);
         };
+        this.getNodeStatsMinute = async (params) => {
+            const queryParams = new URLSearchParams();
+            if (params && params.unitId && params.unitId.length > 0) {
+                queryParams.append('unitId', params.unitId.join(','));
+            }
+            const response = await this.makeRequest(`stats/nodes/minute?${queryParams.toString() ? `?${queryParams.toString()}` : ''}`, 'GET', null);
+            // Process the response to convert lastUpdated strings to Date objects
+            const processedData = response.data.map((item) => ({
+                ...item,
+                lastUpdated: new Date(item.lastUpdated),
+            }));
+            return {
+                ...response,
+                data: processedData,
+            };
+        };
+        this.getNodeStatsDaily = async (params) => {
+            const queryParams = new URLSearchParams();
+            if (params && params.unitId && params.unitId.length > 0) {
+                queryParams.append('unitId', params.unitId.join(','));
+            }
+            return this.makeRequest(`stats/nodes/daily${queryParams.toString() ? `?${queryParams.toString()}` : ''}`, 'GET', null);
+        };
+        this.getRepoStats = async (params) => {
+            const queryParams = new URLSearchParams();
+            if (params && params.repoId && params.repoId.length > 0) {
+                queryParams.append('repoId', params.repoId.join(','));
+            }
+            return this.makeRequest(`repo/stats${queryParams.toString() ? `?${queryParams.toString()}` : ''}`, 'GET', null);
+        };
+        this.getUnitStats = async (params) => {
+            const queryParams = new URLSearchParams();
+            if (params && params.unitId && params.unitId.length > 0) {
+                queryParams.append('unitId', params.unitId.join(','));
+            }
+            return this.makeRequest(`unit/stats${queryParams.toString() ? `?${queryParams.toString()}` : ''}`, 'GET', null);
+        };
         this.baseURL = baseURL;
         this.headers = {};
         this.debug = false;

package/dist/api/index.d.ts

@@ -1,6 +1,7 @@
 import { ApiClient, HttpError } from './client';
 import * as ApiTypes from './types/storage';
 import * as AuthTypes from './types/auth';
+import * as StatsTypes from './types/stats';
 import * as ApiInterfaces from './interfaces';
 import * as BridgeTypes from './types/bridge';
-export { ApiClient, ApiTypes, AuthTypes, ApiInterfaces, HttpError, BridgeTypes };
+export { ApiClient, ApiTypes, AuthTypes, StatsTypes, ApiInterfaces, HttpError, BridgeTypes };

package/dist/api/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BridgeTypes = exports.HttpError = exports.ApiInterfaces = exports.AuthTypes = exports.ApiTypes = exports.ApiClient = void 0;
+exports.BridgeTypes = exports.HttpError = exports.ApiInterfaces = exports.StatsTypes = exports.AuthTypes = exports.ApiTypes = exports.ApiClient = void 0;
 const client_1 = require("./client");
 Object.defineProperty(exports, "ApiClient", { enumerable: true, get: function () { return client_1.ApiClient; } });
 Object.defineProperty(exports, "HttpError", { enumerable: true, get: function () { return client_1.HttpError; } });
@@ -41,6 +41,8 @@ const ApiTypes = __importStar(require("./types/storage"));
 exports.ApiTypes = ApiTypes;
 const AuthTypes = __importStar(require("./types/auth"));
 exports.AuthTypes = AuthTypes;
+const StatsTypes = __importStar(require("./types/stats"));
+exports.StatsTypes = StatsTypes;
 const ApiInterfaces = __importStar(require("./interfaces"));
 exports.ApiInterfaces = ApiInterfaces;
 const BridgeTypes = __importStar(require("./types/bridge"));

package/dist/api/interfaces.d.ts

@@ -1,6 +1,6 @@
-import { StorageUnit, CreateUnitRequest, CreateUnitResponse, CreateRepoRequest, CreateRepoResponse, CreateRepoKeyRequest, CreateRepoKeyResponse, GetUnitsResponse, GetReposResponse, GetRepoKeysResponse, UpdateUnitRequest, UpdateUnitResponse, ActionResponse, UpdateRepoResponse, UpdateRepoRequest, UpdateRepoKeyRequest, UpdateRepoKeyResponse, ValidateUnitRequest, ValidateUnitResponse, ValidateRepoUnitsRequest, ValidateRepoUnitsResponse, GetUnitNodeStatsRequest, GetUnitNodeStatsResponse } from "./types/storage";
-import { RegisterBody, LoginBody, RegisterResponse, LoginResponse, LogoutResponse, ActivateResponse, DeactivateResponse, RefreshTokenResponse, RefreshTokenErrorResponse } from "./types/auth";
-import { StatsQueryParams, StatsResponse } from "./types/stats";
+import { StorageUnit, CreateUnitRequest, CreateUnitResponse, CreateRepoRequest, CreateRepoResponse, CreateRepoKeyRequest, CreateRepoKeyResponse, GetUnitsResponse, GetReposResponse, GetRepoKeysResponse, UpdateUnitRequest, UpdateUnitResponse, ActionResponse, UpdateRepoResponse, UpdateRepoRequest, UpdateRepoKeyRequest, UpdateRepoKeyResponse, ValidateUnitRequest, ValidateUnitResponse, ValidateRepoUnitsRequest, ValidateRepoUnitsResponse, GetUnitNodeStatsRequest, GetUnitNodeStatsResponse } from './types/storage';
+import { RegisterBody, LoginBody, RegisterResponse, LoginResponse, LogoutResponse, ActivateResponse, DeactivateResponse, RefreshTokenResponse, RefreshTokenErrorResponse } from './types/auth';
+import { StatsQueryParams, StatsResponse, NodeStatsMinuteResponse, NodeStatsDailyResponse, NodeStatsQueryParams } from './types/stats';
 export declare enum ProviderType {
     GOOGLE = "GOOGLE",
     GITHUB = "GITHUB",
@@ -34,4 +34,6 @@ export interface IApiClient {
     userDeactivate(): Promise<DeactivateResponse>;
     getDailyStats(params: StatsQueryParams): Promise<StatsResponse>;
     getMinuteStats(params: StatsQueryParams): Promise<StatsResponse>;
+    getNodeStatsMinute(params?: NodeStatsQueryParams): Promise<NodeStatsMinuteResponse>;
+    getNodeStatsDaily(params?: NodeStatsQueryParams): Promise<NodeStatsDailyResponse>;
 }

package/dist/api/types/auth.d.ts

@@ -1,4 +1,4 @@
-import { ProviderType } from "../interfaces";
+import { ProviderType } from '../interfaces';
 export interface AuthState {
     user: {
         email: string;

package/dist/api/types/stats.d.ts

@@ -18,3 +18,55 @@ export interface StatsData {
     size_change: bigint;
     latency_ms: number;
 }
+export interface NodeStatsMinuteResponse {
+    success: boolean;
+    data: NodeStatsMinuteData[];
+    message?: string;
+}
+export interface NodeStatsMinuteData {
+    nodeId: string;
+    unitId: string;
+    nodeStatus: string;
+    lastUpdated: Date;
+    latency_ms: number;
+}
+export interface NodeStatsDailyResponse {
+    success: boolean;
+    data: NodeStatsDailyData[];
+    message?: string;
+}
+export interface NodeStatsDailyData {
+    nodeId: string;
+    unitId: string;
+    day: number;
+    online: number;
+    latency_ms: number;
+    endpoint: string;
+    region: string;
+    storageType: string;
+    provider: string;
+    status: string;
+    version: string;
+}
+export interface NodeStatsQueryParams {
+    unitId?: string[];
+}
+export interface RepoStatsResponse {
+    success: boolean;
+    stats: {
+        repoId: string;
+        totalUploadBytes: string;
+        totalDownloadBytes: string;
+        totalSizeChange: string;
+    }[];
+}
+export interface UnitStatsResponse {
+    success: boolean;
+    stats: {
+        unitId: string;
+        totalCount: string;
+        totalUploadBytes: string;
+        totalDownloadBytes: string;
+        totalSizeChange: string;
+    }[];
+}

package/dist/api/types/storage.d.ts

@@ -1,4 +1,4 @@
-import { NodeStatusInfo, NodeStatusType } from "./bridge";
+import { NodeStatusInfo, NodeStatusType } from './bridge';
 export declare enum StorageType {
     S3 = "S3",
     GCS = "GCS",

package/dist/gcs/index.d.ts

@@ -1,3 +1,3 @@
-import { FlashbackAuthClient } from "./oauth2";
-import { FlashbackGCSStorage, FlashbackStorageOptions } from "./storage";
+import { FlashbackAuthClient } from './oauth2';
+import { FlashbackGCSStorage, FlashbackStorageOptions } from './storage';
 export { FlashbackAuthClient, FlashbackGCSStorage, FlashbackStorageOptions };

package/dist/gcs/oauth2.js

@@ -33,7 +33,7 @@ class FlashbackAuthClient extends google_auth_library_1.OAuth2Client {
         await this.ensureValidToken();
         return {
             token: this._credentials?.access_token || null,
-            res: null
+            res: null,
         };
     }
     async getRequestHeaders() {
@@ -44,7 +44,9 @@ class FlashbackAuthClient extends google_auth_library_1.OAuth2Client {
     }
     async ensureValidToken() {
         const now = Date.now();
-        if (!this._credentials?.access_token || !this._credentials?.expiry_date || now >= this._credentials.expiry_date) {
+        if (!this._credentials?.access_token ||
+            !this._credentials?.expiry_date ||
+            now >= this._credentials.expiry_date) {
             await this.fetchToken();
         }
     }
@@ -57,7 +59,7 @@ class FlashbackAuthClient extends google_auth_library_1.OAuth2Client {
         const { access_token, expires_in } = response.data;
         this._credentials = {
             access_token,
-            expiry_date: Date.now() + (expires_in * 1000) - 10000,
+            expiry_date: Date.now() + expires_in * 1000 - 10000,
         };
     }
     async request(opts) {

package/dist/gcs/storage.js

@@ -96,9 +96,10 @@ class FlashbackGCSStorage extends storage_1.Storage {
             expires,
             expiresPeriodInSeconds,
             accessibleAt: accessibleAt.toISOString(),
-            contentType
+            contentType,
         });
-        if (expiresPeriodInSeconds > 604800) { // 7 days in seconds
+        if (expiresPeriodInSeconds > 604800) {
+            // 7 days in seconds
             throw new Error('Max allowed expiration is seven days (604800 seconds).');
         }
         const extensionHeaders = {};
@@ -108,12 +109,11 @@ class FlashbackGCSStorage extends storage_1.Storage {
         }
         // Sort headers once and use the same order for both signedHeaders and canonicalHeaders
         const sortedHeaderKeys = Object.keys(extensionHeaders)
-            .map(header => header.toLowerCase())
+            .map((header) => header.toLowerCase())
             .sort();
         const signedHeaders = sortedHeaderKeys.join(';');
-        const canonicalHeaders = sortedHeaderKeys
-            .map(key => `${key}:${extensionHeaders[key.toLowerCase()]}`)
-            .join('\n') + '\n';
+        const canonicalHeaders = sortedHeaderKeys.map((key) => `${key}:${extensionHeaders[key.toLowerCase()]}`).join('\n') +
+            '\n';
         const datestamp = accessibleAt.toISOString().split('T')[0];
         const credentialScope = `${datestamp}/auto/storage/goog4_request`;
         const credential = `${this.credentials.client_email}/${credentialScope}`;
@@ -162,7 +162,9 @@ class FlashbackGCSStorage extends storage_1.Storage {
         sign.update(stringToSign);
         const signature = sign.sign(this.credentials.private_key, 'hex');
         this.doLog('Generated Signature:', signature);
-        return [`${this.apiEndpoint}/${cfg.file.bucket.name}/${cfg.file.name}?${canonicalQueryString}&X-Goog-Signature=${signature}`];
+        return [
+            `${this.apiEndpoint}/${cfg.file.bucket.name}/${cfg.file.name}?${canonicalQueryString}&X-Goog-Signature=${signature}`,
+        ];
     }
 }
 exports.FlashbackGCSStorage = FlashbackGCSStorage;

package/dist/utils/blob.js

@@ -18,6 +18,6 @@ function generateBlockID(blockIDPrefix, blockIndex) {
         blockIDPrefix = blockIDPrefix.slice(0, maxAllowedBlockIDPrefixLength);
     }
     const res = blockIDPrefix +
-        blockIndex.toString().padStart(maxSourceStringLength - blockIDPrefix.length, "0");
-    return Buffer.from(res).toString("base64");
+        blockIndex.toString().padStart(maxSourceStringLength - blockIDPrefix.length, '0');
+    return Buffer.from(res).toString('base64');
 }

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@flashbacktech/flashbackclient",
-  "version": "0.0.96",
+  "version": "0.0.98",
+  "type": "module",
   "publishConfig": {
     "access": "public"
   },