project-inter-server/src/repository.ts

// If types match closely, we can use TypeScript "casting"
// to convert from data repo to GraphQL schema

export interface IEntityWithId {
  id: string;
}

export interface ISystem extends IEntityWithId {
  name: string;
}

export interface ICoordinates {
  latitude: number;
  longitude: number;
}

export interface IRoute extends IEntityWithId {
  name: string;
  color: string;
  polylineCoordinates: ICoordinates[];
  systemId: string;
}

export interface IStop extends IEntityWithId {
  name: string;
  systemId: string;
  coordinates: ICoordinates;
}

export interface IShuttle extends IEntityWithId {
  coordinates: ICoordinates;
  name: string;
  routeId: string;
  systemId: string;
}

export interface IEta {
  secondsRemaining: number;
  shuttleId: string;
  stopId: string;
}

export interface IOrderedStop {
  nextStop?: IOrderedStop;
  previousStop?: IOrderedStop;
  routeId: string;
  stopId: string;
  position: number;
}

/**
 * Repository interface for data derived from Passio API.
 * The repository is not designed to have write locks in place.
 * Objects passed from/to the repository should be treated
 * as disposable.
 */
export interface Repository {
  // Getter methods

  getSystems(): Promise<ISystem[]>;
  getSystemById(systemId: string): Promise<ISystem | null>;

  getStopsBySystemId(systemId: string): Promise<IStop[]>;
  getStopById(stopId: string): Promise<IStop | null>;

  getRoutesBySystemId(systemId: string): Promise<IRoute[]>;
  getRouteById(routeId: string): Promise<IRoute | null>;

  getShuttlesBySystemId(systemId: string): Promise<IShuttle[]>;
  getShuttleById(shuttleId: string): Promise<IShuttle | null>;
  getShuttlesByRouteId(routeId: string): Promise<IShuttle[]>;

  getEtasForShuttleId(shuttleId: string): Promise<IEta[]>;
  getEtasForStopId(stopId: string): Promise<IEta[]>;

  getEtaForShuttleAndStopId(shuttleId: string, stopId: string): Promise<IEta | null>;

  getOrderedStopByRouteAndStopId(routeId: string, stopId: string): Promise<IOrderedStop | null>;

  /**
   * Get ordered stops with the given stop ID.
   * Returns an empty array if no ordered stops found.
   * @param stopId
   */
  getOrderedStopsByStopId(stopId: string): Promise<IOrderedStop[]>;

  /**
   * Get ordered stops with the given route ID.
   * Returns an empty array if no ordered stops found.
   * @param routeId
   */
  getOrderedStopsByRouteId(routeId: string): Promise<IOrderedStop[]>;

  // Setter methods
  addOrUpdateSystem(system: ISystem): Promise<void>;
  addOrUpdateRoute(route: IRoute): Promise<void>;
  addOrUpdateShuttle(shuttle: IShuttle): Promise<void>;
  addOrUpdateStop(stop: IStop): Promise<void>;
  addOrUpdateOrderedStop(orderedStop: IOrderedStop): Promise<void>;
  addOrUpdateEta(eta: IEta): Promise<void>;
}