Skip to content

Commit f64eac7

Browse files
committed
autogenerated files
1 parent 78fcb54 commit f64eac7

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

docs/npm-usage.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,7 @@ function run(options: RunOptions): Promise<WinappResult>
343343
| `manifest` | `string \| undefined` | No | Path to the appxmanifest.xml (default: auto-detect from input folder or current directory) |
344344
| `noLaunch` | `boolean \| undefined` | No | Only create the debug identity and register the package without launching the application |
345345
| `outputAppxDirectory` | `string \| undefined` | No | Output directory for the loose layout package. If not specified, a directory named AppX inside the input-folder directory will be used. |
346+
| `symbols` | `boolean \| undefined` | No | Download symbols from Microsoft Symbol Server for richer native crash analysis. Only used with --debug-output. First run downloads symbols and caches them locally; subsequent runs use the cache. |
346347
| `unregisterOnExit` | `boolean \| undefined` | No | Unregister the development package after the application exits. Only removes packages registered in development mode. |
347348
| `withAlias` | `boolean \| undefined` | No | Launch the app using its execution alias instead of AUMID activation. The app runs in the current terminal with inherited stdin/stdout/stderr. Requires a uap5:ExecutionAlias in the manifest. Use "winapp manifest add-alias" to add an execution alias to the manifest. |
348349

@@ -725,11 +726,12 @@ function uiWaitFor(options?: UiWaitForOptions): Promise<WinappResult>
725726
|----------|------|----------|-------------|
726727
| `selector` | `string \| undefined` | No | Semantic slug (e.g., btn-minimize-d1a0) or text to search by name/automationId |
727728
| `app` | `string \| undefined` | No | Target app (process name, window title, or PID). Lists windows if ambiguous. |
729+
| `contains` | `boolean \| undefined` | No | Use substring matching for --value instead of exact match |
728730
| `gone` | `boolean \| undefined` | No | Wait for element to disappear instead of appear |
729731
| `json` | `boolean \| undefined` | No | Format output as JSON |
730732
| `property` | `string \| undefined` | No | Property name to read or filter on |
731733
| `timeout` | `number \| undefined` | No | Timeout in milliseconds |
732-
| `value` | `string \| undefined` | No | Wait for property to equal this value (use with --property) |
734+
| `value` | `string \| undefined` | No | Wait for element value to equal this string. Uses smart fallback (TextPatternValuePatternName). Combine with --property to check a specific property instead. |
733735
| `window` | `number \| undefined` | No | Target window by HWND (stable handle from list output). Takes precedence over --app. |
734736

735737
*Also accepts [CommonOptions](#commonoptions) (`quiet`, `verbose`, `cwd`).*
@@ -1249,6 +1251,7 @@ type ManifestTemplates = "packaged" | "sparse"
12491251
| `manifest` | `string \| undefined` | No | Path to the appxmanifest.xml (default: auto-detect from input folder or current directory) |
12501252
| `noLaunch` | `boolean \| undefined` | No | Only create the debug identity and register the package without launching the application |
12511253
| `outputAppxDirectory` | `string \| undefined` | No | Output directory for the loose layout package. If not specified, a directory named AppX inside the input-folder directory will be used. |
1254+
| `symbols` | `boolean \| undefined` | No | Download symbols from Microsoft Symbol Server for richer native crash analysis. Only used with --debug-output. First run downloads symbols and caches them locally; subsequent runs use the cache. |
12521255
| `unregisterOnExit` | `boolean \| undefined` | No | Unregister the development package after the application exits. Only removes packages registered in development mode. |
12531256
| `withAlias` | `boolean \| undefined` | No | Launch the app using its execution alias instead of AUMID activation. The app runs in the current terminal with inherited stdin/stdout/stderr. Requires a uap5:ExecutionAlias in the manifest. Use "winapp manifest add-alias" to add an execution alias to the manifest. |
12541257
| `quiet` | `boolean \| undefined` | No | Suppress progress messages. |
@@ -1469,11 +1472,12 @@ type ManifestTemplates = "packaged" | "sparse"
14691472
|----------|------|----------|-------------|
14701473
| `selector` | `string \| undefined` | No | Semantic slug (e.g., btn-minimize-d1a0) or text to search by name/automationId |
14711474
| `app` | `string \| undefined` | No | Target app (process name, window title, or PID). Lists windows if ambiguous. |
1475+
| `contains` | `boolean \| undefined` | No | Use substring matching for --value instead of exact match |
14721476
| `gone` | `boolean \| undefined` | No | Wait for element to disappear instead of appear |
14731477
| `json` | `boolean \| undefined` | No | Format output as JSON |
14741478
| `property` | `string \| undefined` | No | Property name to read or filter on |
14751479
| `timeout` | `number \| undefined` | No | Timeout in milliseconds |
1476-
| `value` | `string \| undefined` | No | Wait for property to equal this value (use with --property) |
1480+
| `value` | `string \| undefined` | No | Wait for element value to equal this string. Uses smart fallback (TextPatternValuePatternName). Combine with --property to check a specific property instead. |
14771481
| `window` | `number \| undefined` | No | Target window by HWND (stable handle from list output). Takes precedence over --app. |
14781482
| `quiet` | `boolean \| undefined` | No | Suppress progress messages. |
14791483
| `verbose` | `boolean \| undefined` | No | Enable verbose output. |

src/winapp-npm/src/winapp-commands.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -455,6 +455,8 @@ export interface RunOptions extends CommonOptions {
455455
noLaunch?: boolean;
456456
/** Output directory for the loose layout package. If not specified, a directory named AppX inside the input-folder directory will be used. */
457457
outputAppxDirectory?: string;
458+
/** Download symbols from Microsoft Symbol Server for richer native crash analysis. Only used with --debug-output. First run downloads symbols and caches them locally; subsequent runs use the cache. */
459+
symbols?: boolean;
458460
/** Unregister the development package after the application exits. Only removes packages registered in development mode. */
459461
unregisterOnExit?: boolean;
460462
/** Launch the app using its execution alias instead of AUMID activation. The app runs in the current terminal with inherited stdin/stdout/stderr. Requires a uap5:ExecutionAlias in the manifest. Use "winapp manifest add-alias" to add an execution alias to the manifest. */
@@ -475,6 +477,7 @@ export async function run(options: RunOptions): Promise<WinappResult> {
475477
if (options.manifest) args.push('--manifest', options.manifest);
476478
if (options.noLaunch) args.push('--no-launch');
477479
if (options.outputAppxDirectory) args.push('--output-appx-directory', options.outputAppxDirectory);
480+
if (options.symbols) args.push('--symbols');
478481
if (options.unregisterOnExit) args.push('--unregister-on-exit');
479482
if (options.withAlias) args.push('--with-alias');
480483
return execCommand(args, options);
@@ -962,6 +965,8 @@ export interface UiWaitForOptions extends CommonOptions {
962965
selector?: string;
963966
/** Target app (process name, window title, or PID). Lists windows if ambiguous. */
964967
app?: string;
968+
/** Use substring matching for --value instead of exact match */
969+
contains?: boolean;
965970
/** Wait for element to disappear instead of appear */
966971
gone?: boolean;
967972
/** Format output as JSON */
@@ -970,7 +975,7 @@ export interface UiWaitForOptions extends CommonOptions {
970975
property?: string;
971976
/** Timeout in milliseconds */
972977
timeout?: number;
973-
/** Wait for property to equal this value (use with --property) */
978+
/** Wait for element value to equal this string. Uses smart fallback (TextPattern → ValuePattern → Name). Combine with --property to check a specific property instead. */
974979
value?: string;
975980
/** Target window by HWND (stable handle from list output). Takes precedence over --app. */
976981
window?: number;
@@ -983,6 +988,7 @@ export async function uiWaitFor(options: UiWaitForOptions = {}): Promise<WinappR
983988
const args: string[] = ['ui', 'wait-for'];
984989
if (options.selector) args.push(options.selector);
985990
if (options.app) args.push('--app', options.app);
991+
if (options.contains) args.push('--contains');
986992
if (options.gone) args.push('--gone');
987993
if (options.json) args.push('--json');
988994
if (options.property) args.push('--property', options.property);

0 commit comments

Comments
 (0)