@algolia/wizard 0.35.0-rc.126.250 → 0.36.0

package/dist/main.js

@@ -3275,7 +3275,7 @@ async function runAnalysis(mode, extraInstructions = []) {
 // package.json
 var package_default = {
   name: "@algolia/wizard",
-  version: "0.35.0-rc.126.250",
+  version: "0.36.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {
@@ -4529,7 +4529,12 @@ var defaultWorkflow = {
       id: "project-scan",
       title: "project scan",
       outputSchema: projectScanSchema,
-      tips: ["apps-and-indices", "records-are-json", "speed"],
+      tips: [
+        "apps-and-indices",
+        "records-are-json",
+        "speed",
+        "searchable-attributes"
+      ],
       run: (ctx) => {
         ctx.notify({
           messages: [
@@ -4565,7 +4570,7 @@ var defaultWorkflow = {
       id: "ingestion",
       title: "ingest records",
       outputSchema: implementSchema,
-      tips: ["records-are-json", "searchable-attributes", "facets"],
+      tips: ["facets", "test-relevance", "search-analytics", "recommend"],
       run: (ctx) => {
         ctx.notify({
           messages: [
@@ -4586,13 +4591,7 @@ var defaultWorkflow = {
       id: "search",
       title: "create search ui",
       outputSchema: implementSchema,
-      tips: [
-        "test-relevance",
-        "search-analytics",
-        "recommend",
-        "searchable-attributes",
-        "facets"
-      ],
+      tips: ["typo-tolerance", "synonyms", "multi-index-search", "rules"],
       run: (ctx) => {
         ctx.notify({
           messages: ["Building your Algolia search experience\u2026"]
@@ -5096,7 +5095,7 @@ function Logs() {
 }
 
 // src/ui/Tips.tsx
-import { useEffect as useEffect3, useState as useState8 } from "react";
+import { useEffect as useEffect3, useRef as useRef4, useState as useState8 } from "react";
 import { Box as Box18, Text as Text18 } from "ink";
 import terminalLink from "terminal-link";
 
@@ -5120,7 +5119,7 @@ function highlightJson(json) {
       return /* @__PURE__ */ jsx15(Text17, { color: "yellow", children: part }, i);
     }
     if (/^[{}[\]:,]$/.test(part)) {
-      return /* @__PURE__ */ jsx15(Text17, { dimColor: true, children: part }, i);
+      return /* @__PURE__ */ jsx15(Text17, { color: COLORS.dim, children: part }, i);
     }
     return /* @__PURE__ */ jsx15(Text17, { children: part }, i);
   });
@@ -5253,6 +5252,70 @@ var tips = [
       }
     ]
   },
+  {
+    id: "typo-tolerance",
+    title: "Your users will misspell things. Algolia already handles it.",
+    chunks: [
+      {
+        type: "text",
+        value: 'Typo tolerance is on out of the box. Someone searching "rstaurnt" still gets restaurants.'
+      },
+      {
+        type: "text",
+        value: "Exact matches always rank above one-typo matches, which rank above two."
+      }
+    ]
+  },
+  {
+    id: "synonyms",
+    title: "Synonyms teach the engine your words",
+    chunks: [
+      {
+        type: "text",
+        value: "Pants, trousers, slacks: one synonym entry and all three find each other."
+      },
+      {
+        type: "text",
+        value: 'One-way synonyms go further. "tablet" can find iPad without iPad returning every tablet.'
+      },
+      {
+        type: "text",
+        value: 'And a placeholder like "Case for iPhone <model>" covers a whole product line without duplicating records.'
+      }
+    ]
+  },
+  {
+    id: "multi-index-search",
+    title: "One search box, many indices",
+    chunks: [
+      {
+        type: "text",
+        value: "Federated search queries several indices at once, so a single dropdown can show products, categories and articles side by side."
+      },
+      {
+        type: "text",
+        value: "Each source gets its own layout and its own hit count: 4 categories, 8 products, whatever fits."
+      }
+    ]
+  },
+  {
+    id: "rules",
+    title: "Rules let you put a thumb on the scale",
+    chunks: [
+      {
+        type: "text",
+        value: "When a query matches a condition, a Rule can pin a result to the top, hide one, boost a brand or attach a banner."
+      },
+      {
+        type: "text",
+        value: 'A search for "sale" can filter to discounted items. A search for "iphone" can pin your best-selling case.'
+      },
+      {
+        type: "text",
+        value: "The Visual Editor in the dashboard does all of it by drag and drop, no reindex needed."
+      }
+    ]
+  },
   {
     id: "recommend",
     title: "Let Algolia act as your recommendation engine",
@@ -5279,7 +5342,7 @@ function tipsByIds(ids) {
 import { jsx as jsx16, jsxs as jsxs16 } from "react/jsx-runtime";
 var TICK_MS = 16;
 var CHUNK_HOLD_MS = 2e3;
-var HOLD_MS = 8e3;
+var HOLD_MS = 12e3;
 function TipTitle({ children }) {
   return /* @__PURE__ */ jsxs16(Box18, { gap: 1, children: [
     /* @__PURE__ */ jsx16(Text18, { color: "cyan", children: "\u2726" }),
@@ -5337,7 +5400,11 @@ function TipContent({
   ) });
 }
 var progress = { stepId: null, tipIndex: 0, revealed: 0 };
-function Tips({ stepId, ids }) {
+function Tips({
+  stepId,
+  ids,
+  onRevealStateChange
+}) {
   const tips2 = tipsByIds(ids);
   const resuming = progress.stepId === stepId;
   if (!resuming) {
@@ -5368,6 +5435,16 @@ function Tips({ stepId, ids }) {
     );
     if (!skipPause) chunkBoundaries.push(cumulative);
   }
+  const revealState = tips2.length === 0 ? "idle" : revealed < totalLength ? "revealing" : "revealed";
+  const onRevealStateChangeRef = useRef4(onRevealStateChange);
+  onRevealStateChangeRef.current = onRevealStateChange;
+  const reportedRef = useRef4(null);
+  useEffect3(() => {
+    if (reportedRef.current === revealState) return;
+    reportedRef.current = revealState;
+    onRevealStateChangeRef.current?.(revealState);
+  }, [revealState]);
+  useEffect3(() => () => onRevealStateChangeRef.current?.("idle"), []);
   useEffect3(() => {
     if (tips2.length === 0) return;
     if (revealed < totalLength) {
@@ -5417,6 +5494,7 @@ function App() {
   const { exit } = useApp();
   const { columns, rows } = useWindowSize7();
   const [showLogs, setShowLogs] = useState9(false);
+  const [tipState, setTipState] = useState9("idle");
   const finished = phase === "done" || phase === "error";
   const currentStep = steps[currentStepIndex];
   const stepDef = workflow ? getWorkflow(workflow.id)?.steps.find((s) => s.id === currentStep?.id) : void 0;
@@ -5424,9 +5502,11 @@ function App() {
   const stepHasTips = tipIds.length > 0;
   const isAwaitingUserInput = phase === "awaitingInput" && !!inputReq;
   const isCommandApprovalPrompt = isAwaitingUserInput && inputReq?.promptType === "commandApproval";
-  const showTips = stepHasTips && (phase === "running" || isCommandApprovalPrompt);
+  const promptPending = isAwaitingUserInput && !isCommandApprovalPrompt;
+  const holdForTip = stepHasTips && promptPending && tipState === "revealing";
+  const showTips = stepHasTips && (phase === "running" || isCommandApprovalPrompt || holdForTip);
   const showNoticesInMain = !stepHasTips;
-  const showNotices = !isAwaitingUserInput;
+  const showNotices = !isAwaitingUserInput || holdForTip;
   useInput6(
     (_input, key) => {
       if (key.return) {
@@ -5446,7 +5526,7 @@ function App() {
       });
     }
   });
-  const escOwnedElsewhere = phase === "idle" || phase === "authenticating" || phase === "awaitingInput" && (inputReq?.promptType === "enterToContinue" || inputReq?.promptType === "commandApproval");
+  const escOwnedElsewhere = phase === "idle" || phase === "authenticating" || phase === "awaitingInput" && !holdForTip && (inputReq?.promptType === "enterToContinue" || inputReq?.promptType === "commandApproval");
   useInput6((_input, key) => {
     if (escOwnedElsewhere) return;
     if (key.escape) {
@@ -5510,7 +5590,14 @@ function App() {
                           /* @__PURE__ */ jsx17(Text19, { color: COLORS.muted, children: "A browser window will open \u2014 complete sign-in there." })
                         ] }),
                         /* @__PURE__ */ jsx17(CliOutput, {}),
-                        showTips && currentStep && /* @__PURE__ */ jsx17(Tips, { stepId: currentStep.id, ids: tipIds }),
+                        showTips && currentStep && /* @__PURE__ */ jsx17(
+                          Tips,
+                          {
+                            stepId: currentStep.id,
+                            ids: tipIds,
+                            onRevealStateChange: setTipState
+                          }
+                        ),
                         showNoticesInMain && showNotices && /* @__PURE__ */ jsx17(Notices, { showAll: true, border: false }),
                         !showTips && /* @__PURE__ */ jsx17(PromptInput, {}),
                         phase === "error" && error && /* @__PURE__ */ jsx17(Box19, { marginTop: 1, children: /* @__PURE__ */ jsxs17(Text19, { color: COLORS.status.error, children: [
@@ -5519,7 +5606,7 @@ function App() {
                         ] }) })
                       ] }),
                       !showNoticesInMain && showNotices && /* @__PURE__ */ jsx17(Notices, {}),
-                      showTips && /* @__PURE__ */ jsx17(PromptInput, {})
+                      showTips && !holdForTip && /* @__PURE__ */ jsx17(PromptInput, {})
                     ]
                   }
                 ),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/wizard",
-  "version": "0.35.0-rc.126.250",
+  "version": "0.36.0",
   "description": "Magically implement Algolia functionality in your codebase",
   "type": "module",
   "engines": {