---
name: algolia-sdk-patterns
description: >-
  Create or review a typed application adapter around the Algolia JavaScript v5 client. Use when client calls, index names, errors, task waits, and credential usage are scattered. Trigger with "Algolia SDK patterns", "Algolia client wrapper", or "refactor search client".
argument-hint: "[repository-path] [adapter-module]"
allowed-tools: Read, Glob, Grep, WebFetch, Write, Edit
version: 1.8.0
author: Jeremy Longshore <jeremy@intentsolutions.io>
license: MIT
tags:
  - saas
  - algolia
  - sdk
model: inherit
effort: medium
compatibility: Designed for Claude Code
title: algolia-sdk-patterns
canonical_url: https://skilld.dev/gh/jeremylongshore/tons-of-skills-marketplace/algolia-sdk-patterns
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-sdk-patterns/references/official-docs.md).
>
> If the user asked to install this Skill, run `npx skilld install jeremylongshore/tons-of-skills-marketplace/algolia-sdk-patterns`. 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-sdk-patterns`, 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-sdk-patterns) 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-sdk-patterns`. 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-sdk-patterns --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/algolia-sdk-patterns --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 v5 SDK Boundary

## Overview

This skill centralizes the application contract around the installed v5 client without hiding important provider results. It keeps search, writes, task waits, and error metadata testable and explicit.

## 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

- Create clients at trust boundaries and inject them into adapters rather than constructing them in every call site.
- For v5, call operations on the client and pass `indexName`; do not restore `initIndex`.
- Return typed application results while preserving request IDs, task IDs, and provider error context.
- Put retry, timeout, batching, and index resolution policies in one reviewed layer.

## Authentication

Accept credentials from the approved runtime configuration and never expose them through adapter return values, exceptions, logs, or browser/server boundary mistakes.

## Instructions

1. Inventory every SDK import, installed version, client construction, index name, and direct call.
2. Group use cases into search, indexing, configuration, events, analytics, or administration boundaries.
3. Define typed inputs and outputs plus explicit timeout, task-wait, and error behavior.
4. Implement the smallest adapter and migrate one caller with contract tests.
5. Test success, authorization denial, timeout, stale task, malformed filters, and cancellation.
6. Migrate remaining callers incrementally and remove duplicate credential or retry logic.

## Approval Boundaries

Do not conceal destructive index operations behind generic methods, silently retry writes, or migrate all callers without a compatibility and rollback plan.

## Output

Return the call-site inventory, adapter API, trust boundaries, migrated callers, contract tests, preserved metadata, and remaining direct-client exceptions.

## Error Handling

| Condition | Response |
|---|---|
| Installed types differ from docs | Follow the lockfile and types; schedule version review separately. |
| Provider error is flattened | Preserve status and correlation metadata. |
| Task wait is omitted | Make completion semantics explicit in write results. |
| Adapter gains unrelated policy | Split the boundary by use case. |

## Examples

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

Input:

```text
module=src/search/algolia.ts; version=5.59.0; callers=14
```

Expected handoff:

```text
adapter=SearchGateway+IndexPublisher; migrated=3; contract-tests=pass; retries=centralized
```

## Resources

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