Class: Store

Constructor

new Store(params)

Interact with an object in an S3 bucket.

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Attributes	Default	Description
`credentials`	Credentials			the AWS credentials to use for the connection
`prefix`	string			define a path prefix
`type`	string			the class / type of the item being operated on - must match: ^[a-z,A-Z][a-z,A-Z,0-9,_]+$
`id`	string			the id of the item being operated on - must match: ^[a-z,A-Z][a-z,A-Z,0-9,_]+$
`splay`	number	<optional>	1	the number of characters (from the start of the identifer) when converting the id to a path

Since: 1.17.0
Source: store.js, line 37

Classes

Store

Methods

(async) copy(params)

Copy a file into the item from another part of the storage. This capability is specifically to support using different locations in the bucket for working data and repository data where the repository data might contain versioned copies of the working data.

This method is an event emitter. Listen to events using the store handle.

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Default	Description
`source`	String		the source file to be copied - this must be a full path to the file inside the bucket
`target`	String		the target location to copy the source file to; this is relative to the object path
`registerFile`	Boolean	true	whether the file should be registered in ro-crate-metadata.json. The file will be registered in the hasPart property of the root dataset if there isn't already an entry for the file.
`version`	Boolean	false	whether the file should be versioned. If true, the existing file will be copied to ${file}.v${date as ISO String}.{ext} before the new version is uploaded to the target name
`batch`	Array.<Transfer>		an array of objects defining content to put into the store where the params are as for the single case. Uploads will be run 5 at a time.

Since: 1.18.0
Source: store.js, line 417

Example

Listening to events

const store = new Store({})
store.on("copy", (msg) => console.log(msg));
// where msg = { msg: 'Copied batch 1/1 (1/1 files)', date: date as ISO String }

(async) createObject() → {Boolean}

Create the object in the storage.

Since: 1.17.0
Source: store.js, line 198

Returns:

Type:: Boolean

(async) delete(params)

Remove a file or files from an item in the storage. Files will also be removed from the hasPart property of the root dataset.

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Attributes	Description
`target`	String \| Array.<String>	<optional>	the target name for the file or array of target files; this will be set relative to the item path
`prefix`	String	<optional>	file prefix; this will be set relative to the item path

Source: store.js, line 533

(async) exists() → {Boolean}

Check whether the object exists in the storage.

Since: 1.17.0
Source: store.js, line 136

Returns:

Type:: Boolean

(async) fileExists(params) → {Boolean}

Check whether the path exists in the storage.

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`path`	String	the path of the file to check - this is relative to the item root

Since: 1.17.0
Source: store.js, line 150

Returns:

Type:: Boolean

(async) get(params)

Get a file from the item on the storage.

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`localPath`	String	the local path where you want to download the file to
`target`	String	the file on the storage, relative to the item path, that you want to download

Source: store.js, line 240

(async) getJSON(params)

Get a JSON file from the item on the storage.

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`localPath`	String	the local path where you want to download the file to
`target`	String	the file on the storage, relative to the item path, that you want to download

Source: store.js, line 251

(async) getObjectIdentifier() → {Object}

Get the object identifier.

Since: 1.17.0
Source: store.js, line 169

Returns:

Type:: Object

(async) getObjectInventory() → {Object}

Get the object inventory file.

Since: 1.17.0
Source: store.js, line 178

Returns:

Type:: Object

getObjectPath() → {String}

Get the path of the object in the storage.

Since: 1.17.0
Source: store.js, line 160

Returns:

Type:: String

(async) getPresignedUrl(params)

Get a presigned link to the file.

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`target`	String	the file on the storage, relative to the item path, that you want the url for
`download`	String	get link that can be used to trigger a direct file download

Source: store.js, line 278

(async) hashTarget(params) → {String}

Calculate the SHA512 hash of a file in storage

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`target`	String	the file on the storage, relative to the item path, that is to be hashed

Source: store.js, line 634

Returns:

the hash of the file or undefined

Type:: String

(async) listFileVersions(params) → {Array}

Get file versions.

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`target`	String	the file whose versions to retrieve

Source: store.js, line 262

Returns:

versions of the specified file ordered newest to oldest. The file as named (ie without a version string will be the first - newest - entry)

Type:: Array

(async) listResources() → {Array.<String>}

Recursively walk and list all of the files for the item.

Source: store.js, line 591

Returns:

a list of files

Type:: Array.<String>

(async) put(params)

Put a file or batch of files into the item on the storage.

This method is an event emitter. Listen to events using the store handle.

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Default	Description
`localPath`	String		the path to the file locally that you want to upload to the item folder
`json`	String		a JSON object to store in the file directly
`content`	String		some content to store in the file directly
`target`	String		the target name for the file; this will be set relative to the item path
`registerFile`	Boolean	true	whether the file should be registered in ro-crate-metadata.json. The file will be registered in the hasPart property of the root dataset if there isn't already an entry for the file.
`version`	Boolean	false	whether the file should be versioned. If true, the existing file will be copied to ${file}.v${date as ISO String}.{ext} before the new version is uploaded to the target name
`mimetype`	String		the mimetype of the file. If not defined, the library will try to determine it.
`batch`	Array.<Transfer>		an array of objects defining content to put into the store where the params are as for the single case. Uploads will be run 5 at a time.

Source: store.js, line 305

Example

Listening to events

const store = new Store({})
store.on("put", (msg) => console.log(msg));
// where msg = { msg: 'Uploaded batch 1/1 (1/1 files)', date: date as ISO String }

(async) registerFilesInCrateMetadata(filesopt)

Register a set of files in ro-crate-metadata.json. If no files are defined the method will register all files that are not special files. This includes the ro-crate-metadata file (or any version of it).

Parameters:

Name	Type	Attributes	Description
`files`	Array.<String>	<optional>	if provided, the array of file names to be registered, relative to the root of the object.

Since: 1.18.0
Source: store.js, line 496

(async) removeObject()

Delete the object in the storage.

Since: 1.17.0
Source: store.js, line 574

resolvePath() → {String}

Resolve the full path of a file in the storage

Parameters:

Name	Type	Description
`params.path`	String	the path to the file relative to the object root that it to be resolved

Since: 1.17.0
Source: store.js, line 624

Returns:

the full path to a file

Type:: String

(async) stat(params) → {Boolean}

Return the file stat.

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`path`	String	the path of the file to stat- this is relative to the item root

Source: store.js, line 188

Returns:

Type:: Boolean