@powersync/service-sync-rules 0.42.0 → 0.44.0

package/schema/sync_config.json

@@ -0,0 +1,620 @@
+{
+	"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",
+			"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": {
+						"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}$"
+					},
+					"additionalProperties": {
+						"type": "object",
+						"properties": {
+							"mongodb_filter_expression": {
+								"anyOf": [
+									{
+										"$ref": "#/definitions/mongodb_filter_expression"
+									},
+									{
+										"const": "disabled"
+									}
+								]
+							}
+						},
+						"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
+}