Class ManifestConstructor

Description

Manifest value object.

Hierarchy

ManifestConstructor

Constructors

constructor

new ManifestConstructor(payload: any): ManifestConstructor
Parameters
- payload: any
Returns ManifestConstructor
- Defined in domain/valueObjects/Manifest.ts:26

Properties

manifest

manifest: Manifest

maxArrayLength

maxArrayLength: number = 20

maxRelationsArrayLength

maxRelationsArrayLength: number = 50

sizeThreshold

sizeThreshold: number = 20000

validKeys

validKeys: {} = {}

Type declaration

validLaxKeys

validLaxKeys: string[] = []

Methods

`Private` cleanArrayObjects

cleanArrayObjects(payload: any, validKeys: string[], fieldName: string): any
Description
Clean objects in array.
Parameters
- payload: any
- validKeys: string[]
- fieldName: string
Returns any
- Defined in domain/valueObjects/Manifest.ts:226

`Private` cleanPayload

cleanPayload(payload: any): Manifest
Description
Sanitize the incoming payload.
Parameters
- payload: any
Returns Manifest
- Defined in domain/valueObjects/Manifest.ts:172

`Private` createSanitizedPayload

createSanitizedPayload(payload: any): any
Description
Create a sanitized payload from a previously "cleaned" payload.
Parameters
- payload: any
Returns any
- Defined in domain/valueObjects/Manifest.ts:251

`Private` deleteUnknownFields

deleteUnknownFields(payload: any, validKeys: string[], fieldName?: string): any
Description
Deletes unknown fields.
Parameters
- payload: any
- validKeys: string[]
- Optional fieldName: string
Returns any
- Defined in domain/valueObjects/Manifest.ts:209

`Private` deleteUnusedFields

deleteUnusedFields(payload: any, fieldNames: string[]): any
Description
Deletes useless fields.
Parameters
- payload: any
- fieldNames: string[]
Returns any
- Defined in domain/valueObjects/Manifest.ts:239

getManifest

getManifest(): Manifest
Description
Expose the manifest data.

Returns Manifest
- Defined in domain/valueObjects/Manifest.ts:322

`Private` sanitizeLaxString

sanitizeLaxString(value: string): string
Description
Does a special, less harsh treatment for strings.
Parameters
- value: string
Returns string
- Defined in domain/valueObjects/Manifest.ts:298

`Private` sanitizeObjects

sanitizeObjects(item: any): any
Description
Utility to sanitize objects in payload.
Parameters
- item: any
Returns any
- Defined in domain/valueObjects/Manifest.ts:273

`Private` sanitizeString

sanitizeString(value: string | number, isValue?: boolean): string | number
Description
String sanitizer utility to cap length and allow only certain characters.

See
https://stackoverflow.com/questions/23187013/is-there-a-better-way-to-sanitize-input-with-javascript
Parameters
- value: string | number
- isValue: boolean = false
Returns string | number
- Defined in domain/valueObjects/Manifest.ts:307

`Private` validateArrayLengths

validateArrayLengths(payload: Record<string, any>): void
Description
Validate array lengths.
Parameters
- payload: Record<string, any>
Returns void
- Defined in domain/valueObjects/Manifest.ts:91

`Private` validateDataSensitivity

validateDataSensitivity(input: string): void
Description
Validate the data sensitivity input.
Parameters
- input: string
Returns void
- Defined in domain/valueObjects/Manifest.ts:150

`Private` validateKind

validateKind(input: string): void
Description
Validate the (component) kind input.
Parameters
- input: string
Returns void
- Defined in domain/valueObjects/Manifest.ts:161

`Private` validateLinkIcon

validateLinkIcon(links: LinkItem[]): void
Description
Validate the link icon input.
Parameters
- links: LinkItem[]
Returns void
- Defined in domain/valueObjects/Manifest.ts:135

`Private` validatePayload

validatePayload(body: Manifest | Record<string, unknown>): void
Description
Do basic field validation of the incoming data object.
Parameters
- body: Manifest | Record<string, unknown>
Returns void
- Defined in domain/valueObjects/Manifest.ts:59

`Private` validateRequiredProperties

validateRequiredProperties(payload: Record<string, any>): void
Description
Validate required properties.
Parameters
- payload: Record<string, any>
Returns void
- Defined in domain/valueObjects/Manifest.ts:75

`Private` validateSize

validateSize(payload: Record<string, any>): void
Description
Ensure that we follow some meaningful max size cap.
Parameters
- payload: Record<string, any>
Returns void
- Defined in domain/valueObjects/Manifest.ts:83

`Private` validateSloPeriods

validateSloPeriods(slos: SloItem[]): void
Description
Validate that SLOs have a valid period set.
Parameters
- slos: SloItem[]
Returns void
- Defined in domain/valueObjects/Manifest.ts:107

`Private` validateSloTypes

validateSloTypes(slos: SloItem[]): void
Description
Validate the SLO types.
Parameters
- slos: SloItem[]
Returns void
- Defined in domain/valueObjects/Manifest.ts:120

Generated using TypeDoc