VklassWS Core

This package contains the accual web scraper and APIs. The package is not complete and will probaly never be. Much functionallity is not implemented yet. But you can contribute extenders to add functionallity ;)

Note! The core is likely to change drastically with breaking changes before the v1 relase.

Installation

Make you you have yarn version 2 installed.

1. Clone this repository
2. Run yarn install and yarn build
3. Run yarn link or use npm, to link the package.

Now, you can install the package using yarn add @vws/core or npm install @vws/core. Later, to unlink the package use yarn unlink in the core package.

Usage

First off you need to initialize (signin) a new core. Then you can you any method provided by the extenders, the names should be self explanatory.

import core from '@vws/core'
await core.init()

// Functionallity provided by extender news.
const news = core.getNews()

// Functionallity provided by extender news.
const feed = core.geedFeed()

Concepts

Concepts for the v1.0 relase can be found here.

Extenders

Extenders are separated from eachother (partially). Extenders will extend methods and properties the core class. All requests are chained together using superagent's agent. You will be using cheerio to parse and extract data from the HTML responses.

Contributing

Read rules and guidelines in contributing.md before continuing!

Extenders

Note! You will always be signed, so making requests to the main host is accepted by VKlass authentication service.

To make a new extender place a file in src/extenders with the name describing the extender the best. The exports will not export themself. To add the extender exports to the entry, add . You will also need to make a test specification for the extender. Below is a simple example extracting the feed from "/Latest.aspx". Remember to add export * from './extenders/your_extender' to index.ts to export all exports from your extender. To extend the core with the extender you need to import and add the extender to the core.

Testing Extenders

For the extender to always be working you will need to specify a test for the extender, so the issue can be fixed as soon as possible. The test will run every two hours to ensure the extenders is working. To make a test secification place a file with the same name as the extender ending with ".spec.ts". Below is an test specification example for the feed extender.