Class RedisRedirectorRepository

Redis-based redirector repository implementation.

Depends:

Validator via VALIDATOR token
Config via CONFIG token
Logger via LOGGER token
DatabaseConnector via DATABASE_CONNECTOR token

Example

import { DIContainer } from '@famir/common'
import { REDIRECTOR_REPOSITORY, RedirectorRepository, RedisRedirectorRepository } from '@famir/database'

// Get container singleton
const container = DIContainer.getInstance()

// Register dependency in container
RedisRedirectorRepository.register(container)

// Resolve dependency from container
const redirectorRepository = container.resolve<RedirectorRepository>(REDIRECTOR_REPOSITORY)

// TODO more examples

Implements

RedirectorRepository

Constructors

constructor

new RedisRedirectorRepository(
    validator: Validator,
    config: Config,
    logger: Logger,
    connector: DatabaseConnector,
): RedisRedirectorRepository
Creates a new redirector repository instance.
Parameters
- validator: Validator
  The validator instance.
- config: Config
  The config instance.
- logger: Logger
  The logger instance.
- connector: DatabaseConnector
  The connector instance.
Returns RedisRedirectorRepository
Overrides RedisBaseRepository.constructor
- Defined in packages/database/src/modules/redirector/redis-redirector.repository.ts:67

Methods

appendField

appendField(
    campaignId: string,
    redirectorId: string,
    field: string,
    lockSecret: string,
): Promise<void>
Appends a required field to the redirector.

When rendering a redirector with required fields, all specified fields must be provided in the parameters. If the fields array is empty, the redirector is 'loose' and accepts any parameters.
Parameters
- campaignId: string
  The ID of the campaign containing the redirector.
- redirectorId: string
  The redirector ID to append field to.
- field: string
  The field name to append to the fields list.
- lockSecret: string
  The campaign lock secret obtained from CampaignRepository.lock.
Returns Promise<void>

Throws
DatabaseError If the campaign does not exist.

Throws
DatabaseError If the campaign is not locked.

Throws
DatabaseError If the campaign lock secret does not match.

Throws
DatabaseError If the redirector does not exist.

Throws
DatabaseError If the data validation fails.
Implementation of RedirectorRepository.appendField
- Defined in packages/database/src/modules/redirector/redis-redirector.repository.ts:150

create

create(
    campaignId: string,
    redirectorId: string,
    page: string,
    lockSecret: string,
): Promise<void>
Creates a new redirector.

The redirector is created with an empty fields array, meaning it is initially 'loose' (accepts any parameters). Use appendField or removeField to manage required fields.
Parameters
- campaignId: string
  The ID of the campaign to create the redirector in.
- redirectorId: string
  The new redirector ID to create.
- page: string
  The page template.
- lockSecret: string
  The campaign lock secret obtained from CampaignRepository.lock.
Returns Promise<void>

Throws
DatabaseError If the campaign does not exist.

Throws
DatabaseError If the campaign is not locked.

Throws
DatabaseError If the campaign lock secret does not match.

Throws
DatabaseError If a redirector with the same ID already exists.

Throws
DatabaseError If the data validation fails.
Implementation of RedirectorRepository.create
- Defined in packages/database/src/modules/redirector/redis-redirector.repository.ts:75

delete

delete(
    campaignId: string,
    redirectorId: string,
    lockSecret: string,
): Promise<void>
Deletes the redirector by its ID.

A redirector cannot be deleted if it has any lures pointing to it.
Parameters
- campaignId: string
  The ID of the campaign containing the redirector.
- redirectorId: string
  The redirector ID to delete.
- lockSecret: string
  The campaign lock secret obtained from CampaignRepository.lock.
Returns Promise<void>

Throws
DatabaseError If the campaign does not exist.

Throws
DatabaseError If the campaign is not locked.

Throws
DatabaseError If the campaign lock secret does not match.

Throws
DatabaseError If the redirector does not exist.

Throws
DatabaseError If the redirector still has lures.

Throws
DatabaseError If the data validation fails.
Implementation of RedirectorRepository.delete
- Defined in packages/database/src/modules/redirector/redis-redirector.repository.ts:196

list

list(campaignId: string): Promise<RedirectorModel[] | null>
Lists all redirectors for the campaign.

Redirectors are ordered by creation time (oldest first).
Parameters
- campaignId: string
  The ID of the campaign to list redirectors for.
Returns Promise<RedirectorModel[] | null>
The array of redirector models, or null if the campaign does not exist.

Throws
DatabaseError If the data validation fails.
Implementation of RedirectorRepository.list
- Defined in packages/database/src/modules/redirector/redis-redirector.repository.ts:213

listFull

listFull(campaignId: string): Promise<FullRedirectorModel[] | null>
Lists all full redirectors for the campaign.

Redirectors are ordered by creation time (oldest first).
Parameters
- campaignId: string
  The ID of the campaign to list redirectors for.
Returns Promise<FullRedirectorModel[] | null>
The array of full redirector models, or null if the campaign does not exist.

Throws
DatabaseError If the data validation fails.
Implementation of RedirectorRepository.listFull
- Defined in packages/database/src/modules/redirector/redis-redirector.repository.ts:238

read

read(campaignId: string, redirectorId: string): Promise<RedirectorModel | null>
Reads the redirector by its ID.
Parameters
- campaignId: string
  The ID of the campaign containing the redirector.
- redirectorId: string
  The redirector ID to read.
Returns Promise<RedirectorModel | null>
The redirector model, or null if the redirector is not found.

Throws
DatabaseError If the data validation fails.
Implementation of RedirectorRepository.read
- Defined in packages/database/src/modules/redirector/redis-redirector.repository.ts:99

readFull

readFull(
campaignId: string,
redirectorId: string,
): Promise<FullRedirectorModel | null>
Reads the full redirector by its ID.
Parameters
- campaignId: string
  The ID of the campaign containing the redirector.
- redirectorId: string
  The redirector ID to read.
Returns Promise<FullRedirectorModel | null>
The full redirector model, or null if the redirector is not found.

Throws
DatabaseError If the data validation fails.
Implementation of RedirectorRepository.readFull
- Defined in packages/database/src/modules/redirector/redis-redirector.repository.ts:113

removeField

removeField(
    campaignId: string,
    redirectorId: string,
    field: string,
    lockSecret: string,
): Promise<void>
Removes a required field from the redirector.
Parameters
- campaignId: string
  The ID of the campaign containing the redirector.
- redirectorId: string
  The redirector ID to remove field from.
- field: string
  The field name to remove from the fields list.
- lockSecret: string
  The campaign lock secret obtained from CampaignRepository.lock.
Returns Promise<void>

Throws
DatabaseError If the campaign does not exist.

Throws
DatabaseError If the campaign is not locked.

Throws
DatabaseError If the campaign lock secret does not match.

Throws
DatabaseError If the redirector does not exist.

Throws
DatabaseError If the data validation fails.
Implementation of RedirectorRepository.removeField
- Defined in packages/database/src/modules/redirector/redis-redirector.repository.ts:173

update

update(
    campaignId: string,
    redirectorId: string,
    page: string | null | undefined,
    lockSecret: string,
): Promise<void>
Updates the redirector specific fields.

All update parameters are optional. Only provided fields will be updated.
Parameters
- campaignId: string
  The ID of the campaign containing the redirector.
- redirectorId: string
  The redirector ID to update.
- page: string | null | undefined
  The page template.
- lockSecret: string
  The campaign lock secret obtained from CampaignRepository.lock.
Returns Promise<void>

Throws
DatabaseError If the campaign does not exist.

Throws
DatabaseError If the campaign is not locked.

Throws
DatabaseError If the campaign lock secret does not match.

Throws
DatabaseError If the redirector does not exist.

Throws
DatabaseError If the data validation fails.
Implementation of RedirectorRepository.update
- Defined in packages/database/src/modules/redirector/redis-redirector.repository.ts:127

`Static`register

register(container: DIContainer): void
Registers the redirector repository as a singleton in the DI container.
Parameters
- container: DIContainer
  The DI container to register in.
Returns void
- Defined in packages/database/src/modules/redirector/redis-redirector.repository.ts:46

Class RedisRedirectorRepository

Example

Implements

Constructors

constructor

Parameters

Returns RedisRedirectorRepository

Methods

appendField

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Throws

create

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Throws

delete

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Throws

Throws

list

Parameters

Returns Promise<RedirectorModel[] | null>

Throws

listFull

Parameters

Returns Promise<FullRedirectorModel[] | null>

Throws

read

Parameters

Returns Promise<RedirectorModel | null>

Throws

readFull

Parameters

Returns Promise<FullRedirectorModel | null>

Throws

removeField

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Throws

update

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Throws

Staticregister

Parameters

Returns void

`Static`register