Merge pull request entur#227 from entur/explicit-client-types

Add and export explicit client types

src/index.ts

@@ -1,6 +1,7 @@
 import 'regenerator-runtime/runtime'
 
-import EnturService from './service'
+import createEnturService from './service'
+export type { EnturService } from './service'
 
 export {
     convertFeatureToLocation,
@@ -9,7 +10,10 @@ export {
 } from './utils'
 
 export * as MobilityTypes from './mobility/types'
+export type { MobilityClient } from './mobility'
+
 export * as NsrTypes from './nsr/types'
+export type { NsrClient } from './nsr'
 
 export { TypeName } from './nearest/types'
 export type { NearestPlace } from './nearest/types'
@@ -40,7 +44,7 @@ export type { DeparturesById } from './departure'
 export { County } from './geocoder/countyIds'
 export type { GetFeaturesParams, GetFeaturesReverseParam } from './geocoder'
 
-export default EnturService
+export default createEnturService
 
 export type { Authority } from './fields/Authority'
 export type { BikeRentalStation } from './fields/BikeRentalStation'

src/mobility/index.ts

@@ -4,7 +4,13 @@ import { default as createGetStations } from './getStations'
 import { default as createGetVehicles } from './getVehicles'
 import { default as createGetOperators } from './getOperators'
 
-export default function createClient(config: ArgumentConfig) {
+export interface MobilityClient {
+    getOperators: ReturnType<typeof createGetOperators>
+    getStations: ReturnType<typeof createGetStations>
+    getVehicles: ReturnType<typeof createGetVehicles>
+}
+
+export default function createClient(config: ArgumentConfig): MobilityClient {
     return {
         getOperators: createGetOperators(config),
         getStations: createGetStations(config),

src/nsr/index.ts

@@ -10,7 +10,19 @@ import { default as createGetStopPlaceForQuay } from './getStopPlaceForQuay'
 import { default as createGetTariffZone } from './getTariffZone'
 import { default as createGetTopographicPlace } from './getTopographicPlace'
 
-export default function createClient(config: ArgumentConfig) {
+export interface NsrClient {
+    getFareZone: ReturnType<typeof createGetFareZone>
+    getGroupOfStopPlaces: ReturnType<typeof createGetGroupOfStopPlaces>
+    getParking: ReturnType<typeof createGetParking>
+    getParkingsForStopPlace: ReturnType<typeof createGetParkingsForStopPlace>
+    getQuay: ReturnType<typeof createGetQuay>
+    getStopPlace: ReturnType<typeof createGetStopPlace>
+    getStopPlaceForQuay: ReturnType<typeof createGetStopPlaceForQuay>
+    getTariffZone: ReturnType<typeof createGetTariffZone>
+    getTopographicPlace: ReturnType<typeof createGetTopographicPlace>
+}
+
+export default function createClient(config: ArgumentConfig): NsrClient {
     return {
         getFareZone: createGetFareZone(config),
         getGroupOfStopPlaces: createGetGroupOfStopPlaces(config),

src/service.ts

@@ -23,9 +23,9 @@ import {
     createGetQuaysForStopPlace,
 } from './stopPlace'
 
-import { default as createMobilityClient } from './mobility'
+import { default as createMobilityClient, MobilityClient } from './mobility'
 
-import { default as createNsrClient } from './nsr'
+import { default as createNsrClient, NsrClient } from './nsr'
 
 import {
     createGetBikeRentalStation,
@@ -39,7 +39,63 @@ import { createGetFeatures, createGetFeaturesReverse } from './geocoder'
 
 import { ArgumentConfig, getServiceConfig, ServiceConfig } from './config'
 
-function createEnturService(config: ArgumentConfig) {
+export interface EnturService {
+    journeyPlannerQuery: <T>(
+        query: string,
+        variables: Record<string, unknown>,
+        config: ServiceConfig,
+    ) => Promise<T>
+    queryJourneyPlanner: <T>(
+        queryObj: string,
+        variables: Record<string, unknown>,
+        options?: RequestOptions,
+    ) => Promise<T>
+    nsrQuery: <T>(
+        query: string,
+        variables: Record<string, unknown>,
+        config: ServiceConfig,
+    ) => Promise<T>
+    queryNsr: <T>(
+        queryObj: string,
+        variables: Record<string, unknown>,
+        options?: RequestOptions,
+    ) => Promise<T>
+    getFeatures: ReturnType<typeof createGetFeatures>
+    getFeaturesReverse: ReturnType<typeof createGetFeaturesReverse>
+    getTripPatterns: ReturnType<typeof createGetTripPatterns>
+    findTrips: ReturnType<typeof createFindTrips>
+    getStopPlaceDepartures: typeof getStopPlaceDeparturesDEPRECATED
+    getDeparturesFromStopPlace: ReturnType<
+        typeof createGetDeparturesFromStopPlace
+    >
+    getDeparturesFromStopPlaces: ReturnType<
+        typeof createGetDeparturesFromStopPlaces
+    >
+    getDeparturesFromQuays: ReturnType<typeof createGetDeparturesFromQuays>
+    getDeparturesBetweenStopPlaces: ReturnType<
+        typeof createGetDeparturesBetweenStopPlaces
+    >
+    getDeparturesForServiceJourney: ReturnType<
+        typeof createGetDeparturesForServiceJourney
+    >
+    getNearestPlaces: ReturnType<typeof createGetNearestPlaces>
+    getStopPlace: ReturnType<typeof createGetStopPlace>
+    getStopPlaces: ReturnType<typeof createGetStopPlaces>
+    getParentStopPlace: ReturnType<typeof createGetParentStopPlace>
+    getStopPlacesByPosition: ReturnType<typeof createGetStopPlacesByPosition>
+    getStopPlaceFacilities: ReturnType<typeof createGetStopPlaceFacilities>
+    getQuaysForStopPlace: ReturnType<typeof createGetQuaysForStopPlace>
+    getBikeRentalStation: ReturnType<typeof createGetBikeRentalStation>
+    getBikeRentalStations: ReturnType<typeof createGetBikeRentalStations>
+    getBikeRentalStationsByPosition: ReturnType<
+        typeof createGetBikeRentalStationsByPosition
+    >
+    getScootersByPosition: ReturnType<typeof createGetScootersByPosition>
+    mobility: MobilityClient
+    nsr: NsrClient
+}
+
+function createEnturService(config: ArgumentConfig): EnturService {
     return {
         journeyPlannerQuery: <T>(
             query: string,