sharetribe-flex-sdk 1.14.0

package/.circleci/config.yml

@@ -0,0 +1,22 @@
+version: 2
+jobs:
+  build:
+    branches:
+      ignore:
+        - gh-pages
+    docker:
+      - image: node:8.10.0
+    steps:
+      - checkout
+      - run:
+          name: install
+          command: yarn install
+      - run:
+          name: build
+          command: yarn run build
+      - run:
+          name: test
+          command: yarn test
+      - run:
+          name: lint
+          command: yarn run lint

package/.eslintignore

@@ -0,0 +1,3 @@
+build/
+node_modules/
+docs/

package/.eslintrc.js

@@ -0,0 +1,19 @@
+module.exports = {
+  plugins: [
+    'jest'
+  ],
+  extends: [
+    'plugin:jest/recommended',
+    'airbnb-base',
+    'prettier',
+  ],
+  parserOptions: {
+    sourceType: 'module',
+  },
+  env: {
+    es6: true,
+    browser: false,
+    node: false,
+    jest: true
+  },
+};

package/CHANGELOG.md

@@ -0,0 +1,231 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a
+Changelog](http://keepachangelog.com/en/1.0.0/) and this project
+adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased] - xxxx-xx-xx
+
+## [v1.14.0] - 2021-09-20
+
+### Added
+
+- New endpoints [#142](https://github.com/sharetribe/flex-sdk-js/pull/142)
+  - `sdk.stockAdjustments.query(/* ... */)`
+  - `sdk.stockAdjustments.create(/* ... */)`
+  - `sdk.stock.compareAndSet(/* ... */)`
+
+### Changed
+
+- Extend cookie expiration from 30 days to 180 days. This matches
+  with the lifetime of the refresh token returned by the Auth API.
+  [#138](https://github.com/sharetribe/flex-sdk-js/pull/138)
+- SDK shows a warning if Client Secret is used in a browser.
+  [#134](https://github.com/sharetribe/flex-sdk-js/pull/134)
+
+### Security
+
+- Update Axios to 0.21.1 [#126](https://github.com/sharetribe/flex-sdk-js/pull/126)
+- Update Lodash to 4.17.21 [#131](https://github.com/sharetribe/flex-sdk-js/pull/131)
+- Update development dependencies with security vulnerabilities (multiple PRs)
+
+## [v1.13.0] - 2020-10-15
+
+### Added
+
+- New endpoints [#121](https://github.com/sharetribe/flex-sdk-js/pull/121)
+  - `sdk.loginWithIdp(/* ... */)`
+  - `sdk.currentUser.createWithIdp(/* ... */)`
+
+## [v1.12.0] - 2020-08-12
+
+### Added
+
+- A utility function to convert an object query parameter into a URL compatible
+  string. [#119](https://github.com/sharetribe/flex-sdk-js/pull/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
+
+### Added
+
+- Export Transit serialization helpers
+  [#113](https://github.com/sharetribe/flex-sdk-js/pull/113)
+
+## [v1.11.0-alpha] - 2020-05-08
+
+### Added
+
+- New experimental method `exchangeToken`
+  [#110](https://github.com/sharetribe/flex-sdk-js/pull/110)
+
+## [v1.10.0] - 2020-02-28
+
+### Changed
+
+- The JS SDK Repl environment replaced with a new API Playground
+  [#109](https://github.com/sharetribe/flex-sdk-js/pull/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
+
+### Fixed
+
+- Handling old API tokens that lack the `scope` attribute in `sdk.authInfo`
+  [#108](https://github.com/sharetribe/flex-sdk-js/pull/108)
+
+## [v1.9.0] - 2020-02-12
+
+### Added
+
+- Support for logging in using an authorization code
+  [#107](https://github.com/sharetribe/flex-sdk-js/pull/107)
+
+### Changed
+
+- `sdk.authInfo` return value has been updated
+   [#107](https://github.com/sharetribe/flex-sdk-js/pull/107). The `grantType`
+   attribute has been deprecated and now the returned attributes are:
+  - `isAnonymous`: a boolean denoting if the currently stored token only allows
+     public read access
+  - `scopes`: an array containing the scopes associated with the access token
+
+## [v1.8.0] - 2019-12-20
+
+### Changed
+
+- Add endpoint [#105](https://github.com/sharetribe/flex-sdk-js/pull/105)
+  - `sdk.stripeAccount.fetch(/* ... */)`
+
+## [v1.7.0] - 2019-12-05
+
+### Changed
+
+- Remove endpoint [#104](https://github.com/sharetribe/flex-sdk-js/pull/103)
+  - `sdk.stripeAccountData.fetch(/* ... */)`
+
+## [v1.6.0] - 2019-12-05
+
+### Added
+
+- New endpoints [#103](https://github.com/sharetribe/flex-sdk-js/pull/103)
+  - `sdk.stripeAccountData.fetch(/* ... */)`
+  - `sdk.stripeAccountLinks.create(/* ... */)`
+
+## [v1.5.0] - 2019-08-21
+
+### Security
+
+- Upgrade dependencies with security issues:
+  - Axios (thanks [@joekarasek](https://github.com/joekarasek)!) [#98](https://github.com/sharetribe/flex-sdk-js/pull/95)
+  - Docpress [#97](https://github.com/sharetribe/flex-sdk-js/pull/97)
+  - Jest and Babel [#96](https://github.com/sharetribe/flex-sdk-js/pull/96)
+  - all the patch and minor release updateds for all the dependencies [#101](https://github.com/sharetribe/flex-sdk-js/pull/101)
+
+### Added
+
+- New endpoints [#100](https://github.com/sharetribe/flex-sdk-js/pull/100)
+  - `sdk.stripeSetupIntents.create(/* ... */)`
+  - `sdk.stripeCustomer.create(/* ... */)`
+  - `sdk.stripeCustomer.addPaymentMethod(/* ... */)`
+  - `sdk.stripeCustomer.deletePaymentMethod(/* ... */)`
+
+## [v1.4.0] - 2019-04-16
+
+### Added
+
+- `sdkType` property to the type handler configuration. This property
+  replaces the deprecated `type`
+  property. [#94](https://github.com/sharetribe/flex-sdk-js/pull/94)
+- `appType` property to the type handler configuration. This property
+  replaces the deprecated `customType`
+  property. [#94](https://github.com/sharetribe/flex-sdk-js/pull/94)
+- `canHandle` property to the type handler configuration. The value is
+  expected to be a predicate function (i.e. function that returns
+  truthy or falsy values). If `canHandle` 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](https://github.com/sharetribe/flex-sdk-js/pull/94)
+- Added information about the `canHandle` function in the "Your own
+  types"
+  document. [#94](https://github.com/sharetribe/flex-sdk-js/pull/94)
+
+### Deprecated
+
+- `type` property in type handler configuration. Use `sdkType` instead.
+- `customType` property in type handler configuration. Use `appType` instead.
+
+## [v1.3.0] - 2019-02-27
+
+### Added
+
+- Missing step (copy sharetribe-flex-sdk-web.js from /build/ to /docs/)
+- New endpoints [#92](https://github.com/sharetribe/flex-sdk-js/pull/92)
+  - `sdk.stripeAccount.create(/* ... */)`
+  - `sdk.stripeAccount.update(/* ... */)`
+  - `sdk.stripePersons.create(/* ... */)`
+
+### Changed
+
+- Updated dependencies
+
+## [v1.2.0] - 2018-11-27
+
+### Added
+
+- New endpoints [#89](https://github.com/sharetribe/flex-sdk-js/pull/89)
+  - `sdk.availabilityExceptions.create(/* ... */)`
+  - `sdk.availabilityExceptions.delete(/* ... */)`
+  - `sdk.availabilityExceptions.query(/* ... */)`
+  - `sdk.bookings.query(/* ... */)`
+
+### Changed
+
+- Make `baseUrl` optional, defaults to `https://flex-api.sharetribe.com` [#90](https://github.com/sharetribe/flex-sdk-js/pull/90)
+
+## [v1.1.0] - 2018-11-07
+
+### Added
+
+- New endpoints [#88](https://github.com/sharetribe/flex-sdk-js/pull/88)
+  - `sdk.ownListings.createDraft(/* ... */)`
+  - `sdk.ownListings.publishDraft(/* ... */)`
+  - `sdk.ownListings.discardDraft(/* ... */)`
+
+## v1.0.0 - 2018-08-07
+
+This is the first version that is published in NPM.
+
+See: https://www.npmjs.com/package/sharetribe-flex-sdk
+
+### Changed
+
+- Updated dependencies
+- Changed package name from `sharetribe-sdk` to `sharetribe-flex-sdk`
+  to prepare for publishing to NPM. Remember to check your existing
+  imports!
+
+[v1.13.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.12.0...v1.13.0
+[v1.12.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.11.0...v1.12.0
+[v1.11.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.11.0-alpha-1...v1.11.0
+[v1.11.0-alpha-1]: https://github.com/sharetribe/flex-sdk-js/compare/v1.11.0-alpha...v1.11.0-alpha-1
+[v1.11.0-alpha]: https://github.com/sharetribe/flex-sdk-js/compare/v1.10.0...v1.11.0-alpha
+[v1.10.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.9.1...v1.10.0
+[v1.9.1]: https://github.com/sharetribe/flex-sdk-js/compare/v1.9.0...v1.9.1
+[v1.9.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.8.0...v1.9.0
+[v1.8.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.7.0...v1.8.0
+[v1.7.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.6.0...v1.7.0
+[v1.6.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.5.0...v1.6.0
+[v1.5.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.4.0...v1.5.0
+[v1.4.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.3.0...v1.4.0
+[v1.3.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.2.0...v1.3.0
+[v1.2.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.1.0...v1.2.0
+[v1.1.0]: https://github.com/sharetribe/flex-sdk-js/compare/v1.0.0...v1.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,76 @@
+# Sharetribe Flex SDK for JavaScript
+
+Use Sharetribe Flex Marketplace API with ease.
+
+[![CircleCI](https://circleci.com/gh/sharetribe/flex-sdk-js.svg?style=svg&circle-token=f2209b7cd8300d10f73d359072d7f03f81bff8f4)](https://circleci.com/gh/sharetribe/flex-sdk-js)
+
+## Table of Contents
+
+* [What is it?](#what-is-it)
+* [Installation](#installation)
+* [Usage](#usage)
+* [Examples](#examples)
+* [Documentation](#documentation)
+* [License](#license)
+
+## What is it?
+
+The SDK is the **easiest** way to interact with Sharetribe Flex
+Marketplace API.
+
+It handles **groundwork** such as authentication, renewing
+authentication tokens and serializing and deserializing data to and from
+JavaScript data structures.
+
+This lets you to **concentrate on building your marketplace
+front-end** instead of setting up the necessary boilerplate to
+communicate with the API.
+
+## Installation
+
+Yarn:
+
+```sh
+yarn add sharetribe-flex-sdk
+```
+
+## Usage
+
+```js
+const sharetribeSdk = require('sharetribe-flex-sdk');
+
+// Create new SDK instance
+const sdk = sharetribeSdk.createInstance({
+  clientId: '<Your Client ID here>'
+});
+
+// Query first 5 listings
+sdk.listings
+  .query({ per_page: 5 })
+  .then(res => {
+    // Print listing titles
+    res.data.data.forEach(listing => {
+      console.log(`Listing: ${listing.attributes.title}`)
+    });
+  })
+  .catch(res => {
+    // An error occurred
+    console.log(`Request failed with status: ${res.status} ${res.statusText}`);
+  });
+```
+
+## Examples
+
+See [examples/](https://github.com/sharetribe/flex-sdk-js/tree/master/examples/) directory in Github repository.
+
+## Documentation
+
+[Documentation can be found here](https://sharetribe.github.io/flex-sdk-js/).
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/sharetribe/flex-sdk-js/tree/master/CHANGELOG.md).
+
+## License
+
+Distributed under [The Apache License, Version 2.0](https://github.com/sharetribe/flex-sdk-js/tree/master/LICENSE)