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

@ridi/comic-parser

v0.7.4-alpha.1

Published

Common comic data parser for Ridibooks services

Downloads

25

Readme

@ridi/comic-parser

Common comic data parser for Ridibooks services

NPM version Check codecov NPM total downloads

Features

  • [x] Single structure parsing
  • [ ] Nested structure parsing
  • [x] Unzip zip file when parsing with options
  • [x] Read files
    • [x] Read image in base64 encoding
  • [x] Encrypt and decrypt function when parsing or reading or unzipping
  • [ ] Debug mode
  • [ ] Environment
    • [x] Node
    • [ ] CLI
    • [ ] Browser
  • [ ] Online demo

Install

npm install @ridi/comic-parser

Usage

Basic:

import { ComicParser } from '@ridi/comic-parser';
// or const { ComicParser } = require('@ridi/comic-parser');

const parser = new ComicParser('./foo/bar.zip' or './unzippedPath');
parser.parse(/* { parseOptions } */).then((book) => {
  parser.readItems(items/*, { readOptions } */).then((results) => {
    ...
  });
  ...
});

with AesCryptor:

import { CryptoProvider, AesCryptor } from '@ridi/comic-parser';
// or const { CryptoProvider, AesCryptor } = require('@ridi/comic-parser');

const { Purpose } = CryptoProvider;
const { Mode, Padding } = AesCryptor;

class ContentCryptoProvider extends CryptoProvider {
  constructor(key) {
    super();
    this.cryptor = new AesCryptor(Mode.ECB, { key });
  }

  getCryptor(filePath, purpose) {
    return this.cryptor;
  }

  // If use as follows:
  // const provider = new ContentCryptoProvider(...);
  // const parser = new ComicParser('encrypted.zip', provider);
  // const book = await parser.parse({ unzipPath: ... });
  // const firstImage = await parser.readItem(book.items[0]);
  //
  // It will be called as follows:
  // 1. run(data, 'encrypted.zip', Purpose.READ_IN_DIR)
  // 2. run(data, '0001.jpg', Purpose.READ_IN_ZIP)
  // ...
  // 4. run(data, '0001.jpg', Purpose.WRITE)
  // ...
  // 5. run(data, '0001.jpg', Purpose.READ_IN_DIR)
  //
  run(data, filePath, purpose) {
    const cryptor = this.getCryptor(filePath, purpose);
    const padding = Padding.AUTO;
    if (purpose === Purpose.READ_IN_DIR) {
      return cryptor.decrypt(data, { padding });
    } else if (purpose === Purpose.WRITE) {
      return cryptor.encrypt(data, { padding });
    }
    return data;
  }
}

const cryptoProvider = new ContentCryptoProvider(key);
const parser = new ComicParser('./encrypted.zip' or './unzippedPath', cryptoProvider);

Log level setting:

import { LogLevel, ... } from '@ridi/comic-parser';
const parser = new ComicParser(/* path */, /* cryptoProvider */, /* logLevel */)
// or const parser = new ComicParser(/* path */, /* logLevel */)
parser.logger.logLevel = LogLevel.VERBOSE; // SILENT, ERROR, WARN(default), INFO, DEBUG, VERBOSE

API

parse(parseOptions)

Returns Promise<ComicBook> with:

  • ComicBook: Instance with image path, size, etc.

Or throw exception.

parseOptions: ?object


readItem(item, readOptions)

Returns string or Buffer in Promise with:

  • If readOptions.base64 is true:

    • string
  • Other:

    • Buffer

or throw exception.

item: Item

readOptions: ?object


readItems(items, readOptions)

Returns string[] or Buffer[] in Promise with:

  • If readOptions.base64 is true:

    • string
  • Other:

    • Buffer

or throw exception.

items: Item[]

readOptions: ?object


unzip(unzipPath, overwrite)

Returns Promise<boolean> with:

  • If result is true, unzip is successful or has already been unzipped.

Or throw exception.

unzipPath: string

overwrite: boolean


onProgress = callback(step, totalStep, action)

Tells the progress of parser through callback.

const { Action } = ComicParser; // PARSE, READ_ITEMS
parser.onProgress = (step, totalStep, action) => {
  console.log(`[${action}] ${step} / ${totalStep}`);
}

Model

ComicBook

  • items: Item[]
  • toRaw(): object

Item

  • index: ?string
  • path: ?string
  • size: ?number
  • width: ?number
  • height: ?number
  • toRaw(): object

Parse Options


unzipPath: ?string

If specified, unzip to that path.

only using if input is Zip file.

Default: undefined


overwrite: boolean

If true, overwrite to unzipPath when unzip.

only using if unzipPath specified.

Default: true


ext: string[]

File extension to allow when extracting lists.

Default: ['jpg', 'jpeg', 'png', 'bmp', 'gif']


parseImageSize: boolean|number

If true, image size parse. (parse may be slower.)

Default: false

Read Options


force: boolean

If true, ignore any exceptions that occur within parser.

Default: false


base64: boolean

If false, reads image into a buffer.

Default: false

License

MIT