verdaccio-stats 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Xingwang Liao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,67 @@
+# Verdaccio Stats Plugin
+
+This plugin adds detailed statistics functionality to your Verdaccio private npm registry.
+
+## Features
+
+- Track package download statistics
+- Track manifest view counts
+- ISO week format support
+- Admin interface to view statistics
+
+## Installation
+
+Install Globally
+
+```bash
+npm install -g verdaccio-stats
+```
+
+Or install to verdaccio plugin folder:
+
+```bash
+mkdir -p ./install-here/
+npm install --global-style \
+  --bin-links=false --save=false --package-lock=false \
+  --omit=dev --omit=optional --omit=peer \
+  --prefix ./install-here/ \
+  verdaccio-stats@latest
+mv ./install-here/node_modules/verdaccio-stats/ /path/to/verdaccio/plugins/
+```
+
+
+## Configuration
+
+Add the plugin to your Verdaccio config file:
+
+```yaml
+middlewares:
+  verdaccio-stats:
+    file: ./stats.db        # Optional, SQLite database
+    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
+```
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `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 |
+
+## Usage
+
+After installing and configuring the plugin, it will automatically begin collecting the specified statistics. The data will be stored in the configured database file.
+
+You can view the statistics by visiting the following URL:
+
+```
+http://your-registry.com/-/verdaccio/stats/admin
+```
+
+## License
+
+See the [`LICENSE`](LICENSE ) file for details.

package/lib/config.d.ts

@@ -0,0 +1,40 @@
+import type { Config } from "@verdaccio/types";
+import z from "zod";
+declare const statsConfig: z.ZodObject<{
+    file: z.ZodOptional<z.ZodString>;
+    "iso-week": z.ZodOptional<z.ZodBoolean>;
+    "count-downloads": z.ZodOptional<z.ZodBoolean>;
+    "count-manifest-views": z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    file?: string | undefined;
+    "iso-week"?: boolean | undefined;
+    "count-downloads"?: boolean | undefined;
+    "count-manifest-views"?: boolean | undefined;
+}, {
+    file?: string | undefined;
+    "iso-week"?: boolean | undefined;
+    "count-downloads"?: boolean | undefined;
+    "count-manifest-views"?: boolean | undefined;
+}>;
+export interface ConfigHolder {
+    countDownloads: boolean;
+    countManifestViews: boolean;
+    file: string;
+    isoWeek: boolean;
+    logo?: string;
+    title: string;
+}
+export type StatsConfig = z.infer<typeof statsConfig>;
+export declare class ParsedPluginConfig implements ConfigHolder {
+    private readonly config;
+    private readonly verdaccioConfig;
+    get configPath(): string;
+    get countDownloads(): boolean;
+    get countManifestViews(): boolean;
+    get file(): string;
+    get isoWeek(): boolean;
+    get logo(): string | undefined;
+    get title(): string;
+    constructor(config: StatsConfig, verdaccioConfig: Config);
+}
+export {};

package/lib/constants.d.ts

@@ -0,0 +1,11 @@
+export declare const plugin: {
+    name: string;
+    version: string;
+};
+export declare const pluginKey: string;
+export declare const UNIVERSE_PACKAGE_NAME = "**";
+export declare const UNIVERSE_PACKAGE_VERSION = "*";
+export declare const PERIOD_TYPES: readonly ["overall", "daily", "monthly", "weekly", "yearly"];
+export declare const PERIOD_VALUE_TOTAL = "total";
+export declare const DEFAULT_SQLITE_FILE = "stats.db";
+export declare const API_BASE_PATH = "/-/verdaccio/stats";

package/lib/debugger.d.ts

@@ -0,0 +1,4 @@
+import type { UmzugOptions } from "umzug";
+import buildDebug from "debug";
+export declare const debug: buildDebug.Debugger;
+export declare function getUmzugLogger(): UmzugOptions["logger"];

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { Plugin as default } from "./plugin";