@algolia/wizard 0.48.0 → 0.50.0

package/dist/main.js

@@ -1710,11 +1710,31 @@ async function runStep(state, index, step, appId) {
     durationMs: Date.now() - startedAt
   });
 }
-async function runWorkflow(workflow, appId, resumableState) {
+var RESUME_OPTION = "Resume";
+var START_NEW_OPTION = "Start a new one";
+async function resolveWorkflowState(workflow, appId, options) {
+  const resumed = options?.resumableState !== void 0 ? options.resumableState : await loadResumableState(workflow);
+  if (!resumed) {
+    return initWorkflowState(workflow, nowIso(), appId);
+  }
+  if (options?.skipResumePrompt) {
+    return resumed;
+  }
+  const answer = await useWizard.getState().requestUserInput({
+    prompt: "You have a previous session. Do you want to resume, or start a new one?",
+    promptType: "multipleChoice",
+    options: [RESUME_OPTION, START_NEW_OPTION]
+  });
+  if (answer === START_NEW_OPTION) {
+    await clearWorkflowState(workflow.id);
+    return initWorkflowState(workflow, nowIso(), appId);
+  }
+  return resumed;
+}
+async function runWorkflow(workflow, appId, options) {
   const store = useWizard.getState();
   try {
-    const resolved2 = resumableState !== void 0 ? resumableState : await loadResumableState(workflow);
-    const state = resolved2 ?? initWorkflowState(workflow, nowIso(), appId);
+    const state = await resolveWorkflowState(workflow, appId, options);
     ensureExecutedStepCount(state);
     store.startWorkflow(
       {
@@ -3584,7 +3604,7 @@ async function runAnalysis(mode, extraInstructions = []) {
 // package.json
 var package_default = {
   name: "@algolia/wizard",
-  version: "0.48.0",
+  version: "0.50.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {
@@ -4868,9 +4888,168 @@ var defaultWorkflow = {
   ]
 };
 
+// src/actions/playbookSteps/selectPlaybook.ts
+import { z as z32 } from "zod";
+
+// src/lib/dashboardApi/client.ts
+import "zod";
+var DASHBOARD_API_BASE_URL = `${PROXY_BASE_URL}/dashboard`;
+var DashboardApiError = class extends Error {
+  constructor(status, message) {
+    super(message);
+    this.status = status;
+    this.name = "DashboardApiError";
+  }
+  status;
+};
+async function dashboardRequest(path, schema, init) {
+  const token = getAuthToken();
+  if (!token) {
+    throw new Error("Not authenticated: no user token available");
+  }
+  const res = await proxyFetch(`${DASHBOARD_API_BASE_URL}${path}`, {
+    ...init,
+    headers: {
+      accept: "application/json",
+      authorization: `Bearer ${token}`,
+      ...init?.headers
+    }
+  });
+  if (!res.ok) {
+    throw new DashboardApiError(
+      res.status,
+      `Dashboard API responded ${res.status} for ${path}`
+    );
+  }
+  const body = await res.json();
+  return { status: res.status, data: schema.parse(body) };
+}
+
+// src/lib/dashboardApi/schemas.ts
+import { z as z31 } from "zod";
+var playbookSchema = z31.object({
+  slug: z31.string(),
+  category: z31.string().optional(),
+  title: z31.string(),
+  description: z31.string().optional()
+});
+var playbooksListSchema = z31.array(playbookSchema);
+
+// src/lib/dashboardApi/api.ts
+async function getPlaybooks() {
+  const { data } = await dashboardRequest(
+    "/api/1/playbook-integrations/playbooks",
+    playbooksListSchema
+  );
+  return data;
+}
+
+// src/actions/playbookSteps/selectPlaybook.ts
+var selectPlaybookSchema = z32.object({
+  slug: z32.string()
+});
+function persistSlug(ctx, slug) {
+  ctx.setUserInput("playbookSlug", slug);
+  return { slug };
+}
+async function selectPlaybookStep(ctx, requestedSlug) {
+  const playbooks = await getPlaybooks();
+  const slugs = playbooks.map((playbook) => playbook.slug);
+  if (slugs.length === 0) {
+    throw new Error("No playbooks are available.");
+  }
+  if (requestedSlug && slugs.includes(requestedSlug)) {
+    return persistSlug(ctx, requestedSlug);
+  }
+  const messages = requestedSlug ? [
+    `"${requestedSlug}" is not a valid playbook. Choose one of the available playbooks:`
+  ] : ["Choose a playbook:"];
+  const selection = await ctx.requestUserInput({
+    prompt: "Which playbook do you want to run?",
+    promptType: "multipleChoice",
+    options: slugs,
+    messages
+  });
+  if (typeof selection !== "string") {
+    throw new Error("selectPlaybook received an unexpected non-text result");
+  }
+  return persistSlug(ctx, selection);
+}
+
+// src/lib/cli.ts
+var USAGE = `Usage: wizard [workflow-id] [options]
+       wizard playbook [playbook-slug] [options]
+
+Options:
+  --seed <step-id> Start the workflow at the step with this id, with earlier
+                   steps pre-filled with test data. Pass with no value to print
+                   the step ids. See CONTRIBUTING.md.
+  --no-telemetry   Send no telemetry or analytics for this run.
+  --reset-on-run   Wipe this project's wizard state (run state, AI consent)
+                   before starting, so the run behaves like a first-ever
+                   run. Also drops every API key the wizard has
+                   stored in your keychain (or, where the platform has none,
+                   the encrypted file it falls back to \u2014 see CONTRIBUTING.md),
+                   for this project and any other, so later runs create new
+                   ones. Your Algolia login is not touched.
+  -h, --help       Print this message.`;
+function parseCliArgs(argv) {
+  const positionals = [];
+  let seed;
+  let telemetry = true;
+  let resetOnRun = false;
+  let help = false;
+  for (let i = 0; i < argv.length; i++) {
+    const arg = argv[i];
+    if (arg === "--seed") {
+      const next = argv[i + 1];
+      if (next !== void 0 && !next.startsWith("-")) {
+        seed = next;
+        i++;
+      } else {
+        seed = null;
+      }
+    } else if (arg.startsWith("--seed=")) {
+      seed = arg.slice("--seed=".length);
+    } else if (arg === "--no-telemetry") {
+      telemetry = false;
+    } else if (arg === "--reset-on-run") {
+      resetOnRun = true;
+    } else if (arg === "--help" || arg === "-h") {
+      help = true;
+    } else if (arg.startsWith("-")) {
+      throw new Error(`Unknown option "${arg}".`);
+    } else {
+      positionals.push(arg);
+    }
+  }
+  return { positionals, seed, telemetry, resetOnRun, help };
+}
+function getPlaybookSlugArg(argv = process.argv.slice(2)) {
+  const { positionals } = parseCliArgs(argv);
+  if (positionals[0] !== "playbook") return void 0;
+  return positionals[1];
+}
+
+// src/workflows/playbook.ts
+var playbookWorkflow = {
+  id: "playbook",
+  title: "Playbook Workflow",
+  description: "Select a playbook from the dashboard catalogue and walk through its implementation.",
+  steps: [
+    defineStep({
+      id: "select-playbook",
+      title: "Select playbook",
+      outputSchema: selectPlaybookSchema,
+      run: (ctx) => selectPlaybookStep(ctx, getPlaybookSlugArg())
+    })
+  ]
+};
+
 // src/workflows/index.ts
 var workflows = {
-  [defaultWorkflow.id]: defaultWorkflow
+  [defaultWorkflow.id]: defaultWorkflow,
+  [playbookWorkflow.id]: playbookWorkflow
 };
 function getWorkflow(id) {
   return workflows[id];
@@ -6051,6 +6230,9 @@ var search = {
     ]
   }
 };
+var selectPlaybook = {
+  slug: "orders"
+};
 var review = {
   summaryPoints: [
     "Ingested 25 generated Product records into wizard_seed_products.",
@@ -6069,6 +6251,9 @@ var SEEDS = {
     "confirm-framework": confirmFramework2,
     search,
     review
+  },
+  playbook: {
+    "select-playbook": selectPlaybook
   }
 };
 var SEED_USER_INPUTS = {
@@ -6077,6 +6262,9 @@ var SEED_USER_INPUTS = {
     confirmedEntities: confirmEntities2.confirmedEntities,
     ingestionAnalysis: confirmEntities2.ingestionAnalysis,
     implementation: "success"
+  },
+  playbook: {
+    playbookSlug: selectPlaybook.slug
   }
 };
 function formatStepList(workflow, startIndex) {
@@ -6139,7 +6327,9 @@ async function seedWorkflowState(workflow, value) {
   if (!config.aiConsent) {
     config.aiConsent = true;
     await saveConfig(config);
-    messages.push("Seed: set aiConsent in the project config (skips the consent prompt).");
+    messages.push(
+      "Seed: set aiConsent in the project config (skips the consent prompt)."
+    );
   }
   if (startIndex === 0) {
     await clearWorkflowState(workflow.id);
@@ -6165,55 +6355,6 @@ async function seedWorkflowState(workflow, value) {
   return { messages };
 }
 
-// src/lib/cli.ts
-var USAGE = `Usage: wizard [workflow-id] [options]
-
-Options:
-  --seed <step-id> Start the workflow at the step with this id, with earlier
-                   steps pre-filled with test data. Pass with no value to print
-                   the step ids. See CONTRIBUTING.md.
-  --no-telemetry   Send no telemetry or analytics for this run.
-  --reset-on-run   Wipe this project's wizard state (run state, AI consent)
-                   before starting, so the run behaves like a first-ever
-                   run. Also drops every API key the wizard has
-                   stored in your keychain (or, where the platform has none,
-                   the encrypted file it falls back to \u2014 see CONTRIBUTING.md),
-                   for this project and any other, so later runs create new
-                   ones. Your Algolia login is not touched.
-  -h, --help       Print this message.`;
-function parseCliArgs(argv) {
-  const positionals = [];
-  let seed;
-  let telemetry = true;
-  let resetOnRun = false;
-  let help = false;
-  for (let i = 0; i < argv.length; i++) {
-    const arg = argv[i];
-    if (arg === "--seed") {
-      const next = argv[i + 1];
-      if (next !== void 0 && !next.startsWith("-")) {
-        seed = next;
-        i++;
-      } else {
-        seed = null;
-      }
-    } else if (arg.startsWith("--seed=")) {
-      seed = arg.slice("--seed=".length);
-    } else if (arg === "--no-telemetry") {
-      telemetry = false;
-    } else if (arg === "--reset-on-run") {
-      resetOnRun = true;
-    } else if (arg === "--help" || arg === "-h") {
-      help = true;
-    } else if (arg.startsWith("-")) {
-      throw new Error(`Unknown option "${arg}".`);
-    } else {
-      positionals.push(arg);
-    }
-  }
-  return { positionals, seed, telemetry, resetOnRun, help };
-}
-
 // src/lib/resetState.ts
 import { readdir as readdir3, rm as rm2 } from "node:fs/promises";
 import { join as join13 } from "node:path";
@@ -6322,9 +6463,10 @@ ${formatStepList(workflow)}`);
       return 1;
     }
   }
-  return workflow;
+  return { workflow, skipResumePrompt: args.seed !== void 0 };
 }
-async function run(workflow) {
+async function run(opts) {
+  const { workflow, skipResumePrompt } = opts;
   const store = useWizard.getState();
   const instance = render(/* @__PURE__ */ jsx19(App, {}), { incrementalRendering: true });
   await store.waitForStart();
@@ -6369,7 +6511,7 @@ async function run(workflow) {
     await instance.waitUntilExit();
     process.exit(1);
   }
-  runWorkflow(workflow, app.id, resumableState);
+  runWorkflow(workflow, app.id, { skipResumePrompt, resumableState });
 }
 await requestTerminalSize();
 var started = await startup();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/wizard",
-  "version": "0.48.0",
+  "version": "0.50.0",
   "description": "Magically implement Algolia functionality in your codebase",
   "type": "module",
   "engines": {