Bakalari-TS-Api

Typescript connector for accessing Bakalari api

Client initiaizing

Using password

• Auto token refresh

import { BakalariAPI } from 'bakalari-ts-api';

const api = await BakalariApi.initialize({
    baseUrl: 'https://moje.bakalari.cz',
    username: 'pepa',
    password: `12345`,
});

Using Token

import { BakalariAPI } from 'bakalari-ts-api';

const api = new BakalariAPI({
    baseUrl: 'https://moje.bakalari.cz',
    token: TOKEN,
});

Using Refresh Token

• Auto token refresh

import { BakalariAPI } from 'bakalari-ts-api';

const api = new BakalariAPI({
    baseUrl: 'https://moje.bakalari.cz',
    refreshToken: REFRESH_TOKEN,
});

Subjects

api.subjects();

Timetable

Actual ( Current week shorthand )

api.timetable();

Actual ( With start date )

api.timetable({
    type: 'actual',
    date: '2023-12-30',
});

Permanent

api.timetable({
    type: 'permanent',
});

Marks

api.marks();

Kommens

Default

api.kommens();

Noticeboard

api.kommens({
    noticeboard: true,
});

Downloading Attachment

const { data, filename } = await api.attachment({ id: 'id' });

data.pipe(...);

User info

api.user();

Municipality ( Public )

import { BakalariAPI } from 'bakalari-ts-api';

const cities = BakalariAPI.getMunicipality();
const schools = BakalariAPI.getMunicipality('Praha 9');