getting started

Install jsjiit 0.0.22 and make the first portal calls.

Full install options: Installation. Worked examples: Quick start guide. Method list: API reference.

The published bundle targets ES2020 in a browser. It uses fetch and window.crypto.subtle. It is not a Node HTTP client.

To build from this repo you need Node 18+, npm, [email protected], and jsdoc@^4.0.4. App code that only imports the CDN or dist/ does not.

flowchart TB
  npm["npm install jsjiit"]
  cdn["jsDelivr URL"]
  git["clone tashifkhan/jsjiit"]
  npm --> dist["dist/jsjiit.esm.js"]
  cdn --> min["dist/jsjiit.min.esm.js"]
  git --> src["src/index.js"]
  dist --> app[Browser app]
  min --> app
  src --> app

package.json 0.0.22 entry points:

Both export conditions point at the unminified ESM bundle. For a smaller CDN file use jsjiit.min.esm.js yourself.

This clone is 0.0.22. The repo README still shows @0.0.20. Check npm if you want latest. CDN 0.0.27 used by JPortal is a different publish than this source.

flowchart LR
  A[import WebPortal] --> B["new WebPortal()"]
  B --> C[student_login]
  C --> D[session on portal.session]
  D --> E[authenticated methods]

1. Import WebPortal from the bundle or src/index.js.
2. const portal = new WebPortal() sets session to null. No network yet.
3. await portal.student_login(username, password) POSTs encrypted bodies to /token/pretoken-check then /token/generate-token1, then stores a WebPortalSession.
4. Call methods on the same portal instance. They need this.session.

import { WebPortal } from "https://cdn.jsdelivr.net/npm/[email protected]/dist/jsjiit.min.esm.js";

const portal = new WebPortal();
await portal.student_login("your_username", "your_password");

const meta = await portal.get_attendance_meta();
const attendance = await portal.get_attendance(meta.latest_header(), meta.latest_semester());

classDiagram
  class WebPortal {
    session
    student_login()
    __hit()
  }
  class WebPortalSession {
    token
    expiry
    get_headers()
  }
  WebPortal --> WebPortalSession : session
  WebPortal --> AttendanceMeta
  WebPortal --> Registrations
  WebPortal --> ExamEvent
  AttendanceMeta --> AttendanceHeader
  AttendanceMeta --> Semester
  Registrations --> RegisteredSubject

• WebPortal in src/wrapper.js: login plus every data method
• WebPortalSession in src/wrapper.js: JWT, institute ids, get_headers()
• Models: AttendanceMeta, AttendanceHeader, Semester, RegisteredSubject, Registrations, ExamEvent
• Errors from src/exceptions.js: APIError, LoginError, SessionError, SessionExpired, AccountAPIError, NotLoggedIn

Older docs listed InvalidCredentialsException and WebPortalException. Those names are not in this source.

GitHub for this fork: tashifkhan/jsjiit. Upstream package.json still points at codeblech/jsjiit.

flowchart TD
  cdn[jsDelivr 0.0.22 min] --> page[script type=module]
  npm[npm [email protected]] --> bundler[import from jsjiit]
  git[clone] --> https[run_server plus src/index.js]

Most encrypted bodies go through serialize_payload inside WebPortal. __hit still JSON.stringifys that string as the fetch body when options.json is set, or sends it as options.body on login. deserialize_payload is implemented in encryption.js and is not used by wrapper.js in 0.0.22.

Details: Encryption and security.