Compare commits

..

8 Commits

Author SHA1 Message Date
eb8bee65d9 Fix module res?
All checks were successful
Publish Package / build-and-publish (push) Successful in 7s
2026-04-27 23:48:08 +01:00
fc4c8745a6 Fix the date validator, was checking indexes, not values!
All checks were successful
Publish Package / build-and-publish (push) Successful in 8s
2026-04-27 23:39:36 +01:00
0474973588 Fix path to train module
All checks were successful
Publish Package / build-and-publish (push) Successful in 8s
2026-04-27 23:31:43 +01:00
7f2cb2c413 Fix path to helpers.js
All checks were successful
Publish Package / build-and-publish (push) Successful in 8s
2026-04-27 23:29:31 +01:00
3c81b5225f Add trains endpoint handler
All checks were successful
Publish Package / build-and-publish (push) Successful in 8s
2026-04-27 22:28:55 +01:00
d10dabf604 Adjust generateGeohash from static to standard method to support singleton approach in Svelte without additonal import/exports
All checks were successful
Publish Package / build-and-publish (push) Successful in 3s
2026-03-30 22:57:57 +01:00
26886f8a7d Fix pathing to stationDate.js file
All checks were successful
Publish Package / build-and-publish (push) Successful in 3s
2026-03-30 22:52:09 +01:00
46dcf65de6 Ensure StationDataModule is exported
All checks were successful
Publish Package / build-and-publish (push) Successful in 2s
2026-03-30 22:49:53 +01:00
9 changed files with 133 additions and 10 deletions

8
package-lock.json generated
View File

@@ -9,7 +9,7 @@
"version": "3.0.0",
"license": "GPL-3.0",
"dependencies": {
"@owlboard/api-schema-types": "^3.0.2-alpha3",
"@owlboard/api-schema-types": "^3.0.3-alpha1",
"latlon-geohash": "^2.0.0"
},
"devDependencies": {
@@ -504,9 +504,9 @@
}
},
"node_modules/@owlboard/api-schema-types": {
"version": "3.0.2-alpha3",
"resolved": "https://git.fjla.uk/api/packages/OwlBoard/npm/%40owlboard%2Fapi-schema-types/-/3.0.2-alpha3/api-schema-types-3.0.2-alpha3.tgz",
"integrity": "sha512-3NFP21QdSfjziwlGQixlNnUWC55HlKZGyWANIOimWu0FZejWQWExJiaAVfb6m3Sbv+zvQMu3B8mzcMCcGadZCQ==",
"version": "3.0.3-alpha1",
"resolved": "https://git.fjla.uk/api/packages/OwlBoard/npm/%40owlboard%2Fapi-schema-types/-/3.0.3-alpha1/api-schema-types-3.0.3-alpha1.tgz",
"integrity": "sha512-UWe2nbJWb2B/LuZW1UXHJ2lpqOGwugiXTa4G6X5xLiaws3ISEdciweorX8kr2/JAz5+iFYIe1xXRFAWsFtpn/w==",
"license": "MIT"
},
"node_modules/@tsconfig/node10": {

View File

@@ -30,7 +30,7 @@
"author": "Frederick Boniface",
"license": "GPL-3.0",
"dependencies": {
"@owlboard/api-schema-types": "^3.0.2-alpha3",
"@owlboard/api-schema-types": "^3.0.3-alpha1",
"latlon-geohash": "^2.0.0"
},
"devDependencies": {

View File

@@ -7,3 +7,5 @@ export type * from '@owlboard/api-schema-types'
// Useful exports for Type Hinting
export { PisModule } from './modules/pis.js';
export { LocationFilterModule } from './modules/locationFilter.js';
export { StationDataModule } from './modules/stationData.js';
export { TrainsModule } from './modules/trains.js';

View File

@@ -1,12 +1,14 @@
import { BaseClient } from "./base.js";
import { PisModule } from "../modules/pis.js";
import { LocationFilterModule } from "../modules/locationFilter.js";
import { StationDataModule } from "src/modules/stationData.js";
import { StationDataModule } from "../modules/stationData.js";
import { TrainsModule } from "../modules/trains.js";
export class OwlBoardClient extends BaseClient {
public readonly pis: PisModule;
public readonly locationFilter: LocationFilterModule;
public readonly stationData: StationDataModule;
public readonly trains: TrainsModule;
constructor(baseUrl: string, apiKey?: string) {
super(baseUrl, apiKey);
@@ -14,5 +16,6 @@ export class OwlBoardClient extends BaseClient {
this.pis = new PisModule(this);
this.locationFilter = new LocationFilterModule(this);
this.stationData = new StationDataModule(this);
this.trains = new TrainsModule(this);
}
}

20
src/lib/helpers.ts Normal file
View File

@@ -0,0 +1,20 @@
/**
* Normalises input to YYYY-MM-DD string
* - Strings are passed through as is
* - Date objects are converted to UK time
*/
export const ensureDateString = (input: Date | string): string => {
if (typeof input === 'string') return input.trim();
const d = new Intl.DateTimeFormat('en-GB', {
year: 'numeric',
month: '2-digit',
day: '2-digit',
timeZone: 'Europe/London'
}).formatToParts(input);
const part = (type: string) => d.find(p => p.type === type)?.value;
return `${part('year')}-${part('month')}-${part('day')}`
}

View File

@@ -1,3 +1,13 @@
/**
* Checks if a character code is a digit
*/
const isDigit = (c: number) => c >= 48 && c <= 57;
/**
* Checks if a character code is an upper case letter
*/
const isUpper = (c: number) => c >= 65 && c <= 90;
/**
* Checks if a string is a valid CRS (Syntactically Only)
* using byte level checking for max performance
@@ -49,6 +59,60 @@ export const IsValidPis = (PIS: string): boolean => {
return true;
}
/**
* Checks if a string is the correct format for a Headcode
* USes byte level checking for max performance
* @param Headcode The headcode to be validated
*/
export const IsValidHeadcode = (Headcode: string): boolean => {
if (Headcode.length !== 4) return false;
const c0 = Headcode.charCodeAt(0);
const c1 = Headcode.charCodeAt(1);
const c2 = Headcode.charCodeAt(2);
const c3 = Headcode.charCodeAt(3);
return isDigit(c0) && isUpper(c1) && isDigit(c2) && isDigit(c3)
}
/**
* Checks if a string is the correct format for a TOC Code
*/
export const IsValidToc = (toc: string): boolean => {
if (toc.length !== 2) {
return false;
}
const c0 = toc.charCodeAt(0);
const c1 = toc.charCodeAt(1);
return isUpper(c0) && isUpper(c1);
}
/**
* Checks if a string is the correct format, and is a valid date
*/
export const IsValidDateStr = (s: string): boolean => {
if (s.length !== 10) return false;
if (s[4] !== '-' || s[7] !== '-') return false;
for (let i = 0; i < 10; i++) {
if (i === 4 || i === 7) continue;
const c = s.charCodeAt(i);
if (!isDigit(c)) return false;
}
const y = parseInt(s.substring(0, 4), 10);
const m = parseInt(s.substring(5, 7), 10) - 1; // JS months are 0-11
const d = parseInt(s.substring(8, 10), 10);
const date = new Date(y, m, d);
return (
date.getFullYear() === y &&
date.getMonth() === m &&
date.getDate() === d
);
}
/**
* Validates Geohash string against standard b32 alphabet
* (Syntactically Only validation)

View File

@@ -13,7 +13,7 @@ export class StationDataModule {
* @param ln Longitude
* @returns Geohash as string
*/
static generateGeohash(lt: number, ln: number): string {
generateGeohash(lt: number, ln: number): string {
return Geohash.encode(lt, ln, 6);
}

34
src/modules/trains.ts Normal file
View File

@@ -0,0 +1,34 @@
import { ApiTrainsTrainByHeadcode } from '@owlboard/api-schema-types';
import type { BaseClient, ApiResult } from '../lib/base.js';
import { IsValidHeadcode, IsValidToc, IsValidDateStr } from '../lib/validation.js';
import { ensureDateString } from '../lib/helpers.js';
import { ValidationError } from '../lib/errors.js';
export class TrainsModule {
constructor(private client: BaseClient) { }
async getByHeadcode(headcode: string, date: string | Date = new Date, toc: string = ""): Promise<ApiResult<ApiTrainsTrainByHeadcode.TrainByHeadcodeResponse[]>> {
if (!IsValidHeadcode(headcode)) {
throw new ValidationError("headcode", "Invalid headcode format")
}
if (toc !== "" && !IsValidToc(toc)) {
throw new ValidationError("TOC", "Invalid TOC Format, needs to be two characters");
}
const dateStr = ensureDateString(date);
if (!IsValidDateStr(dateStr)) {
throw new ValidationError("Date", "Invalid date format, need YYYY-MM-DD");
}
const searchParams = new URLSearchParams();
searchParams.append('d', dateStr);
searchParams.append('h', headcode);
if (toc) searchParams.append('t', toc);
const path = `/trains?${searchParams.toString()}`;
return this.client.request<ApiTrainsTrainByHeadcode.TrainByHeadcodeResponse[]>(path, {
method: 'GET',
});
}
}

View File

@@ -7,9 +7,9 @@
// Environment Settings
// See also https://aka.ms/tsconfig/module
"module": "esnext",
"module": "nodenext",
"target": "esnext",
"moduleResolution": "bundler",
"moduleResolution": "nodenext",
"baseUrl": ".",
"types": [],
// For nodejs: