@chelseaapps/recommender documentation

This module is a wrapper service around the Recombee NodeJS library. It aims to adapt the Recombee library to suit the needs of Chelsea Apps projects.

Installation

The project is hosted on npm, so to install simply run

npm

npm i @chelseaapps/recommender

yarn

yarn add @chelseaapps/recommender

Configuration

The module can be imported either globally or restricted to a single module scope. The default option is global, as this allows the module to be used across multiple modules without having to configure it multiple times.

Config options

Option	Description	Example
isGlobal	Register the module globally across all modules in the app	true
databaseID	Recombee database ID	uplevyl-dev
privateToken	Recombee private token (generated in the dashboard)	****
scenarios > main	Main items to user Recombee scenario	homepage
scenarios > search	Search Recombee scenario	search
scenarios > users	Users to user Recombee scenario	connections
scenarios > items	Items to items Recombee scenario	items
cache > enabled	Should the recommendation results from the Recombee API be cached in Redis?	true
cache > ttl	How long should recommendation responses be held in the cache (milliseconds)	30000
cache > redis > host	Redis host for caching	localhost
cache > redis > port	Redis port for caching	6379

The module can be configured in two ways:

• Regular

• Asynchronous

Regular config

Import the module into the module in which you wish to register, and call the static register function.

import { Module } from '@nestjs/common';
import { RecommenderModule } from '@chelseaapps/recommender';

@Module({
    imports: [
        ... other imports here
        RecommenderModule.register({
            isGlobal: true,
            databaseID: "",
            privateToken: "",
            scenarios: {
                main: "",
                search: "",
                users: "",
                items: "",
            },
            cache: {
                enabled: true,
                ttl: 30000,
                redis: {
                    host: "localhost",
                    port: 6379,
                },
            },
        }),
    ],
    controllers: [],
    providers: [],
})
export class AppModule {}

Asynchronous config

The module can also be registered asynchronously to create the module dynamically, fetching configuration details from an external source (such as an environment variable).

import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { RecommenderModule } from '@chelseaapps/recommender';

@Module({
    imports: [
        RecommenderModule.registerAsync({
            isGlobal: true,
            imports: [ConfigModule],
            useFactory: (configService: ConfigService) => ({
                databaseID: configService.get('RECOMBEE_DATABASE_ID')!,
                privateToken: configService.get('RECOMBEE_PRIVATE_TOKEN')!,
                scenarios: {
                    main: configService.get('RECOMBEE_SCENARIO')!,
                    search: configService.get('RECOMBEE_SEARCH_SCENARIO')!,
                    users: configService.get('RECOMBEE_USERS_SCENARIO')!,
                    items: configService.get('RECOMBEE_ITEMS_SCENARIO')!,
                },
                cache: {
                    enabled: false,
                    ttl: 30000,
                    redis: {
                        host: configService.get('REDIS_HOST') ?? 'localhost',
                        port: configService.get('REDIS_PORT') ?? 6379,
                    },
                },
            }),
            inject: [ConfigService],
        }),
    ],
    controllers: [],
    providers: [],
})
export class AppModule {}

Usage

Import the RecommenderService into a module using the Nest depedency injection mechanism.

import { RecommenderService} from "@chelseaapps/recommender"

@Injectable()
export class UserService {
    constructor(
        private recommenderService: RecommenderService,
    ) {}

    ...
}