npm - sharetribe-flex-sdk - Versions diffs - 1.14.0 - Mend

sharetribe-flex-sdk 1.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (87) hide show

package/.circleci/config.yml +22 -0
package/.eslintignore +3 -0
package/.eslintrc.js +19 -0
package/CHANGELOG.md +231 -0
package/LICENSE +201 -0
package/README.md +76 -0
package/build/sharetribe-flex-sdk-node.js +13592 -0
package/build/sharetribe-flex-sdk-web.js +1 -0
package/docs/README.md +20 -0
package/docs/authentication.md +179 -0
package/docs/calling-the-api.md +217 -0
package/docs/configurations.md +95 -0
package/docs/developing-sdk.md +131 -0
package/docs/docpress.json +14 -0
package/docs/features.md +14 -0
package/docs/keep-alive.md +48 -0
package/docs/object-query-parameters.md +36 -0
package/docs/scripts.js +41 -0
package/docs/serializing-types-to-json.md +40 -0
package/docs/sharing-session-between-client-and-server.md +19 -0
package/docs/styles.css +95 -0
package/docs/token-store.md +114 -0
package/docs/try-it-in-browser.md +32 -0
package/docs/try-it-in-the-playground.md +153 -0
package/docs/types.md +27 -0
package/docs/writing-your-own-token-store.md +29 -0
package/docs/your-own-types.md +61 -0
package/examples/README.md +5 -0
package/examples/getting-started-browser/README.md +22 -0
package/examples/getting-started-browser/index.html +89 -0
package/examples/getting-started-browser/index.js +156 -0
package/examples/getting-started-browser/screenshots/screenshot1.png +0 -0
package/examples/getting-started-browser/screenshots/screenshot2.png +0 -0
package/examples/getting-started-node/README.md +23 -0
package/examples/getting-started-node/index.js +139 -0
package/examples/getting-started-node/screenshots/screenshot.png +0 -0
package/package.json +83 -0
package/playground.js +295 -0
package/src/browser_cookie_store.js +26 -0
package/src/context_runner.js +151 -0
package/src/context_runner.test.js +185 -0
package/src/detect.js +11 -0
package/src/express_cookie_store.js +57 -0
package/src/fake/adapter.js +130 -0
package/src/fake/api.js +137 -0
package/src/fake/auth.js +84 -0
package/src/fake/token_store.js +231 -0
package/src/index.js +25 -0
package/src/interceptors/.eslintrc.js +5 -0
package/src/interceptors/add_auth_header.js +32 -0
package/src/interceptors/add_auth_header.test.js +50 -0
package/src/interceptors/add_auth_token_response.js +16 -0
package/src/interceptors/add_client_id_to_params.js +12 -0
package/src/interceptors/add_client_secret_to_params.js +15 -0
package/src/interceptors/add_grant_type_to_params.js +23 -0
package/src/interceptors/add_idp_client_id_to_params.js +17 -0
package/src/interceptors/add_idp_id_to_params.js +17 -0
package/src/interceptors/add_idp_token_to_params.js +17 -0
package/src/interceptors/add_scope_to_params.js +18 -0
package/src/interceptors/add_subject_token_to_params.js +18 -0
package/src/interceptors/add_token_exchange_grant_type_to_params.js +12 -0
package/src/interceptors/auth_info.js +50 -0
package/src/interceptors/clear_token_after_revoke.js +45 -0
package/src/interceptors/default_params.js +12 -0
package/src/interceptors/fetch_auth_token_from_api.js +33 -0
package/src/interceptors/fetch_auth_token_from_store.js +27 -0
package/src/interceptors/fetch_refresh_token_for_revoke.js +24 -0
package/src/interceptors/multipart_request.js +35 -0
package/src/interceptors/retry_with_anon_token.js +58 -0
package/src/interceptors/retry_with_refresh_token.js +70 -0
package/src/interceptors/save_token.js +20 -0
package/src/interceptors/transit_request.js +27 -0
package/src/interceptors/transit_request.test.js +58 -0
package/src/interceptors/transit_response.js +27 -0
package/src/memory_store.js +19 -0
package/src/params_serializer.js +65 -0
package/src/params_serializer.test.js +58 -0
package/src/sdk.js +894 -0
package/src/sdk.test.js +908 -0
package/src/serializer.js +279 -0
package/src/serializer.test.js +229 -0
package/src/token_store.js +15 -0
package/src/types.js +108 -0
package/src/types.test.js +75 -0
package/src/utils.js +68 -0
package/src/utils.test.js +85 -0
package/webpack.config.babel.js +47 -0

package/docs/your-own-types.md ADDED Viewed

@@ -0,0 +1,61 @@
+# Your own types
+In case you are using your own types or types from external library,
+the SDK provides a way to convert the SDK types to and from your own
+types.
+The conversion is handled by "type handlers". You need to pass
+`typeHandlers` when you create a new SDK instance.
+A type handler is an object containing the following properties:
+| Property | Description |
+| -------- | ----------- |
+| `sdkType` | The SDK type. |
+| `appType` | The application specific type to convert SDK type to/from. |
+| `canHandle` | A predicate function (i.e. function that returns truthy or falsy) that defines whether the this handler should be used. The SDK makes sure that `canHandle` will be called only for not `null` Object values, thus `null` check can be safely omitted.|
+| `reader` | Conversion function. Gets an instance of `sdkType` as an argument, should return instance of `appType`. |
+| `writer` | Conversion function. Gets an instance of `appType` as an argument, should return instance of `sdkType`. |
+Either `appType` or `canHandle` should be provider, but not both.
+Please note: v1.4.0 renamed `type` to `sdkType` and `customType` to `appType`.
+**Example:** Convert
+[`google.maps.LatLng`](https://developers.google.com/maps/documentation/javascript/reference/3/#LatLng)
+to/from `LatLng`, [Decimal.js](https://github.com/MikeMcl/decimal.js/)
+`Decimal` to/from `BigDecimal` and own plain object UUID
+representation to UUID type class instance.
+```js
+const { BigDecimal, LatLng } = require('sharetribe-flex-sdk').types;
+const sdk = createInstance({
+  clientId: config.sdk.clientId,
+  baseUrl: config.sdk.baseUrl,
+  typeHandlers: [
+    {
+      sdkType: BigDecimal,
+      appType: Decimal,
+      writer: v => new BigDecimal(v.toString()),
+      reader: v => new Decimal(v.value),
+    },
+      sdkType: LatLng,
+      appType: google.maps.LatLng,
+      writer: v => new LatLng(v.lat(), v.lng()),
+      reader: v => new google.maps.LatLng(v.lat, v.lng)
+    },
+    {
+      sdkType: UUID,
+      canHandle: v => v.isMyOwnUuidType,
+      writer: v => new UUID(v.myOwnUuidValue),
+      reader: v => ({myOwnUuidValue: v.uuid,
+                     isMyOwnUuidType: true})
+    }
+  ]
+});
+```
+**Caveat:** Only body parameters are converted. An error *Don't know
+how to serialize query parameter* will be thrown if query parameters
+contain your own types.

package/examples/README.md ADDED Viewed

@@ -0,0 +1,5 @@
+# Examples
+[Getting started (Node.js)](./getting-started-node)
+[Getting started (browser)](./getting-started-browser)

package/examples/getting-started-browser/README.md ADDED Viewed

@@ -0,0 +1,22 @@
+# Getting started example (browser)
+This example shows how to query listings using the SDK, in browser.
+## Requirements
+* Client ID
+## How to run the example:
+```
+$ cd [project-root]
+$ yarn install
+$ yarn run build
+$ cd examples/getting-started-browser
+$ open index.html
+```
+## Screenshots
+![Screenshot1](screenshots/screenshot1.png)
+![Screenshot2](screenshots/screenshot2.png)

package/examples/getting-started-browser/index.html ADDED Viewed

@@ -0,0 +1,89 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Getting started example</title>
+    <style>
+      body {
+      font-family: Helvetica,Arial,sans-serif;
+      margin: 50px;
+      }
+      .section {
+        margin-bottom: 50px;
+      }
+      label {
+        display: inline-block;
+        width: 100px;
+      }
+      input[type=text] {
+        width: 300px;
+      }
+      img {
+        margin-right: 20px;
+        margin-bottom: 20px;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="main"></div>
+    <template class="form">
+      <h1>Getting started example</h1>
+      <p>Please type your <strong>Client ID</strong> and click <strong>Submit</strong></p>
+      <form>
+        <p>
+          <label for="client-id">Client ID</label>
+          <input type="text" id="client-id" name="client_id">
+        </p>
+        <p>
+          <input type="submit">
+        </p>
+      </form>
+    </template>
+    <template class="status">
+      <div class="section">
+        <h2>Response status</h3>
+        <p>Status: <span class="status-status"></span></p>
+      </div>
+    </template>
+    <template class="meta">
+      <div class="section">
+        <h2>Response meta</h3>
+        <p>Total items: <span class="meta-total-items"></span></p>
+        <p>Page: <span class="meta-page"></span></p>
+        <p>Images per page: <span class="meta-per-page"></span></p>
+      </div>
+    </template>
+    <template class="listings">
+      <div class="section">
+        <h2>Response data</h2>
+        <div class="listings-listings"></div>
+      </div>
+    </template>
+    <template class="listing">
+      <div>
+        <h3 class="listing-title"></h3>
+        <p>ID: <span class="listing-id"></span></p>
+        <p>Geolocation: <span class="listing-geolocation"></span></p>
+        <p>Created at: <span class="listing-created-at"></span></p>
+        <p>State: <span class="listing-state"></span></p>
+        <div class="listing-images"></div>
+      </div>
+    </template>
+    <script src="../../build/sharetribe-flex-sdk-web.js"></script>
+    <script src="./index.js"></script>
+  </body>
+</html>

package/examples/getting-started-browser/index.js ADDED Viewed

@@ -0,0 +1,156 @@
+/* eslint-env browser */
+/* global sharetribeSdk */
+(() => {
+  //
+  // Helpers
+  //
+  const parseParams = qs => {
+    if (qs && qs.length) {
+      return qs
+        .substr(1)
+        .split('&')
+        .reduce((params, kv) => {
+          const [k, v] = kv.split('=');
+          return Object.assign({}, params, { [k]: decodeURIComponent(v) });
+        }, {});
+    }
+    return {};
+  };
+  const groupById = entities =>
+    entities.reduce(
+      (lookupMap, entity) => Object.assign({}, lookupMap, { [entity.id.uuid]: entity }),
+      {}
+    );
+  const formatMoney = money => {
+    // Be careful!!
+    //
+    // The division by hundred enters to the world of floating-points.
+    // In production software, it's recommended to use a library like decimal.js to handle money calculations
+    //
+    // See more: https://github.com/MikeMcl/decimal.js/
+    //
+    const majorUnitAmount = money.amount / 100;
+    return `${majorUnitAmount} ${money.currency}`;
+  };
+  //
+  // Rendering functions
+  //
+  const mainDiv = document.querySelector('.main');
+  const renderStatus = response => {
+    const statusTemplate = document.querySelector('.status');
+    const elem = statusTemplate.content.cloneNode(true);
+    elem.querySelector('.status-status').textContent = `${response.status} ${response.statusText}`;
+    mainDiv.appendChild(elem);
+  };
+  const renderMeta = response => {
+    const metaTemplate = document.querySelector('.meta');
+    const elem = metaTemplate.content.cloneNode(true);
+    const { meta } = response.data;
+    elem.querySelector('.meta-total-items').textContent = meta.totalItems;
+    elem.querySelector('.meta-page').textContent = `${meta.page} / ${meta.totalPages}`;
+    elem.querySelector('.meta-per-page').textContent = meta.perPage;
+    mainDiv.appendChild(elem);
+  };
+  const renderData = response => {
+    // Group images by ID for easy and fast lookup
+    const { included } = response.data;
+    const images = included ? groupById(included.filter(entity => entity.type === 'image')) : {};
+    const listingsTemplate = document.querySelector('.listings');
+    const listingsContainerElem = listingsTemplate.content.cloneNode(true);
+    const listingTemplate = document.querySelector('.listing');
+    response.data.data.forEach(listing => {
+      const elem = listingTemplate.content.cloneNode(true);
+      elem.querySelector('.listing-title').textContent = `${
+        listing.attributes.title
+      }, ${formatMoney(listing.attributes.price)}`;
+      elem.querySelector('.listing-id').textContent = listing.id.uuid;
+      elem.querySelector('.listing-geolocation').textContent = listing.attributes.geolocation
+        ? `${listing.attributes.geolocation.lat},${listing.attributes.geolocation.lng}`
+        : 'No location';
+      elem.querySelector('.listing-created-at').textContent = listing.attributes.createdAt;
+      elem.querySelector('.listing-state').textContent = listing.attributes.state;
+      const imagesElem = elem.querySelector('.listing-images');
+      listing.relationships.images.data.forEach(img => {
+        const image = images[img.id.uuid];
+        const listingImageElem = document.createElement('img');
+        listingImageElem.src = image.attributes.variants.default.url;
+        imagesElem.appendChild(listingImageElem);
+      });
+      listingsContainerElem.querySelector('.listings-listings').appendChild(elem);
+    });
+    mainDiv.appendChild(listingsContainerElem);
+  };
+  const renderForm = () => {
+    const formTemplate = document.querySelector('.form');
+    const elem = formTemplate.content.cloneNode(true);
+    mainDiv.appendChild(elem);
+  };
+  //
+  // Do the request
+  //
+  const doRequest = clientId => {
+    // Create new SDK instance using the given clientId
+    const sdk = sharetribeSdk.createInstance({
+      clientId,
+    });
+    // Call method sdk.listings.query with params include=images and
+    // per_page=5
+    //
+    // This will call the following API endpoint:
+    //
+    // /listings/query?include=images&per_page=5
+    //
+    // Returns a Promise.
+    //
+    sdk.listings
+      .query({ include: 'images', per_page: 5 })
+      .then(response => {
+        // Successful response
+        //
+        // Render the response
+        //
+        renderStatus(response);
+        renderMeta(response);
+        renderData(response);
+      })
+      .catch(response => {
+        // An error occurred
+        renderStatus(response);
+      });
+  };
+  const params = parseParams(window.location.search);
+  if (params.client_id) {
+    doRequest(params.client_id);
+  } else {
+    renderForm();
+  }
+})();

package/examples/getting-started-browser/screenshots/screenshot1.png ADDED Viewed

Binary file

package/examples/getting-started-browser/screenshots/screenshot2.png ADDED Viewed

Binary file

package/examples/getting-started-node/README.md ADDED Viewed

@@ -0,0 +1,23 @@
+# Getting started example (Node.js)
+This example shows how to query listings using the SDK, in Node.js environment.
+## Requirements
+* Node.js
+* Yarn
+* Client ID
+## How to run the example:
+```
+$ cd [project-root]
+$ yarn install
+$ yarn run build
+$ cd examples/getting-started-node
+$ node index.js [clientId]
+```
+## Screenshots
+![Screenshot](screenshots/screenshot.png)

package/examples/getting-started-node/index.js ADDED Viewed

@@ -0,0 +1,139 @@
+/* eslint-env node */
+const sharetribeSdk = require('../../build/sharetribe-flex-sdk-node');
+//
+// Printing helpers
+//
+/* eslint no-console: "off" */
+const cyan = msg => {
+  console.log('\x1b[36m%s\x1b[0m', msg);
+};
+const yellow = msg => {
+  console.log('\x1b[33m%s\x1b[0m', msg);
+};
+const normal = msg => {
+  console.log(msg);
+};
+const lineBreak = () => {
+  console.log();
+};
+const clientId = process.argv[2];
+//
+// Ensure clientId is set
+//
+if (!clientId) {
+  lineBreak();
+  cyan('Could not found clientId!');
+  lineBreak();
+  yellow('Usage: node index.js [clientId]');
+  lineBreak();
+  process.exit(1);
+}
+const formatMoney = money => {
+  // Be careful!!
+  //
+  // The division by hundred enters to the world of floating-points.
+  // In production software, it's recommended to use a library like decimal.js to handle money calculations
+  //
+  // See more: https://github.com/MikeMcl/decimal.js/
+  //
+  const majorUnitAmount = money.amount / 100;
+  return `${majorUnitAmount} ${money.currency}`;
+};
+const groupById = entities =>
+  entities.reduce(
+    (lookupMap, entity) => Object.assign({}, lookupMap, { [entity.id.uuid]: entity }),
+    {}
+  );
+//
+// Printing functions
+//
+const printStatus = response => {
+  lineBreak();
+  cyan(`** Response status:`);
+  lineBreak();
+  yellow(`${response.status} ${response.statusText}`);
+  lineBreak();
+};
+const printMeta = response => {
+  cyan('** Response meta:');
+  lineBreak();
+  yellow(`Total items: ${response.data.meta.totalItems}`);
+  yellow(`Page: ${response.data.meta.page} / ${response.data.meta.totalPages}`);
+  yellow(`Items per page: ${response.data.meta.perPage}`);
+  lineBreak();
+};
+const printData = response => {
+  // Group images by ID for easy and fast lookup
+  const { included } = response.data;
+  const images = included ? groupById(included.filter(entity => entity.type === 'image')) : {};
+  cyan('** Response data:');
+  lineBreak();
+  response.data.data.forEach(listing => {
+    yellow(`${listing.attributes.title}, ${formatMoney(listing.attributes.price)}`);
+    lineBreak();
+    normal(`ID: ${listing.id.uuid}`);
+    lineBreak();
+    normal(`Images:`);
+    listing.relationships.images.data.forEach(img => {
+      const image = images[img.id.uuid];
+      normal(`- ${image.attributes.variants.default.url}`);
+    });
+    lineBreak();
+    normal(
+      `Geolocation: ${listing.attributes.geolocation.lat},${listing.attributes.geolocation.lng}`
+    );
+    normal(`Created at: ${listing.attributes.createdAt}`);
+    normal(`State: ${listing.attributes.state}`);
+    lineBreak();
+    lineBreak();
+  });
+};
+// Create new SDK instance with clientId
+const sdk = sharetribeSdk.createInstance({
+  clientId,
+});
+lineBreak();
+cyan('** Request:');
+lineBreak();
+yellow(`clientId: ${clientId}`);
+// Call method sdk.listings.query with params include=images and
+// per_page=5
+//
+// This will call the following API endpoint:
+//
+// /listings/query?include=images&per_page=5
+//
+// Returns a Promise.
+//
+sdk.listings
+  .query({ include: 'images', per_page: 5 })
+  .then(response => {
+    // Successful response
+    //
+    // Render the response
+    //
+    printStatus(response);
+    printMeta(response);
+    printData(response);
+  })
+  .catch(response => {
+    // An error occurred
+    printStatus(response);
+  });

package/examples/getting-started-node/screenshots/screenshot.png ADDED Viewed

Binary file

package/package.json ADDED Viewed

@@ -0,0 +1,83 @@
+{
+  "name": "sharetribe-flex-sdk",
+  "version": "1.14.0",
+  "description": "Sharetribe Flex SDK for JavaScript",
+  "main": "build/sharetribe-flex-sdk-node.js",
+  "browser": "build/sharetribe-flex-sdk-web.js",
+  "scripts": {
+    "build": "webpack",
+    "lint": "eslint .",
+    "test": "jest",
+    "playground": "babel-node playground.js",
+    "pg": "babel-node playground.js",
+    "format": "prettier --write --print-width 100 --single-quote --trailing-comma es5 'src/**/*.js' 'examples/**/*.js'",
+    "serve-docs": "docpress serve",
+    "build-docs": "docpress build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sharetribe/flex-sdk-js.git"
+  },
+  "keywords": [
+    "sharetribe",
+    "api",
+    "sdk"
+  ],
+  "author": "Sharetribe",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/sharetribe/flex-sdk-js/issues"
+  },
+  "homepage": "https://github.com/sharetribe/flex-sdk-js",
+  "devDependencies": {
+    "@babel/cli": "^7.0.0",
+    "@babel/core": "^7.0.0",
+    "@babel/node": "^7.0.0",
+    "@babel/plugin-proposal-class-properties": "^7.0.0",
+    "@babel/plugin-proposal-json-strings": "^7.0.0",
+    "@babel/plugin-syntax-dynamic-import": "^7.0.0",
+    "@babel/plugin-syntax-import-meta": "^7.0.0",
+    "@babel/preset-env": "^7.0.0",
+    "babel-core": "^7.0.0-bridge.0",
+    "babel-jest": "^23.4.2",
+    "babel-loader": "^8.0.0",
+    "babel-plugin-lodash": "^3.3.4",
+    "colors": "^1.3.1",
+    "command-line-args": "^5.1.1",
+    "command-line-usage": "^6.0.1",
+    "open": "^7.0.2",
+    "docpress": "^0.7.6",
+    "eslint": "^5.3.0",
+    "eslint-config-airbnb-base": "^13.0.0",
+    "eslint-config-prettier": "^2.9.0",
+    "eslint-plugin-import": "^2.13.0",
+    "eslint-plugin-jest": "^21.18.0",
+    "jest": "^24.8.0",
+    "prettier": "^1.14.0",
+    "webpack": "^3.12.0"
+  },
+  "dependencies": {
+    "axios": "^0.21.1",
+    "js-cookie": "^2.1.3",
+    "lodash": "^4.17.10",
+    "transit-js": "^0.8.861"
+  },
+  "resolutions": {
+    "docpress/**/lodash": "^4.17.10"
+  },
+  "babel": {
+    "plugins": [
+      "lodash",
+      "@babel/plugin-syntax-dynamic-import",
+      "@babel/plugin-syntax-import-meta",
+      "@babel/plugin-proposal-class-properties",
+      "@babel/plugin-proposal-json-strings"
+    ],
+    "presets": [
+      "@babel/preset-env"
+    ]
+  },
+  "jest": {
+    "testEnvironment": "node"
+  }
+}