@greatwait/cli 0.1.0-alpha.5 → 0.1.0-alpha.7

package/dist/operate.js

@@ -1,10 +1,11 @@
-import { billingAutoTopUpApplyRequestSchema, billingAutoTopUpPreviewRequestSchema, billingAutoTopUpPreviewSchema, billingCeilingUpdateRequestSchema, billingFundingQuoteRequestSchema, billingFundingQuoteSchema, billingNotificationSettingsUpdateRequestSchema, billingRefundRequestCreateSchema, billingRefundResolutionRequestSchema, projectBillingQuoteSchema, projectBillingQuoteRequestSchema, } from "@greatwait/contracts";
+import { writeFile } from "node:fs/promises";
+import { autoPauseAfterFailuresSchema, httpRequestSchema, sanitizedDiagnosticText, diagnosticBodyText, responseBodySentence, requestCaptureSentence, attemptStatusGuidance, endpointHeaderChangesSchema, billingAutoTopUpApplyRequestSchema, billingAutoTopUpPreviewRequestSchema, billingAutoTopUpPreviewSchema, billingCeilingUpdateRequestSchema, billingFundingQuoteRequestSchema, billingFundingQuoteSchema, billingNotificationSettingsUpdateRequestSchema, billingRefundRequestCreateSchema, billingRefundResolutionRequestSchema, projectBillingQuoteSchema, projectBillingQuoteRequestSchema, } from "@greatwait/contracts";
 import { parseDuration } from "./args.js";
 import { confirmChange } from "./confirm.js";
 import { redactSecret } from "./output.js";
 import { CliError } from "./runtime.js";
 import { openSession } from "./session.js";
-import { apiUrlOption, conditionalHeaders, continuationNote, drainPages, freshnessNote, pageRequest, parseInstant, parseResponse, positionals, readJsonOption, table, } from "./support.js";
+import { apiUrlOption, conditionalHeaders, continuationNote, drainPages, freshnessNote, pageRequest, parseInstant, parseResponse, positionals, readJsonOption, readPrivateJsonOption, table, } from "./support.js";
 /* -------------------------------------------------------------------------- */
 /* Shared plumbing                                                            */
 /* -------------------------------------------------------------------------- */
@@ -102,18 +103,85 @@ async function scheduleRequest(runtime, args, usage) {
                 ? { everySeconds: parseDuration(value) }
                 : { cron: value };
     const endpoint = args.options["--endpoint"];
+    const url = args.options["--url"];
+    if (endpoint !== undefined && url !== undefined) {
+        // Refused here as well as by the service, because "you gave both" is a
+        // sentence about the line somebody typed. The service's own refusal says
+        // the same thing a round trip later.
+        throw new CliError("give --endpoint or --url, not both", "usage", "--url uses this project's destination at that address, or creates one. --endpoint names a destination that already exists.");
+    }
     const data = await readJsonOption(runtime, "--data", args.options["--data"]);
+    const httpInput = await readPrivateJsonOption(runtime, "--http", args.options["--http"]);
+    const http = httpInput === undefined
+        ? undefined
+        : httpRequestSchema.safeParse(httpInput);
+    if (http !== undefined && !http.success)
+        throw new CliError("--http settings are invalid", "usage", http.error.issues.map((issue) => issue.message).join("; "));
+    const pauseInput = args.options["--auto-pause-after-failures"];
+    const pause = pauseInput === undefined
+        ? undefined
+        : autoPauseAfterFailuresSchema.safeParse(pauseInput === "never" ? pauseInput : Number(pauseInput));
+    if (pause !== undefined && !pause.success)
+        throw new CliError('--auto-pause-after-failures must be a whole number from 1 to 100, or "never"', "usage");
     const latencyClass = args.options["--latency-class"];
     const partitionKey = args.options["--partition-key"];
     return {
         ...(data === undefined ? {} : { data }),
+        ...(http?.success ? { http: http.data } : {}),
         ...(endpoint === undefined ? {} : { endpoint }),
+        ...(url === undefined ? {} : { url }),
         ...(latencyClass === undefined ? {} : { latencyClass }),
+        ...(pause?.success ? { autoPauseAfterFailures: pause.data } : {}),
         ...(partitionKey === undefined ? {} : { partitionKey }),
         ...(timeZone === undefined ? {} : { timeZone }),
         ...recurrence,
     };
 }
+/**
+ * Where a schedule written with `--url` delivers, and where its signing
+ * secret is.
+ *
+ * **Only the API's notice, never a secret.** A schedule write that names a
+ * `url` answers with `endpointSigningSecret` — `returned: false` and the
+ * dashboard page where a member reveals the secret — and nothing else about
+ * it, so there is nothing here that could print one. Absent when the write
+ * named `--endpoint`: that caller already holds the destination it chose.
+ */
+export function destinationLines(schedule, notice, 
+/**
+ * The `--url` that was sent. A schedule write answers without
+ * `endpointUrl` (only reads carry it), and the address is the one the
+ * destination was found or made at.
+ */
+requestedUrl) {
+    if (notice === undefined)
+        return [];
+    const address = schedule.endpointUrl ?? canonical(requestedUrl);
+    return [
+        ...(schedule.endpoint === undefined
+            ? []
+            : [
+                `Destination  ${schedule.endpoint}${address === undefined ? "" : ` at ${address}`}`,
+            ]),
+        ``,
+        `GreatWait signs every call to this address. Your receiver checks the`,
+        `signature with the destination's signing secret, which isn't shown here.`,
+        notice.revealUrl === undefined
+            ? `A project member can reveal it on the destination's page in the dashboard.`
+            : `Reveal it on the destination's page: ${notice.revealUrl}`,
+    ];
+}
+/** An address as the service stores it, or as typed if it will not parse. */
+function canonical(url) {
+    if (url === undefined)
+        return undefined;
+    try {
+        return new URL(url).href;
+    }
+    catch {
+        return url;
+    }
+}
 /** How a schedule's recurrence reads in one column. */
 function recurrenceOf(schedule) {
     return schedule.recurrence.kind;
@@ -176,6 +244,12 @@ const destinationsUpdate = async (runtime, args) => {
     if (url === undefined) {
         throw new CliError(`${runtime.programName} destinations update needs --url`, "usage", `Usage: ${runtime.programName} destinations update <destination> --url https://your-receiver.example.com/greatwait`);
     }
+    const headerInput = await readPrivateJsonOption(runtime, "--headers", args.options["--headers"]);
+    const headers = headerInput === undefined
+        ? undefined
+        : endpointHeaderChangesSchema.safeParse(headerInput);
+    if (headers !== undefined && !headers.success)
+        throw new CliError("--headers settings are invalid", "usage", headers.error.issues.map((issue) => issue.message).join("; "));
     const active = await session(runtime, args);
     // Read first, so the preview is the destination as it stands rather than the
     // arguments read back.
@@ -188,7 +262,7 @@ const destinationsUpdate = async (runtime, args) => {
             `Deliveries in flight keep going to the receiver they started for.`,
         ],
     });
-    const updated = parseResponse("endpoints.update", await active.client.request("endpoints_update", id, { url }, conditionalHeaders(args)));
+    const updated = parseResponse("endpoints.update", await active.client.request("endpoints_update", id, { url, ...(headers?.success ? { headers: headers.data } : {}) }, conditionalHeaders(args)));
     return {
         data: { confirmation, endpoint: updated },
         human: endpointBlock(updated).join("\n"),
@@ -279,6 +353,9 @@ async function scheduleChange(runtime, args, options) {
     return {
         data: {
             ...(confirmation === undefined ? {} : { confirmation }),
+            ...(view.endpointSigningSecret === undefined
+                ? {}
+                : { endpointSigningSecret: view.endpointSigningSecret }),
             ...(view.occurrence === undefined ? {} : { occurrence: view.occurrence }),
             schedule: view.schedule,
         },
@@ -292,12 +369,13 @@ async function scheduleChange(runtime, args, options) {
                 : [
                     `Next         ${view.occurrence.id} planned for ${view.occurrence.plannedFor} (${view.occurrence.state})`,
                 ]),
+            ...destinationLines(view.schedule, view.endpointSigningSecret, args.options["--url"]),
         ].join("\n"),
         ...(nextMove === undefined ? {} : { nextMove }),
     };
 }
 const schedulesReplace = async (runtime, args) => {
-    const usage = `${runtime.programName} schedules replace <schedule> --endpoint <destination> (--in <duration> | --at <instant> | --every <duration> | --cron <expression>)`;
+    const usage = `${runtime.programName} schedules replace <schedule> (--endpoint <destination> | --url <https url>) (--in <duration> | --at <instant> | --every <duration> | --cron <expression>)`;
     const [id] = positionals(args, ["<schedule>"], usage);
     const request = await scheduleRequest(runtime, args, usage);
     return scheduleChange(runtime, args, {
@@ -306,7 +384,8 @@ const schedulesReplace = async (runtime, args) => {
             action: `Replace the definition of schedule ${current.id}.`,
             effect: [
                 `now      ${recurrenceOf(current)}, ${current.status}, version ${String(current.version)}`,
-                `after    the definition on this command line, and nothing of the old one`,
+                `after    the timing on this command line. Destination, data and HTTP`,
+                `         settings are kept unless this command line gives new ones.`,
                 `Occurrences already planned under the old definition are discarded.`,
             ],
         }),
@@ -423,9 +502,52 @@ const attemptsRead = async (runtime, args) => {
     const active = await session(runtime, args);
     const view = parseResponse("attempts.read", await active.client.request("attempts_read", schedule, occurrence, attempt));
     const found = view.attempt;
+    const responseFile = args.options["--response-file"];
+    if (responseFile !== undefined) {
+        if (found.response?.body === undefined)
+            throw new CliError(responseBodySentence(found.response?.bodyState ?? "not_captured", found.responseStatus === undefined), "validation");
+        const body = found.response.body;
+        try {
+            await writeFile(responseFile, body.encoding === "base64"
+                ? Buffer.from(body.content, "base64")
+                : Buffer.from(body.content, "utf8"), { mode: 0o600, flag: "wx" });
+        }
+        catch {
+            throw new CliError("The response file could not be created. Choose a path that does not already exist.", "usage");
+        }
+    }
+    const diagnosticLines = [];
+    if (found.response !== undefined) {
+        const response = found.response;
+        diagnosticLines.push(`Server response ${String(found.responseStatus ?? "")} ${response.statusText}`, ...response.headers.map((h) => `${h.name}: ${h.value}`));
+        if (response.body === undefined)
+            diagnosticLines.push(responseBodySentence(response.bodyState, found.responseStatus === undefined));
+        else {
+            const body = response.body;
+            if (body.incomplete)
+                diagnosticLines.push("The response stream stopped during capture; this is a partial answer.");
+            if (body.truncated)
+                diagnosticLines.push(`Response cut at 10 KiB (10,240 bytes)${body.originalBytes === undefined ? "" : `; original length ${String(body.originalBytes)} bytes`}.`);
+            diagnosticLines.push(diagnosticBodyText(body) !== undefined
+                ? diagnosticBodyText(body)
+                : `Binary response (${String(body.capturedBytes)} bytes). Download with --response-file <path>.`);
+        }
+    }
+    diagnosticLines.push("What we sent");
+    if (found.request === undefined)
+        diagnosticLines.push(requestCaptureSentence(found.requestState, found.state === undefined));
+    else
+        diagnosticLines.push(`${found.request.method} ${found.request.url}`, ...found.request.headers.map((h) => `${h.name}: ${h.value}`), found.request.body === "" ? "We sent no body." : found.request.body);
+    const guidance = attemptStatusGuidance(found.responseStatus);
+    if (guidance !== undefined)
+        diagnosticLines.push(guidance);
     return {
         data: { attempt: found, freshness: freshnessOf(view) },
         human: [
+            ...diagnosticLines.map(sanitizedDiagnosticText),
+            ...(responseFile === undefined
+                ? []
+                : [`Response saved to ${sanitizedDiagnosticText(responseFile)}`]),
             `Attempt      ${found.id}`,
             `Number       ${String(found.attemptNumber)}`,
             ...(found.state === undefined ? [] : [`State        ${found.state}`]),
@@ -1387,7 +1509,9 @@ const sinksCreate = async (runtime, args) => {
     const program = await readJsonOption(runtime, "--program", args.options["--program"]);
     const sink = parseResponse("testsinks.create", await active.client.request("testsinks_create", {
         endpoint,
-        ...(program === undefined ? {} : { program }),
+        // The program is passed as typed and validated by the service, which
+        // names the field it refuses; the client's type cannot know it yet.
+        ...(program === undefined ? {} : { program: program }),
     }));
     return {
         data: { sink },

package/dist/remediation.d.ts

@@ -30,6 +30,6 @@ export declare function remediationFor(problem: Problem | undefined, retryable:
  * A case asserting what the advice *says* wants one spelling; a case asserting
  * that it follows the invoked name passes its own.
  */
-export declare const REMEDIATION: Readonly<Record<"invalid_request" | "not_found" | "state_conflict" | "version_conflict" | "authentication_required" | "billing_not_ready" | "capability_not_configured" | "credential_expired" | "credential_revoked" | "idempotency_key_reused" | "payload_too_large" | "plan_limit_reached" | "project_archived" | "rate_limited" | "revision_conflict" | "scope_missing" | "service_unavailable" | "test_to_live_escalation", string>>;
+export declare const REMEDIATION: Readonly<Record<"authentication_required" | "billing_not_ready" | "capability_not_configured" | "credential_expired" | "credential_revoked" | "idempotency_key_reused" | "invalid_request" | "not_found" | "payload_too_large" | "plan_limit_reached" | "project_archived" | "rate_limited" | "revision_conflict" | "scope_missing" | "service_unavailable" | "state_conflict" | "test_to_live_escalation" | "version_conflict", string>>;
 /** Exposed so a case can assert the records cover the published vocabularies. */
 export { isRetryable, remediationTable };

package/dist/support.d.ts

@@ -31,6 +31,8 @@ export declare function expectNoExtraArguments(args: ParsedArguments, used: numb
  * "unexpected argument" rule is applied from the same count.
  */
 export declare function positionals(args: ParsedArguments, names: readonly string[], usage: string): readonly string[];
+/** Secret-bearing option documents are accepted through files/stdin only. */
+export declare function readPrivateJsonOption(runtime: CliRuntime, flag: string, value: string | undefined): Promise<unknown>;
 /** The payload, from an argument, a file, or standard input. */
 export declare function readJsonOption(runtime: CliRuntime, flag: string, value: string | undefined): Promise<unknown>;
 /**

package/dist/support.js

@@ -76,6 +76,13 @@ export function positionals(args, names, usage) {
     expectNoExtraArguments(args, names.length, usage);
     return found;
 }
+/** Secret-bearing option documents are accepted through files/stdin only. */
+export async function readPrivateJsonOption(runtime, flag, value) {
+    if (value !== undefined && value !== "-" && !value.startsWith("@")) {
+        throw new CliError(`${flag} must be @file.json or -`, "usage", "Read secret-bearing settings from a private file or standard input, never a command-line argument.");
+    }
+    return readJsonOption(runtime, flag, value);
+}
 /** The payload, from an argument, a file, or standard input. */
 export async function readJsonOption(runtime, flag, value) {
     if (value === undefined)

package/package.json

@@ -7,8 +7,8 @@
     "url": "https://github.com/flowxo/greatwait/issues"
   },
   "dependencies": {
-    "@greatwait/api-client": "0.1.0-alpha.5",
-    "@greatwait/contracts": "0.1.0-alpha.5"
+    "@greatwait/api-client": "0.1.0-alpha.7",
+    "@greatwait/contracts": "0.1.0-alpha.7"
   },
   "description": "The GreatWait command line: sign in, create a destination and a one-shot schedule, and wait for the callback, over the public API.",
   "engines": {
@@ -48,5 +48,5 @@
   },
   "sideEffects": false,
   "type": "module",
-  "version": "0.1.0-alpha.5"
+  "version": "0.1.0-alpha.7"
 }