# epub-cfi-generator
[Node.js](https://nodejs.org/) utility that generates [CFI](http://www.idpf.org/epub/linking/cfi/epub-cfi.html) for each text node in each spine of given [EPUB](http://idpf.org/epub).
Takes EPUB file as input (either epub file or unzipped epub directory), produces json file as output.
Internally uses [readium-cfi-js](https://github.com/readium/readium-cfi-js) that does most job.
## Usage
### Command line
```sh
npx epub-cfi-generator input.epub output.json
```
### Examples
#### Input
Reference EPUB (close to https://idpf.org/epub/linking/cfi/#sec-path-examples)
package.opf
```xml
Test EPUB
some-book-id
Viachaslau Tyshkavets
en
test.xhtml
```xml
Title
1
2
3
4
xxxyyy0123456789
6
7
8
9
```
#### Output:
Output json
```json
[
{
"idref": "test",
"href": "html/test.xhtml",
"content": [
{
"node": "1",
"cfi": "/6/2[testref]!/4[body01]/2/1:0"
},
{
"node": "2",
"cfi": "/6/2[testref]!/4[body01]/4/1:0"
},
{
"node": "3",
"cfi": "/6/2[testref]!/4[body01]/6/1:0"
},
{
"node": "4",
"cfi": "/6/2[testref]!/4[body01]/8/1:0"
},
{
"node": "xxx",
"cfi": "/6/2[testref]!/4[body01]/10[para05]/1:0"
},
{
"node": "yyy",
"cfi": "/6/2[testref]!/4[body01]/10[para05]/2/1:0"
},
{
"node": "0123456789",
"cfi": "/6/2[testref]!/4[body01]/10[para05]/3:0"
},
{
"node": "6",
"cfi": "/6/2[testref]!/4[body01]/12/1:0"
},
{
"node": "7",
"cfi": "/6/2[testref]!/4[body01]/14/1:0"
},
{
"node": "8",
"cfi": "/6/2[testref]!/4[body01]/18/1:0"
},
{
"node": "9",
"cfi": "/6/2[testref]!/4[body01]/20/1:0"
}
]
}
]
```
### API
#### EpubCfiGenerator.parse()
```js
const EpubCfiGenerator = require('./epub-cfi-generator');
const result = await new EpubCfiGenerator().parse(inputFile);
```
License
----
MIT