@abyss-project/storage 1.0.21 → 1.0.23

package/dist/api/hourly-metrics.api.d.ts

@@ -0,0 +1,4 @@
+import { IGetStorageHourlyMetricsParams, IGetStorageHourlyMetricsQuery, IGetStorageHourlyMetricsResponse, IGetAggregatedStorageHourlyMetricsParams, IGetAggregatedStorageHourlyMetricsQuery, IGetAggregatedStorageHourlyMetricsResponse, IGetStorageHourlyMetricsComparisonParams, IGetStorageHourlyMetricsComparisonQuery, IGetStorageHourlyMetricsComparisonResponse } from '../types';
+export declare const getStorageHourlyMetrics: (params: IGetStorageHourlyMetricsParams, query: IGetStorageHourlyMetricsQuery) => Promise<IGetStorageHourlyMetricsResponse>;
+export declare const getAggregatedStorageHourlyMetrics: (params: IGetAggregatedStorageHourlyMetricsParams, query: IGetAggregatedStorageHourlyMetricsQuery) => Promise<IGetAggregatedStorageHourlyMetricsResponse>;
+export declare const getStorageHourlyMetricsComparison: (params: IGetStorageHourlyMetricsComparisonParams, query: IGetStorageHourlyMetricsComparisonQuery) => Promise<IGetStorageHourlyMetricsComparisonResponse>;

package/dist/api/hourly-metrics.api.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStorageHourlyMetricsComparison = exports.getAggregatedStorageHourlyMetrics = exports.getStorageHourlyMetrics = void 0;
+const __1 = require("..");
+const getStorageHourlyMetrics = async (params, query) => {
+    return (await __1.AbyssStorageCore.axios.get(`metrics/hourly/${params.projectId}`, { params: query })).data;
+};
+exports.getStorageHourlyMetrics = getStorageHourlyMetrics;
+const getAggregatedStorageHourlyMetrics = async (params, query) => {
+    return (await __1.AbyssStorageCore.axios.get(`metrics/hourly/${params.projectId}/aggregated`, { params: query })).data;
+};
+exports.getAggregatedStorageHourlyMetrics = getAggregatedStorageHourlyMetrics;
+const getStorageHourlyMetricsComparison = async (params, query) => {
+    return (await __1.AbyssStorageCore.axios.get(`metrics/hourly/${params.projectId}/comparison`, { params: query })).data;
+};
+exports.getStorageHourlyMetricsComparison = getStorageHourlyMetricsComparison;

package/dist/api/index.d.ts

@@ -17,3 +17,4 @@ export * from './application-store.admin.api';
 export * from './application-store.public.api';
 export * from './application-store.api';
 export * from './report.admin.api';
+export * from './hourly-metrics.api';

package/dist/api/index.js

@@ -33,3 +33,4 @@ __exportStar(require("./application-store.admin.api"), exports);
 __exportStar(require("./application-store.public.api"), exports);
 __exportStar(require("./application-store.api"), exports);
 __exportStar(require("./report.admin.api"), exports);
+__exportStar(require("./hourly-metrics.api"), exports);

package/dist/types/interface/api/index.d.ts

@@ -20,6 +20,8 @@ export * from './requests/application-store.admin.request';
 export * from './requests/application-store.public.request';
 export * from './requests/application-store.request';
 export * from './requests/report.admin.request';
+export * from './requests/metrics.admin.request';
+export * from './requests/hourly-metrics.request';
 export * from './responses/application.response';
 export * from './responses/application.admin.response';
 export * from './responses/application-file.admin.response';
@@ -38,3 +40,5 @@ export * from './responses/application-store.admin.response';
 export * from './responses/application-store.public.response';
 export * from './responses/application-store.response';
 export * from './responses/report.admin.response';
+export * from './responses/metrics.admin.response';
+export * from './responses/hourly-metrics.response';

package/dist/types/interface/api/index.js

@@ -36,6 +36,8 @@ __exportStar(require("./requests/application-store.admin.request"), exports);
 __exportStar(require("./requests/application-store.public.request"), exports);
 __exportStar(require("./requests/application-store.request"), exports);
 __exportStar(require("./requests/report.admin.request"), exports);
+__exportStar(require("./requests/metrics.admin.request"), exports);
+__exportStar(require("./requests/hourly-metrics.request"), exports);
 __exportStar(require("./responses/application.response"), exports);
 __exportStar(require("./responses/application.admin.response"), exports);
 __exportStar(require("./responses/application-file.admin.response"), exports);
@@ -54,3 +56,5 @@ __exportStar(require("./responses/application-store.admin.response"), exports);
 __exportStar(require("./responses/application-store.public.response"), exports);
 __exportStar(require("./responses/application-store.response"), exports);
 __exportStar(require("./responses/report.admin.response"), exports);
+__exportStar(require("./responses/metrics.admin.response"), exports);
+__exportStar(require("./responses/hourly-metrics.response"), exports);

package/dist/types/interface/api/requests/hourly-metrics.request.d.ts

@@ -0,0 +1,28 @@
+export interface IGetStorageHourlyMetricsParams {
+    projectId: string;
+}
+export interface IGetStorageHourlyMetricsQuery {
+    applicationIds?: string[];
+    startDate?: Date;
+    endDate?: Date;
+    limit?: number;
+    offset?: number;
+    granularity?: 'hour' | 'day' | 'week' | 'month';
+}
+export interface IGetAggregatedStorageHourlyMetricsParams {
+    projectId: string;
+}
+export interface IGetAggregatedStorageHourlyMetricsQuery {
+    applicationIds?: string[];
+    startDate?: Date;
+    endDate?: Date;
+}
+export interface IGetStorageHourlyMetricsComparisonParams {
+    projectId: string;
+}
+export interface IGetStorageHourlyMetricsComparisonQuery {
+    applicationIds: string[];
+    startDate?: Date;
+    endDate?: Date;
+    metrics?: string[];
+}

package/dist/types/interface/api/requests/hourly-metrics.request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/api/requests/metrics.admin.request.d.ts

@@ -0,0 +1,13 @@
+export interface IFillLifetimeMetricsAdminBody {
+    applicationIds?: string[];
+    force?: boolean;
+}
+export interface IFillHourlyMetricsAdminBody {
+    applicationIds?: string[];
+    days?: number;
+    force?: boolean;
+}
+export interface IAggregateHourAdminBody {
+    applicationIds?: string[];
+    applicationCronTaskHistoryId?: string;
+}

package/dist/types/interface/api/requests/metrics.admin.request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/api/responses/hourly-metrics.response.d.ts

@@ -0,0 +1,82 @@
+import { IResponse, IApplicationHourlyMetrics, FilesByType } from '../..';
+export interface IStorageHourlyMetricsRecord extends Omit<IApplicationHourlyMetrics, 'application'> {
+}
+export interface IAggregatedStorageMetricsSummary {
+    totalFiles: number;
+    totalFilesSize: number;
+    totalCreatedFiles: number;
+    totalCreatedFilesSize: number;
+    totalDeletedFiles: number;
+    totalDeletedFilesSize: number;
+    netFileChange: number;
+    netSizeChange: number;
+    totalThumbnails: number;
+    totalThumbnailsSize: number;
+    totalCreatedThumbnails: number;
+    totalCreatedThumbnailsSize: number;
+    totalDeletedThumbnails: number;
+    totalDeletedThumbnailsSize: number;
+    totalPreSignUrls: number;
+    usedPreSignUrls: number;
+    preSignUrlUsageRate: number;
+    uploadPreSignUrls: number;
+    downloadPreSignUrls: number;
+    writePreSignUrls: number;
+    usedUploadPreSignUrls: number;
+    usedDownloadPreSignUrls: number;
+    usedWritePreSignUrls: number;
+    totalWebhooks: number;
+    successfulWebhooks: number;
+    failedWebhooks: number;
+    webhookSuccessRate: number;
+    totalStoreEntries: number;
+    filesByMimeType: Record<string, FilesByType>;
+}
+export interface IStorageMetricsTimeSeriesPoint {
+    timestamp: string;
+    value: number;
+}
+export interface IStorageMetricsTimeSeries {
+    metricName: string;
+    applicationId: string;
+    applicationName?: string;
+    data: IStorageMetricsTimeSeriesPoint[];
+}
+export interface IGetStorageHourlyMetricsData {
+    metricsByApplication: Record<string, IStorageHourlyMetricsRecord[]>;
+    totalByApplication: Record<string, number>;
+    periodStart: string;
+    periodEnd: string;
+}
+export type IGetStorageHourlyMetricsResponse = IResponse<IGetStorageHourlyMetricsData>;
+export interface IGetAggregatedStorageHourlyMetricsData {
+    aggregatedByApplication: Record<string, IAggregatedStorageMetricsSummary>;
+    overallAggregated: IAggregatedStorageMetricsSummary;
+    periodStart: string;
+    periodEnd: string;
+    hoursInPeriod: number;
+}
+export type IGetAggregatedStorageHourlyMetricsResponse = IResponse<IGetAggregatedStorageHourlyMetricsData>;
+export interface IApplicationStorageMetricsComparison {
+    applicationId: string;
+    applicationName?: string;
+    aggregated: IAggregatedStorageMetricsSummary;
+    trends: {
+        totalFiles: IStorageMetricsTimeSeriesPoint[];
+        totalFilesSize: IStorageMetricsTimeSeriesPoint[];
+        createdFiles: IStorageMetricsTimeSeriesPoint[];
+        preSignUrls: IStorageMetricsTimeSeriesPoint[];
+    };
+}
+export interface IGetStorageHourlyMetricsComparisonData {
+    applications: IApplicationStorageMetricsComparison[];
+    periodStart: string;
+    periodEnd: string;
+}
+export type IGetStorageHourlyMetricsComparisonResponse = IResponse<IGetStorageHourlyMetricsComparisonData>;
+export interface IGetStorageMetricsTimeSeriesData {
+    series: IStorageMetricsTimeSeries[];
+    periodStart: string;
+    periodEnd: string;
+}
+export type IGetStorageMetricsTimeSeriesResponse = IResponse<IGetStorageMetricsTimeSeriesData>;

package/dist/types/interface/api/responses/hourly-metrics.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/api/responses/metrics.admin.response.d.ts

@@ -0,0 +1,19 @@
+import { IResponse } from '../..';
+export interface IFillLifetimeMetricsData {
+    success: boolean;
+    message: string;
+    requestId: string;
+}
+export type IFillLifetimeMetricsAdminResponse = IResponse<IFillLifetimeMetricsData>;
+export interface IFillHourlyMetricsData {
+    success: boolean;
+    message: string;
+    requestId: string;
+}
+export type IFillHourlyMetricsAdminResponse = IResponse<IFillHourlyMetricsData>;
+export interface IAggregateHourData {
+    success: boolean;
+    message: string;
+    requestId: string;
+}
+export type IAggregateHourAdminResponse = IResponse<IAggregateHourData>;

package/dist/types/interface/api/responses/metrics.admin.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/api/responses/report.admin.response.d.ts

@@ -10,42 +10,30 @@ export interface PreSignUrlsByType {
     write: PreSignUrlTypeStats;
 }
 export interface FilesByType {
-    mimeType: string;
     count: number;
     totalSize: number;
 }
-export interface LifetimeMetrics {
+export interface CoreLifetimeMetrics {
     totalFiles: number;
     totalSize: number;
     totalPreSignUrlsGenerated: number;
     totalPreSignUrlsUsed: number;
     averageFileSize: number;
-    filesByType: Array<FilesByType>;
+    filesByType: Record<string, FilesByType>;
     preSignUrlsByType: PreSignUrlsByType;
-    largestFile: {
-        id: string;
-        name: string;
-        size: number;
-        mimeType: string;
-    } | null;
     mostUploadedFileType: string;
-    topFilesByPreSignUrlUsage: Array<{
-        fileId: string;
-        fileName: string;
-        uploadCount: number;
-        downloadCount: number;
-        writeCount: number;
-        totalUsageCount: number;
-    }>;
 }
-export interface ApplicationMetrics {
-    totalFiles: number;
-    totalSize: number;
-    totalPreSignUrlsGenerated: number;
-    totalPreSignUrlsUsed: number;
-    averageFileSize: number;
-    filesByType: Array<FilesByType>;
-    preSignUrlsByType: PreSignUrlsByType;
+export interface LifetimeMetrics extends CoreLifetimeMetrics {
+}
+export interface ApplicationMetrics extends CoreLifetimeMetrics {
+    createdFiles: number;
+    createdFilesSize: number;
+    deletedFiles: number;
+    deletedFilesSize: number;
+    createdThumbnails: number;
+    createdThumbnailsSize: number;
+    deletedThumbnails: number;
+    deletedThumbnailsSize: number;
     largestFile: {
         id: string;
         name: string;

package/dist/types/interface/index.d.ts

@@ -6,6 +6,8 @@ export * from './models/pre-sign-url.model';
 export * from './models/application-file-thumbnail.model';
 export * from './models/stream-media.model';
 export * from './models/application-store-entry.model';
+export * from './models/application-hourly-metrics.model';
+export * from './models/application-lifetime-metrics.model';
 export * from './api';
 export * from './dto';
 export * from './constants';

package/dist/types/interface/index.js

@@ -22,6 +22,8 @@ __exportStar(require("./models/pre-sign-url.model"), exports);
 __exportStar(require("./models/application-file-thumbnail.model"), exports);
 __exportStar(require("./models/stream-media.model"), exports);
 __exportStar(require("./models/application-store-entry.model"), exports);
+__exportStar(require("./models/application-hourly-metrics.model"), exports);
+__exportStar(require("./models/application-lifetime-metrics.model"), exports);
 __exportStar(require("./api"), exports);
 __exportStar(require("./dto"), exports);
 __exportStar(require("./constants"), exports);

package/dist/types/interface/models/application-file-thumbnail.model.d.ts

@@ -11,5 +11,6 @@ export interface IApplicationFileThumbnail {
     applicationFileId: string;
     updatedAt?: Date;
     createdAt?: Date;
+    deletedAt?: Date | null;
     applicationFile?: IApplicationFile;
 }

package/dist/types/interface/models/application-file.model.d.ts

@@ -23,6 +23,7 @@ export interface IApplicationFile {
     applicationId: string;
     updatedAt?: Date;
     createdAt?: Date;
+    deletedAt?: Date | null;
     application?: IApplication;
     applicationFileThumbnail?: IApplicationFileThumbnail[];
 }

package/dist/types/interface/models/application-hourly-metrics.model.d.ts

@@ -0,0 +1,41 @@
+import { FilesByType } from '../api';
+import { IApplication } from './application.model';
+export interface IApplicationHourlyMetrics {
+    id: string;
+    applicationId: string;
+    hour: Date;
+    totalFiles: number;
+    totalFilesSize: number;
+    createdFiles: number;
+    createdFilesSize: number;
+    deletedFiles: number;
+    deletedFilesSize: number;
+    totalThumbnails: number;
+    totalThumbnailsSize: number;
+    createdThumbnails: number;
+    createdThumbnailsSize: number;
+    deletedThumbnails: number;
+    deletedThumbnailsSize: number;
+    totalPreSignUrls: number;
+    usedPreSignUrls: number;
+    uploadPreSignUrls: number;
+    downloadPreSignUrls: number;
+    writePreSignUrls: number;
+    usedUploadPreSignUrls: number;
+    usedDownloadPreSignUrls: number;
+    usedWritePreSignUrls: number;
+    totalWebhooks: number;
+    successfulWebhooks: number;
+    failedWebhooks: number;
+    totalStoreEntries: number;
+    filesByMimeType: Record<string, FilesByType>;
+    topLargestFiles: {
+        id: string;
+        name: string;
+        size: number;
+        mimeType: string;
+    }[];
+    createdAt?: Date;
+    updatedAt?: Date;
+    application?: IApplication;
+}

package/dist/types/interface/models/application-hourly-metrics.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/application-lifetime-metrics.model.d.ts

@@ -0,0 +1,27 @@
+import { IApplication } from './application.model';
+export interface IApplicationLifetimeMetrics {
+    id: string;
+    applicationId: string;
+    totalFiles: number;
+    totalFilesSize: number;
+    deletedFiles: number;
+    deletedFilesSize: number;
+    totalThumbnails: number;
+    totalThumbnailsSize: number;
+    totalPreSignUrls: number;
+    usedPreSignUrls: number;
+    uploadPreSignUrls: number;
+    downloadPreSignUrls: number;
+    writePreSignUrls: number;
+    usedUploadPreSignUrls: number;
+    usedDownloadPreSignUrls: number;
+    usedWritePreSignUrls: number;
+    totalWebhooks: number;
+    successfulWebhooks: number;
+    failedWebhooks: number;
+    totalStoreEntries: number;
+    lastCalculatedAt: Date;
+    createdAt?: Date;
+    updatedAt?: Date;
+    application?: IApplication;
+}

package/dist/types/interface/models/application-lifetime-metrics.model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/application-store-entry.model.d.ts

@@ -10,5 +10,6 @@ export interface IApplicationStoreEntry {
     countAccess: number;
     updatedAt?: Date;
     createdAt?: Date;
+    deletedAt?: Date;
     application?: IApplication;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abyss-project/storage",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "description": "Core package to interact with Abyss-Storage",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",