Merge branch 'main' into feat/timeouts-per-specs

Author: shortcuts

.github/workflows/check.yml

@@ -224,6 +224,9 @@ jobs:
       - name: Build the playground
         run: yarn cli build playground javascript ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun }}
 
+      - name: Build the browser playground
+        run: yarn workspace javascript-playground-browser build
+
       - name: Run common and requester tests
         run: cd clients/algoliasearch-client-javascript && yarn test ${{ !contains(fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun, 'algoliasearch') && '--ignore algoliasearch' || '' }}
 

docs/guides/csharp/src/pushSetup.cs

@@ -10,7 +10,7 @@ class PushSetup
 {
   public static async Task Main(string[] args)
   {
-    string jsonContent = File.ReadAllText("/my-raw-records.json");
+    string jsonContent = File.ReadAllText("records.json");
 
     var records = JsonSerializer.Deserialize<List<PushTaskRecords>>(jsonContent);
 

docs/guides/go/src/pushSetup.go

@@ -16,7 +16,7 @@ func push() {
 		panic(err)
 	}
 
-	content, err := os.ReadFile("/my-raw-records.json")
+	content, err := os.ReadFile("records.json")
 	if err != nil {
 		panic(err)
 	}

docs/guides/java/src/test/java/com/algolia/pushSetup.java

@@ -8,7 +8,7 @@
 public class pushSetup {
 
   public static void main(String[] args) throws Exception {
-    JsonNode content = new ObjectMapper().readTree(new File("/my-raw-records.json"));
+    JsonNode content = new ObjectMapper().readTree(new File("records.json"));
     List<PushTaskRecords> records = new ObjectMapper().readerForListOf(Map.class).readValue(content);
 
     // use the region matching your applicationID

docs/guides/javascript/src/pushSetup.ts

@@ -8,7 +8,7 @@ const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initIn
 
 try {
   // read local JSON file containing array of records
-  const records = JSON.parse(fs.readFileSync('/my-raw-records.json', 'utf8')) as PushTaskRecords[];
+  const records = JSON.parse(fs.readFileSync('records.json', 'utf8')) as PushTaskRecords[];
 
   // push records to the API
   const run = await client.pushTask({

docs/guides/kotlin/src/main/kotlin/com/algolia/snippets/pushSetup.kt

@@ -8,7 +8,7 @@ import kotlinx.serialization.json.Json
 import java.io.File
 
 suspend fun main() {
-  val json = File("/my-raw-records.json").readText()
+  val json = File("records.json").readText()
   val records: List<PushTaskRecords> = Json.decodeFromString(ListSerializer(PushTaskRecords.serializer()), json)
 
   // use the region matching your applicationID

docs/guides/php/src/pushSetup.php

@@ -3,7 +3,7 @@
 require __DIR__.'/vendor/autoload.php';
 use Algolia\AlgoliaSearch\Api\IngestionClient;
 
-$records = json_decode(file_get_contents('/my-raw-records.json'), true);
+$records = json_decode(file_get_contents('records.json'), true);
 
 // use the region matching your applicationID
 $client = IngestionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');

docs/guides/python/pushSetup.py

@@ -9,7 +9,7 @@ async def main():
         "ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
     )
 
-    with open("/my-raw-records.json") as f:
+    with open("records.json") as f:
         records = json.load(f)
 
         run = _client.push_task(

docs/guides/ruby/pushSetup.rb

@@ -1,7 +1,7 @@
 require "json"
 require "algolia"
 
-records = JSON.parse(File.read("/my-raw-records.json"))
+records = JSON.parse(File.read("records.json"))
 
 # use the region matching your applicationID
 client = Algolia::IngestionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")

docs/guides/scala/src/main/scala/pushSetup.scala

@@ -15,7 +15,7 @@ object PushSetup {
     implicit val ec: ExecutionContextExecutor = scala.concurrent.ExecutionContext.global
     implicit val formats: org.json4s.Formats = org.json4s.DefaultFormats
 
-    val result = Source.fromFile("/my-raw-records.json").getLines().mkString
+    val result = Source.fromFile("records.json").getLines().mkString
     val records = JsonMethods.parse(result).extract[Seq[algoliasearch.ingestion.PushTaskRecords]]
 
     // use the region matching your applicationID

docs/guides/swift/Sources/pushSetup.swift

@@ -9,7 +9,7 @@ import Ingestion
 func pushSetup() async throws {
     do {
         let path = URL(string: #file)!.deletingLastPathComponent()
-            .appendingPathComponent("/my-raw-records.json")
+            .appendingPathComponent("records.json")
         let data = try Data(contentsOf: URL(fileURLWithPath: path.absoluteString))
         let records = try JSONDecoder().decode([PushTaskRecords].self, from: data)
 

config/versions.history.json renamed to docs/versions-history-with-sla-and-support-policy.json

@@ -0,0 +1,28 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  { ignores: ['dist'] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+    },
+  },
+)

playground/javascript/browser/.yarn/releases/yarn-4.5.3.cjs

@@ -1,22 +1,13 @@
 <!doctype html>
 <html lang="en">
   <head>
-    <meta charset="utf-8" />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1, shrink-to-fit=no"
-    />
-
-    <link rel="shortcut icon" href="favicon.png" />
-
-    <title>React InstantSearch — Getting started</title>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
   </head>
-
   <body>
-    <noscript> You need to enable JavaScript to run this app. </noscript>
-
     <div id="root"></div>
-
-    <script type="module" src="src/index.tsx"></script>
+    <script type="module" src="/src/main.tsx"></script>
   </body>
 </html>

playground/javascript/browser/.yarnrc.yml

@@ -1,33 +1,33 @@
 {
-  "name": "javascript-browser-playground",
-  "version": "0.0.0",
+  "name": "javascript-playground-browser",
   "private": true,
+  "version": "0.0.0",
+  "type": "module",
   "scripts": {
-    "build": "yarn clean && BABEL_ENV=parcel parcel build index.html products.html",
-    "clean": "rm -rf .parcel-cache node_modules dist || true && yarn",
-    "start": "yarn clean && BABEL_ENV=parcel parcel index.html products.html --port 3001"
+    "dev": "vite",
+    "build": "tsc -b && vite build",
+    "lint": "eslint .",
+    "preview": "vite preview"
   },
   "dependencies": {
     "algoliasearch": "link:../../../clients/algoliasearch-client-javascript/packages/algoliasearch",
-    "instantsearch.css": "8.5.1",
-    "instantsearch.js": "4.75.5",
-    "react": "18.3.1",
-    "react-dom": "18.3.1",
-    "react-instantsearch": "7.13.8"
+    "instantsearch.css": "^8.5.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-instantsearch": "^7.13.8"
   },
   "devDependencies": {
-    "@parcel/core": "2.13.2",
-    "@parcel/packager-raw-url": "2.13.2",
-    "@parcel/transformer-webmanifest": "2.13.2",
-    "@types/react": "^18.0.9",
-    "https-browserify": "^1.0.0",
-    "parcel": "2.13.2",
-    "stream-http": "^3.1.0",
+    "@eslint/js": "9.15.0",
+    "@types/react": "18.3.12",
+    "@types/react-dom": "18.3.1",
+    "@vitejs/plugin-react-swc": "3.5.0",
+    "eslint": "9.15.0",
+    "eslint-plugin-react-hooks": "5.0.0",
+    "eslint-plugin-react-refresh": "0.4.14",
+    "globals": "15.12.0",
     "typescript": "5.7.2",
-    "url": "^0.11.0"
-  },
-  "@parcel/resolver-default": {
-    "packageExports": true
+    "typescript-eslint": "8.15.0",
+    "vite": "6.0.1"
   },
   "packageManager": "[email protected]"
 }

playground/javascript/browser/app.css

@@ -0,0 +1,68 @@
+:root {
+  font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif;
+  line-height: 1.5;
+  font-weight: 400;
+
+  color-scheme: light dark;
+  color: rgba(255, 255, 255, 0.87);
+  background-color: #242424;
+
+  font-synthesis: none;
+  text-rendering: optimizeLegibility;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+a {
+  font-weight: 500;
+  color: #646cff;
+  text-decoration: inherit;
+}
+a:hover {
+  color: #535bf2;
+}
+
+body {
+  margin: 0;
+  display: flex;
+  place-items: center;
+  min-width: 320px;
+  min-height: 100vh;
+}
+
+h1 {
+  font-size: 3.2em;
+  line-height: 1.1;
+}
+
+button {
+  border-radius: 8px;
+  border: 1px solid transparent;
+  padding: 0.6em 1.2em;
+  font-size: 1em;
+  font-weight: 500;
+  font-family: inherit;
+  background-color: #1a1a1a;
+  cursor: pointer;
+  transition: border-color 0.25s;
+}
+button:hover {
+  border-color: #646cff;
+}
+button:focus,
+button:focus-visible {
+  outline: 4px auto -webkit-focus-ring-color;
+}
+
+@media (prefers-color-scheme: light) {
+  :root {
+    color: #213547;
+    background-color: #ffffff;
+  }
+  a:hover {
+    color: #747bff;
+  }
+  button {
+    background-color: #f9f9f9;
+  }
+}

playground/javascript/browser/app.ts

@@ -0,0 +1,10 @@
+import { StrictMode } from 'react'
+import { createRoot } from 'react-dom/client'
+import './index.css'
+import {App} from './App.tsx'
+
+createRoot(document.getElementById('root')!).render(
+  <StrictMode>
+    <App />
+  </StrictMode>,
+)

playground/javascript/browser/eslint.config.js

@@ -0,0 +1 @@
+/// <reference types="vite/client" />