Paquet NPM — API programmatique

Référence TypeScript/API JavaScript pour @microsoft/winappcli. Chaque commande CLI est disponible en tant que fonction asynchrone qui capture stdout/stderr et retourne un résultat typé. Les utilitaires d’assistance pour l’identité MSIX, l’identité de débogage Electron et les outils de compilation sont également exportés.

Installation

npm install @microsoft/winappcli

Démarrage rapide

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' });

Types courants

Chaque wrapper de commande CLI accepte un objet options qui s’étend CommonOptions et retourne Promise<WinappResult>.

`CommonOptions`

Options de base partagées par la plupart des commandes.

Propriété	Catégorie	Obligatoire	Description
`quiet`	`boolean \\| undefined`	Non	Supprimez les messages de progression.
`verbose`	`boolean \\| undefined`	Non	Activez la sortie détaillée.
`cwd`	`string \\| undefined`	Non	Répertoire de travail pour le processus CLI (par défaut, process.cwd()).

`WinappResult`

Résultat renvoyé par chaque enveloppe de commande.

Propriété	Catégorie	Obligatoire	Description
`exitCode`	`number`	Oui	Code de sortie du processus (toujours 0 en cas de réussite – non zéro génère une exception).
`stdout`	`string`	Oui	Sortie standard capturée.
`stderr`	`string`	Oui	Erreur standard capturée.

Enveloppes de commandes CLI

Ces fonctions encapsulent les commandes CLI natives winapp . Acceptent tous CommonOptions (quiet, verbose, cwd).

`certGenerate()`

Créez un certificat auto-signé pour les tests locaux uniquement. L'éditeur doit correspondre au manifeste (déduit automatiquement si --manifest est fourni ou si Package.appxmanifest se trouve dans le répertoire de travail). Sortie : devcert.pfx (mot de passe par défaut : « mot de passe »). Pour la production, obtenez un certificat auprès d’une autorité de certification approuvée. Utilisez « cert install » pour faire confiance à cet ordinateur.

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

Options :

Propriété	Catégorie	Obligatoire	Description
`exportCer`	`boolean \\| undefined`	Non	Exporter un fichier .cer (clé publique uniquement) en même temps que le fichier .pfx
`ifExists`	`IfExists \\| undefined`	Non	Comportement lorsque le fichier de sortie existe : « erreur » (échec, valeur par défaut), « skip » (conserver existant) ou « remplacer » (remplacer)
`install`	`boolean \\| undefined`	Non	Installer le certificat dans le magasin d’ordinateurs local après la génération
`json`	`boolean \\| undefined`	Non	Mettre en forme la sortie au format JSON
`manifest`	`string \\| undefined`	Non	Chemin d’accès au fichier Package.appxmanifest ou appxmanifest.xml pour extraire les informations de l’éditeur.
`output`	`string \\| undefined`	Non	Chemin d’accès de sortie pour le fichier PFX généré
`password`	`string \\| undefined`	Non	Mot de passe pour le fichier PFX généré
`publisher`	`string \\| undefined`	Non	Nom de l'éditeur pour le certificat généré. S’il n’est pas spécifié, il sera déduit du manifeste.
`validDays`	`number \\| undefined`	Non	Nombre de jours pendant lesquels le certificat est valide