Class FullCampaignModel

Represents a 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 of the campaign
- mirrorDomain: string
  The public-facing mirror domain
- description: string
  Human-readable description
- cryptSecret: string
  Secret used for encrypting session data
- upgradeSessionPath: string
  URL path that triggers session upgrade
- sessionCookieName: string
  Name of the cookie used to track sessions
- sessionCookieNames: string[]
- sessionExpire: number
  TTL for an authorized session
- newSessionExpire: number
  TTL for a newly created, not-yet-authorized session
- messageExpire: number
  TTL for message logs
- isLocked: boolean
  Determines whether a campaign is blocked
- proxyCount: number
  Total number of proxies related to this campaign
- targetCount: number
  Total number of targets related to this campaign
- redirectorCount: number
  Total number of redirectors related to this campaign
- lureCount: number
  Total number of lures related to this campaign
- sessionCount: number
  Total number of sessions processed through this campaign
- messageCount: number
  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:64

Properties

`Readonly`campaignId

campaignId: string

The unique identifier of the campaign

`Readonly`createdAt

createdAt: Date

The date and time when the campaign was created

`Readonly`cryptSecret

cryptSecret: string

Secret used for encrypting session data

`Readonly`description

description: string

Human-readable description

`Readonly`isLocked

isLocked: boolean

Determines whether a campaign is blocked

`Readonly`lureCount

lureCount: number

Total number of lures related to this campaign

`Readonly`messageCount

messageCount: number

Total number of messages processed through this campaign

`Readonly`messageExpire

messageExpire: number

TTL for message logs

`Readonly`mirrorDomain

mirrorDomain: string

The public-facing mirror domain

`Readonly`newSessionExpire

newSessionExpire: number

TTL for a newly created, not-yet-authorized session

`Readonly`proxyCount

proxyCount: number

Total number of proxies related to this campaign

`Readonly`redirectorCount

redirectorCount: number

Total number of redirectors related to this campaign

`Readonly`sessionCookieName

sessionCookieName: string

Name of the cookie used to track sessions

`Readonly`sessionCookieNames

sessionCookieNames: string[]

`Readonly`sessionCount

sessionCount: number

Total number of sessions processed through this campaign

`Readonly`sessionExpire

sessionExpire: number

TTL for an authorized session

`Readonly`targetCount

targetCount: number

Total number of targets related to this campaign

`Readonly`upgradeSessionPath

upgradeSessionPath: string

URL path that triggers session upgrade

Methods

`Static`isNotNull

isNotNull<T extends CampaignModel>(model: T | null): model is T
Type guard to filter out null values in arrays.
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