@algolia/wizard 0.84.0 → 0.86.0

package/dist/main.js

@@ -1208,6 +1208,7 @@ function SelectPrompt({
   helpText,
   messages,
   table,
+  list,
   error,
   multi,
   cancelable,
@@ -1290,6 +1291,20 @@ function SelectPrompt({
       error && /* @__PURE__ */ jsx8(Text10, { color: COLORS.danger, children: error }),
       messages?.map((m, i) => /* @__PURE__ */ jsx8(Text10, { color: COLORS.muted, children: m }, `msg-${i}`)),
       table && /* @__PURE__ */ jsx8(Table, { columns: table.columns, rows: table.rows }),
+      list && list.length > 0 && /* @__PURE__ */ jsx8(Box9, { flexDirection: "column", children: list.map((item, i) => /* @__PURE__ */ jsxs9(Text10, { children: [
+        /* @__PURE__ */ jsx8(
+          Text10,
+          {
+            color: item.color === "success" ? COLORS.success : COLORS.danger,
+            children: item.color === "success" ? "\u2713 " : "\u25CF "
+          }
+        ),
+        /* @__PURE__ */ jsx8(Text10, { color: COLORS.primary, children: item.label }),
+        item.helpText ? /* @__PURE__ */ jsxs9(Text10, { color: COLORS.muted, children: [
+          " ",
+          item.helpText
+        ] }) : null
+      ] }, `list-${i}`)) }),
       /* @__PURE__ */ jsxs9(Box9, { flexDirection: "column", children: [
         question && /* @__PURE__ */ jsx8(Text10, { color: COLORS.muted, children: question }),
         helpText && /* @__PURE__ */ jsx8(Text10, { color: COLORS.dim, children: helpText })
@@ -1389,6 +1404,7 @@ function PromptInput() {
         helpText: inputReq.helpText,
         messages: inputReq.messages,
         table: inputReq.table,
+        list: inputReq.list,
         options: inputReq.options,
         secondary: inputReq.secondary,
         disabled: inputReq.disabled,
@@ -1409,6 +1425,7 @@ function PromptInput() {
         helpText: inputReq.helpText,
         messages: inputReq.messages,
         table: inputReq.table,
+        list: inputReq.list,
         options: inputReq.options,
         error: inputReq.error,
         onSelect: handleSubmit
@@ -2315,7 +2332,7 @@ async function ensureApplication(resumeAppId) {
 // package.json
 var package_default = {
   name: "@algolia/wizard",
-  version: "0.84.0",
+  version: "0.86.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {
@@ -7352,9 +7369,6 @@ var defaultWorkflow = {
   ]
 };
 
-// src/workflows/playbook.ts
-import "zod";
-
 // src/actions/playbookSteps/selectPlaybook.ts
 import { z as z33 } from "zod";
 
@@ -7517,11 +7531,12 @@ async function getPlaybookExecution(uuid) {
   return data;
 }
 async function assessPlaybookExecution(uuid) {
-  await dashboardRequest(
+  const { data } = await dashboardRequest(
     `/api/1/playbook-integrations/playbooks/executions/${uuid}/assess`,
-    messageResponseSchema,
+    playbookExecutionSchema,
     { method: "POST" }
   );
+  return data;
 }
 
 // src/actions/playbookSteps/selectPlaybook.ts
@@ -7704,13 +7719,107 @@ async function confirmIndexStep(ctx) {
   }
 }
 
-// src/actions/playbookSteps/dataAssessment.ts
+// src/actions/playbookSteps/dataAssessmentPrompts.ts
 var CONTINUE_EXECUTION_OPTION = "Continue";
 var RESTART_OPTION = "Restart";
 var GO_BACK_OPTION3 = "Go back";
 var SWITCH_APPLICATION_OPTION = "Switch application";
 var SWITCH_INDEX_OPTION = "Switch index";
 var RETRY_OPTION = "Retry";
+var RETRY_ASSESSMENT_OPTION = "Retry assessment";
+var promptResumeExecution = async (ctx, indexName) => {
+  const choice = await ctx.requestUserInput({
+    prompt: `${indexName} has a playbook in progress.`,
+    promptType: "multipleChoice",
+    options: [CONTINUE_EXECUTION_OPTION, RESTART_OPTION, GO_BACK_OPTION3],
+    secondary: [{ kind: "text", value: "resume Assessment" }]
+  });
+  if (typeof choice !== "string") {
+    throw new Error("data-assessment received an unexpected execution choice");
+  }
+  return choice;
+};
+var promptAssessmentRecovery = async (ctx, message, retryDisabled) => {
+  const choice = await ctx.requestUserInput({
+    prompt: "Data assessment failed.",
+    promptType: "multipleChoice",
+    options: [SWITCH_APPLICATION_OPTION, SWITCH_INDEX_OPTION, RETRY_OPTION],
+    messages: [message],
+    disabled: [false, false, retryDisabled],
+    helpText: "Retry re-runs assessment on this index. Switch index or application to pick a different target."
+  });
+  if (choice === SWITCH_APPLICATION_OPTION) {
+    return ctx.changeApplication();
+  }
+  if (choice === SWITCH_INDEX_OPTION) {
+    return ctx.returnToStep("select-index");
+  }
+  if (choice === RETRY_OPTION) {
+    return;
+  }
+  throw new Error("data-assessment received an unexpected recovery choice");
+};
+var promptNotReady = async (ctx, execution) => {
+  const choice = await ctx.requestUserInput({
+    prompt: "Update the records above, then retry.",
+    messages: ["Some sampled records are missing fields the reviews playbook needs before it can continue."],
+    promptType: "multipleChoice",
+    options: [RETRY_ASSESSMENT_OPTION, SWITCH_INDEX_OPTION],
+    list: missingRequiredFields(execution)
+  });
+  if (choice === RETRY_ASSESSMENT_OPTION) {
+    return;
+  }
+  if (choice === SWITCH_INDEX_OPTION) {
+    return ctx.returnToStep("select-index");
+  }
+  throw new Error("data-assessment received an unexpected not-ready choice");
+};
+var promptReady = async (ctx, execution) => {
+  const result = execution.assessment_result;
+  if (!result?.ready) {
+    throw new Error("data-assessment expected a ready assessment result");
+  }
+  const schemaComparison = result.schema_comparison ?? [];
+  const requiredFieldCount = schemaComparison.filter(
+    (item) => item.canonical_required
+  ).length;
+  const settingsWithChanges = changedSettings(result.settings_recommendation);
+  await ctx.requestUserInput({
+    prompt: settingsWithChanges.length > 0 ? `Your data is in good shape. Next you will review ${settingsWithChanges.length} ${settingsWithChanges.length === 1 ? "setting" : "settings"}.` : "All settings are optimized",
+    promptType: "multipleChoice",
+    options: [CONTINUE_EXECUTION_OPTION],
+    list: [
+      {
+        label: "Records sampled",
+        color: "success"
+      },
+      {
+        label: "Schema detected",
+        color: "success",
+        helpText: `${requiredFieldCount} ${requiredFieldCount === 1 ? "field" : "fields"} detected`
+      },
+      {
+        label: "All required fields present",
+        color: "success"
+      }
+    ]
+  });
+};
+var missingRequiredFields = (execution) => {
+  return (execution.assessment_result?.schema_comparison ?? []).filter((item) => item.canonical_required && item.status !== "mapped").sort((a, b) => Number(b.canonical_required) - Number(a.canonical_required)).slice(0, 10).map((item) => ({
+    label: item.canonical_attr,
+    color: "error",
+    helpText: `missing \xB7 roles: ${item.canonical_roles.join(", ")}`
+  }));
+};
+var changedSettings = (settingsRecommendation) => {
+  return Object.entries(settingsRecommendation ?? {}).filter(
+    ([_, setting]) => JSON.stringify(setting.current) !== JSON.stringify(setting.recommended)
+  );
+};
+
+// src/actions/playbookSteps/dataAssessment.ts
 var POLL_INTERVAL_MS = 5e3;
 var POLL_TIMEOUT_MS = 6e4;
 var ASSESSING_NOTICE_HOLD_MS = 2e4;
@@ -7732,7 +7841,10 @@ async function dataAssessmentStep(ctx) {
     showNotice(ctx, CREATING_EXECUTION_NOTICE);
     const { id: appId } = await requireApplication();
     const execution = await resolveExecution(ctx, appId, slug, indexName);
-    return await runAssessment(ctx, execution, indexName);
+    const assessed = await runAssessment(ctx, execution, indexName);
+    ctx.clearNotices();
+    await promptReady(ctx, assessed);
+    return assessed;
   } finally {
     ctx.clearNotices();
   }
@@ -7772,20 +7884,39 @@ function startPollNotices(ctx) {
   showCurrent();
   return () => clearTimeout(timer);
 }
+function isNotReady(execution) {
+  return execution.step_status === "error" && execution.status_reason === "not_ready";
+}
 async function runAssessment(ctx, execution, indexName) {
   if (execution.step_status === "done") {
     return execution;
   }
-  if (execution.step_status === "not_started" || execution.step_status === "error") {
-    await assessExecution(ctx, execution.uuid, indexName);
-  } else if (execution.step_status !== "in_progress") {
-    throw unexpectedAssessmentStatus(execution.step_status);
+  if (isNotReady(execution)) {
+    await reassessNotReady(
+      ctx,
+      execution,
+      indexName
+    );
+  } else {
+    await startAssessment(ctx, execution, indexName);
   }
   for (; ; ) {
-    const assessed = await pollUntilAssessed(ctx, execution.uuid, indexName);
+    const assessed = await pollUntilAssessed(
+      ctx,
+      execution.uuid,
+      indexName
+    );
     if (assessed.step_status === "done") {
       return assessed;
     }
+    if (isNotReady(assessed)) {
+      await reassessNotReady(
+        ctx,
+        assessed,
+        indexName
+      );
+      continue;
+    }
     if (assessed.step_status !== "error") {
       throw unexpectedAssessmentStatus(assessed.step_status);
     }
@@ -7797,6 +7928,18 @@ async function runAssessment(ctx, execution, indexName) {
     await assessExecution(ctx, execution.uuid, indexName);
   }
 }
+async function startAssessment(ctx, execution, indexName) {
+  if (execution.step_status === "not_started" || execution.step_status === "error") {
+    await assessExecution(ctx, execution.uuid, indexName);
+    return;
+  }
+  if (execution.step_status === "in_progress") return;
+  throw unexpectedAssessmentStatus(execution.step_status);
+}
+async function reassessNotReady(ctx, execution, indexName) {
+  await promptNotReady(ctx, execution);
+  await assessExecution(ctx, execution.uuid, indexName);
+}
 function unexpectedAssessmentStatus(status) {
   return new Error(
     `data-assessment received an unexpected assessment status: ${status}`
@@ -7805,12 +7948,7 @@ function unexpectedAssessmentStatus(status) {
 async function resolveExecution(ctx, appId, slug, indexName) {
   const created = await createWithRecovery(ctx, appId, slug, indexName);
   if (!created.resumed) return created;
-  const choice = await ctx.requestUserInput({
-    prompt: `${indexName} has a playbook in progress.`,
-    promptType: "multipleChoice",
-    options: [CONTINUE_EXECUTION_OPTION, RESTART_OPTION, GO_BACK_OPTION3],
-    secondary: [{ kind: "text", value: "resume Assessment" }]
-  });
+  const choice = await promptResumeExecution(ctx, indexName);
   if (choice === CONTINUE_EXECUTION_OPTION) return created;
   if (choice === RESTART_OPTION) {
     return createWithRecovery(ctx, appId, slug, indexName, { forceNew: true });
@@ -7898,26 +8036,6 @@ async function assessExecution(ctx, uuid, indexName) {
     onRequestFailure(ctx, indexName)
   );
 }
-async function promptAssessmentRecovery(ctx, message, retryDisabled) {
-  const choice = await ctx.requestUserInput({
-    prompt: "Data assessment failed.",
-    promptType: "multipleChoice",
-    options: [SWITCH_APPLICATION_OPTION, SWITCH_INDEX_OPTION, RETRY_OPTION],
-    messages: [message],
-    disabled: [false, false, retryDisabled],
-    helpText: "Retry re-runs assessment on this index. Switch index or application to pick a different target."
-  });
-  if (choice === SWITCH_APPLICATION_OPTION) {
-    return ctx.changeApplication();
-  }
-  if (choice === SWITCH_INDEX_OPTION) {
-    return ctx.returnToStep("select-index");
-  }
-  if (choice === RETRY_OPTION) {
-    return;
-  }
-  throw new Error("data-assessment received an unexpected recovery choice");
-}
 function assessmentFailureMessage(execution) {
   if (execution.status_reason === "index_empty") {
     return `Index "${execution.source_index_name}" has no records to assess.`;
@@ -9374,7 +9492,7 @@ async function resetProjectState() {
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@algolia/wizard",
-  version: "0.84.0",
+  version: "0.86.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {

package/package.json

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