@powersync/service-sync-rules 0.41.0 → 0.42.0

package/dist/schema-generators/RustSchemaGenerator.d.ts

@@ -0,0 +1,22 @@
+import { SyncConfig } from '../SyncConfig.js';
+import { SourceSchema } from '../types.js';
+import { GenerateSchemaOptions, SchemaGenerator } from './SchemaGenerator.js';
+/**
+ * Generates the client-side schema for the PowerSync Rust SDK, in the shape its reference docs use:
+ * an `app_schema()` function that pushes one `Table::create(...)` per synced table.
+ *
+ * When the sync configuration has optional streams, a `TypedSyncStreams` helper is generated with
+ * one method per stream.
+ */
+export declare class RustSchemaGenerator extends SchemaGenerator {
+    readonly key = "rust";
+    readonly label = "Rust";
+    readonly mediaType = "text/rust";
+    readonly fileName = "schema.rs";
+    generate(source: SyncConfig, schema: SourceSchema, options?: GenerateSchemaOptions): string;
+    private generateTable;
+    private generateColumn;
+    private generateStreamHelper;
+    private generateStreamMethod;
+    private rustType;
+}

package/dist/schema-generators/RustSchemaGenerator.js

@@ -0,0 +1,120 @@
+import { TYPE_INTEGER, TYPE_REAL, TYPE_TEXT } from '../ExpressionType.js';
+import { SchemaGenerator, toCamelCase } from './SchemaGenerator.js';
+/**
+ * Generates the client-side schema for the PowerSync Rust SDK, in the shape its reference docs use:
+ * an `app_schema()` function that pushes one `Table::create(...)` per synced table.
+ *
+ * When the sync configuration has optional streams, a `TypedSyncStreams` helper is generated with
+ * one method per stream.
+ */
+export class RustSchemaGenerator extends SchemaGenerator {
+    key = 'rust';
+    label = 'Rust';
+    mediaType = 'text/rust';
+    fileName = 'schema.rs';
+    generate(source, schema, options) {
+        const tables = super.getAllTables(source, schema);
+        const streams = this.getOptionalStreams(source, schema);
+        const pushes = tables.map((table) => this.generateTable(table.name, table.columns, options)).join('\n\n');
+        // Import order matches what rustfmt produces.
+        let imports = 'use powersync::schema::{Column, Schema, Table};';
+        if (streams.length) {
+            imports += '\nuse powersync::{PowerSyncDatabase, SyncStream};';
+            if (streams.some((stream) => Object.keys(stream.parameters).length > 0)) {
+                imports += '\nuse serde_json::json;';
+            }
+        }
+        const streamHelper = streams.length ? `\n${this.generateStreamHelper(streams)}` : '';
+        return `${imports}
+
+pub fn app_schema() -> Schema {
+    let mut schema = Schema::default();
+
+${pushes}
+
+    schema
+}
+${streamHelper}`;
+    }
+    generateTable(name, columns, options) {
+        const lines = columns.map((column) => {
+            const line = `            ${this.generateColumn(column)},`;
+            if (options?.includeTypeComments && column.originalType != null) {
+                return `${line} // ${column.originalType}`;
+            }
+            return line;
+        });
+        const columnsVec = lines.length > 0 ? `vec![\n${lines.join('\n')}\n        ]` : 'vec![]';
+        return `    schema.tables.push(Table::create(
+        ${rustString(name)},
+        ${columnsVec},
+        |_| {},
+    ));`;
+    }
+    generateColumn(column) {
+        return `Column::${this.columnType(column)}(${rustString(column.name)})`;
+    }
+    generateStreamHelper(streams) {
+        const methods = streams.map((stream) => this.generateStreamMethod(stream)).join('\n\n');
+        // The field must be pub so that the helper can be constructed from outside the generated module.
+        return `pub struct TypedSyncStreams<'a>(pub &'a PowerSyncDatabase);
+
+impl<'a> TypedSyncStreams<'a> {
+${methods}
+}
+`;
+    }
+    generateStreamMethod(stream) {
+        const entries = Object.entries(stream.parameters);
+        const name = rustString(stream.name);
+        if (entries.length == 0) {
+            return `    pub fn ${toSnakeCase(stream.name)}(&self) -> SyncStream<'a> {
+        self.0.sync_stream(${name}, None)
+    }`;
+        }
+        const args = entries.map(([parameter, type]) => `${toSnakeCase(parameter)}: ${this.rustType(type)}`).join(', ');
+        const jsonEntries = entries.map(([parameter]) => `${rustString(parameter)}: ${toSnakeCase(parameter)}`).join(', ');
+        return `    pub fn ${toSnakeCase(stream.name)}(&self, ${args}) -> SyncStream<'a> {
+        let encoded_params = json!({${jsonEntries}});
+
+        self.0.sync_stream(${name}, Some(&encoded_params))
+    }`;
+    }
+    rustType({ type }) {
+        if (type.typeFlags & TYPE_TEXT) {
+            // The SDK clones parameters internally, so &str is more convenient for callers than String.
+            return '&str';
+        }
+        else if (type.typeFlags & TYPE_REAL) {
+            return 'f64';
+        }
+        else if (type.typeFlags & TYPE_INTEGER) {
+            return 'i64';
+        }
+        else {
+            return '&str';
+        }
+    }
+}
+const RUST_STRING_ESCAPES = {
+    '\\': '\\\\',
+    '"': '\\"',
+    '\n': '\\n',
+    '\r': '\\r',
+    '\t': '\\t'
+};
+/**
+ * Wraps a name in a Rust string literal, escaping characters that would break or distort it.
+ */
+function rustString(value) {
+    return `"${value.replace(/[\\"\n\r\t]/g, (c) => RUST_STRING_ESCAPES[c])}"`;
+}
+/**
+ * Converts a name to a snake_case Rust identifier, e.g. `myStream` and `my-stream` become `my_stream`.
+ */
+function toSnakeCase(source) {
+    return toCamelCase(source)
+        .replace(/([a-z0-9])([A-Z])/g, '$1_$2')
+        .toLowerCase();
+}
+//# sourceMappingURL=RustSchemaGenerator.js.map

package/dist/schema-generators/RustSchemaGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RustSchemaGenerator.js","sourceRoot":"","sources":["../../src/schema-generators/RustSchemaGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGxG,OAAO,EAAyC,eAAe,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAE3G;;;;;;GAMG;AACH,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IAC7C,GAAG,GAAG,MAAM,CAAC;IACb,KAAK,GAAG,MAAM,CAAC;IACf,SAAS,GAAG,WAAW,CAAC;IACxB,QAAQ,GAAG,WAAW,CAAC;IAEhC,QAAQ,CAAC,MAAkB,EAAE,MAAoB,EAAE,OAA+B;QAChF,MAAM,MAAM,GAAG,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE1G,8CAA8C;QAC9C,IAAI,OAAO,GAAG,iDAAiD,CAAC;QAChE,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,OAAO,IAAI,mDAAmD,CAAC;YAC/D,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;gBACxE,OAAO,IAAI,yBAAyB,CAAC;YACvC,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAErF,OAAO,GAAG,OAAO;;;;;EAKnB,MAAM;;;;EAIN,YAAY,EAAE,CAAC;IACf,CAAC;IAEO,aAAa,CAAC,IAAY,EAAE,OAA2B,EAAE,OAA+B;QAC9F,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACnC,MAAM,IAAI,GAAG,eAAe,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC;YAC3D,IAAI,OAAO,EAAE,mBAAmB,IAAI,MAAM,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;gBAChE,OAAO,GAAG,IAAI,OAAO,MAAM,CAAC,YAAY,EAAE,CAAC;YAC7C,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC;QAEzF,OAAO;UACD,UAAU,CAAC,IAAI,CAAC;UAChB,UAAU;;QAEZ,CAAC;IACP,CAAC;IAEO,cAAc,CAAC,MAAwB;QAC7C,OAAO,WAAW,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;IAC1E,CAAC;IAEO,oBAAoB,CAAC,OAAyB;QACpD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAExF,iGAAiG;QACjG,OAAO;;;EAGT,OAAO;;CAER,CAAC;IACA,CAAC;IAEO,oBAAoB,CAAC,MAAsB;QACjD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAErC,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,cAAc,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC;6BACtB,IAAI;MAC3B,CAAC;QACH,CAAC;QAED,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChH,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEnH,OAAO,cAAc,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI;sCAC1B,WAAW;;6BAEpB,IAAI;MAC3B,CAAC;IACL,CAAC;IAEO,QAAQ,CAAC,EAAE,IAAI,EAAc;QACnC,IAAI,IAAI,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC;YAC/B,4FAA4F;YAC5F,OAAO,MAAM,CAAC;QAChB,CAAC;aAAM,IAAI,IAAI,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC;YACtC,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,IAAI,IAAI,CAAC,SAAS,GAAG,YAAY,EAAE,CAAC;YACzC,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;CACF;AAED,MAAM,mBAAmB,GAA2B;IAClD,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,KAAK;CACZ,CAAC;AAEF;;GAEG;AACH,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AAC7E,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,MAAc;IACjC,OAAO,WAAW,CAAC,MAAM,CAAC;SACvB,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,WAAW,EAAE,CAAC;AACnB,CAAC"}

package/dist/schema-generators/generators.d.ts

@@ -2,6 +2,7 @@ import { DartSchemaGenerator } from './DartSchemaGenerator.js';
 import { DotNetClassSchemaGenerator, DotNetSchemaGenerator } from './DotNetSchemaGenerator.js';
 import { JsLegacySchemaGenerator } from './JsLegacySchemaGenerator.js';
 import { KotlinSchemaGenerator } from './KotlinSchemaGenerator.js';
+import { RustSchemaGenerator } from './RustSchemaGenerator.js';
 import { SwiftSchemaGenerator } from './SwiftSchemaGenerator.js';
 import { TsSchemaGenerator } from './TsSchemaGenerator.js';
 export declare const schemaGenerators: {
@@ -11,6 +12,7 @@ export declare const schemaGenerators: {
     js: TsSchemaGenerator;
     jsLegacy: JsLegacySchemaGenerator;
     kotlin: KotlinSchemaGenerator;
+    rust: RustSchemaGenerator;
     swift: SwiftSchemaGenerator;
     ts: TsSchemaGenerator;
 };

package/dist/schema-generators/generators.js

@@ -2,6 +2,7 @@ import { DartSchemaGenerator } from './DartSchemaGenerator.js';
 import { DotNetClassSchemaGenerator, DotNetSchemaGenerator } from './DotNetSchemaGenerator.js';
 import { JsLegacySchemaGenerator } from './JsLegacySchemaGenerator.js';
 import { KotlinSchemaGenerator } from './KotlinSchemaGenerator.js';
+import { RustSchemaGenerator } from './RustSchemaGenerator.js';
 import { SwiftSchemaGenerator } from './SwiftSchemaGenerator.js';
 import { TsSchemaGenerator, TsSchemaLanguage } from './TsSchemaGenerator.js';
 export const schemaGenerators = {
@@ -11,6 +12,7 @@ export const schemaGenerators = {
     js: new TsSchemaGenerator({ language: TsSchemaLanguage.js }),
     jsLegacy: new JsLegacySchemaGenerator(),
     kotlin: new KotlinSchemaGenerator(),
+    rust: new RustSchemaGenerator(),
     swift: new SwiftSchemaGenerator(),
     ts: new TsSchemaGenerator()
 };

package/dist/schema-generators/generators.js.map

@@ -1 +1 @@
-{"version":3,"file":"generators.js","sourceRoot":"","sources":["../../src/schema-generators/generators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAC/F,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE7E,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAE,IAAI,mBAAmB,EAAE;IAC/B,MAAM,EAAE,IAAI,qBAAqB,EAAE;IACnC,WAAW,EAAE,IAAI,0BAA0B,EAAE;IAC7C,EAAE,EAAE,IAAI,iBAAiB,CAAC,EAAE,QAAQ,EAAE,gBAAgB,CAAC,EAAE,EAAE,CAAC;IAC5D,QAAQ,EAAE,IAAI,uBAAuB,EAAE;IACvC,MAAM,EAAE,IAAI,qBAAqB,EAAE;IACnC,KAAK,EAAE,IAAI,oBAAoB,EAAE;IACjC,EAAE,EAAE,IAAI,iBAAiB,EAAE;CAC5B,CAAC"}
+{"version":3,"file":"generators.js","sourceRoot":"","sources":["../../src/schema-generators/generators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAC/F,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE7E,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAE,IAAI,mBAAmB,EAAE;IAC/B,MAAM,EAAE,IAAI,qBAAqB,EAAE;IACnC,WAAW,EAAE,IAAI,0BAA0B,EAAE;IAC7C,EAAE,EAAE,IAAI,iBAAiB,CAAC,EAAE,QAAQ,EAAE,gBAAgB,CAAC,EAAE,EAAE,CAAC;IAC5D,QAAQ,EAAE,IAAI,uBAAuB,EAAE;IACvC,MAAM,EAAE,IAAI,qBAAqB,EAAE;IACnC,IAAI,EAAE,IAAI,mBAAmB,EAAE;IAC/B,KAAK,EAAE,IAAI,oBAAoB,EAAE;IACjC,EAAE,EAAE,IAAI,iBAAiB,EAAE;CAC5B,CAAC"}

package/dist/schema-generators/schema-generators.d.ts

@@ -5,6 +5,7 @@ export * from './generators.js';
 export * from './JsLegacySchemaGenerator.js';
 export * from './KotlinSchemaGenerator.js';
 export * from './RoomSchemaGenerator.js';
+export * from './RustSchemaGenerator.js';
 export * from './SchemaGenerator.js';
 export * from './SwiftSchemaGenerator.js';
 export * from './TsSchemaGenerator.js';

package/dist/schema-generators/schema-generators.js

@@ -5,6 +5,7 @@ export * from './generators.js';
 export * from './JsLegacySchemaGenerator.js';
 export * from './KotlinSchemaGenerator.js';
 export * from './RoomSchemaGenerator.js';
+export * from './RustSchemaGenerator.js';
 export * from './SchemaGenerator.js';
 export * from './SwiftSchemaGenerator.js';
 export * from './TsSchemaGenerator.js';

package/dist/schema-generators/schema-generators.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema-generators.js","sourceRoot":"","sources":["../../src/schema-generators/schema-generators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AAEvC,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;AACpF,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,kBAAkB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC"}
+{"version":3,"file":"schema-generators.js","sourceRoot":"","sources":["../../src/schema-generators/schema-generators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AAEvC,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;AACpF,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,kBAAkB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@powersync/service-sync-rules",
   "repository": "https://github.com/powersync-ja/powersync-service",
-  "version": "0.41.0",
+  "version": "0.42.0",
   "exports": "./dist/index.js",
   "license": "FSL-1.1-ALv2",
   "publishConfig": {