Paquete NPM: API de programación

Referencia de TypeScript/API de JavaScript para @microsoft/winappcli. Cada comando de la interfaz de línea de comandos (CLI) está disponible como una función asincrónica que captura stdout/stderr y devuelve un resultado con tipo. También se exportan las utilidades auxiliares para la identidad MSIX, la identidad de depuración de Electron y las herramientas de compilación.

Installation

npm install @microsoft/winappcli

Inicio rápido

import { init, packageApp, certGenerate } from '@microsoft/winappcli';

// Initialize a new project with defaults
await init({ useDefaults: true });

// Generate a dev certificate
await certGenerate({ install: true });

// Package the built app
await packageApp({ inputFolder: './dist', cert: './devcert.pfx' });

Tipos comunes

Cada contenedor de comandos de la CLI acepta un objeto options que extiende CommonOptions y devuelve Promise<WinappResult>.

`CommonOptions`

Opciones base compartidas por la mayoría de los comandos.

Propiedad	Tipo	Obligatorio	Description
`quiet`	`boolean \\| undefined`	No	Suprima los mensajes de progreso.
`verbose`	`boolean \\| undefined`	No	Habilite la salida detallada.
`cwd`	`string \\| undefined`	No	Directorio de trabajo para el proceso de la CLI (el valor predeterminado es process.cwd()).

`WinappResult`

Resultado devuelto por cada envoltorio de comandos.

Propiedad	Tipo	Obligatorio	Description
`exitCode`	`number`	Sí	Código de salida del proceso (siempre 0 en caso de éxito – distinto de cero en caso de error).
`stdout`	`string`	Sí	Salida estándar capturada.
`stderr`	`string`	Sí	Error estándar capturado.

Envolventes de comandos de la CLI

Estas funciones encapsulan comandos nativos winapp de la CLI. Todas aceptan CommonOptions (quiet, verbose, cwd).

`certGenerate()`

Cree un certificado autofirmado solo para pruebas locales. El publicador debe coincidir con el manifiesto (inferido automáticamente si se proporciona --manifest o si Package.appxmanifest está en el directorio de trabajo). Salida: devcert.pfx (contraseña predeterminada: 'password'). Para el entorno de producción, obtenga un certificado de una entidad de certificación de confianza. Use "cert install" para confiar en esta máquina.

function certGenerate(options?: CertGenerateOptions): Promise<WinappResult>

Opciones:

Propiedad	Tipo	Obligatorio	Description
`exportCer`	`boolean \\| undefined`	No	Exportar un archivo .cer (solo clave pública) junto con el archivo .pfx
`ifExists`	`IfExists \\| undefined`	No	Comportamiento cuando existe un archivo de salida: 'error' (error, valor predeterminado), 'skip' (mantener existente) o 'overwrite' (reemplazar)
`install`	`boolean \\| undefined`	No	Instale el certificado en el almacén del equipo local después de generarlo
`json`	`boolean \\| undefined`	No	Dar formato a la salida como JSON
`manifest`	`string \\| undefined`	No	Ruta de acceso al archivo Package.appxmanifest o appxmanifest.xml para extraer información del publicador
`output`	`string \\| undefined`	No	Ruta de acceso de salida para el archivo PFX generado
`password`	`string \\| undefined`	No	Contraseña del archivo PFX generado
`publisher`	`string \\| undefined`	No	Nombre del editor para el certificado generado. Si no se especifica, se deducirá del manifiesto.
`validDays`	`number \\| undefined`	No	Número de días que el certificado es válido