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

Index

Constructors

constructor

new VlocityDatapack(headerFile, datapackType, key, projectFolder, data?): VlocityDatapack
Parameters
- headerFile: string
- datapackType: string
- key: string
- projectFolder: string
- Optional data: any
Returns VlocityDatapack
- Defined in packages/vlocity/src/datapack/datapack.ts:74

Properties

`Private` #dataProxy

#dataProxy: any

`Readonly` data

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

Type declaration

[key: string]: any

`Readonly` datapackType

datapackType: string

`Readonly` headerFile

headerFile: string

`Readonly` key

key: string

`Readonly` projectFolder

projectFolder: string

Accessors

datapackFolder

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

globalKey

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

manifestEntry

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

name

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

sobjectType

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

sourceKey

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

Methods

entries

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

`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:309

`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:297

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:257

`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:193

`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:275

`Private` getProperty

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

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:241

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:227

rename

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

`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:206

`Private` setProperty

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

updateField

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

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:168

updateSourceKey

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

Class VlocityDatapack

Hierarchy

Implements

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

headerFile: string

datapackType: string

key: string

projectFolder: string

Optional data: any

Returns VlocityDatapack

Properties

Private #dataProxy

Readonly data

Type declaration

[key: string]: any

Readonly datapackType

Readonly headerFile

Readonly key

Readonly projectFolder

Accessors

datapackFolder

Returns 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>

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` data: any

`Private` #dataProxy

`Readonly` data

`Readonly` datapackType

`Readonly` headerFile

`Readonly` key

`Readonly` projectFolder

`Private` forEachChildObject

`Private` getChildObjects

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

`Private` getGlobalKeyFields

`Private` getProperties

`Private` getProperty

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

`Private` replaceGlobalKey

`Optional` newGlobalKey: string

`Private` setProperty

`Optional` fieldName: string