@whooshbang/sdk 1.0.0-rc.22 → 1.0.0-rc.24

package/dist/cli/arguments.js

@@ -4,7 +4,41 @@ const SWITCHES = new Set([
     "version",
     "credential-stdin",
     "yes",
+    "free-text",
+    "no-connection",
+    "no-route",
+    "invite",
+    "no-invite",
+    "send",
+    "no-send",
+    "ask",
 ]);
+/**
+ * Short and shortened spellings, resolved here so no command ever sees one.
+ *
+ * A short form that some commands understand and others do not is worse than
+ * none: the failure is silent, because an unrecognised flag is read as a
+ * switch and the value it carried disappears. Normalising at the door means
+ * `-p` is the same argument as `--project` everywhere, including in the error
+ * messages, which always name the long form so nothing has to be memorised to
+ * recover from a mistake.
+ */
+const ALIASES = new Map([
+    ["c", "connection"],
+    ["e", "environment"],
+    ["env", "environment"],
+    ["k", "key"],
+    ["m", "mode"],
+    ["n", "name"],
+    ["p", "project"],
+    ["s", "subscriber"],
+    ["t", "text"],
+    ["w", "wait"],
+    ["y", "yes"],
+]);
+function canonical(name) {
+    return ALIASES.get(name) ?? name;
+}
 export function parseArguments(argv) {
     const words = [];
     const options = new Map();
@@ -12,13 +46,20 @@ export function parseArguments(argv) {
     const repeated = new Map();
     for (let index = 0; index < argv.length; index += 1) {
         const token = argv[index];
-        if (!token.startsWith("--")) {
+        // A single dash introduces a short form; `-` alone and a negative number
+        // are ordinary words, because both are things somebody might legitimately
+        // pass as a value.
+        const short = token.length > 1 &&
+            token.startsWith("-") &&
+            !token.startsWith("--") &&
+            !/^-\d/u.test(token);
+        if (!token.startsWith("--") && !short) {
             words.push(token);
             continue;
         }
-        const body = token.slice(2);
+        const body = short ? token.slice(1) : token.slice(2);
         const equals = body.indexOf("=");
-        const name = equals === -1 ? body : body.slice(0, equals);
+        const name = canonical(equals === -1 ? body : body.slice(0, equals));
         if (equals !== -1) {
             const value = body.slice(equals + 1);
             options.set(name, value);
@@ -30,7 +71,7 @@ export function parseArguments(argv) {
             continue;
         }
         const next = argv[index + 1];
-        if (next === undefined || next.startsWith("--")) {
+        if (next === undefined || next.startsWith("-")) {
             // A bare unknown flag is a switch rather than an error: the command
             // decides what it does and does not understand, and it can say so in its
             // own words.

package/dist/cli/arguments.js.map

@@ -1 +1 @@
-{"version":3,"file":"arguments.js","sourceRoot":"","sources":["../../src/cli/arguments.ts"],"names":[],"mappings":"AAkBA,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC;IACvB,MAAM;IACN,MAAM;IACN,SAAS;IACT,kBAAkB;IAClB,KAAK;CACN,CAAC,CAAC;AAEH,MAAM,UAAU,cAAc,CAAC,IAAuB;IACpD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAoB,CAAC;IAE7C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAW,CAAC;QACpC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClB,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAC1D,IAAI,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;YAClB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACrC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACzB,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;YAC3D,SAAS;QACX,CAAC;QACD,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACnB,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,oEAAoE;YACpE,yEAAyE;YACzE,aAAa;YACb,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACnB,SAAS;QACX,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACxB,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1D,KAAK,IAAI,CAAC,CAAC;IACb,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAChD,CAAC;AAED,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,UAAU,QAAQ,CACtB,MAAuB,EACvB,IAAY,EACZ,IAAY;IAEZ,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACvC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,UAAU,CAAC,KAAK,IAAI,iBAAiB,IAAI,GAAG,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}
+{"version":3,"file":"arguments.js","sourceRoot":"","sources":["../../src/cli/arguments.ts"],"names":[],"mappings":"AAkBA,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC;IACvB,MAAM;IACN,MAAM;IACN,SAAS;IACT,kBAAkB;IAClB,KAAK;IACL,WAAW;IACX,eAAe;IACf,UAAU;IACV,QAAQ;IACR,WAAW;IACX,MAAM;IACN,SAAS;IACT,KAAK;CACN,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,OAAO,GAAgC,IAAI,GAAG,CAAC;IACnD,CAAC,GAAG,EAAE,YAAY,CAAC;IACnB,CAAC,GAAG,EAAE,aAAa,CAAC;IACpB,CAAC,KAAK,EAAE,aAAa,CAAC;IACtB,CAAC,GAAG,EAAE,KAAK,CAAC;IACZ,CAAC,GAAG,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,SAAS,CAAC;IAChB,CAAC,GAAG,EAAE,YAAY,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,KAAK,CAAC;CACb,CAAC,CAAC;AAEH,SAAS,SAAS,CAAC,IAAY;IAC7B,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAuB;IACpD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IACnC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAoB,CAAC;IAE7C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAW,CAAC;QACpC,yEAAyE;QACzE,0EAA0E;QAC1E,mBAAmB;QACnB,MAAM,KAAK,GACT,KAAK,CAAC,MAAM,GAAG,CAAC;YAChB,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;YACrB,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;YACvB,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACtC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClB,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QACrE,IAAI,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;YAClB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACrC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACzB,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;YAC3D,SAAS;QACX,CAAC;QACD,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACnB,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/C,oEAAoE;YACpE,yEAAyE;YACzE,aAAa;YACb,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACnB,SAAS;QACX,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACxB,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1D,KAAK,IAAI,CAAC,CAAC;IACb,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAChD,CAAC;AAED,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,UAAU,QAAQ,CACtB,MAAuB,EACvB,IAAY,EACZ,IAAY;IAEZ,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACvC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,UAAU,CAAC,KAAK,IAAI,iBAAiB,IAAI,GAAG,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/cli/commands.d.ts

@@ -1,3 +1,5 @@
+import type { ConfirmInteractionRequest, InputInteractionRequest, InteractionSummary, SelectInteractionRequest } from "@whooshbang/contracts";
+import type { WhooshBangClient } from "../client.js";
 import { type ParsedArguments } from "./arguments.js";
 import { type Writer } from "./output.js";
 import { resolveOrigin } from "./session.js";
@@ -8,7 +10,63 @@ export interface CommandContext {
     readonly openUrl: (url: string) => Promise<void>;
     readonly readStdin: () => Promise<string>;
     readonly credentialsFile?: string;
+    readonly contextFile?: string;
+    /** Asks a question when there is a person to ask. Absent means non-interactive. */
+    readonly prompt?: (question: string, fallback?: string) => Promise<string>;
 }
+declare const CONNECTION_MODES: readonly ["whooshbang_shared", "customer_managed", "customer_byok"];
+/**
+ * Builds the question from what was asked for.
+ *
+ * Choices mean a single-select, `--free-text` means a typed reply, and a
+ * question with neither is a yes/no confirm — which is what most first
+ * questions are, and what someone following a quickstart gets for free.
+ */
+export declare function askedInteraction(parsed: ParsedArguments): ConfirmInteractionRequest | SelectInteractionRequest | InputInteractionRequest;
+/**
+ * Waits for the question to reach a state that can no longer change.
+ *
+ * One request cannot wait longer than the service's own poll ceiling, so a
+ * longer wait is consecutive polls against a deadline. Each one returns the
+ * moment the answer lands, so this costs the wait it was given and no more.
+ */
+export interface EnvironmentScope {
+    readonly environmentId: string;
+    readonly projectId: string;
+}
+export declare function untilAnswered(api: WhooshBangClient, scope: EnvironmentScope | null, interactionId: string, waitFor: number): Promise<InteractionSummary>;
+export declare function describeInteraction(summary: InteractionSummary, where: string): string[];
+/**
+ * Asks for something that was not given, when there is somebody to ask.
+ *
+ * Every question is also an argument. Supply them all and nothing is asked, so
+ * the same command works unchanged in a script — which is the rule that keeps
+ * a guided path from quietly becoming a second, divergent product.
+ *
+ * With no terminal attached there is nobody to answer, so this refuses in the
+ * same words the argument would have: a cron job should be told which flag it
+ * forgot, not left waiting on a prompt nothing will ever read.
+ */
+export declare function ask(context: CommandContext, question: string, option: string, fallback?: string): Promise<string>;
+/**
+ * A yes-or-no step that can be answered in advance.
+ *
+ * `--invite` and `--no-invite` decide it without asking, which is what lets
+ * `wb init` run in a script. With no terminal and no flag the answer is no:
+ * an unattended run should do less rather than guess.
+ */
+export declare function confirmed(context: CommandContext, option: string, question: string): Promise<boolean>;
+/** What to call a connection nobody bothered to name. */
+export declare function defaultConnectionName(mode: (typeof CONNECTION_MODES)[number]): string;
+/**
+ * The shared identity to connect through, chosen rather than demanded.
+ *
+ * A provider offering exactly one is not a choice, and making somebody run a
+ * lookup command to copy an opaque id out of it was the single largest piece of
+ * the getting-started path. When there is more than one the choice is real, so
+ * it is named along with what the alternatives are.
+ */
+export declare function sharedIdentityFor(api: WhooshBangClient, projectId: string, environmentId: string, parsed: ParsedArguments): Promise<string>;
 /**
  * Words left over once the command itself is accounted for.
  *