@oniroproject/core 0.17.0 → 0.18.0

package/dist/index.d.cts

@@ -28,7 +28,7 @@ declare const noopProgress: ProgressReporter;
  * Keys read from the ConfigProvider by core. Frontends (CLI, VS Code extension)
  * implement the provider however they like (env vars, settings.json, etc.).
  */
-type ConfigKey = 'sdkRootDir' | 'cmdToolsPath' | 'hdcPath' | 'emulatorDir' | 'hapPath' | 'cmdToolsUrlLinux' | 'cmdToolsUrlWindows' | 'cmdToolsUrlMac' | 'emulatorUrl' | 'tmpDir' | 'sdkUrlBase' | 'applicationCertPath' | 'harmonyosSdkPath' | 'harmonyosAuthDir' | 'harmonyosSigningDir' | 'cacheDir';
+type ConfigKey = 'sdkRootDir' | 'cmdToolsPath' | 'hdcPath' | 'emulatorDir' | 'hapPath' | 'cmdToolsUrlLinux' | 'cmdToolsUrlWindows' | 'cmdToolsUrlMac' | 'emulatorUrl' | 'tmpDir' | 'sdkUrlBase' | 'applicationCertPath' | 'harmonyosSdkPath' | 'harmonyosAuthDir' | 'harmonyosSigningDir' | 'cacheDir' | 'docsDir';
 interface ConfigProvider {
     /**
      * Get the configured value for `key`, or `fallback` if unset/empty.
@@ -5963,6 +5963,200 @@ declare function parseActiveRefreshRate(hidumper: string): number | null;
  */
 declare function perfTrace(opts: PerfTraceOptions): Promise<PerfTraceReport>;
 
+/**
+ * Search over the OpenHarmony application-development documentation (`docs sync`
+ * clones `en/application-dev` of gitcode.com/openharmony/docs). The SDK typings
+ * behind `api search` / `api show` say whether a symbol exists and with what
+ * signature; the docs say how an API is used, which business error codes a kit
+ * throws and how the platform behaves. The index is deterministic, built in memory
+ * in a few seconds from titles, headings and an inverted word index, and answers a
+ * query in milliseconds; bodies are read on demand.
+ */
+interface DocEntry {
+    /** Path relative to the `en/application-dev` tree, e.g. `ui/arkts-navigation-jump.md`. */
+    path: string;
+    title: string;
+    /** Every `##`–`####` heading with its 1-based line. */
+    headings: DocHeading[];
+    bytes: number;
+}
+interface DocHeading {
+    line: number;
+    level: number;
+    text: string;
+}
+interface DocSearchHit {
+    path: string;
+    title: string;
+    score: number;
+    /** Headings that contain a query word (at most 6), to pass to `show`. */
+    headings: {
+        line: number;
+        text: string;
+    }[];
+    /** First paragraph after the title, trimmed. */
+    snippet: string;
+}
+interface DocSearchOptions {
+    /** At most n hits (default 8, at most 30). */
+    limit?: number;
+    /** Only documents under this subtree, e.g. `ui`, `reference/errorcodes`. */
+    section?: string;
+}
+interface DocSearchResult {
+    query: string;
+    /** The words the query was read as. */
+    terms: string[];
+    total: number;
+    hits: DocSearchHit[];
+}
+interface DocShowOptions {
+    /** A heading (or a distinctive part of it, case-insensitive): only that section. */
+    heading?: string;
+    /** Line cap (default 250, at most 1200). */
+    maxLines?: number;
+}
+type DocShowResult = {
+    found: true;
+    path: string;
+    /** The text (images and inline HTML dropped), cut at `maxLines` with a note. */
+    text: string;
+    truncated: boolean;
+    /** The headings inside what was shown. */
+    headings: {
+        line: number;
+        text: string;
+    }[];
+    /** Lines of the whole section before the cap. */
+    lines: number;
+} | {
+    found: false;
+    path: string;
+    error: string;
+    /** Similar document paths, or the document's headings when the heading did not match. */
+    suggestions: string[];
+};
+/** Every `.md` under `tree`, sorted, skipping figure directories. */
+declare function listMarkdown(tree: string): string[];
+/** Lower-cased words of a text: identifiers keep their dots, 2–40 chars, no long digit runs (hashes, ids). */
+declare function docTokens(text: string): string[];
+interface QueryTerm {
+    term: string;
+    /** 1 for a word of the query, 0.4 for a part of a camelCase or dotted identifier. */
+    weight: number;
+}
+/**
+ * The query's words plus the parts of camelCase and dotted identifiers
+ * (`NavPathStack` → nav, path, stack), so a guide that says "path stack" still matches;
+ * the parts weigh less and are not required.
+ */
+declare function docQueryTerms(query: string): QueryTerm[];
+/** Whether `term` occurs in `text` as a whole word (a trailing API-level suffix such as `insert10+` still counts). */
+declare function wordIn(text: string, term: string): boolean;
+/** Title and headings of one document. */
+declare function parseDoc(rel: string, text: string): DocEntry;
+/**
+ * Distinct index words of a document: its text plus the words of its path. A dotted
+ * identifier also contributes its parts (`this.pathstack.pushpathbyname` → pathstack,
+ * pushpathbyname) and a word with a trailing API-level suffix its stem
+ * (`pushpathbyname10` → pushpathbyname), so the words a reader types are the words
+ * the index holds.
+ */
+declare function docWords(rel: string, text: string): Set<string>;
+declare class DocsIndex {
+    readonly tree: string;
+    readonly docs: readonly DocEntry[];
+    /** Build time, ms. */
+    readonly buildMs: number;
+    /** word → ascending document ids (packed: 4 bytes per occurrence). */
+    private readonly postings;
+    private constructor();
+    /** The index of a tree, built on the first call of a process and kept. */
+    static load(tree: string): DocsIndex;
+    /** An index over in-memory documents (tests). `tree` is used by `show` for reading files. */
+    static fromDocs(tree: string, docs: {
+        path: string;
+        text: string;
+    }[]): DocsIndex;
+    /** Forget the cached index of a tree (after a sync). */
+    static forget(tree: string): void;
+    get size(): number;
+    private has;
+    /**
+     * Documents containing every word of the query (any of them when none does), scored by
+     * where the words occur: title, headings, path, body; a document whose title is exactly a
+     * query word, or that contains the whole query in a title or heading, ranks higher; the
+     * generated API reference ranks a little below the guides, system-API pages and tables of
+     * contents below everything.
+     */
+    search(query: string, o?: DocSearchOptions): DocSearchResult;
+    private snippet;
+    /**
+     * A document, or one of its sections: from the heading that matches `heading`
+     * (exactly, else by substring, case-insensitive) to the next heading of the same or a
+     * higher level. Image lines and inline HTML are dropped; the text is cut at `maxLines`
+     * with a note of what was left out.
+     */
+    show(rel: string, o?: DocShowOptions): DocShowResult;
+}
+
+/** The OpenHarmony documentation repository. */
+declare const DOCS_REPO = "https://gitcode.com/openharmony/docs";
+/** The part of the repository `docs search` reads; device, kernel and the Chinese tree stay out. */
+declare const DOCS_SPARSE_PATH = "en/application-dev";
+/** Sparse-checkout patterns (non-cone): the tree without its figures, which are about 90% of its bytes. */
+declare const DOCS_SPARSE_PATTERNS: readonly string[];
+/**
+ * The release branch of the docs repository for an SDK: from its version
+ * (`oh-uni-package.json`: `6.1.0.31` → `OpenHarmony-6.1-Release`, `5.1.0.107` →
+ * `OpenHarmony-5.1.0-Release`), else from the API level (18 → 5.1.0, 20 → 6.0,
+ * 23 → 6.1, 26 → 7.0), else `master`.
+ */
+declare function docsRefFor(sdk: {
+    api?: number;
+    version?: string;
+}): string;
+/** `{ api, version }` of an SDK API directory, from `ets/oh-uni-package.json`; empty when unreadable. */
+declare function readSdkRelease(sdkDir: string): {
+    api?: number;
+    version?: string;
+};
+/** Where the clones live: the `docsDir` config key, default `<sdkRootDir>/docs`. */
+declare function getDocsRootDir(config: ConfigProvider): string;
+/** The clone of one release: `<docs root>/<ref>`. */
+declare function docsDirFor(config: ConfigProvider, ref: string): string;
+/** The `en/application-dev` tree of a clone, or null when the release has not been synced. */
+declare function docsTree(docsDir: string): string | null;
+interface SyncDocsOptions {
+    /** The branch or tag to clone. */
+    ref: string;
+    /** Where to clone (normally `docsDirFor(config, ref)`). */
+    dir: string;
+    /** Repository URL (default {@link DOCS_REPO}). */
+    repo?: string;
+    logger?: Logger;
+    /** Per git step; the clone of a release takes a minute or two. Default 10 minutes. */
+    timeoutMs?: number;
+    abortSignal?: AbortSignal;
+}
+interface SyncDocsResult {
+    dir: string;
+    ref: string;
+    /** Markdown files under `en/application-dev`. */
+    files: number;
+    /** False when the clone was created, true when an existing one was brought up to date. */
+    updated: boolean;
+    /** The commit the tree is at. */
+    commit?: string;
+}
+/**
+ * Clone or update the documentation of one release: a partial (`--filter=blob:none`),
+ * depth-1, sparse clone of `en/application-dev` without its figures, about 100 MB
+ * instead of the 2 GB a plain clone of the tree is. A second call on an existing
+ * clone fetches the branch head and resets to it. Needs `git` on the PATH.
+ */
+declare function syncDocs(opts: SyncDocsOptions): Promise<SyncDocsResult>;
+
 declare const VERSION: string;
 
-export { ALL_SDKS, API_INDEX_FORMAT, APL_VALUES, APP_FEATURE_VALUES, type AbilityInfo, type AgcAuthInfo, AgcError, type AnalyzeFaultLogOptions, type ApiElsewhere, type ApiEntry, type ApiIndex, type ApiLanguage, type ApiSdkSelection, type ApiSearchHit, type ApiSearchOptions, type ApiSearchResult, type ApiShowResult, type ApiSymbolKind, type Apl, type AppFeature, type ApplyChangesOptions, type ApplyChangesResult, type ArktsCheckOptions, type ArktsCheckReport, type ArktsCheckSdk, type ArktsCheckSummary, BLANK_BACKGROUND_SHARE, BLANK_MAX_STDDEV, BLANK_PHASH_DISTANCE, type BaseImageFingerprint, type BinderEdge, type BinderInfo, type BinderNode, type BinderPropagation, type BinderTransaction, type BlankAnalysis, type BuildApiIndexOptions, type BuildDiagnostic, BuildFailedError, type BuildHapOptions, type BuildHapResult, type BuildReport, type BuildSdk, type BuildSummary, type BundleOptions, CMD_TOOLS_REQUIRED, CancelledError, type CaptureBurstOptions, type CaptureLogOptions, type CaptureLogResult, type CertificateInfo, ChecksumMismatchError, type CmdToolsFlavour, type CmdToolsFsOps, type CmdToolsInfo, CmdToolsNotInstalledError, type CmdToolsSdk, type CmdToolsStatus, type CmdWrapper, type CodelinterFinding, type CodelinterReport, type CodelinterResult, type CodelinterSummary, CommandFailedError, type ConfigKey, type ConfigProvider, type CppCrashLog, type CrashJson, type CrashVerdict, type CreateScaffoldOptions, type CreateScaffoldResult, DEFAULT_BOOT_TIMEOUT_SECONDS, DEFAULT_EMULATOR_PID_FILE, DEFAULT_PERF_FLOW_TAIL_MS, DEFAULT_PERF_FOR_MS, DEFAULT_SMOKE_DELAY_MS, DEFAULT_SMOKE_PID_TIMEOUT_MS, DEFAULT_TRACE_BUFFER_KB, DEFAULT_TRACE_CATEGORIES, type Declaration, type Decorator, type DeveloperAgreementStatus, type DeviceFullInfo, type DeviceInfo, type DiagnosticSource, type DiscoverHapsOptions, type DisplaySize, type DisplaySizeOptions, type DivergenceLayout, type DivergenceReason, type DocTags, type DoctorCheck, type DoctorOptions, type DoctorProject, type DoctorReport, type DoctorStatus, type DoctorVersions, type DownloadOptions, type DslSelector, type DumpLayoutOptions, type DumpLayoutResult, type DumpLogOptions, EMULATOR_KERNEL_APPEND, type ElementQuery, type ElementSelector, type EmulatorAccel, type EmulatorHealth, type EmulatorInstanceStatus, type EmulatorStatus, type ExtractZipOptions, FAULTLOG_DIR, FAULTLOG_TEMP_DIR, FAULT_LOG_FAMILIES, FLOW_ACTIONS, FLOW_VERSION, type FaultCompleteness, type FaultConfidence, type FaultLogClassification, type FaultLogDeviceOptions, type FaultLogEntry, type FaultLogFamily, type FaultLogKind, type FindInOtherSdksOptions, type FlatLayoutNode, type Flow, type FlowAction, type FlowDevice, FlowFormatError, type FlowFromRecordingInput, type FlowFromRecordingResult, type FlowPoint, type FlowStep, type FrameArea, type FreezeLog, type FreezeReport, type GenerateSigningConfigsOptions, type GenerateSigningConfigsResult, type GestureUitestOptions, type GetDeviceInfoOptions, type GreyImage, type GreyscaleDecoder, HARMONYOS_SDK_VERSIONS, HASH_BITS, HUAWEI_SITES, type HapAssetDiff, type HapProfileReport, type HapSigner, type HapSigningInfo, type HapVerifyStatus, type HapZip, type HarmonyOsAutoSignOptions, type HarmonyOsLoginOptions, type HarmonyOsSdk, type HarmonyOsSdkListing, type HarmonyOsSdkSource, type HarmonyOsSession, type HarmonyOsSessionOptions, type HarmonyOsSignHapOptions, type HarmonyOsSignHapResult, type HarmonyOsSigningResult, type HdcBootProbe, type HdcExecOptions, type HdcExecResult, type HdcShellOptions, type HealthInputs, type HidumperOptions, type HilogEntry, type HilogLevel, type HiperfFunction, type HiperfReport, type HuaweiSite, type HuaweiSiteCode, type HuaweiTeam, type HuaweiUserInfo, INSTALL_TMP_DIRNAME, type ImageComparison, type IndexedLayoutNode, type InputType, type InstallAppOptions, type InstallAppResult, type InstallCandidate, type InstallCmdToolsOptions, type InstallCmdToolsResult, type InstallEmulatorOptions, type InstallMethod, type InstallSdkFromArchiveOptions, type InstallSdkOptions, type InstallTempDir, type InstallTempDirOptions, type InstalledSdk, InsufficientSpaceError, type JsCrashLog, type JsFrame, type KeyboardState, LAYOUT_COMPONENTS, LAYOUT_MOVED_IOU, type LatestCrashOptions, type LaunchAppOptions, type LayoutDiff, type LayoutDiffNode, type LayoutMatch, type LayoutMatchKind, type LayoutNode, type LayoutSelector, type LayoutSummary, type LayoutWindow, type LayoutWindowSummary, type ListFaultLogsOptions, type ListWindowsOptions, type LoadApiIndexOptions, type LoadedApiIndex, type LocateTargetOptions, type LocatedTarget, type Logger, MAX_FAULTLOG_BYTES, MAX_POOL_INSTANCE, type MissingSdkSymbol, type ModuleHaps, NO_WINDOW, type NativeFrame, type NearMatch, OHOS_DAILY_BUILDS_URL, OHOS_URL_BASE, type OniroContext, OniroError, type OsFolder, type OutputSink, POOL_DEFAULT_MEMORY, POOL_DEFAULT_RESOLUTION, POOL_DEFAULT_SMP, POOL_DISKS, POOL_REQUIRED_IMAGES, type ParamOptions, type ParseTraceOptions, type ParsedBuildOutput, type ParsedTestOutput, type PerfFrameStats, type PerfGateResult, type PerfScene, type PerfStartup, type PerfThresholds, type PerfTraceOptions, type PerfTraceReport, type PerformInputOptions, type PerformInputResult, type PickTargetFailure, type PickedHap, type PoolInstancePorts, type PoolInstanceState, type PoolQemuSpec, type PrepareSigningOptions, type PrepareSigningResult, type ProgressReporter, type ProgressUpdate, type ProjectModule, type Prompter, type ProvisionProfileInfo, type RawLayoutNode, type RawTouchEvent, type ReadFaultLogOptions, type RebootDecision, type RebootOptions, type RecordFlowOptions, type RecordFlowResult, type RecordedElement, type RecordingTimes, type RecvFileOptions, type ReplayFlowOptions, type ReplayReport, type ReplayStepResult, type ResolveApiSdkOptions, type RouteSpecResult, type RunCodelinterOptions, type RunHvigorwOptions, type RunHvigorwResult, type RunOhpmOptions, type RunProcessOptions, type RunTestsOptions, type RunningProcess, type RuntimeOs, SAME_MAX_CHANGE_RATIO, SAME_MAX_HASH_DISTANCE, SELECTOR_KEYS, SIGNED_HAP_CHUNK_SIZE, SIGNING_ERRORS, type ScannedSource, type ScreenDump, type ScreenPage, type ScreenPlaceholder, type ScreenRoute, type ScreenSpecResult, type ScreensInventory, type ScreensOptions, type ScreensSpec, type ScreensSpecReport, type Screenshot, type ScreenshotOptions, type SdkArchiveInfo, type SdkInfo, SdkNotInstalledError, type SdkPkgInfo, type SdkRelease, type SelectorClause, type SelectorKey, type SelectorOperator, SelectorParseError, type SendFileOptions, type SendGestureOptions, type SendInputOptions, type SendRawTouchOptions, type SetHilogLevelOptions, type SignOpenHarmonyHapOptions, type SignOpenHarmonyHapResult, type SigningKind, type SigningMaterialPaths, type SigningMaterialSummary, type SigningPasswords, type SmokeCheckOptions, type SmokeCrashProbe, type SmokeCrashProbeArgs, type SmokeResult, type SourceComment, type StackFrame, type StartEmulatorOptions, type StartPoolInstanceOptions, type StopPoolInstanceOptions, type StoredSession, type StreamHilogOptions, type SummarizeTraceOptions, THREAD_HEADER_RE, TMP_DIR_HINT, TargetNotFoundError, type TemplateOption, type TestCaseResult, type TestOutcome, type TestRunReport, type TestStatus, type TestSummary, type ThreadStack, type Token, type TokenKind, type TokenStore, type TraceAsyncSlice, type TraceCounterSample, type TraceModel, TraceParser, type TraceSlice, type TraceSummary, UI_RECORD_CSV, type UiInputType, type UiRecordEvent, type UiRecordFinger, UnsupportedPlatformError, VERSION, type VerifyHapOptions, type VerifyHapResult, type WaitForBootOptions, type WaitForBundleOptions, type WaitForConditionOptions, type WaitForLogOptions, type WaitForTargetOptions, type WaitPoolInstanceReadyOptions, type WakeScreenOptions, type WakeScreenResult, type WatchLogOptions, type Waypoint, type WindowInfo, type XPathExpression, type XPathSelector, aaTestCommand, alignTouches, allIndexed, analyzeBlank, analyzeFaultLog, apiIndexCachePath, apiIndexKey, apiLevelOf, appSandboxDir, applyChanges, arktsCheckerScript, assertDevicePath, assertLayoutSelector, assertPoolInstance, attemptHdcConnection, boxIoU, buildApiIndex, buildCmdWrapper, buildGestureCommands, buildGestureUitestCommand, buildHap, buildHvigorwArgs, buildInputCommand, buildOutputTail, buildPoolQemuArgs, buildPropagation, buildRawTouchCommand, buildWithDiagnostics, bundleNameFromHapConfig, captureBurst, captureLog, checkArkts, checkCmdTools, checkCmdToolsFlavour, checkDisk, checkNode, checkScreensAgainstSpec, checkSigning, classifyEmulatorHealth, classifyFaultLog, clauseMatches, cleanBuildOutput, cleanCodelinterOutput, cleanMarkerName, commMatchesBundle, compareImages, consoleLogger, createHarmonyOsSession, createInstallTempDir, createMaterial, createScaffold, createTempWorkDir, createTokenStore, cropRows, dHash, decideInstallMethod, decideOutcome, decideReboot, decryptPwd, dedupEntries, defaultContext, defaultPaths, defaultSignedHapPath, dependencyApiDiagnostic, describeBuildSdk, describeCmdTools, describeLayoutNode, describeProfileValidity, describeProject, describeReplacement, describeSigningMaterial, deserializeApiIndex, detectAaStartFailure, detectCmdToolsFlavour, detectInstallFailure, detectProjectSdkVersion, detectRuntimeOs, detectSigningConfigNames, diagnoseBuildFailure, diffEntryNames, diffHapAssets, diffLayouts, discoverHaps, downloadAndInstallSdk, downloadFile, dumpLayout, dumpLog, dumpRenderService, dumpScreen, dumpWindow, elementAt, emulatorAccelArgs, encryptPwd, ensureFreeSpace, ensureInstallOk, ensureOhModules, ensureOk, ensureRemoteOk, escapeCmdArgument, escapeCmdCommand, evaluatePerfGate, evaluateXPath, existingHapOrUnsigned, expectFor, extractStackErrors, extractTarball, extractZipWithProgress, faultloggerCommand, fieldSelector, findApiInOtherSdks, findAppPids, findAppPidsBySurface, findAppProcessId, findCmdToolsSourceDir, findCoveredNodes, findHapSignTool, findHarmonyOsSdk, findKeyboardWindow, findLayoutNodes, findMissingProjectSdk, findRunningProcess, findSdkOsDir, findVisibleMatch, flatFrameHash, flatLayoutNode, flattenLayout, flowFromRecording, forceStop, formatBytes, formatFlow, formatHapVerification, formatSelector, formatUtc, generateSigningConfigs, getApiIndexCacheDir, getBundleName, getCmdToolsBin, getCmdToolsDownloadUrl, getCmdToolsPath, getCmdToolsStatus, getDefaultInstanceStatus, getDeviceInfo, getDisplaySize, getEmulatorDir, getEmulatorStatus, getFreeSpaceBytes, getHarmonyOsSdkListing, getHdcPath, getHvigorwPath, getImeBundles, getInstalledSdks, getKey, getMainAbility, getOhosBaseSdkHome, getOhpmPath, getOsFolder, getPoolInstanceStatus, getSdkFilename, getSdkRootDir, getSupportedSdksForUi, hammingDistance, harmonyOsAutoSign, harmonyOsSdkLabelForApi, harmonyOsSignHap, hasOwnFields, hdcClientFailure, hdcExec, hdcTargetArgs, hdcTargetArgsFor, hideKeyboard, hilogSection, hilogTimeMs, holdScreenOn, indexLayout, installApp, installCmdTools, installEmulator, installFailureReason, installSdkFromArchive, installedApiLevels, inventoryScreens, isBundleInstalled, isCmdToolsInstalled, isCrashJson, isElementSelector, isEmulatorInstalled, isInstanceProcess, isLockScreenShown, isOutOfSpaceError, isPidAlive, isRamBackedPath, isTcpPortFree, isTestHap, isUnsignedHap, isUsableDevice, isValidBundleName, isValidProjectName, keystrokeChar, keystrokeName, killProcessTree, latestCrash, launchApp, listAbilities, listDevices, listFaultLogs, listLayoutWindows, listModules, listPoolInstanceNumbers, listPoolInstanceStatuses, listRunningProcesses, listTemplates, listWindows, livePoolPids, loadApiIndex, locateTarget, matchSelector, mergeDocBlocks, missingProjectRootFiles, missingSdkSymbols, nameParts, nearMatches, needsCmdWrapper, nodeLabel, nonInteractivePrompter, noopLogger, noopProgress, normaliseLocalPath, normalizeFaultTime, normalizeKit, ohModulesPackage, pHash, pagesMatching, paramGet, paramGetMany, paramSet, parseActiveRefreshRate, parseArktsCheckOutput, parseBinder, parseBounds, parseBuildOutput, parseCodelinterFindings, parseCodelinterReport, parseCppCrash, parseCrashRecordHeads, parseDeviceList, parseDeviceTime, parseDocBlock, parseFaultLogList, parseFaultLogName, parseFlow, parseFrame, parseFreeze, parseHilogLine, parseHiperfReport, parseImeBundles, parseJsCrash, parseJsFrame, parseLayoutBaseline, parseMainAbilityFromBmDump, parseNativeFrame, parseParamValues, parsePowerState, parseProvisionProfile, parseRecorderForeground, parseRemoteExit, parseSelector, parseTestOutput, parseThreadStacks, parseTouchDowns, parseTraceFile, parseTraceText, parseUiRecordLines, parseUtcOffset, parseWindowList, parseXPath, perfSliceFilter, perfTrace, performInput, pickHap, pickSigningKind, pickTarget, pixelChangeRatio, poolInstanceDir, poolInstancePorts, poolRootDir, prepareSigning, probeEmulatorBoot, pruneLayout, quantile, rawWindowSubtree, readCmdToolsInfo, readDefaultEmulatorPid, readFaultLog, readFlowFile, readHapBundleName, readHapSigningInfo, readJson5File, readJsonFile, readLogTail, readPoolState, readProvisionProfile, readSdkPkg, readTestModuleName, readZipEntry, reboot, recordFlow, recvFile, removeCmdTools, removeEmulator, removeSdk, removeTempWorkDir, renderCrashJson, replayFlow, requireHarmonyOsSdk, resizeGrey, resolveApiSdk, resolveArktsCheckSdk, resolveBuildSdk, resolveDeviceSerial, resolveKeyEvent, resolveProjectSdkDir, resolveSelectorKey, resolveTmpRoot, runCodelinter, runDoctor, runHvigorw, runOhpm, runProcess, runTests, scanEts, scopedLogger, sdkTooOldDiagnostic, searchApi, selectDevice, selectableTree, selectorAttribute, selectorFor, sendFile, sendGesture, sendInput, sendRawTouch, serializeApiIndex, setHilogLevel, shell, shellChecked, showApi, signOpenHarmonyHap, signingMismatch, smokeCheck, smokeVerdict, spawnCompat, startEmulator, startPoolInstance, stateFile, staticConfig, statusFromCode, stopEmulator, stopPoolInstance, streamHilog, stripHidumperBanner, suggestApiSymbols, summarizeDivergenceLayout, summarizeLayout, summarizeTrace, takeScreenshot, testHapPath, toLongPath, toSpaceError, uninstallApp, unsignedHapRejection, validateTemplateLayout, verifyHap, verifyHapExitCode, verifySha256, waitForBoot, waitForBundle, waitForCondition, waitForLog, waitForTarget, waitPoolInstanceReady, wakeAndUnlock, watchLog, waypointsToRawEvents, windowNotFoundError, windowSubtree, withHapZip, withoutWindow, writeJson5File, writeJsonFile, writePoolState };
+export { ALL_SDKS, API_INDEX_FORMAT, APL_VALUES, APP_FEATURE_VALUES, type AbilityInfo, type AgcAuthInfo, AgcError, type AnalyzeFaultLogOptions, type ApiElsewhere, type ApiEntry, type ApiIndex, type ApiLanguage, type ApiSdkSelection, type ApiSearchHit, type ApiSearchOptions, type ApiSearchResult, type ApiShowResult, type ApiSymbolKind, type Apl, type AppFeature, type ApplyChangesOptions, type ApplyChangesResult, type ArktsCheckOptions, type ArktsCheckReport, type ArktsCheckSdk, type ArktsCheckSummary, BLANK_BACKGROUND_SHARE, BLANK_MAX_STDDEV, BLANK_PHASH_DISTANCE, type BaseImageFingerprint, type BinderEdge, type BinderInfo, type BinderNode, type BinderPropagation, type BinderTransaction, type BlankAnalysis, type BuildApiIndexOptions, type BuildDiagnostic, BuildFailedError, type BuildHapOptions, type BuildHapResult, type BuildReport, type BuildSdk, type BuildSummary, type BundleOptions, CMD_TOOLS_REQUIRED, CancelledError, type CaptureBurstOptions, type CaptureLogOptions, type CaptureLogResult, type CertificateInfo, ChecksumMismatchError, type CmdToolsFlavour, type CmdToolsFsOps, type CmdToolsInfo, CmdToolsNotInstalledError, type CmdToolsSdk, type CmdToolsStatus, type CmdWrapper, type CodelinterFinding, type CodelinterReport, type CodelinterResult, type CodelinterSummary, CommandFailedError, type ConfigKey, type ConfigProvider, type CppCrashLog, type CrashJson, type CrashVerdict, type CreateScaffoldOptions, type CreateScaffoldResult, DEFAULT_BOOT_TIMEOUT_SECONDS, DEFAULT_EMULATOR_PID_FILE, DEFAULT_PERF_FLOW_TAIL_MS, DEFAULT_PERF_FOR_MS, DEFAULT_SMOKE_DELAY_MS, DEFAULT_SMOKE_PID_TIMEOUT_MS, DEFAULT_TRACE_BUFFER_KB, DEFAULT_TRACE_CATEGORIES, DOCS_REPO, DOCS_SPARSE_PATH, DOCS_SPARSE_PATTERNS, type Declaration, type Decorator, type DeveloperAgreementStatus, type DeviceFullInfo, type DeviceInfo, type DiagnosticSource, type DiscoverHapsOptions, type DisplaySize, type DisplaySizeOptions, type DivergenceLayout, type DivergenceReason, type DocEntry, type DocHeading, type DocSearchHit, type DocSearchOptions, type DocSearchResult, type DocShowOptions, type DocShowResult, type DocTags, DocsIndex, type DoctorCheck, type DoctorOptions, type DoctorProject, type DoctorReport, type DoctorStatus, type DoctorVersions, type DownloadOptions, type DslSelector, type DumpLayoutOptions, type DumpLayoutResult, type DumpLogOptions, EMULATOR_KERNEL_APPEND, type ElementQuery, type ElementSelector, type EmulatorAccel, type EmulatorHealth, type EmulatorInstanceStatus, type EmulatorStatus, type ExtractZipOptions, FAULTLOG_DIR, FAULTLOG_TEMP_DIR, FAULT_LOG_FAMILIES, FLOW_ACTIONS, FLOW_VERSION, type FaultCompleteness, type FaultConfidence, type FaultLogClassification, type FaultLogDeviceOptions, type FaultLogEntry, type FaultLogFamily, type FaultLogKind, type FindInOtherSdksOptions, type FlatLayoutNode, type Flow, type FlowAction, type FlowDevice, FlowFormatError, type FlowFromRecordingInput, type FlowFromRecordingResult, type FlowPoint, type FlowStep, type FrameArea, type FreezeLog, type FreezeReport, type GenerateSigningConfigsOptions, type GenerateSigningConfigsResult, type GestureUitestOptions, type GetDeviceInfoOptions, type GreyImage, type GreyscaleDecoder, HARMONYOS_SDK_VERSIONS, HASH_BITS, HUAWEI_SITES, type HapAssetDiff, type HapProfileReport, type HapSigner, type HapSigningInfo, type HapVerifyStatus, type HapZip, type HarmonyOsAutoSignOptions, type HarmonyOsLoginOptions, type HarmonyOsSdk, type HarmonyOsSdkListing, type HarmonyOsSdkSource, type HarmonyOsSession, type HarmonyOsSessionOptions, type HarmonyOsSignHapOptions, type HarmonyOsSignHapResult, type HarmonyOsSigningResult, type HdcBootProbe, type HdcExecOptions, type HdcExecResult, type HdcShellOptions, type HealthInputs, type HidumperOptions, type HilogEntry, type HilogLevel, type HiperfFunction, type HiperfReport, type HuaweiSite, type HuaweiSiteCode, type HuaweiTeam, type HuaweiUserInfo, INSTALL_TMP_DIRNAME, type ImageComparison, type IndexedLayoutNode, type InputType, type InstallAppOptions, type InstallAppResult, type InstallCandidate, type InstallCmdToolsOptions, type InstallCmdToolsResult, type InstallEmulatorOptions, type InstallMethod, type InstallSdkFromArchiveOptions, type InstallSdkOptions, type InstallTempDir, type InstallTempDirOptions, type InstalledSdk, InsufficientSpaceError, type JsCrashLog, type JsFrame, type KeyboardState, LAYOUT_COMPONENTS, LAYOUT_MOVED_IOU, type LatestCrashOptions, type LaunchAppOptions, type LayoutDiff, type LayoutDiffNode, type LayoutMatch, type LayoutMatchKind, type LayoutNode, type LayoutSelector, type LayoutSummary, type LayoutWindow, type LayoutWindowSummary, type ListFaultLogsOptions, type ListWindowsOptions, type LoadApiIndexOptions, type LoadedApiIndex, type LocateTargetOptions, type LocatedTarget, type Logger, MAX_FAULTLOG_BYTES, MAX_POOL_INSTANCE, type MissingSdkSymbol, type ModuleHaps, NO_WINDOW, type NativeFrame, type NearMatch, OHOS_DAILY_BUILDS_URL, OHOS_URL_BASE, type OniroContext, OniroError, type OsFolder, type OutputSink, POOL_DEFAULT_MEMORY, POOL_DEFAULT_RESOLUTION, POOL_DEFAULT_SMP, POOL_DISKS, POOL_REQUIRED_IMAGES, type ParamOptions, type ParseTraceOptions, type ParsedBuildOutput, type ParsedTestOutput, type PerfFrameStats, type PerfGateResult, type PerfScene, type PerfStartup, type PerfThresholds, type PerfTraceOptions, type PerfTraceReport, type PerformInputOptions, type PerformInputResult, type PickTargetFailure, type PickedHap, type PoolInstancePorts, type PoolInstanceState, type PoolQemuSpec, type PrepareSigningOptions, type PrepareSigningResult, type ProgressReporter, type ProgressUpdate, type ProjectModule, type Prompter, type ProvisionProfileInfo, type QueryTerm, type RawLayoutNode, type RawTouchEvent, type ReadFaultLogOptions, type RebootDecision, type RebootOptions, type RecordFlowOptions, type RecordFlowResult, type RecordedElement, type RecordingTimes, type RecvFileOptions, type ReplayFlowOptions, type ReplayReport, type ReplayStepResult, type ResolveApiSdkOptions, type RouteSpecResult, type RunCodelinterOptions, type RunHvigorwOptions, type RunHvigorwResult, type RunOhpmOptions, type RunProcessOptions, type RunTestsOptions, type RunningProcess, type RuntimeOs, SAME_MAX_CHANGE_RATIO, SAME_MAX_HASH_DISTANCE, SELECTOR_KEYS, SIGNED_HAP_CHUNK_SIZE, SIGNING_ERRORS, type ScannedSource, type ScreenDump, type ScreenPage, type ScreenPlaceholder, type ScreenRoute, type ScreenSpecResult, type ScreensInventory, type ScreensOptions, type ScreensSpec, type ScreensSpecReport, type Screenshot, type ScreenshotOptions, type SdkArchiveInfo, type SdkInfo, SdkNotInstalledError, type SdkPkgInfo, type SdkRelease, type SelectorClause, type SelectorKey, type SelectorOperator, SelectorParseError, type SendFileOptions, type SendGestureOptions, type SendInputOptions, type SendRawTouchOptions, type SetHilogLevelOptions, type SignOpenHarmonyHapOptions, type SignOpenHarmonyHapResult, type SigningKind, type SigningMaterialPaths, type SigningMaterialSummary, type SigningPasswords, type SmokeCheckOptions, type SmokeCrashProbe, type SmokeCrashProbeArgs, type SmokeResult, type SourceComment, type StackFrame, type StartEmulatorOptions, type StartPoolInstanceOptions, type StopPoolInstanceOptions, type StoredSession, type StreamHilogOptions, type SummarizeTraceOptions, type SyncDocsOptions, type SyncDocsResult, THREAD_HEADER_RE, TMP_DIR_HINT, TargetNotFoundError, type TemplateOption, type TestCaseResult, type TestOutcome, type TestRunReport, type TestStatus, type TestSummary, type ThreadStack, type Token, type TokenKind, type TokenStore, type TraceAsyncSlice, type TraceCounterSample, type TraceModel, TraceParser, type TraceSlice, type TraceSummary, UI_RECORD_CSV, type UiInputType, type UiRecordEvent, type UiRecordFinger, UnsupportedPlatformError, VERSION, type VerifyHapOptions, type VerifyHapResult, type WaitForBootOptions, type WaitForBundleOptions, type WaitForConditionOptions, type WaitForLogOptions, type WaitForTargetOptions, type WaitPoolInstanceReadyOptions, type WakeScreenOptions, type WakeScreenResult, type WatchLogOptions, type Waypoint, type WindowInfo, type XPathExpression, type XPathSelector, aaTestCommand, alignTouches, allIndexed, analyzeBlank, analyzeFaultLog, apiIndexCachePath, apiIndexKey, apiLevelOf, appSandboxDir, applyChanges, arktsCheckerScript, assertDevicePath, assertLayoutSelector, assertPoolInstance, attemptHdcConnection, boxIoU, buildApiIndex, buildCmdWrapper, buildGestureCommands, buildGestureUitestCommand, buildHap, buildHvigorwArgs, buildInputCommand, buildOutputTail, buildPoolQemuArgs, buildPropagation, buildRawTouchCommand, buildWithDiagnostics, bundleNameFromHapConfig, captureBurst, captureLog, checkArkts, checkCmdTools, checkCmdToolsFlavour, checkDisk, checkNode, checkScreensAgainstSpec, checkSigning, classifyEmulatorHealth, classifyFaultLog, clauseMatches, cleanBuildOutput, cleanCodelinterOutput, cleanMarkerName, commMatchesBundle, compareImages, consoleLogger, createHarmonyOsSession, createInstallTempDir, createMaterial, createScaffold, createTempWorkDir, createTokenStore, cropRows, dHash, decideInstallMethod, decideOutcome, decideReboot, decryptPwd, dedupEntries, defaultContext, defaultPaths, defaultSignedHapPath, dependencyApiDiagnostic, describeBuildSdk, describeCmdTools, describeLayoutNode, describeProfileValidity, describeProject, describeReplacement, describeSigningMaterial, deserializeApiIndex, detectAaStartFailure, detectCmdToolsFlavour, detectInstallFailure, detectProjectSdkVersion, detectRuntimeOs, detectSigningConfigNames, diagnoseBuildFailure, diffEntryNames, diffHapAssets, diffLayouts, discoverHaps, docQueryTerms, docTokens, docWords, docsDirFor, docsRefFor, docsTree, downloadAndInstallSdk, downloadFile, dumpLayout, dumpLog, dumpRenderService, dumpScreen, dumpWindow, elementAt, emulatorAccelArgs, encryptPwd, ensureFreeSpace, ensureInstallOk, ensureOhModules, ensureOk, ensureRemoteOk, escapeCmdArgument, escapeCmdCommand, evaluatePerfGate, evaluateXPath, existingHapOrUnsigned, expectFor, extractStackErrors, extractTarball, extractZipWithProgress, faultloggerCommand, fieldSelector, findApiInOtherSdks, findAppPids, findAppPidsBySurface, findAppProcessId, findCmdToolsSourceDir, findCoveredNodes, findHapSignTool, findHarmonyOsSdk, findKeyboardWindow, findLayoutNodes, findMissingProjectSdk, findRunningProcess, findSdkOsDir, findVisibleMatch, flatFrameHash, flatLayoutNode, flattenLayout, flowFromRecording, forceStop, formatBytes, formatFlow, formatHapVerification, formatSelector, formatUtc, generateSigningConfigs, getApiIndexCacheDir, getBundleName, getCmdToolsBin, getCmdToolsDownloadUrl, getCmdToolsPath, getCmdToolsStatus, getDefaultInstanceStatus, getDeviceInfo, getDisplaySize, getDocsRootDir, getEmulatorDir, getEmulatorStatus, getFreeSpaceBytes, getHarmonyOsSdkListing, getHdcPath, getHvigorwPath, getImeBundles, getInstalledSdks, getKey, getMainAbility, getOhosBaseSdkHome, getOhpmPath, getOsFolder, getPoolInstanceStatus, getSdkFilename, getSdkRootDir, getSupportedSdksForUi, hammingDistance, harmonyOsAutoSign, harmonyOsSdkLabelForApi, harmonyOsSignHap, hasOwnFields, hdcClientFailure, hdcExec, hdcTargetArgs, hdcTargetArgsFor, hideKeyboard, hilogSection, hilogTimeMs, holdScreenOn, indexLayout, installApp, installCmdTools, installEmulator, installFailureReason, installSdkFromArchive, installedApiLevels, inventoryScreens, isBundleInstalled, isCmdToolsInstalled, isCrashJson, isElementSelector, isEmulatorInstalled, isInstanceProcess, isLockScreenShown, isOutOfSpaceError, isPidAlive, isRamBackedPath, isTcpPortFree, isTestHap, isUnsignedHap, isUsableDevice, isValidBundleName, isValidProjectName, keystrokeChar, keystrokeName, killProcessTree, latestCrash, launchApp, listAbilities, listDevices, listFaultLogs, listLayoutWindows, listMarkdown, listModules, listPoolInstanceNumbers, listPoolInstanceStatuses, listRunningProcesses, listTemplates, listWindows, livePoolPids, loadApiIndex, locateTarget, matchSelector, mergeDocBlocks, missingProjectRootFiles, missingSdkSymbols, nameParts, nearMatches, needsCmdWrapper, nodeLabel, nonInteractivePrompter, noopLogger, noopProgress, normaliseLocalPath, normalizeFaultTime, normalizeKit, ohModulesPackage, pHash, pagesMatching, paramGet, paramGetMany, paramSet, parseActiveRefreshRate, parseArktsCheckOutput, parseBinder, parseBounds, parseBuildOutput, parseCodelinterFindings, parseCodelinterReport, parseCppCrash, parseCrashRecordHeads, parseDeviceList, parseDeviceTime, parseDoc, parseDocBlock, parseFaultLogList, parseFaultLogName, parseFlow, parseFrame, parseFreeze, parseHilogLine, parseHiperfReport, parseImeBundles, parseJsCrash, parseJsFrame, parseLayoutBaseline, parseMainAbilityFromBmDump, parseNativeFrame, parseParamValues, parsePowerState, parseProvisionProfile, parseRecorderForeground, parseRemoteExit, parseSelector, parseTestOutput, parseThreadStacks, parseTouchDowns, parseTraceFile, parseTraceText, parseUiRecordLines, parseUtcOffset, parseWindowList, parseXPath, perfSliceFilter, perfTrace, performInput, pickHap, pickSigningKind, pickTarget, pixelChangeRatio, poolInstanceDir, poolInstancePorts, poolRootDir, prepareSigning, probeEmulatorBoot, pruneLayout, quantile, rawWindowSubtree, readCmdToolsInfo, readDefaultEmulatorPid, readFaultLog, readFlowFile, readHapBundleName, readHapSigningInfo, readJson5File, readJsonFile, readLogTail, readPoolState, readProvisionProfile, readSdkPkg, readSdkRelease, readTestModuleName, readZipEntry, reboot, recordFlow, recvFile, removeCmdTools, removeEmulator, removeSdk, removeTempWorkDir, renderCrashJson, replayFlow, requireHarmonyOsSdk, resizeGrey, resolveApiSdk, resolveArktsCheckSdk, resolveBuildSdk, resolveDeviceSerial, resolveKeyEvent, resolveProjectSdkDir, resolveSelectorKey, resolveTmpRoot, runCodelinter, runDoctor, runHvigorw, runOhpm, runProcess, runTests, scanEts, scopedLogger, sdkTooOldDiagnostic, searchApi, selectDevice, selectableTree, selectorAttribute, selectorFor, sendFile, sendGesture, sendInput, sendRawTouch, serializeApiIndex, setHilogLevel, shell, shellChecked, showApi, signOpenHarmonyHap, signingMismatch, smokeCheck, smokeVerdict, spawnCompat, startEmulator, startPoolInstance, stateFile, staticConfig, statusFromCode, stopEmulator, stopPoolInstance, streamHilog, stripHidumperBanner, suggestApiSymbols, summarizeDivergenceLayout, summarizeLayout, summarizeTrace, syncDocs, takeScreenshot, testHapPath, toLongPath, toSpaceError, uninstallApp, unsignedHapRejection, validateTemplateLayout, verifyHap, verifyHapExitCode, verifySha256, waitForBoot, waitForBundle, waitForCondition, waitForLog, waitForTarget, waitPoolInstanceReady, wakeAndUnlock, watchLog, waypointsToRawEvents, windowNotFoundError, windowSubtree, withHapZip, withoutWindow, wordIn, writeJson5File, writeJsonFile, writePoolState };

package/dist/index.d.ts

@@ -28,7 +28,7 @@ declare const noopProgress: ProgressReporter;
  * Keys read from the ConfigProvider by core. Frontends (CLI, VS Code extension)
  * implement the provider however they like (env vars, settings.json, etc.).
  */
-type ConfigKey = 'sdkRootDir' | 'cmdToolsPath' | 'hdcPath' | 'emulatorDir' | 'hapPath' | 'cmdToolsUrlLinux' | 'cmdToolsUrlWindows' | 'cmdToolsUrlMac' | 'emulatorUrl' | 'tmpDir' | 'sdkUrlBase' | 'applicationCertPath' | 'harmonyosSdkPath' | 'harmonyosAuthDir' | 'harmonyosSigningDir' | 'cacheDir';
+type ConfigKey = 'sdkRootDir' | 'cmdToolsPath' | 'hdcPath' | 'emulatorDir' | 'hapPath' | 'cmdToolsUrlLinux' | 'cmdToolsUrlWindows' | 'cmdToolsUrlMac' | 'emulatorUrl' | 'tmpDir' | 'sdkUrlBase' | 'applicationCertPath' | 'harmonyosSdkPath' | 'harmonyosAuthDir' | 'harmonyosSigningDir' | 'cacheDir' | 'docsDir';
 interface ConfigProvider {
     /**
      * Get the configured value for `key`, or `fallback` if unset/empty.
@@ -5963,6 +5963,200 @@ declare function parseActiveRefreshRate(hidumper: string): number | null;
  */
 declare function perfTrace(opts: PerfTraceOptions): Promise<PerfTraceReport>;
 
+/**
+ * Search over the OpenHarmony application-development documentation (`docs sync`
+ * clones `en/application-dev` of gitcode.com/openharmony/docs). The SDK typings
+ * behind `api search` / `api show` say whether a symbol exists and with what
+ * signature; the docs say how an API is used, which business error codes a kit
+ * throws and how the platform behaves. The index is deterministic, built in memory
+ * in a few seconds from titles, headings and an inverted word index, and answers a
+ * query in milliseconds; bodies are read on demand.
+ */
+interface DocEntry {
+    /** Path relative to the `en/application-dev` tree, e.g. `ui/arkts-navigation-jump.md`. */
+    path: string;
+    title: string;
+    /** Every `##`–`####` heading with its 1-based line. */
+    headings: DocHeading[];
+    bytes: number;
+}
+interface DocHeading {
+    line: number;
+    level: number;
+    text: string;
+}
+interface DocSearchHit {
+    path: string;
+    title: string;
+    score: number;
+    /** Headings that contain a query word (at most 6), to pass to `show`. */
+    headings: {
+        line: number;
+        text: string;
+    }[];
+    /** First paragraph after the title, trimmed. */
+    snippet: string;
+}
+interface DocSearchOptions {
+    /** At most n hits (default 8, at most 30). */
+    limit?: number;
+    /** Only documents under this subtree, e.g. `ui`, `reference/errorcodes`. */
+    section?: string;
+}
+interface DocSearchResult {
+    query: string;
+    /** The words the query was read as. */
+    terms: string[];
+    total: number;
+    hits: DocSearchHit[];
+}
+interface DocShowOptions {
+    /** A heading (or a distinctive part of it, case-insensitive): only that section. */
+    heading?: string;
+    /** Line cap (default 250, at most 1200). */
+    maxLines?: number;
+}
+type DocShowResult = {
+    found: true;
+    path: string;
+    /** The text (images and inline HTML dropped), cut at `maxLines` with a note. */
+    text: string;
+    truncated: boolean;
+    /** The headings inside what was shown. */
+    headings: {
+        line: number;
+        text: string;
+    }[];
+    /** Lines of the whole section before the cap. */
+    lines: number;
+} | {
+    found: false;
+    path: string;
+    error: string;
+    /** Similar document paths, or the document's headings when the heading did not match. */
+    suggestions: string[];
+};
+/** Every `.md` under `tree`, sorted, skipping figure directories. */
+declare function listMarkdown(tree: string): string[];
+/** Lower-cased words of a text: identifiers keep their dots, 2–40 chars, no long digit runs (hashes, ids). */
+declare function docTokens(text: string): string[];
+interface QueryTerm {
+    term: string;
+    /** 1 for a word of the query, 0.4 for a part of a camelCase or dotted identifier. */
+    weight: number;
+}
+/**
+ * The query's words plus the parts of camelCase and dotted identifiers
+ * (`NavPathStack` → nav, path, stack), so a guide that says "path stack" still matches;
+ * the parts weigh less and are not required.
+ */
+declare function docQueryTerms(query: string): QueryTerm[];
+/** Whether `term` occurs in `text` as a whole word (a trailing API-level suffix such as `insert10+` still counts). */
+declare function wordIn(text: string, term: string): boolean;
+/** Title and headings of one document. */
+declare function parseDoc(rel: string, text: string): DocEntry;
+/**
+ * Distinct index words of a document: its text plus the words of its path. A dotted
+ * identifier also contributes its parts (`this.pathstack.pushpathbyname` → pathstack,
+ * pushpathbyname) and a word with a trailing API-level suffix its stem
+ * (`pushpathbyname10` → pushpathbyname), so the words a reader types are the words
+ * the index holds.
+ */
+declare function docWords(rel: string, text: string): Set<string>;
+declare class DocsIndex {
+    readonly tree: string;
+    readonly docs: readonly DocEntry[];
+    /** Build time, ms. */
+    readonly buildMs: number;
+    /** word → ascending document ids (packed: 4 bytes per occurrence). */
+    private readonly postings;
+    private constructor();
+    /** The index of a tree, built on the first call of a process and kept. */
+    static load(tree: string): DocsIndex;
+    /** An index over in-memory documents (tests). `tree` is used by `show` for reading files. */
+    static fromDocs(tree: string, docs: {
+        path: string;
+        text: string;
+    }[]): DocsIndex;
+    /** Forget the cached index of a tree (after a sync). */
+    static forget(tree: string): void;
+    get size(): number;
+    private has;
+    /**
+     * Documents containing every word of the query (any of them when none does), scored by
+     * where the words occur: title, headings, path, body; a document whose title is exactly a
+     * query word, or that contains the whole query in a title or heading, ranks higher; the
+     * generated API reference ranks a little below the guides, system-API pages and tables of
+     * contents below everything.
+     */
+    search(query: string, o?: DocSearchOptions): DocSearchResult;
+    private snippet;
+    /**
+     * A document, or one of its sections: from the heading that matches `heading`
+     * (exactly, else by substring, case-insensitive) to the next heading of the same or a
+     * higher level. Image lines and inline HTML are dropped; the text is cut at `maxLines`
+     * with a note of what was left out.
+     */
+    show(rel: string, o?: DocShowOptions): DocShowResult;
+}
+
+/** The OpenHarmony documentation repository. */
+declare const DOCS_REPO = "https://gitcode.com/openharmony/docs";
+/** The part of the repository `docs search` reads; device, kernel and the Chinese tree stay out. */
+declare const DOCS_SPARSE_PATH = "en/application-dev";
+/** Sparse-checkout patterns (non-cone): the tree without its figures, which are about 90% of its bytes. */
+declare const DOCS_SPARSE_PATTERNS: readonly string[];
+/**
+ * The release branch of the docs repository for an SDK: from its version
+ * (`oh-uni-package.json`: `6.1.0.31` → `OpenHarmony-6.1-Release`, `5.1.0.107` →
+ * `OpenHarmony-5.1.0-Release`), else from the API level (18 → 5.1.0, 20 → 6.0,
+ * 23 → 6.1, 26 → 7.0), else `master`.
+ */
+declare function docsRefFor(sdk: {
+    api?: number;
+    version?: string;
+}): string;
+/** `{ api, version }` of an SDK API directory, from `ets/oh-uni-package.json`; empty when unreadable. */
+declare function readSdkRelease(sdkDir: string): {
+    api?: number;
+    version?: string;
+};
+/** Where the clones live: the `docsDir` config key, default `<sdkRootDir>/docs`. */
+declare function getDocsRootDir(config: ConfigProvider): string;
+/** The clone of one release: `<docs root>/<ref>`. */
+declare function docsDirFor(config: ConfigProvider, ref: string): string;
+/** The `en/application-dev` tree of a clone, or null when the release has not been synced. */
+declare function docsTree(docsDir: string): string | null;
+interface SyncDocsOptions {
+    /** The branch or tag to clone. */
+    ref: string;
+    /** Where to clone (normally `docsDirFor(config, ref)`). */
+    dir: string;
+    /** Repository URL (default {@link DOCS_REPO}). */
+    repo?: string;
+    logger?: Logger;
+    /** Per git step; the clone of a release takes a minute or two. Default 10 minutes. */
+    timeoutMs?: number;
+    abortSignal?: AbortSignal;
+}
+interface SyncDocsResult {
+    dir: string;
+    ref: string;
+    /** Markdown files under `en/application-dev`. */
+    files: number;
+    /** False when the clone was created, true when an existing one was brought up to date. */
+    updated: boolean;
+    /** The commit the tree is at. */
+    commit?: string;
+}
+/**
+ * Clone or update the documentation of one release: a partial (`--filter=blob:none`),
+ * depth-1, sparse clone of `en/application-dev` without its figures, about 100 MB
+ * instead of the 2 GB a plain clone of the tree is. A second call on an existing
+ * clone fetches the branch head and resets to it. Needs `git` on the PATH.
+ */
+declare function syncDocs(opts: SyncDocsOptions): Promise<SyncDocsResult>;
+
 declare const VERSION: string;
 
-export { ALL_SDKS, API_INDEX_FORMAT, APL_VALUES, APP_FEATURE_VALUES, type AbilityInfo, type AgcAuthInfo, AgcError, type AnalyzeFaultLogOptions, type ApiElsewhere, type ApiEntry, type ApiIndex, type ApiLanguage, type ApiSdkSelection, type ApiSearchHit, type ApiSearchOptions, type ApiSearchResult, type ApiShowResult, type ApiSymbolKind, type Apl, type AppFeature, type ApplyChangesOptions, type ApplyChangesResult, type ArktsCheckOptions, type ArktsCheckReport, type ArktsCheckSdk, type ArktsCheckSummary, BLANK_BACKGROUND_SHARE, BLANK_MAX_STDDEV, BLANK_PHASH_DISTANCE, type BaseImageFingerprint, type BinderEdge, type BinderInfo, type BinderNode, type BinderPropagation, type BinderTransaction, type BlankAnalysis, type BuildApiIndexOptions, type BuildDiagnostic, BuildFailedError, type BuildHapOptions, type BuildHapResult, type BuildReport, type BuildSdk, type BuildSummary, type BundleOptions, CMD_TOOLS_REQUIRED, CancelledError, type CaptureBurstOptions, type CaptureLogOptions, type CaptureLogResult, type CertificateInfo, ChecksumMismatchError, type CmdToolsFlavour, type CmdToolsFsOps, type CmdToolsInfo, CmdToolsNotInstalledError, type CmdToolsSdk, type CmdToolsStatus, type CmdWrapper, type CodelinterFinding, type CodelinterReport, type CodelinterResult, type CodelinterSummary, CommandFailedError, type ConfigKey, type ConfigProvider, type CppCrashLog, type CrashJson, type CrashVerdict, type CreateScaffoldOptions, type CreateScaffoldResult, DEFAULT_BOOT_TIMEOUT_SECONDS, DEFAULT_EMULATOR_PID_FILE, DEFAULT_PERF_FLOW_TAIL_MS, DEFAULT_PERF_FOR_MS, DEFAULT_SMOKE_DELAY_MS, DEFAULT_SMOKE_PID_TIMEOUT_MS, DEFAULT_TRACE_BUFFER_KB, DEFAULT_TRACE_CATEGORIES, type Declaration, type Decorator, type DeveloperAgreementStatus, type DeviceFullInfo, type DeviceInfo, type DiagnosticSource, type DiscoverHapsOptions, type DisplaySize, type DisplaySizeOptions, type DivergenceLayout, type DivergenceReason, type DocTags, type DoctorCheck, type DoctorOptions, type DoctorProject, type DoctorReport, type DoctorStatus, type DoctorVersions, type DownloadOptions, type DslSelector, type DumpLayoutOptions, type DumpLayoutResult, type DumpLogOptions, EMULATOR_KERNEL_APPEND, type ElementQuery, type ElementSelector, type EmulatorAccel, type EmulatorHealth, type EmulatorInstanceStatus, type EmulatorStatus, type ExtractZipOptions, FAULTLOG_DIR, FAULTLOG_TEMP_DIR, FAULT_LOG_FAMILIES, FLOW_ACTIONS, FLOW_VERSION, type FaultCompleteness, type FaultConfidence, type FaultLogClassification, type FaultLogDeviceOptions, type FaultLogEntry, type FaultLogFamily, type FaultLogKind, type FindInOtherSdksOptions, type FlatLayoutNode, type Flow, type FlowAction, type FlowDevice, FlowFormatError, type FlowFromRecordingInput, type FlowFromRecordingResult, type FlowPoint, type FlowStep, type FrameArea, type FreezeLog, type FreezeReport, type GenerateSigningConfigsOptions, type GenerateSigningConfigsResult, type GestureUitestOptions, type GetDeviceInfoOptions, type GreyImage, type GreyscaleDecoder, HARMONYOS_SDK_VERSIONS, HASH_BITS, HUAWEI_SITES, type HapAssetDiff, type HapProfileReport, type HapSigner, type HapSigningInfo, type HapVerifyStatus, type HapZip, type HarmonyOsAutoSignOptions, type HarmonyOsLoginOptions, type HarmonyOsSdk, type HarmonyOsSdkListing, type HarmonyOsSdkSource, type HarmonyOsSession, type HarmonyOsSessionOptions, type HarmonyOsSignHapOptions, type HarmonyOsSignHapResult, type HarmonyOsSigningResult, type HdcBootProbe, type HdcExecOptions, type HdcExecResult, type HdcShellOptions, type HealthInputs, type HidumperOptions, type HilogEntry, type HilogLevel, type HiperfFunction, type HiperfReport, type HuaweiSite, type HuaweiSiteCode, type HuaweiTeam, type HuaweiUserInfo, INSTALL_TMP_DIRNAME, type ImageComparison, type IndexedLayoutNode, type InputType, type InstallAppOptions, type InstallAppResult, type InstallCandidate, type InstallCmdToolsOptions, type InstallCmdToolsResult, type InstallEmulatorOptions, type InstallMethod, type InstallSdkFromArchiveOptions, type InstallSdkOptions, type InstallTempDir, type InstallTempDirOptions, type InstalledSdk, InsufficientSpaceError, type JsCrashLog, type JsFrame, type KeyboardState, LAYOUT_COMPONENTS, LAYOUT_MOVED_IOU, type LatestCrashOptions, type LaunchAppOptions, type LayoutDiff, type LayoutDiffNode, type LayoutMatch, type LayoutMatchKind, type LayoutNode, type LayoutSelector, type LayoutSummary, type LayoutWindow, type LayoutWindowSummary, type ListFaultLogsOptions, type ListWindowsOptions, type LoadApiIndexOptions, type LoadedApiIndex, type LocateTargetOptions, type LocatedTarget, type Logger, MAX_FAULTLOG_BYTES, MAX_POOL_INSTANCE, type MissingSdkSymbol, type ModuleHaps, NO_WINDOW, type NativeFrame, type NearMatch, OHOS_DAILY_BUILDS_URL, OHOS_URL_BASE, type OniroContext, OniroError, type OsFolder, type OutputSink, POOL_DEFAULT_MEMORY, POOL_DEFAULT_RESOLUTION, POOL_DEFAULT_SMP, POOL_DISKS, POOL_REQUIRED_IMAGES, type ParamOptions, type ParseTraceOptions, type ParsedBuildOutput, type ParsedTestOutput, type PerfFrameStats, type PerfGateResult, type PerfScene, type PerfStartup, type PerfThresholds, type PerfTraceOptions, type PerfTraceReport, type PerformInputOptions, type PerformInputResult, type PickTargetFailure, type PickedHap, type PoolInstancePorts, type PoolInstanceState, type PoolQemuSpec, type PrepareSigningOptions, type PrepareSigningResult, type ProgressReporter, type ProgressUpdate, type ProjectModule, type Prompter, type ProvisionProfileInfo, type RawLayoutNode, type RawTouchEvent, type ReadFaultLogOptions, type RebootDecision, type RebootOptions, type RecordFlowOptions, type RecordFlowResult, type RecordedElement, type RecordingTimes, type RecvFileOptions, type ReplayFlowOptions, type ReplayReport, type ReplayStepResult, type ResolveApiSdkOptions, type RouteSpecResult, type RunCodelinterOptions, type RunHvigorwOptions, type RunHvigorwResult, type RunOhpmOptions, type RunProcessOptions, type RunTestsOptions, type RunningProcess, type RuntimeOs, SAME_MAX_CHANGE_RATIO, SAME_MAX_HASH_DISTANCE, SELECTOR_KEYS, SIGNED_HAP_CHUNK_SIZE, SIGNING_ERRORS, type ScannedSource, type ScreenDump, type ScreenPage, type ScreenPlaceholder, type ScreenRoute, type ScreenSpecResult, type ScreensInventory, type ScreensOptions, type ScreensSpec, type ScreensSpecReport, type Screenshot, type ScreenshotOptions, type SdkArchiveInfo, type SdkInfo, SdkNotInstalledError, type SdkPkgInfo, type SdkRelease, type SelectorClause, type SelectorKey, type SelectorOperator, SelectorParseError, type SendFileOptions, type SendGestureOptions, type SendInputOptions, type SendRawTouchOptions, type SetHilogLevelOptions, type SignOpenHarmonyHapOptions, type SignOpenHarmonyHapResult, type SigningKind, type SigningMaterialPaths, type SigningMaterialSummary, type SigningPasswords, type SmokeCheckOptions, type SmokeCrashProbe, type SmokeCrashProbeArgs, type SmokeResult, type SourceComment, type StackFrame, type StartEmulatorOptions, type StartPoolInstanceOptions, type StopPoolInstanceOptions, type StoredSession, type StreamHilogOptions, type SummarizeTraceOptions, THREAD_HEADER_RE, TMP_DIR_HINT, TargetNotFoundError, type TemplateOption, type TestCaseResult, type TestOutcome, type TestRunReport, type TestStatus, type TestSummary, type ThreadStack, type Token, type TokenKind, type TokenStore, type TraceAsyncSlice, type TraceCounterSample, type TraceModel, TraceParser, type TraceSlice, type TraceSummary, UI_RECORD_CSV, type UiInputType, type UiRecordEvent, type UiRecordFinger, UnsupportedPlatformError, VERSION, type VerifyHapOptions, type VerifyHapResult, type WaitForBootOptions, type WaitForBundleOptions, type WaitForConditionOptions, type WaitForLogOptions, type WaitForTargetOptions, type WaitPoolInstanceReadyOptions, type WakeScreenOptions, type WakeScreenResult, type WatchLogOptions, type Waypoint, type WindowInfo, type XPathExpression, type XPathSelector, aaTestCommand, alignTouches, allIndexed, analyzeBlank, analyzeFaultLog, apiIndexCachePath, apiIndexKey, apiLevelOf, appSandboxDir, applyChanges, arktsCheckerScript, assertDevicePath, assertLayoutSelector, assertPoolInstance, attemptHdcConnection, boxIoU, buildApiIndex, buildCmdWrapper, buildGestureCommands, buildGestureUitestCommand, buildHap, buildHvigorwArgs, buildInputCommand, buildOutputTail, buildPoolQemuArgs, buildPropagation, buildRawTouchCommand, buildWithDiagnostics, bundleNameFromHapConfig, captureBurst, captureLog, checkArkts, checkCmdTools, checkCmdToolsFlavour, checkDisk, checkNode, checkScreensAgainstSpec, checkSigning, classifyEmulatorHealth, classifyFaultLog, clauseMatches, cleanBuildOutput, cleanCodelinterOutput, cleanMarkerName, commMatchesBundle, compareImages, consoleLogger, createHarmonyOsSession, createInstallTempDir, createMaterial, createScaffold, createTempWorkDir, createTokenStore, cropRows, dHash, decideInstallMethod, decideOutcome, decideReboot, decryptPwd, dedupEntries, defaultContext, defaultPaths, defaultSignedHapPath, dependencyApiDiagnostic, describeBuildSdk, describeCmdTools, describeLayoutNode, describeProfileValidity, describeProject, describeReplacement, describeSigningMaterial, deserializeApiIndex, detectAaStartFailure, detectCmdToolsFlavour, detectInstallFailure, detectProjectSdkVersion, detectRuntimeOs, detectSigningConfigNames, diagnoseBuildFailure, diffEntryNames, diffHapAssets, diffLayouts, discoverHaps, downloadAndInstallSdk, downloadFile, dumpLayout, dumpLog, dumpRenderService, dumpScreen, dumpWindow, elementAt, emulatorAccelArgs, encryptPwd, ensureFreeSpace, ensureInstallOk, ensureOhModules, ensureOk, ensureRemoteOk, escapeCmdArgument, escapeCmdCommand, evaluatePerfGate, evaluateXPath, existingHapOrUnsigned, expectFor, extractStackErrors, extractTarball, extractZipWithProgress, faultloggerCommand, fieldSelector, findApiInOtherSdks, findAppPids, findAppPidsBySurface, findAppProcessId, findCmdToolsSourceDir, findCoveredNodes, findHapSignTool, findHarmonyOsSdk, findKeyboardWindow, findLayoutNodes, findMissingProjectSdk, findRunningProcess, findSdkOsDir, findVisibleMatch, flatFrameHash, flatLayoutNode, flattenLayout, flowFromRecording, forceStop, formatBytes, formatFlow, formatHapVerification, formatSelector, formatUtc, generateSigningConfigs, getApiIndexCacheDir, getBundleName, getCmdToolsBin, getCmdToolsDownloadUrl, getCmdToolsPath, getCmdToolsStatus, getDefaultInstanceStatus, getDeviceInfo, getDisplaySize, getEmulatorDir, getEmulatorStatus, getFreeSpaceBytes, getHarmonyOsSdkListing, getHdcPath, getHvigorwPath, getImeBundles, getInstalledSdks, getKey, getMainAbility, getOhosBaseSdkHome, getOhpmPath, getOsFolder, getPoolInstanceStatus, getSdkFilename, getSdkRootDir, getSupportedSdksForUi, hammingDistance, harmonyOsAutoSign, harmonyOsSdkLabelForApi, harmonyOsSignHap, hasOwnFields, hdcClientFailure, hdcExec, hdcTargetArgs, hdcTargetArgsFor, hideKeyboard, hilogSection, hilogTimeMs, holdScreenOn, indexLayout, installApp, installCmdTools, installEmulator, installFailureReason, installSdkFromArchive, installedApiLevels, inventoryScreens, isBundleInstalled, isCmdToolsInstalled, isCrashJson, isElementSelector, isEmulatorInstalled, isInstanceProcess, isLockScreenShown, isOutOfSpaceError, isPidAlive, isRamBackedPath, isTcpPortFree, isTestHap, isUnsignedHap, isUsableDevice, isValidBundleName, isValidProjectName, keystrokeChar, keystrokeName, killProcessTree, latestCrash, launchApp, listAbilities, listDevices, listFaultLogs, listLayoutWindows, listModules, listPoolInstanceNumbers, listPoolInstanceStatuses, listRunningProcesses, listTemplates, listWindows, livePoolPids, loadApiIndex, locateTarget, matchSelector, mergeDocBlocks, missingProjectRootFiles, missingSdkSymbols, nameParts, nearMatches, needsCmdWrapper, nodeLabel, nonInteractivePrompter, noopLogger, noopProgress, normaliseLocalPath, normalizeFaultTime, normalizeKit, ohModulesPackage, pHash, pagesMatching, paramGet, paramGetMany, paramSet, parseActiveRefreshRate, parseArktsCheckOutput, parseBinder, parseBounds, parseBuildOutput, parseCodelinterFindings, parseCodelinterReport, parseCppCrash, parseCrashRecordHeads, parseDeviceList, parseDeviceTime, parseDocBlock, parseFaultLogList, parseFaultLogName, parseFlow, parseFrame, parseFreeze, parseHilogLine, parseHiperfReport, parseImeBundles, parseJsCrash, parseJsFrame, parseLayoutBaseline, parseMainAbilityFromBmDump, parseNativeFrame, parseParamValues, parsePowerState, parseProvisionProfile, parseRecorderForeground, parseRemoteExit, parseSelector, parseTestOutput, parseThreadStacks, parseTouchDowns, parseTraceFile, parseTraceText, parseUiRecordLines, parseUtcOffset, parseWindowList, parseXPath, perfSliceFilter, perfTrace, performInput, pickHap, pickSigningKind, pickTarget, pixelChangeRatio, poolInstanceDir, poolInstancePorts, poolRootDir, prepareSigning, probeEmulatorBoot, pruneLayout, quantile, rawWindowSubtree, readCmdToolsInfo, readDefaultEmulatorPid, readFaultLog, readFlowFile, readHapBundleName, readHapSigningInfo, readJson5File, readJsonFile, readLogTail, readPoolState, readProvisionProfile, readSdkPkg, readTestModuleName, readZipEntry, reboot, recordFlow, recvFile, removeCmdTools, removeEmulator, removeSdk, removeTempWorkDir, renderCrashJson, replayFlow, requireHarmonyOsSdk, resizeGrey, resolveApiSdk, resolveArktsCheckSdk, resolveBuildSdk, resolveDeviceSerial, resolveKeyEvent, resolveProjectSdkDir, resolveSelectorKey, resolveTmpRoot, runCodelinter, runDoctor, runHvigorw, runOhpm, runProcess, runTests, scanEts, scopedLogger, sdkTooOldDiagnostic, searchApi, selectDevice, selectableTree, selectorAttribute, selectorFor, sendFile, sendGesture, sendInput, sendRawTouch, serializeApiIndex, setHilogLevel, shell, shellChecked, showApi, signOpenHarmonyHap, signingMismatch, smokeCheck, smokeVerdict, spawnCompat, startEmulator, startPoolInstance, stateFile, staticConfig, statusFromCode, stopEmulator, stopPoolInstance, streamHilog, stripHidumperBanner, suggestApiSymbols, summarizeDivergenceLayout, summarizeLayout, summarizeTrace, takeScreenshot, testHapPath, toLongPath, toSpaceError, uninstallApp, unsignedHapRejection, validateTemplateLayout, verifyHap, verifyHapExitCode, verifySha256, waitForBoot, waitForBundle, waitForCondition, waitForLog, waitForTarget, waitPoolInstanceReady, wakeAndUnlock, watchLog, waypointsToRawEvents, windowNotFoundError, windowSubtree, withHapZip, withoutWindow, writeJson5File, writeJsonFile, writePoolState };
+export { ALL_SDKS, API_INDEX_FORMAT, APL_VALUES, APP_FEATURE_VALUES, type AbilityInfo, type AgcAuthInfo, AgcError, type AnalyzeFaultLogOptions, type ApiElsewhere, type ApiEntry, type ApiIndex, type ApiLanguage, type ApiSdkSelection, type ApiSearchHit, type ApiSearchOptions, type ApiSearchResult, type ApiShowResult, type ApiSymbolKind, type Apl, type AppFeature, type ApplyChangesOptions, type ApplyChangesResult, type ArktsCheckOptions, type ArktsCheckReport, type ArktsCheckSdk, type ArktsCheckSummary, BLANK_BACKGROUND_SHARE, BLANK_MAX_STDDEV, BLANK_PHASH_DISTANCE, type BaseImageFingerprint, type BinderEdge, type BinderInfo, type BinderNode, type BinderPropagation, type BinderTransaction, type BlankAnalysis, type BuildApiIndexOptions, type BuildDiagnostic, BuildFailedError, type BuildHapOptions, type BuildHapResult, type BuildReport, type BuildSdk, type BuildSummary, type BundleOptions, CMD_TOOLS_REQUIRED, CancelledError, type CaptureBurstOptions, type CaptureLogOptions, type CaptureLogResult, type CertificateInfo, ChecksumMismatchError, type CmdToolsFlavour, type CmdToolsFsOps, type CmdToolsInfo, CmdToolsNotInstalledError, type CmdToolsSdk, type CmdToolsStatus, type CmdWrapper, type CodelinterFinding, type CodelinterReport, type CodelinterResult, type CodelinterSummary, CommandFailedError, type ConfigKey, type ConfigProvider, type CppCrashLog, type CrashJson, type CrashVerdict, type CreateScaffoldOptions, type CreateScaffoldResult, DEFAULT_BOOT_TIMEOUT_SECONDS, DEFAULT_EMULATOR_PID_FILE, DEFAULT_PERF_FLOW_TAIL_MS, DEFAULT_PERF_FOR_MS, DEFAULT_SMOKE_DELAY_MS, DEFAULT_SMOKE_PID_TIMEOUT_MS, DEFAULT_TRACE_BUFFER_KB, DEFAULT_TRACE_CATEGORIES, DOCS_REPO, DOCS_SPARSE_PATH, DOCS_SPARSE_PATTERNS, type Declaration, type Decorator, type DeveloperAgreementStatus, type DeviceFullInfo, type DeviceInfo, type DiagnosticSource, type DiscoverHapsOptions, type DisplaySize, type DisplaySizeOptions, type DivergenceLayout, type DivergenceReason, type DocEntry, type DocHeading, type DocSearchHit, type DocSearchOptions, type DocSearchResult, type DocShowOptions, type DocShowResult, type DocTags, DocsIndex, type DoctorCheck, type DoctorOptions, type DoctorProject, type DoctorReport, type DoctorStatus, type DoctorVersions, type DownloadOptions, type DslSelector, type DumpLayoutOptions, type DumpLayoutResult, type DumpLogOptions, EMULATOR_KERNEL_APPEND, type ElementQuery, type ElementSelector, type EmulatorAccel, type EmulatorHealth, type EmulatorInstanceStatus, type EmulatorStatus, type ExtractZipOptions, FAULTLOG_DIR, FAULTLOG_TEMP_DIR, FAULT_LOG_FAMILIES, FLOW_ACTIONS, FLOW_VERSION, type FaultCompleteness, type FaultConfidence, type FaultLogClassification, type FaultLogDeviceOptions, type FaultLogEntry, type FaultLogFamily, type FaultLogKind, type FindInOtherSdksOptions, type FlatLayoutNode, type Flow, type FlowAction, type FlowDevice, FlowFormatError, type FlowFromRecordingInput, type FlowFromRecordingResult, type FlowPoint, type FlowStep, type FrameArea, type FreezeLog, type FreezeReport, type GenerateSigningConfigsOptions, type GenerateSigningConfigsResult, type GestureUitestOptions, type GetDeviceInfoOptions, type GreyImage, type GreyscaleDecoder, HARMONYOS_SDK_VERSIONS, HASH_BITS, HUAWEI_SITES, type HapAssetDiff, type HapProfileReport, type HapSigner, type HapSigningInfo, type HapVerifyStatus, type HapZip, type HarmonyOsAutoSignOptions, type HarmonyOsLoginOptions, type HarmonyOsSdk, type HarmonyOsSdkListing, type HarmonyOsSdkSource, type HarmonyOsSession, type HarmonyOsSessionOptions, type HarmonyOsSignHapOptions, type HarmonyOsSignHapResult, type HarmonyOsSigningResult, type HdcBootProbe, type HdcExecOptions, type HdcExecResult, type HdcShellOptions, type HealthInputs, type HidumperOptions, type HilogEntry, type HilogLevel, type HiperfFunction, type HiperfReport, type HuaweiSite, type HuaweiSiteCode, type HuaweiTeam, type HuaweiUserInfo, INSTALL_TMP_DIRNAME, type ImageComparison, type IndexedLayoutNode, type InputType, type InstallAppOptions, type InstallAppResult, type InstallCandidate, type InstallCmdToolsOptions, type InstallCmdToolsResult, type InstallEmulatorOptions, type InstallMethod, type InstallSdkFromArchiveOptions, type InstallSdkOptions, type InstallTempDir, type InstallTempDirOptions, type InstalledSdk, InsufficientSpaceError, type JsCrashLog, type JsFrame, type KeyboardState, LAYOUT_COMPONENTS, LAYOUT_MOVED_IOU, type LatestCrashOptions, type LaunchAppOptions, type LayoutDiff, type LayoutDiffNode, type LayoutMatch, type LayoutMatchKind, type LayoutNode, type LayoutSelector, type LayoutSummary, type LayoutWindow, type LayoutWindowSummary, type ListFaultLogsOptions, type ListWindowsOptions, type LoadApiIndexOptions, type LoadedApiIndex, type LocateTargetOptions, type LocatedTarget, type Logger, MAX_FAULTLOG_BYTES, MAX_POOL_INSTANCE, type MissingSdkSymbol, type ModuleHaps, NO_WINDOW, type NativeFrame, type NearMatch, OHOS_DAILY_BUILDS_URL, OHOS_URL_BASE, type OniroContext, OniroError, type OsFolder, type OutputSink, POOL_DEFAULT_MEMORY, POOL_DEFAULT_RESOLUTION, POOL_DEFAULT_SMP, POOL_DISKS, POOL_REQUIRED_IMAGES, type ParamOptions, type ParseTraceOptions, type ParsedBuildOutput, type ParsedTestOutput, type PerfFrameStats, type PerfGateResult, type PerfScene, type PerfStartup, type PerfThresholds, type PerfTraceOptions, type PerfTraceReport, type PerformInputOptions, type PerformInputResult, type PickTargetFailure, type PickedHap, type PoolInstancePorts, type PoolInstanceState, type PoolQemuSpec, type PrepareSigningOptions, type PrepareSigningResult, type ProgressReporter, type ProgressUpdate, type ProjectModule, type Prompter, type ProvisionProfileInfo, type QueryTerm, type RawLayoutNode, type RawTouchEvent, type ReadFaultLogOptions, type RebootDecision, type RebootOptions, type RecordFlowOptions, type RecordFlowResult, type RecordedElement, type RecordingTimes, type RecvFileOptions, type ReplayFlowOptions, type ReplayReport, type ReplayStepResult, type ResolveApiSdkOptions, type RouteSpecResult, type RunCodelinterOptions, type RunHvigorwOptions, type RunHvigorwResult, type RunOhpmOptions, type RunProcessOptions, type RunTestsOptions, type RunningProcess, type RuntimeOs, SAME_MAX_CHANGE_RATIO, SAME_MAX_HASH_DISTANCE, SELECTOR_KEYS, SIGNED_HAP_CHUNK_SIZE, SIGNING_ERRORS, type ScannedSource, type ScreenDump, type ScreenPage, type ScreenPlaceholder, type ScreenRoute, type ScreenSpecResult, type ScreensInventory, type ScreensOptions, type ScreensSpec, type ScreensSpecReport, type Screenshot, type ScreenshotOptions, type SdkArchiveInfo, type SdkInfo, SdkNotInstalledError, type SdkPkgInfo, type SdkRelease, type SelectorClause, type SelectorKey, type SelectorOperator, SelectorParseError, type SendFileOptions, type SendGestureOptions, type SendInputOptions, type SendRawTouchOptions, type SetHilogLevelOptions, type SignOpenHarmonyHapOptions, type SignOpenHarmonyHapResult, type SigningKind, type SigningMaterialPaths, type SigningMaterialSummary, type SigningPasswords, type SmokeCheckOptions, type SmokeCrashProbe, type SmokeCrashProbeArgs, type SmokeResult, type SourceComment, type StackFrame, type StartEmulatorOptions, type StartPoolInstanceOptions, type StopPoolInstanceOptions, type StoredSession, type StreamHilogOptions, type SummarizeTraceOptions, type SyncDocsOptions, type SyncDocsResult, THREAD_HEADER_RE, TMP_DIR_HINT, TargetNotFoundError, type TemplateOption, type TestCaseResult, type TestOutcome, type TestRunReport, type TestStatus, type TestSummary, type ThreadStack, type Token, type TokenKind, type TokenStore, type TraceAsyncSlice, type TraceCounterSample, type TraceModel, TraceParser, type TraceSlice, type TraceSummary, UI_RECORD_CSV, type UiInputType, type UiRecordEvent, type UiRecordFinger, UnsupportedPlatformError, VERSION, type VerifyHapOptions, type VerifyHapResult, type WaitForBootOptions, type WaitForBundleOptions, type WaitForConditionOptions, type WaitForLogOptions, type WaitForTargetOptions, type WaitPoolInstanceReadyOptions, type WakeScreenOptions, type WakeScreenResult, type WatchLogOptions, type Waypoint, type WindowInfo, type XPathExpression, type XPathSelector, aaTestCommand, alignTouches, allIndexed, analyzeBlank, analyzeFaultLog, apiIndexCachePath, apiIndexKey, apiLevelOf, appSandboxDir, applyChanges, arktsCheckerScript, assertDevicePath, assertLayoutSelector, assertPoolInstance, attemptHdcConnection, boxIoU, buildApiIndex, buildCmdWrapper, buildGestureCommands, buildGestureUitestCommand, buildHap, buildHvigorwArgs, buildInputCommand, buildOutputTail, buildPoolQemuArgs, buildPropagation, buildRawTouchCommand, buildWithDiagnostics, bundleNameFromHapConfig, captureBurst, captureLog, checkArkts, checkCmdTools, checkCmdToolsFlavour, checkDisk, checkNode, checkScreensAgainstSpec, checkSigning, classifyEmulatorHealth, classifyFaultLog, clauseMatches, cleanBuildOutput, cleanCodelinterOutput, cleanMarkerName, commMatchesBundle, compareImages, consoleLogger, createHarmonyOsSession, createInstallTempDir, createMaterial, createScaffold, createTempWorkDir, createTokenStore, cropRows, dHash, decideInstallMethod, decideOutcome, decideReboot, decryptPwd, dedupEntries, defaultContext, defaultPaths, defaultSignedHapPath, dependencyApiDiagnostic, describeBuildSdk, describeCmdTools, describeLayoutNode, describeProfileValidity, describeProject, describeReplacement, describeSigningMaterial, deserializeApiIndex, detectAaStartFailure, detectCmdToolsFlavour, detectInstallFailure, detectProjectSdkVersion, detectRuntimeOs, detectSigningConfigNames, diagnoseBuildFailure, diffEntryNames, diffHapAssets, diffLayouts, discoverHaps, docQueryTerms, docTokens, docWords, docsDirFor, docsRefFor, docsTree, downloadAndInstallSdk, downloadFile, dumpLayout, dumpLog, dumpRenderService, dumpScreen, dumpWindow, elementAt, emulatorAccelArgs, encryptPwd, ensureFreeSpace, ensureInstallOk, ensureOhModules, ensureOk, ensureRemoteOk, escapeCmdArgument, escapeCmdCommand, evaluatePerfGate, evaluateXPath, existingHapOrUnsigned, expectFor, extractStackErrors, extractTarball, extractZipWithProgress, faultloggerCommand, fieldSelector, findApiInOtherSdks, findAppPids, findAppPidsBySurface, findAppProcessId, findCmdToolsSourceDir, findCoveredNodes, findHapSignTool, findHarmonyOsSdk, findKeyboardWindow, findLayoutNodes, findMissingProjectSdk, findRunningProcess, findSdkOsDir, findVisibleMatch, flatFrameHash, flatLayoutNode, flattenLayout, flowFromRecording, forceStop, formatBytes, formatFlow, formatHapVerification, formatSelector, formatUtc, generateSigningConfigs, getApiIndexCacheDir, getBundleName, getCmdToolsBin, getCmdToolsDownloadUrl, getCmdToolsPath, getCmdToolsStatus, getDefaultInstanceStatus, getDeviceInfo, getDisplaySize, getDocsRootDir, getEmulatorDir, getEmulatorStatus, getFreeSpaceBytes, getHarmonyOsSdkListing, getHdcPath, getHvigorwPath, getImeBundles, getInstalledSdks, getKey, getMainAbility, getOhosBaseSdkHome, getOhpmPath, getOsFolder, getPoolInstanceStatus, getSdkFilename, getSdkRootDir, getSupportedSdksForUi, hammingDistance, harmonyOsAutoSign, harmonyOsSdkLabelForApi, harmonyOsSignHap, hasOwnFields, hdcClientFailure, hdcExec, hdcTargetArgs, hdcTargetArgsFor, hideKeyboard, hilogSection, hilogTimeMs, holdScreenOn, indexLayout, installApp, installCmdTools, installEmulator, installFailureReason, installSdkFromArchive, installedApiLevels, inventoryScreens, isBundleInstalled, isCmdToolsInstalled, isCrashJson, isElementSelector, isEmulatorInstalled, isInstanceProcess, isLockScreenShown, isOutOfSpaceError, isPidAlive, isRamBackedPath, isTcpPortFree, isTestHap, isUnsignedHap, isUsableDevice, isValidBundleName, isValidProjectName, keystrokeChar, keystrokeName, killProcessTree, latestCrash, launchApp, listAbilities, listDevices, listFaultLogs, listLayoutWindows, listMarkdown, listModules, listPoolInstanceNumbers, listPoolInstanceStatuses, listRunningProcesses, listTemplates, listWindows, livePoolPids, loadApiIndex, locateTarget, matchSelector, mergeDocBlocks, missingProjectRootFiles, missingSdkSymbols, nameParts, nearMatches, needsCmdWrapper, nodeLabel, nonInteractivePrompter, noopLogger, noopProgress, normaliseLocalPath, normalizeFaultTime, normalizeKit, ohModulesPackage, pHash, pagesMatching, paramGet, paramGetMany, paramSet, parseActiveRefreshRate, parseArktsCheckOutput, parseBinder, parseBounds, parseBuildOutput, parseCodelinterFindings, parseCodelinterReport, parseCppCrash, parseCrashRecordHeads, parseDeviceList, parseDeviceTime, parseDoc, parseDocBlock, parseFaultLogList, parseFaultLogName, parseFlow, parseFrame, parseFreeze, parseHilogLine, parseHiperfReport, parseImeBundles, parseJsCrash, parseJsFrame, parseLayoutBaseline, parseMainAbilityFromBmDump, parseNativeFrame, parseParamValues, parsePowerState, parseProvisionProfile, parseRecorderForeground, parseRemoteExit, parseSelector, parseTestOutput, parseThreadStacks, parseTouchDowns, parseTraceFile, parseTraceText, parseUiRecordLines, parseUtcOffset, parseWindowList, parseXPath, perfSliceFilter, perfTrace, performInput, pickHap, pickSigningKind, pickTarget, pixelChangeRatio, poolInstanceDir, poolInstancePorts, poolRootDir, prepareSigning, probeEmulatorBoot, pruneLayout, quantile, rawWindowSubtree, readCmdToolsInfo, readDefaultEmulatorPid, readFaultLog, readFlowFile, readHapBundleName, readHapSigningInfo, readJson5File, readJsonFile, readLogTail, readPoolState, readProvisionProfile, readSdkPkg, readSdkRelease, readTestModuleName, readZipEntry, reboot, recordFlow, recvFile, removeCmdTools, removeEmulator, removeSdk, removeTempWorkDir, renderCrashJson, replayFlow, requireHarmonyOsSdk, resizeGrey, resolveApiSdk, resolveArktsCheckSdk, resolveBuildSdk, resolveDeviceSerial, resolveKeyEvent, resolveProjectSdkDir, resolveSelectorKey, resolveTmpRoot, runCodelinter, runDoctor, runHvigorw, runOhpm, runProcess, runTests, scanEts, scopedLogger, sdkTooOldDiagnostic, searchApi, selectDevice, selectableTree, selectorAttribute, selectorFor, sendFile, sendGesture, sendInput, sendRawTouch, serializeApiIndex, setHilogLevel, shell, shellChecked, showApi, signOpenHarmonyHap, signingMismatch, smokeCheck, smokeVerdict, spawnCompat, startEmulator, startPoolInstance, stateFile, staticConfig, statusFromCode, stopEmulator, stopPoolInstance, streamHilog, stripHidumperBanner, suggestApiSymbols, summarizeDivergenceLayout, summarizeLayout, summarizeTrace, syncDocs, takeScreenshot, testHapPath, toLongPath, toSpaceError, uninstallApp, unsignedHapRejection, validateTemplateLayout, verifyHap, verifyHapExitCode, verifySha256, waitForBoot, waitForBundle, waitForCondition, waitForLog, waitForTarget, waitPoolInstanceReady, wakeAndUnlock, watchLog, waypointsToRawEvents, windowNotFoundError, windowSubtree, withHapZip, withoutWindow, wordIn, writeJson5File, writeJsonFile, writePoolState };