Index of every page on this site: llms.txt
All skills
jeremylongshore avatar

/algolia-sdk-patterns

@820dfc8
Run it yourself

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".

Use this Skill: https://skilld.dev/gh/jeremylongshore/tons-of-skills-marketplace/algolia-sdk-patterns

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈73 tokens for metadata: the name and description. ≈850 when used: this file. ≈333 more on demand in 1 file.

Description uses 3.6% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈292 characters, or 3.6%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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:

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

Expected handoff:

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

Resources

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning2mo3 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    The skill provides guidelines for refactoring Algolia JavaScript SDK v5 implementations into a centralized adapter pattern. It emphasizes secure credential management and relies on official Algolia documentation. No security issues were detected.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: MEDIUM · 1 issue

Signed by skilld at 820dfc8. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 2 months ago
What it can do
Reads files Network Edits files
Modelinherit
argument-hint
[repository-path] [adapter-module]
version
1.8.0
author
Jeremy Longshore <jeremy@intentsolutions.io>
All 6 allowed tools
ReadGlobGrepWebFetchWriteEdit
Other metadata
tags
[
  "saas",
  "algolia",
  "sdk"
]
model
inherit
effort
medium
compatibility
Designed for Claude Code

README badge

README badge for jeremylongshore/tons-of-skills-marketplace/algolia-sdk-patterns