@algolia/wizard 0.80.0 → 0.81.0

package/dist/main.js

@@ -2306,7 +2306,7 @@ async function ensureApplication(resumeAppId) {
 // package.json
 var package_default = {
   name: "@algolia/wizard",
-  version: "0.80.0",
+  version: "0.81.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {
@@ -6435,17 +6435,12 @@ var defaultWorkflow = {
   id: "default",
   title: "Default Workflow",
   description: "This workflow explores your repo and implements Algolia on your behalf",
+  tips: true,
   steps: [
     defineStep({
       id: "project-scan",
       title: "project scan",
       outputSchema: projectScanSchema,
-      tips: [
-        "apps-and-indices",
-        "records-are-json",
-        "speed",
-        "searchable-attributes"
-      ],
       run: (ctx) => {
         ctx.notify({
           messages: [
@@ -6481,7 +6476,6 @@ var defaultWorkflow = {
       id: "ingestion",
       title: "ingest records",
       outputSchema: implementSchema,
-      tips: ["facets", "test-relevance", "search-analytics", "recommend"],
       run: (ctx) => {
         ctx.notify({
           messages: [
@@ -6502,7 +6496,6 @@ var defaultWorkflow = {
       id: "search",
       title: "create search ui",
       outputSchema: implementSchema,
-      tips: ["typo-tolerance", "synonyms", "multi-index-search", "rules"],
       run: (ctx) => {
         ctx.notify({
           messages: ["Building your Algolia search experience\u2026"]
@@ -6513,6 +6506,7 @@ var defaultWorkflow = {
     defineStep({
       id: "review",
       title: "done",
+      hideTips: true,
       outputSchema: reviewSchema,
       run: (ctx) => {
         ctx.notify({
@@ -7175,7 +7169,6 @@ var playbookWorkflow = {
       id: "select-index",
       title: "Select index",
       outputSchema: selectIndexSchema,
-      tips: ["apps-and-indices", "records-are-json", "speed"],
       run: (ctx) => selectIndexStep2(ctx)
     }),
     defineStep({
@@ -7183,7 +7176,6 @@ var playbookWorkflow = {
       title: "Confirm sample index creation",
       outputSchema: confirmIndexSchema,
       visible: false,
-      tips: ["apps-and-indices", "records-are-json", "speed"],
       run: (ctx) => confirmIndexStep(ctx)
     }),
     defineStep({
@@ -7788,7 +7780,6 @@ function Code({ children }) {
 // src/ui/copy/tips.ts
 var tips = [
   {
-    id: "apps-and-indices",
     title: "An Application is like your library. Indices are the books in it.",
     chunks: [
       {
@@ -7802,7 +7793,6 @@ var tips = [
     ]
   },
   {
-    id: "records-are-json",
     title: "A Record is a JSON object inside of an index.",
     chunks: [
       {
@@ -7836,7 +7826,6 @@ var tips = [
     ]
   },
   {
-    id: "speed",
     title: "Speed isn't a feature, it's our business",
     chunks: [
       {
@@ -7850,7 +7839,6 @@ var tips = [
     ]
   },
   {
-    id: "searchable-attributes",
     title: "Searchable attributes are your relevance dial #1",
     chunks: [
       {
@@ -7866,7 +7854,6 @@ var tips = [
     ]
   },
   {
-    id: "facets",
     title: "Facets aren't just filters, they help build your UI",
     chunks: [
       { type: "codeword", value: "attributesForFaceting" },
@@ -7877,7 +7864,6 @@ var tips = [
     ]
   },
   {
-    id: "test-relevance",
     title: "Test relevance in the dashboard before you write a line of ranking code",
     chunks: [
       {
@@ -7896,7 +7882,6 @@ var tips = [
     ]
   },
   {
-    id: "search-analytics",
     title: "Search Analytics helps you discover opportunities",
     chunks: [
       {
@@ -7910,7 +7895,6 @@ var tips = [
     ]
   },
   {
-    id: "typo-tolerance",
     title: "Your users will misspell things. Algolia already handles it.",
     chunks: [
       {
@@ -7924,7 +7908,6 @@ var tips = [
     ]
   },
   {
-    id: "synonyms",
     title: "Synonyms teach the engine your words",
     chunks: [
       {
@@ -7942,7 +7925,6 @@ var tips = [
     ]
   },
   {
-    id: "multi-index-search",
     title: "One search box, many indices",
     chunks: [
       {
@@ -7956,7 +7938,6 @@ var tips = [
     ]
   },
   {
-    id: "rules",
     title: "Rules let you put a thumb on the scale",
     chunks: [
       {
@@ -7974,7 +7955,6 @@ var tips = [
     ]
   },
   {
-    id: "recommend",
     title: "Let Algolia act as your recommendation engine",
     chunks: [
       {
@@ -7988,18 +7968,12 @@ var tips = [
     ]
   }
 ];
-var tipsById = Object.fromEntries(
-  tips.map((tip) => [tip.id, tip])
-);
-function tipsByIds(ids) {
-  return ids.map((id) => tipsById[id]).filter((tip) => tip !== void 0);
-}
 
 // src/ui/Tips.tsx
 import { jsx as jsx20, jsxs as jsxs19 } from "react/jsx-runtime";
 var TICK_MS = 16;
 var CHUNK_HOLD_MS = 2e3;
-var HOLD_MS = 12e3;
+var TIP_DURATION_MS = 25e3;
 function TipTitle({ children }) {
   return /* @__PURE__ */ jsxs19(Box21, { gap: 1, children: [
     /* @__PURE__ */ jsx20(Text22, { color: "cyan", children: "\u2726" }),
@@ -8056,45 +8030,53 @@ function TipContent({
     ] }, j)) }, i)
   ) });
 }
-var progress = { stepId: null, tipIndex: 0, revealed: 0 };
+var noPauseAfterText = [
+  "highlight",
+  "link",
+  "codeword"
+];
+function revealSchedule(tip) {
+  const segments = [
+    { type: "text", value: tip.title },
+    ...tip.chunks
+  ];
+  const schedule = [];
+  let at = 0;
+  segments.forEach((segment, i) => {
+    for (let c = 0; c < segment.value.length; c++) {
+      const pause = i > 0 && c === 0 && !noPauseAfterText.includes(segment.type);
+      at += pause ? CHUNK_HOLD_MS : TICK_MS;
+      schedule.push(at);
+    }
+  });
+  return schedule;
+}
+var clock = { tipIndex: 0, elapsedMs: 0, complete: false };
 function Tips({
-  stepId,
-  ids,
-  onRevealStateChange
+  onRevealStateChange,
+  onComplete
 }) {
-  const tips2 = tipsByIds(ids);
-  const resuming = progress.stepId === stepId;
-  if (!resuming) {
-    progress.stepId = stepId;
-    progress.tipIndex = 0;
-    progress.revealed = 0;
-  }
-  const [tipIndex, setTipIndex] = useState11(resuming ? progress.tipIndex : 0);
-  const [revealed, setRevealed] = useState11(resuming ? progress.revealed : 0);
-  const tip = tips2.length > 0 ? tips2[tipIndex % tips2.length] : void 0;
-  const contentLength = tip?.chunks.reduce((sum, c) => sum + c.value.length, 0) ?? 0;
-  const totalLength = (tip?.title.length ?? 0) + contentLength;
-  const segments = tip ? [
-    { type: "title", length: tip.title.length },
-    ...tip.chunks.map((c) => ({ type: c.type, length: c.value.length }))
-  ] : [];
-  const noPauseAfterText = [
-    "highlight",
-    "link",
-    "codeword"
-  ];
-  const chunkBoundaries = [];
-  let cumulative = 0;
-  for (let i = 0; i < segments.length - 1; i++) {
-    cumulative += segments[i].length;
-    const skipPause = noPauseAfterText.includes(
-      segments[i + 1].type
-    );
-    if (!skipPause) chunkBoundaries.push(cumulative);
-  }
-  const revealState = tips2.length === 0 ? "idle" : revealed < totalLength ? "revealing" : "revealed";
+  const [position, setPosition] = useState11(() => {
+    const now = Date.now();
+    return {
+      tipIndex: clock.tipIndex,
+      startedAt: now - clock.elapsedMs,
+      now,
+      complete: clock.complete
+    };
+  });
+  const tip = tips[position.tipIndex];
+  const elapsedMs = position.now - position.startedAt;
+  const schedule = revealSchedule(tip);
+  const revealed = schedule.filter((at) => at <= elapsedMs).length;
+  const fullyTyped = revealed === schedule.length;
+  const nextAt = fullyTyped ? TIP_DURATION_MS : schedule[revealed];
+  const midSentence = !fullyTyped && revealed > 0 && nextAt - schedule[revealed - 1] === TICK_MS;
+  const revealState = position.complete ? "idle" : midSentence ? "typing" : "resting";
   const onRevealStateChangeRef = useRef4(onRevealStateChange);
   onRevealStateChangeRef.current = onRevealStateChange;
+  const onCompleteRef = useRef4(onComplete);
+  onCompleteRef.current = onComplete;
   const reportedRef = useRef4(null);
   useEffect3(() => {
     if (reportedRef.current === revealState) return;
@@ -8103,30 +8085,35 @@ function Tips({
   }, [revealState]);
   useEffect3(() => () => onRevealStateChangeRef.current?.("idle"), []);
   useEffect3(() => {
-    if (tips2.length === 0) return;
-    if (revealed < totalLength) {
-      const delay2 = chunkBoundaries.includes(revealed) ? CHUNK_HOLD_MS : TICK_MS;
-      const timer2 = setTimeout(() => {
-        setRevealed((r) => {
-          const next = r + 1;
-          progress.revealed = next;
-          return next;
-        });
-      }, delay2);
-      return () => clearTimeout(timer2);
+    if (position.complete) {
+      onCompleteRef.current?.();
+      return;
     }
     const timer = setTimeout(() => {
-      setTipIndex((i) => {
-        const next = (i + 1) % tips2.length;
-        progress.tipIndex = next;
-        return next;
-      });
-      setRevealed(0);
-      progress.revealed = 0;
-    }, HOLD_MS);
-    return () => clearTimeout(timer);
-  }, [revealed, totalLength, tips2.length]);
-  if (!tip) return null;
+      const now = Date.now();
+      const tipComplete = now - position.startedAt >= TIP_DURATION_MS;
+      if (tipComplete && position.tipIndex === tips.length - 1) {
+        clock.complete = true;
+        setPosition({ ...position, now, complete: true });
+        return;
+      }
+      setPosition(
+        tipComplete ? {
+          tipIndex: position.tipIndex + 1,
+          startedAt: now,
+          now,
+          complete: false
+        } : { ...position, now }
+      );
+    }, nextAt - elapsedMs);
+    return () => {
+      clearTimeout(timer);
+      if (clock.complete) return;
+      clock.tipIndex = position.tipIndex;
+      clock.elapsedMs = Date.now() - position.startedAt;
+    };
+  }, [position, nextAt, elapsedMs]);
+  if (position.complete) return null;
   const titleRevealed = tip.title.slice(0, revealed);
   const contentRevealed = Math.max(0, revealed - tip.title.length);
   return /* @__PURE__ */ jsxs19(Box21, { flexDirection: "column", marginBottom: 1, gap: 1, children: [
@@ -8194,17 +8181,16 @@ function App() {
   const compactRun = isCompactTerminal(columns, rows);
   const [showLogs, setShowLogs] = useState12(false);
   const [tipState, setTipState] = useState12("idle");
+  const [tipsComplete, setTipsComplete] = useState12(false);
   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;
-  const tipIds = stepDef?.tips ?? [];
-  const stepHasTips = tipIds.length > 0;
+  const workflowDef = workflow ? getWorkflow(workflow.id) : void 0;
+  const stepHidesTips = workflowDef?.steps.find((s) => s.id === currentStep?.id)?.hideTips === true;
+  const tipsActive = workflowDef?.tips === true && !tipsComplete && !stepHidesTips;
   const isAwaitingUserInput = phase === "awaitingInput" && !!inputReq;
-  const isCommandApprovalPrompt = isAwaitingUserInput && inputReq?.promptType === "commandApproval";
-  const promptPending = isAwaitingUserInput && !isCommandApprovalPrompt;
-  const holdForTip = !compactRun && stepHasTips && promptPending && tipState === "revealing";
-  const showTips = !compactRun && stepHasTips && (phase === "running" && currentStep?.status === "running" && !loadingMessage && !settingUpAppId || isCommandApprovalPrompt);
-  const showNoticesInMain = !stepHasTips;
+  const holdForTip = !compactRun && tipsActive && isAwaitingUserInput && tipState === "typing";
+  const showTips = !compactRun && tipsActive && (phase === "running" && currentStep?.status === "running" && !loadingMessage && !settingUpAppId || holdForTip);
+  const showNoticesInMain = !tipsActive;
   const showNotices = !compactRun && (!isAwaitingUserInput || holdForTip) && !review2;
   useInput9(
     (_input, key) => {
@@ -8299,12 +8285,11 @@ function App() {
                           loadingMessage
                         ] }) }),
                         /* @__PURE__ */ jsx21(CliOutput, {}),
-                        showTips && currentStep && /* @__PURE__ */ jsx21(
+                        showTips && /* @__PURE__ */ jsx21(
                           Tips,
                           {
-                            stepId: currentStep.id,
-                            ids: tipIds,
-                            onRevealStateChange: setTipState
+                            onRevealStateChange: setTipState,
+                            onComplete: () => setTipsComplete(true)
                           }
                         ),
                         showNoticesInMain && showNotices && /* @__PURE__ */ jsx21(Notices, { showAll: true, border: false }),
@@ -8315,8 +8300,7 @@ function App() {
                           error
                         ] }) })
                       ] }),
-                      !showNoticesInMain && showNotices && /* @__PURE__ */ jsx21(Notices, {}),
-                      showTips && !holdForTip && /* @__PURE__ */ jsx21(PromptInput, {})
+                      !showNoticesInMain && showNotices && /* @__PURE__ */ jsx21(Notices, {})
                     ]
                   }
                 ),
@@ -8563,7 +8547,7 @@ async function resetProjectState() {
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@algolia/wizard",
-  version: "0.80.0",
+  version: "0.81.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {

package/package.json

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