@pivotshare/avails

avails -- tools for parsing and generating EMA Avails

SYNOPSES

avails convert [-i type] [-o type]

avails merge [-i type] [-o type] file1 [file2 ...]

avails diff [-i type] [-o type] file1 file2

DESCRIPTION

avails convert simply transforms avails from one format to another.

avails merge will accept one of more avails in chronological order and merge them into a single avails. Merge will treat avails as state so repeated entities with the same Entry Types will be ignored. A Full Extract followed by a Full Delete will result in no entry for that entity.

avails diff will accept two avails, A and B, and return a new avails containing entries unique to B, without entries that exist in both A and B, and with entries that are only in A as Full Delete entries.

The following options are available:

• -i, --input : Specify the format of input file: tsv, json, xlsx. Required. See FORMATS.

• -o, --output : Specify the format of output file: tsv, json, xlsx. Required. See FORMATS.

• -h: Display help avails or subcommands.

See BACKGROUND for more information regarding the Avails standard and this tool.

FORMATS

avails conforms to EMA Avails spreadsheet template Version 1.6e2.

avails supports the following formats:

• Tab-serparated values (tsv)
• Microsoft Excel (xlsx)
• JSON (json)

The official Avails XML format is not supported.

The TSV format should not supply headers, as the Entity Type field is used to determine that particular line's schema.

The JSON format is an unofficial format used both for representing Avails, and as an intermediary data structure within avails. It has a 1-1 mapping with the columns of the Excel-based standard. Keys (columns) are in snake_case. Values are always strings. See schema for header values and test/mock for examples. Excel was chosen over the XML standard for modeling since most vendors prefer that format.

BACKGROUND

Content Availability Metadata, or avails, is an Entertainment industry term for information about the time, location and business rules relating to offering a media asset, e.g. a movie or a television show.

avails document the transition between states, e.g. Full Extract, Full Delete, not states themselves, however, by manipulating initial and subsequent avails we can recreate the expected state of content on a given platform. This is the technique utilized by the merge and diff subcommands, and third-party tools that generate initial avails.

It is recommended to persist submitted avails and use avails, together with custom or third-party tools, to easily create new avails, or determine state of content on third-party platforms.

EXAMPLES

You can use Avails as a CLI or a library.

as library:

const Avails = require('@pivotshare/avails'); // npm install avails
const obj = Avails.fromTSVLine('SomeFilmStudio\tEN\tUS\tMovie'); // etc
// { display_name: 'SomeFilmStudio', store_language: 'EN', territory : 'US', work_type: 'Movie', ... }

as CLI:

# npm install -g avails
# avails --help
avails convert -i json -o xlsx <movies.json > movies.xlsx

SEE ALSO

emavalidator, Content Availability Metadata, Sending Avails