@skrillex1224/android-toolkit 0.1.9 → 1.0.0

package/src/apify-kit.js

@@ -1,217 +0,0 @@
-import fs from 'node:fs';
-
-import {Code, Status} from './constants.js';
-import {createAndroidContext} from './context.js';
-import {CrawlerError, serializeError} from './errors.js';
-import {Logger} from './logger.js';
-
-let instance = null;
-
-async function createApifyKit(options = {}) {
-    const io = {
-        inputPath: options.inputPath || '',
-        outputPath: requiredOption(options.outputPath, 'outputPath')
-    };
-    const input = options.input || (io.inputPath ? JSON.parse(fs.readFileSync(io.inputPath, 'utf8')) : {});
-    const ctx = options.ctx || createAndroidContext(input, options.contextDefaults || {});
-    let pushed = false;
-    let lastDevice = null;
-
-    return {
-        ctx,
-        input,
-        inputPath: io.inputPath,
-        outputPath: io.outputPath,
-
-        /**
-         * Android 版 runStep。
-         *
-         * 设计上贴近 playwright-toolkit 的 ApifyKit.runStep：
-         * - step 是中文步骤名；
-         * - target 位置保留给 device/session，便于未来接入云真机 live view；
-         * - actionFn 是真正业务动作；
-         * - failActor=true 时会先 pushFailed，再把错误继续抛给 Launch。
-         */
-        async runStep(step, target, actionFn, options = {}) {
-            if (target) lastDevice = target;
-            const {failActor = true} = options;
-            const startedAt = Date.now();
-
-            Logger.start(`[Step] ${step}`, stepDetail({target, failActor}));
-            try {
-                const result = await actionFn();
-                Logger.success(`[Step] ${step}`, {duration: Logger.duration(startedAt)});
-                return result;
-            } catch (error) {
-                Logger.fail(`[Step] ${step} duration=${Logger.duration(startedAt)}`, error);
-                if (failActor) {
-                    await this.pushFailed(error, {step}, {target});
-                }
-                throw error;
-            }
-        },
-
-        /**
-         * 宽松版 runStep。
-         *
-         * 和 playwright-toolkit 一样：只负责打日志和抛错，不主动写失败 dataset。
-         * 业务层可以用它包“可选截图/可选关闭弹窗/可选诊断”这类步骤。
-         */
-        async runStepLoose(step, target, fn, options = {}) {
-            return this.runStep(step, target, fn, {
-                ...options,
-                failActor: false
-            });
-        },
-
-        /**
-         * 写成功 dataset。
-         *
-         * 对齐 playwright-toolkit：业务 actor 只传业务数据，toolkit 统一补
-         * code/status/timestamp/data 外壳。这样 commander/transformer 看到的是同类结构。
-         */
-        async pushSuccess(data = {}, options = {}) {
-            const dataSummary = summarizeDatasetData(data);
-            pushed = true;
-            appendOutput(io.outputPath, {
-                code: Code.Success,
-                status: Status.Success,
-                timestamp: new Date().toISOString(),
-                data: sanitizeData(data),
-                ...(options.meta ? {meta: sanitizeData(options.meta)} : {})
-            });
-            Logger.success('pushSuccess', {
-                outputPath: io.outputPath,
-                ...dataSummary
-            });
-        },
-
-        /**
-         * 写补充 artifact dataset。
-         *
-         * 这类数据不是最终业务结果，只用于给 commander 的 ext/base64 链路消费，
-         * 例如 screenshotBase64、conversationShareLink。它不改变 hasPushed()
-         * 状态，避免 artifact 写入后主流程失败时吞掉失败 dataset。
-         */
-        async pushArtifact(data = {}) {
-            appendOutput(io.outputPath, sanitizeData(data));
-            Logger.success('pushArtifact', {
-                outputPath: io.outputPath,
-                keys: Object.keys(data || {}).join(',')
-            });
-        },
-
-        /**
-         * 写失败 dataset。
-         *
-         * 失败结构也对齐 playwright-toolkit：CrawlerError 决定 code/context，
-         * 普通 Error 统一按 UnknownError 处理，业务可预期失败必须显式抛 CrawlerError。
-         */
-        async pushFailed(error, meta = {}) {
-            const normalized = CrawlerError.isCrawlerError(error)
-                ? error
-                : CrawlerError.from(error, {code: Code.UnknownError, context: meta});
-
-            pushed = true;
-            appendOutput(io.outputPath, {
-                code: normalized.code,
-                status: Status.Failed,
-                error: serializeError(normalized),
-                meta: sanitizeData(meta),
-                context: sanitizeData(normalized.context),
-                timestamp: new Date().toISOString()
-            });
-            Logger.success('pushFailed', {
-                outputPath: io.outputPath,
-                code: normalized.code,
-                message: normalized.message
-            });
-        },
-
-        hasPushed() {
-            return pushed;
-        },
-
-        getLastDevice() {
-            return lastDevice;
-        }
-    };
-}
-
-async function useApifyKit(options = {}) {
-    if (!instance || options.reset) {
-        instance = await createApifyKit(options);
-    }
-    return instance;
-}
-
-export const ApifyKit = {
-    useApifyKit
-};
-
-function appendOutput(outputPath, item) {
-    const items = readOutputArray(outputPath);
-    items.push(item);
-    fs.writeFileSync(outputPath, JSON.stringify(items, null, 2) + '\n', 'utf8');
-}
-
-function readOutputArray(outputPath) {
-    if (!fs.existsSync(outputPath)) return [];
-    const raw = fs.readFileSync(outputPath, 'utf8').trim();
-    if (!raw) return [];
-    const parsed = JSON.parse(raw);
-    if (!Array.isArray(parsed)) {
-        throw new Error(`Android output must be a JSON array: ${outputPath}`);
-    }
-    return parsed;
-}
-
-function requiredOption(value, name) {
-    const clean = String(value || '').trim();
-    if (!clean) throw new Error(`ApifyKit.useApifyKit requires ${name}`);
-    return clean;
-}
-
-function stepDetail({target, failActor}) {
-    const detail = {failActor};
-    if (!target) return detail;
-    if (typeof target === 'string') detail.target = target;
-    else if (typeof target === 'object') {
-        detail.serial = target.serial;
-        detail.packageName = target.packageName;
-        detail.runId = target.runId;
-    }
-    return detail;
-}
-
-function summarizeDatasetData(data) {
-    const summary = {};
-    if (typeof data?.answer === 'string') summary.answerChars = data.answer.length;
-    if (Array.isArray(data?.sources)) summary.sourceCount = data.sources.length;
-    if (data?.imMessage?.message_id) summary.messageId = data.imMessage.message_id;
-    if (data?.imMessage?.local_message_id) summary.localMessageId = data.imMessage.local_message_id;
-    return summary;
-}
-
-function sanitizeData(value, depth = 0, seen = new WeakSet()) {
-    if (depth > 8) return '[MaxDepth]';
-    if (value == null) return value;
-    const valueType = typeof value;
-    if (valueType === 'string' || valueType === 'number' || valueType === 'boolean') return value;
-    if (valueType === 'bigint') return value.toString();
-    if (valueType === 'function' || valueType === 'symbol') return undefined;
-    if (value instanceof Error) return serializeError(value);
-    if (Array.isArray(value)) {
-        return value.map((item) => sanitizeData(item, depth + 1, seen)).filter((item) => item !== undefined);
-    }
-    if (valueType !== 'object') return String(value);
-    if (seen.has(value)) return '[Circular]';
-    seen.add(value);
-
-    const out = {};
-    for (const [key, item] of Object.entries(value)) {
-        const safe = sanitizeData(item, depth + 1, seen);
-        if (safe !== undefined) out[key] = safe;
-    }
-    return out;
-}

package/src/constants.js

@@ -1,75 +0,0 @@
-export const Code = {
-  Success: 0,
-  UnknownError: -1,
-  NotLogin: 30000001,
-  Chaptcha: 30000002,
-  Timeout: 30000003,
-  InitialTimeout: 30000004,
-  OverallTimeout: 30000005,
-
-  // Android-toolkit 扩展码从 300100xx 开始，避免改动 Playwright-toolkit 既有码值。
-  InvalidRequest: 30010001,
-  AdbUnavailable: 30010002,
-  ContentUnavailable: 30010003,
-  SourceExtractionFailed: 30010004,
-  AutomationFailed: 30010005,
-  RunnerFailed: 30010006,
-  AppiumUnavailable: 30010007,
-  FridaUnavailable: 30010008,
-  AppNotInstalled: 30010009
-};
-
-export const Status = {
-  Success: 'SUCCESS',
-  Failed: 'FAILED'
-};
-
-const normalizePrefix = (value) => String(value || '').trim();
-
-const normalizeShare = (value) => {
-  const raw = value && typeof value === 'object' ? value : {};
-  const modeRaw = String(raw.mode || 'clipboard').trim().toLowerCase();
-  const mode = ['clipboard', 'custom'].includes(modeRaw) ? modeRaw : 'clipboard';
-  return {
-    mode,
-    prefix: normalizePrefix(raw.prefix),
-    xurl: Array.isArray(raw.xurl) ? raw.xurl : []
-  };
-};
-
-const createActorInfo = (info) => {
-  const key = String(info?.key || '').trim();
-  const share = normalizeShare(info?.share);
-  return {
-    ...info,
-    key,
-    share,
-    get icon() {
-      if (info.icon) return info.icon;
-      return buildIcon(this.key);
-    }
-  };
-};
-
-const buildIcon = (key) => `https://static.heartbitai.com/general/actors/${key}.png`;
-
-export const ActorInfo = {
-  'doubao.android': createActorInfo({
-    key: 'doubao.android',
-    name: '豆包 Android',
-    share: {
-      mode: 'clipboard',
-      prefix: 'https://www.doubao.com/thread/',
-      xurl: []
-    }
-  }),
-  'wechat.android': createActorInfo({
-    key: 'wechat.android',
-    name: '微信 Android',
-    share: {
-      mode: 'clipboard',
-      prefix: '',
-      xurl: []
-    }
-  })
-};

package/src/context.js

@@ -1,89 +0,0 @@
-import path from 'node:path';
-import {execFileSync} from 'node:child_process';
-import {fileURLToPath} from 'node:url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const toolkitRoot = path.resolve(__dirname, '..');
-
-export const Context = {
-    createAndroidContext,
-    firstNonEmpty,
-    toolkitPath
-};
-
-/**
- * 创建 Android actor 的运行上下文。
- *
- * 这里刻意只接受 input/defaults 参数，不读取环境变量，也不写任何业务默认值：
- * - 具体 app 包名由后端注入 input.runtime.device.packageName；
- * - 不知道当前 visitor 要 attach 哪些 WebView 类；
- *
- * ADB/Frida 是机器环境，不是业务 input。toolkit 只从 PATH 查找命令；
- * 安装和 PATH 准备由 postinstall 或部署环境负责。
- */
-export function createAndroidContext(input = {}, defaults = {}) {
-    const runtime = input.runtime || {};
-    const device = normalizeRuntimeDevice(runtime.device);
-
-    return {
-        runId: firstNonEmpty(defaults.runId),
-        query: String(input.query || defaults.query || '').trim(),
-        mode: firstNonEmpty(defaults.mode, 'ai_search'),
-        serial: firstNonEmpty(device.serial, defaults.serial),
-        adbPath: resolveAdbPath(defaults),
-        packageName: firstNonEmpty(device.packageName),
-        fridaPath: resolveFridaPath(defaults),
-        // Frida WebView event agent 是当前保留的唯一 Frida agent：
-        // 它 hook WebView 执行 JS 字符串的入口，业务方再从注入事件中解析数据。
-        fridaWebViewEventAgentScript: firstNonEmpty(
-            defaults.fridaWebViewEventAgentScript,
-            toolkitPath('src/internals/frida/webview_event_agent.js')
-        ),
-        appVersion: firstNonEmpty(defaults.appVersion),
-        slotKey: firstNonEmpty(defaults.slotKey),
-        instanceId: firstNonEmpty(defaults.instanceId),
-        externalIp: firstNonEmpty(defaults.externalIp)
-    };
-}
-
-export function toolkitPath(relativePath) {
-    return path.resolve(toolkitRoot, relativePath);
-}
-
-export function firstNonEmpty(...values) {
-    for (const value of values) {
-        const clean = String(value ?? '').trim();
-        if (clean) return clean;
-    }
-    return '';
-}
-
-function normalizeRuntimeDevice(value) {
-    if (typeof value === 'string') return {serial: value};
-    if (value && typeof value === 'object') return value;
-    return {};
-}
-
-function resolveAdbPath(defaults = {}) {
-    return firstNonEmpty(
-        defaults.adbPath,
-        findCommand('adb'),
-        'adb'
-    );
-}
-
-function resolveFridaPath(defaults = {}) {
-    return firstNonEmpty(
-        defaults.fridaPath,
-        findCommand('frida'),
-        'frida'
-    );
-}
-
-function findCommand(command) {
-    try {
-        return String(execFileSync('which', [command], {encoding: 'utf8'})).trim();
-    } catch {
-        return '';
-    }
-}