├── EXAMPLE.env
├── assets
    ├── logo.png
    └── Readme.png
├── .gitignore
├── src
    ├── webapi
    │   ├── models
    │   │   └── models.ts
    │   ├── controllers
    │   │   ├── kardex
    │   │   │   └── kardexController.ts
    │   │   ├── baseController.ts
    │   │   ├── careers
    │   │   │   └── careersController.ts
    │   │   ├── users
    │   │   │   └── userController.ts
    │   │   ├── afis
    │   │   │   └── afisController.ts
    │   │   ├── grades
    │   │   │   └── gradesController.ts
    │   │   └── schedule
    │   │   │   └── scheduleController.ts
    │   └── index.ts
    ├── core
    │   ├── utils
    │   │   └── stringExtensions.ext.ts
    │   └── domain
    │   │   ├── kardex.ts
    │   │   ├── users.ts
    │   │   ├── grades.ts
    │   │   ├── map.ts
    │   │   ├── careers.ts
    │   │   └── afis.ts
    └── network
    │   ├── exceptions
    │       └── errorResponse.ts
    │   ├── siaseNetworkDataSource.ts
    │   ├── userDataSource.ts
    │   ├── kardexDataSource.ts
    │   ├── gradesDataSource.ts
    │   ├── careersDataSource.ts
    │   └── afisDataSource.ts
├── contributing.md
├── package.json
├── .github
    └── workflows
    │   └── master_siase-api.yml
├── readme.md
├── tsconfig.json
└── COPYING.txt


/EXAMPLE.env:
--------------------------------------------------------------------------------
1 | PORT=5000
2 | DEV=true
3 | SECRET="SECRETKEYHERE"
4 | 


--------------------------------------------------------------------------------
/assets/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GDSC-UANL/siase-api/HEAD/assets/logo.png


--------------------------------------------------------------------------------
/assets/Readme.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/GDSC-UANL/siase-api/HEAD/assets/Readme.png


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | build/*
2 | !build/webapi
3 | build/webapi/*
4 | !build/webapi/views
5 | node_modules/
6 | .env


--------------------------------------------------------------------------------
/src/webapi/models/models.ts:
--------------------------------------------------------------------------------
1 | export interface TokenPayload {
2 |     user: string
3 |     trim: string
4 |     careers: object[]
5 |     picture: string
6 |     name: string
7 | }
8 | 
9 | 


--------------------------------------------------------------------------------
/src/core/utils/stringExtensions.ext.ts:
--------------------------------------------------------------------------------
1 | 
2 | interface String {
3 |     capitalizeFirst(): string;
4 | }
5 | 
6 | String.prototype.capitalizeFirst = function (this: string): string {
7 |     return this.charAt(0).toUpperCase() + this.slice(1).toLowerCase();
8 | }


--------------------------------------------------------------------------------
/contributing.md:
--------------------------------------------------------------------------------
 1 | Gracias por tu interés en contribuir a la SIASE API
 2 | 
 3 | <br>
 4 | 
 5 | ## Contribuciones de código
 6 | 
 7 | ¡Los Pull Requests son bienvenidos!
 8 | 
 9 | Si estás interesado en resolver un [issue abierto](https://github.com/GDSC-UANL/siase-api/issues) asegúrate de comentar en la publicaión para que otros estén enterados.
10 | 
11 | <br>
12 | 
13 | ### Pasos para contribuir
14 | 
15 | 1. Haz un fork
16 | 2. Crea una rama para la feature que quieras hacer: `git checkout -b my-new-feature`
17 | 3. Haz un commit: `git commit -am 'Add some feature'`
18 | 4. Haz push a tu rama: `git push origin my-new-feature`
19 | 5. Sube un pull request
20 | 
21 | 
22 | <br>
23 | 
24 | ## Forks
25 | 
26 | Los forks estan permitidos siempre y cuando cumplan con la [licencia del proyecto](https://github.com/GDSC-UANL/siase-api/blob/master/LICENSE)


--------------------------------------------------------------------------------
/src/network/exceptions/errorResponse.ts:
--------------------------------------------------------------------------------
 1 | export class ErrorResponse extends Error {
 2 | 
 3 | 
 4 |     static sessionExpired = "Procedimiento restringido, iniciar sesion nuevamente."
 5 |     static inactivityTime = "El tiempo de inactividad (30 minutos) excedio, iniciar sesion nuevamente."
 6 | 
 7 |     static errors = {
 8 |         [this.sessionExpired]: new ErrorResponse(this.sessionExpired, 401),
 9 |         [this.inactivityTime]: new ErrorResponse(this.inactivityTime, 401)
10 |     }
11 | 
12 |     constructor(
13 |         public message = "Ocurrió un error al obtener la información",
14 |         public statusCode = 500
15 |     ) {
16 |         super(message)
17 |     }
18 | 
19 |     static getErrorByMessage(message: string) {
20 | 
21 |         const error = this.errors[message]
22 | 
23 |         return error ?? new ErrorResponse(message)
24 | 
25 |     }
26 | }


--------------------------------------------------------------------------------
/src/core/domain/kardex.ts:
--------------------------------------------------------------------------------
 1 | import "@siaseApi/core/utils/stringExtensions.ext"
 2 | 
 3 | export class MateriaKardex {
 4 |     semestreMateria: string = ""
 5 |     claveMateria: string = "";
 6 |     nombre: string = "";
 7 |     oportunidades: string[] = []
 8 |     laboratorio?: string
 9 | 
10 | 
11 |     setNombreFromValue(value: string) {
12 |         const name = value.trim()
13 |         this.nombre = name.capitalizeFirst();
14 |     }
15 | 
16 |     setClaveMateriaFromValue(value: string) {
17 |         this.claveMateria = value.trim()
18 |     }
19 | 
20 |     setSemestreFromvalue(value: string) {
21 |         this.semestreMateria = value.trim()
22 |     }
23 | 
24 | }
25 | 
26 | export class Kardex {
27 |     nombreAlumno: string = ""
28 |     carrera: string = ""
29 |     planEstudios: string = ""
30 |     materias: MateriaKardex[] = []
31 | 
32 |     setNombreAlumnoFromvalue(value: string) {
33 |         const name = value.split(":").pop()!.trim()
34 | 
35 |         this.nombreAlumno = name.split(" ").map(e => e.capitalizeFirst()).join(" ")
36 | 
37 |     }
38 | 
39 |     setCarreraFromValue(value: string) {
40 |         const name = value.split(":").pop()!.trim()
41 | 
42 |         this.carrera = name.split(" ").map(e => e.capitalizeFirst()).join(" ")
43 | 
44 |     }
45 | 
46 |     setPlanEstudiosFromValue(value: string) {
47 |         this.planEstudios = value.split(":").pop()!.trim();
48 |     }
49 | }


--------------------------------------------------------------------------------
/src/core/domain/users.ts:
--------------------------------------------------------------------------------
 1 | import "@siaseApi/core/utils/stringExtensions.ext"
 2 | import { Carrera } from "./careers";
 3 | export class InformacionAlumno {
 4 |     matricula: string = "";
 5 |     nombre: string = "";
 6 |     carrera: string = "";
 7 |     planEstudios: string = "";
 8 |     foto: string = "";
 9 | 
10 |     constructor(rawData?: string, foto?: string) {
11 |         if (rawData) {
12 |             const data = rawData.split("\n")
13 |             this.matricula = this.getValue(data[InformacionAlumnoValues.Matricula])
14 |             this.nombre = this.getValue(data[InformacionAlumnoValues.Nombre])
15 |             this.carrera = this.getValue(data[InformacionAlumnoValues.Carrera])
16 |             this.planEstudios = this.getValue(data[InformacionAlumnoValues.PlanEstudios])
17 |         }
18 | 
19 |         if (foto) this.foto = foto
20 | 
21 | 
22 |     }
23 | 
24 |     private getValue(data: string) {
25 |         const newData = data.trim();
26 |         const realValue = newData.split(":").pop()?.trim().replace(/\s/g, " ")
27 |         return realValue
28 |             ?.toLowerCase()
29 |             .split(' ')
30 |             .map(word =>
31 |                 word.capitalizeFirst()
32 |             )
33 |             .join(' ') ?? "";
34 | 
35 |     }
36 | }
37 | 
38 | export class AuthResponse {
39 |     carreras?: Carrera[]
40 |     trim?: string
41 | }
42 | 
43 | 
44 | enum InformacionAlumnoValues {
45 |     Matricula,
46 |     Nombre,
47 |     Carrera,
48 |     PlanEstudios
49 | }
50 | 


--------------------------------------------------------------------------------
/src/core/domain/grades.ts:
--------------------------------------------------------------------------------
 1 | import { Carrera } from '@siaseApi/core/domain/careers';
 2 | export class PeriodoCalificaciones {
 3 |     nombre?: string
 4 |     claveDependencia: string = ""
 5 |     claveUnidad: string = ""
 6 |     claveNivelAcademico: string = ""
 7 |     claveGradoAcademico: string = ""
 8 |     claveModalidad: string = ""
 9 |     clavePlanEstudios: string = ""
10 |     claveCarrera: string = ""
11 |     periodo?: string
12 | 
13 |     constructor(career?: Carrera, name?: string, period?: string) {
14 |         if (name) {
15 |             this.nombre = name.trim().capitalizeFirst();
16 |         }
17 | 
18 |         if (career) {
19 |             this.claveCarrera = career.claveCarrera!;
20 |             this.claveDependencia = career.claveDependencia!;
21 |             this.claveGradoAcademico = career.claveGradoAcademico!;
22 |             this.claveModalidad = career.claveModalidad!;
23 |             this.claveNivelAcademico = career.claveNivelAcademico!;
24 |             this.claveModalidad = career.claveModalidad!;
25 |             this.clavePlanEstudios = career.clavePlanEstudios!;
26 |             this.claveUnidad = career.claveUnidad!;
27 |         }
28 | 
29 |         if (period)
30 |             this.periodo = period;
31 | 
32 |     }
33 | 
34 | 
35 | 
36 | }
37 | 
38 | export class Calificacion {
39 |     claveMateria?: string
40 |     nombre?: string
41 |     tipoInscripcion?: string
42 |     grupo?: string
43 |     fecha?: string;
44 |     calificacion?: string;
45 |     oportunidad?: string
46 | }


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "siase-api",
 3 |   "version": "1.0.0",
 4 |   "description": "Un rest api para consumir los datos de SIASE",
 5 |   "main": "index.js",
 6 |   "scripts": {
 7 |     "start": "node build/webapi/index.js",
 8 |     "build": "tsc",
 9 |     "build-w": "tsc -w",
10 |     "dev": "nodemon build/webapi/index.js",
11 |     "postinstall": "npm run build"
12 |   },
13 |   "repository": {
14 |     "type": "git",
15 |     "url": "git+https://github.com/GDSC-UANL/siase-api.git"
16 |   },
17 |   "author": "GDSC UANL",
18 |   "license": "ISC",
19 |   "bugs": {
20 |     "url": "https://github.com/GDSC-UANL/siase-api/issues"
21 |   },
22 |   "homepage": "https://github.com/GDSC-UANL/siase-api#readme",
23 |   "dependencies": {
24 |     "axios": "^0.24.0",
25 |     "cheerio": "^1.0.0-rc.10",
26 |     "cors": "^2.8.5",
27 |     "dotenv": "^10.0.0",
28 |     "express": "^4.17.1",
29 |     "form-data": "^4.0.0",
30 |     "iconv-lite": "^0.6.3",
31 |     "jsonwebtoken": "^8.5.1",
32 |     "module-alias": "^2.2.2",
33 |     "morgan": "^1.10.0",
34 |     "node_extra_ca_certs_mozilla_bundle": "^1.0.4",
35 |     "typescript": "^4.5.2"
36 |   },
37 |   "devDependencies": {
38 |     "@types/axios": "^0.14.0",
39 |     "@types/cheerio": "^0.22.30",
40 |     "@types/cors": "^2.8.12",
41 |     "@types/express": "^4.17.13",
42 |     "@types/iconv-lite": "0.0.1",
43 |     "@types/jsonwebtoken": "^8.5.6",
44 |     "@types/morgan": "^1.9.3",
45 |     "nodemon": "^2.0.15"
46 |   },
47 |   "_moduleAliases": {
48 |     "@siaseApi": "./build"
49 |   }
50 | }
51 | 


--------------------------------------------------------------------------------
/src/network/siaseNetworkDataSource.ts:
--------------------------------------------------------------------------------
 1 | import iconv from 'iconv-lite';
 2 | import axios from "axios";
 3 | import { ErrorResponse } from './exceptions/errorResponse';
 4 | 
 5 | export class SiaseNetworkDataSource {
 6 |     protected axios = axios.create({
 7 |         timeout: 30000,
 8 |         responseType: "text",
 9 |     });
10 | 
11 |     constructor() {
12 | 
13 | 
14 |         this.axios.interceptors.request.use((request) => {
15 |             request.headers = {
16 |                 'Content-Type': 'application/x-www-form-urlencoded',
17 |                 "Referer": "https://deimos.dgi.uanl.mx/cgi-bin/wspd_cgi.sh/login.htm",
18 |                 "Origin": "https://deimos.dgi.uanl.mx/cgi-bin/wspd_cgi.sh/login.htm",
19 |                 "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/99.0.4844.51 Safari/537.36"
20 | 
21 |             }
22 |             request.responseType = 'arraybuffer'
23 |             return request
24 |         }, (error) => {
25 |             return Promise.reject(error)
26 |         })
27 | 
28 | 
29 |         this.axios.interceptors.response.use((value) => {
30 |             value.data = iconv.decode(value.data, "ISO-8859-1")
31 |             return value
32 |         }, (error) => {
33 |             return Promise.reject(error);
34 |         })
35 |     }
36 | 
37 |     getError($: cheerio.Root): ErrorResponse {
38 |         const regex = new RegExp(/\'(.*?)\'/g)
39 |         const alert = $("SCRIPT").last().html() ?? ""
40 |         const alertText = regex.exec(alert)?.pop() ?? "Ocurrió un error al obtener la información"
41 |         return ErrorResponse.getErrorByMessage(alertText);
42 |     }
43 | 
44 | }
45 | 


--------------------------------------------------------------------------------
/.github/workflows/master_siase-api.yml:
--------------------------------------------------------------------------------
 1 | # Docs for the Azure Web Apps Deploy action: https://github.com/Azure/webapps-deploy
 2 | # More GitHub Actions for Azure: https://github.com/Azure/actions
 3 | 
 4 | name: Build and deploy Node.js app to Azure Web App - Siase-Api
 5 | 
 6 | on:
 7 |   push:
 8 |     branches:
 9 |       - master
10 |   workflow_dispatch:
11 | 
12 | jobs:
13 |   build:
14 |     runs-on: ubuntu-latest
15 | 
16 |     steps:
17 |       - uses: actions/checkout@v2
18 | 
19 |       - name: Set up Node.js version
20 |         uses: actions/setup-node@v1
21 |         with:
22 |           node-version: '16.x'
23 | 
24 |       - name: npm install, build, and test
25 |         run: |
26 |           npm install
27 |           npm run build --if-present
28 |           npm run test --if-present
29 | 
30 |       - name: Upload artifact for deployment job
31 |         uses: actions/upload-artifact@v2
32 |         with:
33 |           name: node-app
34 |           path: .
35 | 
36 |   deploy:
37 |     runs-on: ubuntu-latest
38 |     needs: build
39 |     environment:
40 |       name: 'Production'
41 |       url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}
42 | 
43 |     steps:
44 |       - name: Download artifact from build job
45 |         uses: actions/download-artifact@v2
46 |         with:
47 |           name: node-app
48 | 
49 |       - name: 'Deploy to Azure Web App'
50 |         id: deploy-to-webapp
51 |         uses: azure/webapps-deploy@v2
52 |         with:
53 |           app-name: 'Siase-Api'
54 |           slot-name: 'Production'
55 |           publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_64D4E71754794E2F9474A2DAA5D626EF }}
56 |           package: .
57 | 


--------------------------------------------------------------------------------
/src/webapi/controllers/kardex/kardexController.ts:
--------------------------------------------------------------------------------
 1 | import { kardexDataSource } from '@siaseApi/network/kardexDataSource';
 2 | import { Response } from "express";
 3 | import { Carrera } from "@siaseApi/core/domain/careers";
 4 | import { BaseController, CustomRequest } from "@siaseApi/webapi/controllers/baseController";
 5 | import axios from 'axios'
 6 | import { ErrorResponse } from '@siaseApi/network/exceptions/errorResponse';
 7 | class KardexController extends BaseController {
 8 |     protected config(): void {
 9 | 
10 |         this.router.get("/:index",
11 |             (req, res, next) => this.verifyToken(req, res, next),
12 |             (req, res, next) => this.setCache(req, res, next, 2),
13 |             (req, res) => this.getKardexByIndex(req as CustomRequest, res))
14 |     }
15 | 
16 | 
17 |     private async getKardexByIndex(req: CustomRequest, res: Response) {
18 |         try {
19 | 
20 |             const rawIndex = req.params.index
21 | 
22 |             const index = Number.parseInt(rawIndex)
23 | 
24 |             if (Number.isNaN(index))
25 |                 return res.status(400).send("Invalid index")
26 | 
27 |             if (index < 0 || index >= req.careers.length)
28 |                 return res.status(400).send("Index out of bounds")
29 | 
30 |             const carrera = req.careers[index] as Carrera
31 | 
32 |             const data = await kardexDataSource.getKardex(carrera, req.user, req.trim);
33 | 
34 |             res.status(200).json(data)
35 | 
36 |         } catch (error: any) {
37 |             console.error(error)
38 | 
39 |             if (axios.isAxiosError(error))
40 |                 return res.status(503).send("SIASE no funciona")
41 | 
42 |             if (error instanceof ErrorResponse)
43 |                 return res.status(error.statusCode).send(error.message)
44 | 
45 |             res.status(500).send(error.message)
46 |         }
47 |     }
48 | 
49 | }
50 | 
51 | export const kardexController = new KardexController();
52 | 


--------------------------------------------------------------------------------
/src/core/domain/map.ts:
--------------------------------------------------------------------------------
 1 | import "@siaseApi/core/utils/stringExtensions.ext"
 2 | class Campus {
 3 |     id?: number;
 4 |     nombre?: string;
 5 |     latitud?: number;
 6 |     longitud?: number;
 7 |     edificios: Edificio[] = []
 8 | }
 9 | 
10 | class Edificio {
11 |     id?: number;
12 |     nombre?: string;
13 |     latitud?: number;
14 |     longitud?: number;
15 |     idCampus?: number
16 |     tipo?: TiposEdificios
17 | }
18 | 
19 | class Facultad extends Edificio {
20 | 
21 |     claveDependencia?: string
22 |     salones: Salon[] = []
23 |     edificios: Edificio[] = []
24 | 
25 |     constructor() {
26 |         super();
27 |         this.tipo = TiposEdificios.facultad
28 |     }
29 | }
30 | 
31 | class EdificioSalones extends Edificio {
32 |     salones: Salon[] = []
33 | 
34 |     constructor() {
35 |         super();
36 |         this.tipo = TiposEdificios.salones
37 |     }
38 | }
39 | 
40 | 
41 | class Salon {
42 |     claveDependencia?: string
43 |     idEdificio?: string
44 |     nombre?: string
45 |     latitud?: number;
46 |     longitud?: number;
47 | }
48 | 
49 | class Cafeteria extends Edificio {
50 |     claveDependencia?: string
51 |     menu: ItemMenu[] = []
52 | 
53 |     constructor() {
54 |         super();
55 |         this.tipo = TiposEdificios.cafeteria
56 |     }
57 | }
58 | 
59 | class ItemMenu {
60 |     nombre?: string;
61 |     precio?: number;
62 | }
63 | 
64 | class Gimnasio extends Edificio {
65 |     claveDependencia?: string
66 |     constructor() {
67 |         super();
68 |         this.tipo = TiposEdificios.gimnasio
69 |     }
70 | }
71 | 
72 | class Estadio extends Edificio {
73 |     constructor() {
74 |         super();
75 |         this.tipo = TiposEdificios.estadio
76 |     }
77 | }
78 | 
79 | 
80 | class Biblioteca extends Edificio {
81 |     constructor() {
82 |         super();
83 |         this.tipo = TiposEdificios.biblioteca
84 |     }
85 | }
86 | 
87 | 
88 | enum TiposEdificios {
89 |     facultad,
90 |     cafeteria,
91 |     gimnasio,
92 |     biblioteca,
93 |     estadio,
94 |     salones
95 | }
96 | 
97 | 
98 | 
99 | 


--------------------------------------------------------------------------------
/src/webapi/controllers/baseController.ts:
--------------------------------------------------------------------------------
 1 | import { TokenPayload } from '@siaseApi/webapi/models/models';
 2 | import { Request, Router } from "express";
 3 | import jwt from 'jsonwebtoken';
 4 | import { Carrera } from '@siaseApi/core/domain/careers';
 5 | 
 6 | export interface CustomRequest extends Request<any> {
 7 |     user: string;
 8 |     trim: string;
 9 |     careers: Carrera[];
10 |     picture: string;
11 |     name: string;
12 | }
13 | export abstract class BaseController {
14 | 
15 |     router: Router = Router();
16 | 
17 |     private dayInMillis = 60 * 60 * 24
18 | 
19 | 
20 |     constructor() {
21 |         this.config();
22 |     }
23 | 
24 |     protected abstract config(): void;
25 | 
26 | 
27 | 
28 |     async verifyToken(req: any, res: any, next: any) {
29 |         try {
30 |             res.setHeader("Content-Type", "application/json; charset=utf-8");
31 | 
32 |             if (!req.headers.authorization)
33 |                 return res.status(401).send('Unauhtorized Request');
34 | 
35 |             let token = req.headers.authorization.split(' ')[1];
36 |             if (token === 'null')
37 |                 return res.status(401).send('Unauhtorized Request');
38 | 
39 | 
40 |             const payload = jwt.verify(token, process.env.SECRET!) as TokenPayload;
41 | 
42 |             if (!payload)
43 |                 return res.status(401).send('Invalid or expired token');
44 | 
45 | 
46 |             req.name = payload.name;
47 |             req.user = payload.user;
48 |             req.trim = payload.trim;
49 |             req.careers = payload.careers;
50 |             req.picture = payload.picture;
51 | 
52 |             next();
53 | 
54 |         } catch (e) {
55 |             console.error(e);
56 |             return res.status(401).send('Unauhtorized Request');
57 |         }
58 |     }
59 | 
60 | 
61 |     async setCache(req: any, res: any, next: any, timeInDays?: number) {
62 |         if (req.method != "GET") {
63 |             res.set("Cache-control", `no-store`)
64 |             next();
65 |             return;
66 |         }
67 | 
68 | 
69 |         let period = timeInDays !== undefined ? this.dayInMillis * timeInDays : this.dayInMillis * 25
70 | 
71 |         res.set("Cache-control", `private, max-age=${period}`)
72 | 
73 |         next();
74 |     }
75 | 
76 | }
77 | 


--------------------------------------------------------------------------------
/src/webapi/controllers/careers/careersController.ts:
--------------------------------------------------------------------------------
 1 | import { BaseController, CustomRequest } from "@siaseApi/webapi/controllers/baseController";
 2 | import { Response } from 'express';
 3 | import axios from 'axios';
 4 | import { userDataSource } from '@siaseApi/network/userDataSource';
 5 | import { ErrorResponse } from '@siaseApi/network/exceptions/errorResponse';
 6 | 
 7 | class CareersController extends BaseController {
 8 |     protected config(): void {
 9 |         this.router.get("/",
10 |             this.verifyToken,
11 |             (req, res, next) => this.setCache(req, res, next),
12 |             (req, res) => this.getUserCareers(req as CustomRequest, res))
13 |         this.router.get("/:index",
14 |             this.verifyToken,
15 |             (req, res, next) => this.setCache(req, res, next),
16 |             (req, res) => this.getCareerDetail(req as CustomRequest, res))
17 | 
18 |     }
19 | 
20 |     async getUserCareers(req: CustomRequest, res: Response) {
21 |         try {
22 | 
23 |             res.status(200).json(req.careers)
24 | 
25 |         } catch (error: any) {
26 |             console.error(error)
27 | 
28 |             if (axios.isAxiosError(error))
29 |                 return res.status(503).send("SIASE no funciona")
30 | 
31 |             res.status(500).send(error.message)
32 |         }
33 |     }
34 | 
35 |     async getCareerDetail(req: CustomRequest, res: Response) {
36 |         try {
37 | 
38 |             const rawIndex = req.params.index
39 | 
40 |             const index = Number.parseInt(rawIndex)
41 | 
42 |             if (Number.isNaN(index))
43 |                 return res.status(400).send("Invalid index")
44 | 
45 |             if (index < 0 || index >= req.careers.length)
46 |                 return res.status(400).send("Index out of bounds")
47 | 
48 |             const careers = req.careers[index]
49 | 
50 |             const userInfoResponse = await userDataSource.getUserInfo(careers, req.user, req.trim);
51 | 
52 |             res.status(200).json(userInfoResponse)
53 | 
54 |         } catch (error: any) {
55 |             console.error(error)
56 | 
57 |             if (axios.isAxiosError(error))
58 |                 return res.status(503).send("SIASE no funciona")
59 | 
60 |             if (error instanceof ErrorResponse)
61 |                 return res.status(error.statusCode).send(error.message)
62 | 
63 |             res.status(500).send(error.message)
64 |         }
65 |     }
66 | 
67 | }
68 | 
69 | export const careersController = new CareersController(); 


--------------------------------------------------------------------------------
/src/webapi/index.ts:
--------------------------------------------------------------------------------
 1 | require("module-alias/register")
 2 | import { afisController } from '@siaseApi/webapi/controllers/afis/afisController';
 3 | import { kardexController } from '@siaseApi/webapi/controllers/kardex/kardexController';
 4 | import { userController } from '@siaseApi/webapi/controllers/users/userController';
 5 | import { scheduleController } from '@siaseApi/webapi/controllers/schedule/scheduleController';
 6 | import { careersController } from '@siaseApi/webapi/controllers/careers/careersController';
 7 | import { gradesController } from '@siaseApi/webapi/controllers/grades/gradesController';
 8 | import express, { Application } from 'express';
 9 | import cors from 'cors'
10 | import morgan from "morgan";
11 | import dotenv from 'dotenv'
12 | import fs from 'fs'
13 | import https from 'https'
14 | import path from 'path';
15 | const CERT_PATH = './node_modules/node_extra_ca_certs_mozilla_bundle/ca_bundle/ca_intermediate_root_bundle.pem'
16 | 
17 | class Server {
18 | 
19 |     private app: Application;
20 | 
21 |     constructor() {
22 |         this.app = express()
23 |         this.config()
24 |         this.routes()
25 |     }
26 | 
27 |     private config() {
28 |         https.globalAgent.options.ca = fs.readFileSync(CERT_PATH);
29 |         dotenv.config();
30 |         this.app.set("port", process.env.PORT || 5000)
31 |         this.app.use(cors())
32 |         this.app.use(morgan('dev'));
33 |         this.app.use(express.json())
34 |         this.app.use(express.urlencoded({ extended: false }));
35 | 
36 |     }
37 | 
38 |     private routes() {
39 | 
40 |         this.app.use("/api/user", userController.router)
41 |         this.app.use("/api/schedules", scheduleController.router)
42 |         this.app.use("/api/kardex", kardexController.router)
43 |         this.app.use("/api/careers", careersController.router)
44 |         this.app.use("/api/afis", afisController.router)
45 |         this.app.use("/api/grades", gradesController.router)
46 | 
47 |         this.app.use('/views', express.static(__dirname + '/views/landing/'))
48 | 
49 | 
50 |         this.app.get("/", (req, res) => {
51 | 
52 |             res.sendFile(path.join(__dirname + '/views/landing/index.html'));
53 | 
54 |         })
55 | 
56 | 
57 |         this.app.get("/api", (req, res) => {
58 |             res.sendFile(path.join(__dirname + '/views/landing/index.html'));
59 |         })
60 |     }
61 | 
62 |     start() {
63 |         const port = this.app.get('port')
64 | 
65 |         this.app.listen(port, () => {
66 |             console.log("Servidor iniciado en puerto " + port)
67 |         })
68 |     }
69 | 
70 | }
71 | 
72 | const server = new Server()
73 | server.start()
74 | 


--------------------------------------------------------------------------------
/src/webapi/controllers/users/userController.ts:
--------------------------------------------------------------------------------
 1 | import { InformacionAlumno } from '@siaseApi/core/domain/users';
 2 | import { Request, Response } from "express";
 3 | import { BaseController, CustomRequest } from "@siaseApi/webapi/controllers/baseController";
 4 | import { userDataSource } from '@siaseApi/network/userDataSource';
 5 | import jwt from 'jsonwebtoken'
 6 | import axios from 'axios';
 7 | import { ErrorResponse } from '@siaseApi/network/exceptions/errorResponse';
 8 | 
 9 | class UserController extends BaseController {
10 | 
11 | 
12 |     protected config() {
13 |         this.router.get("/",
14 |             (req, res, next) => this.verifyToken(req, res, next),
15 |             (req, res, next) => this.setCache(req, res, next),
16 |             (req, res) => this.getUser(req as CustomRequest, res))
17 | 
18 |         this.router.post("/", (req, res) => this.authUser(req, res))
19 |     }
20 | 
21 |     async authUser(req: Request, res: Response) {
22 |         try {
23 |             const password = req.body.password
24 | 
25 |             const user = req.body.user
26 | 
27 |             const loginResponse = await userDataSource.loginUser(user, password);
28 | 
29 |             const userInfo: InformacionAlumno = await userDataSource.getUserInfo(
30 |                 loginResponse.carreras![0],
31 |                 user,
32 |                 loginResponse.trim!
33 |             );
34 | 
35 | 
36 |             const token = jwt.sign({
37 |                 user: user,
38 |                 name: userInfo?.nombre,
39 |                 trim: loginResponse.trim,
40 |                 careers: loginResponse.carreras,
41 |             }, process.env.SECRET!, {
42 |                 expiresIn: "30m"
43 |             })
44 | 
45 |             res.status(200).json({
46 |                 nombre: userInfo?.nombre,
47 |                 matricula: user,
48 |                 carreras: loginResponse.carreras,
49 |                 foto: userInfo?.foto,
50 |                 token,
51 |             })
52 |         } catch (error: any) {
53 |             console.error(error)
54 | 
55 |             if (axios.isAxiosError(error))
56 |                 return res.status(503).send("SIASE no funciona")
57 | 
58 |             if (error instanceof ErrorResponse)
59 |                 return res.status(error.statusCode).send(error.message)
60 | 
61 |             res.status(500).send(error.message)
62 |         }
63 | 
64 |     }
65 | 
66 |     async getUser(req: CustomRequest, res: Response) {
67 |         try {
68 | 
69 |             res.status(200).json({
70 |                 nombre: req.name,
71 |                 matricula: req.user,
72 |                 carreras: req.careers,
73 |             })
74 | 
75 |         } catch (error: any) {
76 |             console.error(error)
77 | 
78 |             if (axios.isAxiosError(error))
79 |                 return res.status(503).send("SIASE no funciona")
80 | 
81 |             res.status(500).send(error.message)
82 |         }
83 |     }
84 | 
85 | }
86 | 
87 | export const userController = new UserController();
88 | 


--------------------------------------------------------------------------------
/src/network/userDataSource.ts:
--------------------------------------------------------------------------------
 1 | import { Carrera } from '@siaseApi/core/domain/careers';
 2 | import { AuthResponse, InformacionAlumno } from '@siaseApi/core/domain/users';
 3 | import { SiaseNetworkDataSource } from '@siaseApi/network/siaseNetworkDataSource';
 4 | import cheerio from 'cheerio'
 5 | 
 6 | class UserDataSource extends SiaseNetworkDataSource {
 7 | 
 8 |     async loginUser(user: string, password: string): Promise<AuthResponse> {
 9 | 
10 |         const formData = new URLSearchParams()
11 | 
12 |         formData.append("HTMLUsuCve", user)
13 |         formData.append("HTMLPassword", password)
14 |         formData.append("HTMLPrograma", "")
15 |         formData.append("HTMLTipCve", "01")
16 | 
17 |         const response = await this.axios.post("https://deimos.dgi.uanl.mx/cgi-bin/wspd_cgi.sh/eselcarrera.htm", formData)
18 | 
19 |         const $ = cheerio.load(response.data)
20 | 
21 |         const trim = $("[name=HTMLtrim]").attr("value") ?? null
22 | 
23 |         if (trim == null)
24 |             throw this.getError($)
25 | 
26 |         const form = $("form[name=SelCarrera]")
27 | 
28 |         if (form.length == 0)
29 |             throw this.getError($)
30 | 
31 |         const carreras = form.first().children()
32 | 
33 |         const parsedCarreras: Carrera[] = []
34 | 
35 |         let sectionNumber = 0;
36 | 
37 |         for (let carrera of carreras) {
38 | 
39 |             const parsedCarrera = $(carrera);
40 | 
41 |             if (parsedCarrera.is("p")) sectionNumber++
42 |             if (sectionNumber > 1) break;
43 | 
44 |             if (!parsedCarrera.is("a")) continue;
45 | 
46 |             const name = parsedCarrera.text();
47 |             const urlData = parsedCarrera.attr("href")
48 | 
49 |             if (!urlData) continue;
50 | 
51 | 
52 |             parsedCarreras.push(new Carrera(urlData, name))
53 | 
54 |         }
55 | 
56 |         const authResponse = new AuthResponse()
57 |         authResponse.carreras = parsedCarreras;
58 |         authResponse.trim = trim;
59 | 
60 |         return authResponse;
61 | 
62 |     }
63 | 
64 |     async getUserInfo(query: Carrera, user: string, trim: string): Promise<InformacionAlumno> {
65 |         const formData = new URLSearchParams()
66 | 
67 |         formData.append("HTMLUsuario", user)
68 |         formData.append("HTMLCve_Carrera", query.claveCarrera!)
69 |         formData.append("HTMLCve_Dependencia", query.claveDependencia!)
70 |         formData.append("HTMLCve_Grado_Academico", query.claveGradoAcademico!)
71 |         formData.append("HTMLCve_Modalidad", query.claveModalidad!)
72 |         formData.append("HTMLCve_Nivel_Academico", query.claveNivelAcademico!)
73 |         formData.append("HTMLCve_Plan_Estudio", query.clavePlanEstudios!)
74 |         formData.append("HTMLtrim", trim!)
75 |         formData.append("HTMLCve_Unidad", query.claveUnidad!)
76 |         formData.append("HTMLTipCve", "01")
77 | 
78 |         const response = await this.axios.get("https://deimos.dgi.uanl.mx/cgi-bin/wspd_cgi.sh/maintop.htm", {
79 |             params: formData
80 |         })
81 | 
82 |         const $ = cheerio.load(response.data)
83 |         const images = $("img")
84 | 
85 |         const profilePicture = $(images[1]).attr("src")
86 | 
87 |         const userData = $(".style1")
88 |         if (userData.text() == "") throw this.getError($)
89 | 
90 |         const userInfo = new InformacionAlumno(userData.text(), profilePicture)
91 | 
92 |         return userInfo;
93 |     }
94 | }
95 | 
96 | export const userDataSource = new UserDataSource();


--------------------------------------------------------------------------------
/src/webapi/controllers/afis/afisController.ts:
--------------------------------------------------------------------------------
 1 | import axios from "axios";
 2 | import { Response } from "express";
 3 | import { Carrera } from "@siaseApi/core/domain/careers";
 4 | import { afisDataSource } from "@siaseApi/network/afisDataSource";
 5 | import { BaseController, CustomRequest } from "@siaseApi/webapi/controllers/baseController";
 6 | import { ErrorResponse } from "@siaseApi/network/exceptions/errorResponse";
 7 | 
 8 | class AfisController extends BaseController {
 9 |     protected config(): void {
10 |         this.router.get("/:index/history",
11 |         (req, res, next) => this.verifyToken(req, res, next),
12 |         (req, res, next) => this.setCache(req, res, next, 1),
13 |         (req, res) => this.getCareerAfisHistory(req as CustomRequest, res)
14 |     )
15 | 
16 |         this.router.get("/:index/:month",
17 |             (req, res, next) => this.verifyToken(req, res, next),
18 |             (req, res, next) => this.setCache(req, res, next, 1),
19 |             (req, res) => this.getCareerAfisByIndex(req as CustomRequest, res)
20 |         )
21 | 
22 |         this.router.get("/:index",
23 |             (req, res, next) => this.verifyToken(req, res, next),
24 |             (req, res, next) => this.setCache(req, res, next, 1),
25 |             (req, res) => this.getCareerAfisByIndex(req as CustomRequest, res)
26 |         )
27 | 
28 |     
29 |     }
30 | 
31 |     async getCareerAfisByIndex(req: CustomRequest, res: Response) {
32 |         try {
33 | 
34 |             const rawIndex = req.params.index
35 |             const month = req.params.month ?? null
36 | 
37 |             const index = Number.parseInt(rawIndex)
38 | 
39 |             if (Number.isNaN(index))
40 |                 return res.status(400).send("Invalid index")
41 | 
42 |             if (index < 0 || index >= req.careers.length)
43 |                 return res.status(400).send("Index out of bounds")
44 | 
45 |             const carrera = req.careers[index] as Carrera
46 | 
47 |             const data = await afisDataSource.getAfisFromCareer(carrera, month, req.user, req.trim);
48 | 
49 |             res.status(200).json(data)
50 | 
51 |         } catch (error: any) {
52 |             console.error(error)
53 | 
54 |             if (axios.isAxiosError(error))
55 |                 return res.status(503).send("SIASE no funciona")
56 | 
57 |             if (error instanceof ErrorResponse)
58 |                 return res.status(error.statusCode).send(error.message)
59 | 
60 |             res.status(500).send(error.message)
61 |         }
62 |     }
63 | 
64 |     async getCareerAfisHistory(req: CustomRequest, res: Response) {
65 |         try {
66 | 
67 |             const rawIndex = req.params.index
68 |             const month = req.params.month ?? null
69 | 
70 |             const index = Number.parseInt(rawIndex)
71 | 
72 |             if (Number.isNaN(index))
73 |                 return res.status(400).send("Invalid index")
74 | 
75 |             if (index < 0 || index >= req.careers.length)
76 |                 return res.status(400).send("Index out of bounds")
77 | 
78 |             const carrera = req.careers[index] as Carrera
79 | 
80 |             const data = await afisDataSource.getAfisHistoryFromCareer(carrera, req.user, req.trim);
81 | 
82 |             res.status(200).json(data)
83 | 
84 |         } catch (error: any) {
85 |             console.error(error)
86 | 
87 |             if (axios.isAxiosError(error))
88 |                 return res.status(503).send("SIASE no funciona")
89 | 
90 |             res.status(500).send(error.message)
91 |         }
92 |     }
93 | 
94 | }
95 | 
96 | export const afisController = new AfisController();


--------------------------------------------------------------------------------
/src/webapi/controllers/grades/gradesController.ts:
--------------------------------------------------------------------------------
 1 | import axios from "axios";
 2 | import { Response } from "express";
 3 | import { Carrera } from "@siaseApi/core/domain/careers";
 4 | import { BaseController, CustomRequest } from "@siaseApi/webapi/controllers/baseController";
 5 | import { gradesDataSource } from "@siaseApi/network/gradesDataSource";
 6 | import { PeriodoCalificaciones } from "@siaseApi/core/domain/grades";
 7 | import { ErrorResponse } from "@siaseApi/network/exceptions/errorResponse";
 8 | 
 9 | class GradesController extends BaseController {
10 |     protected config(): void {
11 |         this.router.get("/:index",
12 |             (req, res, next) => this.verifyToken(req, res, next),
13 |             (req, res, next) => this.setCache(req, res, next),
14 |             (req, res) => this.getGradesPeriods(req as CustomRequest, res)
15 |         )
16 | 
17 |         this.router.get("/:index/:periodo",
18 |             (req, res, next) => this.verifyToken(req, res, next),
19 |             (req, res, next) => this.setCache(req, res, next, 1),
20 |             (req, res) => this.getGradesDetail(req as CustomRequest, res)
21 |         );
22 |     }
23 | 
24 |     async getGradesPeriods(req: CustomRequest, res: Response) {
25 |         try {
26 | 
27 |             const rawIndex = req.params.index
28 | 
29 |             const index = Number.parseInt(rawIndex)
30 | 
31 |             if (Number.isNaN(index))
32 |                 return res.status(400).send("Invalid index")
33 | 
34 |             if (index < 0 || index >= req.careers.length)
35 |                 return res.status(400).send("Index out of bounds")
36 | 
37 |             const carrera = req.careers[index] as Carrera
38 | 
39 |             const data = await gradesDataSource.getGradesPeriods(carrera, req.user, req.trim);
40 | 
41 |             res.status(200).json(data)
42 | 
43 |         } catch (error: any) {
44 |             console.error(error)
45 | 
46 |             if (axios.isAxiosError(error))
47 |                 return res.status(503).send("SIASE no funciona")
48 | 
49 |             if (error instanceof ErrorResponse)
50 |                 return res.status(error.statusCode).send(error.message)
51 | 
52 |             res.status(500).send(error.message)
53 |         }
54 |     }
55 | 
56 |     async getGradesDetail(req: CustomRequest, res: Response) {
57 |         try {
58 | 
59 |             const rawIndex = req.params.index
60 | 
61 |             const index = Number.parseInt(rawIndex)
62 | 
63 |             if (Number.isNaN(index))
64 |                 return res.status(400).send("Invalid index")
65 | 
66 |             if (index < 0 || index >= req.careers.length)
67 |                 return res.status(400).send("Index out of bounds")
68 | 
69 |             const periodo = req.params.periodo;
70 | 
71 |             if (!periodo)
72 |                 return res.status(400).send("Periodo missing")
73 | 
74 |             const periodoCalificacion = { ...req.careers[index] } as PeriodoCalificaciones
75 | 
76 |             periodoCalificacion.periodo = periodo
77 | 
78 |             const data = await gradesDataSource.getGradesDetail(periodoCalificacion, req.user, req.trim);
79 | 
80 |             res.status(200).json(data)
81 | 
82 |         } catch (error: any) {
83 |             console.error(error)
84 | 
85 |             if (axios.isAxiosError(error))
86 |                 return res.status(503).send("SIASE no funciona")
87 | 
88 |             if (error instanceof ErrorResponse)
89 |                 return res.status(error.statusCode).send(error.message)
90 | 
91 |             res.status(500).send(error.message)
92 |         }
93 |     }
94 | 
95 | }
96 | 
97 | export const gradesController = new GradesController();


--------------------------------------------------------------------------------
/src/network/kardexDataSource.ts:
--------------------------------------------------------------------------------
  1 | import { Carrera } from "@siaseApi/core/domain/careers";
  2 | import { Kardex, MateriaKardex } from "@siaseApi/core/domain/kardex";
  3 | import { SiaseNetworkDataSource } from "@siaseApi/network/siaseNetworkDataSource";
  4 | import cheerio from 'cheerio'
  5 | 
  6 | class KardexDataSource extends SiaseNetworkDataSource {
  7 | 
  8 |     async getKardex(query: Carrera, user: string, trim: string): Promise<Kardex | null> {
  9 |         const formData = new URLSearchParams()
 10 | 
 11 |         formData.append("HTMLUsuario", user)
 12 |         formData.append("HTMLCve_Carrera", query.claveCarrera!)
 13 |         formData.append("HTMLCve_Dependencia", query.claveDependencia!)
 14 |         formData.append("HTMLCve_Grado_Academico", query.claveGradoAcademico!)
 15 |         formData.append("HTMLCve_Modalidad", query.claveModalidad!)
 16 |         formData.append("HTMLCve_Nivel_Academico", query.claveNivelAcademico!)
 17 |         formData.append("HTMLCve_Plan_Estudio", query.clavePlanEstudios!)
 18 |         formData.append("HTMLtrim", trim!)
 19 |         formData.append("HTMLCve_Unidad", query.claveUnidad!)
 20 |         formData.append("HTMLTipCve", "01")
 21 | 
 22 |         const response = await this.axios.get("https://deimos.dgi.uanl.mx/cgi-bin/wspd_cgi.sh/econkdx01.htm", {
 23 |             params: formData
 24 |         })
 25 | 
 26 |         const $ = cheerio.load(response.data)
 27 | 
 28 |         const kardex = new Kardex();
 29 | 
 30 |         const tables = $("table")
 31 | 
 32 |         const infoTable = tables.first();
 33 |         const kardexTable = $(tables[1])
 34 | 
 35 |         if (tables.length == 0) 
 36 |             throw this.getError($)
 37 |         
 38 | 
 39 |         const subjects = kardexTable.find("tr")
 40 |         const kardexInfo = infoTable.find("tr")
 41 | 
 42 |         const careerStudyPlan = $(kardexInfo.get(KardexInfoValues.CarreraPlanEstudios)).find("td")
 43 | 
 44 |         kardex.setNombreAlumnoFromvalue($(kardexInfo.get(KardexInfoValues.Nombre)).text())
 45 |         kardex.setCarreraFromValue(careerStudyPlan.first().text())
 46 |         kardex.setPlanEstudiosFromValue(careerStudyPlan.last().text())
 47 | 
 48 |         for (let i = 0; i < subjects.length; i++) {
 49 |             if (i == 0) continue
 50 | 
 51 |             const currentSubject = $(subjects[i])
 52 |             const newSubject = new MateriaKardex();
 53 | 
 54 |             newSubject.setSemestreFromvalue($(currentSubject.children().get(KardexSubjectValues.Semestre)).text())
 55 |             newSubject.setClaveMateriaFromValue($(currentSubject.children().get(KardexSubjectValues.Clave)).text())
 56 |             newSubject.setNombreFromValue($(currentSubject.children().get(KardexSubjectValues.Nombre)).text())
 57 | 
 58 |             const scores = currentSubject.children().slice(KardexSubjectValues.Calificaciones)
 59 | 
 60 |             let scoreNum = 0;
 61 | 
 62 | 
 63 |             for (let score of scores) {
 64 |                 scoreNum++;
 65 | 
 66 |                 const text = $(score).text().trim()
 67 |                 if (!text || text == "" || text == " ") continue;
 68 | 
 69 |                 if (scoreNum == 7)
 70 |                     newSubject.laboratorio = text
 71 |                 else {
 72 |                     newSubject.oportunidades.push(text)
 73 |                 }
 74 | 
 75 |             }
 76 | 
 77 |             kardex.materias.push(newSubject)
 78 | 
 79 |         }
 80 | 
 81 | 
 82 |         return kardex;
 83 |     }
 84 | 
 85 | }
 86 | 
 87 | enum KardexInfoValues {
 88 |     Nombre,
 89 |     CarreraPlanEstudios,
 90 | 
 91 | }
 92 | 
 93 | enum KardexSubjectValues {
 94 |     Semestre,
 95 |     Mod,
 96 |     Clave,
 97 |     Nombre,
 98 |     Calificaciones
 99 | }
100 | 
101 | export const kardexDataSource = new KardexDataSource();


--------------------------------------------------------------------------------
/src/webapi/controllers/schedule/scheduleController.ts:
--------------------------------------------------------------------------------
  1 | import axios from 'axios';
  2 | import { Response } from 'express';
  3 | import { Horario } from '@siaseApi/core/domain/careers';
  4 | import { careerDataSource } from '@siaseApi/network/careersDataSource';
  5 | import { BaseController, CustomRequest } from '@siaseApi/webapi/controllers/baseController';
  6 | import { ErrorResponse } from '@siaseApi/network/exceptions/errorResponse';
  7 | class ScheduleController extends BaseController {
  8 | 
  9 |     protected config(): void {
 10 | 
 11 |         this.router.get("/:index",
 12 |             (req, res, next) => this.verifyToken(req, res, next),
 13 |             (req, res, next) => this.setCache(req, res, next),
 14 |             (req, res) => this.getSchedulesByIndex(req as CustomRequest, res)
 15 |         );
 16 | 
 17 |         this.router.get("/:index/:periodo",
 18 |             (req, res, next) => this.verifyToken(req, res, next),
 19 |             (req, res, next) => this.setCache(req, res, next),
 20 |             (req, res) => this.getScheduleDetailByIndex(req as CustomRequest, res)
 21 |         );
 22 |     }
 23 | 
 24 |     private async getSchedulesByIndex(req: CustomRequest, res: Response) {
 25 | 
 26 |         try {
 27 | 
 28 |             const rawIndex = req.params.index
 29 | 
 30 |             const index = Number.parseInt(rawIndex)
 31 | 
 32 |             if (Number.isNaN(index))
 33 |                 return res.status(400).send("Invalid index")
 34 | 
 35 |             if (index < 0 || index >= req.careers.length)
 36 |                 return res.status(400).send("Index out of bounds")
 37 | 
 38 |             const career = req.careers[index]
 39 | 
 40 |             const data = await careerDataSource.getCareerSchedules(career, req.user, req.trim);
 41 | 
 42 |             res.status(200).json(data)
 43 | 
 44 |         } catch (error: any) {
 45 | 
 46 |             console.error(error);
 47 | 
 48 |             if (axios.isAxiosError(error))
 49 |                 return res.status(503).send("SIASE no funciona")
 50 | 
 51 |             if (error instanceof ErrorResponse)
 52 |                 return res.status(error.statusCode).send(error.message)
 53 | 
 54 |             res.status(500).send(error.message)
 55 | 
 56 |         }
 57 | 
 58 |     }
 59 | 
 60 | 
 61 |     private async getScheduleDetailByIndex(req: CustomRequest, res: Response) {
 62 | 
 63 |         try {
 64 | 
 65 |             const rawIndex = req.params.index
 66 | 
 67 |             const index = Number.parseInt(rawIndex)
 68 | 
 69 |             if (Number.isNaN(index))
 70 |                 return res.status(400).send("Invalid index")
 71 | 
 72 |             if (index == null)
 73 |                 return res.status(400).send("Index missing")
 74 | 
 75 |             if (index < 0 || index >= req.careers.length)
 76 |                 return res.status(400).send("Index out of bounds")
 77 | 
 78 |             const periodo = req.params.periodo
 79 | 
 80 |             if (!periodo)
 81 |                 return res.status(400).send("Periodo missing")
 82 | 
 83 |             const horario = { ...req.careers[index] } as Horario
 84 | 
 85 |             horario.periodo = periodo
 86 | 
 87 |             const data = await careerDataSource.getScheduleDetail(horario, req.user, req.trim);
 88 | 
 89 |             res.status(200).json(data)
 90 | 
 91 |         } catch (error) {
 92 |             console.error(error);
 93 | 
 94 |             if (axios.isAxiosError(error))
 95 |                 return res.status(503).send("SIASE no funciona")
 96 | 
 97 | 
 98 |             if (error instanceof ErrorResponse)
 99 |                 return res.status(error.statusCode).send(error.message)
100 | 
101 |             res.sendStatus(500);
102 |         }
103 | 
104 |     }
105 | 
106 | 
107 | 
108 | }
109 | 
110 | export const scheduleController = new ScheduleController();
111 | 


--------------------------------------------------------------------------------
/src/core/domain/careers.ts:
--------------------------------------------------------------------------------
  1 | import "@siaseApi/core/utils/stringExtensions.ext"
  2 | export class Carrera {
  3 |     nombre: string = ""
  4 |     claveDependencia: string = ""
  5 |     claveUnidad: string = ""
  6 |     claveNivelAcademico: string = ""
  7 |     claveGradoAcademico: string = ""
  8 |     claveModalidad: string = ""
  9 |     clavePlanEstudios: string = ""
 10 |     claveCarrera: string = ""
 11 | 
 12 |     constructor(urlData?: string, name?: string) {
 13 | 
 14 |         if (urlData) {
 15 |             const data = urlData.split(";")
 16 |             this.claveDependencia = this.getValue(data[CarreraValues.ClaveDependencia])
 17 |             this.claveUnidad = this.getValue(data[CarreraValues.ClaveUnidad])
 18 |             this.claveNivelAcademico = this.getValue(data[CarreraValues.ClaveNivelAcademico])
 19 |             this.claveGradoAcademico = this.getValue(data[CarreraValues.ClaveGradoAcademico])
 20 |             this.claveModalidad = this.getValue(data[CarreraValues.ClaveModalidad])
 21 |             this.clavePlanEstudios = this.getValue(data[CarreraValues.ClavePlanEstudios])
 22 |             this.claveCarrera = this.getValue(data[CarreraValues.ClaveCarrera])
 23 |         }
 24 | 
 25 |         if (name)
 26 |             this.nombre = name.trim().capitalizeFirst();
 27 |     }
 28 | 
 29 |     private getValue(data: string) {
 30 | 
 31 |         return data?.split("=")?.pop()?.replace(/'/g, "") || ""
 32 | 
 33 |     }
 34 | 
 35 | 
 36 | }
 37 | 
 38 | export class Horario {
 39 |     nombre: string = ""
 40 |     claveDependencia: string = ""
 41 |     claveUnidad: string = ""
 42 |     claveNivelAcademico: string = ""
 43 |     claveGradoAcademico: string = ""
 44 |     claveModalidad: string = ""
 45 |     clavePlanEstudios: string = ""
 46 |     claveCarrera: string = ""
 47 |     periodo: string = ""
 48 | 
 49 |     constructor(career?: Carrera, name?: string, period?: string) {
 50 |         if (name) {
 51 |             this.nombre = name.trim().capitalizeFirst();
 52 |         }
 53 | 
 54 |         if (career) {
 55 |             this.claveCarrera = career.claveCarrera!;
 56 |             this.claveDependencia = career.claveDependencia!;
 57 |             this.claveGradoAcademico = career.claveGradoAcademico!;
 58 |             this.claveModalidad = career.claveModalidad!;
 59 |             this.claveNivelAcademico = career.claveNivelAcademico!;
 60 |             this.claveModalidad = career.claveModalidad!;
 61 |             this.clavePlanEstudios = career.clavePlanEstudios!;
 62 |             this.claveUnidad = career.claveUnidad!;
 63 |         }
 64 | 
 65 |         if (period)
 66 |             this.periodo = period;
 67 | 
 68 |     }
 69 | }
 70 | 
 71 | export class Materia {
 72 |     nombre: string = ""
 73 |     nombreCorto = ""
 74 |     fase: string = ""
 75 |     tipo: string = ""
 76 |     grupo: string = ""
 77 |     salon: string = ""
 78 |     horaInicio: string = ""
 79 |     horaFin: string = ""
 80 |     claveMateria: string = ""
 81 |     modalidad: string = ""
 82 |     oportunidad: string = ""
 83 | }
 84 | 
 85 | export class HorarioDetalle {
 86 |     lunes: Materia[] = []
 87 |     martes: Materia[] = []
 88 |     miercoles: Materia[] = []
 89 |     jueves: Materia[] = []
 90 |     viernes: Materia[] = []
 91 |     sabado: Materia[] = []
 92 | 
 93 |     addSubject(subject: Materia, day: number) {
 94 |         switch (day) {
 95 |             case Days.Monday:
 96 |                 this.lunes.push(subject)
 97 |                 break;
 98 |             case Days.Tuesday:
 99 |                 this.martes.push(subject)
100 |                 break;
101 |             case Days.Wednesday:
102 |                 this.miercoles.push(subject)
103 |                 break;
104 |             case Days.Thursday:
105 |                 this.jueves.push(subject)
106 |                 break;
107 |             case Days.Friday:
108 |                 this.viernes.push(subject)
109 |                 break;
110 |             case Days.Saturday:
111 |                 this.sabado.push(subject)
112 |                 break;
113 |         }
114 |     }
115 | }
116 | 
117 | 
118 | enum CarreraValues {
119 |     ClaveDependencia,
120 |     ClaveUnidad,
121 |     ClaveNivelAcademico,
122 |     ClaveGradoAcademico,
123 |     ClaveModalidad,
124 |     ClavePlanEstudios,
125 |     ClaveCarrera,
126 | }
127 | 
128 | enum Days {
129 |     Monday,
130 |     Tuesday,
131 |     Wednesday,
132 |     Thursday,
133 |     Friday,
134 |     Saturday
135 | }
136 | 


--------------------------------------------------------------------------------
/src/network/gradesDataSource.ts:
--------------------------------------------------------------------------------
  1 | import { Carrera } from '@siaseApi/core/domain/careers';
  2 | import { Calificacion, PeriodoCalificaciones } from '@siaseApi/core/domain/grades';
  3 | import { SiaseNetworkDataSource } from '@siaseApi/network/siaseNetworkDataSource';
  4 | import cheerio from 'cheerio'
  5 | 
  6 | class GradesDataSource extends SiaseNetworkDataSource {
  7 | 
  8 | 
  9 |     async getGradesPeriods(career: Carrera, user: string, trim: string): Promise<PeriodoCalificaciones[]> {
 10 |         const formData = new URLSearchParams()
 11 | 
 12 |         formData.append("HTMLUsuario", user)
 13 |         formData.append("HTMLCve_Carrera", career.claveCarrera!)
 14 |         formData.append("HTMLCve_Dependencia", career.claveDependencia!)
 15 |         formData.append("HTMLCve_Grado_Academico", career.claveGradoAcademico!)
 16 |         formData.append("HTMLCve_Modalidad", career.claveModalidad!)
 17 |         formData.append("HTMLCve_Nivel_Academico", career.claveNivelAcademico!)
 18 |         formData.append("HTMLCve_Plan_Estudio", career.clavePlanEstudios!)
 19 |         formData.append("HTMLtrim", trim!)
 20 |         formData.append("HTMLCve_Unidad", career.claveUnidad!)
 21 |         formData.append("HTMLTipCve", "01")
 22 | 
 23 |         const response = await this.axios.get("https://deimos.dgi.uanl.mx/cgi-bin/wspd_cgi.sh/econcfs01.htm", {
 24 |             params: formData
 25 |         })
 26 | 
 27 |         const $ = cheerio.load(response.data)
 28 | 
 29 |         const periodos: PeriodoCalificaciones[] = []
 30 |         const options = $("option")
 31 |         if (options.length == 0) throw this.getError($);
 32 |         let index = 0;
 33 |         for (let option of options) {
 34 |             if (index++ == 0) continue
 35 |             const name = $(option).text()
 36 |             const period = $(option).attr("value")
 37 |             const periodo = new PeriodoCalificaciones(career, name, period);
 38 |             periodos.push(periodo)
 39 |         }
 40 | 
 41 |         return periodos
 42 |     }
 43 | 
 44 | 
 45 |     async getGradesDetail(query: PeriodoCalificaciones, user: string, trim: string): Promise<Calificacion[]> {
 46 |         const formData = new URLSearchParams()
 47 |         formData.append("HTMLUsuario", user)
 48 |         formData.append("HTMLCve_Carrera", query.claveCarrera!)
 49 |         formData.append("HTMLCve_Dependencia", query.claveDependencia!)
 50 |         formData.append("HTMLCve_Grado_Academico", query.claveGradoAcademico!)
 51 |         formData.append("HTMLCve_Modalidad", query.claveModalidad!)
 52 |         formData.append("HTMLCve_Nivel_Academico", query.claveNivelAcademico!)
 53 |         formData.append("HTMLCve_Plan_Estudio", query.clavePlanEstudios!)
 54 |         formData.append("HTMLtrim", trim!)
 55 |         formData.append("HTMLCve_Unidad", query.claveUnidad!)
 56 |         formData.append("HTMLTipCve", "01")
 57 |         formData.append("HTMLResill", "83747")
 58 |         formData.append("HTMLPeriodo", query.periodo!)
 59 |         formData.append("HTMLTrund", "econcfs02")
 60 | 
 61 |         const response = await this.axios.get("https://deimos.dgi.uanl.mx/cgi-bin/wspd_cgi.sh/control.p", {
 62 |             params: formData
 63 |         })
 64 | 
 65 |         const $ = cheerio.load(response.data)
 66 | 
 67 |         const calificaciones: Calificacion[] = []
 68 |         const tables = $("table")
 69 | 
 70 |         if (tables.length <= 1) throw this.getError($)
 71 | 
 72 |         const calificacionesTable = $(tables.get(1))
 73 | 
 74 | 
 75 |         const rows = calificacionesTable.find("tr")
 76 |         let index = 0
 77 |         for (let row of rows) {
 78 | 
 79 |             if (index++ == 0 || index + 1 == rows.length) continue;
 80 | 
 81 |             const calificacion = new Calificacion();
 82 |             const infoCols = $(row).find("td")
 83 | 
 84 |             calificacion.claveMateria = $(infoCols.get(CalificacionesValues.clave)).text().trim()
 85 |             calificacion.nombre = $(infoCols.get(CalificacionesValues.nombre)).text().trim()
 86 |             calificacion.tipoInscripcion = $(infoCols.get(CalificacionesValues.tipoInscripcion)).text().trim()
 87 |             calificacion.grupo = $(infoCols.get(CalificacionesValues.grupo)).text().trim()
 88 |             calificacion.fecha = $(infoCols.get(CalificacionesValues.fecha)).text().trim()
 89 |             calificacion.calificacion = $(infoCols.get(CalificacionesValues.calificacion)).text().trim()
 90 |             calificacion.oportunidad = $(infoCols.get(CalificacionesValues.oportunidad)).text().trim()
 91 | 
 92 |             calificaciones.push(calificacion)
 93 | 
 94 | 
 95 |         }
 96 | 
 97 |         return calificaciones
 98 | 
 99 |     }
100 | }
101 | 
102 | export const gradesDataSource = new GradesDataSource()
103 | 
104 | enum CalificacionesValues {
105 |     clave,
106 |     nombre,
107 |     tipoInscripcion,
108 |     grupo,
109 |     fecha,
110 |     calificacion,
111 |     oportunidad
112 | }


--------------------------------------------------------------------------------
/src/core/domain/afis.ts:
--------------------------------------------------------------------------------
  1 | import "@siaseApi/core/utils/stringExtensions.ext"
  2 | 
  3 | export class AfiHistorial {
  4 |     completadas = 0
  5 |     total = 0
  6 |     afis: AfiRegistrada[] = []
  7 | }
  8 | 
  9 | export class Afi {
 10 |     registrado?: boolean = false
 11 |     organizador?: string
 12 |     area?: string;
 13 | 
 14 |     evento?: string;
 15 |     descripcion?: string;
 16 | 
 17 |     fechaInicio?: string;
 18 |     horaInicio?: string;
 19 | 
 20 |     fechaFin?: string;
 21 |     horaFin?: string;
 22 | 
 23 |     capacidad?: number
 24 |     alumnosRegistrados?: number
 25 |     disponibles?: number;
 26 | 
 27 | 
 28 | 
 29 |     setDescription(value?: string) {
 30 |         if (!value) return
 31 |         this.descripcion = value.trim()
 32 |     }
 33 | 
 34 |     setOrganizador(value?: string) {
 35 |         if (!value) return
 36 |         this.organizador = value.trim().capitalizeFirst();
 37 |     }
 38 | 
 39 | 
 40 |     setArea(value?: string) {
 41 |         if (!value) return
 42 |         this.area = value.trim().capitalizeFirst();
 43 |     }
 44 | 
 45 | 
 46 |     setEvento(value?: string) {
 47 |         if (!value) return
 48 |         this.evento = value.trim().capitalizeFirst();
 49 |     }
 50 | 
 51 |     setFechaHoraInicio(value?: string) {
 52 |         if (!value) return
 53 |         const valueSplit = value.trim().split(" ")
 54 |         this.fechaInicio = valueSplit.shift();
 55 |         this.horaInicio = valueSplit.pop();
 56 |     }
 57 | 
 58 | 
 59 |     setFechaHoraFin(value?: string) {
 60 |         if (!value) return
 61 |         const valueSplit = value.trim().split(" ")
 62 |         this.fechaFin = valueSplit.shift();
 63 |         this.horaFin = valueSplit.pop();
 64 |     }
 65 | 
 66 |     setCapacidad(value?: string) {
 67 |         if (!value) return
 68 | 
 69 |         const numericVal = Number.parseInt(value)
 70 | 
 71 |         if (Number.isNaN(numericVal)) return
 72 | 
 73 |         this.capacidad = numericVal
 74 |     }
 75 | 
 76 | 
 77 |     setAlumnosRegistrados(value?: string) {
 78 |         if (!value) return
 79 | 
 80 |         const numericVal = Number.parseInt(value)
 81 | 
 82 |         if (Number.isNaN(numericVal)) return
 83 | 
 84 |         this.alumnosRegistrados = numericVal
 85 |     }
 86 | 
 87 | 
 88 |     setDisponibles(value?: string) {
 89 |         if (!value) return
 90 | 
 91 |         const numericVal = Number.parseInt(value)
 92 | 
 93 |         if (Number.isNaN(numericVal)) return
 94 | 
 95 |         this.disponibles = numericVal
 96 |     }
 97 | 
 98 | 
 99 | }
100 | 
101 | export class AfiRegistrada {
102 |     area?: string;
103 | 
104 |     evento?: string;
105 |     idEvento?: string;
106 |     indicaciones?: string;
107 |     recinto?: string
108 |     sede?: string
109 |     direccion?: string
110 |     municipio?: string
111 |     estado?: string
112 |     pais?: string
113 |     organizador?: string
114 | 
115 |     fechaInicio?: string;
116 |     horaInicio?: string;
117 | 
118 |     asistencia = false;
119 |     eventoOficial = false;
120 |     numEventoOficial?: number
121 |     periodoEscolar?: string
122 | 
123 | 
124 |     setEvento(value?: string) {
125 |         if (!value) return
126 |         this.evento = value.trim().capitalizeFirst();
127 |     }
128 | 
129 |     setIdEvento(value?: string) {
130 |         if (!value) return
131 |         this.idEvento = value.split(" ")?.shift()?.trim().capitalizeFirst();
132 |     }
133 | 
134 |     setIndicaciones(value?: string) {
135 |         if (!value) return
136 |         this.indicaciones = value.trim().capitalizeFirst();
137 |     }
138 | 
139 |     setRecinto(value?: string) {
140 |         if (!value) return
141 |         this.recinto = value.trim().capitalizeFirst();
142 |     }
143 | 
144 |     setSede(value?: string) {
145 |         if (!value) return
146 |         this.sede = value.trim().capitalizeFirst();
147 |     }
148 | 
149 |     setDireccion(value?: string) {
150 |         if (!value) return
151 |         this.direccion = value.trim().capitalizeFirst();
152 |     }
153 | 
154 |     setMunicipio(value?: string) {
155 |         if (!value) return
156 |         this.municipio = value.trim().capitalizeFirst();
157 |     }
158 | 
159 |     setEstado(value?: string) {
160 |         if (!value) return
161 |         this.estado = value.trim().capitalizeFirst();
162 |     }
163 | 
164 |     setPais(value?: string) {
165 |         if (!value) return
166 |         this.pais = value.trim().capitalizeFirst();
167 |     }
168 | 
169 |     setOrganizador(value?: string) {
170 |         if (!value) return
171 |         this.organizador = value.trim().capitalizeFirst();
172 |     }
173 | 
174 |     setArea(value?: string) {
175 |         if (!value) return
176 |         this.area = value.trim().capitalizeFirst();
177 |     }
178 | 
179 |     setFechaHoraInicio(value?: string) {
180 |         if (!value) return
181 |         const valueSplit = value.trim().split(" ")
182 |         this.fechaInicio = valueSplit.shift();
183 |         this.horaInicio = valueSplit.pop();
184 |     }
185 | 
186 |     setNumEventoOficial(value?: string) {
187 |         if (!value) return
188 | 
189 |         const numericVal = Number.parseInt(value)
190 | 
191 |         if (Number.isNaN(numericVal)) return
192 | 
193 |         this.numEventoOficial = numericVal
194 |     }
195 | 
196 |     setAsistencia(value?: string) {
197 |         if (!value) return
198 |         this.asistencia = value == "Si"
199 |     }
200 | 
201 |     setEventoOficial(value?: string) {
202 |         if (!value) return
203 |         this.eventoOficial = value == "Si"
204 |     }
205 | 
206 |     setPeriodoEscolar(value?: string) {
207 |         if (!value) return
208 |         this.periodoEscolar = value.trim().capitalizeFirst();
209 |     }
210 | }


--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
  1 | 
  2 | <br />
  3 | <p align="center">
  4 |     <img src="./assets/Readme.png" alt="Logo" >
  5 | 
  6 |   <h1 align="center">SIASE API</h1>
  7 | 
  8 |   <h3 align="center">
  9 |    Un REST API de código abierto que proporciona los datos de SIASE
 10 |     <br />
 11 |   </h3>
 12 | </p>
 13 | 
 14 | 
 15 | <br>
 16 | 
 17 | [![discord](https://img.shields.io/discord/761984010170794015)](https://discord.gg/ZS52h7HKKJ)
 18 | 
 19 | <!-- ABOUT THE PROJECT -->
 20 | 
 21 | ## Acerca del proyecto
 22 | 
 23 | * [Documentación](https://siaseapi.docs.apiary.io/#)
 24 | 
 25 | SIASE API es un REST API de código abierto que utiliza webscraping para obtener los datos de la plataforma de SIASE de la UANL, con esta api podrás acceder a tu información como las carreras que estas cursando, los horarios e incluso consultar tu kardex.
 26 | 
 27 | Puedes utilizar esta API para construir cualquier proyecto que desees o contribuir para mejorarla.
 28 | 
 29 | SIASE API y el GDSC no estamos afiliados de ninguna manera con la UANL, este es un proyecto hecho por y para estudiantes.
 30 | 
 31 | 
 32 | <br>
 33 | 
 34 | ## Errores, mejoras y contribuciones
 35 | 
 36 | Por favor asegurate de leer las guías de contribución.
 37 | 
 38 | <details><summary>Issues</summary>
 39 | 
 40 | 1. **Antes de reportar un issue por favor echa un vistazo a los [issues](https://github.com/GDSC-UANL/siase-api/issues) abiertos.**
 41 | 2. Si tienes alguna duda puedes preguntar en nuestro [Discord](https://discord.gg/ZS52h7HKKJ)
 42 | 
 43 | </details>
 44 | 
 45 | <details><summary>Bugs</summary>
 46 | 
 47 | * Incluye los pasos para reproducir
 48 | * Incluye screenshots si es necesario 
 49 | 
 50 | </details>
 51 | 
 52 | <details><summary>Feature requests</summary>
 53 | 
 54 | * Escribe una explicación detallada, donde se menciona que es lo que se debería de hacer y como.
 55 | * Incluye screenshots si es necesario 
 56 | * Ten en cuenta que estamos limitados a las capacidades de la plataforma de SIASE
 57 | 
 58 | </details>
 59 | 
 60 | <details><summary>Contribuciones</summary>
 61 | 
 62 | Por favor mira nuestro apartado de [contribuciones](https://github.com/GDSC-UANL/siase-api/blob/master/contributing.md)
 63 | 
 64 | </details>
 65 | 
 66 | <br>
 67 | 
 68 | ## 💻 Herramientas de desarrollo
 69 | 
 70 | <!-- Herramientas de desarrollo -->
 71 | <table>
 72 | <tr>
 73 |     <td align="center">
 74 |         <a href="https://nodejs.org">
 75 |             <img src="https://www.vectorlogo.zone/logos/nodejs/nodejs-icon.svg" width="100;" alt="NodeJS"/>
 76 |             <br />
 77 |             <sub><b>NodeJS</b></sub>
 78 |         </a>
 79 |     </td>
 80 |     <td align="center">
 81 |         <a href="https://www.typescriptlang.org/">
 82 |             <img src="https://www.vectorlogo.zone/logos/typescriptlang/typescriptlang-icon.svg" width="100;" alt="TypeScript"/>
 83 |             <br />
 84 |             <sub><b>TypeScript</b></sub>
 85 |         </a>
 86 |     </td>
 87 |     <td align="center">
 88 |         <a href="https://expressjs.com/">
 89 |             <img src="https://www.vectorlogo.zone/logos/expressjs/expressjs-icon.svg" width="100;" alt="Express"/>
 90 |             <br />
 91 |             <sub><b>Express</b></sub>
 92 |         </a>
 93 |     </td>
 94 |     <td align="center" style="line-height: 8;">
 95 |         <a href="https://cheerio.js.org/">
 96 |             <b>Cheerio</b>
 97 |         </a>
 98 |     </td>
 99 |     <td align="center">
100 |         <a href="https://expressjs.com/">
101 |             <img src="https://axios-http.com/assets/logo.svg" width="100;" height="94;" alt="Axios"/>
102 |             <br />
103 |             <sub><b>Axios</b></sub>
104 |         </a>
105 |     </td>
106 |     <td align="center">
107 |         <a href="https://expressjs.com/">
108 |             <img src="https://jwt.io/img/pic_logo.svg" width="100;" alt="JWT"/>
109 |             <br />
110 |             <sub><b>JWT</b></sub>
111 |         </a>
112 |     </td>
113 |   </tr>
114 | </table>
115 | 
116 | <!-- GETTING STARTED -->
117 | <br>
118 | 
119 | ## Iniciar un servidor local de desarrollo
120 | Antes de clonar el repositorio asegurate de tener instalado:
121 | 
122 | - NodeJS [![NodeJS](https://img.shields.io/badge/NodeJS-v14.15.6-green)](https://nodejs.org/es/)
123 | - NPM [![NPM](https://img.shields.io/npm/v/npm)](https://nodejs.org/es/)
124 | 
125 | 
126 | - Una vez que hayas descargado el repositorio instala las dependencias utilizando
127 | 
128 | ```
129 |   npm install
130 | ```
131 | 
132 | - Crea un archivo .env en el directorio principal y llenalo con las variables necesarias. Puedes ver las variables requeridas en el archivo [EXAMPLE.env](https://github.com/GDSC-UANL/siase-api/blob/master/EXAMPLE.env).
133 | 
134 | - Ejecuta el servidor utilizando
135 | 
136 | ```
137 |   npm run build && npm run start
138 | ```
139 | 
140 | ## ✍ Colaboradores
141 | <!-- COLABORADORES -->
142 | <table>
143 | <tr>
144 |     <td align="center">
145 |         <a href="https://github.com/Fmaldonado6">
146 |             <img src="https://avatars.githubusercontent.com/u/28517542?v=4" width="100;" alt="Fmaldonado6"/>
147 |             <br />
148 |             <sub><b>Fmaldonado6</b></sub>
149 |         </a>
150 |     </td>
151 |     <td align="center">
152 |         <a href="https://github.com/David-Lazaro-Fernandez">
153 |             <img src="https://avatars.githubusercontent.com/u/57787993?v=4" width="100;" alt="David-Lazaro-Fernandez"/>
154 |             <br />
155 |             <sub><b>David-Lazaro-Fernandez</b></sub>
156 |         </a>
157 |     </td>
158 |     <td align="center">
159 |         <a href="https://github.com/FabianCruz-0">
160 |             <img src="https://avatars.githubusercontent.com/u/57044771?v=4" width="100;" alt="FabianCruz-0"/>
161 |             <br />
162 |             <sub><b>FabianCruz-0</b></sub>
163 |         </a>
164 |     </td>
165 |     <td align="center">
166 |         <a href="https://github.com/rtrevinnoc">
167 |             <img src="https://avatars.githubusercontent.com/u/7103315?v=4" width="100;" alt="rtrevinnoc"/>
168 |             <br />
169 |             <sub><b>rtrevinnoc</b></sub>
170 |         </a>
171 |     </td>
172 |   </tr>
173 | </table>
174 | 
175 | <!-- CONTACT -->
176 | <br>
177 | 
178 | ## Contact
179 | 
180 | GDSC UANL - [@dscuanl](https://twitter.com/gdscuanl) - dscuanl@gmail.com
181 | 


--------------------------------------------------------------------------------
/src/network/careersDataSource.ts:
--------------------------------------------------------------------------------
  1 | import { Carrera, Horario, HorarioDetalle, Materia } from '@siaseApi/core/domain/careers';
  2 | import { SiaseNetworkDataSource } from "@siaseApi/network/siaseNetworkDataSource";
  3 | import cheerio from 'cheerio'
  4 | class CareerDataSource extends SiaseNetworkDataSource {
  5 | 
  6 |     async getCareerSchedules(career: Carrera, user: string, trim: string): Promise<Horario[]> {
  7 |         const formData = new URLSearchParams()
  8 | 
  9 |         formData.append("HTMLUsuario", user)
 10 |         formData.append("HTMLCve_Carrera", career.claveCarrera!)
 11 |         formData.append("HTMLCve_Dependencia", career.claveDependencia!)
 12 |         formData.append("HTMLCve_Grado_Academico", career.claveGradoAcademico!)
 13 |         formData.append("HTMLCve_Modalidad", career.claveModalidad!)
 14 |         formData.append("HTMLCve_Nivel_Academico", career.claveNivelAcademico!)
 15 |         formData.append("HTMLCve_Plan_Estudio", career.clavePlanEstudios!)
 16 |         formData.append("HTMLtrim", trim!)
 17 |         formData.append("HTMLCve_Unidad", career.claveUnidad!)
 18 |         formData.append("HTMLTipCve", "01")
 19 | 
 20 |         const response = await this.axios.get("https://deimos.dgi.uanl.mx/cgi-bin/wspd_cgi.sh/echalm01.htm", {
 21 |             params: formData
 22 |         })
 23 | 
 24 |         const $ = cheerio.load(response.data)
 25 | 
 26 |         const schedules = $("option")
 27 |         const resill = $("[name=HTMLResill]").attr("value")
 28 | 
 29 |         if (!resill)
 30 |             throw this.getError($)
 31 | 
 32 |         const parsedSchedules: Horario[] = []
 33 | 
 34 |         for (let schedule of schedules) {
 35 | 
 36 |             const parsedSchedule = $(schedule);
 37 |             const value = parsedSchedule.attr("value")
 38 | 
 39 |             if (!value || value == "0")
 40 |                 continue;
 41 | 
 42 |             parsedSchedules.push(new Horario(career, parsedSchedule.text(), value))
 43 | 
 44 |         }
 45 | 
 46 |         return parsedSchedules;
 47 |     }
 48 | 
 49 | 
 50 |     async getScheduleDetail(query: Horario, user: string, trim: string): Promise<HorarioDetalle> {
 51 |         const formData = new URLSearchParams()
 52 | 
 53 |         formData.append("HTMLUsuario", user)
 54 |         formData.append("HTMLCve_Carrera", query.claveCarrera!)
 55 |         formData.append("HTMLCve_Dependencia", query.claveDependencia!)
 56 |         formData.append("HTMLCve_Grado_Academico", query.claveGradoAcademico!)
 57 |         formData.append("HTMLCve_Modalidad", query.claveModalidad!)
 58 |         formData.append("HTMLCve_Nivel_Academico", query.claveNivelAcademico!)
 59 |         formData.append("HTMLCve_Plan_Estudio", query.clavePlanEstudios!)
 60 |         formData.append("HTMLtrim", trim)
 61 |         formData.append("HTMLCve_Unidad", query.claveUnidad!)
 62 |         formData.append("HTMLResill", "1")
 63 |         formData.append("HTMLPeriodo", query.periodo!)
 64 |         formData.append("HTMLTrund", "echalm02")
 65 |         formData.append("HTMLTipCve", "01")
 66 | 
 67 | 
 68 |         const response = await this.axios.get("https://deimos.dgi.uanl.mx/cgi-bin/wspd_cgi.sh/control.p", {
 69 |             params: formData
 70 |         })
 71 | 
 72 |         const $ = cheerio.load(response.data)
 73 | 
 74 |         const tables = $("table")
 75 | 
 76 |         if (tables.length == 0)
 77 |             this.getError($)
 78 | 
 79 |         const scheduleTable = tables.first();
 80 |         const infoTable = $(tables[1]);
 81 |         const infoElements = infoTable.find("tr");
 82 |         const elements = scheduleTable.find(".text-center")
 83 | 
 84 |         const scheduleDetail = new HorarioDetalle();
 85 | 
 86 |         const subjects = new Map<string, Materia>();
 87 | 
 88 |         for (let i = 0; i < infoElements.length; i++) {
 89 | 
 90 |             if (i == 0) continue;
 91 | 
 92 |             const info = $(infoElements[i]);
 93 | 
 94 |             const subject = new Materia();
 95 | 
 96 |             subject.tipo = $(info.children().get(SubjectValues.Tipo)).text()
 97 |             subject.grupo = $(info.children().get(SubjectValues.Grupo)).text()
 98 |             subject.nombre = $(info.children().get(SubjectValues.Nombre)).text()
 99 |             subject.claveMateria = $(info.children().get(SubjectValues.ClaveMateria)).text()
100 |             subject.nombreCorto = $(info.children().get(SubjectValues.Abreviacion)).text()
101 |             subject.modalidad = $(info.children().get(SubjectValues.TipoOferta)).text()
102 |             subject.oportunidad = $(info.children().get(SubjectValues.Oportunidad)).text()
103 | 
104 |             subjects.set(subject.nombreCorto, subject)
105 |         }
106 | 
107 |         let startTime = ""
108 |         let endTime = ""
109 | 
110 |         let substract = 0
111 | 
112 |         for (let i = 0; i < elements.length; i++) {
113 |             const subject = $(elements[i])
114 | 
115 |             if (i % 7 == 0) {
116 |                 let times = subject.html()!.split(/ *a<br> */g)
117 |                 startTime = times.shift()?.trim()!
118 |                 endTime = times.pop()!.trim()!
119 |                 substract++
120 | 
121 |                 continue;
122 |             }
123 | 
124 |             const values = subject.html()!
125 |                 .replace(/<br>/g, " / ")
126 |                 .replace(/<b>/g, "")
127 |                 .replace(/<\/b>/g, "")
128 |                 .replace(/ \/ /g, "/");
129 | 
130 |             if (values == "&nbsp;") continue;
131 | 
132 |             const split = values.split("/")
133 | 
134 |             const fase = split[SubjectItemValues.Fase]
135 |             const shortName = split[SubjectItemValues.NombreCorto]
136 |             const classroom = split[SubjectItemValues.Salon]
137 | 
138 |             const currentSubject = { ...subjects.get(shortName)! }
139 | 
140 |             currentSubject.fase = fase;
141 |             currentSubject.salon = classroom;
142 |             currentSubject.horaInicio = startTime;
143 |             currentSubject.horaFin = endTime;
144 | 
145 |             scheduleDetail.addSubject(currentSubject, (i - substract) % 6)
146 | 
147 |         }
148 |         return scheduleDetail;
149 | 
150 |     }
151 | 
152 | }
153 | 
154 | export const careerDataSource = new CareerDataSource()
155 | 
156 | enum SubjectItemValues {
157 |     Fase,
158 |     Tipo,
159 |     NombreCorto,
160 |     Grupo,
161 |     Salon
162 | }
163 | 
164 | enum SubjectValues {
165 |     Tipo,
166 |     ClaveMateria,
167 |     Nombre,
168 |     Abreviacion,
169 |     Grupo,
170 |     TipoOferta,
171 |     FrecuenciaPresencial,
172 |     FrecuenciaEnLinea,
173 |     FrecuenciaTotla,
174 |     Creditos,
175 |     Oportunidad,
176 | }


--------------------------------------------------------------------------------
/src/network/afisDataSource.ts:
--------------------------------------------------------------------------------
  1 | import { SiaseNetworkDataSource } from '@siaseApi/network/siaseNetworkDataSource';
  2 | import { Carrera } from '@siaseApi/core/domain/careers';
  3 | import { Afi, AfiHistorial, AfiRegistrada } from '@siaseApi/core/domain/afis';
  4 | import cheerio from 'cheerio';
  5 | class AfisDataSource extends SiaseNetworkDataSource {
  6 | 
  7 | 
  8 |     async getAfisFromCareer(
  9 |         query: Carrera,
 10 |         mes: number,
 11 |         user: string,
 12 |         trim: string
 13 |     ): Promise<Afi[]> {
 14 |         const formData = new URLSearchParams()
 15 | 
 16 |         formData.append("HTMLUsuario", user)
 17 |         formData.append("HTMLCve_Carrera", query.claveCarrera!)
 18 |         formData.append("HTMLCve_Dependencia", query.claveDependencia!)
 19 |         formData.append("HTMLCve_Grado_Academico", query.claveGradoAcademico!)
 20 |         formData.append("HTMLCve_Modalidad", query.claveModalidad!)
 21 |         formData.append("HTMLCve_Nivel_Academico", query.claveNivelAcademico!)
 22 |         formData.append("HTMLCve_Plan_Estudio", query.clavePlanEstudios!)
 23 |         formData.append("HTMLtrim", trim!)
 24 |         formData.append("HTMLCve_Unidad", query.claveUnidad!)
 25 |         formData.append("HTMLTipCve", "01")
 26 | 
 27 |         if (mes != null) {
 28 |             const mesString = mes < 10 ? "0" + mes : mes.toString()
 29 |             formData.append("HTMLCveMes", mesString)
 30 |         }
 31 | 
 32 |         const response = await this.axios.get("https://deimos.dgi.uanl.mx/cgi-bin/wspd_cgi.sh/delSavePrereg.htm", {
 33 |             params: formData
 34 |         })
 35 | 
 36 |         const $ = cheerio.load(response.data)
 37 | 
 38 |         const afis: Afi[] = []
 39 |         const tables = $(".TablaLink")
 40 | 
 41 |         if (tables.length == 0) throw this.getError($)
 42 | 
 43 |         const afisTable = tables.first()
 44 | 
 45 |         const rows = afisTable.find("tr")
 46 | 
 47 |         let index = 0
 48 |         for (let row of rows) {
 49 |             if (index++ == 0 || index == rows.length + 1) continue;
 50 | 
 51 |             const afi = new Afi();
 52 |             const infoCols = $(row).find("td")
 53 | 
 54 |             const checkbox = $(infoCols.get(AfiValues.checkbox)).find("input").first()
 55 |             afi.registrado = checkbox.is(":checked")
 56 |             afi.setOrganizador($(infoCols.get(AfiValues.organizador)).text())
 57 |             afi.setArea($(infoCols.get(AfiValues.area)).text())
 58 |             afi.setEvento($(infoCols.get(AfiValues.evento)).text())
 59 |             afi.setFechaHoraInicio($(infoCols.get(AfiValues.fechaInicio)).text())
 60 |             afi.setFechaHoraFin($(infoCols.get(AfiValues.fechaFin)).text())
 61 |             afi.setCapacidad($(infoCols.get(AfiValues.capacidad)).text())
 62 |             afi.setAlumnosRegistrados($(infoCols.get(AfiValues.registro)).text())
 63 |             afi.setDisponibles($(infoCols.get(AfiValues.disponibles)).text())
 64 |             afi.setDescription($(infoCols.get(AfiValues.evento)).attr("title"))
 65 |             afis.push(afi)
 66 |         }
 67 | 
 68 |         return afis
 69 |     }
 70 | 
 71 | 
 72 |     async getAfisHistoryFromCareer(
 73 |         query: Carrera,
 74 |         user: string,
 75 |         trim: string
 76 |     ): Promise<AfiHistorial> {
 77 |         const formData = new URLSearchParams()
 78 | 
 79 |         formData.append("HTMLUsuario", user)
 80 |         formData.append("HTMLCve_Carrera", query.claveCarrera!)
 81 |         formData.append("HTMLCve_Dependencia", query.claveDependencia!)
 82 |         formData.append("HTMLCve_Grado_Academico", query.claveGradoAcademico!)
 83 |         formData.append("HTMLCve_Modalidad", query.claveModalidad!)
 84 |         formData.append("HTMLCve_Nivel_Academico", query.claveNivelAcademico!)
 85 |         formData.append("HTMLCve_Plan_Estudio", query.clavePlanEstudios!)
 86 |         formData.append("HTMLtrim", trim!)
 87 |         formData.append("HTMLCve_Unidad", query.claveUnidad!)
 88 |         formData.append("HTMLTipCve", "01")
 89 | 
 90 |         const response = await this.axios.get("https://deimos.dgi.uanl.mx/cgi-bin/wspd_cgi.sh/delConsRegEven.htm", {
 91 |             params: formData
 92 |         })
 93 | 
 94 |         const $ = cheerio.load(response.data)
 95 | 
 96 |         const historial = new AfiHistorial()
 97 | 
 98 |         const tables = $("table")
 99 | 
100 |         if (tables.length == 0) throw this.getError($)
101 | 
102 |         const infoTable = $(tables[2])
103 |         const afisTable = $(tables[3])
104 | 
105 |         const totalAfisValues = $(infoTable.find("tr")).find("td")
106 | 
107 |         if (totalAfisValues.length == 0) throw this.getError($)
108 | 
109 |         historial.completadas = Number.parseInt($(totalAfisValues.get(0)).text())
110 |         historial.total = Number.parseInt($(totalAfisValues.get(1)).text())
111 |     
112 |         const rows = afisTable.find("tr")
113 |         let index = 0
114 |         for (let row of rows) {
115 |             if (index++ == 0 || index == rows.length + 1) continue;
116 | 
117 |             const afi = new AfiRegistrada();
118 |             const infoCols = $(row).find("td")
119 | 
120 |             const info = $(infoCols.get(AfiHistorialValues.evento))
121 | 
122 | 
123 |             const infoValues = info.find("b")
124 | 
125 | 
126 |             afi.setEvento($(infoValues.get(AfiHistorialInfoValues.evento).next).text())
127 |             afi.setIdEvento($(infoValues.get(AfiHistorialInfoValues.evento)).text())
128 |             afi.setIndicaciones($(infoValues.get(AfiHistorialInfoValues.indicaciones).next).text())
129 |             afi.setRecinto($(infoValues.get(AfiHistorialInfoValues.recinto).next).text())
130 |             afi.setSede($(infoValues.get(AfiHistorialInfoValues.sede).next).text())
131 |             afi.setDireccion($(infoValues.get(AfiHistorialInfoValues.direccion).next).text())
132 |             afi.setMunicipio($(infoValues.get(AfiHistorialInfoValues.municipio).next).text())
133 |             afi.setEstado($(infoValues.get(AfiHistorialInfoValues.estado).next).text())
134 |             afi.setPais($(infoValues.get(AfiHistorialInfoValues.pais).next).text())
135 |             afi.setOrganizador($(infoValues.get(AfiHistorialInfoValues.organizador).next).text())
136 | 
137 |             afi.setArea($(infoCols.get(AfiHistorialValues.area)).text())
138 |             afi.setAsistencia($(infoCols.get(AfiHistorialValues.asistencia)).text())
139 |             afi.setFechaHoraInicio($(infoCols.get(AfiHistorialValues.fecha)).text())
140 |             afi.setEventoOficial($(infoCols.get(AfiHistorialValues.eventoOficial)).text())
141 |             afi.setNumEventoOficial($(infoCols.get(AfiHistorialValues.numEventoificial)).text())
142 |             afi.setPeriodoEscolar($(infoCols.get(AfiHistorialValues.periodoEscolar)).text())
143 | 
144 | 
145 |             historial.afis.push(afi)
146 |         }
147 | 
148 |         return historial
149 |     }
150 | }
151 | 
152 | export const afisDataSource = new AfisDataSource()
153 | 
154 | enum AfiValues {
155 |     checkbox,
156 |     organizador,
157 |     area,
158 |     evento,
159 |     fechaInicio,
160 |     fechaFin,
161 |     capacidad,
162 |     registro,
163 |     disponibles
164 | }
165 | 
166 | enum AfiHistorialValues {
167 |     evento,
168 |     area,
169 |     fecha,
170 |     asistencia,
171 |     eventoOficial,
172 |     numEventoificial,
173 |     periodoEscolar
174 | }
175 | 
176 | enum AfiHistorialInfoValues {
177 |     evento,
178 |     indicaciones,
179 |     recinto,
180 |     sede,
181 |     direccion,
182 |     municipio,
183 |     estado,
184 |     pais,
185 |     organizador
186 | }


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
  1 | {
  2 |   "compilerOptions": {
  3 |     /* Visit https://aka.ms/tsconfig.json to read more about this file */
  4 |     /* Projects */
  5 |     // "incremental": true,                              /* Enable incremental compilation */
  6 |     // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
  7 |     // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
  8 |     // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
  9 |     // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
 10 |     // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
 11 |     /* Language and Environment */
 12 |     "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
 13 |     // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
 14 |     // "jsx": "preserve",                                /* Specify what JSX code is generated. */
 15 |     // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
 16 |     // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
 17 |     // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
 18 |     // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
 19 |     // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
 20 |     // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
 21 |     // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
 22 |     // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
 23 |     /* Modules */
 24 |     "module": "commonjs", /* Specify what module code is generated. */
 25 |     "rootDir": "./src", /* Specify the root folder within your source files. */
 26 |     // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
 27 |     "baseUrl": "./src", /* Specify the base directory to resolve non-relative module names. */
 28 |     "paths": {
 29 |       "@siaseApi/*": [
 30 |         "./*",
 31 |       ]
 32 |     }, /* Specify a set of entries that re-map imports to additional lookup locations. */
 33 |     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
 34 |     // "typeRoots": [
 35 |     //   "./node_modules/@types",
 36 |     //   "./src/core/utils/",
 37 |     // ], /* Specify multiple folders that act like `./node_modules/@types`. */
 38 |     // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
 39 |     // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
 40 |     // "resolveJsonModule": true,                        /* Enable importing .json files */
 41 |     // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
 42 |     /* JavaScript Support */
 43 |     // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
 44 |     // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
 45 |     // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
 46 |     /* Emit */
 47 |     // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
 48 |     // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
 49 |     // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
 50 |     // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
 51 |     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
 52 |     "outDir": "./build", /* Specify an output folder for all emitted files. */
 53 |     // "removeComments": true,                           /* Disable emitting comments. */
 54 |     // "noEmit": true,                                   /* Disable emitting files from a compilation. */
 55 |     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
 56 |     // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
 57 |     // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
 58 |     // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
 59 |     // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
 60 |     // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
 61 |     // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
 62 |     // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
 63 |     // "newLine": "crlf",                                /* Set the newline character for emitting files. */
 64 |     // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
 65 |     // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
 66 |     // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
 67 |     // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
 68 |     // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
 69 |     // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
 70 |     /* Interop Constraints */
 71 |     // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
 72 |     // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
 73 |     "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
 74 |     // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
 75 |     "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
 76 |     /* Type Checking */
 77 |     "strict": true, /* Enable all strict type-checking options. */
 78 |     // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
 79 |     // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
 80 |     // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
 81 |     // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
 82 |     // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
 83 |     // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
 84 |     // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
 85 |     // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
 86 |     // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
 87 |     // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
 88 |     // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
 89 |     // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
 90 |     // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
 91 |     // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
 92 |     // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
 93 |     // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
 94 |     // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
 95 |     // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
 96 |     /* Completeness */
 97 |     // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
 98 |     "skipLibCheck": true /* Skip type checking all .d.ts files. */
 99 |   }
100 | }


--------------------------------------------------------------------------------
/COPYING.txt:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------