verdaccio-stats 0.3.3 → 0.4.0

package/README.md

@@ -54,6 +54,8 @@ middlewares:
     iso-week: false # Optional, whether to use ISO week format
     count-downloads: true # Optional, whether to count downloads
     count-manifest-views: true # Optional, whether to count manifest views
+    flush-interval: 5s # Optional: flush interval (number ms or duration string). 0 means realtime flush.
+    max-pending-entries: 10000 # Optional: flush when pending entry keys reach this size
 ```
 
 Note: SQLite is the default database type, but for performance reason, it is not recommended for production use. For production, consider using MySQL, PostgreSQL, MariaDB, or MSSQL.
@@ -70,10 +72,11 @@ Note: SQLite is the default database type, but for performance reason, it is not
 | `database.password`    | string           |                   | Database password                                                 |
 | `database.host`        | string           | `localhost`       | Database host                                                     |
 | `database.port`        | number           | `3306`            | Database port                                                     |
-| `file`                 | string           | `stats.db`        | Path to the file where stats are stored                           |
 | `iso-week`             | boolean          | `false`           | Whether to use ISO week format                                    |
 | `count-downloads`      | boolean          | `true`            | Whether to count downloads                                        |
 | `count-manifest-views` | boolean          | `true`            | Whether to count manifest views                                   |
+| `flush-interval`       | number or string | `5000`            | Flush interval in ms or a duration string (e.g. `5s`, `1m`); `0` = realtime, `<0` disables timer |
+| `max-pending-entries`  | number           | `10000`           | Flush when the number of pending entry keys reaches this threshold |
 
 ## Usage
 
@@ -82,7 +85,7 @@ After installing and configuring the plugin, it will automatically begin collect
 You can view the statistics by visiting the following URL:
 
 ```
-http://your-registry.com/-/verdaccio/stats/ui
+http://your-registry.com/-/web/stats
 ```
 
 ## License

package/lib/config.d.ts

@@ -1,85 +1,35 @@
 import type { Config } from "@verdaccio/types";
 import type { Options as SequelizeOptions } from "sequelize";
-import z from "zod";
-declare const statsConfig: z.ZodEffects<z.ZodObject<{
-    dialect: z.ZodDefault<z.ZodOptional<z.ZodEnum<["mariadb", "mssql", "mysql", "postgres", "sqlite"]>>>;
-    database: z.ZodUnion<[z.ZodDefault<z.ZodString>, z.ZodObject<{
+import { z } from "zod";
+declare const statsConfig: z.ZodObject<{
+    dialect: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        mariadb: "mariadb";
+        mssql: "mssql";
+        mysql: "mysql";
+        postgres: "postgres";
+        sqlite: "sqlite";
+    }>>>;
+    database: z.ZodUnion<readonly [z.ZodDefault<z.ZodString>, z.ZodObject<{
         name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         username: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         password: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         host: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         port: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        username: string;
-        password: string;
-        host: string;
-        port: number;
-    }, {
-        name?: string | undefined;
-        username?: string | undefined;
-        password?: string | undefined;
-        host?: string | undefined;
-        port?: number | undefined;
-    }>]>;
+    }, z.core.$strip>]>;
     "iso-week": z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     "count-downloads": z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     "count-manifest-views": z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-}, "strip", z.ZodTypeAny, {
-    dialect: "mariadb" | "mssql" | "mysql" | "postgres" | "sqlite";
-    database: string | {
-        name: string;
-        username: string;
-        password: string;
-        host: string;
-        port: number;
-    };
-    "iso-week": boolean;
-    "count-downloads": boolean;
-    "count-manifest-views": boolean;
-}, {
-    dialect?: "mariadb" | "mssql" | "mysql" | "postgres" | "sqlite" | undefined;
-    database?: string | {
-        name?: string | undefined;
-        username?: string | undefined;
-        password?: string | undefined;
-        host?: string | undefined;
-        port?: number | undefined;
-    } | undefined;
-    "iso-week"?: boolean | undefined;
-    "count-downloads"?: boolean | undefined;
-    "count-manifest-views"?: boolean | undefined;
-}>, {
-    dialect: "mariadb" | "mssql" | "mysql" | "postgres" | "sqlite";
-    database: string | {
-        name: string;
-        username: string;
-        password: string;
-        host: string;
-        port: number;
-    };
-    "iso-week": boolean;
-    "count-downloads": boolean;
-    "count-manifest-views": boolean;
-}, {
-    dialect?: "mariadb" | "mssql" | "mysql" | "postgres" | "sqlite" | undefined;
-    database?: string | {
-        name?: string | undefined;
-        username?: string | undefined;
-        password?: string | undefined;
-        host?: string | undefined;
-        port?: number | undefined;
-    } | undefined;
-    "iso-week"?: boolean | undefined;
-    "count-downloads"?: boolean | undefined;
-    "count-manifest-views"?: boolean | undefined;
-}>;
+    "flush-interval": z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+    "max-pending-entries": z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+}, z.core.$strip>;
 export interface ConfigHolder {
     countDownloads: boolean;
     countManifestViews: boolean;
     favicon: string;
+    flushInterval: number;
     isoWeek: boolean;
     logo?: string;
+    maxPendingEntries: number;
     sequelizeOptions: SequelizeOptions;
     title: string;
 }
@@ -93,6 +43,9 @@ export declare class ParsedPluginConfig implements ConfigHolder {
     get countDownloads(): boolean;
     get countManifestViews(): boolean;
     get isoWeek(): boolean;
+    get flushInterval(): number;
+    get maxPendingEntries(): number;
+    get maxPendingKeys(): number;
     get logo(): string | undefined;
     get sequelizeOptions(): SequelizeOptions;
     get title(): string;

package/lib/constants.d.ts

@@ -17,4 +17,5 @@ export declare const ROUTE_TARBALL_DOWNLOAD = "/:package/-/:filename";
 export declare const ROUTE_SCOPED_TARBALL_DOWNLOAD = "/@:scope/:package/-/:filename";
 export declare const ROUTE_MANIFEST_VIEW = "/:package/:version?";
 export declare const ROUTE_SCOPED_MANIFEST_VIEW = "/@:scope/:package/:version?";
-export declare const API_BASE_PATH = "/-/verdaccio/stats";
+export declare const WEB_PATH = "/-/web/stats";
+export declare const API_BASE_PATH = "/-/stats";