All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
Unreleased - xxxx-xx-xx
- Bug: SDK failed to send any extended data if it had a key
length
with a number type value. #199
v1.21.0 - 2024-05-20
- Add a new function
loginAs
. The function takes a single parameter,code
, which is the authorization code to use. This function should be used to do "Login As" instead of usinglogin
function withcode
. #196 - Add a new key
isLoggedInAs
to the return value of theauthInfo
. The value is boolean wheretrue
indicates that "Login As" was used. Applications should use this value to check if "Login As" was used instead of examining the token scopes. #196 - Add a new configuration option
disableDeprecationWarnings
#196
- Using the
login
function to do "Login As", i.e. logging in withcode
instead ofusername
andpassword
is deprecated in favor of a newly addedloginAs
function. #196
v1.20.1 - 2024-02-15
- Prevent unnecessary params from being sent on
loginWithIdp
invocations. #193
v1.20.0 - 2023-10-10
- New endpoints #187
sdk.sitemapData.queryListings(/* ... */)
sdk.sitemapData.queryAssets(/* ... */)
- Update Axios to the latest version. The new version will improve performance by enabling gzip compression. #188
v1.19.0 - 2023-05-09
- Add support for multi-asset fetching. #170
v1.18.1 - 2023-04-17
- Fix issue where custom
User-Agent
string caused warning and issues with CORS when used in browser. The string is no longer customized when running in browser. #184
v1.18.0 - 2023-04-14
v1.17.0 - 2022-05-10
- New configuration option:
assetCdnBaseUrl
#159
- Request Assets in JSON format instead of Transit #160
- Read response data as Transit only if Content-Type header is
application/transit+json
#161
v1.16.0 - 2022-03-23
- New endpoints #156
sdk.currentUser.delete(/* ... */)
- New endpoints #154
sdk.assetByAlias({path, alias})
sdk.assetByVersion({path, version})
v1.15.0 - 2021-10-06
- Ability to serialize an array of SDK types, i.e. array of UUIDs. Useful when
calling e.g.
sdk.listings.query
withids
parameter. #147
v1.14.1 - 2021-09-20
- Update Axios to 0.21.2 #143
v1.14.0 - 2021-09-20
- New endpoints #142
sdk.stockAdjustments.query(/* ... */)
sdk.stockAdjustments.create(/* ... */)
sdk.stock.compareAndSet(/* ... */)
- Extend cookie expiration from 30 days to 180 days. This matches with the lifetime of the refresh token returned by the Auth API. #138
- SDK shows a warning if Client Secret is used in a browser. #134
- Update Axios to 0.21.1 #126
- Update Lodash to 4.17.21 #131
- Update development dependencies with security vulnerabilities (multiple PRs)
v1.13.0 - 2020-10-15
- New endpoints #121
sdk.loginWithIdp(/* ... */)
sdk.currentUser.createWithIdp(/* ... */)
v1.12.0 - 2020-08-12
- A utility function to convert an object query parameter into a URL compatible string. #119
v1.11.0 - 2020-06-16
This release just changes the version number, making the alpha release into a proper release.
v1.11.0-alpha-1 - 2020-06-11
- Export Transit serialization helpers #113
v1.11.0-alpha - 2020-05-08
- New experimental method
exchangeToken
#110
v1.10.0 - 2020-02-28
- The JS SDK Repl environment replaced with a new API Playground
#109
- Support starting in an initialized and authenticated modes
- Support running scripts
- Add helpers and support all API value types
v1.9.1 - 2020-02-18
- Handling old API tokens that lack the
scope
attribute insdk.authInfo
#108
v1.9.0 - 2020-02-12
- Support for logging in using an authorization code #107
sdk.authInfo
return value has been updated #107. ThegrantType
attribute has been deprecated and now the returned attributes are:isAnonymous
: a boolean denoting if the currently stored token only allows public read accessscopes
: an array containing the scopes associated with the access token
v1.8.0 - 2019-12-20
- Add endpoint #105
sdk.stripeAccount.fetch(/* ... */)
v1.7.0 - 2019-12-05
- Remove endpoint #104
sdk.stripeAccountData.fetch(/* ... */)
v1.6.0 - 2019-12-05
- New endpoints #103
sdk.stripeAccountData.fetch(/* ... */)
sdk.stripeAccountLinks.create(/* ... */)
v1.5.0 - 2019-08-21
- Upgrade dependencies with security issues:
- Axios (thanks @joekarasek!) #98
- Docpress #97
- Jest and Babel #96
- all the patch and minor release updateds for all the dependencies #101
- New endpoints #100
sdk.stripeSetupIntents.create(/* ... */)
sdk.stripeCustomer.create(/* ... */)
sdk.stripeCustomer.addPaymentMethod(/* ... */)
sdk.stripeCustomer.deletePaymentMethod(/* ... */)
v1.4.0 - 2019-04-16
sdkType
property to the type handler configuration. This property replaces the deprecatedtype
property. #94appType
property to the type handler configuration. This property replaces the deprecatedcustomType
property. #94canHandle
property to the type handler configuration. The value is expected to be a predicate function (i.e. function that returns truthy or falsy values). IfcanHandle
returns truthy value, the writer function will called. This allows users to fully customize how they use read and writer the data types to and from SDK. #94- Added information about the
canHandle
function in the "Your own types" document. #94
type
property in type handler configuration. UsesdkType
instead.customType
property in type handler configuration. UseappType
instead.
v1.3.0 - 2019-02-27
- Missing step (copy sharetribe-flex-sdk-web.js from /build/ to /docs/)
- New endpoints #92
sdk.stripeAccount.create(/* ... */)
sdk.stripeAccount.update(/* ... */)
sdk.stripePersons.create(/* ... */)
- Updated dependencies
v1.2.0 - 2018-11-27
- New endpoints #89
sdk.availabilityExceptions.create(/* ... */)
sdk.availabilityExceptions.delete(/* ... */)
sdk.availabilityExceptions.query(/* ... */)
sdk.bookings.query(/* ... */)
- Make
baseUrl
optional, defaults tohttps://flex-api.sharetribe.com
#90
v1.1.0 - 2018-11-07
- New endpoints #88
sdk.ownListings.createDraft(/* ... */)
sdk.ownListings.publishDraft(/* ... */)
sdk.ownListings.discardDraft(/* ... */)
This is the first version that is published in NPM.
See: https://www.npmjs.com/package/sharetribe-flex-sdk
- Updated dependencies
- Changed package name from
sharetribe-sdk
tosharetribe-flex-sdk
to prepare for publishing to NPM. Remember to check your existing imports!