@powersync/service-sync-rules 0.0.0-dev-20260929095716 → 0.0.0-dev-20261005120023

package/schema/sync_config.json

@@ -0,0 +1,253 @@
+{
+	"type": "object",
+	"properties": {
+		"bucket_definitions": {
+			"type": "object",
+			"description": "List of bucket definitions",
+			"examples": [
+				{
+					"global": {
+						"data": "select * from mytable"
+					}
+				}
+			],
+			"patternProperties": {
+				".*": {
+					"type": "object",
+					"required": [
+						"data"
+					],
+					"examples": [
+						{
+							"data": [
+								"select * from mytable"
+							]
+						}
+					],
+					"properties": {
+						"accept_potentially_dangerous_queries": {
+							"description": "If true, disables warnings on potentially dangerous queries",
+							"type": "boolean"
+						},
+						"priority": {
+							"description": "Priority for the bucket (lower values indicate higher priority).",
+							"type": "integer"
+						},
+						"parameters": {
+							"description": "Parameter query(ies)",
+							"anyOf": [
+								{
+									"type": "string",
+									"description": "Parameter query"
+								},
+								{
+									"type": "array",
+									"description": "Parameter queries",
+									"items": {
+										"type": "string"
+									}
+								}
+							]
+						},
+						"data": {
+							"type": "array",
+							"description": "Data queries",
+							"items": {
+								"type": "string"
+							}
+						}
+					},
+					"additionalProperties": false
+				}
+			}
+		},
+		"with": {
+			"type": "object",
+			"description": "Common-table expressions available to all sync streams",
+			"patternProperties": {
+				".*": {
+					"type": "string"
+				}
+			}
+		},
+		"streams": {
+			"type": "object",
+			"description": "List of stream definitions",
+			"examples": [
+				{
+					"user_details": {
+						"query": "select * from users where id = auth.user_id()"
+					}
+				}
+			],
+			"patternProperties": {
+				".*": {
+					"type": "object",
+					"examples": [
+						{
+							"query": [
+								"select * from mytable"
+							]
+						}
+					],
+					"properties": {
+						"accept_potentially_dangerous_queries": {
+							"description": "If true, disables warnings on potentially dangerous queries",
+							"type": "boolean"
+						},
+						"auto_subscribe": {
+							"description": "Whether clients will subscribe to this stream by default.",
+							"type": "boolean"
+						},
+						"priority": {
+							"description": "Priority for the bucket (lower values indicate higher priority).",
+							"type": "integer"
+						},
+						"query": {
+							"description": "The SQL query defining content to sync in this stream.",
+							"type": "string"
+						},
+						"queries": {
+							"description": "SQL queries defining content to sync in this stream.",
+							"type": "array",
+							"items": {
+								"type": "string"
+							}
+						},
+						"with": {
+							"type": "object",
+							"description": "Common table expressions defining subqueries available in queries.",
+							"patternProperties": {
+								".*": {
+									"type": "string"
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"event_definitions": {
+			"type": "object",
+			"description": "Record of sync replication event definitions",
+			"examples": [
+				{
+					"write_checkpoints": {
+						"payloads": [
+							"select user_id, client_id, checkpoint from checkpoints"
+						]
+					}
+				}
+			],
+			"patternProperties": {
+				".*": {
+					"type": [
+						"object"
+					],
+					"required": [
+						"payloads"
+					],
+					"examples": [
+						{
+							"payloads": [
+								"select user_id, client_id, checkpoint from checkpoints"
+							]
+						}
+					],
+					"properties": {
+						"payloads": {
+							"description": "Queries which extract event payload fields from replicated table rows.",
+							"type": "array",
+							"items": {
+								"type": "string"
+							}
+						},
+						"additionalProperties": false,
+						"uniqueItems": true
+					}
+				}
+			}
+		},
+		"config": {
+			"type": "object",
+			"description": "Compatibility, storage, and source-table settings for these definitions.",
+			"properties": {
+				"source_table_options": {
+					"type": "object",
+					"propertyNames": {
+						"minLength": 1,
+						"pattern": "^(?:[^.\"]+|\"(?:[^\"]|\"\")+\")(?:\\.(?:[^.\"]+|\"(?:[^\"]|\"\")+\")){0,2}$",
+						"patternErrorMessage": "Use <table>, <database>.<table>, or <connection>.<database>.<table>. Double-quote names containing dots or quotes."
+					},
+					"additionalProperties": {
+						"type": "object",
+						"properties": {},
+						"additionalProperties": false
+					}
+				},
+				"edition": {
+					"type": "integer",
+					"default": 1,
+					"minimum": 1,
+					"exclusiveMaximum": 4
+				},
+				"storage_version": {
+					"type": "integer",
+					"description": "Storage version used by the storage database.",
+					"enum": [
+						2,
+						3,
+						4
+					]
+				},
+				"timestamp_max_precision": {
+					"type": "string",
+					"enum": [
+						"seconds",
+						"milliseconds",
+						"microseconds",
+						"nanoseconds"
+					]
+				},
+				"timestamps_iso8601": {
+					"type": "boolean",
+					"description": "Enabled by default starting from edition 2: Consistently renders timestamps with an ISO 8601-compatible format (previous versions used a space instead of a T to separate date and time)."
+				},
+				"versioned_bucket_ids": {
+					"type": "boolean",
+					"description": "Enabled by default starting from edition 2: Encode the version of sync rules in generated bucket ids, which avoids clients downloading data twice and improves client-side progress estimates."
+				},
+				"fixed_json_extract": {
+					"type": "boolean",
+					"description": "Enabled by default starting from edition 2: Old versions of the sync service used to treat `->> 'foo.bar'` as a two-element JSON path. With this compatibility option enabled, it follows modern SQLite and treats it as a single key. The `$.` prefix would be required to split on `.`."
+				},
+				"custom_postgres_types": {
+					"type": "boolean",
+					"description": "Enabled by default starting from edition 2: Map custom Postgres types into appropriate structures instead of syncing the raw string."
+				},
+				"unstable_sqlite_expression_engine": {
+					"type": "boolean",
+					"description": "Enabled by default starting from edition null: Experimental option to evaluate functions and operators in Sync Streams with SQLite instead of a JavaScript implementation."
+				},
+				"fixed_booleans_in_json": {
+					"type": "boolean",
+					"description": "Enabled by default starting from edition null: Consistently sync boolean values of a JSON object or array in source data as booleans (instead of integers 0/1)."
+				}
+			},
+			"additionalProperties": false
+		}
+	},
+	"anyOf": [
+		{
+			"required": [
+				"bucket_definitions"
+			]
+		},
+		{
+			"required": [
+				"streams"
+			]
+		}
+	],
+	"additionalProperties": false
+}

package/schema/sync_rules.json

@@ -170,47 +170,19 @@
 		},
 		"config": {
 			"type": "object",
-			"description": "Compatibility, storage, and source connection settings for these definitions.",
+			"description": "Compatibility, storage, and source-table settings for these definitions.",
 			"properties": {
-				"connections": {
+				"source_table_options": {
 					"type": "object",
 					"propertyNames": {
-						"minLength": 1
+						"minLength": 1,
+						"pattern": "^(?:[^.\"]+|\"(?:[^\"]|\"\")+\")(?:\\.(?:[^.\"]+|\"(?:[^\"]|\"\")+\")){0,2}$",
+						"patternErrorMessage": "Use <table>, <database>.<table>, or <connection>.<database>.<table>. Double-quote names containing dots or quotes."
 					},
 					"additionalProperties": {
-						"anyOf": [
-							{
-								"type": "object",
-								"additionalProperties": false,
-								"maxProperties": 0
-							},
-							{
-								"definitions": {},
-								"type": "object",
-								"properties": {
-									"type": {
-										"type": "string",
-										"minLength": 1
-									},
-									"tables": {
-										"type": "object",
-										"propertyNames": {
-											"minLength": 1
-										},
-										"additionalProperties": {
-											"type": "object",
-											"properties": {},
-											"additionalProperties": false,
-											"maxProperties": 0
-										}
-									}
-								},
-								"additionalProperties": false,
-								"required": [
-									"type"
-								]
-							}
-						]
+						"type": "object",
+						"properties": {},
+						"additionalProperties": false
 					}
 				},
 				"edition": {
@@ -221,8 +193,7 @@
 				},
 				"storage_version": {
 					"type": "integer",
-					"description": "Storage version used by the storage database. By default, version 2 is used.",
-					"default": 2,
+					"description": "Storage version used by the storage database.",
 					"enum": [
 						2,
 						3,

package/dist/ConnectionConfig.d.ts

@@ -1,39 +0,0 @@
-import * as t from 'ts-codec';
-import type { JsonObject } from './json.js';
-/**
- * Options for one source table, such as `config.connections.default.tables.orders`. This repo has no table options yet.
- */
-export declare const SOURCE_TABLE_CONFIG: t.ObjectCodec<{}>;
-export type SourceTableConfig = t.Decoded<typeof SOURCE_TABLE_CONFIG>;
-/**
- * Shared connection structure. A source module specializes the table codec to describe its additional options.
- */
-export declare function connectionConfigCodec<T extends t.AnyCodec>(tableConfig: T): t.ObjectCodec<{
-    type: t.IdentityCodec<t.CodecType.String>;
-    tables: t.OptionalCodec<t.Codec<Record<string, t.Ix<T>>, Record<string, t.Ox<T>>, string, t.CodecProps>>;
-}>;
-export declare const CONNECTION_CONFIG: t.ObjectCodec<{
-    type: t.IdentityCodec<t.CodecType.String>;
-    tables: t.OptionalCodec<t.Codec<Record<string, {}>, Record<string, {}>, string, t.CodecProps>>;
-}>;
-export type ConnectionConfig<TTableConfig extends SourceTableConfig = SourceTableConfig> = {
-    readonly type: string;
-    readonly tables?: Readonly<Partial<Record<string, TTableConfig>>>;
-};
-/**
- * Connection tags are map keys; table names and patterns remain relative to their connection's default schema.
- */
-export type ConnectionConfigMap = Readonly<Partial<Record<string, ConnectionConfig>>>;
-/**
- * Generate the common shape while making the empty base table option explicit, regardless of generator defaults.
- */
-export declare function createConnectionConfigSchema(): JsonObject;
-/**
- * Validate and copy portable connection options, preserving module-owned fields.
- * Sort connection tags only: table declaration order can determine wildcard precedence, and literal object order matters.
- */
-export declare function normalizeConnectionConfig(value: unknown): ConnectionConfigMap;
-/**
- * Conservative equality: an expression rewrite may require a new snapshot even if MongoDB evaluates it identically.
- */
-export declare function connectionConfigsEqual(left: ConnectionConfigMap, right: ConnectionConfigMap): boolean;

package/dist/ConnectionConfig.js

@@ -1,97 +0,0 @@
-import * as t from 'ts-codec';
-/**
- * Options for one source table, such as `config.connections.default.tables.orders`. This repo has no table options yet.
- */
-export const SOURCE_TABLE_CONFIG = t.object({});
-/**
- * Shared connection structure. A source module specializes the table codec to describe its additional options.
- */
-export function connectionConfigCodec(tableConfig) {
-    return t.object({ type: t.string, tables: t.record(tableConfig).optional() });
-}
-export const CONNECTION_CONFIG = connectionConfigCodec(SOURCE_TABLE_CONFIG);
-/**
- * Generate the common shape while making the empty base table option explicit, regardless of generator defaults.
- */
-export function createConnectionConfigSchema() {
-    const connection = t.generateJSONSchema(CONNECTION_CONFIG, { allowAdditional: false });
-    const properties = connection.properties;
-    properties.type = { type: 'string', minLength: 1 };
-    properties.tables = {
-        type: 'object',
-        propertyNames: { minLength: 1 },
-        additionalProperties: {
-            type: 'object',
-            properties: {},
-            additionalProperties: false,
-            maxProperties: 0
-        }
-    };
-    // The empty connection spelling means no options. Nonempty connections require their discriminator.
-    return {
-        type: 'object',
-        propertyNames: { minLength: 1 },
-        additionalProperties: {
-            anyOf: [{ type: 'object', additionalProperties: false, maxProperties: 0 }, connection]
-        }
-    };
-}
-/**
- * Validate and copy portable connection options, preserving module-owned fields.
- * Sort connection tags only: table declaration order can determine wildcard precedence, and literal object order matters.
- */
-export function normalizeConnectionConfig(value) {
-    if (value === undefined)
-        return {};
-    assertJsonObject(value);
-    const entries = Object.entries(value).sort(([left], [right]) => (left < right ? -1 : left > right ? 1 : 0));
-    return Object.fromEntries(entries.flatMap(([tag, config]) => {
-        assertJsonObject(config);
-        if (!tag)
-            throw new Error('A connection tag must not be empty.');
-        if (Object.keys(config).length == 0)
-            return [];
-        if (typeof config.type != 'string' || !config.type)
-            throw new Error('A connection type must not be empty.');
-        if (config.tables !== undefined) {
-            assertJsonObject(config.tables);
-            for (const [table, options] of Object.entries(config.tables)) {
-                if (!table)
-                    throw new Error('A source table name must not be empty.');
-                assertJsonObject(options);
-            }
-        }
-        return [[tag, structuredClone(config)]];
-    }));
-}
-/**
- * Conservative equality: an expression rewrite may require a new snapshot even if MongoDB evaluates it identically.
- */
-export function connectionConfigsEqual(left, right) {
-    return JSON.stringify(normalizeConnectionConfig(left)) == JSON.stringify(normalizeConnectionConfig(right));
-}
-function assertJsonObject(value) {
-    if (value == null || typeof value != 'object' || Array.isArray(value)) {
-        throw new Error('Connection and table configuration must be JSON objects.');
-    }
-    assertJsonValue(value, new Set());
-}
-function assertJsonValue(value, parents) {
-    if (value === null || typeof value == 'string' || typeof value == 'boolean')
-        return;
-    if (typeof value == 'number' && Number.isFinite(value))
-        return;
-    if (typeof value != 'object' || parents.has(value)) {
-        throw new Error('Connection configuration must contain finite, acyclic JSON values.');
-    }
-    if (!Array.isArray(value) &&
-        Object.getPrototypeOf(value) !== Object.prototype &&
-        Object.getPrototypeOf(value) !== null) {
-        throw new Error('Connection configuration must contain plain JSON objects.');
-    }
-    parents.add(value);
-    for (const child of Object.values(value))
-        assertJsonValue(child, parents);
-    parents.delete(value);
-}
-//# sourceMappingURL=ConnectionConfig.js.map

package/dist/ConnectionConfig.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ConnectionConfig.js","sourceRoot":"","sources":["../src/ConnectionConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAG9B;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAGhD;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAuB,WAAc;IACxE,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAChF,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;AAW5E;;GAEG;AACH,MAAM,UAAU,4BAA4B;IAC1C,MAAM,UAAU,GAAG,CAAC,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,CAAe,CAAC;IACrG,MAAM,UAAU,GAAG,UAAU,CAAC,UAAwB,CAAC;IACvD,UAAU,CAAC,IAAI,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;IACnD,UAAU,CAAC,MAAM,GAAG;QAClB,IAAI,EAAE,QAAQ;QACd,aAAa,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE;QAC/B,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE;YACd,oBAAoB,EAAE,KAAK;YAC3B,aAAa,EAAE,CAAC;SACjB;KACF,CAAC;IACF,oGAAoG;IACpG,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,aAAa,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE;QAC/B,oBAAoB,EAAE;YACpB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,EAAE,EAAE,UAAU,CAAC;SACvF;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAc;IACtD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACnC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACxB,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5G,OAAO,MAAM,CAAC,WAAW,CACvB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE;QAChC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACzB,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACjE,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,IAAI,CAAC;YAAE,OAAO,EAAE,CAAC;QAC/C,IAAI,OAAO,MAAM,CAAC,IAAI,IAAI,QAAQ,IAAI,CAAC,MAAM,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC5G,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAChC,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC7D,IAAI,CAAC,KAAK;oBAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;gBACtE,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QACD,OAAO,CAAC,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAqB,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAyB,EAAE,KAA0B;IAC1F,OAAO,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7G,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,IAAI,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,IAAI,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACtE,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAC9E,CAAC;IACD,eAAe,CAAC,KAAK,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,eAAe,CAAC,KAAc,EAAE,OAAoB;IAC3D,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,QAAQ,IAAI,OAAO,KAAK,IAAI,SAAS;QAAE,OAAO;IACpF,IAAI,OAAO,KAAK,IAAI,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO;IAC/D,IAAI,OAAO,KAAK,IAAI,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,KAAM,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;IACxF,CAAC;IACD,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACrB,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,SAAS;QACjD,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,IAAI,EACrC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC/E,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,KAAM,CAAC,CAAC;IACpB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,KAAM,CAAC;QAAE,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC3E,OAAO,CAAC,MAAM,CAAC,KAAM,CAAC,CAAC;AACzB,CAAC"}