@algolia/wizard 0.84.0-rc.202.652 → 0.84.0

package/dist/main.js

@@ -2315,7 +2315,7 @@ async function ensureApplication(resumeAppId) {
 // package.json
 var package_default = {
   name: "@algolia/wizard",
-  version: "0.84.0-rc.202.652",
+  version: "0.84.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {
@@ -6321,7 +6321,10 @@ function ingestionInstructions(input) {
       "Write the script in the project's primary language, using Algolia's official client for that language. Do not use the raw HTTP API.",
       "After a successful ingest, the script must print exactly one line to stdout in the form `ALGOLIA_WIZARD_RECORD_COUNT=<n>`, where <n> is the total number of records pushed to Algolia. Print it last, on its own line, with no surrounding text.",
       recordSizeInstruction(input.appPlan),
-      "When you split one source item into several records, keep the fields that the search UI shows (title, description, URL parts) on every record. After you push the records, the script must set the index settings with attributeForDistinct set to the parent identifier and distinct set to true, so that a search returns each source item once.",
+      "When you split one source item into several records, keep the fields that the search UI shows (title, description, URL parts) on every record. After you push those split records, the script must set the index settings with attributeForDistinct set to the parent identifier and distinct set to true, so that a search returns each source item once.",
+      "After you push the records, set searchableAttributes to the primary text fields the UI will search and show. For any longer text field the UI may snippet (description, body, content), set attributesToSnippet (for example description:20). Without attributesToSnippet, Algolia returns no _snippetResult and Snippet helpers render blank.",
+      "Store plain text in fields the UI shows or snippets. Strip Markdown, HTML, and similar markup at index time (or index a separate plain-text field) so result rows do not show raw ###, backticks, or tags.",
+      "URL and slug fields used to build result links must resolve to real routes in this app. Do not invent ids or prefixes that the app does not serve.",
       ...algoliaClientDoc(input),
       "Install the Algolia client with the project's own package manager via runShell, declaring it in whatever manifest the project uses (e.g. package.json, requirements.txt, Gemfile, go.mod, composer.json) so the dependency is not just installed ad hoc.",
       `If the script loads its env vars from a file (e.g. via dotenv or an equivalent for its language) rather than the process environment directly, decide that up front and call writeCredentials on that file before you finish the script \u2014 do not wait to discover the need for it by having a writeFile call refused.`,
@@ -6366,6 +6369,7 @@ function searchInstructions(input) {
     indexedContentMessage ?? "",
     `Build the search UI for ${input.searchUiTarget}.`,
     "Create search UI only. Do not create or modify ingestion scripts, rake/manage/CLI tasks, migrations, seeders, or other data-loading code, even if the data looks incomplete.",
+    "Prefer Highlight (or the plain attribute) for titles and short fields. Use Snippet only for longer text, and only when attributesToSnippet is set for that attribute \u2014 via the index searchParameters (for example attributesToSnippet: ['body:20']) or index settings. Without it, _snippetResult is missing and the result panel looks empty even though search returns hits.",
     FILE_EDIT_INSTRUCTION,
     EXISTING_COMPONENT_INSTRUCTION,
     mountCandidateMessage,
@@ -9370,7 +9374,7 @@ async function resetProjectState() {
 // package.json with { type: 'json' }
 var package_default2 = {
   name: "@algolia/wizard",
-  version: "0.84.0-rc.202.652",
+  version: "0.84.0",
   description: "Magically implement Algolia functionality in your codebase",
   type: "module",
   engines: {

package/docs/algolia-sdk/instantsearch-setup-js.md

@@ -76,6 +76,17 @@ search.start()
 
 Ensure the attributes you map into the component match the entity. 'title' above is an example.
 
+### Highlight vs Snippet
+
+- Prefer `components.Highlight` (or the plain attribute) for titles and other short
+  fields. Highlight uses `_highlightResult`, which Algolia returns by default.
+- Use `components.Snippet` only for longer text. Snippet reads `_snippetResult`,
+  which is **empty unless** `attributesToSnippet` is set. Without it, the result
+  row renders blank while search still returns hits.
+- When you use Snippet, set `attributesToSnippet` on that index's
+  `searchParameters` (for example `['body:20']`), or as an index setting. Do both
+  for the same attribute names the template passes to Snippet.
+
 ### Navigation is `getURL`'s job, not the template's
 
 - `indices[].getURL` — `(item) => string`, a route that already exists; don't invent one.

package/docs/algolia-sdk/instantsearch-setup-react.md

@@ -68,6 +68,17 @@ export function Search() {
 
 Ensure the attributes you map into the component match the entity. 'title' above is an example.
 
+### Highlight vs Snippet
+
+- Prefer plain attributes or `<Highlight>` for titles and other short fields.
+  Highlight uses `_highlightResult`, which Algolia returns by default.
+- Use `<Snippet>` only for longer text. Snippet reads `_snippetResult`, which is
+  **empty unless** `attributesToSnippet` is set. Without it, the result row
+  renders blank while search still returns hits.
+- When you use Snippet, set `attributesToSnippet` on that index's
+  `searchParameters` (for example `['body:20']`), or as an index setting. Do both
+  for the same attribute names the component passes to Snippet.
+
 ### Navigation is `getURL`'s job, not the item component's
 
 - `indices[].getURL` — `(item) => string`, a route that already exists; don't invent one.

package/docs/algolia-sdk/instantsearch-setup-vue.md

@@ -154,6 +154,17 @@ function onFocusOut(event) {
 Adapt the label, placeholder, highlighted attributes, result content, and destination to
 the confirmed indexed entity. `products` and `name` above are examples.
 
+### Highlight vs Snippet
+
+- Prefer `ais-highlight` (or the plain attribute) for titles and other short fields.
+  Highlight uses `_highlightResult`, which Algolia returns by default.
+- Use `ais-snippet` only for longer text. Snippet reads `_snippetResult`, which is
+  **empty unless** `attributesToSnippet` is set. Without it, the result row
+  renders blank while search still returns hits.
+- When you use Snippet, set `attributesToSnippet` via `ais-configure` or that
+  index's search parameters (for example `['body:20']`), or as an index setting.
+  Do both for the same attribute names the template passes to the snippet.
+
 Details that break accessibility if changed:
 
 - `role="combobox"` on the `input`, not a wrapper — with `aria-controls` at the popup's

package/package.json

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