Skip to content

Latest commit

 

History

History
189 lines (116 loc) · 5.05 KB

CHANGELOG.md

File metadata and controls

189 lines (116 loc) · 5.05 KB
Raw

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

0.8.5 (2024-11-12)

Added

  • Added icon and selectedIcon as optional props to PoiUpdateForm

0.8.4 (2024-10-18)

Improved

  • Improve build process to export types so third-party can use them
  • Improve GeofenceForm.geometric type

0.8.3 (2024-09-17)

Fixed

  • Fix typo in SitumApiPermissionLevel typing enum

0.8.2 (2024-09-11)

Added

  • Move all the auth session logic to its own domain, this allows third integrators to query for session information, specifically permission access level
  • Lazy load all internal domain (cartography, auth, realtime, user). This improves code maintability.

Improved

  • Improved documentation

0.8.1 (2024-07-19)

Fixed

  • Fix build problem

0.8.0 (2024-07-18)

Added

  • Implement new auth mechanism by direct pass of a JWT string
  • Add method to renew expired JWT

Improvements

  • Migrate all tests to raw jest expectations, removed chai and mocha
  • Improve all JSDoc comments
  • Updated almost all dependencies to latest versions (important to fix a CVE from axios)

Fixed

  • Fix createPoi and patchPoi methods broken due to invalid types

0.7.1 (2024-04-24)

Fixed

  • Fixed error on pois fetching duplicating pois when there were outdoor pois,

0.7.0 (2023-11-03)

Fixed

  • Query params where not passed propertly

Added

  • Add new compact view support for the buildings and pois endpoints. This new view allow to save bandwidth while fetching information.

0.6.1 (2023-08-18)

Improvements

  • Remove the email parameter in email/apikey authentication. Now you only need to specify a valid apikey.

0.5.0 (2023-05-26)

Added

  • Added cartesian coordinates to Poi instances.

0.4.0 (2023-03-30)

Added

  • SDKConfiguration may include an optional lang parameter to override the Accept-Language HTTP header. Fallsback to "en" if no language is provided. This avoids known issues when retrieving translated entities (bad translations due to sending arbitrary Accept-Language headers).

    Usage example:

const SitumSDK = require("@situm/sdk-js");

const situmSDK = new SitumSDK({
  auth: {
    apiKey: "MY-API-KEY",
    email: "MY-EMAIL",
  },
  domain: "https://dashboard.situm.com",
  lang: "es",
});

Technically you could use any standard Accept-Language values but we recommend to stick to ISO_639-1, avoiding language variants. For example, don't use "es-GB", use "es" instead.

0.3.0 (2022-11-02)

Added

  • Handler for fetching the current organization info (activated modules, logos, accent colors)

Improvements

  • Add base domain to the poi categories icon urls. This fixes image urls pointing to wrong environment.

0.2.0 (2022-04-22)

Fixed

  • build: Export types propertly to dist/index.d.ts

0.1.0 (2022-04-12)

Improvements

  • BREAKING CHANGES!
    • renamed method realtime.getUserPositions to realtime.getPositions
    • renamed method getFloorsOfBuildingId to getFloors
    • renamed method updatePath to patchPath
    • renamed method getPoisOfBuiding to getPois, now supports filtering
    • renamed method searchGeofences to getGeofences
  • build:
    • move to rollup and esbuild as the build system
    • generate cjs, umd and es5 builds
  • chore: improve typing system by using generics in the base API
  • test:
    • Improve test coverage
  • doc:
    • Added documentation for all domain methods
    • Improved typedoc configuration to export symbols of internal domain classes. Now you can use npm run doc to generate documentation in docs/public

Fixed

  • ensure to pass base configuration in the SitumSDK main class
  • remove duplicated User-Agent headers check in apiBase
  • crash in browsers due to user-agent header not writeable
  • Disable injecting version in headers for now
  • double check in content-type header while building request headers

0.0.5 (2022-02-21)

Improvements

  • Separated all data mappers (functions to map server responses to TS objects) into the adapters/ folder
  • Added JSDoc to all API wrappers
  • Renamed getFloorsOfBuilding to getFloorsByBuildingId
  • Renamed searchGeofences to getGeofences

Fixed

  • Crash in cartography fetch request due to improper server response handling

0.0.4 (2022-02-14) 💌 edition

Added

  • API wrappers for the POI REST api, now with the complete CRUD

Fixed

  • ES 2017 support

0.0.1 (2021-12-30)

This is the first version of the Situm Javascript SDK.Please bear in mind this is the first draft version. You must not use it as a production-ready package. We will publish further more stable versions.

Added

  • Consumer wrappers for the cartography REST API for the cartography (floors, geofences, pois, paths, events)
  • Consumer wrappers for the Users REST API
  • Consumer wrappers for fetching realtime positioning.
  • Support for multiple authentication methods