update to typescript

Author: bwees

.github/workflows/npm_publish.yml

@@ -15,9 +15,15 @@ jobs:
           - name: 🟢 Setup Node
             uses: actions/setup-node@v3
             with:
-              node-version: 12
+              node-version: 22
               registry-url: https://registry.npmjs.org
 
+          - name: ☁️ Install Dependencies
+            run: npm install
+
+          - name: 🔨 Build Typescript
+            run: npm run build
+                
           - name: 🚀 Publish
             run: npm publish --access public
             env:

.gitignore

@@ -1,2 +1,3 @@
 node_modules
-api.env
+api.env
+dist

examples/example.js

@@ -0,0 +1,5 @@
+import { getAuthentication, getBaseData } from "../src/index";
+
+getAuthentication().then(async (auth) => {
+    console.log(await getBaseData(auth))
+})

examples/example.ts

@@ -1,16 +1,16 @@
 {
   "name": "brazos-tranist-api",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "JS implementation of the Texas A&M Bus API",
   "main": "src/index.js",
   "files": [
-    "src",
-    "types"
+    "dist/**/*"
   ],
   "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "example": "node examples/example.js"
+    "example": "node examples/example.ts",
+    "build": "tsc"
   },
   "repository": {
     "type": "git",
@@ -25,5 +25,8 @@
   "dependencies": {
     "moment": "^2.29.4"
   },
-  "types": "types/index.d.ts"
+  "devDependencies": {
+    "typescript": "^5.7.3"
+  },
+  "types": "dist/index.d.ts"
 }

package-lock.json

@@ -3,7 +3,7 @@
  * @param {string} auth Authentication to use for the request
  * @returns {string[]} list of route names ("01", "04", etc.)
  */
-export async function getBaseData(auth) {
+export async function getBaseData(auth: string) {
     var res = await fetch(`https://ridebtd.org/Services/JSONPRelay.svc/GetRoutesForMapWithScheduleWithEncodedLine?apiKey=${auth}&isDispatch=false`)
 
     return await res.json()
@@ -14,7 +14,7 @@ export async function getBaseData(auth) {
  * @param {string} auth authentication to use for the request
  * @returns list of all locations for buses that are active
 */
-export async function getVehicleLocations(auth) {
+export async function getVehicleLocations(auth: string) {
     var res = await fetch(`https://ridebtd.org/Services/JSONPRelay.svc/GetMapVehiclePoints?apiKey=${auth}&isPublicMap=true`)
 
     return await res.json()
@@ -26,7 +26,7 @@ export async function getVehicleLocations(auth) {
  * @param {string} auth authentication to use for the request
  * @returns list of stop times for the given routes
 */
-export async function getNextStopTimes(routes, auth) {
+export async function getNextStopTimes(routes: string[], auth: string) {
     var res = await fetch(`https://ridebtd.org/Services/JSONPRelay.svc/GetStopArrivalTimes?apiKey=${auth}&routeIds=${routes.join(",")}&version=2`)
 
     return await res.json()

package.json

@@ -5,7 +5,7 @@ import moment from "moment";
  * @param {string} dateString - formatted as "/Date(1234)/"
  * @returns {moment.Moment | null} converted time
  */
-export function convertDateString(dateString) {
+export function convertDateString(dateString: string): moment.Moment | undefined {
     // Extract the timestamp from the string using a regular expression
     const match = dateString.match(/\/Date\((\d+)\)\//);
 
@@ -17,6 +17,5 @@ export function convertDateString(dateString) {
         return moment(timestamp);
     }
 
-    // Return null or handle the error as needed
-    return null;
+    return undefined;
 }