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.
5.2.1 - 2023-05-22
- missing Accept header in GET requests
5.2.0 - 2023-03-09
fetch
options can now takebaseUrl
for defining custom base URL for the single request only
5.1.0 - 2023-03-08
getAccessToken
method for fetching the access token that's up-to-date
5.0.0 - 2022-10-05
- BREAKING CHANGE
MapResponse
andMapRevisionResponse
may containnull
values inmap_provider
andmap_provider_url
fields
4.0.0 - 2022-09-09
- BREAKING CHANGE
SDKConfigResponse
introduces nullability to some fields
3.0.0 - 2022-05-16
- option
profile
added togetMapsList
- BREAKING CHANGE
getMapsList
result with more information
2.1.0 - 2022-04-29
createProvider
,createProfile
,createMap
dry run option
createProvider
throwsCreateProviderApiError
createProfile
throwsCreateProfileApiError
2.0.0 - 2022-04-12
- BREAKING CHANGE
getProfilesList
result with more information
1.1.0 - 2021-11-24
authenticate
option togetProfile
,getProfileAST
,getProfileSource
functions
1.0.1 - 2021-11-23
- Use of URL and URLSearchParams in browser
1.0.0 - 2021-11-22
- new argument to
passwordless
andgetGithubLoginUrl
to be able to pass any query parameters
- BREAKING CHANGE
getProfile
,getProfileAST
,getProfileSource
arguments changed - parameters
scope
andversion
are optional ingetProfile
,getProfileAST
,getProfileSource
functions - BREAKING CHANGE
getMap
,getMapAST
,getMapSource
arguments changed - parameter
scope
andversion
are optional ingetMap
,getMapAST
,getMapSource
functions
0.0.26 - 2021-10-22
getProvider
andgetProvidersList
correctly map older flat provider API response by removing theurl
param from the definition
0.0.25 - 2021-10-21
- BREAKING CHANGE removed
Provider
interface - BREAKING CHANGE nested provider definition in
ProviderResponse
- BREAKING CHANGE nested provider definition in
ProviderListResponse
0.0.24 - 2021-09-09
createProject
method for initializing new projects
0.0.23 - 2021-08-31
- include
user-session
cookie insignOut
request
0.0.22 - 2021-08-27
shareProfile
method shares profile
0.0.21 - 2021-08-26
getUserInfo
method fetches information about logged in user
0.0.20 - 2021-08-25
confirmCliLogin
uses correct HTTP method
0.0.19 - 2021-08-25
getProfilesList
method fetches list of published profiles (incl. filter by profile owner & results count limit)getMapsList
method fetches list of published map variants (incl. filter by map owner & results count limit)cliLogin
method fetches verify and browser urls with expiration dateverifyCliLogin
method fetches status of CLI loginconfirmCliLogin
method confirms CLI login
- BREAKING CHANGE
findOneProvider
renamed togetProvider
- BREAKING CHANGE
findAllProviders
renamed togetProvidersList
, now has ability to filter providers by profile and owner (incl. results count limit) - BREAKING CHANGE
PasswordlessVerifyOptions
renamed toVerifyOptions
- BREAKING CHANGE
PasswordlessVerifyResponse
renamed toVerifyResponse
- BREAKING CHANGE
PasswordlessVerifyErrorResponse
renamed toVerifyErrorResponse
- BREAKING CHANGE
PasswordlessConfirmErrorResponse
renamed toLoginConfirmErrorResponse
- BREAKING CHANGE
passwordlessLogin
do not throw on json deserialization errors and returnsUnsuccessfulLogin
as result
0.0.18 - 2021-08-18
0.0.17 - 2021-06-29
getSDKConfiguration
method fetches SDK configuration for a given projectgetSDKPerformStatistics
method fetches perform statistics for a given project/profile/providergetSDKProviderChangesList
method lists provider changes for a given project/profile/provider
0.0.16 - 2021-06-17
getProjectsList
method lists all projects owned by the authenticated usergetProject
method fetches a single projectupdateProject
method updates a project
0.0.15 - 2021-06-03
confirmPasswordlessLogin
method with logic for confirming passwordless login flow
0.0.14 - 2021-05-14
- Custom errors have properly set prototype as described in TypeScript Documentation.
0.0.13 - 2021-05-14
- Service Client throws custom errors.
ServiceClientError
as generic error from Service Client andServiceApiError
as error when non 2xx response is received from service apis.
0.0.13-beta.0 - 2021-05-13
0.0.12 - 2021-05-04
fetch
options takeauthenticate
boolean parameter to optionally disable authentication (which is enabled by default)
- the following methods now do not authenticate against Brain:
findAllProviders
findOneProvider
parseProfile
getProfile
getProfileSource
getProfileAST
parseMap
getMap
getMapSource
getMapAST
0.0.11 - 2021-04-29
- Release script
0.0.10 - 2021-04-27
getGithubLoginUrl
method parametermode
added
0.0.9 - 2021-04-23
- BREAKING CHANGE:
BrainClient
renamed toServiceClient
- BREAKING CHANGE: package renamed to
@superfaceai/service-client
0.0.8 - 2021-04-23
- BREAKING CHANGE:
passwordlessLogin
returns error object instead of throwing
0.0.7 - 2021-04-20
createProvider
method creates provider in storefindAllProviders
method returns all providers in storefindOneProvider
method returns one provider from storecreateProfile
method creates profile in storeparseProfile
method parses profile using store apigetProfile
method return profile from store in jsongetProfileSource
method return profile from store in suma formatgetProfileAST
method return profile from store in ast formatcreateMap
method creates map in storeparseMap
method parses map using store apigetMap
method return map from store in jsongetMapSource
method return map from store in suma formatgetMapAST
method return map from store in ast formatsignOut
method for facilitating session sign out with Brain
0.0.6 - 2021-04-19
passwordlessLogin
method takes optional login mode (login
orregister
)
- removed
RequestInit
andResponse
import fromcross-fetch
0.0.5 - 2021-04-14
- BREAKING CHANGE:
passwordlessLogin
returns object withverifyUrl
&expiresAt
0.0.4 - 2021-04-09
- Fixed polling in
verifyPasswordlessLogin
when running in the browser
0.0.3 - 2021-04-08
verifyPasswordlessLogin
method takes new optional argumentoptions
and polls verify endpoint if token verification status isPENDING
- BREAKING CHANGE: renamed
TokenVerificationStatus
toVerificationStatus
passwordlessLogin
method toBrainClient
which starts passworldess login flow by sending confirmation e-mailverifyPasswordlessLogin
method toBrainClient
which checks status of passwordless logingetGithubLoginUrl
method toBrainClient