verdaccio-stats 0.1.0 → 0.2.0

package/README.md

@@ -36,7 +36,8 @@ Add the plugin to your Verdaccio config file:
 
 ```yaml
 middlewares:
-  verdaccio-stats:
+  stats:
+    enabled: true
     file: ./stats.db        # Optional, SQLite database
     iso-week: false         # Optional, whether to use ISO week format
     count-downloads: true   # Optional, whether to count downloads
@@ -59,7 +60,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/admin
+http://your-registry.com/-/verdaccio/stats/ui
 ```
 
 ## License

package/lib/index.js

@@ -9,14 +9,14 @@ var isoWeek = require('dayjs/plugin/isoWeek');
 var weekOfYear = require('dayjs/plugin/weekOfYear');
 var weekYear = require('dayjs/plugin/weekYear');
 var path = require('node:path');
-var sequelize = require('sequelize');
 var core = require('@verdaccio/core');
 var middleware = require('@verdaccio/middleware');
+var sequelize = require('sequelize');
 var buildDebug = require('debug');
 var umzug = require('umzug');
 
 var name = "verdaccio-stats";
-var version = "0.1.0";
+var version = "0.2.0";
 
 const plugin = {
     name,
@@ -157,144 +157,6 @@ class ParsedPluginConfig {
     }
 }
 
-class DownloadStats extends sequelize.Model {
-}
-class ManifestViewStats extends sequelize.Model {
-}
-class Package extends sequelize.Model {
-}
-
-const rootPath = wrapPath("/admin");
-const defaultActions = {
-    new: { isAccessible: false },
-    edit: { isAccessible: false },
-    delete: { isAccessible: false },
-    bulkDelete: { isAccessible: false },
-};
-process.env.ADMIN_JS_SKIP_BUNDLE = "true";
-/**
- * Add Admin UI to the application.
- */
-class AdminUI {
-    adminRouter = null;
-    config;
-    constructor(config) {
-        this.config = config;
-        void this.create().then((router) => {
-            this.adminRouter = router;
-        });
-    }
-    static populatePackageIdListProperties(response) {
-        for (const record of response.records) {
-            if (record.populated.packageId?.params) {
-                const params = record.populated.packageId.params;
-                record.populated.packageId.title = `${params.name}@${params.version}`;
-            }
-        }
-        return response;
-    }
-    static populatePackageIdSearchProperties(response) {
-        for (const record of response.records) {
-            if (record.populated.packageId?.params) {
-                const params = record.populated.packageId.params;
-                record.populated.packageId.title = `${params.name}@${params.version}`;
-            }
-        }
-        return response;
-    }
-    static populatePackageIdShowProperties(response) {
-        if (response.record.populated.packageId?.params) {
-            const params = response.record.populated.packageId.params;
-            response.record.populated.packageId.title = `${params.name}@${params.version}`;
-        }
-        return response;
-    }
-    register_middlewares(app) {
-        app.use(rootPath, (req, res, next) => {
-            if (this.adminRouter) {
-                return this.adminRouter(req, res, next);
-            }
-            else {
-                res.status(503).send("Admin UI is not ready yet.");
-            }
-        });
-    }
-    async create() {
-        const [AdminJS, AdminJSExpress, AdminJSSequelize] = await Promise.all([
-            import('adminjs').then((mod) => mod.default),
-            import('@adminjs/express').then((mod) => mod.default),
-            import('@adminjs/sequelize').then((mod) => mod.default),
-        ]);
-        AdminJS.registerAdapter({
-            Resource: AdminJSSequelize.Resource,
-            Database: AdminJSSequelize.Database,
-        });
-        const admin = new AdminJS({
-            resources: [
-                {
-                    resource: Package,
-                    options: {
-                        actions: { ...defaultActions },
-                        listProperties: ["id", "name", "version", "createdAt"],
-                        showProperties: ["id", "name", "version", "createdAt"],
-                        filterProperties: ["name", "version"],
-                        sort: { sortBy: "createdAt", direction: "desc" },
-                    },
-                },
-                {
-                    resource: DownloadStats,
-                    options: {
-                        actions: {
-                            ...defaultActions,
-                            show: { after: AdminUI.populatePackageIdShowProperties },
-                            list: { after: AdminUI.populatePackageIdListProperties },
-                            search: { after: AdminUI.populatePackageIdSearchProperties },
-                        },
-                        properties: {
-                            periodType: {
-                                availableValues: PERIOD_TYPES.map((type) => ({ value: type, label: type })),
-                            },
-                        },
-                        listProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
-                        showProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
-                        filterProperties: ["packageId", "periodType", "periodValue", "createdAt", "updatedAt"],
-                        sort: { sortBy: "updatedAt", direction: "desc" },
-                    },
-                },
-                {
-                    resource: ManifestViewStats,
-                    options: {
-                        actions: {
-                            ...defaultActions,
-                            show: { after: AdminUI.populatePackageIdShowProperties },
-                            list: { after: AdminUI.populatePackageIdListProperties },
-                            search: { after: AdminUI.populatePackageIdSearchProperties },
-                        },
-                        properties: {
-                            periodType: {
-                                availableValues: PERIOD_TYPES.map((type) => ({ value: type, label: type })),
-                            },
-                        },
-                        listProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
-                        showProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
-                        filterProperties: ["packageId", "periodType", "periodValue", "createdAt", "updatedAt"],
-                        sort: { sortBy: "updatedAt", direction: "desc" },
-                    },
-                },
-            ],
-            rootPath: rootPath,
-            branding: {
-                companyName: this.config.title,
-                logo: this.config.logo,
-            },
-            env: {
-                ADMIN_JS_SKIP_BUNDLE: "true",
-            },
-        });
-        return AdminJSExpress.buildRouter(admin);
-    }
-}
-
 class Hooks {
     config;
     db = null;
@@ -406,6 +268,110 @@ class Stats {
     };
 }
 
+class DownloadStats extends sequelize.Model {
+}
+class ManifestViewStats extends sequelize.Model {
+}
+class Package extends sequelize.Model {
+}
+
+const rootPath = wrapPath("/ui");
+const defaultActions = {
+    new: { isAccessible: false },
+    edit: { isAccessible: false },
+    delete: { isAccessible: false },
+    bulkDelete: { isAccessible: false },
+};
+process.env.ADMIN_JS_SKIP_BUNDLE = "true";
+/**
+ * Add Admin UI to the application.
+ */
+class UI {
+    adminRouter = null;
+    config;
+    constructor(config) {
+        this.config = config;
+        void this.create().then((router) => {
+            this.adminRouter = router;
+        });
+    }
+    register_middlewares(app) {
+        app.use(rootPath, (req, res, next) => {
+            if (this.adminRouter) {
+                return this.adminRouter(req, res, next);
+            }
+            else {
+                res.status(503).send("Admin UI is not ready yet.");
+            }
+        });
+    }
+    async create() {
+        const [AdminJS, AdminJSExpress, AdminJSSequelize] = await Promise.all([
+            import('adminjs').then((mod) => mod.default),
+            import('@adminjs/express').then((mod) => mod.default),
+            import('@adminjs/sequelize').then((mod) => mod.default),
+        ]);
+        AdminJS.registerAdapter({
+            Resource: AdminJSSequelize.Resource,
+            Database: AdminJSSequelize.Database,
+        });
+        const admin = new AdminJS({
+            resources: [
+                {
+                    resource: Package,
+                    options: {
+                        actions: { ...defaultActions },
+                        titleProperty: "displayName",
+                        listProperties: ["id", "name", "version", "createdAt"],
+                        showProperties: ["id", "name", "version", "createdAt"],
+                        filterProperties: ["name", "version"],
+                        sort: { sortBy: "createdAt", direction: "desc" },
+                    },
+                },
+                {
+                    resource: DownloadStats,
+                    options: {
+                        actions: { ...defaultActions },
+                        properties: {
+                            periodType: {
+                                availableValues: PERIOD_TYPES.map((type) => ({ value: type, label: type })),
+                            },
+                        },
+                        listProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
+                        showProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
+                        filterProperties: ["packageId", "periodType", "periodValue", "createdAt", "updatedAt"],
+                        sort: { sortBy: "updatedAt", direction: "desc" },
+                    },
+                },
+                {
+                    resource: ManifestViewStats,
+                    options: {
+                        actions: { ...defaultActions },
+                        properties: {
+                            periodType: {
+                                availableValues: PERIOD_TYPES.map((type) => ({ value: type, label: type })),
+                            },
+                        },
+                        listProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
+                        showProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
+                        filterProperties: ["packageId", "periodType", "periodValue", "createdAt", "updatedAt"],
+                        sort: { sortBy: "updatedAt", direction: "desc" },
+                    },
+                },
+            ],
+            rootPath: rootPath,
+            branding: {
+                companyName: this.config.title,
+                logo: this.config.logo,
+            },
+            env: {
+                ADMIN_JS_SKIP_BUNDLE: "true",
+            },
+        });
+        return AdminJSExpress.buildRouter(admin);
+    }
+}
+
 const debug = buildDebug(`verdaccio:plugin:${pluginKey}`);
 function getUmzugLogger() {
     return {
@@ -609,6 +575,15 @@ class Database {
                 id: { allowNull: false, autoIncrement: true, primaryKey: true, type: sequelize.DataTypes.INTEGER },
                 name: { allowNull: false, type: sequelize.DataTypes.STRING(100) },
                 version: { allowNull: false, type: sequelize.DataTypes.STRING(50) },
+                displayName: {
+                    type: sequelize.DataTypes.VIRTUAL,
+                    get() {
+                        return `${this.name}@${this.version}`;
+                    },
+                    set() {
+                        throw new Error("Virtual property, cannot be set");
+                    },
+                },
             }, { sequelize: this.sequelize, tableName: "packages", underscored: true }),
             DownloadStats.init({
                 count: { allowNull: false, type: sequelize.DataTypes.BIGINT, defaultValue: 0 },
@@ -666,7 +641,7 @@ class Plugin {
         const db = Database.create(this.parsedConfig);
         const hooks = new Hooks(this.parsedConfig);
         const stats = new Stats(this.parsedConfig);
-        const adminUI = new AdminUI(this.parsedConfig);
+        const ui = new UI(this.parsedConfig);
         db.then((db) => {
             hooks.setDatabase(db);
             stats.setDatabase(db);
@@ -674,7 +649,7 @@ class Plugin {
             logger.error({ err }, "Failed to initialize database; @{err}");
             process.exit(1);
         });
-        for (const middleware of [hooks, stats, adminUI]) {
+        for (const middleware of [hooks, stats, ui]) {
             middleware.register_middlewares(app);
         }
     }

package/lib/index.mjs

@@ -5,14 +5,14 @@ import isoWeek from 'dayjs/plugin/isoWeek';
 import weekOfYear from 'dayjs/plugin/weekOfYear';
 import weekYear from 'dayjs/plugin/weekYear';
 import path from 'node:path';
-import { Model, DataTypes, Sequelize } from 'sequelize';
 import { tarballUtils } from '@verdaccio/core';
 import { PACKAGE_API_ENDPOINTS } from '@verdaccio/middleware';
+import { Model, DataTypes, Sequelize } from 'sequelize';
 import buildDebug from 'debug';
 import { Umzug, SequelizeStorage } from 'umzug';
 
 var name = "verdaccio-stats";
-var version = "0.1.0";
+var version = "0.2.0";
 
 const plugin = {
     name,
@@ -153,144 +153,6 @@ class ParsedPluginConfig {
     }
 }
 
-class DownloadStats extends Model {
-}
-class ManifestViewStats extends Model {
-}
-class Package extends Model {
-}
-
-const rootPath = wrapPath("/admin");
-const defaultActions = {
-    new: { isAccessible: false },
-    edit: { isAccessible: false },
-    delete: { isAccessible: false },
-    bulkDelete: { isAccessible: false },
-};
-process.env.ADMIN_JS_SKIP_BUNDLE = "true";
-/**
- * Add Admin UI to the application.
- */
-class AdminUI {
-    adminRouter = null;
-    config;
-    constructor(config) {
-        this.config = config;
-        void this.create().then((router) => {
-            this.adminRouter = router;
-        });
-    }
-    static populatePackageIdListProperties(response) {
-        for (const record of response.records) {
-            if (record.populated.packageId?.params) {
-                const params = record.populated.packageId.params;
-                record.populated.packageId.title = `${params.name}@${params.version}`;
-            }
-        }
-        return response;
-    }
-    static populatePackageIdSearchProperties(response) {
-        for (const record of response.records) {
-            if (record.populated.packageId?.params) {
-                const params = record.populated.packageId.params;
-                record.populated.packageId.title = `${params.name}@${params.version}`;
-            }
-        }
-        return response;
-    }
-    static populatePackageIdShowProperties(response) {
-        if (response.record.populated.packageId?.params) {
-            const params = response.record.populated.packageId.params;
-            response.record.populated.packageId.title = `${params.name}@${params.version}`;
-        }
-        return response;
-    }
-    register_middlewares(app) {
-        app.use(rootPath, (req, res, next) => {
-            if (this.adminRouter) {
-                return this.adminRouter(req, res, next);
-            }
-            else {
-                res.status(503).send("Admin UI is not ready yet.");
-            }
-        });
-    }
-    async create() {
-        const [AdminJS, AdminJSExpress, AdminJSSequelize] = await Promise.all([
-            import('adminjs').then((mod) => mod.default),
-            import('@adminjs/express').then((mod) => mod.default),
-            import('@adminjs/sequelize').then((mod) => mod.default),
-        ]);
-        AdminJS.registerAdapter({
-            Resource: AdminJSSequelize.Resource,
-            Database: AdminJSSequelize.Database,
-        });
-        const admin = new AdminJS({
-            resources: [
-                {
-                    resource: Package,
-                    options: {
-                        actions: { ...defaultActions },
-                        listProperties: ["id", "name", "version", "createdAt"],
-                        showProperties: ["id", "name", "version", "createdAt"],
-                        filterProperties: ["name", "version"],
-                        sort: { sortBy: "createdAt", direction: "desc" },
-                    },
-                },
-                {
-                    resource: DownloadStats,
-                    options: {
-                        actions: {
-                            ...defaultActions,
-                            show: { after: AdminUI.populatePackageIdShowProperties },
-                            list: { after: AdminUI.populatePackageIdListProperties },
-                            search: { after: AdminUI.populatePackageIdSearchProperties },
-                        },
-                        properties: {
-                            periodType: {
-                                availableValues: PERIOD_TYPES.map((type) => ({ value: type, label: type })),
-                            },
-                        },
-                        listProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
-                        showProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
-                        filterProperties: ["packageId", "periodType", "periodValue", "createdAt", "updatedAt"],
-                        sort: { sortBy: "updatedAt", direction: "desc" },
-                    },
-                },
-                {
-                    resource: ManifestViewStats,
-                    options: {
-                        actions: {
-                            ...defaultActions,
-                            show: { after: AdminUI.populatePackageIdShowProperties },
-                            list: { after: AdminUI.populatePackageIdListProperties },
-                            search: { after: AdminUI.populatePackageIdSearchProperties },
-                        },
-                        properties: {
-                            periodType: {
-                                availableValues: PERIOD_TYPES.map((type) => ({ value: type, label: type })),
-                            },
-                        },
-                        listProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
-                        showProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
-                        filterProperties: ["packageId", "periodType", "periodValue", "createdAt", "updatedAt"],
-                        sort: { sortBy: "updatedAt", direction: "desc" },
-                    },
-                },
-            ],
-            rootPath: rootPath,
-            branding: {
-                companyName: this.config.title,
-                logo: this.config.logo,
-            },
-            env: {
-                ADMIN_JS_SKIP_BUNDLE: "true",
-            },
-        });
-        return AdminJSExpress.buildRouter(admin);
-    }
-}
-
 class Hooks {
     config;
     db = null;
@@ -402,6 +264,110 @@ class Stats {
     };
 }
 
+class DownloadStats extends Model {
+}
+class ManifestViewStats extends Model {
+}
+class Package extends Model {
+}
+
+const rootPath = wrapPath("/ui");
+const defaultActions = {
+    new: { isAccessible: false },
+    edit: { isAccessible: false },
+    delete: { isAccessible: false },
+    bulkDelete: { isAccessible: false },
+};
+process.env.ADMIN_JS_SKIP_BUNDLE = "true";
+/**
+ * Add Admin UI to the application.
+ */
+class UI {
+    adminRouter = null;
+    config;
+    constructor(config) {
+        this.config = config;
+        void this.create().then((router) => {
+            this.adminRouter = router;
+        });
+    }
+    register_middlewares(app) {
+        app.use(rootPath, (req, res, next) => {
+            if (this.adminRouter) {
+                return this.adminRouter(req, res, next);
+            }
+            else {
+                res.status(503).send("Admin UI is not ready yet.");
+            }
+        });
+    }
+    async create() {
+        const [AdminJS, AdminJSExpress, AdminJSSequelize] = await Promise.all([
+            import('adminjs').then((mod) => mod.default),
+            import('@adminjs/express').then((mod) => mod.default),
+            import('@adminjs/sequelize').then((mod) => mod.default),
+        ]);
+        AdminJS.registerAdapter({
+            Resource: AdminJSSequelize.Resource,
+            Database: AdminJSSequelize.Database,
+        });
+        const admin = new AdminJS({
+            resources: [
+                {
+                    resource: Package,
+                    options: {
+                        actions: { ...defaultActions },
+                        titleProperty: "displayName",
+                        listProperties: ["id", "name", "version", "createdAt"],
+                        showProperties: ["id", "name", "version", "createdAt"],
+                        filterProperties: ["name", "version"],
+                        sort: { sortBy: "createdAt", direction: "desc" },
+                    },
+                },
+                {
+                    resource: DownloadStats,
+                    options: {
+                        actions: { ...defaultActions },
+                        properties: {
+                            periodType: {
+                                availableValues: PERIOD_TYPES.map((type) => ({ value: type, label: type })),
+                            },
+                        },
+                        listProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
+                        showProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
+                        filterProperties: ["packageId", "periodType", "periodValue", "createdAt", "updatedAt"],
+                        sort: { sortBy: "updatedAt", direction: "desc" },
+                    },
+                },
+                {
+                    resource: ManifestViewStats,
+                    options: {
+                        actions: { ...defaultActions },
+                        properties: {
+                            periodType: {
+                                availableValues: PERIOD_TYPES.map((type) => ({ value: type, label: type })),
+                            },
+                        },
+                        listProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
+                        showProperties: ["id", "packageId", "periodType", "periodValue", "count", "createdAt", "updatedAt"],
+                        filterProperties: ["packageId", "periodType", "periodValue", "createdAt", "updatedAt"],
+                        sort: { sortBy: "updatedAt", direction: "desc" },
+                    },
+                },
+            ],
+            rootPath: rootPath,
+            branding: {
+                companyName: this.config.title,
+                logo: this.config.logo,
+            },
+            env: {
+                ADMIN_JS_SKIP_BUNDLE: "true",
+            },
+        });
+        return AdminJSExpress.buildRouter(admin);
+    }
+}
+
 const debug = buildDebug(`verdaccio:plugin:${pluginKey}`);
 function getUmzugLogger() {
     return {
@@ -605,6 +571,15 @@ class Database {
                 id: { allowNull: false, autoIncrement: true, primaryKey: true, type: DataTypes.INTEGER },
                 name: { allowNull: false, type: DataTypes.STRING(100) },
                 version: { allowNull: false, type: DataTypes.STRING(50) },
+                displayName: {
+                    type: DataTypes.VIRTUAL,
+                    get() {
+                        return `${this.name}@${this.version}`;
+                    },
+                    set() {
+                        throw new Error("Virtual property, cannot be set");
+                    },
+                },
             }, { sequelize: this.sequelize, tableName: "packages", underscored: true }),
             DownloadStats.init({
                 count: { allowNull: false, type: DataTypes.BIGINT, defaultValue: 0 },
@@ -662,7 +637,7 @@ class Plugin {
         const db = Database.create(this.parsedConfig);
         const hooks = new Hooks(this.parsedConfig);
         const stats = new Stats(this.parsedConfig);
-        const adminUI = new AdminUI(this.parsedConfig);
+        const ui = new UI(this.parsedConfig);
         db.then((db) => {
             hooks.setDatabase(db);
             stats.setDatabase(db);
@@ -670,7 +645,7 @@ class Plugin {
             logger.error({ err }, "Failed to initialize database; @{err}");
             process.exit(1);
         });
-        for (const middleware of [hooks, stats, adminUI]) {
+        for (const middleware of [hooks, stats, ui]) {
             middleware.register_middlewares(app);
         }
     }

package/lib/middlewares/ui.d.ts

@@ -0,0 +1,13 @@
+import type { Application } from "express";
+import type { ConfigHolder } from "../config";
+import type { PluginMiddleware } from "../types";
+/**
+ * Add Admin UI to the application.
+ */
+export declare class UI implements PluginMiddleware {
+    private adminRouter;
+    private config;
+    constructor(config: ConfigHolder);
+    register_middlewares(app: Application): void;
+    private create;
+}

package/lib/models.d.ts

@@ -17,6 +17,7 @@ export declare class ManifestViewStats extends Model<InferAttributes<ManifestVie
     periodValue: PeriodValue;
 }
 export declare class Package extends Model<InferAttributes<Package>, InferCreationAttributes<Package>> {
+    readonly displayName: string;
     id: CreationOptional<number>;
     name: string;
     version: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "verdaccio-stats",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "The stats plugin for Verdaccio",
   "main": "./lib/index.js",
   "module": "./lib/index.mjs",

package/lib/middlewares/admin-ui.d.ts

@@ -1,17 +0,0 @@
-import type { ListActionResponse, RecordActionResponse, SearchActionResponse } from "adminjs";
-import type { Application } from "express";
-import type { ConfigHolder } from "../config";
-import type { PluginMiddleware } from "../types";
-/**
- * Add Admin UI to the application.
- */
-export declare class AdminUI implements PluginMiddleware {
-    private adminRouter;
-    private config;
-    constructor(config: ConfigHolder);
-    static populatePackageIdListProperties(this: void, response: ListActionResponse): ListActionResponse;
-    static populatePackageIdSearchProperties(this: void, response: SearchActionResponse): SearchActionResponse;
-    static populatePackageIdShowProperties(this: void, response: RecordActionResponse): RecordActionResponse;
-    register_middlewares(app: Application): void;
-    private create;
-}