{"_id":"@adaas/auxta","_rev":"6-0d3c7995b8e5458e23cc407f909ae88d","name":"@adaas/auxta","dist-tags":{"latest":"0.0.9"},"versions":{"0.0.4":{"name":"@adaas/auxta","version":"0.0.4","keywords":["sdk","ai","rag"],"author":{"name":"adaas.org"},"license":"ISC","_id":"@adaas/auxta@0.0.4","maintainers":[{"name":"andrew-adaas","email":"andrew.t@adaas.org"}],"homepage":"https://github.com/ADAAS-org/adaas-auxta#readme","bugs":{"url":"https://github.com/ADAAS-org/adaas-auxta/issues"},"dist":{"shasum":"c0a555cd12bd42c9d4b3968b21731bea4085054c","tarball":"https://registry.npmjs.org/@adaas/auxta/-/auxta-0.0.4.tgz","fileCount":178,"integrity":"sha512-ff3RDhc2haScjMBfM0eB3I+Q8PiSFN9Mpl9aMAhCWL7tlRJz70VUGWu3b3l3/6LjenGoyj+6jcMMcCrzj5aIRA==","signatures":[{"sig":"MEUCIGOwC+UfCSSyk/AgwaB+oVOghxuR1+tpCnj6+d0uLoGiAiEAkiN/IfiOwv0e0ThAUZEZIj3wJqTV/p0CjT5TA01bd5s=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":288586},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","gitHead":"514437d1c70402f989deff08fb7e10a036193232","scripts":{"test":"jest","build":"tsc --declaration --project tsconfig.build.json && tscpaths -p tsconfig.build.json -s ./ -o ./dist","start":"nodemon ./index.ts","publish":"npm run build && git add . && git commit -m \"new version created :: $(cat package.json | grep version | head -1  | awk -F: '{ print $2 }'  | sed 's/[\",]//g')\" && npm version patch && npm publish --access public","version":"echo git add .","test:unit":"jest tests/unit","preversion":"npm run test:unit","postversion":"git push --no-verify && git push --tags --no-verify && echo \"\n======Version Pushed Successfully=====\n\" ","echo-version":"echo $npm_package_version","test:integration":"jest tests/integration"},"_npmUser":{"name":"andrew-adaas","actor":{"name":"andrew-adaas","type":"user","email":"andrew.t@adaas.org"},"email":"andrew.t@adaas.org"},"repository":{"url":"git+https://github.com/ADAAS-org/adaas-auxtas.git","type":"git"},"_npmVersion":"10.2.3","description":"SDK for Auxta DB to connect and operate ","directories":{"doc":"docs","test":"tests"},"_nodeVersion":"20.10.0","dependencies":{},"nodemonConfig":{"ext":"ts, js","exec":"node -r tsconfig-paths/register -r ts-node/register ","watch":["examples","src"],"ignore":["**/*.test.ts","**/*.spec.ts",".git","node_modules"]},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.0","jest":"^29.7.0","mocha":"^10.4.0","dotenv":"^16.4.5","nodemon":"^3.1.4","ts-jest":"^29.1.2","ts-node":"^10.9.2","tscpaths":"^0.0.9","@types/chai":"^4.3.14","@types/jest":"^29.5.12","@types/mocha":"^10.0.6","tsconfig-paths":"^4.2.0"},"_npmOperationalInternal":{"tmp":"tmp/auxta_0.0.4_1751675335424_0.06087281092143715","host":"s3://npm-registry-packages-npm-production"}},"0.0.5":{"name":"@adaas/auxta","version":"0.0.5","keywords":["sdk","ai","rag"],"author":{"name":"adaas.org"},"license":"ISC","_id":"@adaas/auxta@0.0.5","maintainers":[{"name":"andrew-adaas","email":"andrew.t@adaas.org"}],"homepage":"https://github.com/ADAAS-org/adaas-auxta#readme","bugs":{"url":"https://github.com/ADAAS-org/adaas-auxta/issues"},"dist":{"shasum":"e075da6dc06e52481e19c2f31e9457be7e40c1f8","tarball":"https://registry.npmjs.org/@adaas/auxta/-/auxta-0.0.5.tgz","fileCount":178,"integrity":"sha512-SAjk72XaDEzjWdqG19pmxdPOQOw4fLu4k6uMiD1mnVzW7pDiOjNGw8EpF1kPcTJHmrv3ZgHatTfabvMZRggMOg==","signatures":[{"sig":"MEYCIQDLViAAI+uH3zEZoz+Ml4N6x9Uc0CwXo4SCtvSeeYeNhwIhAJa4IiqX4Cmhehs4IK4z+XygIefxsQjrXuy3gG9zOKAL","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":289331},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","gitHead":"c02297e0edf4ab11f5429e2d07a28c32a300e927","scripts":{"test":"jest","build":"tsc --declaration --project tsconfig.build.json && tscpaths -p tsconfig.build.json -s ./ -o ./dist","start":"nodemon ./index.ts","publish":"npm run build && git add . && git commit -m \"new version created :: $(cat package.json | grep version | head -1  | awk -F: '{ print $2 }'  | sed 's/[\",]//g')\" && npm version patch && npm publish --access public","version":"echo git add .","test:unit":"jest tests/unit","preversion":"npm run test:unit","postversion":"git push --no-verify && git push --tags --no-verify && echo \"\n======Version Pushed Successfully=====\n\" ","echo-version":"echo $npm_package_version","test:integration":"jest tests/integration"},"_npmUser":{"name":"andrew-adaas","email":"andrew.t@adaas.org"},"repository":{"url":"git+https://github.com/ADAAS-org/adaas-auxtas.git","type":"git"},"_npmVersion":"10.2.3","description":"SDK for Auxta DB to connect and operate ","directories":{"doc":"docs","test":"tests"},"_nodeVersion":"20.10.0","dependencies":{},"nodemonConfig":{"ext":"ts, js","exec":"node -r tsconfig-paths/register -r ts-node/register ","watch":["examples","src"],"ignore":["**/*.test.ts","**/*.spec.ts",".git","node_modules"]},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.0","jest":"^29.7.0","mocha":"^10.4.0","dotenv":"^16.4.5","nodemon":"^3.1.4","ts-jest":"^29.1.2","ts-node":"^10.9.2","tscpaths":"^0.0.9","@types/chai":"^4.3.14","@types/jest":"^29.5.12","@types/mocha":"^10.0.6","tsconfig-paths":"^4.2.0"},"_npmOperationalInternal":{"tmp":"tmp/auxta_0.0.5_1753552371063_0.2242016848921875","host":"s3://npm-registry-packages-npm-production"}},"0.0.6":{"name":"@adaas/auxta","version":"0.0.6","keywords":["sdk","ai","rag"],"author":{"name":"adaas.org"},"license":"ISC","_id":"@adaas/auxta@0.0.6","maintainers":[{"name":"andrew-adaas","email":"andrew.t@adaas.org"}],"homepage":"https://github.com/ADAAS-org/adaas-auxta#readme","bugs":{"url":"https://github.com/ADAAS-org/adaas-auxta/issues"},"dist":{"shasum":"2f0333dcfa45d2d3f11c9b4af1cfbe4f3147e97e","tarball":"https://registry.npmjs.org/@adaas/auxta/-/auxta-0.0.6.tgz","fileCount":178,"integrity":"sha512-1j5kzim8x78l2LYGSUQRLJt9bJ3mH0E+2uWfwMMYGteYkiLEN+duTjsLub2T81Z1MbzxNyUcsZMc9zvVvQWGiQ==","signatures":[{"sig":"MEQCIGy8FAjmyLxn8j5BypWKP6Pqf/TJTSz6WPoFmN5DPjfRAiB8sZhDawlmfXweBS1pGHyILkgOmcwuk19nHSG+F50S3g==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":289851},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","gitHead":"83ce71c434f8bbcb6dd426d668bb97f29864f7de","scripts":{"test":"jest","build":"tsc --declaration --project tsconfig.build.json && tscpaths -p tsconfig.build.json -s ./ -o ./dist","start":"nodemon ./index.ts","publish":"npm run build && git add . && git commit -m \"new version created :: $(cat package.json | grep version | head -1  | awk -F: '{ print $2 }'  | sed 's/[\",]//g')\" && npm version patch && npm publish --access public","version":"echo git add .","test:unit":"jest tests/unit","preversion":"npm run test:unit","postversion":"git push --no-verify && git push --tags --no-verify && echo \"\n======Version Pushed Successfully=====\n\" ","echo-version":"echo $npm_package_version","test:integration":"jest tests/integration"},"_npmUser":{"name":"andrew-adaas","email":"andrew.t@adaas.org"},"repository":{"url":"git+https://github.com/ADAAS-org/adaas-auxtas.git","type":"git"},"_npmVersion":"10.2.3","description":"SDK for Auxta DB to connect and operate ","directories":{"doc":"docs","test":"tests"},"_nodeVersion":"20.10.0","dependencies":{},"nodemonConfig":{"ext":"ts, js","exec":"node -r tsconfig-paths/register -r ts-node/register ","watch":["examples","src"],"ignore":["**/*.test.ts","**/*.spec.ts",".git","node_modules"]},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.0","jest":"^29.7.0","mocha":"^10.4.0","dotenv":"^16.4.5","nodemon":"^3.1.4","ts-jest":"^29.1.2","ts-node":"^10.9.2","tscpaths":"^0.0.9","@types/chai":"^4.3.14","@types/jest":"^29.5.12","@types/mocha":"^10.0.6","tsconfig-paths":"^4.2.0"},"_npmOperationalInternal":{"tmp":"tmp/auxta_0.0.6_1753552631129_0.2316253250365672","host":"s3://npm-registry-packages-npm-production"}},"0.0.7":{"name":"@adaas/auxta","version":"0.0.7","keywords":["auxta","sdk","vector-database","ai-powered","matchmaking","auctions","ai","typescript","javascript"],"author":{"name":"ADAAS YAZILIM LİMİTED ŞİRKETİ","email":"contact-us@adaas.org"},"license":"Apache-2.0","_id":"@adaas/auxta@0.0.7","maintainers":[{"name":"andrew-adaas","email":"andrew.t@adaas.org"}],"homepage":"https://github.com/Auxta-DB/adaas-auxta#readme","bugs":{"url":"https://github.com/Auxta-DB/adaas-auxta/issues"},"dist":{"shasum":"8823324632b84af519421bc3a28250125313e4d2","tarball":"https://registry.npmjs.org/@adaas/auxta/-/auxta-0.0.7.tgz","fileCount":76,"integrity":"sha512-nAYmE2dX5qwyz7gdXBl338BV3C6yQkVOGkB4nW1Qd8A3oO25lSKsaFHiFFvDvxp0oeWVExEiLLW02NmcPy6KYA==","signatures":[{"sig":"MEUCIF1Qd+EaQUb2Dl2syyD8qYTDsQZw3rBhfcPPiOSMkZBoAiEAv/m6jolcGghsAab8+eya8kJkOof9cPsDxCFddsbrDKU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":236985},"exports":{".":{"node":{"types":"./dist/node/index.d.ts","import":"./dist/node/index.mjs","require":"./dist/node/index.cjs"},"browser":{"types":"./dist/browser/index.d.mts","import":"./dist/browser/index.mjs"},"default":{"types":"./dist/node/index.d.ts","import":"./dist/node/index.mjs","require":"./dist/node/index.cjs"}}},"scripts":{"test":"jest","build":"tsup --config tsup.config.ts","start":"nodemon ./index.ts","release":"npm run test && npm run build && git add . && git commit -m \"new version created :: $(cat package.json | grep version | head -1  | awk -F: '{ print $2 }'  | sed 's/[\",]//g')\" && npm version patch && npm publish --access public","version":"echo git add .","test:unit":"jest tests/unit","postversion":"git push --no-verify && git push --tags --no-verify && echo \"\n======Version Pushed Successfully=====\n\" ","echo-version":"echo $npm_package_version","test:integration":"jest tests/integration"},"_npmUser":{"name":"andrew-adaas","email":"andrew.t@adaas.org"},"repository":{"url":"git+https://github.com/Auxta-DB/adaas-auxta.git","type":"git"},"_npmVersion":"10.9.3","description":"Auxta SDK is a library to interact with Auxta, an AI-powered vector database. It provides a simple and intuitive interface for developers to perform operations such as querying, inserting, and managing data in Auxta.","directories":{"doc":"docs","test":"tests"},"sideEffects":false,"_nodeVersion":"22.20.0","dependencies":{},"nodemonConfig":{"ext":"ts, js","exec":"node -r tsconfig-paths/register -r ts-node/register ","watch":["src","examples"],"ignore":["**/*.test.ts","**/*.spec.ts",".git","node_modules"]},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.0","jest":"^29.7.0","tsup":"^8.5.0","mocha":"^10.4.0","dotenv":"^16.4.5","nodemon":"^3.1.4","ts-jest":"^29.1.2","ts-node":"^10.9.2","tscpaths":"^0.0.9","@types/chai":"^4.3.14","@types/jest":"^29.5.14","@types/node":"^24.9.1","@types/mocha":"^10.0.6","tsconfig-paths":"^4.2.0"},"_npmOperationalInternal":{"tmp":"tmp/auxta_0.0.7_1773254521862_0.9594945797800967","host":"s3://npm-registry-packages-npm-production"}},"0.0.8":{"name":"@adaas/auxta","version":"0.0.8","keywords":["auxta","sdk","vector-database","ai-powered","matchmaking","auctions","ai","typescript","javascript"],"author":{"name":"ADAAS YAZILIM LİMİTED ŞİRKETİ","email":"contact-us@adaas.org"},"license":"Apache-2.0","_id":"@adaas/auxta@0.0.8","maintainers":[{"name":"andrew-adaas","email":"andrew.t@adaas.org"}],"homepage":"https://github.com/Auxta-DB/adaas-auxta#readme","bugs":{"url":"https://github.com/Auxta-DB/adaas-auxta/issues"},"dist":{"shasum":"165452e391564fce76521afadb371562d363a181","tarball":"https://registry.npmjs.org/@adaas/auxta/-/auxta-0.0.8.tgz","fileCount":12,"integrity":"sha512-wJVFuXcgWzsLW7GjcJVeQgniz2KSusXL0Bh6g9DveK4/FhyAPycwTWhnlzjfq1ajch5BnbFn0IM1og4DiB+fzw==","signatures":[{"sig":"MEUCIQCiBrfiZ/6Zxqhb1tMUhACaxCN5glc0IaqeBxV5r2UQhgIgMkSK+VzK/8OVOv82M34N10ERWSZcu1JIfDGDwE841jY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":865514},"main":"./dist/node/index.cjs","types":"./dist/node/index.d.ts","module":"./dist/node/index.mjs","exports":{".":{"node":{"types":{"import":"./dist/node/index.d.mts","require":"./dist/node/index.d.ts"},"import":"./dist/node/index.mjs","require":"./dist/node/index.cjs"},"browser":{"types":"./dist/browser/index.d.mts","import":"./dist/browser/index.mjs"},"default":{"types":"./dist/node/index.d.ts","import":"./dist/node/index.mjs","require":"./dist/node/index.cjs"}}},"scripts":{"test":"jest","build":"tsup --config tsup.config.ts","start":"nodemon ./index.ts","release":"npm run test && npm run build && git add . && git commit -m \"new version created :: $(cat package.json | grep version | head -1  | awk -F: '{ print $2 }'  | sed 's/[\",]//g')\" && npm version patch && npm publish --access public","version":"echo git add .","test:unit":"jest tests/unit","postversion":"git push --no-verify && git push --tags --no-verify && echo \"\n======Version Pushed Successfully=====\n\" ","echo-version":"echo $npm_package_version","test:integration":"jest tests/integration"},"_npmUser":{"name":"andrew-adaas","email":"andrew.t@adaas.org"},"repository":{"url":"git+https://github.com/Auxta-DB/adaas-auxta.git","type":"git"},"_npmVersion":"10.9.3","description":"Auxta SDK is a library to interact with Auxta, an AI-powered vector database. It provides a simple and intuitive interface for developers to perform operations such as querying, inserting, and managing data in Auxta.","directories":{"doc":"docs","test":"tests"},"sideEffects":false,"_nodeVersion":"22.20.0","dependencies":{},"nodemonConfig":{"ext":"ts, js","exec":"node -r tsconfig-paths/register -r ts-node/register ","watch":["src","examples"],"ignore":["**/*.test.ts","**/*.spec.ts",".git","node_modules"]},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.0","jest":"^29.7.0","tsup":"^8.5.0","mocha":"^10.4.0","dotenv":"^16.4.5","nodemon":"^3.1.4","ts-jest":"^29.1.2","ts-node":"^10.9.2","tscpaths":"^0.0.9","@types/chai":"^4.3.14","@types/jest":"^29.5.14","@types/node":"^24.9.1","@types/mocha":"^10.0.6","tsconfig-paths":"^4.2.0"},"_npmOperationalInternal":{"tmp":"tmp/auxta_0.0.8_1773254665379_0.9885614463667391","host":"s3://npm-registry-packages-npm-production"}},"0.0.9":{"name":"@adaas/auxta","version":"0.0.9","description":"Auxta SDK is a library to interact with Auxta, an AI-powered vector database. It provides a simple and intuitive interface for developers to perform operations such as querying, inserting, and managing data in Auxta.","license":"Apache-2.0","author":{"name":"ADAAS YAZILIM LİMİTED ŞİRKETİ","email":"contact-us@adaas.org"},"homepage":"https://github.com/Auxta-DB/adaas-auxta#readme","repository":{"type":"git","url":"git+https://github.com/Auxta-DB/adaas-auxta.git"},"keywords":["auxta","sdk","vector-database","ai-powered","matchmaking","auctions","ai","typescript","javascript"],"bugs":{"url":"https://github.com/Auxta-DB/adaas-auxta/issues"},"main":"./dist/node/index.cjs","module":"./dist/node/index.mjs","types":"./dist/node/index.d.ts","exports":{".":{"browser":{"types":"./dist/browser/index.d.mts","import":"./dist/browser/index.mjs"},"node":{"types":{"import":"./dist/node/index.d.mts","require":"./dist/node/index.d.ts"},"import":"./dist/node/index.mjs","require":"./dist/node/index.cjs"},"default":{"types":"./dist/node/index.d.ts","import":"./dist/node/index.mjs","require":"./dist/node/index.cjs"}}},"sideEffects":false,"nodemonConfig":{"ignore":["**/*.test.ts","**/*.spec.ts",".git","node_modules"],"watch":["src","examples"],"exec":"node -r tsconfig-paths/register -r ts-node/register ","ext":"ts, js"},"scripts":{"start":"nodemon ./index.ts","release":"npm run test && npm run build && git add . && git commit -m \"new version created :: $(cat package.json | grep version | head -1  | awk -F: '{ print $2 }'  | sed 's/[\",]//g')\" && npm version patch && npm publish --access public","version":"echo git add .","postversion":"git push --no-verify && git push --tags --no-verify && echo \"\n======Version Pushed Successfully=====\n\" ","echo-version":"echo $npm_package_version","build":"tsup --config tsup.config.ts","test":"jest","test:unit":"jest tests/unit","test:integration":"jest tests/integration"},"dependencies":{},"devDependencies":{"@types/chai":"^4.3.14","@types/jest":"^29.5.14","@types/mocha":"^10.0.6","@types/node":"^24.9.1","chai":"^5.1.0","dotenv":"^16.4.5","jest":"^29.7.0","mocha":"^10.4.0","nodemon":"^3.1.4","ts-jest":"^29.1.2","ts-node":"^10.9.2","tsconfig-paths":"^4.2.0","tscpaths":"^0.0.9","tsup":"^8.5.0"},"directories":{"doc":"docs","test":"tests"},"_id":"@adaas/auxta@0.0.9","_nodeVersion":"22.20.0","_npmVersion":"10.9.3","dist":{"integrity":"sha512-jMtoWtO7MiUGdF3rLESUkHaXCRSR9BPiCCTcSnVldSdMnuIvlEWN2rnhqaMl9ZtzR++MIx9I7SRSNlsuLGmTEA==","shasum":"5f81b17231c028bed8787f0b6761da0187456479","tarball":"https://registry.npmjs.org/@adaas/auxta/-/auxta-0.0.9.tgz","fileCount":12,"unpackedSize":852132,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCZ9EPdXASt47S969QKO668ENFlD1Yn1fGqmTOPLa96KAIgA+C252PiFSopHdNsd13p2pjRT6JoECvIvW70GI0YH08="}]},"_npmUser":{"name":"andrew-adaas","email":"andrew.t@adaas.org"},"maintainers":[{"name":"andrew-adaas","email":"andrew.t@adaas.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/auxta_0.0.9_1773254913566_0.6811383072614037"},"_hasShrinkwrap":false}},"time":{"created":"2025-07-05T00:28:55.001Z","modified":"2026-03-11T18:48:33.898Z","0.0.4":"2025-07-05T00:28:55.612Z","0.0.5":"2025-07-26T17:52:51.246Z","0.0.6":"2025-07-26T17:57:11.329Z","0.0.7":"2026-03-11T18:42:02.014Z","0.0.8":"2026-03-11T18:44:25.536Z","0.0.9":"2026-03-11T18:48:33.760Z"},"bugs":{"url":"https://github.com/Auxta-DB/adaas-auxta/issues"},"author":{"name":"ADAAS YAZILIM LİMİTED ŞİRKETİ","email":"contact-us@adaas.org"},"license":"Apache-2.0","homepage":"https://github.com/Auxta-DB/adaas-auxta#readme","keywords":["auxta","sdk","vector-database","ai-powered","matchmaking","auctions","ai","typescript","javascript"],"repository":{"type":"git","url":"git+https://github.com/Auxta-DB/adaas-auxta.git"},"description":"Auxta SDK is a library to interact with Auxta, an AI-powered vector database. It provides a simple and intuitive interface for developers to perform operations such as querying, inserting, and managing data in Auxta.","maintainers":[{"name":"andrew-adaas","email":"andrew.t@adaas.org"}],"readme":"# 📦 @adaas/auxta\n\n[![npm](https://img.shields.io/npm/v/@adaas/auxta.svg)](https://www.npmjs.com/package/@adaas/auxta)  \n[![Release](https://img.shields.io/github/release/ADAAS-org/adaas-auxta.svg)](https://github.com/ADAAS-org/adaas-auxta/releases)  \n[![LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue)](https://www.linkedin.com/in/your-profile/)  \n[![License](https://img.shields.io/badge/License-MIT-blue)](LICENSE)  \n[![Open Issues](https://img.shields.io/github/issues/ADAAS-org/adaas-auxta.svg)](https://github.com/ADAAS-org/adaas-auxta/issues)  \n[![Documentation](https://img.shields.io/badge/Docs-Read-blue)](https://github.com/ADAAS-org/adaas-auxta/docs)  \n[![Version](https://img.shields.io/badge/Version-1.0.0-green)](https://github.com/ADAAS-org/adaas-auxta/releases/tag/v1.0.0)  \n\n**Auxta DB** is a purpose-built database that combines the strengths of Elasticsearch and Redis, optimized for one task: **fast matching search** across both on-disk and in-memory indexes.\n\nIt allows you to define vectors with **static**, **computed**, and **dynamic** fields — all searchable and filterable at high speed.\n\n*A powerful database solution designed for high-performance context-aware applications.*\nSupports advanced use cases with a developer-friendly SDK and flexible entity modeling.\n\n&#x20;&#x20;\n\n---\n\n## 🧭 Table of Contents\n\n2. [Scenarios & Use Cases](#scenarios--use-cases)\n3. [Entities & Data Model](#entities--data-model)\n4. [Quick Start](#quick-start)\n5. [SDK Usage](#sdk-usage)\n6. [Common Use Cases](#common-use-cases)\n7. [Configuration](#configuration)\n8. [Contributing](#contributing)\n9. [License](#license)\n10. [Contact / Support](#contact--support)\n\n---\n\n## 🚀 Quick Start\n\nReady to get started with `@adaas/auxta`? Here's how to fire it up and run your first search.\n\n### 1. Setup your environment\n\nAdd this to your `.env` file or environment variables:\n\n```env\nAUXTA_SERVER_PORT=5656\nAUXTA_SERVER_HOST=localhost\nAUXTA_SERVER_TOKEN=AUXTA-token:1234-1234-1234-1234\nAUXTA_SERVER_CLIENT=auxta-client\n```\n\nThen, initialize the SDK:\n\n```ts\nimport { Auxta, AuxtaCommand } from '@adaas/auxta';\nimport { RunningTrailVector } from './models';\n\nconst auxta = new Auxta();\n```\n\n### 2. Add your first vector\n\n```ts\nconst trail = new RunningTrailVector({\n  distance: 2222,\n  averageTime: 50,\n  complexity: 'uphill',\n  views: ['rocks', 'mud', 'grass', 'sand'],\n  features: ['water', 'trees', 'mountains'],\n});\n\nconst addCommand = new AuxtaCommand().add(trail);\nawait auxta.query(addCommand);\n\nconsole.log('Trail added!');\n```\n\n### 3. Run a search query with conditions\n\n```ts\nconst searchCommand = new AuxtaCommand()\n  .search(RunningTrailVector)\n  .where('distance', d => d.gte(1000).and().lte(3000))\n  .where('views', v => v.in(['mud', 'rocks']).or().in(['water', 'trees']));\n\nconst results = await auxta.query<RunningTrailVector>(searchCommand);\n\nconsole.log('Search returned', results.length, 'items');\n```\n\nAnd that’s it — you're up and running! 🎉\n\n---\n\n## 🎯 Scenarios & Use Cases\n\n### 1. Dynamic Auctions / Matchmaking\n\nIdeal for short-lived real-time data scenarios such as matchmaking systems in multiplayer games:\n\n* Define a temporary index\n* Add dimensions like rank, experience, subscription type, game mode, etc.\n* Run the auction or matchmaking process\n* Clear the index afterward\n\nUse Case Example: Matching online players into balanced teams based on multiple attributes in real time.\n\n### 2. Buyer-Seller Matching\n\nUseful for marketplace platforms with clear category/tag-based logic, but also influenced by dynamic elements like:\n\n* Real-time budgets\n* Inventory or consumption metrics\n\nUse Case Example: Match service providers with clients based on both fixed profiles and rapidly changing preferences or constraints.\n\n### 3. API Quote Matching Engine\n\nPerfect for metered APIs with quota-limited access:\n\n* Multiple API endpoints share a protocol\n* Quotes are evaluated at runtime\n* Users are only granted access to APIs with available call limits or capacity\n\nUse Case Example: A pricing gateway that selects valid API routes based on real-time usage stats and defined business rules.\n\n---\n\n## 📂 Entities & Data Model\n\n### 1. Indexes\n\nIndexes are the main containers that organize vectors. You can think of them like tables or collections, but optimized for fast matching queries on both disk and memory. Indexes support dynamic creation and deletion, allowing flexible workflows such as temporary auction indices.\n\n### 2. Vectors\n\nVectors represent the data records stored in an index. Each vector consists of multiple fields — these can be static, computed, or dynamic — describing the entity’s attributes. Vectors are the primary objects that you search, add, or update in Auxta.\n\n### 3. Dimensions\n\nDimensions define the searchable properties within vectors. They describe the type, constraints, and how a field participates in search queries, including operators like range filters, sets, or proximity. Dimensions enable fine-grained control over how matching is performed.\n\n---\n\n## 🧰 SDK Usage\n\n*Coming soon: initialization, queries, mutations, and examples.*\n\n---\n\n\n## 📄 License\n\nMIT\n\n---\n\n## 📬 Contact / Support\n\n* Website: [https://adaas.org](https://adaas.org)\n* Email: [support@adaas.dev](mailto:support@adaas.dev)\n* Contact us: [contact-us@adaas.org](mailto:contact-us@adaas.org)\n* Issues: [GitHub Issues](https://github.com/adaas/auxta/issues)\n","readmeFilename":"README.md"}