Pacote NPM — API Programática

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

Instalação

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 invólucro de comandos CLI aceita um objeto de opções que se estende CommonOptions e retorna Promise<WinappResult>.

`CommonOptions`

Opções base partilhadas pela maioria dos comandos.

Property	Tipo	Obrigatório	Description
`quiet`	`boolean \\| undefined`	No	Suprimir mensagens de progresso.
`verbose`	`boolean \\| undefined`	No	Ativa a saída verbosa.
`cwd`	`string \\| undefined`	No	Diretório de trabalho para o processo CLI (por padrão, o valor predefinido é process.cwd()).

`WinappResult`

Resultado devolvido por cada wrapper de comando.

Property	Tipo	Obrigatório	Description
`exitCode`	`number`	Yes	Código de saída do processo (sempre 0 no sucesso – lançamentos não nulos).
`stdout`	`string`	Yes	Captura da saída padrão.
`stderr`	`string`	Yes	Erro padrão capturado.

Envoltórios de comandos CLI

Estas funções envolvem comandos nativos winapp da CLI. Todos aceitam CommonOptions (quiet, verbose, cwd).

`certGenerate()`

Crie um certificado auto-assinado apenas para testes locais. O Publisher deve corresponder ao manifest (automaticamente inferido se --manifest fornecido ou Package.appxmanifest estiver no diretório de trabalho). Saída: devcert.pfx (palavra-passe padrão: 'senha'). Para produção, obtenha um certificado de uma Autoridade Certificadora (CA) de confiança. Usa o 'cert install' para confiar nesta máquina.

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

Opções:

Property	Tipo	Obrigatório	Description
`exportCer`	`boolean \\| undefined`	No	Exporte um ficheiro .cer (apenas chave pública) juntamente com o .pfx
`ifExists`	`IfExists \\| undefined`	No	Comportamento quando existe um ficheiro de saída: 'erro' (falha, predefinido), 'ignorar' (manter existente) ou 'sobrescrever' (substituir)
`install`	`boolean \\| undefined`	No	Instale o certificado no repositório local do computador após a geração
`json`	`boolean \\| undefined`	No	Formatar saída como JSON
`manifest`	`string \\| undefined`	No	Caminho para o ficheiro Package.appxmanifest ou appxmanifest.xml para extrair informações do publicador
`output`	`string \\| undefined`	No	Caminho de saída para o ficheiro PFX gerado
`password`	`string \\| undefined`	No	Palavra-passe para o ficheiro PFX gerado
`publisher`	`string \\| undefined`	No	Nome do Publisher para o certificado gerado. Se não for especificado, será inferido a partir do manifesto.
`validDays`	`number \\| undefined`	No	Número de dias em que o certificado é válido