@algolia/wizard 0.34.0-rc.125.245 → 0.34.0

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

@@ -4,18 +4,13 @@ Install `instantsearch.js` (v4)
 
 ## Search client: always use the lite client
 
-Import the client from `algoliasearch/lite` and alias it to `algoliasearch`.
-`ALGOLIA_APP_ID`, `ALGOLIA_SEARCH_API_KEY`, and `ALGOLIA_INDEX_NAME` below are
-the constants exported from the project's shared client-side config module —
-these are public values, safe to commit; never hardcode them inline or read
-them from an env var.
+Import the client from `algoliasearch/lite` and alias it to `algoliasearch`
 
 ```ts
 import { liteClient as algoliasearch } from 'algoliasearch/lite'
-import { ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY } from '<the project's shared config module>'
 
 // Instantiate ONCE, outside components, with a stable reference.
-const searchClient = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY)
+const searchClient = algoliasearch(APP_ID, SEARCH_ONLY_KEY)
 ```
 
 ## Vanilla (`instantsearch.js` v4)
@@ -24,16 +19,11 @@ const searchClient = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY)
 import { liteClient as algoliasearch } from 'algoliasearch/lite'
 import instantsearch from 'instantsearch.js'
 import { searchBox, hits } from 'instantsearch.js/es/widgets'
-import {
-  ALGOLIA_APP_ID,
-  ALGOLIA_SEARCH_API_KEY,
-  ALGOLIA_INDEX_NAME,
-} from '<the project's shared config module>'
 
-const searchClient = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY)
+const searchClient = algoliasearch(APP_ID, SEARCH_ONLY_KEY)
 
 const search = instantsearch({
-  indexName: ALGOLIA_INDEX_NAME,
+  indexName: 'INDEX_NAME',
   searchClient,
   insights: true,
 })
@@ -63,7 +53,7 @@ case, install `search-insights` from npm and pass its default export as
 import aa from 'search-insights'
 
 const search = instantsearch({
-  indexName: ALGOLIA_INDEX_NAME,
+  indexName: 'INDEX_NAME',
   searchClient,
   insights: { insightsClient: aa },
 })

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

@@ -4,18 +4,13 @@ Install `react-instantsearch` (v7)
 
 ## Search client: always use the lite client
 
-Import the client from `algoliasearch/lite` and alias it to `algoliasearch`.
-`ALGOLIA_APP_ID`, `ALGOLIA_SEARCH_API_KEY`, and `ALGOLIA_INDEX_NAME` below are
-the constants exported from the project's shared client-side config module —
-these are public values, safe to commit; never hardcode them inline or read
-them from an env var.
+Import the client from `algoliasearch/lite` and alias it to `algoliasearch`
 
 ```ts
 import { liteClient as algoliasearch } from 'algoliasearch/lite'
-import { ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY } from '<the project's shared config module>'
 
 // Instantiate ONCE, outside components, with a stable reference.
-const searchClient = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY)
+const searchClient = algoliasearch(APP_ID, SEARCH_ONLY_KEY)
 ```
 
 ## React (`react-instantsearch` v7)
@@ -23,19 +18,19 @@ const searchClient = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY)
 ```tsx
 import { liteClient as algoliasearch } from 'algoliasearch/lite'
 import { InstantSearch, SearchBox, Hits } from 'react-instantsearch'
-import {
-  ALGOLIA_APP_ID,
-  ALGOLIA_SEARCH_API_KEY,
-  ALGOLIA_INDEX_NAME,
-} from '<the project's shared config module>'
 
-const searchClient = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY)
+// Read from PUBLIC env vars; never hardcode. (Vite shown; use the framework's
+// convention: NEXT_PUBLIC_* for Next.js, etc.)
+const searchClient = algoliasearch(
+  import.meta.env.VITE_ALGOLIA_APP_ID,
+  import.meta.env.VITE_ALGOLIA_SEARCH_API_KEY,
+)
 
 export function Search() {
   return (
     <InstantSearch
       searchClient={searchClient}
-      indexName={ALGOLIA_INDEX_NAME}
+      indexName="INDEX_NAME"
       insights={true}
     >
       <SearchBox />

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

@@ -4,18 +4,13 @@ Install `vue-instantsearch` (v4)
 
 ## Search client: always use the lite client
 
-Import the client from `algoliasearch/lite` and alias it to `algoliasearch`.
-`ALGOLIA_APP_ID`, `ALGOLIA_SEARCH_API_KEY`, and `ALGOLIA_INDEX_NAME` below are
-the constants exported from the project's shared client-side config module —
-these are public values, safe to commit; never hardcode them inline or read
-them from an env var.
+Import the client from `algoliasearch/lite` and alias it to `algoliasearch`
 
 ```ts
 import { liteClient as algoliasearch } from 'algoliasearch/lite'
-import { ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY } from '<the project's shared config module>'
 
 // Instantiate ONCE, outside components, with a stable reference.
-const searchClient = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY)
+const searchClient = algoliasearch(APP_ID, SEARCH_ONLY_KEY)
 ```
 
 ## Vue (`vue-instantsearch` v4)
@@ -24,7 +19,7 @@ const searchClient = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY)
 <template>
   <ais-instant-search
     :search-client="searchClient"
-    :index-name="ALGOLIA_INDEX_NAME"
+    index-name="INDEX_NAME"
     :insights="true"
   >
     <ais-search-box />
@@ -34,13 +29,11 @@ const searchClient = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY)
 
 <script setup>
 import { liteClient as algoliasearch } from 'algoliasearch/lite'
-import {
-  ALGOLIA_APP_ID,
-  ALGOLIA_SEARCH_API_KEY,
-  ALGOLIA_INDEX_NAME,
-} from '<the project's shared config module>'
 
-const searchClient = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY)
+const searchClient = algoliasearch(
+  import.meta.env.VITE_ALGOLIA_APP_ID,
+  import.meta.env.VITE_ALGOLIA_SEARCH_API_KEY,
+)
 </script>
 ```
 

package/docs/algolia-sdk/search-single-index.md

@@ -5,19 +5,10 @@ route, or programmatic queries). For UI, prefer `instantsearch-setup-<framework>
 
 ## Client
 
-`ALGOLIA_APP_ID`, `ALGOLIA_SEARCH_API_KEY`, and `ALGOLIA_INDEX_NAME` below are
-the constants exported from the project's shared client-side config module —
-these are public values, safe to commit; never hardcode them inline or read
-them from an env var.
-
 ```ts
 import { algoliasearch } from 'algoliasearch'
-import {
-  ALGOLIA_APP_ID,
-  ALGOLIA_SEARCH_API_KEY,
-} from '<the project's shared config module>'
 
-const client = algoliasearch(ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY)
+const client = algoliasearch(APP_ID, SEARCH_ONLY_KEY)
 ```
 
 In v5 there is no `client.initIndex(...)`. Index methods take the index name as a
@@ -27,7 +18,7 @@ parameter on the client. Every method takes a single options object.
 
 ```ts
 const { hits, nbHits } = await client.searchSingleIndex({
-  indexName: ALGOLIA_INDEX_NAME,
+  indexName: 'INDEX_NAME',
   searchParams: { query: 'shoes', hitsPerPage: 20, page: 0 },
 })
 ```
@@ -37,7 +28,7 @@ const { hits, nbHits } = await client.searchSingleIndex({
 ```ts
 const { results } = await client.search({
   requests: [
-    { indexName: ALGOLIA_INDEX_NAME, query: 'shoes' },
+    { indexName: 'INDEX_NAME', query: 'shoes' },
     { indexName: 'OTHER_INDEX', query: 'shoes' },
   ],
 })

package/package.json

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