-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README in progress; v2.0.0 release in progress;
- Loading branch information
1 parent
428c613
commit 70f71c4
Showing
2 changed files
with
8 additions
and
174 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,175 +1,9 @@ | ||
| <div align="center"> | ||
| <p> | ||
| <img src="https://i.imgur.com/Zz8viJd.png" alt="kreta.js" title="kreta.js" /> | ||
| </p> | ||
| <p> | ||
| <img alt="kreta.js npm version" src="https://img.shields.io/npm/v/kreta.js?style=for-the-badge&logo=npm&logoColor=fff&color=C12419" /> | ||
| <img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/blazsmaster/kreta.js?style=for-the-badge" /> | ||
| <img alt="GitHub issues" src="https://img.shields.io/github/issues/blazsmaster/kreta.js?style=for-the-badge" /> | ||
| <img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/blazsmaster/kreta.js?style=for-the-badge" /> | ||
| </p> | ||
| <p> | ||
| <img alt="Node.js badge" src="https://img.shields.io/badge/Node.js-none?style=for-the-badge&logo=node.js&logoColor=white&color=339933" /> | ||
| <img alt="TypeScript badge" src="https://img.shields.io/badge/TypeScript-none?style=for-the-badge&logo=typescript&logoColor=white&color=3178C6" /> | ||
| <img alt="WebStorm badge" src="https://img.shields.io/badge/WebStorm-none?style=for-the-badge&logo=webstorm&logoColor=white&color=000000" /> | ||
| </p> | ||
| </div> | ||
| *en* **[WIP]** Please be patient, I'm working on it, a lot of things are changed since 1.0.6. | ||
| The module is working, but the documentation is not ready yet. You can check the source code for more information. | ||
|
|
||
| ## About | ||
| *hu* **[WIP]** Légy türelemmel, dolgozom rajta, sok minden megváltozott az 1.0.6 óta. | ||
| A modul működik, de a dokumentáció még nem készült el. További információért nézd meg a forráskódot. | ||
|
|
||
| kreta.js is a powerful and easy-to-use node.js module that wraps the Mobile API v3 of e-kréta. | ||
| 2.0.0 version release in a few days. | ||
|
|
||
| ### Pros | ||
|
|
||
| - Object-oriented | ||
| - Type declarations | ||
| - Simplified usage | ||
|
|
||
| ### Cons | ||
|
|
||
| - The api is not 100% covered and discovered, some endpoints are maybe missing | ||
| - ~~Bad error handling *(check [todo](#todo))*~~ | ||
|
|
||
| ## Installation | ||
|
|
||
| **The module requires node `v14.21.3` or higher for stable operation.** | ||
| Tested on node `v14.21.3` `v16.20.0` `v18.15.0`. | ||
|
|
||
| ```shell | ||
| $ npm install kreta.js | ||
| ``` | ||
|
|
||
| ```shell | ||
| $ yarn add kreta.js | ||
| ``` | ||
|
|
||
| ```shell | ||
| $ bower install kreta.js | ||
| ``` | ||
|
|
||
| ```shell | ||
| $ pnpm install kreta.js | ||
| ``` | ||
|
|
||
| ## Methods | ||
|
|
||
| Use the `Global` class to get data from the api without authentication, but if you want to use the protected methods, you have | ||
| to create a new instance of `Kreta`, then login with your credentials. **Never share or upload your credentials!** With | ||
| the `KretaAuthentication` class you can get the access and refresh tokens, then you can use it for your own purposes. | ||
|
|
||
| ```javascript | ||
| const { Kreta, KretaAuthentication } = require('kreta.js'); | ||
|
|
||
| // Create a new instance of Kreta and KretaAuthentication | ||
| const kreta = new Kreta({}) | ||
| const auth = new KretaAuthentication({}) | ||
|
|
||
| // AUTHENTICATION | ||
| auth.getAccessToken() // Get access token | ||
| auth.getRefreshToken() // Refresh access token | ||
|
|
||
| // GLOBAL - Unauthorized access | ||
| kreta.Global.getInstituteList() // Get institute list | ||
|
|
||
| // KRETA - Authentication required | ||
| kreta.getAnnouncedTests() // Get announced tests by date range or by uids | ||
| kreta.getClassAverage() // Get class averages | ||
| kreta.getClassMasters() // Get class masters by uids | ||
| kreta.getDeviceGivenState() // Get device given state | ||
| kreta.getEvaluations() // Get evaluations by date range | ||
| kreta.getGroups() // Get groups | ||
| kreta.getHomework() // Get homework by uid | ||
| kreta.getHomeworks() // Get homeworks by date range | ||
| kreta.getInstitute() // Get current institute | ||
| kreta.getInstituteList() // Get institute list | ||
| kreta.getLepEvents() // Get Lázár Ervin Program events | ||
| kreta.getLesson() // Get lesson by uid | ||
| kreta.getLessons() // Get lessons by date range | ||
| kreta.getNotes() // Get notes by date range | ||
| kreta.getNoticeBoardItems() // Get notice board items | ||
| kreta.getOmissions() // Get omissions by date range | ||
| kreta.getSchoolYearCalendar() // Get school year calendar | ||
| kreta.getStudent() // Get student info | ||
| kreta.getSubjectAverages() // Get personal subject averages | ||
| kreta.getTimeTableWeeks() // Get timetable weeks by date range | ||
|
|
||
| // ADMINISTRATION - Authentication required | ||
| kreta.Administration.getAccessControlSystemEvents() // Get access control system events | ||
| kreta.Administration.getAddressableClasses() // Get addressable classes | ||
| kreta.Administration.getAddressableGuardiansForClass() // Get addressable guardians for class by uid | ||
| kreta.Administration.getAddressableSzmkRepesentative() // Get addressable szmk representative | ||
| kreta.Administration.getAddressableType() // Get addressable type | ||
| kreta.Administration.getAddresseeType() // Get addressee type | ||
| kreta.Administration.getAdministrators() // Get institute administrators | ||
| kreta.Administration.getCaseTypes() // Get case types | ||
| kreta.Administration.getClassMasters() // Get class masters | ||
| kreta.Administration.getCurrentInstitutionDetails() // Get current institute details | ||
| kreta.Administration.getCurrentInstitutionModules() // Get current institute modules | ||
| kreta.Administration.getDirectors() // Get institute directors | ||
| kreta.Administration.getMessage() // Get message by uid | ||
| kreta.Administration.getMessageLimitations() // Get message limitation settings | ||
| kreta.Administration.getMessages() // Get messages | ||
| kreta.Administration.getTeachers() // Get institute teachers | ||
| kreta.Administration.getTmgiCaseTypes() // Get tmgi case types | ||
| kreta.Administration.getUnreadMessagesCount() // Get unread messages count | ||
| ``` | ||
|
|
||
| ## Example | ||
|
|
||
| ```javascript | ||
| const { Kreta } = require('kreta.js'); | ||
|
|
||
| // ES6 | ||
| // import { Kreta } from 'kreta.js'; | ||
|
|
||
| // login with credentials | ||
| const kreta = new Kreta({ | ||
| username: 'KRETA_USERNAME', | ||
| password: 'KRETA_PASSWORD', | ||
| institute_code: 'INSTITUTE_CODE' | ||
| }) | ||
|
|
||
| // get student data | ||
| kreta.getStudent() | ||
| .then((student) => console.log(`Hello ${student.Nev}!`)) | ||
| .catch((err) => console.log(`Oh no, an error occured: ${err}`)); | ||
|
|
||
| // get evaluations between two dates, then log out the last one | ||
| kreta.getEvaluations({ dateFrom: '2023-03-01', dateTo: '2023-03-14' }) | ||
| .then((evaluations) => evaulations[evaluations.length - 1]) | ||
| .catch((err) => console.log(`Oh no, an error occured: ${err}`)); | ||
|
|
||
| // get administration messages | ||
| kreta.Administration.getMessages() | ||
| .then((messages) => console.log(`You have ${messages.length} messages total!`)) | ||
| .catch((err) => console.log(`Oh no, an error occured: ${err}`)); | ||
| ``` | ||
|
|
||
| ## Todo | ||
|
|
||
| - [ ] Documentation | ||
| - Detailed usage of each method (usage, parameters, response, etc.) | ||
| - More examples (usage of each method and the module itself) | ||
| - Common errors (e.g. `KretaError: Invalid credentials`, `KretaError: Invalid institute code`, etc.) | ||
| - How to fix, handle and prevent them | ||
| - Which methods can throw them | ||
| - Which error codes and messages can be thrown | ||
| - [x] Better error handling | ||
| - Static KretaError response | ||
| - `KretaError: [ERROR_HERE]` | ||
| - Custom error messages and codes | ||
|
|
||
| ## Get help | ||
|
|
||
| If you have any questions, feel free to open an issue or contact me, or open an issue on | ||
| the [GitHub repository](https://github.com/blazsmaster/kreta.js/issues/new/choose) or go to | ||
| the [Discussions](https://github.com/blazsmaster/kreta.js/discussions). | ||
|
|
||
| ### Contact me | ||
|
|
||
| - [Discord](https://discord.com/channels/@me/688486778117816383) `Mr. Dogee#6959` | ||
|
|
||
| ## Contributing | ||
|
|
||
| If you want to contribute, feel free to open a [pull request](https://github.com/blazsmaster/kreta.js/pulls) or contact me. Any help or | ||
| feedback is appreciated. | ||
| 2.0.0 verzió kiadása néhány napon belül. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters