neozip-cli 0.90.0 → 0.95.0

package/skills/neozip-shared/SKILL.md

@@ -0,0 +1,60 @@
+---
+name: neozip-shared
+description: "NeoZip global flags for agents: JSON output, --params/--json input, schema introspection, dry-run, and exit codes. Prerequisite for the other neozip skills."
+metadata:
+  version: 0.90.0
+  openclaw:
+    category: "productivity"
+    requires:
+      bins:
+        - neozip
+        - neounzip
+        - neolist
+    cliHelp: "neozip --help"
+---
+
+# NeoZip — shared agent conventions
+
+Read this before the per-command skills. It applies to `neozip`, `neounzip`, and
+`neolist`.
+
+## Get machine-readable output
+
+Add `--format json` to any command. Output is a single JSON object on stdout:
+
+- Success: `{ "ok": true, ... }`
+- Error:   `{ "ok": false, "error": { "code", "exitCode", "message", "nextCommand"? } }`
+
+stdout carries only the JSON object. Human hints/progress go to stderr. Always
+parse stdout; never parse human text.
+
+## Introspect before calling
+
+```bash
+neozip schema neozip      # or: neounzip | neolist | connect
+```
+
+Returns accepted `--params` fields, the `--json` payload shape, defaults, and
+exit codes. Use it to build your `--params`/`--json` objects.
+
+## Provide input as JSON
+
+- `--params '<JSON>'` — options ("how").
+- `--json '<JSON>'` — payload ("what": archive + files/targets).
+- Either accepts `-` to read JSON from stdin.
+- Explicit CLI flags override values from `--params`/`--json`.
+
+## Always dry-run mutations first
+
+```bash
+neozip --format json --dry-run --json '{"archive":"out.zip","files":["src/"]}'
+neounzip --format json --dry-run --params '{"exdir":"out"}' in.zip
+```
+
+`--dry-run` resolves the full plan and writes nothing.
+
+## Branch on exit codes
+
+Exit codes are InfoZip-compatible and echoed in `error.exitCode`. Common:
+`0` success, `10` parameter/option error, `9` files not found, `82` bad password.
+When an error includes `nextCommand`, run it to recover.

package/dist/src/commands/verifyEmail.js

@@ -1,146 +0,0 @@
-"use strict";
-/**
- * Verify email for Zipstamp timestamping
- *
- * Sets a default email for Zipstamp timestamps. Checks with the server whether
- * the email is already verified; if not, sends a magic link. Always saves as default.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.runVerifyEmail = runVerifyEmail;
-const readline = __importStar(require("readline"));
-const zipstamp_server_1 = require("neozip-blockchain/zipstamp-server");
-const ConfigStore_1 = require("../config/ConfigStore");
-const EMAIL_REGEX = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
-function isValidEmail(email) {
-    return EMAIL_REGEX.test(email.trim());
-}
-function isAlreadyVerifiedMessage(msg) {
-    if (!msg)
-        return false;
-    const lower = msg.toLowerCase();
-    return ((lower.includes('already') && (lower.includes('verified') || lower.includes('registered'))) ||
-        lower.includes('already verified') ||
-        lower.includes('email already'));
-}
-/**
- * Run the verify-email flow.
- * Calls the server to check verification status; if already verified, sets as default.
- * If not, sends magic link and sets as default. Always saves email to config.
- */
-async function runVerifyEmail(options) {
-    const rl = readline.createInterface({
-        input: process.stdin,
-        output: process.stdout,
-    });
-    const prompt = (question, defaultValue) => {
-        return new Promise((resolve) => {
-            const display = defaultValue ? `${question} (${defaultValue}): ` : `${question}: `;
-            rl.question(display, (answer) => {
-                resolve((answer.trim() || defaultValue || '').trim());
-            });
-        });
-    };
-    try {
-        console.log('\n📧 Zipstamp Email Configuration\n');
-        console.log('Zipstamp requires a verified email to create timestamped ZIP files.');
-        console.log('');
-        const config = ConfigStore_1.ConfigStore.getConfig();
-        const defaultEmail = options?.email || config.timestampEmail || '';
-        const email = await prompt('Email address', defaultEmail || undefined);
-        if (!email) {
-            console.error('❌ Email is required');
-            rl.close();
-            return false;
-        }
-        if (!isValidEmail(email)) {
-            console.error('❌ Invalid email format');
-            rl.close();
-            return false;
-        }
-        // --set-default: skip server check, just save
-        if (options?.setDefaultOnly) {
-            const saved = ConfigStore_1.ConfigStore.set('zipstamp.timestampEmail', email);
-            if (!saved) {
-                console.error('❌ Failed to save email to configuration');
-                rl.close();
-                return false;
-            }
-            console.log(`\n✅ ${email} set as default for Zipstamp timestamps.`);
-            console.log('\n💡 You can now create timestamped ZIPs: neozip -ts <archive> <files>\n');
-            rl.close();
-            return true;
-        }
-        // Check with server: register returns status (already verified vs magic link sent)
-        console.log(`\n📤 Checking verification status for ${email}...`);
-        const registerResult = await (0, zipstamp_server_1.registerEmail)(email, {
-            debug: options?.debug,
-        });
-        if (!registerResult.success) {
-            console.error('❌ Failed to register email:', registerResult.error || 'Unknown error');
-            rl.close();
-            return false;
-        }
-        const res = registerResult;
-        const msg = res.message || '';
-        const alreadyVerified = res.verified === true ||
-            res.alreadyVerified === true ||
-            isAlreadyVerifiedMessage(msg);
-        const saved = ConfigStore_1.ConfigStore.set('zipstamp.timestampEmail', email);
-        if (!saved) {
-            console.error('❌ Failed to save email to configuration');
-            rl.close();
-            return false;
-        }
-        if (alreadyVerified) {
-            console.log('\n✅ Email is already verified. Set as default.');
-        }
-        else {
-            console.log('\n✅ Verification link sent. Check your inbox (and spam folder).');
-            console.log('   Click the magic link in the email to complete verification.');
-            console.log(`   ${email} has been set as default and will work once you've clicked the link.`);
-        }
-        console.log('\n💡 You can now create timestamped ZIPs: neozip -ts <archive> <files>\n');
-        rl.close();
-        return true;
-    }
-    catch (error) {
-        const msg = error instanceof Error ? error.message : String(error);
-        console.error('❌ Error:', msg);
-        rl.close();
-        return false;
-    }
-}
-//# sourceMappingURL=verifyEmail.js.map

package/dist/src/config/ConfigStore.js

@@ -1,406 +0,0 @@
-"use strict";
-/**
- * ConfigStore - Configuration storage and retrieval manager for NeoZip
- * Handles wallet.json file I/O, environment variable resolution, and config validation
- * This is the data layer - handles all config storage/retrieval operations
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigStore = void 0;
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-const os = __importStar(require("os"));
-const neozip_blockchain_1 = require("neozip-blockchain");
-const DEFAULTS = {
-    network: 'base-sepolia',
-    timestampEmail: null,
-    rpcUrls: {
-        baseSepolia: 'https://sepolia.base.org',
-        baseMainnet: 'https://mainnet.base.org',
-    },
-    gas: {
-        multiplier: 1.0,
-        maxPriceGwei: 100,
-    },
-    debug: {
-        verbose: false,
-        enabled: false,
-    },
-};
-class ConfigStore {
-    /**
-     * Get the configuration directory path
-     */
-    static getConfigDir() {
-        return this.configDir;
-    }
-    /**
-     * Get the configuration file path
-     */
-    static getConfigPath() {
-        return this.configPath;
-    }
-    /**
-     * Check if wallet.json exists
-     */
-    static exists() {
-        return fs.existsSync(this.getConfigPath());
-    }
-    /**
-     * Load configuration from wallet.json
-     */
-    static load() {
-        if (!this.exists()) {
-            return null;
-        }
-        try {
-            const content = fs.readFileSync(this.getConfigPath(), 'utf-8');
-            return JSON.parse(content);
-        }
-        catch (error) {
-            console.error(`⚠️  Failed to load wallet.json: ${error}`);
-            return null;
-        }
-    }
-    /**
-     * Save configuration to wallet.json
-     */
-    static save(config) {
-        try {
-            // Ensure config directory exists
-            const configDir = this.getConfigDir();
-            if (!fs.existsSync(configDir)) {
-                fs.mkdirSync(configDir, { recursive: true, mode: 0o700 });
-            }
-            // Write config file with restricted permissions
-            fs.writeFileSync(this.getConfigPath(), JSON.stringify(config, null, 2), { mode: 0o600 });
-            return true;
-        }
-        catch (error) {
-            console.error(`❌ Failed to save wallet.json: ${error}`);
-            return false;
-        }
-    }
-    /**
-     * Delete wallet.json configuration
-     */
-    static reset() {
-        try {
-            if (this.exists()) {
-                fs.unlinkSync(this.getConfigPath());
-            }
-            return true;
-        }
-        catch (error) {
-            console.error(`❌ Failed to delete wallet.json: ${error}`);
-            return false;
-        }
-    }
-    /**
-     * Get resolved configuration with precedence: CLI args > ENV vars > wallet.json > defaults
-     * @param cliWalletKey - Wallet key from CLI argument (highest priority)
-     */
-    static getConfig(cliWalletKey) {
-        const jsonConfig = this.load();
-        // Wallet key precedence: CLI > ENV > wallet.json
-        let walletKey = null;
-        if (cliWalletKey) {
-            walletKey = cliWalletKey;
-        }
-        else if (process.env.NEOZIP_WALLET_PASSKEY) {
-            walletKey = process.env.NEOZIP_WALLET_PASSKEY;
-        }
-        else if (jsonConfig?.wallet?.privateKey) {
-            walletKey = jsonConfig.wallet.privateKey;
-        }
-        // Network precedence: ENV > wallet.json > default
-        const network = process.env.NEOZIP_NETWORK ||
-            jsonConfig?.wallet?.network ||
-            DEFAULTS.network;
-        // Timestamp email precedence: ENV > wallet.json > default (for Zipstamp)
-        const timestampEmail = process.env.NEOZIP_TIMESTAMP_EMAIL ||
-            jsonConfig?.zipstamp?.timestampEmail ||
-            null;
-        // RPC URLs precedence: ENV > wallet.json > default
-        const rpcUrls = {
-            baseSepolia: process.env.NEOZIP_BASE_SEPOLIA_RPC_URL ||
-                jsonConfig?.rpc?.baseSepolia ||
-                DEFAULTS.rpcUrls.baseSepolia,
-            baseMainnet: process.env.NEOZIP_BASE_MAINNET_RPC_URL ||
-                jsonConfig?.rpc?.baseMainnet ||
-                DEFAULTS.rpcUrls.baseMainnet,
-        };
-        // Gas settings precedence: ENV > wallet.json > default
-        const gas = {
-            multiplier: process.env.NEOZIP_GAS_MULTIPLIER ?
-                parseFloat(process.env.NEOZIP_GAS_MULTIPLIER) :
-                jsonConfig?.gas?.multiplier ||
-                    DEFAULTS.gas.multiplier,
-            maxPriceGwei: process.env.NEOZIP_MAX_GAS_PRICE ?
-                parseInt(process.env.NEOZIP_MAX_GAS_PRICE) :
-                jsonConfig?.gas?.maxPriceGwei ||
-                    DEFAULTS.gas.maxPriceGwei,
-        };
-        // Debug settings precedence: ENV > wallet.json > default
-        const debug = {
-            verbose: process.env.NEOZIP_VERBOSE === 'true' ||
-                jsonConfig?.debug?.verbose ||
-                DEFAULTS.debug.verbose,
-            enabled: process.env.NEOZIP_DEBUG === 'true' ||
-                jsonConfig?.debug?.enabled ||
-                DEFAULTS.debug.enabled,
-        };
-        return {
-            walletKey,
-            network,
-            timestampEmail,
-            rpcUrls,
-            gas,
-            debug,
-        };
-    }
-    /**
-     * Validate wallet private key format
-     */
-    static validatePrivateKey(key) {
-        // Must be 66 characters (0x + 64 hex chars) or 64 characters (without 0x)
-        const withPrefix = /^0x[0-9a-fA-F]{64}$/;
-        const withoutPrefix = /^[0-9a-fA-F]{64}$/;
-        return withPrefix.test(key) || withoutPrefix.test(key);
-    }
-    /**
-     * Validate network name (uses nameAliases from CONTRACT_CONFIGS)
-     */
-    static validateNetwork(network) {
-        return (0, neozip_blockchain_1.getChainIdByName)(network) !== null;
-    }
-    /**
-     * Update a specific configuration value
-     */
-    static set(key, value) {
-        let config = this.load() || {
-            wallet: {},
-            rpc: {},
-            gas: {},
-            debug: {},
-        };
-        // Parse the key path (e.g., "wallet.privateKey", "gas.multiplier")
-        const parts = key.split('.');
-        switch (parts[0]) {
-            case 'zipstamp':
-                if (!config.zipstamp)
-                    config.zipstamp = {};
-                if (parts[1] === 'timestampEmail') {
-                    config.zipstamp.timestampEmail = value;
-                }
-                else {
-                    console.error(`❌ Unknown zipstamp key: ${parts[1]}`);
-                    return false;
-                }
-                break;
-            case 'wallet':
-                if (parts[1] === 'privateKey') {
-                    if (!this.validatePrivateKey(value)) {
-                        console.error('❌ Invalid private key format');
-                        return false;
-                    }
-                    config.wallet.privateKey = value.startsWith('0x') ? value : `0x${value}`;
-                }
-                else if (parts[1] === 'network') {
-                    if (!this.validateNetwork(value)) {
-                        const supportedNetworks = (0, neozip_blockchain_1.getSupportedNetworkNames)();
-                        console.error(`❌ Invalid network: "${value}"`);
-                        console.error(`Supported networks: ${supportedNetworks.join(', ')}`);
-                        return false;
-                    }
-                    config.wallet.network = value;
-                }
-                break;
-            case 'rpc':
-                if (!config.rpc)
-                    config.rpc = {};
-                // Support both legacy keys and dynamic network keys
-                if (parts[1] === 'baseSepolia') {
-                    config.rpc.baseSepolia = value;
-                }
-                else if (parts[1] === 'baseMainnet') {
-                    config.rpc.baseMainnet = value;
-                }
-                else {
-                    // Allow dynamic network keys (e.g., "rpc.baseSepolia", "rpc.arbitrumSepolia")
-                    config.rpc[parts[1]] = value;
-                }
-                break;
-            case 'gas':
-                if (!config.gas)
-                    config.gas = {};
-                if (parts[1] === 'multiplier') {
-                    config.gas.multiplier = parseFloat(value);
-                }
-                else if (parts[1] === 'maxPriceGwei') {
-                    config.gas.maxPriceGwei = parseInt(value);
-                }
-                break;
-            case 'debug':
-                if (!config.debug)
-                    config.debug = {};
-                if (parts[1] === 'verbose') {
-                    config.debug.verbose = value === 'true';
-                }
-                else if (parts[1] === 'enabled') {
-                    config.debug.enabled = value === 'true';
-                }
-                break;
-            default:
-                console.error(`❌ Unknown configuration key: ${key}`);
-                return false;
-        }
-        return this.save(config);
-    }
-    /**
-     * Delete a specific configuration key
-     */
-    static delete(key) {
-        const config = this.load();
-        if (!config) {
-            console.error('❌ No configuration found');
-            return false;
-        }
-        // Parse the key path (e.g., "wallet.privateKey", "gas.multiplier")
-        const parts = key.split('.');
-        switch (parts[0]) {
-            case 'zipstamp':
-                if (!config.zipstamp) {
-                    console.error('❌ No Zipstamp configuration found');
-                    return false;
-                }
-                if (parts[1] === 'timestampEmail') {
-                    delete config.zipstamp.timestampEmail;
-                }
-                else {
-                    console.error(`❌ Unknown zipstamp key: ${parts[1]}`);
-                    return false;
-                }
-                break;
-            case 'wallet':
-                if (parts[1] === 'privateKey') {
-                    delete config.wallet.privateKey;
-                }
-                else if (parts[1] === 'network') {
-                    delete config.wallet.network;
-                }
-                else {
-                    console.error(`❌ Unknown wallet key: ${parts[1]}`);
-                    return false;
-                }
-                break;
-            case 'rpc':
-                if (!config.rpc) {
-                    console.error('❌ No RPC configuration found');
-                    return false;
-                }
-                // Support both legacy keys and dynamic network keys
-                if (parts[1] === 'baseSepolia' || parts[1] === 'baseMainnet' || parts[1] in config.rpc) {
-                    delete config.rpc[parts[1]];
-                }
-                else {
-                    console.error(`❌ Unknown RPC key: ${parts[1]}`);
-                    return false;
-                }
-                break;
-            case 'gas':
-                if (!config.gas) {
-                    console.error('❌ No gas configuration found');
-                    return false;
-                }
-                if (parts[1] === 'multiplier') {
-                    delete config.gas.multiplier;
-                }
-                else if (parts[1] === 'maxPriceGwei') {
-                    delete config.gas.maxPriceGwei;
-                }
-                else {
-                    console.error(`❌ Unknown gas key: ${parts[1]}`);
-                    return false;
-                }
-                break;
-            case 'debug':
-                if (!config.debug) {
-                    console.error('❌ No debug configuration found');
-                    return false;
-                }
-                if (parts[1] === 'verbose') {
-                    delete config.debug.verbose;
-                }
-                else if (parts[1] === 'enabled') {
-                    delete config.debug.enabled;
-                }
-                else {
-                    console.error(`❌ Unknown debug key: ${parts[1]}`);
-                    return false;
-                }
-                break;
-            default:
-                console.error(`❌ Unknown configuration key: ${key}`);
-                return false;
-        }
-        return this.save(config);
-    }
-    /**
-     * Get a masked version of the config for display (hides sensitive data)
-     */
-    static getMaskedConfig() {
-        const config = this.getConfig();
-        const masked = {
-            wallet: {
-                privateKey: config.walletKey ?
-                    `${config.walletKey.substring(0, 6)}...${config.walletKey.substring(config.walletKey.length - 4)}` :
-                    '(not set)',
-                network: config.network,
-            },
-            zipstamp: {
-                timestampEmail: config.timestampEmail || '(not set)',
-            },
-            rpc: config.rpcUrls,
-            gas: config.gas,
-            debug: config.debug,
-        };
-        return JSON.stringify(masked, null, 2);
-    }
-}
-exports.ConfigStore = ConfigStore;
-ConfigStore.configDir = path.join(os.homedir(), '.neozip');
-ConfigStore.configPath = path.join(ConfigStore.configDir, 'wallet.json');
-//# sourceMappingURL=ConfigStore.js.map