@qikdev/sdk 1.0.2 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qikdev/sdk",
-  "version": "1.0.2",
+  "version": "1.0.5",
   "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/docs -c jsdoc.conf README.md"
+    "document": "jsdoc -d public -c jsdoc.conf README.md"
   },
   "exports": {
     ".": {

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.socket.js

@@ -73,18 +73,6 @@ const QikSocket = function(qik, mode) {
         }
 
         const bucket = new EventDispatcher();
-        buckets[key] = bucket;
-
-        if (!service.connected) {
-            // Return the socket
-            await service.connect();
-        }
-
-        // Subscribe to this channel
-        service.subscribe(key);
-
-        // Listen for all relevant events
-        service.addEventListener(key, dispatchMessage);
 
         function dispatchMessage(message) {
             bucket.dispatch('message', message);
@@ -100,6 +88,24 @@ const QikSocket = function(qik, mode) {
             delete buckets[key];
         }
 
+        // Cache the fully-formed bucket (with destroy attached) BEFORE the
+        // connect() await below. A concurrent channel(key) call can hit the
+        // early return above while we're suspended awaiting connect(); if we
+        // registered the bucket before assigning destroy, that caller would
+        // receive a bucket whose destroy() is missing and throw on teardown.
+        buckets[key] = bucket;
+
+        if (!service.connected) {
+            // Return the socket
+            await service.connect();
+        }
+
+        // Subscribe to this channel
+        service.subscribe(key);
+
+        // Listen for all relevant events
+        service.addEventListener(key, dispatchMessage);
+
         return buckets[key];
     }
 

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.1";
+export const version = "1.0.5";