node-matrix-importer

Generate XML for the "Import Assets from XML Tool" with JavaScript!

Example

var Importer = require('node-matrix-importer')
var xml = Importer()

var rootFolder = xml.createAsset('folder', {
  parentId: 1
})
var mySite = xml.createAsset('site', {
  parentId: rootFolder.id
})

xml.setAttribute({
  assetId: rootFolder.id,
  attribute: 'name',
  value: 'Sites'
})

xml.setAttribute({
  assetId: mySite.id,
  attribute: 'name',
  value: 'My Site'
})

console.log(xml.toString())

API

Importer

node-matrix-importer provides an API for generating XML for the "Import Assets from XML Tool" via require('node-matrix-importer').

var importer = new Importer(opts)

The opts argument accepts an object with the following properties:

• opts.sortActions: whether Actions should be sorted into an internal collection. Default: false

importer.addPath(opts)

The opts argument accepts an object with the following properties:

• opts.id
• opts.path
• opts.assetId

Returns a new Action instance: new Action('add_path', opts);.

For more information on Actions refer to the node-matrix-import-actions module.

importer.createAsset(opts)

The opts argument accepts an object with the following properties:

• opts.id
• opts.parentId
• opts.type
• opts.link
• opts.value
• opts.dependant
• opts.exclusive

Returns a new Action instance: new Action('create_asset', opts);, with the addition of an action.id propterty; action.id in this case is a String in the form of '#{id}', where id is a unique identifier.

For more information on Actions refer to the node-matrix-import-actions module.

importer.createLink(opts)

The opts argument accepts an object with the following properties:

• opts.to
• opts.from
• opts.link
• opts.value
• opts.dependant
• opts.exclusive
• opts.major

Returns a new Action instance: new Action('create_link', opts);.

For more information on Actions refer to the node-matrix-import-actions module.

importer.setAttribute(opts)

The opts argument accepts an object with the following properties:

• opts.id
• opts.assetId
• opts.attribute
• opts.value

Returns a new Action instance: new Action('set_attribute', opts);.

For more information on Actions refer to the node-matrix-import-actions module.

importer.setMetadataSchema(opts)

The opts argument accepts an object with the following properties:

• opts.id
• opts.assetId
• opts.schemaId
• opts.granted
• opts.cascade

Returns a new Action instance: new Action('set_metadata_schema', opts);.

For more information on Actions refer to the node-matrix-import-actions module.

importer.setMetadataValue(opts)

The opts argument accepts an object with the following properties:

• opts.id
• opts.assetId
• opts.fieldId
• opts.value

Returns a new Action instance: new Action('set_metadata_value', opts);.

For more information on Actions refer to the node-matrix-import-actions module.

importer.setPermission(opts)

The opts argument accepts an object with the following properties:

• opts.assetId
• opts.permission
• opts.muteError
• opts.granted
• opts.userId

Returns a new Action instance: new Action('set_permission', opts);.

For more information on Actions refer to the node-matrix-import-actions module.

importer.getActionById(id)

The id argument accepts a String in the form of '#{id}' where id corresponds to an Action created with importer.createAsset(type, opts).

Returns the matching Action instance, or undefined if an Action with the supplied id wasn't found.

importer.toString(opts)

node-matrix-importer internally manages a collection of actions created by calling the above methods. At any point you can get a full XML representation of them by calling toString() on your Importer instance.

The opts argument controls the formatting of the output XML.

• opts.pretty: pretty print XML. Default: true
• opts.indent: whitespace for indentation (only if opts.pretty = true. Default: ' '
• opts.newline newline character (only if opts.pretty = true. Default: '\n'

License

MIT