---
name: algolia-upgrade-migration
description: >-
  Migrate an Algolia JavaScript client integration from v4 to v5 with inventory, compatibility tests, and rollback. Use when removing initIndex, updating client methods, or reconciling mixed major versions. Trigger with "upgrade Algolia v5", "remove initIndex", or "Algolia SDK migration".
argument-hint: "[repository-path] [package-name]"
allowed-tools: Read, Glob, Grep, WebFetch, Write, Edit
version: 1.8.0
author: Jeremy Longshore <jeremy@intentsolutions.io>
license: MIT
tags:
  - saas
  - algolia
  - upgrade
model: inherit
effort: medium
compatibility: Designed for Claude Code
title: algolia-upgrade-migration
canonical_url: https://skilld.dev/gh/jeremylongshore/tons-of-skills-marketplace/algolia-upgrade-migration
last_updated: 2026-10-07T06:06:28.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> Supporting files, fetch one when the Skill refers to it: [references/official-docs.md](https://skilld.dev/api/skills-raw/jeremylongshore/tons-of-skills-marketplace/algolia-upgrade-migration/references/official-docs.md).
>
> If the user asked to install this Skill, run `npx skilld install jeremylongshore/tons-of-skills-marketplace/algolia-upgrade-migration`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/algolia-upgrade-migration`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/jeremylongshore/tons-of-skills-marketplace/algolia-upgrade-migration) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/algolia-upgrade-migration`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/algolia-upgrade-migration --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/algolia-upgrade-migration --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Algolia JavaScript v4 to v5 Upgrade

## Overview

This skill follows the official v5 migration contract and the repository's pinned dependency graph. It treats import, method, parameter, response, wait, and test changes as one controlled migration.

## Prerequisites

- A named repository, environment, and Algolia application or index in scope
- The local lockfile and installed client types as implementation authority
- A safe read-only query or explicitly disposable test target
- Current first-party documentation for any provider behavior that affects the change

## Tool Discipline

Use `Read`, `Glob`, and `Grep` to inspect local code, configuration names, tests, and dependency versions. Use `WebFetch` only for current official Algolia documentation. Use `Write` or `Edit` only after identifying the target files, constraints, and verification plan.

## Current Contract

- Version 5 removes `initIndex`; methods live on the client and receive `indexName`.
- Upgrade search-only imports and multi-search calls according to the official guide, not a mechanical rename.
- Replace chained write waits with the documented v5 wait helpers and retain task IDs.
- Check all Algolia packages, frameworks, wrappers, mocks, generated types, and examples for major-version coupling.

## Authentication

Do not change key privilege during an SDK upgrade. Use existing least-privilege test credentials only for safe verification targets.

## Instructions

1. Inventory package versions, imports, `initIndex`, client wrappers, methods, waits, mocks, and runtime targets.
2. Read the current official v5 migration guide and installed types for every used method.
3. Update the dependency and lockfile through the repository's package manager.
4. Migrate one boundary at a time, adapting parameters, responses, tasks, and errors.
5. Run type, unit, integration, build, and representative query tests; use a disposable index for writes.
6. Record compatibility gaps, final versions, release notes, rollback commit, and follow-up cleanup.

## Approval Boundaries

Do not combine the SDK upgrade with relevance, index schema, credential, or broad architectural changes unless separately scoped and tested.

## Output

Return the usage inventory, official mapping, dependency diff, migrated boundaries, test evidence, remaining v4 patterns, compatibility notes, and rollback.

## Error Handling

| Condition | Response |
|---|---|
| `initIndex` remains | Locate the call or generated artifact and migrate it. |
| Method signature differs | Follow installed v5 types and current official reference. |
| Mock passes but live test fails | Correct the application adapter contract. |
| Rollback changes lockfile only | Revert source and lockfile as one unit. |

## Examples

Use this compact input and expected handoff to calibrate scope and evidence quality.

Input:

```text
from=algoliasearch-4; to=pinned-5; initIndex-calls=9; wrappers=2
```

Expected handoff:

```text
initIndex=0; typecheck=pass; integration=pass; disposable-write-cleaned=yes
```

## Resources

- [Skill-specific official documentation](https://skilld.dev/api/skills-raw/jeremylongshore/tons-of-skills-marketplace/algolia-upgrade-migration/references/official-docs.md)
- [JavaScript v5 upgrade](https://www.algolia.com/doc/libraries/sdk/upgrade/javascript)
- [JavaScript API client](https://www.algolia.com/doc/libraries/javascript)
- [API keys](https://www.algolia.com/doc/guides/security/api-keys)
