{"_id":"@aperio-search/aperio","name":"@aperio-search/aperio","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@aperio-search/aperio","version":"1.0.0","description":"Node.js client for Aperio search engine","license":"MIT","funding":{"type":"github","url":"https://github.com/sponsors/andresribeiro"},"type":"module","main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"import":"./dist/index.js","types":"./dist/index.d.ts"}},"scripts":{"build":"tsc","test":"node --import tsx --test tests/*.test.ts","lint":"biome check src/ tests/","lint:fix":"biome check --write src/ tests/","format":"biome format --write src/ tests/"},"devDependencies":{"@biomejs/biome":"^2.4.16","tsx":"^4.22.3","typescript":"^6.0.3"},"gitHead":"1b179611ca6eacbafef9f53231e1a7464dea3534","_id":"@aperio-search/aperio@1.0.0","_nodeVersion":"24.15.0","_npmVersion":"11.12.1","dist":{"integrity":"sha512-yI4eqt3St3XSFIxGbyfGa5Urx6rSMM6iHc3BoBjiqxkuTmR3RrwVkVcogPMiR/e54+uG6rgHrWjGGEBVW3unfA==","shasum":"dc1fcd9cdb569352df9fb4281dcaf25eab681a4c","tarball":"https://registry.npmjs.org/@aperio-search/aperio/-/aperio-1.0.0.tgz","fileCount":9,"unpackedSize":13082,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDF1MtCTRMjVB4X040WzUIiP6ZKnvEm/zzUmlpOTOKVrQIhANIG/qeefzTiFpVC2pMsXBglMjmv7R/Ww+rBsoBOUuSR"}]},"_npmUser":{"name":"andresribeiro","email":"andresribeiroo@proton.me"},"directories":{},"maintainers":[{"name":"andresribeiro","email":"andresribeiroo@proton.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/aperio_1.0.0_1780675527645_0.12058909103868709"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-05T16:05:27.451Z","1.0.0":"2026-06-05T16:05:27.814Z","modified":"2026-06-05T16:05:28.081Z"},"maintainers":[{"name":"andresribeiro","email":"andresribeiroo@proton.me"}],"description":"Node.js client for Aperio search engine","license":"MIT","readme":"# @aperio-search/aperio\n\nNode.js client for [Aperio](https://aperiosearch.com) — a screamingly fast, ultra-lightweight search engine.\n\n## Installation\n\n```sh\nnpm install @aperio-search/aperio\n```\n\n## Usage\n\n```ts\nimport { AperioClient } from \"@aperio-search/aperio\";\n\nconst client = new AperioClient({\n  baseUrl: \"http://localhost:3000\",\n  apiKey: \"SecretApiKey\",\n});\n\n// Create a collection\nawait client.createCollection({\n  name: \"movies\",\n  idType: \"string\",\n  searchableFields: [\"title\"],\n});\n\n// Index documents\nawait client.upsertItem(\"movies\", { id: \"1\", title: \"the empire strikes back\" });\nawait client.upsertItem(\"movies\", { id: \"2\", title: \"star wars a new hope\" });\nawait client.upsertItem(\"movies\", { id: \"3\", title: \"return of the jedi\" });\n\n// Search\nconst { results } = await client.search(\"movies\", { q: \"star\" });\n\n// Delete\nawait client.deleteItem(\"movies\", \"1\");\nawait client.deleteCollection(\"movies\");\n```\n\n## API\n\n### Collections\n\n| Method | Description |\n|--------|-------------|\n| `listCollections()` | List all collections |\n| `createCollection(req)` | Create a new collection |\n| `getCollection(name)` | Get collection metadata |\n| `deleteCollection(name)` | Delete a collection |\n\n### Documents\n\n| Method | Description |\n|--------|-------------|\n| `upsertItem(collection, doc)` | Insert or update a document |\n| `deleteItem(collection, id)` | Delete a document by ID |\n\n### Search\n\n| Method | Description |\n|--------|-------------|\n| `search(collection, params)` | Full-text search with pagination |\n| `suggest(collection, params)` | Suggest indexed terms matching a prefix |\n\n### Backup\n\n| Method | Description |\n|--------|-------------|\n| `exportBackup()` | Export a database snapshot |\n| `importBackup(name)` | Import a database snapshot |\n\n### Health\n\n| Method | Description |\n|--------|-------------|\n| `status()` | Server health check |\n\n## License\n\nMIT\n","readmeFilename":"README.md","_rev":"1-9ee74033c1b0a6fd3eed0791921f6c02"}