@elastic-suite/gally-sdk

中文文档
2.3.1发布于 2026/10/13OSL-3.0TypeScriptESM + CJS零依赖近 30 天下载 2050

TypeScript SDK for Gally connectors

原始使用文档
文档目录6 节
  1. Features
  2. Requirements
  3. Installation
  4. Quick Start
  5. License
  6. Need Help?

@elastic-suite/gally-sdk

JS SDK for Gally - a powerful searchandising solution for e-commerce.

The SDK is the foundation to:

  • Build Gally connectors that will interact with Gally using Javascript (using Medusa JS, Strapi, etc...)
  • Implement front-end features that uses Gally (autocomplete, user behavior analytics, etc...)

npm version License: OSL-3.0

Features

✨ Catalog Management - Sync catalogs, metadata, and source fields
🔍 Advanced Search - Full-text search, filtering, faceting, and sorting
📊 Index Operations - Create, bulk-index, and manage search indexes
📈 Event Tracking - Track views, searches, add-to-cart, and orders
🌐 Multi-locale - Support for multiple catalogs and languages
⚡ Performance - Built-in caching, batching, and optimization
🔒 Type-Safe - Full TypeScript support with comprehensive type definitions

Requirements

  • Node.js >= 18.0.0 (uses native fetch)
  • TypeScript >= 5.3 (for development)

Installation

npm install @elastic-suite/gally-sdk

Quick Start

📖 Full documentation - Getting started with the Gally JS SDK

License

OSL-3.0


Need Help?

版本与发布记录

@elastic-suite/gally-sdk 共发布 4 个版本,首次发布于 2026/05/21;过去 12 个月发布了 4 个版本。

版本发布日期距今
2.3.1latest2026/10/131 个月前
2.3.02026/07/273 个月前
2.3.0-alpha-1canary2026/06/304 个月前
2.2.2-alpha.02026/05/215 个月前

关于 @elastic-suite/gally-sdk 的常见问题

@elastic-suite/gally-sdk 是什么?

TypeScript SDK for Gally connectors

如何安装 @elastic-suite/gally-sdk?

在项目目录运行 npm install @elastic-suite/gally-sdk,或使用 pnpm add / yarn add / bun add。

@elastic-suite/gally-sdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@elastic-suite/gally-sdk 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@elastic-suite/gally-sdk 可以商用吗?

@elastic-suite/gally-sdk 使用 OSL-3.0 许可。声明的许可为 OSL-3.0,请阅读许可原文确认使用条件。以上为概括,不构成法律意见,请以许可原文为准。

@elastic-suite/gally-sdk 的下载量有多少?

根据 npm 官方下载统计,@elastic-suite/gally-sdk 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,050 次,日均约 68 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@elastic-suite/gally-sdk 还在维护吗?

最新版本 2.3.1 发布于 2026/10/13(1 个月前);至今共发布 4 个版本,其中过去 12 个月发布了 4 个;首次发布于 2026/05/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。