@dynamatix/gb-schemas 2.3.296 → 2.3.298

package/dist/shared/api-performance.model.d.ts

@@ -0,0 +1,120 @@
+/// <reference path="../value-objects/pound.d.ts" />
+/// <reference path="../value-objects/account-number.d.ts" />
+/// <reference path="../value-objects/sort-code.d.ts" />
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import mongoose from "mongoose";
+declare const ApiPerformanceLogModel: mongoose.Model<{
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    method: "POST" | "GET" | "PUT" | "PATCH" | "DELETE";
+    endpoint: string;
+    performanceStatus: "Optimal" | "Acceptable" | "Degraded" | "Severe" | "Critical";
+    responseTime: number;
+    responseSize: number;
+    requestSize: number;
+    requestedAt: NativeDate;
+    averageResponseCount: number;
+    label?: string | null | undefined;
+}, {}, {}, {}, mongoose.Document<unknown, {}, {
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    method: "POST" | "GET" | "PUT" | "PATCH" | "DELETE";
+    endpoint: string;
+    performanceStatus: "Optimal" | "Acceptable" | "Degraded" | "Severe" | "Critical";
+    responseTime: number;
+    responseSize: number;
+    requestSize: number;
+    requestedAt: NativeDate;
+    averageResponseCount: number;
+    label?: string | null | undefined;
+}, {}> & {
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    method: "POST" | "GET" | "PUT" | "PATCH" | "DELETE";
+    endpoint: string;
+    performanceStatus: "Optimal" | "Acceptable" | "Degraded" | "Severe" | "Critical";
+    responseTime: number;
+    responseSize: number;
+    requestSize: number;
+    requestedAt: NativeDate;
+    averageResponseCount: number;
+    label?: string | null | undefined;
+} & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}, mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    timestamps: true;
+}, {
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    method: "POST" | "GET" | "PUT" | "PATCH" | "DELETE";
+    endpoint: string;
+    performanceStatus: "Optimal" | "Acceptable" | "Degraded" | "Severe" | "Critical";
+    responseTime: number;
+    responseSize: number;
+    requestSize: number;
+    requestedAt: NativeDate;
+    averageResponseCount: number;
+    label?: string | null | undefined;
+}, mongoose.Document<unknown, {}, mongoose.FlatRecord<{
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    method: "POST" | "GET" | "PUT" | "PATCH" | "DELETE";
+    endpoint: string;
+    performanceStatus: "Optimal" | "Acceptable" | "Degraded" | "Severe" | "Critical";
+    responseTime: number;
+    responseSize: number;
+    requestSize: number;
+    requestedAt: NativeDate;
+    averageResponseCount: number;
+    label?: string | null | undefined;
+}>, {}> & mongoose.FlatRecord<{
+    createdAt: NativeDate;
+    updatedAt: NativeDate;
+} & {
+    method: "POST" | "GET" | "PUT" | "PATCH" | "DELETE";
+    endpoint: string;
+    performanceStatus: "Optimal" | "Acceptable" | "Degraded" | "Severe" | "Critical";
+    responseTime: number;
+    responseSize: number;
+    requestSize: number;
+    requestedAt: NativeDate;
+    averageResponseCount: number;
+    label?: string | null | undefined;
+}> & {
+    _id: mongoose.Types.ObjectId;
+} & {
+    __v: number;
+}>>;
+export default ApiPerformanceLogModel;
+//# sourceMappingURL=api-performance.model.d.ts.map

package/dist/shared/api-performance.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-performance.model.d.ts","sourceRoot":"","sources":["../../shared/api-performance.model.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAyBhC,QAAA,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAA+D,CAAC;AAC5F,eAAe,sBAAsB,CAAC"}

package/dist/shared/api-performance.model.js

@@ -0,0 +1,22 @@
+import mongoose from "mongoose";
+const apiPerformanceLogSchema = new mongoose.Schema({
+    label: { type: String },
+    endpoint: { type: String, required: true },
+    performanceStatus: {
+        type: String,
+        enum: ["Optimal", "Acceptable", "Degraded", "Severe", "Critical"],
+        required: true
+    },
+    responseTime: { type: Number, required: true }, // in milliseconds
+    responseSize: { type: Number, default: 0 }, // in bytes
+    requestSize: { type: Number, default: 0 }, // in bytes
+    requestedAt: { type: Date, required: true, default: Date.now },
+    method: {
+        type: String,
+        required: true,
+        enum: ["GET", "POST", "PUT", "PATCH", "DELETE"]
+    },
+    averageResponseCount: { type: Number, default: 0 },
+}, { timestamps: true });
+const ApiPerformanceLogModel = mongoose.model("ApiPerformanceLog", apiPerformanceLogSchema);
+export default ApiPerformanceLogModel;

package/dist/shared/api-performance.type.d.ts

@@ -0,0 +1,177 @@
+/// <reference path="../value-objects/pound.d.ts" />
+/// <reference path="../value-objects/account-number.d.ts" />
+/// <reference path="../value-objects/sort-code.d.ts" />
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import { Document } from "mongoose";
+/**
+ * HTTP methods supported by the API performance tracking system.
+ */
+export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+/**
+ * Performance status levels based on response time.
+ * Automatically set by the model's pre-save middleware.
+ */
+export type PerformanceStatus = "Optimal" | "Acceptable" | "Degraded" | "Severe" | "Critical";
+/**
+ * Interface representing an API performance log entry.
+ * This matches the Mongoose schema structure for API performance tracking.
+ */
+export interface IApiPerformance {
+    /**
+     * Optional label for the API performance log entry
+     */
+    label?: string;
+    /**
+     * API endpoint or route (e.g., /api/users)
+     */
+    endpoint: string;
+    /**
+     * Performance status automatically calculated based on response time
+     * @default calculated by pre-save middleware
+     */
+    performanceStatus: PerformanceStatus;
+    /**
+     * Response time in milliseconds
+     */
+    responseTime: number;
+    /**
+     * Size of the response payload in bytes
+     * @default 0
+     */
+    responseSize?: number;
+    /**
+     * Size of the request payload in bytes
+     * @default 0
+     */
+    requestSize?: number;
+    /**
+     * Timestamp when the API call was made
+     * @default Date.now
+     */
+    requestedAt: Date;
+    /**
+     * HTTP method used in the request
+     */
+    method: HttpMethod;
+    /**
+     * Average response count for analytics
+     * @default 0
+     */
+    averageResponseCount?: number;
+    /**
+     * Automatically added by Mongoose timestamps
+     */
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+/**
+ * Mongoose document type for API performance logs.
+ * Extends the base interface with Mongoose document methods.
+ */
+export interface IApiPerformanceDocument extends IApiPerformance, Document {
+}
+/**
+ * Input type for creating a new API performance log entry.
+ * Excludes auto-generated fields like timestamps, _id, and performanceStatus.
+ */
+export interface ICreateApiPerformanceInput {
+    endpoint: string;
+    method: HttpMethod;
+    responseTime: number;
+    label?: string;
+    requestSize?: number;
+    responseSize?: number;
+    requestedAt?: Date;
+    averageResponseCount?: number;
+}
+/**
+ * Update type for modifying an existing API performance log entry.
+ * All fields are optional for partial updates.
+ * Note: performanceStatus is automatically calculated and should not be manually set.
+ */
+export interface IUpdateApiPerformanceInput {
+    endpoint?: string;
+    method?: HttpMethod;
+    responseTime?: number;
+    label?: string;
+    requestSize?: number;
+    responseSize?: number;
+    requestedAt?: Date;
+    averageResponseCount?: number;
+}
+/**
+ * Query filters for searching API performance logs.
+ * Supports filtering by various criteria.
+ */
+export interface IApiPerformanceFilters {
+    endpoint?: string | RegExp;
+    method?: HttpMethod;
+    performanceStatus?: PerformanceStatus;
+    responseTime?: {
+        $gte?: number;
+        $lte?: number;
+    };
+    label?: string | RegExp;
+    requestedAt?: {
+        $gte?: Date;
+        $lte?: Date;
+    };
+    averageResponseCount?: {
+        $gte?: number;
+        $lte?: number;
+    };
+    createdAt?: {
+        $gte?: Date;
+        $lte?: Date;
+    };
+    updatedAt?: {
+        $gte?: Date;
+        $lte?: Date;
+    };
+}
+/**
+ * Aggregation result for API performance analytics.
+ * Used for performance metrics and reporting.
+ */
+export interface IApiPerformanceAnalytics {
+    _id?: {
+        endpoint?: string;
+        method?: HttpMethod;
+        performanceStatus?: PerformanceStatus;
+    };
+    count: number;
+    avgResponseTime: number;
+    minResponseTime: number;
+    maxResponseTime: number;
+    totalRequestSize: number;
+    totalResponseSize: number;
+    avgResponseCount: number;
+    performanceStatusDistribution?: {
+        [key in PerformanceStatus]?: number;
+    };
+}
+//# sourceMappingURL=api-performance.type.d.ts.map

package/dist/shared/api-performance.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-performance.type.d.ts","sourceRoot":"","sources":["../../shared/api-performance.type.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAErE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,YAAY,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE9F;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IAErC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,eAAe,EAAE,QAAQ;CAAG;AAE7E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,YAAY,CAAC,EAAE;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE;QACZ,IAAI,CAAC,EAAE,IAAI,CAAC;QACZ,IAAI,CAAC,EAAE,IAAI,CAAC;KACb,CAAC;IACF,oBAAoB,CAAC,EAAE;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,SAAS,CAAC,EAAE;QACV,IAAI,CAAC,EAAE,IAAI,CAAC;QACZ,IAAI,CAAC,EAAE,IAAI,CAAC;KACb,CAAC;IACF,SAAS,CAAC,EAAE;QACV,IAAI,CAAC,EAAE,IAAI,CAAC;QACZ,IAAI,CAAC,EAAE,IAAI,CAAC;KACb,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,GAAG,CAAC,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,UAAU,CAAC;QACpB,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;KACvC,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,6BAA6B,CAAC,EAAE;SAC7B,GAAG,IAAI,iBAAiB,CAAC,CAAC,EAAE,MAAM;KACpC,CAAC;CACH"}

package/dist/shared/api-performance.type.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamatix/gb-schemas",
-  "version": "2.3.296",
+  "version": "2.3.298",
   "description": "All the schemas for gatehouse bank back-end",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",