Skip to content

Elastic-Suite/gally-ts-sdk

Repository files navigation

@gally/sdk

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

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 @gally/sdk

Quick Start

📖 Configuration Guide - Detailed configuration options

2. Sync Catalog Structure

📖 Catalog Synchronization Guide - Complete guide

3. Index Documents

📖 Index Operations Guide - Create indexes, bulk indexing, performance tips

4. Search

📖 Search Guide - Full-text search, filtering, faceting, sorting

5. Track Events

📖 Tracking Events Guide - Complete guide with examples for all event types

Documentation

📚 Full Documentation Wiki

Testing

Integration Tests

The SDK includes integration tests that run against a real Gally instance.

Setup:

cp .env.test.example .env.test
# Edit .env.test with your Gally instance settings
npm run test

License

OSL-3.0


Need Help?

About

TypeScript SDK for Gally

Resources

Code of conduct

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors