Releases: classchartsapi/classcharts-api-js
v2.6.0 - classcharts-api/types
- Types are now exported using the exports field on package.json. Making it easier to import specific ClassCharts types:
// Before
const { ActivityPoint } = require('classcharts-api/script/src/types.js')
import type { ActivityPoint } from 'classcharts-api/esm/src/types.js'
// After
const { ActivityPoint } = require('classcharts-api/types')
import type { ActivityPoint } from 'classcharts-api/types' - Certain commonly used types were previously exported in the main
mod.tsfile. Since it's easier to import types now, these are no longer exported in this file.
// Before
import type { ActivityPoint, ... } from 'classcharts-api'
// After
import type { ActivityPoint, ... } from 'classcharts-api/types'List of types affected by the latter change: ActivityPoint, Announcement, AttendanceDate, Badge, BehaviourTimelinePoint, Detention, Homework, Lesson, Student.
Full Changelog: v2.5.0...v2.6.0
v2.5.0 - Announcements Meta & Small Cleanup
- Implemented the
metaproperty on the.getAnnouncements()method. - Updated types for the
.getAnnouncements()method. - Removed the basic HTML sanitising on the
.getHomeworks()method - This was left in from when the library was initially created, and doesn't align with the "stick as close to the API as possible" direction I want to go with this library, and thus was removed. This does mean the.description_rawfield no longer exists on each homework, since.descriptionis now exactly as returned by the API.
Full Changelog: v2.4.3...v2.5.0
v2.4.3
Changes
- Fixed improper types for baseClient.ts
v2.4.2
fix: remove types from package.json build
v2.4.0 - Deno Support
Note: Node.js is still supported
With this release I migrated the library to Deno, improving ease of development and tests.
Changes:
- Deno support
- Support CommonJs as well as ESM (improved Node.js compat)
- BREAKING: Some types I do not have access to have been changed from
anytounknown
v2.3.1
v2.3.0 - Native Fetch
Instead of using ky-universal the library now uses native fetch. This allows for greater compatibility with services like vercel edge functions or cloudflare workers, at the expense of dropping nodejs versions less than 18 (I can add the ability to add your own fetch function if is required, to work around this issue).
Minor Changes
- 6552c28: Migrate to native fetch
v2.2.0
v2.1.3
Small release to require the options argument in getLessons:
https://classchartsapi.github.io/classcharts-api-js/classes/core_studentClient.StudentClient.html#getLessons