@basementuniverse/jsonpad-realtime-sdk 1.3.0 → 1.4.0

package/README.md

@@ -166,3 +166,13 @@ The event object passed to the event listener has the following properties:
   };
 }
 ```
+
+## Guard indexes
+
+If a list has any [guard indexes](https://jsonpad.io/documentation/indexing), the
+values they point at are removed from an item's `data` before the event is
+published, so they never reach a realtime client.
+
+Realtime connections authenticate with an API token and can't use an identity,
+so there is no realtime equivalent of the API's `includeGuarded` parameter. Read
+a guarded value through the API instead, as the identity that owns the item.

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;

package/package.json

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

package/src/types/item.ts

@@ -1,9 +1,17 @@
+/**
+ * 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
+ */
 export type Item = {
   id: string;
   createdAt: Date;
   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;