Pacote NPM — API programática

Referência de TypeScript/API de JavaScript para @microsoft/winappcli. Cada comando da CLI está disponível como uma função assíncrona que captura stdout/stderr e retorna um resultado tipado. Utilitários auxiliares para identidade MSIX, identidade de depuração do Electron e ferramentas de build também são exportados.

Installation

npm install @microsoft/winappcli

Início 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 comuns

Cada wrapper de comando da CLI aceita um objeto de opções que se estende CommonOptions e retorna Promise<WinappResult>.

`CommonOptions`

Opções base compartilhadas pela maioria dos comandos.

Propriedade	Tipo	Obrigatório	Description
`quiet`	`boolean \\| undefined`	No	Suprimir mensagens de progresso.
`verbose`	`boolean \\| undefined`	No	Habilite a saída detalhada.
`cwd`	`string \\| undefined`	No	Diretório de trabalho para o processo da CLI (padrão para process.cwd()).

`WinappResult`

Resultado retornado por cada wrapper de comando.

Propriedade	Tipo	Obrigatório	Description
`exitCode`	`number`	Yes	Código de saída do processo (sempre 0 em caso de sucesso – códigos diferentes de zero indicam exceções).
`stdout`	`string`	Yes	Saída padrão capturada.
`stderr`	`string`	Yes	Erro padrão capturado.

Wrappers de comandos de CLI

Essas funções encapsulam comandos da CLI nativa winapp . Todos aceitam CommonOptions (quiet, verbose, ). cwd

`certGenerate()`

Crie um certificado autoassinado somente para testes locais. Publisher deve corresponder ao manifesto (inferido automaticamente se --manifest provided ou Package.appxmanifest estiver no diretório de trabalho). Saída: devcert.pfx (senha padrão: 'senha de acesso'). Para produção, obtenha um certificado de uma AC confiável. Use a "instalação de certificado" para confiar nesse computador.

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

Opções:

Propriedade	Tipo	Obrigatório	Description
`exportCer`	`boolean \\| undefined`	No	Exportar um arquivo .cer (somente chave pública) ao lado do .pfx
`ifExists`	`IfExists \\| undefined`	No	Comportamento quando o arquivo de saída existe: 'erro' (falha, padrão), 'pular' (manter existente) ou 'sobrescrever' (substituir)
`install`	`boolean \\| undefined`	No	Instalar o certificado no repositório de máquinas local após a geração
`json`	`boolean \\| undefined`	No	Formatar saída como JSON
`manifest`	`string \\| undefined`	No	Caminho para o arquivo Package.appxmanifest ou appxmanifest.xml para extrair informações do editor
`output`	`string \\| undefined`	No	Caminho de saída para o arquivo PFX gerado
`password`	`string \\| undefined`	No	Senha para o arquivo PFX gerado
`publisher`	`string \\| undefined`	No	Nome do editor para o certificado gerado. Se não for especificado, será inferido do manifesto.
`validDays`	`number \\| undefined`	No	Número de dias em que o certificado é válido