npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

epitelete

v0.2.20

Published

PERF Middleware for Editors in the Proskomma Ecosystem

Downloads

251

Readme

Epitelete

Installation

Epitelete is available as an npm package.


npm install epitelete

Usage

Proskomma mode

Uses a proskomma instance to handle PERF documents.

Example

import Epitelete from "epitelete"
import Proskomma from "proskomma";

const proskomma = new Proskomma();
proskomma.loadSuccinctDocSet(succintJson);

const docSetId = "doc_set_id";
const epitelete = new Epitelete({ proskomma, docSetId });

const bookCode = "GEN";
let docPerf = epitelete.readPerf(bookCode);

const sequenceId = docPerf.mainSequence;
const sequence = docPerf.sequences[sequenceId];

//...make changes in sequence

docPerf = epitelete.writePerf(bookCode,sequenceId,sequence);
docPerf = epitelete.undoPerf(bookCode);
docPerf = epitelete.redoPerf(bookCode);

Edit Button

How to

1. Install proskomma:

npm install proskomma

2. Instantiate and set Proskomma:


import Proskomma from "proskomma";

const proskomma = new Proskomma();

proskomma.loadSuccinctDocSet(succintJson);

...

succintJson : ...

3. Instantiate Epitelete:


import Epitelete from "epitelete"

...

const docSetId = "doc_set_id";

const epitelete = new Epitelete({ proskomma, docSetId });

...

4. Get a document:

...

const bookCode = "GEN";

let docPerf = epitelete.readPerf(bookCode);

...

.readPerf(): gets a document from cache or by fetching from the proskomma instance.

docPerf: copy of the document that has been saved in cache. example docPerf content

5. Make changes to some docPerf sequence:

...

const sequenceId = docPerf.mainSequence;

const sequence = docPerf.sequences[sequenceId];

//...make changes in sequence

...

6. Persist changes to epitelete s history:

...

docPerf = epitelete.writePerf(bookCode,sequenceId,sequence);

...

.writePerf(): creates a copy of last saved document, updates it with the changed sequence and saves it in memory.

7. Undo/Redo your changes to docPerf:

...

docPerf = epitelete.undoPerf(bookCode);

docPerf = epitelete.redoPerf(bookCode);

...

.undoPerf(): retrieves the previous changed document from history.

.redoPerf(): retrieves the next changed document from history.

History size can be set at instantiation with the options argument:

const options = { historySize: 5 }

const epitelete = new Epitelete({ proskomma, docSetId, options });

Standalone mode

Uses only given PERF documents.

Example

import Epitelete from "epitelete"

const docSetId = "doc_set_id";
const options = { historySize: 5 };
const epitelete = new Epitelete({ docSetId, options });

const bookCode = "GEN";
const perfJSON = {...}
let docPerf = await epitelete.sideloadPerf(bookCode,perfJSON);

const sequenceId = docPerf.mainSequence;
const sequence = docPerf.sequences[sequenceId];

//...make changes in sequence

docPerf = epitelete.writePerf(bookCode,sequenceId,sequence);
docPerf = epitelete.undoPerf(bookCode);
docPerf = epitelete.redoPerf(bookCode);

Edit Button

How to

1. Instatiate Epilete:

import Epitelete from "epitelete"

...

const docSetId = "doc_set_id";

const epitelete = new Epitelete({ docSetId [,options] });

...

Optionally could set historySize in the options arg.

2. Load a document into memory:

...

docPerf = await epitelete.sideloadPerf(bookCode, perfJSON);

...

perfJSON: externally loaded and parsed documentPerf.

3. Use writePerf,readPerf,undoPerf,redoPerf as shown before.

API

Complete Epitelete API

License

This project is licensed under the MIT.