@powersync/service-schema 0.0.0-dev-20250507132759

package/LICENSE

@@ -0,0 +1,67 @@
+# Functional Source License, Version 1.1, Apache 2.0 Future License
+
+## Abbreviation
+
+FSL-1.1-Apache-2.0
+
+## Notice
+
+Copyright 2023-2024 Journey Mobile, Inc.
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under these Terms and Conditions, as indicated by our inclusion of these Terms and Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents, Redistribution and Trademark clauses below, we hereby grant you the right to use, copy, modify, create derivative works, publicly perform, publicly display and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use means making the Software available to others in a commercial product or service that:
+
+1. substitutes for the Software;
+2. substitutes for any other product or service we offer using the Software that exists as of the date we make the Software available; or
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+2. for non-commercial education;
+3. for non-commercial research; and
+4. in connection with professional services that you provide to a licensee using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our patents, the license grant above includes a license under our patents. If you make a claim against any party that the Software infringes or contributes to the infringement of any patent, then your patent license to the Software ends immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of the Software.
+If you redistribute any copies, modifications or derivatives of the Software, you must include a copy of or a link to these Terms and Conditions and not remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of the Software, you have no right under these Terms and Conditions to use our trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under the Apache License, Version 2.0 that is effective on the second anniversary of the date we make the Software available. On or after that date, you may use the Software under the Apache License, Version 2.0, in which case the following will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

package/README.md

@@ -0,0 +1,9 @@
+# PowerSync Service Schema
+
+This package includes a JSON Schema for the PowerSync service configuration file.
+
+This can be used to provide validations and suggestions for configuration files
+
+```yaml
+# yaml-language-server: $schema=https://unpkg.com/@powersync/service-schema@latest/json-schema/powersync-config.json
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.js

@@ -0,0 +1,3 @@
+export {};
+// This project does not yet include TypeScript source, but it does use TypeScript to depend on the build of @powersync/service-types.
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,sIAAsI"}

package/dist/scripts/compile-json-schema.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/scripts/compile-json-schema.js

@@ -0,0 +1,36 @@
+import { MongoStorageConfig } from '@powersync/service-module-mongodb-storage/types';
+import { MongoConnectionConfig } from '@powersync/service-module-mongodb/types';
+import { MySQLConnectionConfig } from '@powersync/service-module-mysql/types';
+import { PostgresStorageConfig } from '@powersync/service-module-postgres-storage/types';
+import { PostgresConnectionConfig } from '@powersync/service-module-postgres/types';
+import { configFile } from '@powersync/service-types';
+import fs from 'fs';
+import path from 'path';
+import * as t from 'ts-codec';
+import { fileURLToPath } from 'url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const schemaDir = path.join(__dirname, '../../json-schema');
+fs.mkdirSync(schemaDir, { recursive: true });
+// Merge configs for modules
+const baseShape = configFile.powerSyncConfig.props.shape;
+const mergedDataSourceConfig = configFile.genericDataSourceConfig
+    .or(PostgresConnectionConfig)
+    .or(MongoConnectionConfig)
+    .or(MySQLConnectionConfig);
+const mergedStorageConfig = configFile.GenericStorageConfig.or(PostgresStorageConfig).or(MongoStorageConfig);
+const mergedConfig = t.object({
+    ...baseShape,
+    replication: t
+        .object({
+        ...baseShape.replication.props.shape,
+        connections: t.array(mergedDataSourceConfig).optional()
+    })
+        .optional(),
+    storage: mergedStorageConfig.optional()
+});
+const mergedConfigSchema = t.generateJSONSchema(mergedConfig, {
+    allowAdditional: true,
+    parsers: [configFile.portParser]
+});
+fs.writeFileSync(path.join(schemaDir, 'powersync-config.json'), JSON.stringify(mergedConfigSchema, null, '\t'));
+//# sourceMappingURL=compile-json-schema.js.map

package/dist/scripts/compile-json-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compile-json-schema.js","sourceRoot":"","sources":["../../src/scripts/compile-json-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iDAAiD,CAAC;AACrF,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,kDAAkD,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;AAE5D,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AAE7C,4BAA4B;AAC5B,MAAM,SAAS,GAAG,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC;AAEzD,MAAM,sBAAsB,GAAG,UAAU,CAAC,uBAAuB;KAC9D,EAAE,CAAC,wBAAwB,CAAC;KAC5B,EAAE,CAAC,qBAAqB,CAAC;KACzB,EAAE,CAAC,qBAAqB,CAAC,CAAC;AAE7B,MAAM,mBAAmB,GAAG,UAAU,CAAC,oBAAoB,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC;AAE7G,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,GAAG,SAAS;IACZ,WAAW,EAAE,CAAC;SACX,MAAM,CAAC;QACN,GAAG,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK;QACpC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE;KACxD,CAAC;SACD,QAAQ,EAAE;IACb,OAAO,EAAE,mBAAmB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,MAAM,kBAAkB,GAAG,CAAC,CAAC,kBAAkB,CAAC,YAAY,EAAE;IAC5D,eAAe,EAAE,IAAI;IACrB,OAAO,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;CACjC,CAAC,CAAC;AAEH,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAuB,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC"}

package/json-schema/powersync-config.json

@@ -0,0 +1,866 @@
+{
+	"definitions": {},
+	"type": "object",
+	"properties": {
+		"replication": {
+			"type": "object",
+			"properties": {
+				"connections": {
+					"type": "array",
+					"items": {
+						"anyOf": [
+							{
+								"type": "object",
+								"properties": {
+									"type": {
+										"description": "Unique string identifier for the data source type (e.g., \"postgresql\", \"mysql\", etc.).",
+										"type": "string"
+									},
+									"id": {
+										"description": "Unique identifier for the connection. Optional when only a single connection is present.",
+										"type": "string"
+									},
+									"tag": {
+										"description": "Additional meta tag for the connection, used for categorization or grouping.",
+										"type": "string"
+									},
+									"debug_api": {
+										"description": "When enabled, allows query execution.",
+										"type": "boolean"
+									}
+								},
+								"additionalProperties": true,
+								"required": [
+									"type"
+								]
+							},
+							{
+								"type": "object",
+								"properties": {
+									"type": {
+										"type": "string",
+										"const": "postgresql"
+									},
+									"id": {
+										"type": "string"
+									},
+									"tag": {
+										"type": "string"
+									},
+									"debug_api": {
+										"description": "When enabled, allows query execution.",
+										"type": "boolean"
+									},
+									"uri": {
+										"type": "string"
+									},
+									"hostname": {
+										"type": "string"
+									},
+									"port": {
+										"description": "A network port value that can be specified as either a number or a string that will be parsed to a number.",
+										"anyOf": [
+											{
+												"type": "number"
+											},
+											{
+												"type": "string"
+											}
+										]
+									},
+									"username": {
+										"type": "string"
+									},
+									"password": {
+										"type": "string"
+									},
+									"database": {
+										"type": "string"
+									},
+									"sslmode": {
+										"anyOf": [
+											{
+												"type": "string",
+												"const": "verify-full"
+											},
+											{
+												"type": "string",
+												"const": "verify-ca"
+											},
+											{
+												"type": "string",
+												"const": "disable"
+											}
+										]
+									},
+									"cacert": {
+										"type": "string"
+									},
+									"client_certificate": {
+										"type": "string"
+									},
+									"client_private_key": {
+										"type": "string"
+									},
+									"tls_servername": {
+										"type": "string"
+									},
+									"reject_ip_ranges": {
+										"type": "array",
+										"items": {
+											"type": "string"
+										}
+									},
+									"slot_name_prefix": {
+										"type": "string"
+									},
+									"max_pool_size": {
+										"type": "number"
+									}
+								},
+								"additionalProperties": true,
+								"required": [
+									"type"
+								]
+							},
+							{
+								"type": "object",
+								"properties": {
+									"type": {
+										"description": "Unique string identifier for the data source type (e.g., \"postgresql\", \"mysql\", etc.).",
+										"type": "string"
+									},
+									"uri": {
+										"type": "string"
+									},
+									"database": {
+										"type": "string"
+									},
+									"username": {
+										"type": "string"
+									},
+									"password": {
+										"type": "string"
+									},
+									"reject_ip_ranges": {
+										"type": "array",
+										"items": {
+											"type": "string"
+										}
+									},
+									"id": {
+										"description": "Unique identifier for the connection. Optional when only a single connection is present.",
+										"type": "string"
+									},
+									"tag": {
+										"description": "Additional meta tag for the connection, used for categorization or grouping.",
+										"type": "string"
+									},
+									"debug_api": {
+										"description": "When enabled, allows query execution.",
+										"type": "boolean"
+									},
+									"post_images": {
+										"anyOf": [
+											{
+												"type": "string",
+												"const": "off"
+											},
+											{
+												"type": "string",
+												"const": "auto_configure"
+											},
+											{
+												"type": "string",
+												"const": "read_only"
+											}
+										]
+									}
+								},
+								"additionalProperties": true,
+								"required": [
+									"type",
+									"uri"
+								]
+							},
+							{
+								"type": "object",
+								"properties": {
+									"type": {
+										"type": "string",
+										"const": "mysql"
+									},
+									"id": {
+										"description": "Unique identifier for the connection. Optional when only a single connection is present.",
+										"type": "string"
+									},
+									"tag": {
+										"description": "Additional meta tag for the connection, used for categorization or grouping.",
+										"type": "string"
+									},
+									"debug_api": {
+										"description": "When enabled, allows query execution.",
+										"type": "boolean"
+									},
+									"uri": {
+										"type": "string"
+									},
+									"hostname": {
+										"type": "string"
+									},
+									"port": {
+										"description": "A network port value that can be specified as either a number or a string that will be parsed to a number.",
+										"anyOf": [
+											{
+												"type": "number"
+											},
+											{
+												"type": "string"
+											}
+										]
+									},
+									"username": {
+										"type": "string"
+									},
+									"password": {
+										"type": "string"
+									},
+									"database": {
+										"type": "string"
+									},
+									"server_id": {
+										"type": "number"
+									},
+									"cacert": {
+										"type": "string"
+									},
+									"client_certificate": {
+										"type": "string"
+									},
+									"client_private_key": {
+										"type": "string"
+									},
+									"reject_ip_ranges": {
+										"type": "array",
+										"items": {
+											"type": "string"
+										}
+									}
+								},
+								"additionalProperties": true,
+								"required": [
+									"type"
+								]
+							}
+						]
+					}
+				}
+			},
+			"additionalProperties": true,
+			"required": []
+		},
+		"dev": {
+			"description": "Development-specific configuration options.",
+			"type": "object",
+			"properties": {
+				"demo_auth": {
+					"description": "Enables demo authentication for development purposes.",
+					"type": "boolean"
+				},
+				"demo_password": {
+					"description": "Deprecated. Demo password for development authentication.",
+					"type": "string"
+				},
+				"crud_api": {
+					"description": "Deprecated. Enables CRUD API for development.",
+					"type": "boolean"
+				},
+				"demo_client": {
+					"description": "Deprecated. Enables demo client for development.",
+					"type": "boolean"
+				}
+			},
+			"additionalProperties": true,
+			"required": []
+		},
+		"client_auth": {
+			"description": "Configuration for client authentication mechanisms.",
+			"type": "object",
+			"properties": {
+				"jwks_uri": {
+					"description": "URI or array of URIs pointing to JWKS endpoints for client authentication.",
+					"anyOf": [
+						{
+							"type": "string"
+						},
+						{
+							"type": "array",
+							"items": {
+								"type": "string"
+							}
+						}
+					]
+				},
+				"block_local_jwks": {
+					"description": "When true, blocks JWKS URIs that resolve to local network addresses.",
+					"type": "boolean"
+				},
+				"jwks_reject_ip_ranges": {
+					"description": "IP ranges to reject when validating JWKS URIs.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"jwks": {
+					"description": "Inline JWKS configuration for client authentication.",
+					"type": "object",
+					"properties": {
+						"keys": {
+							"description": "An array of JSON Web Keys (JWKs).",
+							"type": "array",
+							"items": {
+								"description": "A JSON Web Key (JWK) representing a cryptographic key. Can be RSA, HMAC, OKP, or EC key types.",
+								"anyOf": [
+									{
+										"description": "JSON Web Key (JWK) representation of an RSA key.",
+										"type": "object",
+										"properties": {
+											"kty": {
+												"description": "Key type identifier, must be \"RSA\" for RSA keys.",
+												"type": "string",
+												"const": "RSA"
+											},
+											"kid": {
+												"description": "Key ID, a unique identifier for the key.",
+												"type": "string"
+											},
+											"n": {
+												"description": "RSA modulus, Base64 URL encoded.",
+												"type": "string"
+											},
+											"e": {
+												"description": "RSA exponent, Base64 URL encoded.",
+												"type": "string"
+											},
+											"alg": {
+												"description": "The algorithm intended for use with this key (RS256, RS384, or RS512).",
+												"anyOf": [
+													{
+														"type": "string",
+														"const": "RS256"
+													},
+													{
+														"type": "string",
+														"const": "RS384"
+													},
+													{
+														"type": "string",
+														"const": "RS512"
+													}
+												]
+											},
+											"use": {
+												"description": "The intended use of the key (e.g., \"sig\" for signature).",
+												"type": "string"
+											}
+										},
+										"additionalProperties": true,
+										"required": [
+											"kty",
+											"kid",
+											"n",
+											"e"
+										]
+									},
+									{
+										"description": "JSON Web Key (JWK) representation of an HMAC key.",
+										"type": "object",
+										"properties": {
+											"kty": {
+												"description": "Key type identifier, must be \"oct\" for HMAC keys.",
+												"type": "string",
+												"const": "oct"
+											},
+											"kid": {
+												"description": "Key ID. Undefined kid indicates it can match any JWT, with or without a kid. Use a kid wherever possible.",
+												"type": "string"
+											},
+											"k": {
+												"description": "The HMAC key value, Base64 URL encoded.",
+												"type": "string"
+											},
+											"alg": {
+												"description": "The algorithm intended for use with this key (HS256, HS384, or HS512).",
+												"anyOf": [
+													{
+														"type": "string",
+														"const": "HS256"
+													},
+													{
+														"type": "string",
+														"const": "HS384"
+													},
+													{
+														"type": "string",
+														"const": "HS512"
+													}
+												]
+											},
+											"use": {
+												"description": "The intended use of the key (e.g., \"sig\" for signature).",
+												"type": "string"
+											}
+										},
+										"additionalProperties": true,
+										"required": [
+											"kty",
+											"k",
+											"alg"
+										]
+									},
+									{
+										"description": "JSON Web Key (JWK) representation of an Octet Key Pair (OKP) key used with Edwards-curve Digital Signature Algorithm.",
+										"type": "object",
+										"properties": {
+											"kty": {
+												"description": "Key type identifier, must be \"OKP\" for Octet Key Pair keys.",
+												"type": "string",
+												"const": "OKP"
+											},
+											"kid": {
+												"description": "Key ID, a unique identifier for the key.",
+												"type": "string"
+											},
+											"crv": {
+												"description": "The cryptographic curve used with this key. Only Ed25519 and Ed448 are supported.",
+												"anyOf": [
+													{
+														"type": "string",
+														"const": "Ed25519"
+													},
+													{
+														"type": "string",
+														"const": "Ed448"
+													}
+												]
+											},
+											"x": {
+												"description": "The public key, Base64 URL encoded.",
+												"type": "string"
+											},
+											"alg": {
+												"description": "The algorithm intended for use with this key (EdDSA).",
+												"type": "string",
+												"const": "EdDSA"
+											},
+											"use": {
+												"description": "The intended use of the key (e.g., \"sig\" for signature).",
+												"type": "string"
+											}
+										},
+										"additionalProperties": true,
+										"required": [
+											"kty",
+											"crv",
+											"x",
+											"alg"
+										]
+									},
+									{
+										"description": "JSON Web Key (JWK) representation of an Elliptic Curve key.",
+										"type": "object",
+										"properties": {
+											"kty": {
+												"description": "Key type identifier, must be \"EC\" for Elliptic Curve keys.",
+												"type": "string",
+												"const": "EC"
+											},
+											"kid": {
+												"description": "Key ID, a unique identifier for the key.",
+												"type": "string"
+											},
+											"crv": {
+												"description": "The cryptographic curve used with this key (P-256, P-384, or P-512).",
+												"anyOf": [
+													{
+														"type": "string",
+														"const": "P-256"
+													},
+													{
+														"type": "string",
+														"const": "P-384"
+													},
+													{
+														"type": "string",
+														"const": "P-512"
+													}
+												]
+											},
+											"x": {
+												"description": "The x coordinate for the Elliptic Curve point, Base64 URL encoded.",
+												"type": "string"
+											},
+											"y": {
+												"description": "The y coordinate for the Elliptic Curve point, Base64 URL encoded.",
+												"type": "string"
+											},
+											"alg": {
+												"description": "The algorithm intended for use with this key (ES256, ES384, or ES512).",
+												"anyOf": [
+													{
+														"type": "string",
+														"const": "ES256"
+													},
+													{
+														"type": "string",
+														"const": "ES384"
+													},
+													{
+														"type": "string",
+														"const": "ES512"
+													}
+												]
+											},
+											"use": {
+												"description": "The intended use of the key (e.g., \"sig\" for signature).",
+												"type": "string"
+											}
+										},
+										"additionalProperties": true,
+										"required": [
+											"kty",
+											"crv",
+											"x",
+											"y",
+											"alg"
+										]
+									}
+								]
+							}
+						}
+					},
+					"additionalProperties": true,
+					"required": [
+						"keys"
+					]
+				},
+				"supabase": {
+					"description": "Enables Supabase authentication integration.",
+					"type": "boolean"
+				},
+				"supabase_jwt_secret": {
+					"description": "JWT secret for Supabase authentication.",
+					"type": "string"
+				},
+				"audience": {
+					"description": "Valid audiences for JWT validation.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				}
+			},
+			"additionalProperties": true,
+			"required": []
+		},
+		"api": {
+			"description": "API service configuration and parameters.",
+			"type": "object",
+			"properties": {
+				"tokens": {
+					"description": "API access tokens for administrative operations.",
+					"type": "array",
+					"items": {
+						"type": "string"
+					}
+				},
+				"parameters": {
+					"description": "Performance and safety parameters for the API service.",
+					"type": "object",
+					"properties": {
+						"max_concurrent_connections": {
+							"description": "Maximum number of connections (http streams or websockets) per API process.\nDefault of 200.",
+							"type": "number"
+						},
+						"max_data_fetch_concurrency": {
+							"description": "This should not be siginificantly more than storage.max_pool_size, otherwise it would block on the\npool. Increasing this can significantly increase memory usage in some cases.\nDefault of 10.",
+							"type": "number"
+						},
+						"max_buckets_per_connection": {
+							"description": "Maximum number of buckets for each connection.\nMore buckets increase latency and memory usage. While the actual number is controlled by sync rules,\nhaving a hard limit ensures that the service errors instead of crashing when a sync rule is misconfigured.\nDefault of 1000.",
+							"type": "number"
+						},
+						"max_parameter_query_results": {
+							"description": "Related to max_buckets_per_connection, but this limit applies directly on the parameter\nquery results, _before_ we convert it into an unique set.\nDefault of 1000.",
+							"type": "number"
+						}
+					},
+					"additionalProperties": true,
+					"required": []
+				}
+			},
+			"additionalProperties": true,
+			"required": []
+		},
+		"storage": {
+			"anyOf": [
+				{
+					"type": "object",
+					"properties": {
+						"type": {
+							"description": "The type of storage backend to use (e.g., \"postgresql\", \"mongodb\").",
+							"type": "string"
+						},
+						"max_pool_size": {
+							"description": "Maximum number of connections to the storage database, per process. Defaults to 8.",
+							"type": "number"
+						}
+					},
+					"additionalProperties": true,
+					"required": [
+						"type"
+					]
+				},
+				{
+					"type": "object",
+					"properties": {
+						"type": {
+							"type": "string",
+							"const": "postgresql"
+						},
+						"max_pool_size": {
+							"type": "number"
+						},
+						"id": {
+							"type": "string"
+						},
+						"tag": {
+							"type": "string"
+						},
+						"uri": {
+							"type": "string"
+						},
+						"hostname": {
+							"type": "string"
+						},
+						"port": {
+							"description": "A network port value that can be specified as either a number or a string that will be parsed to a number.",
+							"anyOf": [
+								{
+									"type": "number"
+								},
+								{
+									"type": "string"
+								}
+							]
+						},
+						"username": {
+							"type": "string"
+						},
+						"password": {
+							"type": "string"
+						},
+						"database": {
+							"type": "string"
+						},
+						"sslmode": {
+							"anyOf": [
+								{
+									"type": "string",
+									"const": "verify-full"
+								},
+								{
+									"type": "string",
+									"const": "verify-ca"
+								},
+								{
+									"type": "string",
+									"const": "disable"
+								}
+							]
+						},
+						"cacert": {
+							"type": "string"
+						},
+						"client_certificate": {
+							"type": "string"
+						},
+						"client_private_key": {
+							"type": "string"
+						},
+						"tls_servername": {
+							"type": "string"
+						},
+						"reject_ip_ranges": {
+							"type": "array",
+							"items": {
+								"type": "string"
+							}
+						},
+						"slot_name_prefix": {
+							"type": "string"
+						},
+						"batch_limits": {
+							"type": "object",
+							"properties": {
+								"max_estimated_size": {
+									"type": "number"
+								},
+								"max_record_count": {
+									"type": "number"
+								},
+								"max_current_data_batch_size": {
+									"type": "number"
+								}
+							},
+							"additionalProperties": true,
+							"required": []
+						}
+					},
+					"additionalProperties": true,
+					"required": [
+						"type"
+					]
+				},
+				{
+					"type": "object",
+					"properties": {
+						"type": {
+							"type": "string",
+							"const": "mongodb"
+						},
+						"uri": {
+							"type": "string"
+						},
+						"database": {
+							"type": "string"
+						},
+						"username": {
+							"type": "string"
+						},
+						"password": {
+							"type": "string"
+						},
+						"reject_ip_ranges": {
+							"type": "array",
+							"items": {
+								"type": "string"
+							}
+						}
+					},
+					"additionalProperties": true,
+					"required": [
+						"type",
+						"uri"
+					]
+				}
+			]
+		},
+		"port": {
+			"description": "The port on which the service will listen for connections. Can be specified as a number or string.",
+			"anyOf": [
+				{
+					"type": "number"
+				},
+				{
+					"type": "string"
+				}
+			]
+		},
+		"sync_rules": {
+			"description": "Configuration for synchronization rules that define data access patterns.",
+			"type": "object",
+			"properties": {
+				"path": {
+					"description": "Path to the sync rules file or directory.",
+					"type": "string"
+				},
+				"content": {
+					"description": "Inline sync rules content as a string.",
+					"type": "string"
+				},
+				"exit_on_error": {
+					"description": "Whether to exit the process if there is an error parsing sync rules.",
+					"type": "boolean"
+				}
+			},
+			"additionalProperties": true,
+			"required": []
+		},
+		"metadata": {
+			"description": "Custom metadata key-value pairs for the service.",
+			"type": "object",
+			"additionalProperties": {
+				"type": "string"
+			},
+			"properties": {},
+			"required": []
+		},
+		"migrations": {
+			"description": "Configuration for database schema migrations.",
+			"type": "object",
+			"properties": {
+				"disable_auto_migration": {
+					"description": "When true, disables automatic storage database schema migrations.",
+					"type": "boolean"
+				}
+			},
+			"additionalProperties": true,
+			"required": []
+		},
+		"telemetry": {
+			"description": "Configuration for service telemetry and monitoring.",
+			"type": "object",
+			"properties": {
+				"prometheus_port": {
+					"description": "Port on which Prometheus metrics will be exposed. When set, metrics will be available on this port for scraping.",
+					"anyOf": [
+						{
+							"type": "number"
+						},
+						{
+							"type": "string"
+						}
+					]
+				},
+				"disable_telemetry_sharing": {
+					"description": "When true, disables sharing of anonymized telemetry data.",
+					"type": "boolean"
+				},
+				"internal_service_endpoint": {
+					"description": "Internal endpoint for telemetry services.",
+					"type": "string"
+				}
+			},
+			"additionalProperties": true,
+			"required": [
+				"disable_telemetry_sharing"
+			]
+		},
+		"parameters": {
+			"description": "Global parameters that can be referenced in sync rules and other configurations.",
+			"type": "object",
+			"additionalProperties": {
+				"anyOf": [
+					{
+						"type": "number"
+					},
+					{
+						"type": "string"
+					},
+					{
+						"type": "boolean"
+					},
+					{
+						"type": "null"
+					}
+				]
+			},
+			"properties": {},
+			"required": []
+		}
+	},
+	"additionalProperties": true,
+	"required": []
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@powersync/service-schema",
+  "version": "0.0.0-dev-20250507132759",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "FSL-1.1-Apache-2.0",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist/**/*",
+    "json-schema/*"
+  ],
+  "repository": "https://github.com/powersync-ja/powersync-service",
+  "dependencies": {},
+  "devDependencies": {
+    "ts-codec": "^1.3.0",
+    "@powersync/service-module-postgres": "0.0.0-dev-20250507132759",
+    "@powersync/service-module-postgres-storage": "0.0.0-dev-20250507132759",
+    "@powersync/service-module-mongodb": "0.0.0-dev-20250507132759",
+    "@powersync/service-module-mongodb-storage": "0.0.0-dev-20250507132759",
+    "@powersync/service-module-mysql": "0.0.0-dev-20250507132759",
+    "@powersync/service-types": "0.0.0-dev-20250507132759"
+  },
+  "scripts": {
+    "clean": "rm -r ./dist && tsc -b --clean",
+    "build:ts": "tsc -b",
+    "build": "pnpm build:ts && node ./dist/scripts/compile-json-schema.js"
+  }
+}