[partykit] broadcastTransactionChanges

Author: jamesgpearce

src/persisters/persister-partykit-server.ts

@@ -80,6 +80,16 @@ export const loadStoreFromStorage = async (
   return [tables, values];
 };
 
+export const broadcastTransactionChanges = async (
+  server: TinyBasePartyKitServer,
+  transactionChanges: TransactionChanges,
+  without?: string[],
+): Promise<void> =>
+  server.party.broadcast(
+    construct(server.config.messagePrefix!, SET_CHANGES, transactionChanges),
+    without,
+  );
+
 const saveStore = async (
   that: TinyBasePartyKitServer,
   transactionChanges: TransactionChanges,
@@ -235,20 +245,17 @@ export class TinyBasePartyKitServer implements TinyBasePartyKitServerDecl {
 
   async onMessage(message: string, connection: Connection) {
     const {
-      party: {storage, broadcast},
       config: {messagePrefix, storagePrefix},
     } = this;
     await ifNotUndefined(
       deconstruct(messagePrefix!, message, 1),
       async ([type, payload]) => {
         if (
           type == SET_CHANGES &&
-          (await hasStoreInStorage(storage, storagePrefix))
+          (await hasStoreInStorage(this.party.storage, storagePrefix))
         ) {
           await saveStore(this, payload, false, connection);
-          broadcast(construct(messagePrefix!, SET_CHANGES, payload), [
-            connection.id,
-          ]);
+          broadcastTransactionChanges(this, payload, [connection.id]);
         }
       },
     );

src/types/docs/persisters/persister-partykit-server.js

@@ -527,3 +527,21 @@
  * @since v4.4.1
  */
 /// loadStoreFromStorage
+/**
+ * The broadcastTransactionChanges function allows you to broadcast Store
+ * changes to all the client connections of a TinyBasePartyKitServer.
+ *
+ * This is intended for specialist applications that require the ability to
+ * update clients of a TinyBasePartyKitServer in their own custom ways.
+ *
+ * The function is asynchronous, so you should use the `await` keyword or handle
+ * its completion as a promise.
+ * @param server A reference to the TinyBasePartyKitServer object.
+ * @param transactionChanges The Store changes to broadcast to the server's
+ * clients.
+ * @param without An optional array of client connection Ids to exclude from the
+ * broadcast.
+ * @category Connection
+ * @since v4.5.1
+ */
+/// broadcastTransactionChanges

src/types/persisters/persister-partykit-server.d.ts

@@ -4,6 +4,7 @@ import {
   Cell,
   CellOrUndefined,
   Tables,
+  TransactionChanges,
   Value,
   ValueOrUndefined,
   Values,
@@ -89,3 +90,10 @@ export function loadStoreFromStorage(
   storage: Storage,
   storagePrefix?: string,
 ): Promise<[Tables, Values]>;
+
+/// broadcastTransactionChanges
+export function broadcastTransactionChanges(
+  server: TinyBasePartyKitServer,
+  transactionChanges: TransactionChanges,
+  without?: string[],
+): Promise<void>;

src/types/with-schemas/persisters/persister-partykit-server.d.ts

@@ -7,6 +7,7 @@ import {
   NoValuesSchema,
   OptionalSchemas,
   Tables,
+  TransactionChanges,
   Value,
   ValueOrUndefined,
   Values,
@@ -92,3 +93,10 @@ export function loadStoreFromStorage<Schemas extends OptionalSchemas>(
   storage: Storage,
   storagePrefix?: string,
 ): Promise<[Tables<Schemas[0]>, Values<Schemas[1]>]>;
+
+/// broadcastTransactionChanges
+export function broadcastTransactionChanges<Schemas extends OptionalSchemas>(
+  server: TinyBasePartyKitServer,
+  transactionChanges: TransactionChanges<Schemas>,
+  without?: string[],
+): Promise<void>;