@rathnasgala/cli 0.0.15 → 0.0.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rathnasgala/cli",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "type": "module",
   "files": [
     "src"

package/src/scaffold-preflight.js

@@ -5,7 +5,6 @@ import { authenticateGithub } from './github-auth-command.js';
 import { readGalaCredential } from './gala-credential-store.js';
 import { readGithubCredential } from './github-credential-store.js';
 import { resolveGithubLogin } from './github-identity.js';
-import { resolveInstallationId } from './gala-installation-client.js';
 import { galaCredentialAccepted } from './gala-credential-health.js';
 import { openInBrowser } from './open-browser.js';
 import { forgetGalaCredential } from './gala-credential-store.js';
@@ -36,8 +35,6 @@ export async function prepareScaffold({
   cwd = process.cwd(),
   notify = () => {},
   ask,
-  installUrl = GITHUB_APP_INSTALL_URL,
-  installAttempts = 3,
   openUrl = openInBrowser,
   readGala = readGalaCredential,
   readGithub = readGithubCredential,
@@ -46,7 +43,6 @@ export async function prepareScaffold({
   signInGala = authenticateGala,
   signInGithub = authenticateGithub,
   resolveLogin = resolveGithubLogin,
-  resolveInstallation = resolveInstallationId,
   apiBaseUrl = DEFAULT_API_BASE_URL
 } = {}) {
   const gala = await ensureGala({
@@ -65,20 +61,18 @@ export async function prepareScaffold({
   // directory the writer is standing in. Everywhere else the repository names its own folder.
   const resolvedTarget = target ?? `./${resolvedRepository}`;
 
-  const resolvedInstallation = githubInstallationId
-    ?? await ensureInstallation({
-      apiBaseUrl: gala.apiBaseUrl ?? apiBaseUrl,
-      galaAccessToken: gala.accessToken,
-      githubAccessToken: github.accessToken,
-      owner: resolvedOwner,
-      notify, ask, installUrl, installAttempts, resolveInstallation, openUrl
-    });
-
+  /*
+   * No installation lookup. The id is an internal GitHub identifier for an App the server owns, and
+   * nothing here can discover it reliably: a GitHub App token could list installations and the CLI
+   * cannot hold one, while the repository inventory only carries the id once a repository exists —
+   * which, in the flow that creates the first repository, is never. The server resolves it during
+   * registration. `--installation-id` still overrides, for an account with several.
+   */
   return Object.freeze({
     owner: resolvedOwner,
     repository: resolvedRepository,
     target: resolvedTarget,
-    githubInstallationId: resolvedInstallation
+    githubInstallationId: githubInstallationId ?? null
   });
 }
 
@@ -133,47 +127,6 @@ async function ensureGithub({ notify, readGithub, signInGithub, openUrl }) {
   }
 }
 
-/**
- * Confirms the Gala GitHub App is installed, walking the writer through installing it if not.
- *
- * This is the step that used to be a manual detour through GitHub's settings to copy a number out
- * of a redirect URL. The loop is what makes it a step rather than a failure: the writer installs
- * the App in the browser, comes back, presses enter, and the run continues.
- */
-async function ensureInstallation({
-  apiBaseUrl, galaAccessToken, githubAccessToken, owner,
-  notify, ask, installUrl, installAttempts, resolveInstallation, openUrl
-}) {
-  for (let attempt = 0; attempt < Math.max(1, installAttempts); attempt += 1) {
-    const installationId = await resolveInstallation({
-      apiBaseUrl, galaAccessToken, githubAccessToken, owner
-    });
-    if (installationId != null) return installationId;
-
-    if (typeof ask !== 'function') {
-      throw new Error(
-        `The Gala GitHub App is not installed on ${owner}. Install it at ${installUrl} and run `
-        + 'scaffold again, or pass --installation-id explicitly.'
-      );
-    }
-
-    // An installation belongs to one account. Installing it on a personal account when the
-    // publication is meant for an organisation looks like it worked and changes nothing here, so
-    // the account being checked is named every time rather than assumed.
-    notify(attempt === 0
-      ? `The Gala GitHub App is not installed on ${owner} yet.`
-      : `Still not seeing the App on ${owner}. Check that you installed it on ${owner} itself `
-        + 'and not on another account or organisation you belong to.');
-    notify(`${openUrl(installUrl) ? 'Opened' : 'Open'} ${installUrl}`);
-    await ask('Press enter once the App is installed. ');
-  }
-  throw new Error(
-    `The Gala GitHub App still does not cover ${owner}. Install it at ${installUrl} for ${owner} `
-    + 'specifically, then run scaffold again. If the App is installed under a different account, '
-    + 'pass --owner for that account, or --installation-id to name the installation directly.'
-  );
-}
-
 /** GitHub repository names allow letters, digits, dot, underscore and hyphen, and nothing else. */
 export function repositoryNameFrom(siteName) {
   if (typeof siteName !== 'string') return null;

package/src/scaffold-site.js

@@ -62,7 +62,10 @@ export async function scaffoldSite({
   const repositoryOwner = segment(owner, 'owner');
   const repositoryName = segment(repository, 'repository');
   const location = registrationLocation(repositoryOwner, topology, canonicalBaseUrl);
-  if (!Number.isSafeInteger(githubInstallationId) || githubInstallationId <= 0) {
+  // Optional: the server resolves the installation from the owner when none is supplied. An
+  // explicit value is still validated, because a wrong one fails much later and less clearly.
+  if (githubInstallationId != null
+      && (!Number.isSafeInteger(githubInstallationId) || githubInstallationId <= 0)) {
     throw new TypeError('githubInstallationId must be a positive integer');
   }
   if (target == null || path.resolve(target) === path.parse(path.resolve(target)).root) {

package/src/site-registration-client.js

@@ -61,7 +61,8 @@ export async function registerSite({
   required(idempotencyKey, 'idempotencyKey', IDEMPOTENCY_KEY);
   required(repositoryOwner, 'repositoryOwner', REPOSITORY_PART);
   required(repositoryName, 'repositoryName', REPOSITORY_PART);
-  if (!Number.isSafeInteger(githubInstallationId) || githubInstallationId <= 0) {
+  if (githubInstallationId != null
+      && (!Number.isSafeInteger(githubInstallationId) || githubInstallationId <= 0)) {
     throw new TypeError('githubInstallationId must be a positive integer');
   }
   if (!['PROVIDER_DEFAULT', 'CUSTOM_DOMAIN'].includes(topology)) {
@@ -77,7 +78,8 @@ export async function registerSite({
       'idempotency-key': idempotencyKey
     },
     body: JSON.stringify({
-      githubInstallationId,
+      // Omitted rather than sent as null: the server resolves it from the owner.
+      ...(githubInstallationId == null ? {} : { githubInstallationId }),
       repositoryOwner,
       repositoryName,
       topology,
@@ -91,6 +93,14 @@ export async function registerSite({
     throw new Error(`GitHub App installation does not cover ${repositoryOwner}/${repositoryName}`);
   }
   if (response.status === 409) {
+    const failure = await response.clone().json().catch(() => null);
+    if (failure?.code === 'GITHUB_APP_NOT_INSTALLED') {
+      throw new Error(
+        `The Gala GitHub App is not installed on ${repositoryOwner}. Install it at `
+        + 'https://github.com/apps/gala67-app/installations/new for that account, then run scaffold '
+        + 'again.'
+      );
+    }
     throw new Error('Site registration conflicts with existing protected state; use the recovery command');
   }
   if (response.status !== 201) throw new Error(`Gala site registration failed with HTTP ${response.status}`);

package/src/gala-installation-client.js

@@ -1,91 +0,0 @@
-/**
- * Which Gala GitHub App installation covers this writer's account.
- *
- * The installation ID is an internal GitHub identifier that `scaffold` has to send when it
- * registers a site. Until now the writer supplied it by installing the App, watching GitHub
- * redirect to `https://github.com/settings/installations/153144989`, and copying the number out of
- * the address bar — an internal identifier, read out of a URL, by hand.
- *
- * The Gala API already knows it. `GET /v1/auth/github/repositories` answers with
- * `{ installationId, owner, name, status }` per repository, so the CLI can ask the same service it
- * is about to register with rather than guess. Reaching that endpoint needs the bounded capability
- * from `POST /v1/auth/github/device-authorizations`, which is bound to the Gala user and takes the
- * GitHub token the CLI already holds.
- */
-function endpoint(apiBaseUrl, path) {
-  return `${String(apiBaseUrl).replace(/\/$/, '')}${path}`;
-}
-
-export async function exchangeGithubAuthorization({
-  apiBaseUrl, galaAccessToken, githubAccessToken, fetchImpl = fetch
-}) {
-  const response = await fetchImpl(endpoint(apiBaseUrl, '/v1/auth/github/device-authorizations'), {
-    method: 'POST',
-    headers: {
-      accept: 'application/json',
-      authorization: `Bearer ${galaAccessToken}`,
-      'content-type': 'application/json'
-    },
-    body: JSON.stringify({ accessToken: githubAccessToken })
-  });
-  if (response.status === 409) {
-    // The API distinguishes "the App is not installed on this account" from "your credential is
-    // finished". Only the first is something the writer can fix in a browser, so it is signalled
-    // rather than thrown: the caller offers the installation page and waits.
-    return null;
-  }
-  if (response.status === 401) {
-    // Either credential can be the one at fault and the caller cannot tell them apart, so say so
-    // rather than printing a status code the writer has no way to interpret.
-    throw new Error(
-      'Gala refused the GitHub authorization. Run `npx --yes @rathnasgala/cli@latest auth` and '
-      + '`auth github` again, then retry.'
-    );
-  }
-  if (!response.ok) {
-    throw new Error(`GitHub authorization exchange failed with HTTP ${response.status}`);
-  }
-  const payload = await response.json();
-  if (typeof payload?.authorization !== 'string') {
-    throw new TypeError('GitHub authorization exchange returned no capability');
-  }
-  return payload.authorization;
-}
-
-export async function listAuthorizedRepositories({ apiBaseUrl, authorization, fetchImpl = fetch }) {
-  const response = await fetchImpl(endpoint(apiBaseUrl, '/v1/auth/github/repositories'), {
-    headers: { accept: 'application/json', 'GitHub-Authorization': authorization }
-  });
-  if (!response.ok) {
-    throw new Error(`Authorized repository lookup failed with HTTP ${response.status}`);
-  }
-  const payload = await response.json();
-  if (!Array.isArray(payload)) throw new TypeError('Authorized repository lookup returned no list');
-  return payload;
-}
-
-/**
- * Returns the installation covering `owner`, or null when the App is not installed there.
- *
- * An installation belongs to an account, not to one repository, so any repository the App can
- * already see under that owner carries the id the new one will use. Null is an ordinary answer —
- * it means "not installed yet" — and the caller turns it into an instruction, not an error.
- */
-export async function resolveInstallationId({
-  apiBaseUrl, galaAccessToken, githubAccessToken, owner, fetchImpl = fetch,
-  exchange = exchangeGithubAuthorization, list = listAuthorizedRepositories
-}) {
-  const authorization = await exchange({
-    apiBaseUrl, galaAccessToken, githubAccessToken, fetchImpl
-  });
-  // null means the App is not installed yet, which the caller turns into an instruction.
-  if (authorization == null) return null;
-  const repositories = await list({ apiBaseUrl, authorization, fetchImpl });
-  const wanted = String(owner).toLowerCase();
-  for (const repository of repositories) {
-    if (String(repository?.owner).toLowerCase() !== wanted) continue;
-    const installationId = Number(repository?.installationId);
-    if (Number.isSafeInteger(installationId) && installationId > 0) return installationId;
-  }
-  return null;
-}