Class TargetService

Represents the target service.

Constructors

constructor

new TargetService(targetRepository: TargetRepository): TargetService
Creates a new service instance.
Parameters
- targetRepository: TargetRepository
  The target repository instance.
Returns TargetService
- Defined in modules/target/target.service.ts:44

Methods

appendLabel

appendLabel(
    data: {
        campaignId: string;
        label: string;
        lockSecret: string;
        targetId: string;
    },
): Promise<void>
Appends a label to the target.
Parameters
- data: { campaignId: string; label: string; lockSecret: string; targetId: string }
  The data object.
Returns Promise<void>
- Defined in modules/target/target.service.ts:258

create

create(
    data: {
        accessLevel: "transparent" | "landing";
        allowWebSockets: boolean;
        bodySizeLimit: number;
        campaignId: string;
        connectTimeout: number;
        donorDomain: string;
        donorPort: number;
        donorSecure: boolean;
        donorSub: string;
        faviconIco: string;
        headersSizeLimit: number;
        lockSecret: string;
        mainPage: string;
        mirrorPort: number;
        mirrorSecure: boolean;
        mirrorSub: string;
        notFoundPage: string;
        robotsTxt: string;
        simpleTimeout: number;
        sitemapXml: string;
        streamTimeout: number;
        targetId: string;
    },
): Promise<FullTargetModel>
Creates a new target.
Parameters
- data: {
      accessLevel: "transparent" | "landing";
      allowWebSockets: boolean;
      bodySizeLimit: number;
      campaignId: string;
      connectTimeout: number;
      donorDomain: string;
      donorPort: number;
      donorSecure: boolean;
      donorSub: string;
      faviconIco: string;
      headersSizeLimit: number;
      lockSecret: string;
      mainPage: string;
      mirrorPort: number;
      mirrorSecure: boolean;
      mirrorSub: string;
      notFoundPage: string;
      robotsTxt: string;
      simpleTimeout: number;
      sitemapXml: string;
      streamTimeout: number;
      targetId: string;
  }
  The data object.
Returns Promise<FullTargetModel>
The created target model.
- Defined in modules/target/target.service.ts:52

delete

delete(
data: { campaignId: string; lockSecret: string; targetId: string },
): Promise<void>
Deletes the target by its ID.
Parameters
- data: { campaignId: string; lockSecret: string; targetId: string }
  The data object.
Returns Promise<void>
- Defined in modules/target/target.service.ts:324

disable

disable(
data: { campaignId: string; lockSecret: string; targetId: string },
): Promise<void>
Disables the target, stopping traffic routing.
Parameters
- data: { campaignId: string; lockSecret: string; targetId: string }
  The data object.
Returns Promise<void>
- Defined in modules/target/target.service.ts:235

enable

enable(
data: { campaignId: string; lockSecret: string; targetId: string },
): Promise<void>
Enables the target, making it available for traffic routing.
Parameters
- data: { campaignId: string; lockSecret: string; targetId: string }
  The data object.
Returns Promise<void>
- Defined in modules/target/target.service.ts:212

list

list(data: { campaignId: string }): Promise<TargetModel[]>
Lists all targets for the campaign.
Parameters
- data: { campaignId: string }
  The data object.
Returns Promise<TargetModel[]>
The array of target models.
- Defined in modules/target/target.service.ts:348

read

read(data: { campaignId: string; targetId: string }): Promise<FullTargetModel>
Reads the target by its ID.
Parameters
- data: { campaignId: string; targetId: string }
  The data object.
Returns Promise<FullTargetModel>
The target model.

Throws
ReplServerError If the target is not found.
- Defined in modules/target/target.service.ts:133

readHosts

readHosts(): Promise<TargetHosts>
Reads all target hosts across all campaigns.

Returns Promise<TargetHosts>
The dictionary of target hosts and their links.
- Defined in modules/target/target.service.ts:150

removeLabel

removeLabel(
    data: {
        campaignId: string;
        label: string;
        lockSecret: string;
        targetId: string;
    },
): Promise<void>
Removes a label from the target.
Parameters
- data: { campaignId: string; label: string; lockSecret: string; targetId: string }
  The data object.
Returns Promise<void>
- Defined in modules/target/target.service.ts:291

update

update(
    data: {
        allowWebSockets: boolean | null | undefined;
        bodySizeLimit: number | null | undefined;
        campaignId: string;
        connectTimeout: number | null | undefined;
        faviconIco: string | null | undefined;
        headersSizeLimit: number | null | undefined;
        lockSecret: string;
        mainPage: string | null | undefined;
        notFoundPage: string | null | undefined;
        robotsTxt: string | null | undefined;
        simpleTimeout: number | null | undefined;
        sitemapXml: string | null | undefined;
        streamTimeout: number | null | undefined;
        targetId: string;
    },
): Promise<void>
Updates the target specific fields.
Parameters
- data: {
      allowWebSockets: boolean | null | undefined;
      bodySizeLimit: number | null | undefined;
      campaignId: string;
      connectTimeout: number | null | undefined;
      faviconIco: string | null | undefined;
      headersSizeLimit: number | null | undefined;
      lockSecret: string;
      mainPage: string | null | undefined;
      notFoundPage: string | null | undefined;
      robotsTxt: string | null | undefined;
      simpleTimeout: number | null | undefined;
      sitemapXml: string | null | undefined;
      streamTimeout: number | null | undefined;
      targetId: string;
  }
  The data object.
Returns Promise<void>
- Defined in modules/target/target.service.ts:159

`Static`register

register(container: DIContainer): void
Registers the service as a singleton in the DI container.
Parameters
- container: DIContainer
  The DI container to register in.
Returns void
- Defined in modules/target/target.service.ts:32

Class TargetService

Constructors

constructor

Parameters

Returns TargetService

Methods

appendLabel

Parameters

Returns Promise<void>

create

Parameters

Returns Promise<FullTargetModel>

delete

Parameters

Returns Promise<void>

disable

Parameters

Returns Promise<void>

enable

Parameters

Returns Promise<void>

list

Parameters

Returns Promise<TargetModel[]>

read

Parameters

Returns Promise<FullTargetModel>

Throws

readHosts

Returns Promise<TargetHosts>

removeLabel

Parameters

Returns Promise<void>

update

Parameters

Returns Promise<void>

Staticregister

Parameters

Returns void

`Static`register