@5stones/onix/README.md

A strongly typed library for parsing ONIX feeds.

# ONIX

A strongly typed library for parsing ONIX feeds.

## Usage

At a high level, you can pass an XML string into the `parse` function which
will return an object of type `ONIXMessageRoot`.

```ts
import { parse } from '@5stones/onix';

const someONIXMessage = '...';
const parsed = parse(someONIXMessage);
```

There are also numerous interfaces, enums, and other data that can be used
for strong typing and parsing (e.g. BISAC data).

There are also the following helpers for dealing with BISAC:

```ts
import {
  getBISACLabelsForCode,
  getBISACCodeForLabel,
  getBISACAncestorForCode,
  type BISACNode,
} from '@5stones/onix';

const labels: string[] = getBISACLabelsForCode('...');
const code: string = getBISACCodeForLabel('...');
const ancestor: BISACNode | undefined = getBISACAncestorForCode('...');
```

## Code Generation

If you need to update the BISAC codes/labels and/or the ONIX enums you can
use the two scraper scripts that scrape the relevant documentation websites
and generate the code:

```sh
yarn generate:bisac
yarn generate:onix-enums
```

## Release

The standard release command for this project is:
```
yarn version [--new-version <newversion> | major | minor | patch ]
```

This command will:

1. Generate/update the Changelog
1. Bump the package version
1. Tag & pushing the commit


e.g.

```
yarn version --new-version 1.2.17
yarn version patch // 1.2.17 -> 1.2.18
```