OpenEljur TypeScript SDK

TypeScript SDK for OpenEljur.

Install

npm i @openeljur/typescript-sdk

Quick Start

import { OpenEljurClient } from "@openeljur/typescript-sdk";

const client = new OpenEljurClient({
  baseUrl: "http://localhost:8080",
});

const login = await client.login({
  username: "user",
  password: "pass",
  school_id: "eljur",
});

if (!login.ok || !login.data?.token) {
  throw new Error(login.error?.message ?? "Login failed");
}

const diary = await client.diary({
  access_token: login.data.token,
  school_id: "eljur",
});

Unwrap Helper

const token = (await client.unwrap(client.login({ username, password, school_id }))).token;

unwrap() throws OpenEljurAPIError if unified response contains error.

Endpoints

• login() -> POST /v1/auth/login
• diary() -> POST /v1/diary
• marks() -> POST /v1/marks
• updates() -> POST /v1/updates
• messages() -> POST /v1/messages
• dashboard() -> POST /v1/dashboard
• schoolsSearch() -> POST /v1/schools/search
• healthz() -> GET /healthz

Development

npm install
npm run build
npm run typecheck

License

MIT