@gjsify/cli 0.63.1-next.236 → 0.64.0

package/lib/commands/build.js

@@ -107,6 +107,11 @@ export const buildCommand = {
             type: 'string',
             choices: ['silent', 'error', 'warning', 'info', 'debug', 'verbose'],
             default: 'warning',
+        })
+            .option('channel', {
+            description: 'Distribution channel this build is for (ADR 0113): flathub, web, microsoft-store or apple-app-store. Sets the __GJSIFY_CHANNEL__ define that @gjsify/distribution reads; overrides gjsify.ship.channel. Unset builds report no donation UI.',
+            type: 'string',
+            choices: ['flathub', 'web', 'microsoft-store', 'apple-app-store'],
         })
             .option('dialect', {
             description: "The dialect the SOURCE is written in. 'react-native' aliases 'react-native' onto '@gjsify/react-native' and fails the build on an import whose ADR 0032 support-table status is not supported/partial. GJS and Node app builds. This is NOT gjsify.runtimes['react-native'], which declares the runtime a package RUNS on — the two answer opposite questions.",

package/lib/commands/flatpak/scaffold.js

@@ -26,6 +26,7 @@ function toMetadataInputs(inputs) {
         command: inputs.command,
         kind: inputs.kind,
         metadata: inputs.flatpak,
+        channel: 'flathub',
         configKey: 'gjsify.flatpak',
     };
 }

package/lib/commands/ship.d.ts

@@ -7,6 +7,7 @@ interface ShipOptions {
     'from-stage'?: string;
     'expect-target'?: string;
     'skip-build': boolean;
+    channel?: string;
     arch?: string;
     sign?: string;
     notarize?: string;

package/lib/commands/ship.js

@@ -22,6 +22,7 @@
 // on the two rows that are host-bound: a `.dmg` is a UDIF image over a real
 // HFS+/APFS volume that no Linux host in this tree can write (§ A1), and a
 // signature is made where the identity lives (§ A14).
+import { CHANNELS, CHANNEL_ENV, parseDeclaredChannel } from '../utils/channel.js';
 import { mkdirSync, readFileSync, statSync, writeFileSync } from 'node:fs';
 import { basename, dirname, join, relative, resolve } from 'node:path';
 import { Config } from '../config.js';
@@ -104,6 +105,12 @@ export const shipCommand = {
         type: 'string',
         description: 'With --from-stage: refuse unless the stage was assembled for this `<os>-<arch>`, e.g. ' +
             '`linux-arm64`.',
+    })
+        .option('channel', {
+        type: 'string',
+        choices: [...CHANNELS],
+        description: 'Distribution channel (ADR 0113). Overrides gjsify.ship.channel; `--target flatpak` implies flathub. ' +
+            'Passed to the project build, and gates the metainfo donation URL.',
     })
         .option('skip-build', {
         type: 'boolean',
@@ -303,8 +310,13 @@ async function assemble(args) {
     if (!args.stage)
         for (const format of formats)
             assertCanPack(format);
+    // flag > `gjsify.ship.channel` > what the target implies. Only flatpak implies one: an MSIX or a
+    // `.app` can as well be sideloaded (ADR 0113 § 2).
+    const channel = parseDeclaredChannel(args.channel, '--channel') ??
+        parseDeclaredChannel(ship.channel, 'gjsify.ship.channel') ??
+        (formats.some((format) => format.id === 'flatpak') ? 'flathub' : undefined);
     if (!args['skip-build'])
-        await runProjectBuild(projectDir);
+        await runProjectBuild(projectDir, channel);
     // THE OTHER HALF of the resolution above, and they are one decision: the
     // runtime a target execs and the entry it hands that runtime (#1545). Two
     // keys, resolved by two twin functions, compared by `assertEntryRunsUnder`
@@ -365,6 +377,7 @@ async function assemble(args) {
         command: settings.binaryName,
         kind: settings.kind,
         metadata,
+        channel,
         configKey: 'gjsify.ship',
         copyrightYear: new Date(mtime * 1000).getUTCFullYear(),
     };
@@ -1441,7 +1454,7 @@ function assertFormatCanRunInterpreter(format, app) {
  * `completion: 'return'` because this handler returns afterwards; on GJS that
  * selects the blocking path rather than arming a main loop only an exit quits.
  */
-async function runProjectBuild(projectDir) {
+async function runProjectBuild(projectDir, channel) {
     const pkg = readPackageJson(join(projectDir, 'package.json'));
     if (typeof pkg?.scripts?.build !== 'string') {
         throw new Error('gjsify ship: this project has no `build` script to run. Add one, or pass --skip-build to ' +
@@ -1452,6 +1465,7 @@ async function runProjectBuild(projectDir) {
         completion: 'return',
         cwd: projectDir,
         stdio: 'inherit',
+        env: channel === undefined ? undefined : { ...process.env, [CHANNEL_ENV]: channel },
         notFound: () => new Error('gjsify ship: `gjsify` is not on PATH, so the project build cannot be run. Build the project ' +
             'yourself and pass --skip-build.'),
     });

package/lib/commands/site.d.ts

@@ -3,6 +3,7 @@ interface SiteCliOptions {
     operation: string;
     root?: string;
     out?: string;
+    overview?: string;
     offline: boolean;
     cache: boolean;
     cacheDir?: string;

package/lib/commands/site.js

@@ -21,9 +21,11 @@
 // The resolved install directory is passed to the child as `--package-dir`. A
 // bundle's `import.meta.url` is the OUTFILE, so the library cannot find its own
 // `po/` and `lib/client/` on its own — only the caller still knows.
+import { spawnSync } from 'node:child_process';
 import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
 import { dirname, join, resolve } from 'node:path';
 import { hostRuntime } from '@gjsify/rolldown-plugin-gjsify/runtime';
+import { resolveNodeGi } from '../utils/run-node.js';
 /** The `@gjsify/site` install reachable from `cwd`, walking the node_modules chain upwards. */
 function resolveSitePackage(cwd) {
     let dir = resolve(cwd);
@@ -37,6 +39,23 @@ function resolveSitePackage(cwd) {
         dir = parent;
     }
 }
+function gjsOnPath() {
+    return spawnSync('gjs', ['--version'], { stdio: 'ignore' }).status === 0;
+}
+/**
+ * The runtime the page is built for. An explicit `--runtime` wins. Otherwise the host runtime —
+ * except that a non-gjs host without `@gjsify/node-gi` in the project cannot run the `--app node`
+ * bundle (GdkPixbuf is reached through it), so a consumer that only ran
+ * `npm i -D @gjsify/site` falls back to gjs when the system has one.
+ */
+function pickRuntime(requested, cwd) {
+    if (requested)
+        return requested;
+    const host = hostRuntime();
+    if (host === 'gjs' || resolveNodeGi(cwd))
+        return host;
+    return gjsOnPath() ? 'gjs' : host;
+}
 /**
  * The generated entry. Arguments arrive as ARGV rather than baked in, so the cached bundle serves
  * every invocation — flags change far more often than this does.
@@ -65,6 +84,10 @@ export const siteCommand = {
         .option('root', {
         description: 'Repository to read from (default: the working directory)',
         type: 'string',
+    })
+        .option('overview', {
+        description: 'build: render the support overview listed in this JSON file instead of one app',
+        type: 'string',
     })
         .option('out', { description: 'Output directory, emptied first (default: <root>/dist)', type: 'string' })
         .option('offline', { description: 'Skip every network call', type: 'boolean', default: false })
@@ -90,7 +113,8 @@ export const siteCommand = {
     })
         .option('runtime', {
         description: 'Runtime to build for and run on: gjs | node | bun | deno (default: the host runtime). ' +
-            'node/bun/deno build the same `--app node` bundle and require @gjsify/node-gi in the project.',
+            'node/bun/deno build the same `--app node` bundle and require @gjsify/node-gi in the project; ' +
+            'without it the default falls back to gjs.',
         type: 'string',
         choices: ['gjs', 'node', 'bun', 'deno'],
         defaultDescription: 'host runtime (gjs on gjs, else node/bun/deno)',
@@ -111,15 +135,29 @@ export const siteCommand = {
                 '  In a source checkout, build the package first: `gjsify workspace site build`.');
             return process.exit(1);
         }
-        const runtime = (args.runtime ?? hostRuntime());
+        const runtime = pickRuntime(args.runtime, cwd);
         const app = runtime === 'gjs' ? 'gjs' : 'node';
         const cacheDir = join(cwd, 'node_modules', '.cache', 'gjsify-site');
         mkdirSync(cacheDir, { recursive: true });
         const entryPath = join(cacheDir, `entry.${app}.ts`);
         const outPath = join(cacheDir, `site.${app}.mjs`);
         writeFileSync(entryPath, generateEntry(app));
-        const { runCli } = await import('../cli-app.js');
-        await runCli(['build', entryPath, '--app', app, '--globals', args.globals ?? 'auto', '--outfile', outPath]);
+        const globals = args.globals ?? 'auto';
+        if (app === 'gjs') {
+            // The consumer installed `@gjsify/site`, not the polyfills `--globals auto` injects
+            // (URL, DOMException, streams, …), so those resolve from beside the running CLI.
+            const { BuildAction } = await import('../actions/build.js');
+            await BuildAction.bundleFileForGjs(entryPath, outPath, {
+                globals,
+                preserveDefaultExport: false,
+                toolchainAnchor: BuildAction.runningCliFile(),
+                logLevel: 'silent',
+            });
+        }
+        else {
+            const { runCli } = await import('../cli-app.js');
+            await runCli(['build', entryPath, '--app', app, '--globals', globals, '--outfile', outPath]);
+        }
         // RESOLVED values, not the raw argv: the child parses its own flags and
         // cannot know where this CLI found the package.
         const forwarded = [args.operation, '--package-dir', packageDir];
@@ -127,6 +165,8 @@ export const siteCommand = {
             forwarded.push('--root', resolve(cwd, args.root));
         if (args.out)
             forwarded.push('--out', resolve(cwd, args.out));
+        if (args.overview)
+            forwarded.push('--overview', resolve(cwd, args.overview));
         if (args.offline)
             forwarded.push('--offline');
         if (!args.cache)

package/lib/config.js

@@ -1,4 +1,5 @@
 import { APP_NAME } from './constants.js';
+import { CHANNEL_ENV, parseDeclaredChannel } from './utils/channel.js';
 import { cosmiconfig } from 'cosmiconfig';
 import { basename, dirname } from 'node:path';
 import { pathToFileURL } from 'node:url';
@@ -360,6 +361,11 @@ export class Config {
             return out;
         };
         const defineMap = parseKvPairs(cliArgs.define ?? [], 'define');
+        // flag > env (set by `gjsify ship` for the project's own build) > `gjsify.ship.channel`.
+        const channel = parseDeclaredChannel(cliArgs.channel ?? process.env[CHANNEL_ENV] ?? configData.ship?.channel, cliArgs.channel !== undefined ? '--channel' : 'gjsify.ship.channel');
+        if (channel !== undefined && defineMap.__GJSIFY_CHANNEL__ === undefined) {
+            defineMap.__GJSIFY_CHANNEL__ = JSON.stringify(channel);
+        }
         const aliasMap = parseKvPairs(cliArgs.alias ?? [], 'alias');
         if (Object.keys(aliasMap).length) {
             configData.aliases = { ...configData.aliases, ...aliasMap };

package/lib/types/cli-build-options.d.ts

@@ -36,6 +36,8 @@ export interface CliBuildOptions {
      * whatever was typed, and the narrowing happens once, where the value is read.
      */
     dialect?: string;
+    /** Distribution channel (ADR 0113), becomes the `__GJSIFY_CHANNEL__` define. */
+    channel?: string;
     /**
      * Resolve `gi://Ns?version=X` to the target's widget renderer instead of an empty
      * module — `--gi-renderer` (ADR 0034 stage 9). `browser` and `nativescript` targets.

package/lib/types/config-data.d.ts

@@ -431,6 +431,13 @@ export interface AppMetadata {
  * `gjsify.flatpak` block usually needs no `gjsify.ship` block at all.
  */
 export interface ConfigDataShip extends AppMetadata {
+    /**
+     * Distribution channel (ADR 0113): `flathub | web | microsoft-store | apple-app-store`.
+     * Becomes the `__GJSIFY_CHANNEL__` define that `@gjsify/distribution` reads, and gates the
+     * metainfo `<url type="donation">`. `--channel` overrides it; `ship --target flatpak` implies
+     * `flathub` when nothing states one. Unset means no donation UI.
+     */
+    channel?: string;
     /** Reverse-DNS app id. Falls back to `gjsify.flatpak.appId`, then `package.json#name`. */
     appId?: string;
     /**

package/lib/utils/app-metadata.d.ts

@@ -10,6 +10,8 @@ export interface AppMetadataInputs {
     /** `'app'` renders a desktop-application component, `'cli'` a console one. */
     kind: 'app' | 'cli';
     metadata: AppMetadata;
+    /** Distribution channel (ADR 0113). `<url type="donation">` is emitted only where it allows donations. */
+    channel?: string;
     /**
      * Config path the validator names in its hints, e.g. `gjsify.flatpak` or
      * `gjsify.ship`. Both read the same fields, so the hint has to say which

package/lib/utils/app-metadata.js

@@ -13,6 +13,7 @@
 // attributes, provides) has too many optional nested sections for a
 // template+placeholder approach to stay legible. The `.desktop` entry stays
 // template-based — it is flat `key=value`.
+import { channelAllowsDonations } from './channel.js';
 /**
  * The `.desktop` skeleton, as source rather than as a file to find at runtime.
  *
@@ -190,7 +191,7 @@ function renderMetainfo(inputs, kind) {
         lines.push(`  <url type="bugtracker">${escapeXml(m.bugtrackerUrl)}</url>`);
     if (m.vcsBrowserUrl)
         lines.push(`  <url type="vcs-browser">${escapeXml(m.vcsBrowserUrl)}</url>`);
-    if (m.donationUrl)
+    if (m.donationUrl && channelAllowsDonations(inputs.channel))
         lines.push(`  <url type="donation">${escapeXml(m.donationUrl)}</url>`);
     if (m.translateUrl)
         lines.push(`  <url type="translate">${escapeXml(m.translateUrl)}</url>`);

package/lib/utils/channel.d.ts

@@ -0,0 +1,8 @@
+export declare const CHANNELS: readonly ["flathub", "web", "microsoft-store", "apple-app-store"];
+export type DeclaredChannel = (typeof CHANNELS)[number];
+/** Env var `gjsify ship` hands to the project's own build, which has no `--channel` to pass. */
+export declare const CHANNEL_ENV = "GJSIFY_CHANNEL";
+/** The channel `value` names, or a refusal that lists the alternatives. `undefined` stays unset. */
+export declare function parseDeclaredChannel(value: unknown, source: string): DeclaredChannel | undefined;
+/** Unset (an `unknown` build) permits no donation UI, as the ADR's quiet default. */
+export declare function channelAllowsDonations(channel: string | undefined): boolean;

package/lib/utils/channel.js

@@ -0,0 +1,24 @@
+// The distribution channel (ADR 0113), as the CLI needs it: validate a value, and ask whether
+// it permits donation UI. Mirrors `@gjsify/distribution`'s table on purpose and does not import
+// it: the CLI would then depend on a package it must be able to build and publish first.
+export const CHANNELS = ['flathub', 'web', 'microsoft-store', 'apple-app-store'];
+const DONATIONS = {
+    flathub: true,
+    web: true,
+    'microsoft-store': false,
+    'apple-app-store': false,
+};
+/** Env var `gjsify ship` hands to the project's own build, which has no `--channel` to pass. */
+export const CHANNEL_ENV = 'GJSIFY_CHANNEL';
+/** The channel `value` names, or a refusal that lists the alternatives. `undefined` stays unset. */
+export function parseDeclaredChannel(value, source) {
+    if (value === undefined || value === '')
+        return undefined;
+    if (CHANNELS.includes(value))
+        return value;
+    throw new Error(`${source}: "${String(value)}" is not a distribution channel. Known: ${CHANNELS.join(', ')}.`);
+}
+/** Unset (an `unknown` build) permits no donation UI, as the ADR's quiet default. */
+export function channelAllowsDonations(channel) {
+    return channel !== undefined && DONATIONS[channel] === true;
+}

package/lib/utils/run-node.js

@@ -63,8 +63,8 @@ export function nodeBinary() {
 export async function runNodeBundle(bundlePath, extraArgs = [], options) {
     const cwd = process.cwd();
     if (!resolveNodeGiForBundle(bundlePath, cwd)) {
-        throw new Error('Cannot run the storybook on Node: `@gjsify/node-gi` is not installed.\n' +
-            'Add @gjsify/node-gi as a dependency to run the storybook on Node, e.g.:\n' +
+        throw new Error('Cannot run this bundle on Node: `@gjsify/node-gi` is not installed.\n' +
+            'Add @gjsify/node-gi as a dependency to run it on Node, e.g.:\n' +
             '  "devDependencies": { "@gjsify/node-gi": "^0.13.0" }');
     }
     const { env: nativeEnv, envPrefix } = computeNativeEnvForBundle(bundlePath, cwd);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gjsify/cli",
-    "version": "0.63.1-next.236",
+    "version": "0.64.0",
     "description": "CLI for Gjsify",
     "type": "module",
     "main": "lib/index.js",
@@ -142,22 +142,22 @@
         "cli"
     ],
     "dependencies": {
-        "@gjsify/blueprint": "0.63.1-next.236",
-        "@gjsify/buffer": "0.63.1-next.236",
-        "@gjsify/create-app": "0.63.1-next.236",
-        "@gjsify/node-globals": "0.63.1-next.236",
-        "@gjsify/node-polyfills": "0.63.1-next.236",
-        "@gjsify/npm-registry": "0.63.1-next.236",
-        "@gjsify/resolve-npm": "0.63.1-next.236",
-        "@gjsify/rolldown-plugin-gjsify": "0.63.1-next.236",
-        "@gjsify/vite-plugin-blueprint": "0.63.1-next.236",
-        "@gjsify/rolldown-plugin-pnp": "0.63.1-next.236",
-        "@gjsify/semver": "0.63.1-next.236",
-        "@gjsify/tar": "0.63.1-next.236",
-        "@gjsify/tsc": "0.63.1-next.236",
-        "@gjsify/utils": "0.63.1-next.236",
-        "@gjsify/web-polyfills": "0.63.1-next.236",
-        "@gjsify/workspace": "0.63.1-next.236",
+        "@gjsify/blueprint": "^0.64.0",
+        "@gjsify/buffer": "^0.64.0",
+        "@gjsify/create-app": "^0.64.0",
+        "@gjsify/node-globals": "^0.64.0",
+        "@gjsify/node-polyfills": "^0.64.0",
+        "@gjsify/npm-registry": "^0.64.0",
+        "@gjsify/resolve-npm": "^0.64.0",
+        "@gjsify/rolldown-plugin-gjsify": "^0.64.0",
+        "@gjsify/vite-plugin-blueprint": "^0.64.0",
+        "@gjsify/rolldown-plugin-pnp": "^0.64.0",
+        "@gjsify/semver": "^0.64.0",
+        "@gjsify/tar": "^0.64.0",
+        "@gjsify/tsc": "^0.64.0",
+        "@gjsify/utils": "^0.64.0",
+        "@gjsify/web-polyfills": "^0.64.0",
+        "@gjsify/workspace": "^0.64.0",
         "acorn": "^8.17.0",
         "cosmiconfig": "^9.0.2",
         "get-tsconfig": "^4.14.0",
@@ -166,13 +166,13 @@
         "yargs": "^18.0.0"
     },
     "devDependencies": {
-        "@gjsify/unit": "0.63.1-next.236",
+        "@gjsify/unit": "^0.64.0",
         "@types/yargs": "^17.0.35",
         "typescript": "^6.0.3"
     },
     "peerDependencies": {
-        "@gjsify/oxfmt-native": "0.63.1-next.236",
-        "@gjsify/rolldown-native": "0.63.1-next.236"
+        "@gjsify/oxfmt-native": "^0.64.0",
+        "@gjsify/rolldown-native": "^0.64.0"
     },
     "peerDependenciesMeta": {
         "@gjsify/oxfmt-native": {
@@ -191,6 +191,5 @@
     "bugs": {
         "url": "https://github.com/gjsify/gjsify/issues"
     },
-    "homepage": "https://github.com/gjsify/gjsify/tree/main/packages/infra/cli#readme",
-    "gitHead": "d4ae412daabae9cb89f4fa11ee7279a308c9e4be"
+    "homepage": "https://github.com/gjsify/gjsify/tree/main/packages/infra/cli#readme"
 }