@powersync/service-module-mongodb 0.15.3 → 0.16.0

package/dist/replication/bufferToSqlite.d.ts

@@ -0,0 +1,43 @@
+import { CompatibilityContext, SqliteRow } from '@powersync/service-sync-rules';
+export declare const enum DateRenderMode {
+    LEGACY_MILLISECONDS = 0,
+    ISO_MILLISECONDS = 1,
+    ISO_SECONDS = 2
+}
+/**
+ * Convert a buffer containing BSON bytes to a SqliteRow.
+ *
+ * This is using a custom BSON parser and JSON serializer for performance reasons. By bypassing bson.deserialize,
+ * we avoid many small allocations, and can significantly increase throughput.
+ *
+ * This attempts to match the behavior of `bson.deserialize -> constructAfterRecord -> applyRowContext` for the most part,
+ * with some intentional differences:
+ * 1. Regular expression patterns options are preserved as-is, while the above normalizes to JS RegExp values.
+ * 2. Full UTF-8 validation is not performed - we attempt to continue using replacement characters, as long as the resulting output remains valid.
+ * 3. bson.deserialize has special-case handler for converting documents containing {$ref} -> DBRef. We don't do that here.
+ *
+ * General principles followed:
+ * 1. Correctness: Never produce invalid JSON.
+ * 2. Performance: Optimize to be as performant as possible for common cases.
+ * 3. Full BSON support: Support all valid BSON documents as input, including deprecated types, but without specifically optimizing for performance here.
+ * 4. The source database is responsible for producing valid BSON - we don't test for all edge cases of invalid BSON.
+ * 5. We do a best-effort attempt to support "degenerate" BSON cases as documented at https://specifications.readthedocs.io/en/latest/bson-corpus/bson-corpus/, since MongoDB can produce many of these cases.
+ *
+ * @param bytes the source BSON bytes
+ * @param dateRenderMode derive using getDateRenderMode(compatibilityContext)
+ *
+ * @returns a SqliteRow
+ */
+export declare function bufferToSqlite(bytes: Buffer, dateRenderMode: DateRenderMode): SqliteRow;
+export declare function getDateRenderMode(compatibilityContext: CompatibilityContext): DateRenderMode;
+/**
+ * Parse an _id from a buffer, without parsing the entire document.
+ *
+ * The parsed _id is parsed using standard bson.deserialize - different from bufferToSqlite.
+ *
+ * @returns the parsed id, as well as a serialized document including only _id.
+ */
+export declare function parseDocumentId(bytes: Buffer): {
+    id: any;
+    idBuffer: Buffer;
+};