@basementuniverse/jsonpad-realtime-sdk 1.3.1 → 1.5.0

package/README.md

@@ -90,6 +90,8 @@ A connection that drops without closing cleanly keeps its slot on the server unt
 const jsonpadRealtime = new JSONPadRealtime('your-api-token', { retry: false });
 ```
 
+The same happens if you subscribe to items by alias while one of your alias indexes is still being built: the connection is refused with `INDEX_BUILDING` (code 16006), and retried once the server's suggested delay has passed. Subscribing by item id always works.
+
 ## `listen()` method
 
 The `listen()` method takes an array of event types to listen for. You can pass in any of the following event types:

package/build/jsonpad-realtime-sdk.d.ts

@@ -6,12 +6,20 @@ type EventDetail<T extends object> = {
 
 type EventType = 'list-created' | 'list-updated' | 'list-deleted' | 'item-created' | 'item-updated' | 'item-restored' | 'item-deleted';
 
+/**
+ * An item, as it arrives in a realtime event
+ *
+ * Realtime clients authenticate with an API token and never with an identity,
+ * so any value covered by a guard index in the item's list has already been
+ * removed from `data` before the event was published
+ */
 type Item = {
     id: string;
     createdAt: Date;
     updatedAt: Date;
     data: any;
     description: string;
+    tags: string[];
     version: string;
     readonly: boolean;
     activated: boolean;
@@ -49,6 +57,7 @@ type List = {
     };
     name: string;
     description: string;
+    tags: string[];
     pathName: string;
     schema: any;
     pinned: boolean;
@@ -101,7 +110,8 @@ declare class ListEvent extends CustomEvent<any> {
  */
 declare class RealtimeErrorEvent extends CustomEvent<string> {
     /**
-     * The jsonpad error code, e.g. 10015, or null if the error didn't come from
+     * The jsonpad error code, e.g. 10015 (too many connections) or 16006 (an
+     * alias index is still being built), or null if the error didn't come from
      * the server
      */
     readonly code: number | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basementuniverse/jsonpad-realtime-sdk",
-  "version": "1.3.1",
+  "version": "1.5.0",
   "description": "JSONPad Realtime SDK for Node and browser",
   "author": "Gordon Larrigan <gordonlarrigan@gmail.com> (https://gordonlarrigan.com)",
   "license": "MIT",

package/src/events/realtime-error-event.ts

@@ -9,7 +9,8 @@ import { RealtimeErrorData } from '../types';
  */
 export class RealtimeErrorEvent extends CustomEvent<string> {
   /**
-   * The jsonpad error code, e.g. 10015, or null if the error didn't come from
+   * The jsonpad error code, e.g. 10015 (too many connections) or 16006 (an
+   * alias index is still being built), or null if the error didn't come from
    * the server
    */
   public readonly code: number | null;

package/src/types/item.ts

@@ -11,6 +11,7 @@ export type Item = {
   updatedAt: Date;
   data: any;
   description: string;
+  tags: string[];
   version: string;
   readonly: boolean;
   activated: boolean;

package/src/types/list.ts

@@ -13,6 +13,7 @@ export type List = {
   };
   name: string;
   description: string;
+  tags: string[];
   pathName: string;
   schema: any;
   pinned: boolean;