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

package/schema/sync_rules.json

@@ -1,9 +1,366 @@
 {
 	"type": "object",
+	"definitions": {
+		"mongodb_filter_expression": {
+			"allOf": [
+				{
+					"$ref": "#/definitions/__schema0"
+				}
+			]
+		},
+		"__schema0": {
+			"anyOf": [
+				{
+					"type": "object",
+					"properties": {
+						"$eq": {
+							"type": "array",
+							"items": [
+								{
+									"$ref": "#/definitions/__schema1"
+								},
+								{
+									"$ref": "#/definitions/__schema2"
+								}
+							],
+							"additionalItems": false,
+							"minItems": 2,
+							"maxItems": 2,
+							"description": "Compare a source field with a scalar constant.",
+							"examples": [
+								[
+									"$$doc.status",
+									"active"
+								]
+							]
+						}
+					},
+					"required": [
+						"$eq"
+					],
+					"additionalProperties": false
+				},
+				{
+					"type": "object",
+					"properties": {
+						"$in": {
+							"type": "array",
+							"items": [
+								{
+									"$ref": "#/definitions/__schema1"
+								},
+								{
+									"$ref": "#/definitions/__schema6"
+								}
+							],
+							"additionalItems": false,
+							"minItems": 2,
+							"maxItems": 2,
+							"examples": [
+								[
+									"$$doc.status",
+									[
+										"pending",
+										"shipped"
+									]
+								]
+							]
+						}
+					},
+					"required": [
+						"$in"
+					],
+					"additionalProperties": false
+				},
+				{
+					"type": "object",
+					"properties": {
+						"$and": {
+							"minItems": 1,
+							"type": "array",
+							"items": {
+								"$ref": "#/definitions/mongodb_filter_expression"
+							},
+							"examples": [
+								[
+									{
+										"$eq": [
+											"$$doc.active",
+											true
+										]
+									}
+								]
+							]
+						}
+					},
+					"required": [
+						"$and"
+					],
+					"additionalProperties": false
+				},
+				{
+					"type": "object",
+					"properties": {
+						"$or": {
+							"minItems": 1,
+							"type": "array",
+							"items": {
+								"$ref": "#/definitions/mongodb_filter_expression"
+							},
+							"examples": [
+								[
+									{
+										"$eq": [
+											"$$doc.status",
+											"pending"
+										]
+									},
+									{
+										"$eq": [
+											"$$doc.priority",
+											true
+										]
+									}
+								]
+							]
+						}
+					},
+					"required": [
+						"$or"
+					],
+					"additionalProperties": false
+				}
+			]
+		},
+		"__schema1": {
+			"type": "string",
+			"pattern": "^\\$\\$doc(?:\\.(?![0-9]+(?:\\.|$))[^.$][^.]*)+$"
+		},
+		"__schema2": {
+			"anyOf": [
+				{
+					"type": "boolean"
+				},
+				{
+					"type": "number"
+				},
+				{
+					"type": "string",
+					"pattern": "^(?!\\$)"
+				},
+				{
+					"anyOf": [
+						{
+							"type": "object",
+							"properties": {
+								"$literal": {
+									"type": "string"
+								}
+							},
+							"required": [
+								"$literal"
+							],
+							"additionalProperties": false
+						},
+						{
+							"type": "object",
+							"properties": {
+								"$oid": {
+									"type": "string",
+									"pattern": "^[0-9a-fA-F]{24}$"
+								}
+							},
+							"required": [
+								"$oid"
+							],
+							"additionalProperties": false
+						},
+						{
+							"type": "object",
+							"properties": {
+								"$numberInt": {
+									"allOf": [
+										{
+											"$ref": "#/definitions/__schema3"
+										}
+									]
+								}
+							},
+							"required": [
+								"$numberInt"
+							],
+							"additionalProperties": false
+						},
+						{
+							"type": "object",
+							"properties": {
+								"$numberLong": {
+									"allOf": [
+										{
+											"$ref": "#/definitions/__schema3"
+										}
+									]
+								}
+							},
+							"required": [
+								"$numberLong"
+							],
+							"additionalProperties": false
+						},
+						{
+							"type": "object",
+							"properties": {
+								"$numberDouble": {
+									"type": "string",
+									"pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$"
+								}
+							},
+							"required": [
+								"$numberDouble"
+							],
+							"additionalProperties": false
+						},
+						{
+							"type": "object",
+							"properties": {
+								"$numberDecimal": {
+									"type": "string"
+								}
+							},
+							"required": [
+								"$numberDecimal"
+							],
+							"additionalProperties": false
+						},
+						{
+							"type": "object",
+							"properties": {
+								"$uuid": {
+									"type": "string",
+									"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+								}
+							},
+							"required": [
+								"$uuid"
+							],
+							"additionalProperties": false
+						},
+						{
+							"type": "object",
+							"properties": {
+								"$date": {
+									"anyOf": [
+										{
+											"type": "string",
+											"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$"
+										},
+										{
+											"type": "object",
+											"properties": {
+												"$numberLong": {
+													"allOf": [
+														{
+															"$ref": "#/definitions/__schema3"
+														}
+													]
+												}
+											},
+											"required": [
+												"$numberLong"
+											],
+											"additionalProperties": false
+										}
+									]
+								}
+							},
+							"required": [
+								"$date"
+							],
+							"additionalProperties": false
+						},
+						{
+							"type": "object",
+							"properties": {
+								"$timestamp": {
+									"type": "object",
+									"properties": {
+										"t": {
+											"type": "integer",
+											"minimum": 0,
+											"maximum": 4294967295
+										},
+										"i": {
+											"type": "integer",
+											"minimum": 0,
+											"maximum": 4294967295
+										}
+									},
+									"required": [
+										"t",
+										"i"
+									],
+									"additionalProperties": false
+								}
+							},
+							"required": [
+								"$timestamp"
+							],
+							"additionalProperties": false
+						},
+						{
+							"type": "object",
+							"properties": {
+								"$binary": {
+									"type": "object",
+									"properties": {
+										"base64": {
+											"$ref": "#/definitions/__schema4"
+										},
+										"subType": {
+											"$ref": "#/definitions/__schema5"
+										}
+									},
+									"required": [
+										"base64",
+										"subType"
+									],
+									"additionalProperties": false
+								}
+							},
+							"required": [
+								"$binary"
+							],
+							"additionalProperties": false
+						}
+					]
+				}
+			]
+		},
+		"__schema3": {
+			"type": "string",
+			"pattern": "^-?(?:0|[1-9][0-9]*)$"
+		},
+		"__schema4": {
+			"type": "string",
+			"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/][AQgw]==|[A-Za-z0-9+/]{2}[AEIMQUYcgkosw048]=)?$"
+		},
+		"__schema5": {
+			"type": "string",
+			"pattern": "^[0-9a-fA-F]{2}$"
+		},
+		"__schema6": {
+			"minItems": 1,
+			"type": "array",
+			"items": {
+				"$ref": "#/definitions/__schema2"
+			}
+		}
+	},
 	"properties": {
 		"bucket_definitions": {
 			"type": "object",
-			"description": "List of bucket definitions",
+			"deprecated": true,
+			"description": "Deprecated: legacy Sync Rules bucket definitions. They will be removed in the next major version of the PowerSync Service. Use `streams:` (Sync Streams) instead: https://docs.powersync.com/sync/rules/migrate-to-sync-streams",
 			"examples": [
 				{
 					"global": {
@@ -176,12 +533,22 @@
 					"type": "object",
 					"propertyNames": {
 						"minLength": 1,
-						"pattern": "^(?:[^.\"]+|\"(?:[^\"]|\"\")+\")(?:\\.(?:[^.\"]+|\"(?:[^\"]|\"\")+\")){0,2}$",
-						"patternErrorMessage": "Use <table>, <database>.<table>, or <connection>.<database>.<table>. Double-quote names containing dots or quotes."
+						"pattern": "^(?:[^.\"]+|\"(?:[^\"]|\"\")+\")(?:\\.(?:[^.\"]+|\"(?:[^\"]|\"\")+\")){0,2}$"
 					},
 					"additionalProperties": {
 						"type": "object",
-						"properties": {},
+						"properties": {
+							"mongodb_filter_expression": {
+								"anyOf": [
+									{
+										"$ref": "#/definitions/mongodb_filter_expression"
+									},
+									{
+										"const": "disabled"
+									}
+								]
+							}
+						},
 						"additionalProperties": false
 					}
 				},

package/dist/SyncConfigParserHooks.d.ts

@@ -1,103 +0,0 @@
-import type { JsonObject } from './json.js';
-import type { SyncConfig } from './SyncConfig.js';
-import type { TablePattern } from './TablePattern.js';
-/**
- * A decoded config path, for example `['config', 'source_table_options', 'orders', 'option']`.
- */
-export type SyncConfigSourcePath = readonly (string | number)[];
-export type SyncConfigSourceLocationTarget = 'key' | 'value';
-/**
- * Offsets into the authored config, compatible with locations returned by service diagnostics.
- */
-export interface SyncConfigSourceSpan {
-    start_offset: number;
-    end_offset: number;
-}
-/**
- * A parser warning or failure, optionally pointing to the relevant config key or value.
- */
-export interface SyncConfigDiagnostic {
-    level: 'warning' | 'fatal';
-    message: string;
-    location?: SyncConfigSourceSpan;
-}
-export interface SyncConfigSourceLocationResolver {
-    /**
-     * Resolve a field to its source span, falling back to its nearest existing ancestor.
-     */
-    getLocation(path: SyncConfigSourcePath, target?: SyncConfigSourceLocationTarget): SyncConfigSourceSpan | undefined;
-}
-/**
- * Context for parsing input sync config.
- */
-export interface SyncConfigParserContext {
-    readonly defaultSchema: string;
-    /**
-     * Candidate being assembled. With throwOnError: false, a partial config may be returned with fatal diagnostics.
-     * Store options on the appropriate config fields.
-     */
-    parsedConfig: SyncConfig;
-    /**
-     * Sources selected by SQL. Additional parsers may inspect these, but cannot add replication sources.
-     */
-    sourceTables: readonly TablePattern[];
-    /**
-     * Utility helpers for determining source locations.
-     */
-    sourceLocations: SyncConfigSourceLocationResolver;
-    /**
-     * Report a diagnostic found while parsing.
-     */
-    reportDiagnostic(diagnostic: SyncConfigDiagnostic): void;
-}
-/**
- * Context for validating persisted sync config.
- */
-export interface PersistedSyncConfigParserContext {
-    /**
-     * Default schema used to resolve unqualified table names during validation.
-     * Some callers supply a placeholder; do not persist names qualified using this value.
-     */
-    readonly defaultSchema: string;
-    /**
-     * Report a warning or fatal error found while validating the persisted config.
-     * Include a config source location when available. Fatal errors prevent the config from loading.
-     */
-    reportDiagnostic(diagnostic: SyncConfigDiagnostic): void;
-}
-/**
- * Additional deterministic parsing/validation, registered per service rather than globally or by source type.
- * A hook identifies its own fields and leaves unrelated input alone. Source I/O belongs in source validation.
- */
-export interface AdditionalSyncConfigParser {
-    /**
-     * A unique ID for the parser. Persisted sync configs store these IDs to validate
-     * if modules which created the persisted config are present.
-     */
-    readonly id: string;
-    /**
-     * Mutates an isolated schema before parsing.
-     */
-    extendJsonSchema?(options: {
-        schema: JsonObject;
-    }): void;
-    /**
-     * `config` is decoded sync config. Everything else needed to parse it is supplied through `context`.
-     * Parse module-owned input into context.parsedConfig, including sourceTableConfig entries for this module.
-     * Core does not copy source-table options from the input or normalize the parser's output here.
-     * For a PrecompiledSyncConfig, add this parser's ID to parsedConfig.plan.moduleData with a null value
-     * when the config requires this module. The plan's keys determine which parsers must be present on reload.
-     */
-    parse(options: {
-        config: unknown;
-        context: SyncConfigParserContext;
-    }): void;
-    /**
-     * Validate saved config fields without reparsing their original config or requiring config source locations.
-     */
-    validatePersisted?(options: {
-        config: SyncConfig;
-        context: PersistedSyncConfigParserContext;
-    }): void;
-}
-export declare function validateAdditionalSyncConfigParsers(parsers: readonly AdditionalSyncConfigParser[]): void;

package/dist/SyncConfigParserHooks.js

@@ -1,11 +0,0 @@
-export function validateAdditionalSyncConfigParsers(parsers) {
-    const ids = new Set();
-    for (const parser of parsers) {
-        if (!parser.id)
-            throw new Error('A sync config parser id must not be empty.');
-        if (ids.has(parser.id))
-            throw new Error(`A sync config parser is already registered with id '${parser.id}'.`);
-        ids.add(parser.id);
-    }
-}
-//# sourceMappingURL=SyncConfigParserHooks.js.map

package/dist/SyncConfigParserHooks.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"SyncConfigParserHooks.js","sourceRoot":"","sources":["../src/SyncConfigParserHooks.ts"],"names":[],"mappings":"AAyGA,MAAM,UAAU,mCAAmC,CAAC,OAA8C;IAChG,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAC9E,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,uDAAuD,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;QAC9G,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACrB,CAAC;AACH,CAAC"}