Class FullCampaignModel

Represents the full campaign model.

Hierarchy (View Summary)

CampaignModel
- FullCampaignModel

Constructors

constructor

new FullCampaignModel(
    campaignId: string,
    mirrorDomain: string,
    description: string,
    cryptSecret: string,
    upgradeSessionPath: string,
    sessionCookieName: string,
    sessionCookieNames: string[],
    sessionExpire: number,
    newSessionExpire: number,
    messageExpire: number,
    isLocked: boolean,
    proxyCount: number,
    targetCount: number,
    redirectorCount: number,
    lureCount: number,
    sessionCount: number,
    messageCount: number,
    createdAt: Date,
): FullCampaignModel
Creates a new full campaign model instance.
Parameters
- campaignId: string
  The unique identifier for the campaign.
- mirrorDomain: string
  The public-facing mirror domain for the campaign.
- description: string
  The human-readable description for the campaign.
- cryptSecret: string
  The secret used for encrypting session data.
- upgradeSessionPath: string
  The URL path that triggers a session upgrade.
- sessionCookieName: string
  The name of the cookie used to track authorized sessions.
- sessionCookieNames: string[]
  The names of the cookies used by all campaigns.
- sessionExpire: number
  The TTL for an authorized session in milliseconds.
- newSessionExpire: number
  The TTL for a not-yet-authorized session in milliseconds.
- messageExpire: number
  The TTL for a message in milliseconds.
- isLocked: boolean
  The flag indicating if the campaign is blocked.
- proxyCount: number
  The total number of proxies related to this campaign.
- targetCount: number
  The total number of targets related to this campaign.
- redirectorCount: number
  The total number of redirectors related to this campaign.
- lureCount: number
  The total number of lures related to this campaign.
- sessionCount: number
  The total number of sessions processed through this campaign.
- messageCount: number
  The total number of messages processed through this campaign.
- createdAt: Date
  The date and time when the campaign was created.
Returns FullCampaignModel
Overrides CampaignModel.constructor
- Defined in packages/database/src/modules/campaign/campaign.models.ts:65

Properties

`Readonly`campaignId

campaignId: string

The unique identifier for the campaign.

`Readonly`createdAt

createdAt: Date

The date and time when the campaign was created.

`Readonly`cryptSecret

cryptSecret: string

The secret used for encrypting session data.

`Readonly`description

description: string

The human-readable description for the campaign.

`Readonly`isLocked

isLocked: boolean

The flag indicating if the campaign is blocked.

`Readonly`lureCount

lureCount: number

The total number of lures related to this campaign.

`Readonly`messageCount

messageCount: number

The total number of messages processed through this campaign.

`Readonly`messageExpire

messageExpire: number

The TTL for a message in milliseconds.

`Readonly`mirrorDomain

mirrorDomain: string

The public-facing mirror domain for the campaign.

`Readonly`newSessionExpire

newSessionExpire: number

The TTL for a not-yet-authorized session in milliseconds.

`Readonly`proxyCount

proxyCount: number

The total number of proxies related to this campaign.

`Readonly`redirectorCount

redirectorCount: number

The total number of redirectors related to this campaign.

`Readonly`sessionCookieName

sessionCookieName: string

The name of the cookie used to track authorized sessions.

`Readonly`sessionCookieNames

sessionCookieNames: string[]

The names of the cookies used by all campaigns.

`Readonly`sessionCount

sessionCount: number

The total number of sessions processed through this campaign.

`Readonly`sessionExpire

sessionExpire: number

The TTL for an authorized session in milliseconds.

`Readonly`targetCount

targetCount: number

The total number of targets related to this campaign.

`Readonly`upgradeSessionPath

upgradeSessionPath: string

The URL path that triggers a session upgrade.

Methods

`Static`isNotNull

isNotNull<T extends CampaignModel>(model: T | null): model is T
Type guard to filter out null models from a list.
Type Parameters
- T extends CampaignModel
Parameters
- model: T | null
  The model to check.
Returns model is T
true if the model is not null, false otherwise.
Inherited from CampaignModel.isNotNull
- Defined in packages/database/src/modules/campaign/campaign.models.ts:13

Class FullCampaignModel

Hierarchy (View Summary)

Constructors

constructor

Parameters

Returns FullCampaignModel

Properties

ReadonlycampaignId

ReadonlycreatedAt

ReadonlycryptSecret

Readonlydescription

ReadonlyisLocked

ReadonlylureCount

ReadonlymessageCount

ReadonlymessageExpire

ReadonlymirrorDomain

ReadonlynewSessionExpire

ReadonlyproxyCount

ReadonlyredirectorCount

ReadonlysessionCookieName

ReadonlysessionCookieNames

ReadonlysessionCount

ReadonlysessionExpire

ReadonlytargetCount

ReadonlyupgradeSessionPath