@powersync/service-sync-rules 0.42.0 → 0.44.0

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": {
@@ -170,8 +527,31 @@
 		},
 		"config": {
 			"type": "object",
-			"description": "Config declaring the compatibility level used to parse these definitions.",
+			"description": "Compatibility, storage, and source-table settings for these definitions.",
 			"properties": {
+				"source_table_options": {
+					"type": "object",
+					"propertyNames": {
+						"minLength": 1,
+						"pattern": "^(?:[^.\"]+|\"(?:[^\"]|\"\")+\")(?:\\.(?:[^.\"]+|\"(?:[^\"]|\"\")+\")){0,2}$"
+					},
+					"additionalProperties": {
+						"type": "object",
+						"properties": {
+							"mongodb_filter_expression": {
+								"anyOf": [
+									{
+										"$ref": "#/definitions/mongodb_filter_expression"
+									},
+									{
+										"const": "disabled"
+									}
+								]
+							}
+						},
+						"additionalProperties": false
+					}
+				},
 				"edition": {
 					"type": "integer",
 					"default": 1,
@@ -180,8 +560,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,
@@ -216,6 +595,10 @@
 				"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