@sinequa/atomic

A modern TypeScript package designed for use with Sinequa, providing web API helpers, authentication, configurations, and utilities.

Table of Contents

• Features
• Installation
• Usage
• Documentation
• License

Features

• Web API Helpers: Simplify API calls with helpers for aggregations, datasets, preview, principal, query, and more.
• Authentication: Easy-to-use authentication utilities (OAuth, SAML, JWT, CSRF, etc.).
• Configurations: Centralized and type-safe configuration management.
• Helpers & Utilities: Includes bisect, date, logger, syslang, and more.
• Type Definitions: Strongly-typed interfaces for API endpoints and data structures.
• ...and many more functions to help you build with Sinequa.

Explore the full feature set in the online documentation.

Installation

npm install @sinequa/atomic

Usage

Import and use helpers in your TypeScript project:

import { fetchQuery, fetchAggregation, isAuthenticated } from '@sinequa/atomic';

// Example: Fetch data
const data = await fetchQuery({ query: 'example' });

// Example: Check authentication
if (isAuthenticated()) {
  // ...
}

Documentation

Comprehensive documentation is available in the Atomic Documentation Portal.

License

This project is licensed under the MIT License. See the LICENSE file for details.