@powersync/service-core 0.0.0-dev-20250813080357 → 0.0.0-dev-20250819134004

package/dist/system/ServiceContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"ServiceContext.js","sourceRoot":"","sources":["../../src/system/ServiceContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,EAAqB,MAAM,mCAAmC,CAAC;AAErH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,OAAO,MAAM,6BAA6B,CAAC;AAEvD,OAAO,KAAK,WAAW,MAAM,qCAAqC,CAAC;AACnE,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,KAAK,OAAO,MAAM,6BAA6B,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,KAAK,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAe7D,MAAM,CAAN,IAAY,kBAQX;AARD,WAAY,kBAAkB;IAC5B,iCAA6B,CAAA;IAC7B,mCAA+B,CAAA;IAC/B,yCAAqC,CAAA;IACrC,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;IACvB,2CAAqB,CAAA;IACrB,yDAAmC,CAAA;AACrC,CAAC,EARW,kBAAkB,KAAlB,kBAAkB,QAQ7B;AAOD;;;;GAIG;AACH,MAAM,OAAO,uBAAuB;IAClC,aAAa,CAAgC;IAC7C,eAAe,CAAmB;IAClC,aAAa,CAAwB;IACrC,aAAa,CAAgB;IAC7B,WAAW,CAAc;IACzB,YAAY,CAAsB;IAClC,WAAW,CAAqB;IAEhC,YAAY,OAA8B;QACxC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QAEnC,IAAI,CAAC,eAAe,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAE9C,IAAI,CAAC,aAAa,GAAG,IAAI,OAAO,CAAC,aAAa,CAAC;YAC7C,aAAa;SACd,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC;YAClC,iBAAiB,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC3B,8CAA8C;gBAC9C,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC5C,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAEzC,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE;YACrD,KAAK,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE;YAC/C,IAAI,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE;SAClD,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QAC9C,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE;YACpD,IAAI,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE;SAChD,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC;YACjC,uBAAuB,EAAE,aAAa,CAAC,cAAc,CAAC,0BAA0B;YAChF,UAAU,EAAE,aAAa,CAAC,cAAc,CAAC,0BAA0B;YACnE,wBAAwB,EAAE,aAAa,CAAC,cAAc,CAAC,2BAA2B;SACnF,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAChD,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,uBAAuB,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;QAE1F,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,gBAAgB,EAAE;YACnD,yDAAyD;YACzD,KAAK,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;SACrD,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE;YACrD,IAAI,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE;SAClD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,aAAa;QACf,OAAO,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,SAAS,CAAC,iBAAiB,CAAC,SAAS,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAI,UAAgC,EAAE,cAAiB;QAC7D,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,GAAG,CAAI,UAAgC;QACrC,OAAO,SAAS,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;CACF"}
+{"version":3,"file":"ServiceContext.js","sourceRoot":"","sources":["../../src/system/ServiceContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,EAAqB,MAAM,mCAAmC,CAAC;AAErH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,OAAO,MAAM,6BAA6B,CAAC;AAEvD,OAAO,KAAK,WAAW,MAAM,qCAAqC,CAAC;AACnE,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,KAAK,OAAO,MAAM,6BAA6B,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,KAAK,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAezD,MAAM,CAAN,IAAY,kBAQX;AARD,WAAY,kBAAkB;IAC5B,iCAA6B,CAAA;IAC7B,mCAA+B,CAAA;IAC/B,yCAAqC,CAAA;IACrC,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;IACvB,2CAAqB,CAAA;IACrB,yDAAmC,CAAA;AACrC,CAAC,EARW,kBAAkB,KAAlB,kBAAkB,QAQ7B;AAOD;;;;GAIG;AACH,MAAM,OAAO,uBAAuB;IAClC,aAAa,CAAgC;IAC7C,eAAe,CAAmB;IAClC,aAAa,CAAwB;IACrC,YAAY,CAAe;IAC3B,WAAW,CAAc;IACzB,YAAY,CAAsB;IAClC,WAAW,CAAqB;IAEhC,YAAY,OAA8B;QACxC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QAEnC,IAAI,CAAC,eAAe,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAE9C,IAAI,CAAC,aAAa,GAAG,IAAI,OAAO,CAAC,aAAa,CAAC;YAC7C,aAAa;SACd,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC;YAClC,iBAAiB,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC3B,8CAA8C;gBAC9C,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC5C,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;QACvC,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE;YACpD,IAAI,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE;SAClD,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE;YACrD,KAAK,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE;YAC/C,IAAI,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE;SAClD,CAAC,CAAC;QAEH,IAAI,CAAC,YAAY,GAAG,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QAC9C,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE;YACpD,IAAI,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE;SAChD,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAC;YACjC,uBAAuB,EAAE,aAAa,CAAC,cAAc,CAAC,0BAA0B;YAChF,UAAU,EAAE,aAAa,CAAC,cAAc,CAAC,0BAA0B;YACnE,wBAAwB,EAAE,aAAa,CAAC,cAAc,CAAC,2BAA2B;SACnF,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAChD,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,uBAAuB,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;QAE1F,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,gBAAgB,EAAE;YACnD,yDAAyD;YACzD,KAAK,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;SACrD,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE;YACpD,IAAI,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE;SAClD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,aAAa;QACf,OAAO,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,SAAS,CAAC,iBAAiB,CAAC,SAAS,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAI,UAAgC,EAAE,cAAiB;QAC7D,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,GAAG,CAAI,UAAgC;QACrC,OAAO,SAAS,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;CACF"}

package/dist/util/protocol-types.d.ts

@@ -1,5 +1,5 @@
 import * as t from 'ts-codec';
-import { BucketDescription, BucketPriority, SqliteJsonRow } from '@powersync/service-sync-rules';
+import { BucketPriority, SqliteJsonRow } from '@powersync/service-sync-rules';
 import { JsonContainer } from '@powersync/service-jsonbig';
 export declare const BucketRequest: t.ObjectCodec<{
     name: t.IdentityCodec<t.CodecType.String>;
@@ -9,9 +9,62 @@ export declare const BucketRequest: t.ObjectCodec<{
     after: t.IdentityCodec<t.CodecType.String>;
 }>;
 export type BucketRequest = t.Decoded<typeof BucketRequest>;
+/**
+ * A sync steam that a client has expressed interest in by explicitly opening it on the client side.
+ */
+export declare const RequestedStreamSubscription: t.ObjectCodec<{
+    /**
+     * The defined name of the stream as it appears in sync stream definitions.
+     */
+    stream: t.IdentityCodec<t.CodecType.String>;
+    /**
+     * An optional dictionary of parameters to pass to this specific stream.
+     */
+    parameters: t.OptionalCodec<t.Codec<Record<string, any>, Record<string, any>, string, t.CodecProps>>;
+    /**
+     * Set when the client wishes to re-assign a different priority to this stream.
+     *
+     * Streams and sync rules can also assign a default priority, but clients are allowed to override those. This can be
+     * useful when the priority for partial syncs depends on e.g. the current page opened in a client.
+     */
+    override_priority: t.Union<t.IdentityCodec<t.CodecType.Number>, t.Codec<null, null, t.CodecType.Null, t.CodecProps>>;
+}>;
+export type RequestedStreamSubscription = t.Decoded<typeof RequestedStreamSubscription>;
+/**
+ * An overview of all subscribed streams as part of a streaming sync request.
+ */
+export declare const StreamSubscriptionRequest: t.ObjectCodec<{
+    /**
+     * Whether to sync default streams.
+     *
+     * When disabled, only explicitly-opened subscriptions are included.
+     */
+    include_defaults: t.OptionalCodec<t.Codec<boolean, boolean, string, t.CodecProps>>;
+    /**
+     * An array of sync streams the client has opened explicitly.
+     */
+    subscriptions: t.ArrayCodec<t.ObjectCodec<{
+        /**
+         * The defined name of the stream as it appears in sync stream definitions.
+         */
+        stream: t.IdentityCodec<t.CodecType.String>;
+        /**
+         * An optional dictionary of parameters to pass to this specific stream.
+         */
+        parameters: t.OptionalCodec<t.Codec<Record<string, any>, Record<string, any>, string, t.CodecProps>>;
+        /**
+         * Set when the client wishes to re-assign a different priority to this stream.
+         *
+         * Streams and sync rules can also assign a default priority, but clients are allowed to override those. This can be
+         * useful when the priority for partial syncs depends on e.g. the current page opened in a client.
+         */
+        override_priority: t.Union<t.IdentityCodec<t.CodecType.Number>, t.Codec<null, null, t.CodecType.Null, t.CodecProps>>;
+    }>>;
+}>;
+export type StreamSubscriptionRequest = t.Decoded<typeof StreamSubscriptionRequest>;
 export declare const StreamingSyncRequest: t.ObjectCodec<{
     /**
-     * Existing bucket states.
+     * Existing client-side bucket states.
      */
     buckets: t.OptionalCodec<t.Codec<{
         name: string;
@@ -44,6 +97,24 @@ export declare const StreamingSyncRequest: t.ObjectCodec<{
      * Unique client id.
      */
     client_id: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+    /**
+     * If the client is aware of streams, an array of streams the client has opened.
+     */
+    streams: t.OptionalCodec<t.Codec<{
+        subscriptions: {
+            stream: string;
+            override_priority: number | null;
+            parameters?: Record<string, any> | undefined;
+        }[];
+        include_defaults?: boolean | undefined;
+    }, {
+        subscriptions: {
+            stream: string;
+            override_priority: number | null;
+            parameters?: Record<string, any> | undefined;
+        }[];
+        include_defaults?: boolean | undefined;
+    }, string, t.CodecProps>>;
 }>;
 export type StreamingSyncRequest = t.Decoded<typeof StreamingSyncRequest>;
 export interface StreamingSyncCheckpoint {
@@ -53,7 +124,7 @@ export interface StreamingSyncCheckpointDiff {
     checkpoint_diff: {
         last_op_id: ProtocolOpId;
         write_checkpoint?: ProtocolOpId;
-        updated_buckets: BucketChecksumWithDescription[];
+        updated_buckets: CheckpointBucket[];
         removed_buckets: string[];
     };
 }
@@ -79,10 +150,49 @@ export type StreamingSyncLine = StreamingSyncData | StreamingSyncCheckpoint | St
  * 64-bit unsigned number, as a base-10 string.
  */
 export type ProtocolOpId = string;
+export interface StreamDescription {
+    /**
+     * The name of the stream as it appears in the sync configuration.
+     */
+    name: string;
+    /**
+     * Whether this stream is subscribed to by default.
+     *
+     * For default streams, this field is still `true` if clients have an explicit subscription to the stream.
+     */
+    is_default: boolean;
+    /**
+     * If some subscriptions on this stream could not be resolved, e.g. due to an error, this array contains the faulty
+     * subscriptions along with an error message.
+     */
+    errors: StreamSubscriptionError[];
+}
+export interface StreamSubscriptionError {
+    /**
+     * The subscription that errored - either the default subscription or some of the explicit subscriptions.
+     */
+    subscription: 'default' | number;
+    /**
+     * A message describing the error on the subscription.
+     */
+    message: string;
+}
 export interface Checkpoint {
     last_op_id: ProtocolOpId;
     write_checkpoint?: ProtocolOpId;
-    buckets: BucketChecksumWithDescription[];
+    buckets: CheckpointBucket[];
+    /**
+     * All streams that the client is subscribed to.
+     *
+     * This field has two purposes:
+     *
+     *  1. It allows clients to determine which of their subscriptions actually works. E.g. if a user does
+     *     `db.syncStream('non_existent_stream').subscribe()`, clients don't immediately know that the stream doesn't
+     *     exist. Only after the next `checkpoint` line can they query this field and mark unresolved subscriptions.
+     *. 2. It allows clients to learn which default streams they have been subscribed to. This is relevant for APIs
+     *     listing all streams on the client-side.
+     */
+    streams: StreamDescription[];
 }
 export interface BucketState {
     bucket: string;
@@ -126,5 +236,43 @@ export interface BucketChecksum {
      */
     count: number;
 }
-export interface BucketChecksumWithDescription extends BucketChecksum, BucketDescription {
+/**
+ * The reason a particular bucket is included in a checkpoint.
+ *
+ * This information allows clients to associate individual buckets with sync streams they're subscribed to. Having that
+ * association is useful because it enables clients to track progress for individual sync streams.
+ */
+export type BucketSubscriptionReason = BucketDerivedFromDefaultStream | BucketDerivedFromExplicitSubscription;
+/**
+ * A bucket has been included in a checkpoint because it's part of a default stream.
+ */
+export type BucketDerivedFromDefaultStream = {
+    /**
+     * The index (into {@link Checkpoint.streams}) of the stream defining the bucket.
+     */
+    default: number;
+};
+/**
+ * The bucket has been included in a checkpoint because it's part of a stream that a client has explicitly subscribed
+ * to.
+ */
+export type BucketDerivedFromExplicitSubscription = {
+    /**
+     * The index (into {@link StreamSubscriptionRequest.subscriptions}) of the subscription yielding this bucket.
+     */
+    sub: number;
+};
+export interface ClientBucketDescription {
+    /**
+     * An opaque id of the bucket.
+     */
+    bucket: string;
+    /**
+     * The priority used to synchronize this bucket, derived from its definition and an optional priority override from
+     * the stream subscription.
+     */
+    priority: BucketPriority;
+    subscriptions: BucketSubscriptionReason[];
+}
+export interface CheckpointBucket extends BucketChecksum, ClientBucketDescription {
 }

package/dist/util/protocol-types.js

@@ -6,9 +6,44 @@ export const BucketRequest = t.object({
      */
     after: t.string
 });
+/**
+ * A sync steam that a client has expressed interest in by explicitly opening it on the client side.
+ */
+export const RequestedStreamSubscription = t.object({
+    /**
+     * The defined name of the stream as it appears in sync stream definitions.
+     */
+    stream: t.string,
+    /**
+     * An optional dictionary of parameters to pass to this specific stream.
+     */
+    parameters: t.record(t.any).optional(),
+    /**
+     * Set when the client wishes to re-assign a different priority to this stream.
+     *
+     * Streams and sync rules can also assign a default priority, but clients are allowed to override those. This can be
+     * useful when the priority for partial syncs depends on e.g. the current page opened in a client.
+     */
+    override_priority: t.union(t.number, t.Null)
+});
+/**
+ * An overview of all subscribed streams as part of a streaming sync request.
+ */
+export const StreamSubscriptionRequest = t.object({
+    /**
+     * Whether to sync default streams.
+     *
+     * When disabled, only explicitly-opened subscriptions are included.
+     */
+    include_defaults: t.boolean.optional(),
+    /**
+     * An array of sync streams the client has opened explicitly.
+     */
+    subscriptions: t.array(RequestedStreamSubscription)
+});
 export const StreamingSyncRequest = t.object({
     /**
-     * Existing bucket states.
+     * Existing client-side bucket states.
      */
     buckets: t.array(BucketRequest).optional(),
     /**
@@ -34,6 +69,10 @@ export const StreamingSyncRequest = t.object({
     /**
      * Unique client id.
      */
-    client_id: t.string.optional()
+    client_id: t.string.optional(),
+    /**
+     * If the client is aware of streams, an array of streams the client has opened.
+     */
+    streams: StreamSubscriptionRequest.optional()
 });
 //# sourceMappingURL=protocol-types.js.map

package/dist/util/protocol-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"protocol-types.js","sourceRoot":"","sources":["../../src/util/protocol-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAI9B,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,IAAI,EAAE,CAAC,CAAC,MAAM;IAEd;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,MAAM;CAChB,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE;IAE1C;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;IAElC;;OAEG;IACH,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;IAEtC;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;IAE9B;;OAEG;IACH,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;IAEjC;;OAEG;IACH,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAEtC;;OAEG;IACH,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC"}
+{"version":3,"file":"protocol-types.js","sourceRoot":"","sources":["../../src/util/protocol-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAI9B,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,IAAI,EAAE,CAAC,CAAC,MAAM;IAEd;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,MAAM;CAChB,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC,MAAM;IAChB;;OAEG;IACH,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IACtC;;;;;OAKG;IACH,iBAAiB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC;CAC7C,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;IAEtC;;OAEG;IACH,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC;CACpD,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE;IAE1C;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;IAElC;;OAEG;IACH,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;IAEtC;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;IAE9B;;OAEG;IACH,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;IAEjC;;OAEG;IACH,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAEtC;;OAEG;IACH,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;IAE9B;;OAEG;IACH,OAAO,EAAE,yBAAyB,CAAC,QAAQ,EAAE;CAC9C,CAAC,CAAC"}

package/package.json

@@ -5,7 +5,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.0-dev-20250813080357",
+  "version": "0.0.0-dev-20250819134004",
   "main": "dist/index.js",
   "license": "FSL-1.1-ALv2",
   "type": "module",
@@ -33,11 +33,11 @@
     "uuid": "^11.1.0",
     "winston": "^3.13.0",
     "yaml": "^2.3.2",
-    "@powersync/lib-services-framework": "0.0.0-dev-20250813080357",
-    "@powersync/service-jsonbig": "0.0.0-dev-20250813080357",
-    "@powersync/service-rsocket-router": "0.0.0-dev-20250813080357",
-    "@powersync/service-sync-rules": "0.0.0-dev-20250813080357",
-    "@powersync/service-types": "0.0.0-dev-20250813080357"
+    "@powersync/lib-services-framework": "0.0.0-dev-20250819134004",
+    "@powersync/service-jsonbig": "0.0.0-dev-20250819134004",
+    "@powersync/service-rsocket-router": "0.0.0-dev-20250819134004",
+    "@powersync/service-sync-rules": "0.0.0-dev-20250819134004",
+    "@powersync/service-types": "0.0.0-dev-20250819134004"
   },
   "devDependencies": {
     "@types/async": "^3.2.24",

package/src/api/diagnostics.ts

@@ -134,7 +134,7 @@ export async function getSyncRulesStatus(
     })
   );
 
-  if (live_status && status?.active && sourceConfig.type != 'mysql') {
+  if (live_status && status?.active) {
     // Check replication lag for active sync rules.
     // Right now we exclude mysql, since it we don't have consistent keepalives for it.
     if (sync_rules.last_checkpoint_ts == null && sync_rules.last_keepalive_ts == null) {

package/src/{emitters/EmitterEngine.ts → events/EventsEngine.ts}

@@ -1,11 +1,10 @@
 import EventEmitter from 'node:events';
 import { logger } from '@powersync/lib-services-framework';
 import { event_types } from '@powersync/service-types';
-import { BaseEmitterEngine } from './emitter-interfaces.js';
 
-export class EmitterEngine implements BaseEmitterEngine {
+export class EventsEngine {
   private emitter: EventEmitter;
-  events: Set<event_types.EmitterEngineEvents> = new Set();
+  private events: Set<event_types.EventsEngineEventType> = new Set();
   constructor() {
     this.emitter = new EventEmitter({ captureRejections: true });
     this.emitter.on('error', (error: Error) => {
@@ -13,18 +12,18 @@ export class EmitterEngine implements BaseEmitterEngine {
     });
   }
 
-  subscribe<K extends event_types.EmitterEngineEvents>(event: event_types.EmitterEvent<K>): void {
+  subscribe<K extends event_types.EventsEngineEventType>(event: event_types.EmitterEvent<K>): void {
     if (!this.events.has(event.event)) {
       this.events.add(event.event);
     }
     this.emitter.on(event.event, event.handler.bind(event));
   }
 
-  get listEvents(): event_types.EmitterEngineEvents[] {
+  get listEvents(): event_types.EventsEngineEventType[] {
     return Array.from(this.events.values());
   }
 
-  countListeners(eventName: event_types.EmitterEngineEvents): number {
+  countListeners(eventName: event_types.EventsEngineEventType): number {
     return this.emitter.listenerCount(eventName);
   }
 

package/src/routes/endpoints/socket-route.ts

@@ -1,5 +1,4 @@
 import { ErrorCode, errors, schema } from '@powersync/lib-services-framework';
-import { RequestParameters } from '@powersync/service-sync-rules';
 
 import * as sync from '../../sync/sync-index.js';
 import * as util from '../../util/util-index.js';
@@ -23,12 +22,12 @@ export const syncStreamReactive: SocketRouteGenerator = (router) =>
         user_agent: context.user_agent
       };
 
-      const sdkData: event_types.SdkUserData = {
+      const sdkData: event_types.ConnectedUserData & event_types.ClientConnectionEventData = {
         client_id: params.client_id,
         user_id: context.user_id!,
         user_agent: context.user_agent,
         jwt_exp: context.token_payload?.exp ? new Date(context.token_payload.exp * 1000) : undefined,
-        connect_at: new Date(streamStart)
+        connected_at: new Date(streamStart)
       };
 
       // Best effort guess on why the stream was closed.
@@ -66,8 +65,6 @@ export const syncStreamReactive: SocketRouteGenerator = (router) =>
         return;
       }
 
-      const syncParams = new RequestParameters(context.token_payload!, params.parameters ?? {});
-
       const {
         storageEngine: { activeBucketStorage }
       } = service_context;
@@ -93,7 +90,7 @@ export const syncStreamReactive: SocketRouteGenerator = (router) =>
       });
 
       metricsEngine.getUpDownCounter(APIMetric.CONCURRENT_CONNECTIONS).add(1);
-      service_context.emitterEngine.emit(event_types.EmitterEngineEvents.SDK_CONNECT_EVENT, sdkData);
+      service_context.eventsEngine.emit(event_types.EventsEngineEventType.SDK_CONNECT_EVENT, sdkData);
       const tracker = new sync.RequestTracker(metricsEngine);
       try {
         for await (const data of sync.streamResponse({
@@ -104,7 +101,6 @@ export const syncStreamReactive: SocketRouteGenerator = (router) =>
             ...params,
             binary_data: true // always true for web sockets
           },
-          syncParams,
           token: context!.token_payload!,
           tokenStreamOptions: {
             // RSocket handles keepalive events by default
@@ -168,9 +164,9 @@ export const syncStreamReactive: SocketRouteGenerator = (router) =>
           close_reason: closeReason ?? 'unknown'
         });
         metricsEngine.getUpDownCounter(APIMetric.CONCURRENT_CONNECTIONS).add(-1);
-        service_context.emitterEngine.emit(event_types.EmitterEngineEvents.SDK_DISCONNECT_EVENT, {
+        service_context.eventsEngine.emit(event_types.EventsEngineEventType.SDK_DISCONNECT_EVENT, {
           ...sdkData,
-          disconnect_at: new Date()
+          disconnected_at: new Date()
         });
       }
     }

package/src/routes/endpoints/sync-rules.ts

@@ -202,34 +202,7 @@ async function debugSyncRules(apiHandler: RouteAPI, sync_rules: string) {
 
     return {
       valid: true,
-      bucket_definitions: rules.bucketDescriptors.map((d) => {
-        let all_parameter_queries = [...d.parameterQueries.values()].flat();
-        let all_data_queries = [...d.dataQueries.values()].flat();
-        return {
-          name: d.name,
-          bucket_parameters: d.bucketParameters,
-          global_parameter_queries: d.globalParameterQueries.map((q) => {
-            return {
-              sql: q.sql
-            };
-          }),
-          parameter_queries: all_parameter_queries.map((q) => {
-            return {
-              sql: q.sql,
-              table: q.sourceTable,
-              input_parameters: q.inputParameters
-            };
-          }),
-
-          data_queries: all_data_queries.map((q) => {
-            return {
-              sql: q.sql,
-              table: q.sourceTable,
-              columns: q.columnOutputNames()
-            };
-          })
-        };
-      }),
+      bucket_definitions: rules.bucketSources.map((source) => source.debugRepresentation()),
       source_tables: resolved_tables,
       data_tables: rules.debugGetOutputTables()
     };

package/src/routes/endpoints/sync-stream.ts

@@ -1,5 +1,4 @@
 import { ErrorCode, errors, router, schema } from '@powersync/lib-services-framework';
-import { RequestParameters } from '@powersync/service-sync-rules';
 import { Readable } from 'stream';
 import Negotiator from 'negotiator';
 
@@ -42,12 +41,12 @@ export const syncStreamed = routeDefinition({
       user_id: payload.context.user_id,
       bson: useBson
     };
-    const sdkData: event_types.SdkUserData = {
+    const sdkData: event_types.ConnectedUserData & event_types.ClientConnectionEventData = {
       client_id: clientId,
       user_id: payload.context.user_id!,
       user_agent: userAgent as string,
       jwt_exp: token_payload?.exp ? new Date(token_payload?.exp * 1000) : undefined,
-      connect_at: new Date(streamStart)
+      connected_at: new Date(streamStart)
     };
 
     if (routerEngine.closed) {
@@ -58,9 +57,6 @@ export const syncStreamed = routeDefinition({
       });
     }
 
-    const params: util.StreamingSyncRequest = payload.params;
-    const syncParams = new RequestParameters(payload.context.token_payload!, payload.params.parameters ?? {});
-
     const bucketStorage = await storageEngine.activeBucketStorage.getActiveStorage();
 
     if (bucketStorage == null) {
@@ -77,12 +73,12 @@ export const syncStreamed = routeDefinition({
     const tracker = new sync.RequestTracker(metricsEngine);
     try {
       metricsEngine.getUpDownCounter(APIMetric.CONCURRENT_CONNECTIONS).add(1);
+      service_context.eventsEngine.emit(event_types.EventsEngineEventType.SDK_CONNECT_EVENT, sdkData);
       const syncLines = sync.streamResponse({
         syncContext: syncContext,
         bucketStorage,
         syncRules: syncRules,
-        params,
-        syncParams,
+        params: payload.params,
         token: payload.context.token_payload!,
         tracker,
         signal: controller.signal,
@@ -94,7 +90,6 @@ export const syncStreamed = routeDefinition({
         objectMode: false,
         highWaterMark: 16 * 1024
       });
-      service_context.emitterEngine.emit(event_types.EmitterEngineEvents.SDK_CONNECT_EVENT, sdkData);
 
       // Best effort guess on why the stream was closed.
       // We use the `??=` operator everywhere, so that we catch the first relevant
@@ -138,9 +133,9 @@ export const syncStreamed = routeDefinition({
           }
           controller.abort();
           metricsEngine.getUpDownCounter(APIMetric.CONCURRENT_CONNECTIONS).add(-1);
-          service_context.emitterEngine.emit(event_types.EmitterEngineEvents.SDK_DISCONNECT_EVENT, {
+          service_context.eventsEngine.emit(event_types.EventsEngineEventType.SDK_DISCONNECT_EVENT, {
             ...sdkData,
-            disconnect_at: new Date()
+            disconnected_at: new Date()
           });
           logger.info(`Sync stream complete`, {
             ...tracker.getLogMeta(),
@@ -152,9 +147,9 @@ export const syncStreamed = routeDefinition({
     } catch (ex) {
       controller.abort();
       metricsEngine.getUpDownCounter(APIMetric.CONCURRENT_CONNECTIONS).add(-1);
-      service_context.emitterEngine.emit(event_types.EmitterEngineEvents.SDK_DISCONNECT_EVENT, {
+      service_context.eventsEngine.emit(event_types.EventsEngineEventType.SDK_DISCONNECT_EVENT, {
         ...sdkData,
-        disconnect_at: new Date()
+        disconnected_at: new Date()
       });
     }
   }

package/src/storage/ReportStorage.ts

@@ -0,0 +1,11 @@
+import { event_types } from '@powersync/service-types';
+
+export interface ReportStorage extends AsyncDisposable {
+  reportClientConnection(data: event_types.ClientConnectionBucketData): Promise<void>;
+  reportClientDisconnection(data: event_types.ClientDisconnectionEventData): Promise<void>;
+  getConnectedClients(data: event_types.ClientConnectionsRequest): Promise<event_types.ClientConnectionReport>;
+  getClientConnectionReports(
+    data: event_types.ClientConnectionReportRequest
+  ): Promise<event_types.ClientConnectionReport>;
+  deleteOldConnectionData(data: event_types.DeleteOldConnectionData): Promise<void>;
+}

package/src/storage/StorageEngine.ts

@@ -1,7 +1,7 @@
 import { BaseObserver, logger, ServiceError } from '@powersync/lib-services-framework';
 import { ResolvedPowerSyncConfig } from '../util/util-index.js';
 import { BucketStorageFactory } from './BucketStorageFactory.js';
-import { ActiveStorage, BucketStorageProvider } from './StorageProvider.js';
+import { ActiveStorage, StorageProvider } from './StorageProvider.js';
 
 export type StorageEngineOptions = {
   configuration: ResolvedPowerSyncConfig;
@@ -14,7 +14,7 @@ export interface StorageEngineListener {
 
 export class StorageEngine extends BaseObserver<StorageEngineListener> {
   // TODO: This will need to revisited when we actually support multiple storage providers.
-  private storageProviders: Map<string, BucketStorageProvider> = new Map();
+  private storageProviders: Map<string, StorageProvider> = new Map();
   private currentActiveStorage: ActiveStorage | null = null;
 
   constructor(private options: StorageEngineOptions) {
@@ -37,7 +37,7 @@ export class StorageEngine extends BaseObserver<StorageEngineListener> {
    * Register a provider which generates a {@link BucketStorageFactory}
    * given the matching config specified in the loaded {@link ResolvedPowerSyncConfig}
    */
-  registerProvider(provider: BucketStorageProvider) {
+  registerProvider(provider: StorageProvider) {
     this.storageProviders.set(provider.type, provider);
   }
 

package/src/storage/StorageProvider.ts

@@ -1,12 +1,11 @@
 import { ServiceError } from '@powersync/lib-services-framework';
 import * as util from '../util/util-index.js';
 import { BucketStorageFactory } from './BucketStorageFactory.js';
-import { ReportStorageFactory } from './ReportStorageFactory.js';
+import { ReportStorage } from './ReportStorage.js';
 
 export interface ActiveStorage {
   storage: BucketStorageFactory;
-  // TODO: REMOVE THE NULL ONCE POSTGRES HAS BEEN IMPLEMENTED THIS IS JUST SO I CAN TEST MONGO
-  reportStorage: ReportStorageFactory | null;
+  reportStorage: ReportStorage;
   shutDown(): Promise<void>;
 
   /**
@@ -25,7 +24,7 @@ export interface GetStorageOptions {
 /**
  * Represents a provider that can create a storage instance for a specific storage type from configuration.
  */
-export interface BucketStorageProvider {
+export interface StorageProvider {
   /**
    *  The storage type that this provider provides.
    *  The type should match the `type` field in the config.

package/src/storage/storage-index.ts

@@ -13,4 +13,4 @@ export * from './BucketStorageBatch.js';
 export * from './SyncRulesBucketStorage.js';
 export * from './PersistedSyncRulesContent.js';
 export * from './ReplicationLock.js';
-export * from './ReportStorageFactory.js';
+export * from './ReportStorage.js';