@qikdev/sdk 1.0.4 → 1.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qikdev/sdk",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "type": "module",
   "description": "Promise based Javascript SDK",
   "main": "./dist/main.js",
@@ -11,7 +11,7 @@
     "test": "mocha  --colors ./test/*.spec.js",
     "test:watch": "mocha  --colors -w ./test/*.spec.js",
     "test:auth": "yarn build && node test/server.js",
-    "document": "jsdoc -r  . -d public -c jsdoc.conf README.md"
+    "document": "jsdoc -d public -c jsdoc.conf README.md"
   },
   "exports": {
     ".": {

package/src/api/qik.api.js

@@ -273,6 +273,34 @@ var QikAPI = function (qik) {
             //Ignore let QikAuth handle it
             break;
 
+          case 429: {
+            // Rate-limited by the server's fairness/concurrency limiter. It
+            // sends Retry-After (seconds); honour it — with jitter so a burst
+            // of 429s doesn't retry in lockstep and re-trip the limit — and
+            // retry a few times rather than surfacing the error. Retry state
+            // lives on the request config, NOT the shared retryCount above,
+            // because 429s arrive in concurrent bursts that would corrupt a
+            // single shared counter.
+            var config429 = err.config || {};
+            config429.__retry429 = (config429.__retry429 || 0) + 1;
+            if (config429.__retry429 <= 3) {
+              var retryAfterHeader = parseInt(
+                err?.response?.headers?.["retry-after"],
+                10,
+              );
+              var backoffMs = Number.isFinite(retryAfterHeader)
+                ? retryAfterHeader * 1000
+                : 800 * config429.__retry429;
+              var jitterMs = Math.floor(Math.random() * 500);
+              return new Promise(function (resolve, reject) {
+                setTimeout(function () {
+                  return instance.request(config429).then(resolve, reject);
+                }, backoffMs + jitterMs);
+              });
+            }
+            break;
+          }
+
           case 502:
           case 504:
             if (retryCount < 5) {

package/src/api/qik.filter.js

@@ -325,7 +325,7 @@ service.activeFilterKeys = function(filterConfiguration, options) {
 /**
  * 
  * @description Returns an array of all comparators that are being actively filtered
- * @alias filter.activeFilterKeys
+ * @alias filter.activeFilterComparators
  * @param  {Object} filterConfiguration A filter configuration object
  * @example
  * 

package/src/api/qik.geo.js

@@ -85,7 +85,7 @@ export default function(qik) {
     /**
      * 
      * Start watching the user's geolocation
-     * @alias geo.stopWatchPosition
+     * @alias geo.watchPosition
      * @param  {Function} callback A function that will be called with updated position data
      * @example
      * const result = await sdk.geo.watchPosition(callback)

package/src/api/qik.utils.js

@@ -4,6 +4,12 @@ import { isBrowser, isNode } from "browser-or-node";
 
 ///////////////////////////////////////////////////////////////////////////////
 
+/**
+ * @name utils
+ * @classdesc Utility helper functions — id, ids, hashing, parsing, cleaning, and other general-purpose helpers
+ * @class
+ */
+
 const service = {};
 
 ////////////////////////////////////

package/src/version.js

@@ -1 +1 @@
-export const version = "1.0.4";
+export const version = "1.0.6";