@algolia/wizard 0.89.0 → 0.91.0

package/dist/main.js

@@ -1514,6 +1514,15 @@ function PromptInput() {
   return /* @__PURE__ */ jsxs10(Box10, { flexDirection: "column", children: [
     inputReq.error && /* @__PURE__ */ jsx9(Text11, { color: COLORS.danger, children: inputReq.error }),
     inputReq.messages?.map((m, i) => /* @__PURE__ */ jsx9(Text11, { color: COLORS.muted, children: m }, `msg-${i}`)),
+    inputReq.suggestion && /* @__PURE__ */ jsxs10(Text11, { color: COLORS.muted, children: [
+      "Press",
+      " ",
+      /* @__PURE__ */ jsx9(Text11, { color: COLORS.accent, bold: true, children: "Enter" }),
+      " ",
+      "to use",
+      " ",
+      /* @__PURE__ */ jsx9(Text11, { color: COLORS.accent, bold: true, children: inputReq.suggestion })
+    ] }),
     /* @__PURE__ */ jsxs10(Box10, { children: [
       /* @__PURE__ */ jsxs10(Text11, { color: COLORS.primary, children: [
         inputReq.prompt,
@@ -2358,7 +2367,7 @@ async function ensureApplication(resumeAppId) {
 // package.json
 var package_default = {
   name: "@algolia/wizard",
-  version: "0.89.0",
+  version: "0.91.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {
@@ -2831,6 +2840,9 @@ async function runWorkflow(workflow, startWorkflowAppId, options) {
   }
 }
 
+// src/actions/selectIndex.ts
+import { basename } from "node:path";
+
 // src/actions/listIndices.ts
 import { z as z5 } from "zod";
 var indicesListSchema = z5.object({
@@ -2865,11 +2877,27 @@ function indexNameError(name) {
     return "Index name cannot end with .txt, .bin, or .idx.";
   return void 0;
 }
+function slug(text) {
+  return text.toLowerCase().replace(/[^a-z0-9]+/g, "_").replace(/^_+|_+$/g, "");
+}
+function suggestIndexName(project, entity, taken) {
+  const base = ([slug(project), slug(entity ?? "")].filter(Boolean).join("_") || "records").slice(0, MAX_INDEX_NAME_LENGTH);
+  let name = base;
+  for (let n = 2; taken.includes(name); n++) {
+    const suffix = `_${n}`;
+    name = base.slice(0, MAX_INDEX_NAME_LENGTH - suffix.length) + suffix;
+  }
+  return name;
+}
 var selectIndexStep = async (ctx) => {
   await requireApplication(ctx.appId);
   const indices = await listIndices();
   const names = indices.map((i) => i.name);
   const hasIndices = names.length > 0;
+  const entity = ctx.getStepOutput(
+    "confirm-entities"
+  )?.confirmedEntities?.[0]?.name;
+  const suggested = suggestIndexName(basename(process.cwd()), entity, names);
   let error;
   let chosen;
   while (chosen === void 0) {
@@ -2886,6 +2914,7 @@ var selectIndexStep = async (ctx) => {
       messages: [
         "This app has no existing indices \u2014 enter a name to create one."
       ],
+      suggestion: suggested,
       error
     });
     if (typeof selection !== "string") {
@@ -2894,17 +2923,18 @@ var selectIndexStep = async (ctx) => {
     let candidate;
     let isNewName = true;
     if (!hasIndices) {
-      candidate = selection.trim();
+      candidate = selection.trim() || suggested;
     } else if (selection === CREATE_NEW_INDEX) {
       const name = await ctx.requestUserInput({
         prompt: "Name the new index:",
         promptType: "textInput",
-        options: []
+        options: [],
+        suggestion: suggested
       });
       if (typeof name !== "string") {
         throw new Error("selectIndex received an unexpected non-text result");
       }
-      candidate = name.trim();
+      candidate = name.trim() || suggested;
     } else {
       candidate = selection;
       isNewName = false;
@@ -3140,14 +3170,14 @@ import z9 from "zod";
 import { readFile as readFile4 } from "node:fs/promises";
 
 // src/lib/tools/env.ts
-import { basename } from "node:path";
+import { basename as basename2 } from "node:path";
 function isEnvFile(filePath) {
-  const name = basename(filePath);
+  const name = basename2(filePath);
   return name === ".env" || name.startsWith(".env.");
 }
 function isSecretEnvFile(filePath) {
   if (!isEnvFile(filePath)) return false;
-  const name = basename(filePath);
+  const name = basename2(filePath);
   return !/\.(example|sample|template)$/.test(name);
 }
 function secretEnvWriteRefusal(filePath) {
@@ -3782,7 +3812,7 @@ import { execFile as execFile2 } from "node:child_process";
 import { tool as tool8 } from "ai";
 import z15 from "zod";
 import { lstat as lstat3, readdir as readdir2, readFile as readFile8, realpath, stat as stat2 } from "node:fs/promises";
-import { basename as basename2, isAbsolute as isAbsolute2, join as join8, relative as relative4, sep as sep2 } from "node:path";
+import { basename as basename3, isAbsolute as isAbsolute2, join as join8, relative as relative4, sep as sep2 } from "node:path";
 import { performance } from "node:perf_hooks";
 import { Worker } from "node:worker_threads";
 var MAX_GIT_OUTPUT_BYTES = 32e6;
@@ -4125,7 +4155,7 @@ async function safeSearchPath(rootPath, file) {
 }
 async function searchableFiles(root, target) {
   try {
-    if (SKIP_FILES.has(basename2(target)) && (await lstat3(target)).isFile()) {
+    if (SKIP_FILES.has(basename3(target)) && (await lstat3(target)).isFile()) {
       return [target];
     }
     const gitRoot = await gitRootForTarget(root, target);
@@ -4304,7 +4334,7 @@ import { tool as tool9 } from "ai";
 import z16 from "zod";
 import { createHash as createHash2 } from "node:crypto";
 import { readFile as readFile9, stat as stat3 } from "node:fs/promises";
-import { basename as basename3, relative as relative5, resolve as resolve3 } from "node:path";
+import { basename as basename4, relative as relative5, resolve as resolve3 } from "node:path";
 
 // src/lib/tools/utils/prompt.ts
 var chain = Promise.resolve();
@@ -4402,7 +4432,7 @@ function commandDiffersFromReviewedScript(ctx, command, cwd) {
   if (approval.command === command && approval.cwd === cwd) return false;
   if (approval.command === command) return true;
   const scriptReferences = [
-    basename3(approval.filePath),
+    basename4(approval.filePath),
     relative5(ctx.root, approval.filePath),
     ".algolia-wizard"
   ];
@@ -5123,8 +5153,8 @@ function generateRecordTool(ctx, createModel = defaultCreateModel2) {
           ...record,
           objectID: nanoid2()
         }));
-        const slug = entityName.toLowerCase().replace(/[^a-z0-9]+/g, "-");
-        const relPath = `${DATA_DIR}/${slug}.json`;
+        const slug2 = entityName.toLowerCase().replace(/[^a-z0-9]+/g, "-");
+        const relPath = `${DATA_DIR}/${slug2}.json`;
         const resolved2 = resolveInRoot(ctx, relPath);
         if (resolved2.ok === false) return resolved2.error;
         const writeError = await safeWriteFile(
@@ -6077,7 +6107,7 @@ import {
 // src/lib/git.ts
 import { execFile as execFile3 } from "node:child_process";
 import { copyFile, mkdir as mkdir4, stat as stat4 } from "node:fs/promises";
-import { basename as basename4, dirname as dirname3, isAbsolute as isAbsolute3, join as join9, resolve as resolve4 } from "node:path";
+import { basename as basename5, dirname as dirname3, isAbsolute as isAbsolute3, join as join9, resolve as resolve4 } from "node:path";
 var MAX_BUFFER = 32 * 1024 * 1024;
 function git(args) {
   return new Promise((resolve6, reject) => {
@@ -6114,7 +6144,7 @@ async function copyUploadIntoProject(repoRoot, ingestDir, sourcePath) {
   } catch {
     return { ok: false, reason: `"${sourcePath}" does not exist` };
   }
-  const relPath = join9(ingestDir, basename4(source));
+  const relPath = join9(ingestDir, basename5(source));
   const dest = join9(repoRoot, relPath);
   if (resolve4(source) === resolve4(dest)) {
     return { ok: true, relPath };
@@ -6490,6 +6520,27 @@ function packageSearchInstructions(input) {
     "Install any Algolia packages you import with the project's own package manager via runShell, and declare them in the project's dependency manifest."
   ];
 }
+function cdnAutocompleteShape(placeholder) {
+  return `Use this shape for the autocomplete call. Replace the item fields and the getURL route with the real record fields and an existing route:
+\`\`\`js
+window.instantsearch.widgets.autocomplete({
+  container: '#autocomplete',
+  placeholder: ${JSON.stringify(placeholder)},
+  indices: [
+    {
+      indexName: window.${SEARCH_CONFIG_INDEX_NAME},
+      getURL: (item) => '/existing-route/' + item.slug,
+      templates: {
+        item: ({ item, onSelect }, { html, components }) =>
+          html\`<div onClick=\${onSelect}>\${components.Highlight({ hit: item, attribute: 'name' })}</div>\`,
+        noResults: (_, { html }) => html\`<span>No results</span>\`,
+      },
+    },
+  ],
+})
+\`\`\`
+The widget reads the item and noResults templates only from each indices entry. Its own top-level templates option accepts only panel. If item is not inside indices[].templates, the widget throws "Template must be 'string' or 'function', was 'undefined' (key: item)" on the first search and shows no results.`;
+}
 function cdnSearchInstructions(input) {
   const entityName = input.findings.confirmedEntities?.[0]?.name;
   const placeholder = entityName ? `Search ${entityName} records...` : "Search indexed content...";
@@ -6499,7 +6550,8 @@ function cdnSearchInstructions(input) {
     input.searchKey ? `Set window.${SEARCH_CONFIG_SEARCH_KEY} to "${input.searchKey}".` : `A real search-only key could not be provisioned${input.searchKeyError ? ` (${input.searchKeyError})` : ""} \u2014 set window.${SEARCH_CONFIG_SEARCH_KEY} to the placeholder "${SEARCH_KEY_PLACEHOLDER}" and add a prominent TODO for the developer to fill in a real one.`,
     'Load these exact pinned tags in order before the config and search scripts: <script src="https://cdn.jsdelivr.net/npm/algoliasearch@5.59.0/dist/lite/builds/browser.umd.js" integrity="sha256-pduQHl1jn0IaN/BIpSotQm7Y5THdpKcX3Bw6xdRteRw=" crossorigin="anonymous"></script> then <script src="https://cdn.jsdelivr.net/npm/instantsearch.js@4.117.0/dist/instantsearch.production.min.js" integrity="sha256-5zhKxAGeH7ThWfnmdD4pS1gsmafE2b8aWRsq8set/dc=" crossorigin="anonymous"></script>.',
     'When using the InstantSearch theme, load this exact tag before the application styles: <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.css@8.22.1/themes/satellite-min.css" integrity="sha256-5/eHPZl63VYJSDVOKrOgGe/5+owUkX3uPAW6+XYeLNc=" crossorigin="anonymous">. Never use an unversioned or differently versioned theme URL, and never omit its integrity attribute.',
-    `In that classic search script, use window['algoliasearch/lite'].liteClient and window.instantsearch. Add window.instantsearch.widgets.autocomplete as the only search widget. Configure it with container '#autocomplete', the content-specific placeholder ${JSON.stringify(placeholder)}, and an indices array containing one object whose indexName is window.${SEARCH_CONFIG_INDEX_NAME}; put item and noResults functions in its templates option, implement getURL only for an existing route, and match the item template to the entity schema. Keep insights: true and call search.start(). Do not substitute searchBox or hits, omit indices, use imports or exports, or use type="module".`
+    `In that classic search script, use window['algoliasearch/lite'].liteClient and window.instantsearch. Add window.instantsearch.widgets.autocomplete as the only search widget. Configure it with container '#autocomplete', the content-specific placeholder ${JSON.stringify(placeholder)}, and an indices array containing one object whose indexName is window.${SEARCH_CONFIG_INDEX_NAME}. Put the item and noResults functions in the templates option of that indices entry, implement getURL only for an existing route, and match the item template to the entity schema. Keep insights: true and call search.start(). Do not substitute searchBox or hits, omit indices, use imports or exports, or use type="module".`,
+    cdnAutocompleteShape(placeholder)
   ];
 }
 function validationInstructions(input) {
@@ -6522,7 +6574,8 @@ function validationInstructions(input) {
     "Do not modify files. Report each implementation issue as a concrete instruction for the next implementation pass.",
     `Detected verification tools: ${JSON.stringify(input.findings.verification ?? [])}. Use only a type checker; ignore any linter or formatter in this list.`,
     ...!input.frontendHasPackageJson ? [
-      "The frontend has no package.json: never create one or run npm, pnpm, yarn, or bun. Validate the CDN implementation by inspecting its HTML or template and classic scripts for the search container, Algolia \u2192 InstantSearch \u2192 config \u2192 search load order, browser globals, autocomplete widget configuration, search.start(), and exact pinned CDN URLs and integrity attributes for every Algolia script or stylesheet. Source inspection is required even when the project has no automated checks. window.instantsearch.widgets.autocomplete is a real widget in the pinned InstantSearch build; do not report its use as an error, and do not fetch a remote bundle or URL to verify it."
+      "The frontend has no package.json: never create one or run npm, pnpm, yarn, or bun. Validate the CDN implementation by inspecting its HTML or template and classic scripts for the search container, Algolia \u2192 InstantSearch \u2192 config \u2192 search load order, browser globals, autocomplete widget configuration, search.start(), and exact pinned CDN URLs and integrity attributes for every Algolia script or stylesheet. Source inspection is required even when the project has no automated checks. window.instantsearch.widgets.autocomplete is a real widget in the pinned InstantSearch build; do not report its use as an error, and do not fetch a remote bundle or URL to verify it.",
+      "In the autocomplete call, confirm that the item and noResults templates are inside the templates option of the indices entry, not in the top-level templates option of the widget. The top-level templates option accepts only panel, so an item template there throws on the first search and no results show. If item is missing from indices[].templates, set sufficient=false and tell the next pass to move the templates into the indices entry."
     ] : [],
     "Always call reportStatus with status=success after validation, even when sufficient=false.",
     "Set sufficient=false if the input's computed accessible name is empty or generic, including when aria-labelledby references a missing or empty element; a placeholder does not count as the label.",
@@ -6662,8 +6715,8 @@ async function firstRecordIn(filePath) {
 async function ingestedRecordSample(repoRoot, entityName, uploadFilePath) {
   const candidates = [];
   if (entityName) {
-    const slug = entityName.toLowerCase().replace(/[^a-z0-9]+/g, "-");
-    candidates.push(join11(repoRoot, INGEST_DIR, "data", `${slug}.json`));
+    const slug2 = entityName.toLowerCase().replace(/[^a-z0-9]+/g, "-");
+    candidates.push(join11(repoRoot, INGEST_DIR, "data", `${slug2}.json`));
   }
   if (uploadFilePath?.toLowerCase().endsWith(".json")) {
     candidates.push(join11(repoRoot, uploadFilePath));
@@ -7600,9 +7653,9 @@ async function getPlaybooks() {
   );
   return data;
 }
-async function createPlaybookExecution(appId, slug, indexName, options) {
+async function createPlaybookExecution(appId, slug2, indexName, options) {
   const { data } = await dashboardRequest(
-    `/api/1/playbook-integrations/applications/${appId}/playbooks/${slug}/executions`,
+    `/api/1/playbook-integrations/applications/${appId}/playbooks/${slug2}/executions`,
     playbookExecutionCreateResponseSchema,
     {
       method: "POST",
@@ -7643,9 +7696,9 @@ async function assessPlaybookExecution(uuid) {
 var selectPlaybookSchema = z33.object({
   slug: z33.string()
 });
-function persistSlug(ctx, slug) {
-  ctx.setUserInput("playbookSlug", slug);
-  return { slug };
+function persistSlug(ctx, slug2) {
+  ctx.setUserInput("playbookSlug", slug2);
+  return { slug: slug2 };
 }
 async function selectPlaybookStep(ctx, requestedSlug) {
   const playbooks = await getPlaybooks();
@@ -7776,13 +7829,13 @@ async function confirmIndexStep(ctx) {
   if (!sampleIndex) {
     return null;
   }
-  const { slug } = ctx.getStepOutput("select-playbook");
+  const { slug: slug2 } = ctx.getStepOutput("select-playbook");
   const selection = await ctx.requestUserInput({
     prompt: "Ready to create sample index?",
     promptType: "multipleChoice",
     options: [CONTINUE_OPTION, GO_BACK_OPTION2],
     messages: [
-      `A new index called "algolia_playbooks_${slug}_sample_index" will be created with sample ${slug} data.`
+      `A new index called "algolia_playbooks_${slug2}_sample_index" will be created with sample ${slug2} data.`
     ],
     helpText: "Going back lets you choose a different index."
   });
@@ -7934,13 +7987,13 @@ var POLL_NOTICES = [
   { message: "detecting required fields\u2026" }
 ];
 async function dataAssessmentStep(ctx) {
-  const { slug } = ctx.getStepOutput("select-playbook");
+  const { slug: slug2 } = ctx.getStepOutput("select-playbook");
   const { indexName, existingExecution } = indexForAssessment(ctx);
   if (existingExecution) return existingExecution;
   try {
     showNotice(ctx, CREATING_EXECUTION_NOTICE);
     const { id: appId } = await requireApplication();
-    const execution = await resolveExecution(ctx, appId, slug, indexName);
+    const execution = await resolveExecution(ctx, appId, slug2, indexName);
     const assessed = await runAssessment(ctx, execution, indexName);
     ctx.clearNotices();
     await promptReady(ctx, assessed);
@@ -8045,24 +8098,24 @@ function unexpectedAssessmentStatus(status) {
     `data-assessment received an unexpected assessment status: ${status}`
   );
 }
-async function resolveExecution(ctx, appId, slug, indexName) {
-  const created = await createWithRecovery(ctx, appId, slug, indexName);
+async function resolveExecution(ctx, appId, slug2, indexName) {
+  const created = await createWithRecovery(ctx, appId, slug2, indexName);
   if (!created.resumed) return created;
   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 });
+    return createWithRecovery(ctx, appId, slug2, indexName, { forceNew: true });
   }
   if (choice === GO_BACK_OPTION3) {
     return ctx.returnToStep("select-index");
   }
   throw new Error("data-assessment received an unexpected execution choice");
 }
-async function createWithRecovery(ctx, appId, slug, indexName, options) {
+async function createWithRecovery(ctx, appId, slug2, indexName, options) {
   return retryOnDashboardError(
     () => {
       showNotice(ctx, CREATING_EXECUTION_NOTICE);
-      return createPlaybookExecution(appId, slug, indexName, options);
+      return createPlaybookExecution(appId, slug2, indexName, options);
     },
     onRequestFailure(ctx, indexName)
   );
@@ -9741,7 +9794,7 @@ async function resetProjectState() {
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@algolia/wizard",
-  version: "0.89.0",
+  version: "0.91.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {

package/package.json

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