Skip to content
cccskills
FreePublished on GitHub

algolia-upgrade-migration

Plan and carry out a controlled migration of an Algolia JavaScript client from v4 to v5. Inventory package versions and API usage, update method calls and waits against the installed types and official migration guidance, run compatibility checks, and document remaining gaps and rollback steps.

OriginalShow the original 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".

Run score Not tested

See how to install

Good for

  • Finding v4 client calls and mixed package versions
  • Migrating initIndex and related method usage
  • Checking compatibility and preparing a rollback

Files included (2)

  • SKILL.md3.9 KB
  • references/official-docs.md1.3 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

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

ConditionResponse
initIndex remainsLocate the call or generated artifact and migrate it.
Method signature differsFollow installed v5 types and current official reference.
Mock passes but live test failsCorrect the application adapter contract.
Rollback changes lockfile onlyRevert source and lockfile as one unit.

Examples

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

Input:

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

Expected handoff:

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

Resources

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Add a synthetic-data CI gate for customer-owned Abridge integration code. Test consent handling, note-review handoffs, redaction, and rollback behavior with mocked vendor boundaries, without connecting CI to a live Abridge or EHR tenant.

  • Adding regression checks to an Abridge integration repository
  • Testing consent and note-release handling
  • Checking logs for sensitive data exposure
jeremylongshore/tons-of-skills-marketplace2.9KUpdated Oct 23, 2026

Triage Abridge recording, note review, Epic handoff, and access problems using observed symptoms and approved guidance. Identify the affected workflow stage, organize a minimal timeline, and prepare a redacted escalation record for the responsible team.

  • Separate recording problems from upload failures
  • Investigate note creation delays and editor issues
  • Identify the responsible team for Epic handoff failures
jeremylongshore/tons-of-skills-marketplace2.9KUpdated Oct 23, 2026

Map and review an Abridge clinical documentation workflow from consent and recording through draft review, evidence checks, edits, and final disposition. Keep clinician approval explicit, identify failure exits, and separate verified facts from tenant-specific details and pending approvals.

  • Map a clinical note workflow for a care setting
  • Check where consent and patient identity are verified
  • Review draft notes against linked evidence before sign-off
jeremylongshore/tons-of-skills-marketplace2.9KUpdated Oct 23, 2026

Audit how clinician-reviewed Abridge note sections map into Epic templates and downstream workflows. Use approved test records to document destinations, exceptions, evidence, rollback steps, and a go or no-go decision for a specific environment.

  • Checking Abridge note section mappings to Epic templates
  • Auditing a department’s approved documentation handoff
  • Preparing test evidence and a go or no-go decision
jeremylongshore/tons-of-skills-marketplace2.9KUpdated Oct 23, 2026

Review Abridge adoption and workflow value using local usage records, clinician feedback, and verified contract costs. Build an evidence based decision table covering adoption, quality, support burden, and options to expand, hold, or improve the rollout.

  • Reviewing adoption after an Abridge rollout
  • Preparing evidence for a renewal decision
  • Comparing workflow outcomes across care settings
jeremylongshore/tons-of-skills-marketplace2.9KUpdated Oct 23, 2026

Prepare a bounded support bundle for an Abridge issue using allowlisted operational details such as versions, coarse timestamps, and correlation references. Exclude recordings, transcripts, patient identifiers, credentials, and unrestricted logs, then document redactions and review details.

  • Preparing reviewed evidence for an Abridge support case
  • Documenting redactions and excluded data
  • Collecting approved operational details for an incident
jeremylongshore/tons-of-skills-marketplace2.9KUpdated Oct 23, 2026

See all skills by jeremylongshore

Report a problem with this skill