Skip to content
This repository has been archived by the owner on May 3, 2021. It is now read-only.

Release: v2.0.0

Compare
Choose a tag to compare
@sgammon sgammon released this 22 Apr 00:15
· 372 commits to master since this release
v2.0.0
f2c6d0f

Description

This is a major release and re-architecture of the Bloombox SDK for JavaScript. In many cases this upgrade will break calls into APIs like menu retrieval, shop operations, and telemetry transmission, so please test carefully before fully upgrading.

As part of the transitional release cycle (i.e. 2.0.x, pre 2.1.x), this version will maintain fallback code to the v1beta0-version API implementations. Once 2.1.x is pushed, it will no longer contain this fallback code. Earlier versions of the library will still work fine but won't be as fast ;).

Improvements

The version 2 re-architecture allows many improvements, most notably:

  • Support for gRPC web, with binary proto encoding over the wire
  • Much wider visibility for the compiler/optimizer
  • Improved test-suite and resulting coverage
  • Unified datamodel support, rather than a manually-maintained façade for API users

Known Issues

This v2 pre-release must only be used directly as sources. Public callers of the library won't find it useful yet. It is, however, compilable via Closure compiler, using goog primitives.

Feature list in detail

  • Support for gRPC via grpc-web (#227)
    • Support for the Menu API (v1beta1)
      • retrieve, featured, product
    • Support for the Shop API (v1)
      • info, zipcheck, verify
    • Support for the Event Telemetry API (v1beta4)
      • ping, event
  • Upstream: Schema support for grpc-web (Bloombox/Schema#106)
  • Updated dependencies and many vulnerabilities fixed (#169, #169, #170, #180, #225)

Using this version

<!doctype html>
<html>
  <head>

  <script type="text/javascript" src="https://js.bloombox.cloud/client/v2.0.0.min.js"></script>
  <script type="text/javascript">
    bloombox.setup("<partner>", "<location>", "<apikey>", function() {
      // use the library
    });
  </script>

  [...]

Changelog

  • [Feature] gRPC Web Support (#227)
  • [Chore] Dependency Update (#225)
  • [Security] Bump extend from 3.0.1 to 3.0.2 (#180)
  • [Security] Bump cryptiles from 3.1.2 to 3.1.4 (#170)
  • [Security] Bump stringstream from 0.0.5 to 0.0.6 (#169)
  • [Security] Bump cached-path-relative from 1.0.1 to 1.0.2 (#168)