c3nav 3.4.7 → 3.5.0

package/README.md

@@ -1,6 +1,6 @@
 # c3nav [![npm version](https://img.shields.io/npm/v/c3nav.svg)](https://www.npmjs.com/package/c3nav)
 
-A [c3nav](https://c3nav.de) API client. For a documentation on the API see https://c3nav.de/api/.
+A [c3nav](https://c3nav.de) API client. For a documentation on the API see [the c3nav API reference](https://39c3.c3nav.de/api/v2/).
 
 ### Installation
 

package/dist/Endpoints.d.ts

@@ -19,6 +19,13 @@ export declare const Endpoint: {
     doors(id?: number | string): string;
     EDITOR: string;
     editor(id?: number | string): string;
+    Editor: {
+        beaconsLookup(): string;
+        bounds(): string;
+        geometryStyles(): string;
+        levelGeometries(levelId: number | string): string;
+        spaceGeometries(spaceId: number | string): string;
+    };
     GEOMETRY: string;
     HOLES: string;
     holes(id?: number | string): string;
@@ -45,17 +52,51 @@ export declare const Endpoint: {
     MAP: string;
     Map: {
         bounds(): string;
+        legend(themeId: number | string): string;
+        load(): string;
+        locationById(locationId: number | string, full?: boolean): string;
+        locationBySlug(locationSlug: string, full?: boolean): string;
+        locationDisplayById(locationId: number | string): string;
+        locationDisplayBySlug(locationSlug: string): string;
+        locationGeometryById(locationId: number | string): string;
+        locationGeometryBySlug(locationSlug: string): string;
+        locations(full?: boolean): string;
+        myPositions(): string;
+        position(positionId: number | string): string;
+        projection(): string;
+        quests(): string;
+        settings(): string;
+        wifidata(): string;
+    };
+    Mesh: {
+        firmwareById(firmwareId: number): string;
+        firmwares(): string;
+        map(levelId: number): string;
+        messages(): string;
     };
     OBSTACLES: string;
     obstacles(id?: number | string): string;
     POIS: string;
     pois(id?: number | string): string;
+    Positioning: {
+        locate(): string;
+        locateTest(): string;
+    };
     RAMPS: string;
     ramps(id?: number | string): string;
     ROUTING: string;
     routing(id?: number | string): string;
+    Routing: {
+        options(): string;
+        optionsForm(): string;
+        route(): string;
+    };
     SESSION: string;
     session(id?: number | string): string;
+    Session: {
+        key(): string;
+        status(): string;
+    };
     SOURCES: string;
     sources(id?: number | string): string;
     SPACES: string;
@@ -65,4 +106,7 @@ export declare const Endpoint: {
     TYPES: string;
     UPDATES: string;
     updates(id?: number | string): string;
+    Updates: {
+        fetch(): string;
+    };
 };

package/dist/Endpoints.js

@@ -2,236 +2,275 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Endpoint = void 0;
 const encode = encodeURIComponent;
+function mapDataEndpoint(path, id) {
+    let endpoint = `/api/v2/mapdata/${path}/`;
+    if (id !== undefined) {
+        endpoint += `${encode(String(id))}/`;
+    }
+    return endpoint;
+}
 exports.Endpoint = {
     ACCESSRESTRICTIONGROUPS: 'accessrestrictiongroups',
     accessRestrictionGroups(id) {
-        let endpoint = `/${exports.Endpoint.ACCESSRESTRICTIONGROUPS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('accessrestrictiongroups', id);
     },
     ACCESSRESTRICTIONS: 'accessrestrictions',
     accessRestrictions(id) {
-        let endpoint = `/${exports.Endpoint.ACCESSRESTRICTIONS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('accessrestrictions', id);
     },
     AREAS: 'areas',
     areas(id) {
-        let endpoint = `/${exports.Endpoint.AREAS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('areas', id);
     },
     BOUNDS: 'bounds',
     BUILDINGS: 'buildings',
     buildings(id) {
-        let endpoint = `/${exports.Endpoint.BUILDINGS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('buildings', id);
     },
     CHANGESETS: 'changesets',
     changesets(id) {
-        let endpoint = `/${exports.Endpoint.CHANGESETS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('changesets', id);
     },
     COLUMNS: 'columns',
     columns(id) {
-        let endpoint = `/${exports.Endpoint.COLUMNS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('columns', id);
     },
-    CROSSDESCRIPTIONS: 'crossdescriptions',
+    CROSSDESCRIPTIONS: 'cross_descriptions',
     crossDescriptions(id) {
-        let endpoint = `/${exports.Endpoint.CROSSDESCRIPTIONS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('cross_descriptions', id);
     },
-    DETAILS: 'details',
+    DETAILS: 'display',
     DOORS: 'doors',
     doors(id) {
-        let endpoint = `/${exports.Endpoint.DOORS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('doors', id);
     },
     EDITOR: 'editor',
     editor(id) {
-        let endpoint = `/${exports.Endpoint.EDITOR}/`;
-        if (id) {
+        let endpoint = '/api/v2/editor/';
+        if (id !== undefined) {
             endpoint += `${encode(String(id))}/`;
         }
         return endpoint;
     },
+    Editor: {
+        beaconsLookup() {
+            return '/api/v2/editor/beacons-lookup/';
+        },
+        bounds() {
+            return '/api/v2/editor/bounds/';
+        },
+        geometryStyles() {
+            return '/api/v2/editor/geometrystyles/';
+        },
+        levelGeometries(levelId) {
+            return `/api/v2/editor/geometries/level/${encode(String(levelId))}/`;
+        },
+        spaceGeometries(spaceId) {
+            return `/api/v2/editor/geometries/space/${encode(String(spaceId))}/`;
+        },
+    },
     GEOMETRY: 'geometry',
     HOLES: 'holes',
     holes(id) {
-        let endpoint = `/${exports.Endpoint.HOLES}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('holes', id);
     },
-    LEAVEDESCRIPTIONS: 'leavedescriptions',
+    LEAVEDESCRIPTIONS: 'leave_descriptions',
     leaveDescriptions(id) {
-        let endpoint = `/${exports.Endpoint.LEAVEDESCRIPTIONS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('leave_descriptions', id);
     },
     Level: {
         levels(id) {
-            let endpoint = `/${exports.Endpoint.LEVELS}/`;
-            if (id) {
-                endpoint += `${encode(String(id))}/`;
-            }
-            return endpoint;
+            return mapDataEndpoint('levels', id);
         },
     },
     LEVELS: 'levels',
     LINEOBSTACLES: 'lineobstacles',
     lineObstacles(id) {
-        let endpoint = `/${exports.Endpoint.LINEOBSTACLES}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('lineobstacles', id);
     },
     Location: {
         detail(id) {
-            let endpoint = `/${exports.Endpoint.LOCATIONS}/`;
-            endpoint += typeof id === 'string' ? 'by_slug/' : '';
-            endpoint += `${encode(String(id))}/`;
-            return endpoint;
+            if (typeof id === 'string') {
+                return `/api/v2/map/locations/by-slug/${encode(String(id))}/`;
+            }
+            return `/api/v2/map/locations/${encode(String(id))}/`;
         },
         details(id) {
-            let endpoint = `/${exports.Endpoint.LOCATIONS}/`;
-            endpoint += typeof id === 'string' ? 'by_slug/' : '';
-            endpoint += `${encode(String(id))}/${exports.Endpoint.DETAILS}/`;
-            return endpoint;
+            if (typeof id === 'string') {
+                return `/api/v2/map/locations/by-slug/${encode(String(id))}/display/`;
+            }
+            return `/api/v2/map/locations/${encode(String(id))}/display/`;
         },
         geometry(id) {
-            let endpoint = `/${exports.Endpoint.LOCATIONS}/`;
-            endpoint += typeof id === 'string' ? 'by_slug/' : '';
-            endpoint += `${encode(String(id))}/${exports.Endpoint.GEOMETRY}/`;
-            return endpoint;
+            if (typeof id === 'string') {
+                return `/api/v2/map/locations/by-slug/${encode(String(id))}/geometry/`;
+            }
+            return `/api/v2/map/locations/${encode(String(id))}/geometry/`;
         },
         locations() {
-            return `/${exports.Endpoint.LOCATIONS}/`;
+            return '/api/v2/map/locations/';
         },
         types() {
-            return `/${exports.Endpoint.LOCATIONS}/${exports.Endpoint.TYPES}/`;
+            return '/api/v2/locations/types/';
         },
     },
     LOCATIONGROUPCATEGORIES: 'locationgroupcategories',
     locationGroupCategories(id) {
-        let endpoint = `/${exports.Endpoint.LOCATIONGROUPCATEGORIES}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('locationgroupcategories', id);
     },
     LOCATIONGROUPS: 'locationgroups',
     locationGroups(id) {
-        let endpoint = `/${exports.Endpoint.LOCATIONGROUPS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('locationgroups', id);
     },
     LOCATIONS: 'locations',
     MAP: 'map',
     Map: {
         bounds() {
-            return `/${exports.Endpoint.MAP}/${exports.Endpoint.BOUNDS}/`;
+            return '/api/v2/map/bounds/';
+        },
+        legend(themeId) {
+            return `/api/v2/map/legend/${encode(String(themeId))}/`;
+        },
+        load() {
+            return '/api/v2/map/load/';
+        },
+        locationById(locationId, full = false) {
+            return full
+                ? `/api/v2/map/locations/${encode(String(locationId))}/full/`
+                : `/api/v2/map/locations/${encode(String(locationId))}/`;
+        },
+        locationBySlug(locationSlug, full = false) {
+            return full
+                ? `/api/v2/map/locations/by-slug/${encode(String(locationSlug))}/full/`
+                : `/api/v2/map/locations/by-slug/${encode(String(locationSlug))}/`;
+        },
+        locationDisplayById(locationId) {
+            return `/api/v2/map/locations/${encode(String(locationId))}/display/`;
+        },
+        locationDisplayBySlug(locationSlug) {
+            return `/api/v2/map/locations/by-slug/${encode(String(locationSlug))}/display/`;
+        },
+        locationGeometryById(locationId) {
+            return `/api/v2/map/locations/${encode(String(locationId))}/geometry/`;
+        },
+        locationGeometryBySlug(locationSlug) {
+            return `/api/v2/map/locations/by-slug/${encode(String(locationSlug))}/geometry/`;
+        },
+        locations(full = false) {
+            return full ? '/api/v2/map/locations/full/' : '/api/v2/map/locations/';
+        },
+        myPositions() {
+            return '/api/v2/map/positions/my/';
+        },
+        position(positionId) {
+            return `/api/v2/map/positions/${encode(String(positionId))}/`;
+        },
+        projection() {
+            return '/api/v2/map/projection/';
+        },
+        quests() {
+            return '/api/v2/map/quests/';
+        },
+        settings() {
+            return '/api/v2/map/settings/';
+        },
+        wifidata() {
+            return '/api/v2/map/wifidata/';
+        },
+    },
+    Mesh: {
+        firmwareById(firmwareId) {
+            return `/api/v2/mesh/firmwares/${encode(String(firmwareId))}/`;
+        },
+        firmwares() {
+            return '/api/v2/mesh/firmwares/';
+        },
+        map(levelId) {
+            return `/api/v2/mesh/map/${encode(String(levelId))}/`;
+        },
+        messages() {
+            return '/api/v2/mesh/messages/';
         },
     },
     OBSTACLES: 'obstacles',
     obstacles(id) {
-        let endpoint = `/${exports.Endpoint.OBSTACLES}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('obstacles', id);
     },
     POIS: 'pois',
     pois(id) {
-        let endpoint = `/${exports.Endpoint.POIS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('pois', id);
+    },
+    Positioning: {
+        locate() {
+            return '/api/v2/positioning/locate/';
+        },
+        locateTest() {
+            return '/api/v2/positioning/locate-test/';
+        },
     },
     RAMPS: 'ramps',
     ramps(id) {
-        let endpoint = `/${exports.Endpoint.RAMPS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('ramps', id);
     },
     ROUTING: 'routing',
     routing(id) {
-        let endpoint = `/${exports.Endpoint.ROUTING}/`;
-        if (id) {
+        let endpoint = '/api/v2/routing/';
+        if (id !== undefined) {
             endpoint += `${encode(String(id))}/`;
         }
         return endpoint;
     },
+    Routing: {
+        options() {
+            return '/api/v2/routing/options/';
+        },
+        optionsForm() {
+            return '/api/v2/routing/options/form/';
+        },
+        route() {
+            return '/api/v2/routing/route/';
+        },
+    },
     SESSION: 'session',
     session(id) {
-        let endpoint = `/${exports.Endpoint.SESSION}/`;
-        if (id) {
+        let endpoint = '/api/v2/auth/session/';
+        if (id !== undefined) {
             endpoint += `${encode(String(id))}/`;
         }
         return endpoint;
     },
+    Session: {
+        key() {
+            return '/api/v2/auth/session/';
+        },
+        status() {
+            return '/api/v2/auth/status/';
+        },
+    },
     SOURCES: 'sources',
     sources(id) {
-        let endpoint = `/${exports.Endpoint.SOURCES}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('sources', id);
     },
     SPACES: 'spaces',
     spaces(id) {
-        let endpoint = `/${exports.Endpoint.SPACES}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('spaces', id);
     },
     STAIRS: 'stairs',
     stairs(id) {
-        let endpoint = `/${exports.Endpoint.STAIRS}/`;
-        if (id) {
-            endpoint += `${encode(String(id))}/`;
-        }
-        return endpoint;
+        return mapDataEndpoint('stairs', id);
     },
     TYPES: 'types',
     UPDATES: 'updates',
     updates(id) {
-        let endpoint = `/${exports.Endpoint.UPDATES}/`;
-        if (id) {
+        let endpoint = '/api/v2/updates/';
+        if (id !== undefined) {
             endpoint += `${encode(String(id))}/`;
         }
         return endpoint;
     },
+    Updates: {
+        fetch() {
+            return '/api/v2/updates/fetch/';
+        },
+    },
 };

package/dist/api/EditorAPI.d.ts

@@ -1,11 +1,13 @@
 import type { APIClient } from '@ffflorian/api-client';
-import type { ClientOptions, Editor } from '../interfaces/';
+import type { ClientOptions, Editor, EditorBeaconsLookup, EditorGeometries, GeometryStyles } from '../interfaces/';
 import { APIBase } from './APIBase';
 export declare class EditorAPI extends APIBase {
     constructor(apiClient: APIClient, options: ClientOptions);
-    /**
-     * @param id The id to get
-     */
-    getById(id: number): Promise<Editor>;
+    getBeaconsLookup(): Promise<EditorBeaconsLookup>;
+    getBounds(): Promise<Editor>;
+    getById(_id: number): Promise<Editor>;
+    getGeometryStyles(): Promise<GeometryStyles>;
+    getLevelGeometries(levelId: number | string, updateCacheKey?: string): Promise<EditorGeometries>;
     getList(): Promise<Editor[]>;
+    getSpaceGeometries(spaceId: number | string, updateCacheKey?: string): Promise<EditorGeometries>;
 }

package/dist/api/EditorAPI.js

@@ -16,22 +16,57 @@ class EditorAPI extends APIBase_1.APIBase {
     constructor(apiClient, options) {
         super(apiClient, options);
     }
-    /**
-     * @param id The id to get
-     */
-    getById(id) {
+    getBeaconsLookup() {
         return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.editor(id);
+            const endpoint = Endpoints_1.Endpoint.Editor.beaconsLookup();
             const { data } = yield this.apiClient.get(endpoint);
             return data;
         });
     }
-    getList() {
+    getBounds() {
         return __awaiter(this, void 0, void 0, function* () {
-            const endpoint = Endpoints_1.Endpoint.editor();
+            const endpoint = Endpoints_1.Endpoint.Editor.bounds();
             const { data } = yield this.apiClient.get(endpoint);
             return data;
         });
     }
+    getById(_id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getBounds();
+        });
+    }
+    getGeometryStyles() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Editor.geometryStyles();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    getLevelGeometries(levelId, updateCacheKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Editor.levelGeometries(levelId);
+            const requestPath = updateCacheKey
+                ? `${endpoint}?update_cache_key=${encodeURIComponent(updateCacheKey)}`
+                : endpoint;
+            const { data } = yield this.apiClient.get(requestPath);
+            return data;
+        });
+    }
+    getList() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const bounds = yield this.getBounds();
+            return [bounds];
+        });
+    }
+    getSpaceGeometries(spaceId, updateCacheKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Editor.spaceGeometries(spaceId);
+            const requestPath = updateCacheKey
+                ? `${endpoint}?update_cache_key=${encodeURIComponent(updateCacheKey)}`
+                : endpoint;
+            const { data } = yield this.apiClient.get(requestPath);
+            return data;
+        });
+    }
 }
 exports.EditorAPI = EditorAPI;

package/dist/api/LocationsAPI.d.ts

@@ -16,7 +16,7 @@ export declare class LocationsAPI extends APIBase {
     getDetails(slug: string): Promise<LocationDetails>;
     getGeometry(id: number): Promise<LocationGeometry>;
     getGeometry(slug: string): Promise<LocationGeometry>;
-    getList(): Promise<Location[]>;
+    getList(geometry?: boolean): Promise<Location[]>;
     getLocation(id: number): Promise<Location>;
     getLocation(slug: string): Promise<Location>;
     getTypes(): Promise<LocationType[]>;

package/dist/api/LocationsAPI.js

@@ -39,10 +39,11 @@ class LocationsAPI extends APIBase_1.APIBase {
             return data;
         });
     }
-    getList() {
+    getList(geometry) {
         return __awaiter(this, void 0, void 0, function* () {
             const endpoint = Endpoints_1.Endpoint.Location.locations();
-            const { data } = yield this.apiClient.get(endpoint);
+            const requestPath = geometry === undefined ? endpoint : `${endpoint}?geometry=${String(geometry)}`;
+            const { data } = yield this.apiClient.get(requestPath);
             return data;
         });
     }

package/dist/api/MapAPI.d.ts

@@ -1,8 +1,23 @@
 import type { APIClient } from '@ffflorian/api-client';
-import type { Bounds, ClientOptions } from '../interfaces/';
+import type { Bounds, ClientOptions, MapLegend, MapLocation, MapLocationDisplay, MapLocationGeometry, MapLocationOptions, MapLocationQueryOptions, MapSettings, Position, Projection, Quest } from '../interfaces/';
 import { APIBase } from './APIBase';
 export declare class MapAPI extends APIBase {
     constructor(apiClient: APIClient, options: ClientOptions);
     /** /bounds/ returns the maximum bounds of the map */
     getBounds(): Promise<Bounds>;
+    getLegend(themeId: number | string): Promise<MapLegend>;
+    getLoad(): Promise<Record<string, number>>;
+    getLocation(idOrSlug: number | string, options?: MapLocationOptions): Promise<MapLocation>;
+    getLocationDisplay(idOrSlug: number | string): Promise<MapLocationDisplay>;
+    getLocationGeometry(idOrSlug: number | string): Promise<MapLocationGeometry>;
+    getLocations(options?: MapLocationQueryOptions): Promise<MapLocation[]>;
+    getLocationsFull(options?: MapLocationQueryOptions): Promise<MapLocation[]>;
+    getMyPositions(): Promise<Position[]>;
+    getPositionById(positionId: number | string): Promise<Position>;
+    getProjection(): Promise<Projection>;
+    getQuests(questType?: string, level?: number): Promise<Quest[]>;
+    getSettings(): Promise<MapSettings>;
+    getWifiData(): Promise<Record<string, unknown>>;
+    setPosition(positionId: number | string, coordinatesId: null | string, timeout?: null | number): Promise<Position>;
+    updateLoad(aps: Record<string, number>): Promise<void>;
 }