@mapvx/web-js 1.0.0

package/dist/es/repository/requester.d.ts

@@ -0,0 +1,169 @@
+import type { MapVxRequestContext } from "../config/sdkConfig";
+import { type MapVxProduct } from "../domain/models/platform";
+import { type InternalGetRouteConfiguration } from "../domain/models/routeConfiguration";
+/**
+ * Represents the requester for the repository.
+ * @hidden
+ */
+export declare class Requester {
+    private lang;
+    private readonly baseUrl;
+    private readonly baseUrlApi;
+    private readonly baseUrlPortal;
+    private readonly mapvxRequestContext?;
+    private readonly baseUrlHealth;
+    private readonly oldBaseUrl;
+    private readonly routeBaseUrl;
+    constructor(lang: string, apiUrl?: string, mapvxRequestContext?: MapVxRequestContext);
+    /**
+     * function to change the lang of requests
+     * @param lang request response language
+     */
+    setLang(lang: string): void;
+    /**
+     * Build headers for MapVx request context when target is public-api.mapvx.com.
+     * Only non-empty context values are added as X-MapVx-* headers.
+     */
+    private getMapVxContextHeaders;
+    /**
+     * Make a request using {@link fetch}.
+     * When the request target is public-api.mapvx.com and mapvxRequestContext is set,
+     * adds X-MapVx-* headers (baseUrl, totemId, originId, institutionId, parentPlace, institutionName, fullUrl).
+     *
+     * @param resourceUrl Path to endpoint
+     * @param params should have the token included plus any extra parameter that the url needs
+     * @param options option for fetch method
+     * @returns Response promise
+     */
+    private fetchFromUrl;
+    /**
+     *
+     * @param token
+     * @param stopId
+     * @returns
+     */
+    fetchTransport(token: string, stopId: string): Promise<Response>;
+    /**
+     *
+     * @param token
+     * @param stopId
+     * @param vehicleId
+     * @returns
+     */
+    fetchStops(token: string, stopId: string, vehicleId: string): Promise<Response>;
+    /**
+     *
+     * @param token Client identification
+     * @param placeId
+     * @returns Response promise
+     */
+    fetchMapStyle(token: string, placeId?: string): Promise<Response>;
+    /**
+     * Fetches the map style configuration for a specified institution.
+     * Can be used to obtain any map style from an Institution, without the limitation of the ApiKey.
+     * Therefore, does not make use of an ApiKey but rather an authentication token.
+     *
+     * Sends a GET request to the "mapStyle" endpoint using the provided authentication token
+     * and institution ID. The request includes language and institution ID as query parameters.
+     *
+     * @param token - The Bearer authentication token to authorize the request.
+     * @param institutionId - The unique identifier of the institution whose map style is being requested.
+     * @returns A promise that resolves to the HTTP response containing the map style data.
+     */
+    fetchAnyMapStyle(authToken: string, institutionId: string): Promise<Response>;
+    /**
+     * Obtain allowed Places associated with the key
+     * @param token
+     * @returns Response promise
+     */
+    fetchAllowedPlaces(token: string): Promise<Response>;
+    /**
+     * Fetches the available places for a given institution using the provided authentication token.
+     * Does not make use of an ApiKey but rather an authentication token, therefore it is not limited by the allowed ApiKey places.
+     *
+     * Sends a GET request to the `availablePlaces` endpoint with the institution ID and language as parameters.
+     *
+     * @param authToken - The authentication token used for authorization in the request header.
+     * @param institutionId - The unique identifier of the institution whose places are to be fetched.
+     * @returns A promise that resolves to the response from the API.
+     */
+    fetchPlacesFromAnyInstitution(institutionId: string, authToken: string): Promise<Response>;
+    /**
+     * Obtain info about specific place. Use mainly to obtain innerFloors
+     * @param placeId
+     * @param token
+     * @returns
+     */
+    fetchPlaceDetail(token: string, placeId: string): Promise<Response>;
+    /**
+     * Fetches detailed information for a specific place using its unique identifier.
+     * Can be used to obtain any place detail, without the limitation of the ApiKey.
+     * Therefore, does not make use of an ApiKey but rather an authentication token.
+     *
+     * @param token - The authentication token used for authorization in the request header.
+     * @param placeId - The unique identifier of the place to retrieve details for.
+     * @returns A promise that resolves to the HTTP response containing the place details.
+     *
+     */
+    fetchAnyPlaceDetail(authToken: string, placeId: string): Promise<Response>;
+    /**
+     * To obtain all places associated with targetPlace
+     * @param targetPlaceId
+     * @param token
+     * @returns
+     */
+    fetchSubPlaces(targetPlaceId: string, token: string): Promise<Response>;
+    /**
+     * Fetches sub-places for any specified target place using the Portal API.
+     * Can be used to obtain the sub-places for any target place, without the limitation of the ApiKey.
+     * Therefore, does not make use of an ApiKey but rather an authentication token.
+     *
+     * Sends a GET request to the "subPlaces" endpoint with the provided Bearer authentication token
+     * and target place ID. The request includes language and target place ID as query parameters.
+     *
+     * @param targetPlaceId - The unique identifier of the target place whose sub-places are being requested.
+     * @param authToken - The Bearer authentication token to authorize the request.
+     * @returns A promise that resolves to the HTTP response containing the sub-places data.
+     */
+    fetchAnySubPlaces(targetPlaceId: string, authToken: string): Promise<Response>;
+    /**
+     * To obtain the route
+     * @param routeConfig
+     * @returns
+     */
+    fetchRoute(routeConfig: InternalGetRouteConfiguration, token: string): Promise<Response>;
+    /**
+     * To obtain the route
+     * @param routeConfig
+     * @returns
+     */
+    fetchRouteV2(routeConfig: InternalGetRouteConfiguration, token: string): Promise<Response>;
+    /**
+     * To obtain info associated to an Institution based on id provided
+     * It return 403 if the institution id
+     * @param targetPlaceId
+     * @param token
+     * @returns
+     */
+    fetchInstitutions(token: string): Promise<Response>;
+    /**
+     * To obtain places from an institution whose name is similar to provided input
+     * @param institutionId
+     * @param input Provided value to look for
+     * @param token Client identification
+     * @param parentIds Identifier of the parent place
+     * @param origin The ID of a totem or a place origin from directories. Used to return search results based on distance from the origin.
+     * @param lat Latitude as a string for location-based search.
+     * @param lng Longitude as a string for location-based search.
+     * @param floor Floor ID as a string for location-based search.
+     * @returns Response promise
+     */
+    fetchSearchResults(institutionId: string, input: string, token: string, parentIds?: string[], origin?: string, lat?: string, lng?: string, floor?: string): Promise<Response>;
+    fetchConfiguration(token: string, place_id?: string, product?: MapVxProduct): Promise<Response>;
+    fetchCategories(token: string, place_id?: string): Promise<Response>;
+    fetchRoutesForOrigin(token: string, parentPlaceId: string, fromPlaceId: string, announceFormat: string, unitSystem: string, mode: string): Promise<Response>;
+    fetchCacheTimestamp(token: string, placeId: string): Promise<Response>;
+    fetchCssCustomization(token: string, type: string): Promise<Response>;
+    postHealth(token: string, healthPingId: string, placeId: string, totemId: string, status: boolean): Promise<Response>;
+}
+//# sourceMappingURL=requester.d.ts.map

package/dist/es/repository/requester.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requester.d.ts","sourceRoot":"","sources":["../../../src/repository/requester.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,EAEL,KAAK,6BAA6B,EACnC,MAAM,qCAAqC,CAAA;AAK5C;;;GAGG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,IAAI,CAAQ;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAqB;IAC1D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAQ;gBAGnC,IAAI,EAAE,MAAM,EACZ,MAAM,GAAE,MAAuC,EAC/C,mBAAmB,CAAC,EAAE,mBAAmB;IAgB3C;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAiB9B;;;;;;;;;OASG;YACW,YAAY;IAuB1B;;;;;OAKG;IACG,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAiBlD;;;;;;OAMG;IACG,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAkBjE;;;;;OAKG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAoBvE;;;;;;;;;;;OAWG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAiBnF;;;;OAIG;IACG,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAgB1D;;;;;;;;;OASG;IACG,6BAA6B,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAiBhG;;;;;OAKG;IACG,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAiBzE;;;;;;;;;OASG;IACG,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAgBhF;;;;;OAKG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAiB7E;;;;;;;;;;;OAWG;IACG,iBAAiB,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAiBpF;;;;OAIG;IACG,UAAU,CAAC,WAAW,EAAE,6BAA6B,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IA6D9F;;;;OAIG;IACG,YAAY,CAAC,WAAW,EAAE,6BAA6B,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IA6DhG;;;;;;OAMG;IACG,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAgBzD;;;;;;;;;;;OAWG;IACG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,EAAE,EACpB,MAAM,CAAC,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,QAAQ,CAAC;IAsCd,kBAAkB,CACtB,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,QAAQ,CAAC;IAmBd,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAkBpE,oBAAoB,CACxB,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,QAAQ,CAAC;IAqBd,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAgBtE,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAgBrE,UAAU,CACd,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,OAAO,GACd,OAAO,CAAC,QAAQ,CAAC;CAsBrB"}