Optional
uid: stringUnique ID of the Data Package
Optional
name: stringHuman Readable name of the DataPackage
Indcates that the DataPackage has been destroyed and all local files removed
The local path to the Data Package working directory
DataPackage schema version - 2 is most common
Add a CoT marker to the Package
Add any file to a Package
Input ReadableStream of File at attach
Options
Optional
attachment?: stringShould the file be associated as an attachment to a CoT. If so this should contain the UID of the CoT
Optional
ignore?: booleanShould the file be ignore, defaults to false
Filename for the file
Optional
uid?: stringOptional UID for the File, a UUID will be generated if not supplied
Return attachments that are associated in the Manifest with a given CoT Note: this does not return files that are NOT associated with a CoT
Return CoT objects for all CoT type features in the Data Package
CoTs have their attachment_list
field populated if parseAttachments is set to true.
While this field is populated automatically by some ATAK actions such as QuickPic
other attachment actions do not automatically populate this field other than the link
provided between a CoT and it's attachment in the MANIFEST file
Destory the underlying FS resources and prevent further mutation
Return a list of files that are NOT attachments or CoT markers The Set returned has a list of file paths that can be passed to getFile(path)
Compile the DataPackage into a TAK compatible ZIP File Note this function can be called multiple times and does not affect the ability of the class to continue building a Package
Get any file from a Package
When DataPackages are uploaded to TAK Server they generally use an EUD calculated Hash
Mission Sync archived are returned in DataPackage format Return true if the DataPackage is a MissionSync Archive
Return a string version of the Manifest document
The Package should be imported and then removed
The Package should be imported and the package retained
Static
hashWhen DataPackages are uploaded to TAK Server they generally use an EUD calculated Hash
Static
parseReturn a DataPackage version of a raw Data Package Zip
path to zipped DataPackage on disk
Optional
opts: { cleanup?: boolean; strict?: boolean }Parser Options
Optional
cleanup?: booleanIf the Zip is parsed as a DataSync successfully, remove the initial zip file
Optional
strict?: booleanBy default the DataPackage must contain a manifest file, turning strict mode off will generate a manifest based on the contents of the file
Helper class for creating and parsing static Data Packages