API.md

Modules

ButtercupImporter

Functions

convert1pifToJSON(onePifRaw) ⇒ Object

Convert raw 1pif text to a JSON tree

createGroupSkeleton(id) ⇒ Object

Create a new group skeleton

mergeItemsToTree(groups, entries, [currentGroup])

Merge extracted groups and entries to form a tree

onePasswordItemToEntry(rawItem) ⇒ Object | null

Convert a 1password raw item to an entry object

ButtercupImporter

• ButtercupImporter
  • ~BitwardenImporter
    • new BitwardenImporter(data)
  • ~ButtercupCSVImporter
    • new ButtercupCSVImporter(csvData)
  • ~ButtercupImporter
    • new ButtercupImporter(sourceVault)
  • ~CSVImporter
    • new CSVImporter(csvData, [name])
  • ~KeePass2XMLImporter
    • new KeePass2XMLImporter(xmlContent)
  • ~LastPassImporter
    • new LastPassImporter(data)
  • ~OnePasswordImporter
    • new OnePasswordImporter(onePIFData)
    • .export() ⇒ Promise.<Vault>

ButtercupImporter~BitwardenImporter

Importer for Bitwarden vaults

Kind: inner class of ButtercupImporter

new BitwardenImporter(data)

Create a new Bitwarden importer

Param	Type	Description
data	String	Raw JSON data of a Bitwarden vault export

ButtercupImporter~ButtercupCSVImporter

Importer for Buttercup CSV exports

Kind: inner class of ButtercupImporter

new ButtercupCSVImporter(csvData)

Create a new Buttercup CSV importer

Param	Type	Description
csvData	String	Raw CSV data of a Buttercup vault export

ButtercupImporter~ButtercupImporter

Importer for Buttercup vaults

Kind: inner class of ButtercupImporter

new ButtercupImporter(sourceVault)

Create a new Buttercup importer

Param	Type	Description
sourceVault	Vault	Source Buttercup vault

ButtercupImporter~CSVImporter

Importer for CSV files

Kind: inner class of ButtercupImporter

new CSVImporter(csvData, [name])

Create a new CSV importer

Param	Type	Default	Description
csvData	String		The source CSV data
[name]	String	Untitled CSV import	Name for the imported folder

ButtercupImporter~KeePass2XMLImporter

Importer for KeePass XML exports

Kind: inner class of ButtercupImporter

new KeePass2XMLImporter(xmlContent)

Create a new KeePass XML importer

Param	Type	Description
xmlContent	String	The XML content to import from

ButtercupImporter~LastPassImporter

Importer for LastPass CSV dumps

Kind: inner class of ButtercupImporter

new LastPassImporter(data)

Create a new LastPass importer

Param	Type	Description
data	String	Raw CSV data of a LastPass vault export

ButtercupImporter~OnePasswordImporter

Importer for 1Password vaults

Kind: inner class of ButtercupImporter

• ~OnePasswordImporter
  • new OnePasswordImporter(onePIFData)
  • .export() ⇒ Promise.<Vault>

new OnePasswordImporter(onePIFData)

Constructor for the importer

Param	Type	Description
onePIFData	String	1pif file data

onePasswordImporter.export() ⇒ Promise.<Vault>

Export the 1pif data to a Buttercup Vault instance

Kind: instance method of OnePasswordImporter
Returns: Promise.<Vault> - A promise that resolves with a Buttercup Vault instance

convert1pifToJSON(onePifRaw) ⇒ Object

Convert raw 1pif text to a JSON tree

Kind: global function
Returns: Object - Raw archive structure

Param	Type	Description
onePifRaw	String	Exported 1PIF content

createGroupSkeleton(id) ⇒ Object

Create a new group skeleton

Kind: global function
Returns: Object - A group object

Param	Type	Description
id	String | null	The 1password group UUID

mergeItemsToTree(groups, entries, [currentGroup])

Merge extracted groups and entries to form a tree

Kind: global function

Param	Type	Description
groups	Object	Groups key=>value list
entries	Object	Entries key=>value list
[currentGroup]	Object	The current object being worked on

onePasswordItemToEntry(rawItem) ⇒ Object | null

Convert a 1password raw item to an entry object

Kind: global function
Returns: Object | null - The converted entry object or null if invalid

Param	Type	Description
rawItem	Object	Extracted 1password item