Skip to main content

Olfeo OEM documentation

SDK download and changelog

SDK Download

In order to download the SDK, log in to our OEM customer portal.

Download the SDK

Discover the SDK with a sample database

About the SDK Changelog

Find below a record of updates, improvements and bug fixes applied to the SDK. It is intended to stay up-to -date with modifications and leveraging new features optimizations, and patches.

1.0.1 - Fev 05, 2024

SDK
  • Validator

    • Fixed an issue with IDNA validation happening even for ascii only domains.

1.0.0 - Dec 13, 2024

This SDK V1.0.0 is a major release, which introduces breaking changes from previous V0.x. Please review carefully and adapt any existing implementation.

In order to migrate from a previous version, a reset of the database is required. Please see our article Migrating to 1.0 for more information.

SDK
  • Metrics

    • Introduced new Recorder interface to collect runtime usage metrics of the Categorizer.

    • Added a default interface that store the metrics in the redis database.

  • Validator

    • Introduced new Validator interface to automatically check and correct categorization inputs.

  • Categorizer

    • Updated Categorizer creation to allow to specify optional Validator and MetricsCollector instances. Defaults are used if no other instance is provided.

  • Database

    • Updated redis data structures from lists to sets to avoid creating duplicates (a reset of the database is required).

Updater
  • Updated redis data structures from lists to sets to avoid creating duplicates (a reset of the database is required).

  • Modified the Updater to collect all recorded runtime usage metrics and forward them to the server after a successful update.

  • Reworked the update process to avoid the possibility of losing updates.

  • Added an option to reduce parallelism of the updating process.

Tooling
  • Tool "add-test-domain"

    • Added the ability to attach multiple application_ids to the same domain.

    • Added the ability to remove the data associated with a given domain.

  • Tool "remove-obsolete-lists"

    • Added a tool to remove obsolete list entries from the database after a successful transition to v1 sets.

Categorize interface
  • Added input validation to the Categorizer interface

Database interface
  • Fixed behavior for GetThemeCategoryIds when the theme is empty.

  • Reinstated a Database interface implementation using github.com/redis/go-redis/v9 as a dependency.

Updater
  • Fixed application metadata to include logo ids if existing

  • Fixed the update process to avoid processing the last update multiple times

  • Optimized the processing of changes in an IP range

Database Interface
  • Redis dependency changed from github.com/redis/go-redis/v9 to github.com/redis/rueidis.

  • Application logo information is now available through the SDK.

Tooling
  • A new binary is included in the release: olfeo-tools that allows adding domain data to an existing redis database.

Categorizer interface
  • Added tracing to the method GetAdvancedDomainInfo.

Database interface
  • Changed how domain theme information is provided.

  • Added new methods to Database interface: GetThemeInfo, GetThemeInfoList, GetThemeIds and GetThemeCategoryIds.

Interface Database
  • Adding a  HealthCheck method to the Database interface

Ip_ranges
  • Integrated an Ip Range matcher to the SDK

Database interface
  • Better output for unknown applications.