@lakutata/builder 3.1.3 → 3.1.5

package/dist/types/lib/nwjs/Runtime.d.ts

@@ -0,0 +1,116 @@
+/**
+ * A release of NW.js: its version and the ones of the Node.js and the Chromium it embeds, the systems it is built for
+ */
+export type NwjsRelease = {
+    /**
+     * The version of NW.js (0.119.2)
+     */
+    version: string;
+    /**
+     * The day it was released (2026/10/22)
+     */
+    date: string;
+    /**
+     * The version of the Node.js it embeds (26.12.1)
+     */
+    node: string;
+    /**
+     * The version of the Chromium it embeds (156.0.8078.48)
+     */
+    chromium: string;
+    /**
+     * The systems it is built for: win-x64, win-ia32, win-arm64, osx-x64, osx-arm64, linux-x64, linux-ia32, linux-arm64
+     */
+    platforms: string[];
+};
+/**
+ * The flavors of NW.js: normal (the one shipped), sdk (with the developer tools, for the development)
+ */
+export type NwjsFlavor = 'normal' | 'sdk';
+/**
+ * The options of {@link downloadNwjs}
+ */
+export type NwjsRuntimeOptions = {
+    /**
+     * The version of NW.js: a version (0.72.0), latest (the latest release) or win7 (0.72.0, the last one running on
+     * Windows 7, 8 and 8.1)
+     */
+    version: string;
+    /**
+     * normal (by default) or sdk
+     */
+    flavor?: NwjsFlavor;
+    /**
+     * The system (process.platform: win32, darwin, linux), the one of the machine by default
+     */
+    platform?: NodeJS.Platform;
+    /**
+     * The architecture (process.arch: x64, ia32, arm64), the one of the machine by default. On a Mac with Apple silicon,
+     * a release without osx-arm64 (before 0.77) is the x64 one, run by Rosetta
+     */
+    arch?: string;
+};
+/**
+ * A runtime of NW.js, downloaded into the cache
+ */
+export type NwjsRuntime = NwjsRelease & {
+    flavor: NwjsFlavor;
+    /**
+     * Its system and its architecture as NW.js names them (osx-arm64)
+     */
+    platform: string;
+    /**
+     * The directory of the runtime: nw.exe and its libraries, nwjs.app, nw and its libraries
+     */
+    directory: string;
+    /**
+     * Its executable: nw.exe, nwjs.app/Contents/MacOS/nwjs, nw
+     */
+    executable: string;
+};
+/**
+ * Compare two versions (1.2.3)
+ * @param left
+ * @param right
+ */
+export declare function compareVersions(left: string, right: string): number;
+/**
+ * The releases of NW.js, newest first: the list of nwjs.io (LAKUTATA_NWJS_VERSIONS), kept a day in the cache; the
+ * cached one when it cannot be read
+ * @example
+ * import {nwjsReleases} from '@lakutata/builder'
+ *
+ * for (const release of (await nwjsReleases()).slice(0, 3)) console.log(release.version, release.node, release.chromium)
+ */
+export declare function nwjsReleases(): Promise<NwjsRelease[]>;
+/**
+ * A release of NW.js: a version, latest (the latest release) or win7 (0.72.0, the last one running on Windows 7, 8
+ * and 8.1). Refused when it embeds a Node.js older than the one lakutata runs on (18.10)
+ * @param version
+ * @example
+ * import {nwjsRelease} from '@lakutata/builder'
+ *
+ * const release = await nwjsRelease('win7')
+ * console.log(release.version, release.node, release.chromium) //0.72.0 19.3.0 109.0.5414.87
+ */
+export declare function nwjsRelease(version: string): Promise<NwjsRelease>;
+/**
+ * The system and the architecture of a release as NW.js names them (osx-arm64), the x64 build on a Mac with Apple
+ * silicon when the release has no arm64 one
+ * @param release
+ * @param platform
+ * @param arch
+ */
+export declare function nwjsPlatform(release: NwjsRelease, platform?: NodeJS.Platform, arch?: string): string;
+/**
+ * A runtime of NW.js for a system, downloaded once into the cache (~/.cache/lakutata/nwjs, LAKUTATA_CACHE_DIR) from
+ * dl.nwjs.io (LAKUTATA_NWJS_MIRROR: a mirror of it) and checked with the SHASUMS256.txt of its release
+ * @param options
+ * @example
+ * import {downloadNwjs} from '@lakutata/builder'
+ *
+ * //The NW.js of the development (its developer tools), for the machine
+ * const runtime = await downloadNwjs({version: 'latest', flavor: 'sdk'})
+ * console.log(runtime.executable, runtime.node)
+ */
+export declare function downloadNwjs(options: NwjsRuntimeOptions): Promise<NwjsRuntime>;

package/dist/types/lib/nwjs/Stage.d.ts

@@ -0,0 +1,104 @@
+import { type BundleResult } from '../Bundle.js';
+import { type NwjsRelease } from './Runtime.js';
+import { type NwjsAddons } from './Addons.js';
+/**
+ * The NW.js of an application: the "lakutata.nwjs" of its package.json
+ */
+export type NwjsConfig = {
+    /**
+     * The version of NW.js: a version (0.119.2), latest, or win7 (0.72.0, the last one running on Windows 7, 8 and 8.1)
+     */
+    version: string;
+    /**
+     * The name of the application in NW.js, which names the directory of its data: the appId of its installer, else the
+     * name of its package (in lower case)
+     */
+    name?: string;
+    /**
+     * The arguments given to Chromium (the "chromium-args" of the manifest of NW.js)
+     */
+    chromiumArgs?: string;
+};
+/**
+ * The options of {@link stageNwjsApp}
+ */
+export type NwjsStageOptions = {
+    /**
+     * The directory of the application (its package.json), the current one by default
+     */
+    project?: string;
+    /**
+     * The directory of the application of NW.js made
+     */
+    outdir: string;
+    /**
+     * The version of NW.js, the one of lakutata.nwjs by default
+     */
+    version?: string;
+    /**
+     * The compiled entry of the application (the "main" of the package.json by default)
+     */
+    entry?: string;
+    /**
+     * Minify the bundle (false by default)
+     */
+    minify?: boolean;
+    /**
+     * The modules left out of the bundle
+     */
+    external?: string[];
+    /**
+     * The system of the runtime (process.platform), the one of the machine by default
+     */
+    platform?: NodeJS.Platform;
+    /**
+     * The architecture of the runtime (process.arch), the one of the machine by default (x64 on a Mac with Apple silicon
+     * for the releases without osx-arm64)
+     */
+    arch?: string;
+};
+/**
+ * The application of NW.js made by {@link stageNwjsApp}
+ */
+export type NwjsStage = {
+    /**
+     * Its directory: its manifest (package.json), its background script (main.js), the bundle of the application (app.cjs),
+     * its native tree (app.native) and its resources (resources)
+     */
+    directory: string;
+    /**
+     * The release of NW.js it is made for
+     */
+    release: NwjsRelease;
+    /**
+     * Its name in NW.js (the directory of its data)
+     */
+    name: string;
+    /**
+     * The build of NW.js it is made for (win-x64, osx-arm64…)
+     */
+    platform: string;
+    bundle: BundleResult;
+    /**
+     * What was done to its native addons to load them in NW.js
+     */
+    addons: NwjsAddons;
+};
+/**
+ * The NW.js of an application, from the "lakutata.nwjs" of its package.json
+ * @param manifest
+ */
+export declare function nwjsConfig(manifest: Record<string, any>): NwjsConfig;
+/**
+ * Make the application of NW.js of a project: its bundle (CommonJS, for the Node.js of the release), its native tree
+ * and its resources (lakutata.resources), the manifest of NW.js (its name, its background script, the partition of the
+ * webviews holding its user interface) and the background script running the bundle
+ * @param options
+ * @example
+ * import {stageNwjsApp} from '@lakutata/builder'
+ *
+ * //The application of the development, run by: nw .nwjs/app
+ * const stage = await stageNwjsApp({outdir: '.nwjs/app'})
+ * console.log(stage.directory, stage.release.version, stage.name)
+ */
+export declare function stageNwjsApp(options: NwjsStageOptions): Promise<NwjsStage>;

package/dist/types/lib/win/Windows.d.ts

@@ -1,10 +1,38 @@
 import type { InstallerPlan } from '../Installer.js';
+import type { InstallerHook } from '../Scripts.js';
 /**
  * The installers of Windows: the installer of NSIS (.exe), the package of Windows Installer (.msi), the zip archive of
  * the directory of the executable
  */
 export declare const WINDOWS_TARGETS: readonly ["nsis", "msi", "zip"];
 export type WindowsTarget = typeof WINDOWS_TARGETS[number];
+/**
+ * The script of NSIS of the installer: its files in Program Files, its uninstaller registered, its script run (the
+ * service of the version it replaces stopped first, its files being replaced); the scripts of the application run from
+ * its temporary directory (the preinstall one before its files are installed, the postinstall one before the service
+ * starts, the preremove one once it is stopped, the postremove one once the files are removed), the macros of the file
+ * of NSIS it includes inserted
+ * @param plan
+ * @param stage the files it installs
+ * @param file
+ * @param scripts the scripts of the application (written with the mark of UTF-8, which Windows PowerShell reads them by)
+ * @internal
+ */
+export declare function nsisScript(plan: InstallerPlan, stage: string, file: string, scripts: {
+    hooks: Partial<Record<InstallerHook, string>>;
+    include?: string;
+}): string;
+/**
+ * The source of WiX of the package: its files (a component each, their directories), its service (WinSW) installed,
+ * started, stopped and removed by Windows Installer, its PATH, its data in ProgramData (its environment file kept by
+ * the upgrades and the removals), the versions replaced by the upgrades
+ * @param plan
+ * @param stage the files it installs
+ * @param serviceDirectory the files of its service (WinSW and its configuration)
+ * @param environment the environment file
+ * @internal
+ */
+export declare function wixSource(plan: InstallerPlan, stage: string, serviceDirectory: string, environment: string | undefined): string;
 /**
  * Make the installers of Windows of an application: the installer of NSIS, the package of Windows Installer (WiX), the
  * zip archive of the directory of the executable; its service run by WinSW

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lakutata/builder",
-  "version": "3.1.3",
+  "version": "3.1.5",
   "description": "The builder of the applications of the lakutata framework: their bundles, their executables (Node.js, Bun) with their native addons and their resources.",
   "keywords": [
     "lakutata",
@@ -60,7 +60,7 @@
     }
   },
   "engines": {
-    "node": "^22.13.0 || >=24.11.0"
+    "node": ">=18.10.0"
   },
   "license": "MIT",
   "files": [