Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/knoxpo/dart_algolia

[Unofficial] Algolia is a pure dart SDK, wrapped around Algolia REST API for easy implementation for your Flutter or Dart projects.
https://github.com/knoxpo/dart_algolia
algolia algolia-search algoliasearch dart flutter knoxpo sdk
Last synced: 3 days ago
JSON representation
[Unofficial] Algolia is a pure dart SDK, wrapped around Algolia REST API for easy implementation for your Flutter or Dart projects.
Host: GitHub
URL: https://github.com/knoxpo/dart_algolia
Owner: knoxpo
License: other
Created: 2018-12-19T14:04:38.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-06-29T07:56:12.000Z (7 months ago)
Last Synced: 2025-01-24T12:07:39.434Z (10 days ago)
Topics: algolia, algolia-search, algoliasearch, dart, flutter, knoxpo, sdk
Language: Dart
Homepage:
Size: 144 KB
Stars: 118
Watchers: 10
Forks: 116
Open Issues: 39
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project

README

        # Algolia Search (Dart Client)

![Algolia](https://res.cloudinary.com/hilnmyskv/image/upload/q_auto/v1614950376/Algolia_com_Website_assets/images/shared/algolia_logo/logo-algolia-nebula-blue-full.svg 'Algolia')

**[UNOFFICIAL]** Algolia is a pure dart SDK, wrapped around Algolia REST API for easy implementation for your Flutter or Dart projects.

[![pub package](https://img.shields.io/pub/v/algolia.svg)](https://pub.dartlang.org/packages/algolia)  [![.github/workflows/dart.yml](https://github.com/knoxpo/dart_algolia/actions/workflows/dart.yml/badge.svg)](https://github.com/knoxpo/dart_algolia/actions/workflows/dart.yml) [![Build Status](https://travis-ci.com/knoxpo/dart_algolia.svg?branch=master)](https://travis-ci.com/knoxpo/dart_algolia)

[Pub](https://pub.dartlang.org/packages/algolia) - [API Docs](https://pub.dartlang.org/documentation/algolia/latest/) - [GitHub](https://github.com/knoxpo/dart_algolia)

## Features

- Query / Search / Similar Query

- Get Object

- Add Object

- Add Objects

- Replace all objects in an Index

- Update Object

- Partial Update Object

- Delete Object

- Perform Batch Activities

- Add Index

- Delete Index

- Clear Index

- Copy Index

- Move Index

- Index Settings

- Push Insights Events

## Version compatibility

See CHANGELOG for all breaking (and non-breaking) changes.

## Become Contributor

If you wish to contribute in our development process, refer to our [Contributing Guidelines](https://github.com/knoxpo/dart_algolia/blob/master/CONTRIBUTING.md)

## Getting started

You should ensure that you add the router as a dependency in your flutter project.

```yaml

dependencies:

 algolia: ^1.1.2

```

You should then run `flutter packages upgrade` or update your packages in IntelliJ.

## Example Project

There is a pretty sweet example project in the `example` folder. Check it out. Otherwise, keep reading to get up and running.

## Setting up

```dart

  ///

  /// Initiate static Algolia once in your project.

  ///

  class Application {

    static final Algolia algolia = Algolia.init(

      applicationId: 'YOUR_APPLICATION_ID',

      apiKey: 'YOUR_API_KEY',

    );

  }

  

  void main() async {

    ///

    /// Initiate Algolia in your project

    ///

    Algolia algolia = Application.algolia;

    ///

    /// Perform Query

    ///

    AlgoliaQuery query = algolia.instance.index('contacts').query('john');

    // Perform multiple facetFilters

    query = query.facetFilter('status:published');

    query = query.facetFilter('isDelete:false');

    // Get Result/Objects

    AlgoliaQuerySnapshot snap = await query.getObjects();

    // Checking if has [AlgoliaQuerySnapshot]

    print('Hits count: ${snap.nbHits}');

    ///

    /// Perform Index Settings

    ///

    AlgoliaIndexSettings settingsRef = algolia.instance.index('contact').settings;

    // Get Settings

    Map currentSettings = await settingsRef.getSettings();

    // Checking if has [Map]

    print('\n\n');

    print(currentSettings);

    // Set Settings

    AlgoliaSettings settingsData = settingsRef;

    settingsData = settingsData.setReplicas(const ['index_copy_1', 'index_copy_2']);

    AlgoliaTask setSettings = await settingsData.setSettings();

    // Checking if has [AlgoliaTask]

    print('\n\n');

    print(setSettings.data);

    // Pushing Event

    AlgoliaEvent event = AlgoliaEvent(

      eventType: AlgoliaEventType.view,

      eventName: 'View contact',

      index: 'contacts',

      userToken: 'user123',

    );

    await algolia.instance.pushEvents([event]);

  }

```

## Insights

The Insights API lets you push a collection of events related to how your product is being used. Sending those events is a required step for using several Algolia features like Click analytics, A/B Testing, Personalization and Dynamic Re-Ranking.

- `.pushEvents(List events)`

## Search Parameters

Here is the list of parameters you can use with the search method (search scope).

We have managed to include most commonly used parameters for search functionality

and there many more to be added in future releases.

We have indicated counts of queryable parameters with their availability status

on official Algolia website and what we have managed to support it in this

version of the release.

##### search (1/1)

- `.query(String value)`

- `.similarQuery(String value)`

##### attributes (2/2)

- `.setAttributesToRetrieve(List value)`

- `.setRestrictSearchableAttributes(List value)`

##### filtering (6/6)

- `.filters(String value)`

- `.facetFilter(dynamic value)` This can be used multiple times in a query.

- `.setOptionalFilter(String value)` This can be used multiple times in a query.

- `.setNumericFilter(String value)` This can be used multiple times in a query.

- `.setTagFilter(String value)` This can be used multiple times in a query.

- `.setSumOrFiltersScore(bool value)`

##### faceting (4/4)

- `.setFacets(List value)`

- `.setMaxValuesPerFacet(int value)`

- `.setFacetingAfterDistinct({bool enable = true})`

- `.setSortFacetValuesBy(AlgoliaSortFacetValuesBy value)`

##### highlighting-snippeting (6/6)

- `.setAttributesToHighlight(List value)`

- `.setAttributesToSnippet(List value)`

- `.setHighlightPreTag(String value)`

- `.setHighlightPostTag(String value)`

- `.setSnippetEllipsisText(String value)`

- `.setRestrictHighlightAndSnippetArrays({bool enable = true})`

##### pagination (4/4)

- `.setPage(int value)`

- `.setHitsPerPage(int value)`

- `.setOffset(int value)`

- `.setLength(int value)`

##### typos (5/5)

- `.setMinWordSizeFor1Typo(int value)`

- `.setMinWordSizeFor2Typos(int value)`

- `.setTypoTolerance(dynamic value)`

- `.setAllowTyposOnNumericTokens(bool value)`

- `.setDisableTypoToleranceOnAttributes(List value)`

##### geo-search (7/7)

- `.setAroundLatLng(String value)`

- `.setAroundLatLngViaIP(bool value)`

- `.setAroundRadius(dynamic value)`

- `.setAroundPrecision(int value)`

- `.setMinimumAroundRadius(int value)`

- `.setInsideBoundingBox(List value)`

- `.setInsidePolygon(List value)`

##### languages (8/11)

- `.setIgnorePlurals(dynamic value)`

- `.setRemoveStopWords(dynamic value)`

- `.setCamelCaseAttributes(List value)`

- `.setDecompoundedAttributes(dynamic value)`

- `.setkeepDiacriticsOnCharacters(String value)`

- `.setQueryLanguages(List value)`

- `.setIndexLanguages(List value)`

- `.setNaturalLanguages(List value)`

##### query-rules (3/3)

- `.setEnableRules({bool enabled = false})`

- `.setFilterPromotes({bool enabled = false})`

- `.setRuleContexts(List value)`

##### personalization (3/3)

- `.setEnablePersonalization({bool enabled = false})`

- `.setPersonalizationImpact({required int value})`

- `.setUserToken({required String value})`

##### query-strategy (7/7)

- `.setQueryType(QueryType value)`

- `.setRemoveWordsIfNoResults(RemoveWordsIfNoResults value)`

- `.setAdvancedSyntax({bool enabled = false})`

- `.setOptionalWords(List value)`

- `.setDisablePrefixOnAttributes(List value)`

- `.setDisableExactOnAttributes(List value)`

- `.setExactOnSingleWordQuery(ExactOnSingleWordQuery value)`

##### performance (2/2)

- `.setNumericAttributesForFiltering({required List value})`

- `.setAllowCompressionOfIntegerArray({bool enabled = false})`

##### advanced (11/15)

- `.setAttributeForDistinct(String value)`

- `.setDistinct({dynamic value = 0})`

- `.setGetRankingInfo({bool enabled = true})`

- `.setClickAnalytics({bool enabled = false})`

- `.setAnalytics({bool enabled = false})`

- `.setAnalyticsTags(List value)`

- `.setSynonyms({bool enabled = false})`

- `.setReplaceSynonymsInHighlight({bool enabled = false})`

- `.setMaxFacetHits(int value)`

- `.setPercentileComputation({bool enabled = false})`

- `.setEnableABTest({bool enabled = false})`

##### custom-query (11/15)

- `.custom(String key, dynamic value)`

##### GET RESULT

- `.getObjects()`

## Settings Parameters

Here is the list of parameters you can use with the settings method (settings scope).

We have managed to include most commonly used parameters for settings functionality

and there many more to be added in future releases.

We have indicated counts of settings parameters with their availability status

on official Algolia website and what we have managed to support it in this

version of the release.

##### attributes (4/4)

- `.setSearchableAttributes(List value)`

- `.setAttributesForFaceting(List value)`

- `.setUnretrievableAttributes(List value)`

- `.setAttributesToRetrieve(List value)`

##### ranking (3/3)

- `.setRanking(List value)`

- `.setCustomRanking(List value)`

- `.setReplicas(List value)`

##### faceting (2/2)

- `.setMaxValuesPerFacet(int value)`

- `.setSortFacetValuesBy(AlgoliaSortFacetValuesBy value)`

##### highlighting-snippeting (6/6)

- `.setAttributesToHighlight(List value)`

- `.setAttributesToSnippet(List value)`

- `.setHighlightPreTag(String value)`

- `.setHighlightPostTag(String value)`

- `.setSnippetEllipsisText(String value)`

- `.setRestrictHighlightAndSnippetArrays({bool enable = true})`

##### pagination (2/2)

- `.setHitsPerPage(int value)`

- `.setPaginationLimitedTo(int value)`

##### typos (7/7)

- `.setMinWordSizeFor1Typo(int value)`

- `.setMinWordSizeFor2Typos(int value)`

- `.setTypoTolerance(dynamic value)`

- `.setAllowTyposOnNumericTokens(bool value)`

- `.setDisableTypoToleranceOnAttributes(List value)`

- `.setDisableTypoToleranceOnWords(List value)`

- `.setSeparatorsToIndex(List value)`

##### languages (8/11)

- `.setIgnorePlurals(dynamic value)`

- `.setRemoveStopWords(dynamic value)`

- `.setCamelCaseAttributes(List value)`

- `.setDecompoundedAttributes(dynamic value)`

- `.setkeepDiacriticsOnCharacters(String value)`

- `.setQueryLanguages(List value)`

- `.setIndexLanguages(List value)`

- `.setNaturalLanguages(List value)`

##### query-rules (3/3)

- `.setEnableRules({bool enabled = false})`

- `.setFilterPromotes({bool enabled = false})`

- `.setRuleContexts(List value)`

##### personalization (3/3)

- `.setEnablePersonalization({bool enabled = false})`

- `.setPersonalizationImpact({required int value})`

- `.setUserToken({required String value})`

##### query-strategy (7/7)

- `.setQueryType(QueryType value)`

- `.setRemoveWordsIfNoResults(RemoveWordsIfNoResults value)`

- `.setAdvancedSyntax({bool enabled = false})`

- `.setOptionalWords(List value)`

- `.setDisablePrefixOnAttributes(List value)`

- `.setDisableExactOnAttributes(List value)`

- `.setExactOnSingleWordQuery(ExactOnSingleWordQuery value)`

##### performance (2/2)

- `.setNumericAttributesForFiltering({required List value})`

- `.setAllowCompressionOfIntegerArray({bool enabled = false})`

##### advanced (11/15)

- `.setAttributeForDistinct(String value)`

- `.setDistinct({dynamic value = 0})`

- `.setGetRankingInfo({bool enabled = true})`

- `.setClickAnalytics({bool enabled = false})`

- `.setAnalytics({bool enabled = false})`

- `.setAnalyticsTags(List value)`

- `.setSynonyms({bool enabled = false})`

- `.setReplaceSynonymsInHighlight({bool enabled = false})`

- `.setMaxFacetHits(int value)`

- `.setPercentileComputation({bool enabled = false})`

- `.setEnableABTest({bool enabled = false})`

##### GET Settings

- `.getSettings()`

##### SET Settings

- `.setSettings()`

------

*Algolia [Unofficial SDK for Dart] is a Knoxpo original.*