@jackwener/opencli 1.7.11 → 1.7.13

package/clis/steam/app.js

@@ -0,0 +1,67 @@
+// steam app — fetch a single Steam game / DLC / app's storefront detail.
+//
+// Hits the public appdetails API (`/api/appdetails?appids=<id>`). Surfaces
+// the columns most useful for an agent: name, type, free flag, release
+// date, developers / publishers, price, metacritic, recommendations,
+// genres / categories joined.
+import { cli, Strategy } from '@jackwener/opencli/registry';
+import { EmptyResultError } from '@jackwener/opencli/errors';
+import { STEAM_STORE, decodeHtmlEntities, priceCents, requireAppId, requireCountryCode, steamFetch } from './utils.js';
+
+function joinNames(list) {
+    if (!Array.isArray(list)) return '';
+    return list
+        .map((entry) => (entry && typeof entry === 'object' ? entry.description ?? entry.name ?? '' : String(entry)))
+        .filter(Boolean)
+        .join(', ');
+}
+
+cli({
+    site: 'steam',
+    name: 'app',
+    access: 'read',
+    description: 'Steam storefront detail for a single app id',
+    domain: 'store.steampowered.com',
+    strategy: Strategy.PUBLIC,
+    browser: false,
+    args: [
+        { name: 'id', positional: true, required: true, help: 'Numeric Steam app id (e.g. "620" for Portal 2)' },
+        { name: 'currency', default: 'us', help: 'Storefront country code (e.g. us / cn / jp / de)' },
+    ],
+    columns: [
+        'id', 'name', 'type', 'isFree', 'releaseDate', 'developers', 'publishers',
+        'price', 'currency', 'metacritic', 'recommendations', 'genres', 'categories',
+        'shortDescription', 'website', 'url',
+    ],
+    func: async (args) => {
+        const appId = requireAppId(args.id);
+        const cc = requireCountryCode(args.currency);
+        const url = `${STEAM_STORE}/api/appdetails?appids=${appId}&l=en&cc=${encodeURIComponent(cc)}`;
+        const body = await steamFetch(url, `steam app ${appId}`);
+        const wrapper = body?.[appId];
+        if (!wrapper || wrapper.success !== true || !wrapper.data) {
+            throw new EmptyResultError('steam app', `Steam app id ${appId} returned no data (may be region-locked or removed).`);
+        }
+        const data = wrapper.data;
+        const isFree = data.is_free === true;
+        const priceFinal = priceCents(data?.price_overview?.final ?? null);
+        return [{
+            id: String(data.steam_appid ?? appId),
+            name: decodeHtmlEntities(data.name ?? ''),
+            type: String(data.type ?? ''),
+            isFree,
+            releaseDate: String(data?.release_date?.date ?? ''),
+            developers: Array.isArray(data.developers) ? data.developers.join(', ') : '',
+            publishers: Array.isArray(data.publishers) ? data.publishers.join(', ') : '',
+            price: isFree ? 0 : priceFinal,
+            currency: String(data?.price_overview?.currency ?? '').toUpperCase(),
+            metacritic: data?.metacritic?.score != null ? Number(data.metacritic.score) : null,
+            recommendations: data?.recommendations?.total != null ? Number(data.recommendations.total) : null,
+            genres: joinNames(data.genres),
+            categories: joinNames(data.categories),
+            shortDescription: decodeHtmlEntities(data.short_description ?? ''),
+            website: String(data.website ?? ''),
+            url: `${STEAM_STORE}/app/${data.steam_appid ?? appId}/`,
+        }];
+    },
+});

package/clis/steam/search.js

@@ -0,0 +1,58 @@
+// steam search — search the Steam storefront catalog.
+//
+// Hits the public storesearch API (`/api/storesearch/?term=…`). Returns
+// matched apps with id / name / price / metascore / platform support so
+// the row's `id` round-trips into `steam app`.
+import { cli, Strategy } from '@jackwener/opencli/registry';
+import { EmptyResultError } from '@jackwener/opencli/errors';
+import {
+    STEAM_STORE,
+    decodeHtmlEntities,
+    priceCents,
+    requireBoundedInt,
+    requireCountryCode,
+    requireString,
+    steamFetch,
+} from './utils.js';
+
+function platformList(platforms) {
+    if (!platforms || typeof platforms !== 'object') return '';
+    return ['windows', 'mac', 'linux'].filter((p) => platforms[p]).join(',');
+}
+
+cli({
+    site: 'steam',
+    name: 'search',
+    access: 'read',
+    description: 'Search the Steam storefront by name keyword',
+    domain: 'store.steampowered.com',
+    strategy: Strategy.PUBLIC,
+    browser: false,
+    args: [
+        { name: 'query', positional: true, required: true, help: 'Search keyword (e.g. "portal", "stardew")' },
+        { name: 'limit', type: 'int', default: 20, help: 'Max results (1-50)' },
+        { name: 'currency', default: 'us', help: 'Storefront country code (e.g. us / cn / jp / de)' },
+    ],
+    columns: ['rank', 'id', 'name', 'price', 'currency', 'metascore', 'platforms', 'url'],
+    func: async (args) => {
+        const query = requireString(args.query, 'query');
+        const limit = requireBoundedInt(args.limit, 20, 50);
+        const cc = requireCountryCode(args.currency);
+        const url = `${STEAM_STORE}/api/storesearch/?term=${encodeURIComponent(query)}&l=en&cc=${encodeURIComponent(cc)}`;
+        const body = await steamFetch(url, 'steam search');
+        const items = Array.isArray(body?.items) ? body.items : [];
+        if (!items.length) {
+            throw new EmptyResultError('steam search', `No Steam results matched "${query}".`);
+        }
+        return items.slice(0, limit).map((item, i) => ({
+            rank: i + 1,
+            id: String(item.id ?? ''),
+            name: decodeHtmlEntities(item.name ?? ''),
+            price: priceCents(item?.price?.final ?? null),
+            currency: String(item?.price?.currency ?? '').toUpperCase(),
+            metascore: item.metascore != null && item.metascore !== '' ? Number(item.metascore) : null,
+            platforms: platformList(item.platforms),
+            url: item.id ? `${STEAM_STORE}/app/${item.id}/` : '',
+        }));
+    },
+});

package/clis/steam/steam.test.js

@@ -0,0 +1,46 @@
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { getRegistry } from '@jackwener/opencli/registry';
+import { ArgumentError } from '@jackwener/opencli/errors';
+import { decodeHtmlEntities, requireCountryCode } from './utils.js';
+import './search.js';
+import './app.js';
+
+afterEach(() => {
+    vi.unstubAllGlobals();
+});
+
+describe('steam adapter helpers', () => {
+    it('decodes Steam HTML entities from API strings', () => {
+        expect(decodeHtmlEntities('"Perpetual Testing Initiative" & Co-op')).toBe('"Perpetual Testing Initiative" & Co-op');
+        expect(decodeHtmlEntities('Portal 2')).toBe('Portal 2');
+    });
+
+    it('validates storefront country code without silent fallback', () => {
+        expect(requireCountryCode(undefined)).toBe('us');
+        expect(requireCountryCode(' CN ')).toBe('cn');
+        expect(() => requireCountryCode('')).toThrow(ArgumentError);
+        expect(() => requireCountryCode('usd')).toThrow(ArgumentError);
+        expect(() => requireCountryCode('$$')).toThrow(ArgumentError);
+    });
+});
+
+describe('steam command argument contracts', () => {
+    it('rejects invalid search currency before fetching', async () => {
+        const fetchMock = vi.fn();
+        vi.stubGlobal('fetch', fetchMock);
+
+        const search = getRegistry().get('steam/search');
+        await expect(search.func({ query: 'portal', limit: 5, currency: '$$$' })).rejects.toThrow(ArgumentError);
+        await expect(search.func({ query: 'portal', limit: 5, currency: '' })).rejects.toThrow(ArgumentError);
+        expect(fetchMock).not.toHaveBeenCalled();
+    });
+
+    it('rejects invalid app currency before fetching', async () => {
+        const fetchMock = vi.fn();
+        vi.stubGlobal('fetch', fetchMock);
+
+        const app = getRegistry().get('steam/app');
+        await expect(app.func({ id: '620', currency: 'usd' })).rejects.toThrow(ArgumentError);
+        expect(fetchMock).not.toHaveBeenCalled();
+    });
+});

package/clis/steam/top-sellers.js

@@ -2,6 +2,7 @@ import { cli, Strategy } from '@jackwener/opencli/registry';
 cli({
     site: 'steam',
     name: 'top-sellers',
+    access: 'read',
     description: 'Steam top selling games',
     domain: 'store.steampowered.com',
     strategy: Strategy.PUBLIC,

package/clis/steam/utils.js

@@ -0,0 +1,107 @@
+// Shared helpers for the steam adapters that hit Steam's storefront JSON
+// endpoints (no browser).
+import { ArgumentError, CommandExecutionError, EmptyResultError } from '@jackwener/opencli/errors';
+
+export const STEAM_STORE = 'https://store.steampowered.com';
+const UA = 'opencli-steam-adapter (+https://github.com/jackwener/opencli)';
+
+export function requireString(value, label) {
+    const s = String(value ?? '').trim();
+    if (!s) {
+        throw new ArgumentError(`steam ${label} cannot be empty`);
+    }
+    return s;
+}
+
+export function requireCountryCode(value, defaultValue = 'us') {
+    const raw = value === undefined || value === null ? defaultValue : value;
+    const code = String(raw).trim().toLowerCase();
+    if (!/^[a-z]{2}$/.test(code)) {
+        throw new ArgumentError(
+            `steam currency must be a two-letter storefront country code (got "${value}")`,
+            'Examples: us, cn, jp, de. This controls Steam regional pricing and availability.',
+        );
+    }
+    return code;
+}
+
+export function requireBoundedInt(value, defaultValue, maxValue, label = 'limit') {
+    const raw = value ?? defaultValue;
+    const n = typeof raw === 'number' ? raw : Number(raw);
+    if (!Number.isInteger(n) || n <= 0) {
+        throw new ArgumentError(`steam ${label} must be a positive integer`);
+    }
+    if (n > maxValue) {
+        throw new ArgumentError(`steam ${label} must be <= ${maxValue}`);
+    }
+    return n;
+}
+
+export function requireAppId(value) {
+    const s = String(value ?? '').trim();
+    if (!s) {
+        throw new ArgumentError('steam app id is required (e.g. "620" for Portal 2)');
+    }
+    if (!/^\d+$/.test(s)) {
+        throw new ArgumentError(
+            `steam app id "${value}" must be a positive integer`,
+            'Copy the numeric id from `steam search` or the URL `store.steampowered.com/app/<id>/`.',
+        );
+    }
+    return s;
+}
+
+export async function steamFetch(url, label) {
+    let resp;
+    try {
+        resp = await fetch(url, { headers: { 'user-agent': UA, accept: 'application/json' } });
+    }
+    catch (err) {
+        throw new CommandExecutionError(
+            `${label} request failed: ${err?.message ?? err}`,
+            'Check that store.steampowered.com is reachable from this network.',
+        );
+    }
+    if (resp.status === 429) {
+        throw new CommandExecutionError(
+            `${label} returned HTTP 429 (rate limited)`,
+            'Steam throttles bursty traffic; wait a few seconds and retry.',
+        );
+    }
+    if (resp.status === 404) {
+        throw new EmptyResultError(label, 'Steam returned 404 — the resource does not exist.');
+    }
+    if (!resp.ok) {
+        throw new CommandExecutionError(`${label} returned HTTP ${resp.status}`);
+    }
+    let body;
+    try {
+        body = await resp.json();
+    }
+    catch (err) {
+        throw new CommandExecutionError(`${label} returned malformed JSON: ${err?.message ?? err}`);
+    }
+    return body;
+}
+
+export function asString(value) {
+    return value == null ? '' : String(value);
+}
+
+const HTML_ENTITIES = {
+    '&amp;': '&', '&lt;': '<', '&gt;': '>', '&quot;': '"', '&apos;': "'", '&#39;': "'", '&nbsp;': ' ',
+};
+
+export function decodeHtmlEntities(value) {
+    return String(value ?? '')
+        .replace(/&#x([0-9a-fA-F]+);/g, (_, h) => String.fromCodePoint(parseInt(h, 16)))
+        .replace(/&#(\d+);/g, (_, d) => String.fromCodePoint(parseInt(d, 10)))
+        .replace(/&(amp|lt|gt|quot|apos|#39|nbsp);/g, (m) => HTML_ENTITIES[m] || m);
+}
+
+export function priceCents(cents) {
+    if (cents == null || cents === '') return null;
+    const n = Number(cents);
+    if (!Number.isFinite(n)) return null;
+    return Number((n / 100).toFixed(2));
+}

package/clis/substack/feed.js

@@ -3,6 +3,7 @@ import { buildSubstackBrowseUrl, loadSubstackFeed } from './utils.js';
 cli({
     site: 'substack',
     name: 'feed',
+    access: 'read',
     description: 'Substack 热门文章 Feed',
     domain: 'substack.com',
     strategy: Strategy.COOKIE,

package/clis/substack/publication.js

@@ -3,6 +3,7 @@ import { loadSubstackArchive } from './utils.js';
 cli({
     site: 'substack',
     name: 'publication',
+    access: 'read',
     description: '获取特定 Substack Newsletter 的最新文章',
     domain: 'substack.com',
     strategy: Strategy.COOKIE,

package/clis/substack/search.js

@@ -59,6 +59,7 @@ async function searchPublications(keyword, limit) {
 cli({
     site: 'substack',
     name: 'search',
+    access: 'read',
     description: '搜索 Substack 文章和 Newsletter',
     domain: 'substack.com',
     strategy: Strategy.PUBLIC,

package/clis/taobao/add-cart.js

@@ -4,6 +4,7 @@ import { normalizeNumericId } from '../_shared/common.js';
 cli({
     site: 'taobao',
     name: 'add-cart',
+    access: 'write',
     description: '淘宝加入购物车',
     domain: 'item.taobao.com',
     strategy: Strategy.COOKIE,

package/clis/taobao/cart.js

@@ -4,6 +4,7 @@ import { clampInt } from '../_shared/common.js';
 cli({
     site: 'taobao',
     name: 'cart',
+    access: 'read',
     description: '查看淘宝购物车',
     domain: 'cart.taobao.com',
     strategy: Strategy.COOKIE,

package/clis/taobao/commands.test.js

@@ -5,30 +5,7 @@ import './detail.js';
 import './reviews.js';
 import './cart.js';
 import './add-cart.js';
-function createPageMock() {
-    return {
-        goto: vi.fn().mockResolvedValue(undefined),
-        evaluate: vi.fn().mockResolvedValue({ title: 'Demo', price: '¥99' }),
-        snapshot: vi.fn().mockResolvedValue(undefined),
-        click: vi.fn().mockResolvedValue(undefined),
-        typeText: vi.fn().mockResolvedValue(undefined),
-        pressKey: vi.fn().mockResolvedValue(undefined),
-        scrollTo: vi.fn().mockResolvedValue(undefined),
-        getFormState: vi.fn().mockResolvedValue({ forms: [], orphanFields: [] }),
-        wait: vi.fn().mockResolvedValue(undefined),
-        tabs: vi.fn().mockResolvedValue([]),
-        selectTab: vi.fn().mockResolvedValue(undefined),
-        networkRequests: vi.fn().mockResolvedValue([]),
-        consoleMessages: vi.fn().mockResolvedValue([]),
-        scroll: vi.fn().mockResolvedValue(undefined),
-        autoScroll: vi.fn().mockResolvedValue(undefined),
-        installInterceptor: vi.fn().mockResolvedValue(undefined),
-        getInterceptedRequests: vi.fn().mockResolvedValue([]),
-        getCookies: vi.fn().mockResolvedValue([]),
-        screenshot: vi.fn().mockResolvedValue(''),
-        waitForCapture: vi.fn().mockResolvedValue(undefined),
-    };
-}
+import { createPageMock } from '../test-utils.js';
 describe('taobao command registration', () => {
     it('registers all taobao shopping commands', () => {
         for (const name of ['search', 'detail', 'reviews', 'cart', 'add-cart']) {

package/clis/taobao/detail.js

@@ -3,6 +3,7 @@ import { normalizeNumericId } from '../_shared/common.js';
 cli({
     site: 'taobao',
     name: 'detail',
+    access: 'read',
     description: '淘宝商品详情',
     domain: 'item.taobao.com',
     strategy: Strategy.COOKIE,

package/clis/taobao/reviews.js

@@ -3,6 +3,7 @@ import { clampInt, normalizeNumericId } from '../_shared/common.js';
 cli({
     site: 'taobao',
     name: 'reviews',
+    access: 'read',
     description: '淘宝商品评价',
     domain: 'item.taobao.com',
     strategy: Strategy.COOKIE,

package/clis/taobao/search.js

@@ -4,6 +4,7 @@ import { clampInt, requireNonEmptyQuery } from '../_shared/common.js';
 cli({
     site: 'taobao',
     name: 'search',
+    access: 'read',
     description: '淘宝商品搜索',
     domain: 's.taobao.com',
     strategy: Strategy.COOKIE,

package/clis/tdx/hot-rank.js

@@ -5,6 +5,7 @@ const TDX_HOT_URL = 'https://pul.tdx.com.cn/site/app/gzhbd/tdx-topsearch/page-ma
 cli({
   site: 'tdx',
   name: 'hot-rank',
+    access: 'read',
   description: '通达信热搜榜',
   domain: 'pul.tdx.com.cn',
   strategy: Strategy.COOKIE,

package/clis/test-utils.js

@@ -0,0 +1,61 @@
+import { vi } from 'vitest';
+
+/**
+ * Create a page mock with all standard browser automation methods.
+ *
+ * @param {any[]} evaluateResults - Sequential results for page.evaluate() calls
+ * @param {Record<string, any>} [overrides] - Override or add mock methods
+ * @returns A mock page object compatible with OpenCLI's browser page interface
+ */
+export function createPageMock(evaluateResults = [], overrides = {}) {
+    const evaluate = vi.fn();
+    for (const result of evaluateResults) {
+        evaluate.mockResolvedValueOnce(result);
+    }
+    return {
+        // Navigation
+        goto: vi.fn().mockResolvedValue(undefined),
+        tabs: vi.fn().mockResolvedValue([]),
+        selectTab: vi.fn().mockResolvedValue(undefined),
+        closeTab: vi.fn().mockResolvedValue(undefined),
+        newTab: vi.fn().mockResolvedValue(undefined),
+
+        // Content extraction
+        evaluate,
+        snapshot: vi.fn().mockResolvedValue(undefined),
+        screenshot: vi.fn().mockResolvedValue(''),
+
+        // User interaction
+        click: vi.fn().mockResolvedValue(undefined),
+        typeText: vi.fn().mockResolvedValue(undefined),
+        pressKey: vi.fn().mockResolvedValue(undefined),
+        scrollTo: vi.fn().mockResolvedValue(undefined),
+        scroll: vi.fn().mockResolvedValue(undefined),
+        autoScroll: vi.fn().mockResolvedValue(undefined),
+        setFileInput: vi.fn().mockResolvedValue(undefined),
+
+        // Form handling
+        getFormState: vi.fn().mockResolvedValue({ forms: [], orphanFields: [] }),
+
+        // Monitoring
+        networkRequests: vi.fn().mockResolvedValue([]),
+        consoleMessages: vi.fn().mockResolvedValue([]),
+
+        // Request interception
+        installInterceptor: vi.fn().mockResolvedValue(undefined),
+        getInterceptedRequests: vi.fn().mockResolvedValue([]),
+        waitForCapture: vi.fn().mockResolvedValue(undefined),
+
+        // Network capture
+        startNetworkCapture: vi.fn().mockResolvedValue(undefined),
+        readNetworkCapture: vi.fn().mockResolvedValue([]),
+
+        // Auth
+        getCookies: vi.fn().mockResolvedValue([]),
+
+        // Wait
+        wait: vi.fn().mockResolvedValue(undefined),
+
+        ...overrides,
+    };
+}

package/clis/ths/hot-rank.js

@@ -5,6 +5,7 @@ const THS_HOT_URL = 'https://eq.10jqka.com.cn/webpage/ths-hot-list/index.html?sh
 cli({
   site: 'ths',
   name: 'hot-rank',
+    access: 'read',
   description: '同花顺热股榜',
   domain: 'eq.10jqka.com.cn',
   strategy: Strategy.COOKIE,

package/clis/tieba/hot.js

@@ -4,15 +4,15 @@ import { normalizeTiebaLimit } from './utils.js';
 cli({
     site: 'tieba',
     name: 'hot',
+    access: 'read',
     description: 'Tieba hot topics',
     domain: 'tieba.baidu.com',
     strategy: Strategy.PUBLIC,
     browser: true,
-    navigateBefore: false,
     args: [
         { name: 'limit', type: 'int', default: 20, help: 'Number of items to return' },
     ],
-    columns: ['rank', 'title', 'discussions', 'description'],
+    columns: ['rank', 'title', 'discussions', 'description', 'url'],
     func: async (page, kwargs) => {
         const limit = normalizeTiebaLimit(kwargs.limit);
         // Use the default browser settle path so we do not scrape the previous page.

package/clis/tieba/posts.js

@@ -60,6 +60,7 @@ async function fetchTiebaPagePc(page, kwargs, limit) {
 cli({
     site: 'tieba',
     name: 'posts',
+    access: 'read',
     description: 'Browse posts in a tieba forum',
     domain: 'tieba.baidu.com',
     strategy: Strategy.COOKIE,

package/clis/tieba/read.js

@@ -111,6 +111,7 @@ function buildExtractReadEvaluate() {
 cli({
     site: 'tieba',
     name: 'read',
+    access: 'read',
     description: 'Read a tieba thread',
     domain: 'tieba.baidu.com',
     strategy: Strategy.COOKIE,

package/clis/tieba/search.js

@@ -81,6 +81,7 @@ function assertSupportedPage(kwargs) {
 cli({
     site: 'tieba',
     name: 'search',
+    access: 'read',
     description: 'Search posts across tieba',
     domain: 'tieba.baidu.com',
     strategy: Strategy.COOKIE,
@@ -92,7 +93,7 @@ cli({
         { name: 'page', type: 'int', default: 1, choices: ['1'], help: 'Page number (currently only 1 is supported)' },
         { name: 'limit', type: 'int', default: 20, help: 'Number of items to return' },
     ],
-    columns: ['rank', 'title', 'forum', 'author', 'time'],
+    columns: ['rank', 'id', 'title', 'forum', 'author', 'time', 'url'],
     func: async (page, kwargs) => {
         assertSupportedPage(kwargs);
         const limit = normalizeTiebaLimit(kwargs.limit);