Class VlocityDatapack

Simple representation of a datapack; maps common values to properties. Source of the datapsck can be accessed through the data property

Hierarchy

VlocityDatapack

Implements

Indexable

[key: string]: any

Constructors

constructor

new VlocityDatapack(type, data, options?): VlocityDatapack
Parameters
- type: string
- data: unknown
- Optional options: VlocityDatapackCreateOptions
Returns VlocityDatapack
- Defined in packages/vlocity/src/datapack/datapack.ts:130

Properties

`Private` #dataProxy

#dataProxy: any

`Readonly` data

data: object & {
[key: string]: any;
}

Type declaration

[key: string]: any

`Readonly` datapackType

datapackType: string

`Optional` `Readonly` headerFile

headerFile?: string

`Readonly` key

key: string

`Optional` `Readonly` projectFolder

projectFolder?: string

Accessors

datapackFolder

get datapackFolder(): undefined | string
Returns undefined | string
- Defined in packages/vlocity/src/datapack/datapack.ts:120

globalKey

get globalKey(): string
Returns string
Implementation of ObjectEntry.globalKey
- Defined in packages/vlocity/src/datapack/datapack.ts:115

manifestEntry

get manifestEntry(): ManifestEntry
Returns ManifestEntry
- Defined in packages/vlocity/src/datapack/datapack.ts:119

name

get name(): string
Returns string
Implementation of ObjectEntry.name
- Defined in packages/vlocity/src/datapack/datapack.ts:116

sobjectType

get sobjectType(): string
Returns string
Implementation of ObjectEntry.sobjectType
- Defined in packages/vlocity/src/datapack/datapack.ts:117

sourceKey

get sourceKey(): string
Returns string
- Defined in packages/vlocity/src/datapack/datapack.ts:118

Methods

entries

entries(): [string, any][]
Returns [string, any][]
- Defined in packages/vlocity/src/datapack/datapack.ts:162

`Private` forEachChildObject

forEachChildObject(object, executer): any
Parameters
- object: any
- executer: ((object) => any)
  - - (object): any
    - Parameters
      
      object: any
      
      Returns any
Returns any
- Defined in packages/vlocity/src/datapack/datapack.ts:376

`Private` getChildObjects

getChildObjects(object?): Generator<any, void, unknown>
Recursively iterate over this datapack and child objects
Parameters
- object: object & {
  [key: string]: any;
  } = ...
  
  object
Returns Generator<any, void, unknown>
- Defined in packages/vlocity/src/datapack/datapack.ts:352

`Private` getDatapackKey

getDatapackKey(): string
Returns string
- Defined in packages/vlocity/src/datapack/datapack.ts:364

getExternalReferences

getExternalReferences(): IterableIterator<VlocityDatapackReference>
Iterate over the relationship from this datapack to other objects

Returns IterableIterator<VlocityDatapackReference>
- Defined in packages/vlocity/src/datapack/datapack.ts:312

`Private` getGlobalKeyFields

getGlobalKeyFields(): string[]
Returns a list of fields in this datapack that are considered global keys. Tries to match the standard GlobalKey__c format as well as group and version global keys.

Returns string[]
List of global key fields in this datapack
- Defined in packages/vlocity/src/datapack/datapack.ts:248

`Private` getProperties

getProperties(target?): Generator<[string, string, any], any, unknown>
Recursively iterate over the properties of this datapack and it's child objects
Parameters
- target: object = ...
  
  object to iterate over
Returns Generator<[string, string, any], any, unknown>
- Defined in packages/vlocity/src/datapack/datapack.ts:330

`Private` getProperty

getProperty(name): any
Parameters
- name: string | number | symbol
Returns any
- Defined in packages/vlocity/src/datapack/datapack.ts:387

getReferences

getReferences(): Generator<VlocityDatapackReference, void, unknown>
Iterate over the relationship from this datapack to other objects; the generator yields all references found and does not remove any duplicates

Returns Generator<VlocityDatapackReference, void, unknown>
- Defined in packages/vlocity/src/datapack/datapack.ts:296

getSourceKeys

getSourceKeys(): Generator<{
VlocityRecordSObjectType: string;
VlocityRecordSourceKey: string;
}, void, unknown>
Iterate over the source keys provided by this datapack

Returns Generator<{
VlocityRecordSObjectType: string;
VlocityRecordSourceKey: string;
}, void, unknown>
- Defined in packages/vlocity/src/datapack/datapack.ts:282

rename

rename(newName): void
Parameters
- newName: string
Returns void
- Defined in packages/vlocity/src/datapack/datapack.ts:166

`Private` replaceGlobalKey

replaceGlobalKey(object, keyField, newGlobalKey?): string
Replace the global key on the specified object and all of it's child datapacks. with a new global key. This is useful when you want to clone a datapack. Optionally, you can provide a new global key to use otherwise a new one will be generated in UUID format.
Parameters
- object: object
  
  Datapack to replace global key on
- keyField: string
  
  Field name of the global key
- Optional newGlobalKey: string
  
  Optional new global key to use
Returns string
The new global key
- Defined in packages/vlocity/src/datapack/datapack.ts:261

`Private` setProperty

setProperty(name, value): boolean
Parameters
- name: string | number | symbol
- value: any
Returns boolean
- Defined in packages/vlocity/src/datapack/datapack.ts:396

updateField

updateField(fieldName, newValue): void
Parameters
- fieldName: string
- newValue: string | number | boolean
Returns void
- Defined in packages/vlocity/src/datapack/datapack.ts:181

updateGlobalKeyField

updateGlobalKeyField(fieldName?): void
Updates the global key of this datapack in-place and all of it's child datapacks. Use with caution as this will change the global key causing the datapack to be re-inserted on the next deployment.
Parameters
- Optional fieldName: string
  
  Field name to use as global key. If not specified, all global key fields are updated.
Returns void
- Defined in packages/vlocity/src/datapack/datapack.ts:223

updateSourceKey

updateSourceKey(newKey): any
Parameters
- newKey: string
Returns any
- Defined in packages/vlocity/src/datapack/datapack.ts:206

Class VlocityDatapack

Hierarchy

Implements

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

type: string

data: unknown

Optional options: VlocityDatapackCreateOptions

Returns VlocityDatapack

Properties

Private #dataProxy

Readonly data

Type declaration

[key: string]: any

Readonly datapackType

Optional Readonly headerFile

Readonly key

Optional Readonly projectFolder

Accessors

datapackFolder

Returns undefined | string

globalKey

Returns string

manifestEntry

Returns ManifestEntry

name

Returns string

sobjectType

Returns string

sourceKey

Returns string

Methods

entries

Returns [string, any][]

Private forEachChildObject

Parameters

object: any

executer: ((object) => any)

Parameters

object: any

Returns any

Returns any

Private getChildObjects

Parameters

object: object & { [key: string]: any; } = ...

Returns Generator<any, void, unknown>

Private getDatapackKey

Returns string

getExternalReferences

Returns IterableIterator<VlocityDatapackReference>

Private getGlobalKeyFields

Returns string[]

Private getProperties

Parameters

target: object = ...

Returns Generator<[string, string, any], any, unknown>

Private getProperty

Parameters

name: string | number | symbol

Returns any

getReferences

Returns Generator<VlocityDatapackReference, void, unknown>

getSourceKeys

Returns Generator<{ VlocityRecordSObjectType: string; VlocityRecordSourceKey: string; }, void, unknown>

rename

Parameters

newName: string

Returns void

Private replaceGlobalKey

Parameters

object: object

keyField: string

Optional newGlobalKey: string

`Optional` options: VlocityDatapackCreateOptions

`Private` #dataProxy

`Readonly` data

`Readonly` datapackType

`Optional` `Readonly` headerFile

`Readonly` key

`Optional` `Readonly` projectFolder

`Private` forEachChildObject

`Private` getChildObjects

object: object & {
[key: string]: any;
} = ...

`Private` getDatapackKey

`Private` getGlobalKeyFields

`Private` getProperties

`Private` getProperty

Returns Generator<{
VlocityRecordSObjectType: string;
VlocityRecordSourceKey: string;
}, void, unknown>

`Private` replaceGlobalKey

`Optional` newGlobalKey: string

`Private` setProperty

`Optional` fieldName: string