@pagepocket/cli 0.8.0 → 0.8.1

package/dist/commands/archive.js

@@ -12,9 +12,9 @@ const lib_1 = require("@pagepocket/lib");
 const single_file_unit_1 = require("@pagepocket/single-file-unit");
 const write_down_unit_1 = require("@pagepocket/write-down-unit");
 const chalk_1 = __importDefault(require("chalk"));
+const load_configured_plugins_1 = require("../services/load-configured-plugins");
 const network_observer_unit_1 = require("../units/network-observer-unit");
 const with_spinner_1 = require("../utils/with-spinner");
-const load_configured_plugins_1 = require("../services/load-configured-plugins");
 const MAX_STATUS_URL_LENGTH = 80;
 const formatStatusUrl = (url) => {
     if (url.length <= MAX_STATUS_URL_LENGTH) {

package/dist/commands/plugin/add.js

@@ -8,6 +8,7 @@ const chalk_1 = __importDefault(require("chalk"));
 const config_service_1 = require("../../services/config-service");
 const plugin_installer_1 = require("../../services/plugin-installer");
 const plugin_store_1 = require("../../services/plugin-store");
+const validate_plugin_default_export_1 = require("../../utils/validate-plugin-default-export");
 const parseDynamicOptions = (argv) => {
     const tokens = argv.filter(Boolean);
     const pairs = tokens
@@ -72,8 +73,13 @@ class PluginAddCommand extends core_1.Command {
                 : { name, options: parsed.value };
         (0, plugin_installer_1.installPluginPackage)(store, { packageName: name });
         const mod = await store.importPluginModule(name);
-        if (typeof mod.default !== "function") {
-            throw new Error(`Plugin ${name} must have a default export (class).`);
+        const validation = (0, validate_plugin_default_export_1.validatePluginDefaultExport)({
+            pluginName: name,
+            moduleExports: mod,
+            options: parsed.kind === "none" ? undefined : parsed.value
+        });
+        if (!validation.ok) {
+            throw validation.error;
         }
         const nextConfig = store.addPluginToConfig(config, entry);
         configService.writeConfig(nextConfig);

package/dist/services/load-configured-plugins.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadConfiguredPlugins = void 0;
 const config_service_1 = require("./config-service");
 const plugin_store_1 = require("./plugin-store");
+const validate_plugin_default_export_1 = require("../utils/validate-plugin-default-export");
 const loadConfiguredPlugins = async () => {
     const configService = new config_service_1.ConfigService();
     const store = new plugin_store_1.PluginStore(configService);
@@ -11,12 +12,17 @@ const loadConfiguredPlugins = async () => {
     const specs = config.plugins.map(plugin_store_1.normalizePluginConfigEntry);
     const loaded = await Promise.all(specs.map(async (spec) => {
         try {
-            const p = await store.instantiatePluginFromSpec(spec);
-            if (!p || typeof p.setup !== "function") {
-                console.error(`Skipping plugin ${spec.name}: default export is not a PagePocket plugin instance.`);
+            const mod = await store.importPluginModule(spec.name);
+            const v = (0, validate_plugin_default_export_1.validatePluginDefaultExport)({
+                pluginName: spec.name,
+                moduleExports: mod,
+                options: spec.options
+            });
+            if (!v.ok) {
+                console.error(`Skipping plugin ${spec.name}: ${v.error.message}`);
                 return null;
             }
-            return p;
+            return v.plugin;
         }
         catch (e) {
             const msg = e && typeof e.message === "string"

package/dist/services/plugin-store.js

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PluginStore = exports.getPluginNameFromSpec = exports.normalizePluginConfigEntry = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
-const node_path_1 = __importDefault(require("node:path"));
 const node_module_1 = require("node:module");
+const node_path_1 = __importDefault(require("node:path"));
 const node_url_1 = require("node:url");
 const normalizePluginConfigEntry = (entry) => {
     if (typeof entry === "string") {

package/dist/utils/validate-plugin-default-export.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatePluginDefaultExport = void 0;
+const isRecord = (value) => Boolean(value) && typeof value === "object" && !Array.isArray(value);
+const toError = (value) => {
+    if (value instanceof Error) {
+        return value;
+    }
+    return new Error(typeof value === "string" ? value : JSON.stringify(value));
+};
+const validatePluginDefaultExport = (input) => {
+    const { pluginName, moduleExports, options } = input;
+    const defaultExport = moduleExports.default;
+    if (typeof defaultExport !== "function") {
+        return {
+            ok: false,
+            error: new Error(`Plugin ${pluginName} must default export a class/constructor.`)
+        };
+    }
+    const ctor = defaultExport;
+    try {
+        const instance = typeof options === "undefined"
+            ? new ctor()
+            : Array.isArray(options)
+                ? new ctor(...options)
+                : new ctor(options);
+        if (!isRecord(instance)) {
+            return {
+                ok: false,
+                error: new Error(`Plugin ${pluginName} default export did not construct an object.`)
+            };
+        }
+        const name = instance.name;
+        if (typeof name !== "string" || name.trim().length === 0) {
+            return {
+                ok: false,
+                error: new Error(`Plugin ${pluginName} instance must have a non-empty string 'name'.`)
+            };
+        }
+        const setup = instance.setup;
+        if (typeof setup !== "function") {
+            return {
+                ok: false,
+                error: new Error(`Plugin ${pluginName} instance must implement setup(host).`)
+            };
+        }
+        const contribute = instance.contribute;
+        if (typeof contribute !== "undefined" && typeof contribute !== "function") {
+            return {
+                ok: false,
+                error: new Error(`Plugin ${pluginName} contribute must be a function if provided.`)
+            };
+        }
+        return { ok: true, plugin: instance };
+    }
+    catch (e) {
+        return { ok: false, error: toError(e) };
+    }
+};
+exports.validatePluginDefaultExport = validatePluginDefaultExport;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pagepocket/cli",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "CLI for capturing offline snapshots of web pages.",
   "main": "dist/index.js",
   "bin": {
@@ -20,15 +20,15 @@
     "koa-static": "^5.0.0",
     "ora": "^9.0.0",
     "env-paths": "^2.2.1",
-    "@pagepocket/lib": "0.8.0",
-    "@pagepocket/capture-http-cdp-unit": "0.8.0",
-    "@pagepocket/capture-http-puppeteer-unit": "0.8.0",
-    "@pagepocket/build-snapshot-unit": "0.8.0",
-    "@pagepocket/capture-http-lighterceptor-unit": "0.8.0",
-    "@pagepocket/plugin-yt-dlp": "0.8.0",
-    "@pagepocket/single-file-unit": "0.8.0",
-    "@pagepocket/write-down-unit": "0.8.0",
-    "@pagepocket/contracts": "0.8.0"
+    "@pagepocket/lib": "0.8.1",
+    "@pagepocket/capture-http-cdp-unit": "0.8.1",
+    "@pagepocket/capture-http-lighterceptor-unit": "0.8.1",
+    "@pagepocket/capture-http-puppeteer-unit": "0.8.1",
+    "@pagepocket/build-snapshot-unit": "0.8.1",
+    "@pagepocket/plugin-yt-dlp": "0.8.1",
+    "@pagepocket/single-file-unit": "0.8.1",
+    "@pagepocket/write-down-unit": "0.8.1",
+    "@pagepocket/contracts": "0.8.1"
   },
   "devDependencies": {
     "@types/node": "^20.11.30",