verdaccio-stats 0.1.0

package/lib/middlewares/hooks.d.ts

@@ -0,0 +1,13 @@
+import type { Application, Handler } from "express";
+import type { ConfigHolder } from "../config";
+import type { PluginMiddleware } from "../types";
+import { Database } from "../storage/db";
+export declare class Hooks implements PluginMiddleware {
+    private config;
+    private db;
+    constructor(config: ConfigHolder);
+    packageManifestHandler: Handler;
+    register_middlewares(app: Application): void;
+    setDatabase(db: Database): void;
+    tarballDownloadHandler: Handler;
+}

package/lib/middlewares/stats.d.ts

@@ -0,0 +1,16 @@
+import type { Application } from "express";
+import type { ConfigHolder } from "../config";
+import type { PluginMiddleware } from "../types";
+import { Database } from "../storage/db";
+/**
+ * NOTE: This middleware is not implemented yet.
+ */
+export declare class Stats implements PluginMiddleware {
+    private config;
+    private db;
+    constructor(config: ConfigHolder);
+    register_middlewares(app: Application): void;
+    setDatabase(db: Database): void;
+    private checkDatabase;
+    private notImplementedHandler;
+}

package/lib/migrations.d.ts

@@ -0,0 +1,3 @@
+import type { RunnableMigration } from "umzug";
+import { type Sequelize } from "sequelize";
+export declare const migrations: RunnableMigration<Sequelize>[];

package/lib/models.d.ts

@@ -0,0 +1,23 @@
+import { CreationOptional, ForeignKey, type InferAttributes, type InferCreationAttributes, Model, NonAttribute } from "sequelize";
+import type { PeriodType, PeriodValue } from "./types";
+export declare class DownloadStats extends Model<InferAttributes<DownloadStats>, InferCreationAttributes<DownloadStats>> {
+    count: number;
+    id: CreationOptional<number>;
+    package?: NonAttribute<Package>;
+    packageId: ForeignKey<Package["id"]>;
+    periodType: PeriodType;
+    periodValue: PeriodValue;
+}
+export declare class ManifestViewStats extends Model<InferAttributes<ManifestViewStats>, InferCreationAttributes<ManifestViewStats>> {
+    count: number;
+    id: CreationOptional<number>;
+    package?: NonAttribute<Package>;
+    packageId: ForeignKey<Package["id"]>;
+    periodType: PeriodType;
+    periodValue: PeriodValue;
+}
+export declare class Package extends Model<InferAttributes<Package>, InferCreationAttributes<Package>> {
+    id: CreationOptional<number>;
+    name: string;
+    version: string;
+}

package/lib/plugin.d.ts

@@ -0,0 +1,12 @@
+import type { pluginUtils } from "@verdaccio/core";
+import type { Express } from "express";
+import { type StatsConfig } from "./config";
+export declare class Plugin implements pluginUtils.ExpressMiddleware<StatsConfig, never, never> {
+    config: StatsConfig;
+    options: pluginUtils.PluginOptions;
+    get version(): number;
+    private parsedConfig;
+    constructor(config: StatsConfig, options: pluginUtils.PluginOptions);
+    getVersion(): number;
+    register_middlewares(app: Express): void;
+}

package/lib/storage/db.d.ts

@@ -0,0 +1,19 @@
+import type { ConfigHolder } from "../config";
+export declare class Database {
+    private config;
+    private sequelize;
+    private umzug;
+    private constructor();
+    static create(config: ConfigHolder): Promise<Database>;
+    addDownloadCount(packageName: string, version: string): Promise<void>;
+    addManifestViewCount(packageName: string, version?: string): Promise<void>;
+    migrate(): Promise<import("umzug").MigrationMeta[]>;
+    rollback(): Promise<import("umzug").MigrationMeta[]>;
+    private addDownloadForAllPeriod;
+    private addManifestViewForAllPeriod;
+    private addPackageDownloadCount;
+    private addPackageManifestViewCount;
+    private addTotalDownloadCount;
+    private addTotalManifestViewCount;
+    private init;
+}

package/lib/types.d.ts

@@ -0,0 +1,7 @@
+import type { Application } from "express";
+import type { PERIOD_TYPES, PERIOD_VALUE_TOTAL } from "./constants";
+export type PeriodType = (typeof PERIOD_TYPES)[number];
+export type PeriodValue = (Record<never, never> & string) | typeof PERIOD_VALUE_TOTAL;
+export interface PluginMiddleware {
+    register_middlewares(app: Application): void;
+}

package/lib/utils.d.ts

@@ -0,0 +1,33 @@
+import { type Dayjs } from "dayjs";
+import type { PeriodType, PeriodValue } from "./types";
+/**
+ * Get the period value for the given period type.
+ *
+ * @param periodType {PeriodType} - The period type.
+ * @param date {Dayjs} - The date to get the period value for.
+ * @param isoWeek {boolean} - Whether to use ISO week format.
+ * @returns {PeriodValue} The period value.
+ */
+export declare function getPeriodValue(periodType: PeriodType, date?: Dayjs, isoWeek?: boolean): PeriodValue;
+/**
+ * Check if the status code is a success status code.
+ *
+ * @param statusCode {number} - The status code.
+ * @returns {boolean} Whether the status code is a success status code.
+ */
+export declare function isSuccessStatus(statusCode: number): boolean;
+/**
+ * Get the absolute path of a file path.
+ *
+ * @param configPath {string} - The path to the config file.
+ * @param targetPath {string} - The path to the files.
+ * @returns {string} The absolute path of the file.
+ */
+export declare function normalizeFilePath(configPath: string, targetPath: string): string;
+/**
+ * Wraps the given URL path for Verdaccio stats.
+ *
+ * @param urlPath {string} - The path to be wrapped.
+ * @returns {string} The wrapped path.
+ */
+export declare function wrapPath(urlPath: string): string;

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "verdaccio-stats",
+  "version": "0.1.0",
+  "description": "The stats plugin for Verdaccio",
+  "main": "./lib/index.js",
+  "module": "./lib/index.mjs",
+  "types": "./lib/index.d.ts",
+  "repository": "https://github.com/kuoruan/verdaccio-stats.git",
+  "keywords": [
+    "verdaccio",
+    "plugin",
+    "stats"
+  ],
+  "files": [
+    "lib"
+  ],
+  "author": "Xingwang Liao<kuoruan@gmail.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "@eslint/js": "^9.21.0",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-replace": "^6.0.2",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@types/debug": "^4.1.12",
+    "@types/express": "^5.0.0",
+    "@verdaccio/types": "13.0.0-next-8.3",
+    "cross-env": "^7.0.3",
+    "eslint": "^9.21.0",
+    "eslint-config-prettier": "^10.0.2",
+    "eslint-import-resolver-next": "^0.4.2",
+    "eslint-plugin-import-x": "^4.6.1",
+    "eslint-plugin-perfectionist": "^4.9.0",
+    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-unicorn": "^57.0.0",
+    "express": "^4.21.2",
+    "globals": "^16.0.0",
+    "prettier": "^3.5.3",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.34.9",
+    "rollup-plugin-node-externals": "^8.0.0",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.26.0",
+    "verdaccio": "^6.0.5",
+    "verdaccio-stats": "file:",
+    "vitest": "^3.0.8"
+  },
+  "peerDependencies": {
+    "verdaccio": "^5.0.0||^6.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@adminjs/express": "^6.1.1",
+    "@adminjs/sequelize": "^4.1.1",
+    "@verdaccio/core": "8.0.0-next-8.10",
+    "@verdaccio/middleware": "8.0.0-next-8.10",
+    "adminjs": "^7.8.15",
+    "dayjs": "^1.11.13",
+    "debug": "^4.4.0",
+    "sequelize": "^6.37.6",
+    "sqlite3": "^5.1.7",
+    "umzug": "^3.8.2",
+    "zod": "^3.24.2"
+  },
+  "scripts": {
+    "start": "cross-env DEBUG='verdaccio:*' node_modules/verdaccio/bin/verdaccio -c verdaccio/verdaccio.yml",
+    "build": "rimraf dist && rollup -c --environment NODE_ENV:production",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "test": "vitest --run"
+  }
+}