ninepm 0.83.0 → 0.87.0

package/README.md

@@ -269,9 +269,35 @@ another service's certificate check uses `_acme-challenge`) is not ours, so leav
 that sends no such list it prints no deletion advice at all. When the removal is still finishing
 upstream (the API answers `202` with `releasing: true`), it says so, names no record to delete, and
 prints the `9pm domains list` command: once the domain is no longer listed, it has stopped serving
-from 9pm. A removal that finishes in the background returns no record list, so the CLI cannot say
-which DNS records to delete for it. Such a domain shows as `removing`
-in `list` and `status` (`"removing": true` in `--json`), and `wait` on it exits `20`. Since 0.80.0.
+from 9pm. Such a domain shows as `removing` in `list` and `status` (`"removing": true` in `--json`),
+and `wait` on it exits `20`. Since 0.80.0.
+
+Since 0.86.0, a removal that finished (from `remove` or `9pm delete`) also says that after removal,
+visitors may see a TLS or routing error while the domain's DNS still points at 9pm. It names no
+record and adds no deletion advice of its own: what may be deleted is only the cleanup list printed
+above it, each record only if its value still matches. A removal still finishing gets no such line,
+since it is told to leave its records in place. A server that sends no cleanup list still gets it.
+
+Since 0.87.0, that line is followed by the order the staging rehearsal (#2182) demonstrated for a
+move to another host: point DNS at the new host, wait for the DNS TTL to pass, then remove the domain
+from 9pm. While caches update, some visitors may still reach 9pm or briefly see an error from the new
+host, and once DNS points away 9pm may show the domain as failed, which is expected. It links the
+custom-domain guide's "Moving a domain off 9pm" section on the site beside the control plane it
+talked to (staging's guide for `--api-url https://api-staging.9pm.ai`). A move to your own Cloudflare
+DNS zone was not rehearsed, so no order is printed for it; the guide says to contact support first.
+
+Since 0.84.0, `9pm domains removed [--owner <organisation>]` lists the DNS records you may delete
+after a removal that finished in the background: a `remove` that answered `releasing`, or a domain of
+a deleted app, finished later by the platform. It is the same list `remove` prints when it finishes
+itself, under the same rule (delete a record only while it still has the value shown), and the
+printed hint after a still-finishing removal or `9pm delete` points at it, with `--owner` and
+`--api-url` kept. A removal is listed for 30 days after it finishes, only to the account that owned
+the domain, and not at all once the hostname has been added again anywhere: the server checks the
+certificate provider for it when you run the command, and a domain it couldn't check is named without
+its records, with the command to ask about it again. The server checks ten domains per page; the
+command reads up to 20 pages and says so if more remain. `--hostname <hostname>` asks about one
+domain only. `--json` prints the API's answer with its pages merged (`next` is null once every page
+was read). Against a server without the route it says it can't list any, prints no record and exits `1`.
 
 Since 0.83.0, `9pm domains cleanup <app> <hostname>` lists the setup TXT records 9pm issued for a
 live domain and no longer needs, such as an earlier `_acme-challenge` value or the
@@ -332,6 +358,7 @@ and none can be listed for it later.
 9pm domains restart <app> <hostname>          # only after a certificate failed; record values may change
 9pm domains remove <app> <hostname> --confirm <hostname> [--json]
 9pm domains move [<app>] <hostname> --to <app> [--json]
+9pm domains removed [--hostname <hostname>] [--owner <organisation>] [--json]   # records to delete after a removal that finished in the background
 9pm access show <site>
 9pm access public <site> [--switch-mode]
 9pm access otp <site> [--switch-mode]

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 import { Agent } from "undici";
+import { type ProjectQrAddress } from "./qr-code.js";
 import { type DomainNext, type DomainReason, type DomainRecordStatus, type DomainState, type DomainStateDnsCheck, type DomainStateDnsInstruction, type DomainStateInput } from "./domain-state.js";
 import type { AccessGrant, AccessGrantType, AccessProviderKey, AppAccessSettings, AppAccessServiceToken, AppAccessToken, AppDatabase, AppRuntime, AppUserFilesUsage, ContainerImageUploadInstruction, ContainerRegion, Deployment, ManagedFileObject, ManagedFileShare, ManagedFileUsage, Project } from "./cli-types.js";
 export interface DeployOptions {
@@ -122,7 +123,7 @@ export interface DeletedSiteResult {
     metadata: boolean;
     errors?: string[];
 }
-export declare function deletedDomainLines(deleted: Pick<DeletedSiteResult, "customDomainCleanup" | "customDomainsReleasing">): string[];
+export declare function deletedDomainLines(deleted: Pick<DeletedSiteResult, "customDomainCleanup" | "customDomainsReleasing" | "customDomainNames">, options?: DomainFormatOptions): string[];
 export interface CreatedRuntimeToken {
     token: string;
     appAccessToken: AppAccessToken;
@@ -132,7 +133,7 @@ export interface CreatedServiceToken {
     clientSecret: string;
 }
 export type FetchLike = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
-export declare const CLI_VERSION = "0.83.0";
+export declare const CLI_VERSION = "0.87.0";
 type CredentialBackend = "macos-keychain" | "windows-dpapi" | "linux-secret-service" | "file-plaintext" | "none";
 export interface StoredCredentialEntry {
     token: string;
@@ -532,6 +533,7 @@ type CliCommand = {
     confirmSlug: string;
     apiUrl: string;
     token: string;
+    apiUrlFrom?: ApiUrlSource;
 } | {
     kind: "apps";
     apiUrl: string;
@@ -628,6 +630,17 @@ type CliCommand = {
     };
     apiUrl: string;
     token: string;
+} | {
+    kind: "qr";
+    site: string;
+    owner?: string;
+    address?: string;
+    format: "svg" | "png";
+    out?: string;
+    terminal: boolean;
+    json: boolean;
+    apiUrl: string;
+    token: string;
 } | {
     kind: "domains";
     owner?: string;
@@ -668,6 +681,10 @@ type CliCommand = {
         hostname: string;
         to: string;
         json: boolean;
+    } | {
+        kind: "removed";
+        json: boolean;
+        hostname?: string;
     };
     apiUrl: string;
     token: string;
@@ -880,7 +897,21 @@ export declare function getDomainSetupCleanup(options: DomainCommandOptions & {
 }): Promise<unknown>;
 export declare function domainSetupCleanupLines(body: unknown, hostname: string): string[];
 export declare function setupCleanupLines(hostname: string, records: DomainCleanupRecord[]): string[];
+export declare function customDomainMoveOffGuideUrl(options?: DomainFormatOptions): string;
+export declare function domainRemovedConsequenceLines(hostnames: string[], options?: DomainFormatOptions): string[];
 export declare function domainRemovalPendingLines(hostname: string, app: string, options: DomainFormatOptions): string[];
+export declare const FINISHED_REMOVAL_PAGES_PER_COMMAND = 20;
+export declare function getFinishedDomainRemovals(options: ApiOptions & {
+    owner?: string;
+    hostname?: string;
+}): Promise<unknown>;
+export interface FinishedDomainRemoval {
+    hostname: string;
+    finishedAt: string | null;
+    cleanup: DomainCleanup;
+}
+export declare function parseFinishedDomainRemovals(body: unknown): FinishedDomainRemoval[] | null;
+export declare function finishedDomainRemovalLines(body: unknown, options?: DomainFormatOptions): string[];
 export interface DomainMove {
     body: unknown;
     hostname: string;
@@ -923,6 +954,23 @@ export declare function waitForDomain(options: DomainCommandOptions & {
     onRetry?: (error: unknown) => void;
 }): Promise<DomainWaitResult>;
 export declare function healthWithReason(status: string | null | undefined, reason: string | null | undefined): string;
+export declare const QR_PNG_PIXELS_PER_MODULE = 16;
+/**
+ * The minimum width in centimetres, rounded UP to the millimetre: it is a floor, so rounding
+ * to nearest would print a 26.5 mm minimum as "2.6 cm", below what the code needs.
+ */
+export declare function qrMinimumWidthCmText(minimumWidthMm: number): string;
+export declare const QR_ACCESS_NOTE = "This app is private. Scanning the code doesn't grant access: people still have to sign in and be allowed in.";
+export declare function qrCustomDomainNote(hostname: string): string;
+/**
+ * The returned address `--address` names, or an error listing the valid ones. The value is
+ * normalized first - a bare hostname gets `https://`, case is ignored, a trailing `/` is
+ * allowed - and must then match an address the server offered: no other host, path, query,
+ * fragment, credentials, port or scheme. The CLI never encodes a URL the server did not offer.
+ */
+export declare function pickQrAddress(addresses: readonly ProjectQrAddress[], requested: string | undefined): ProjectQrAddress;
+/** An 8-bit greyscale PNG of a module matrix (quiet zone included), black on white. */
+export declare function encodeQrPng(modules: readonly (readonly boolean[])[], scale?: number): Buffer;
 export type ApiUrlSource = "flag" | "env" | "default";
 export declare function workerPublicFiles(paths: readonly string[], serverEntry: string, selection: string | null): Array<{
     path: string;