@powersync/service-module-mongodb 0.0.0-dev-20241111122558 → 0.1.0

package/src/types/types.ts

@@ -4,6 +4,42 @@ import * as t from 'ts-codec';
 
 export const MONGO_CONNECTION_TYPE = 'mongodb' as const;
 
+export enum PostImagesOption {
+  /**
+   * Use fullDocument: updateLookup on the changeStream.
+   *
+   * This does not guarantee consistency - operations may
+   * arrive out of order, especially when there is replication lag.
+   *
+   * This is the default option for backwards-compatability.
+   */
+  OFF = 'off',
+
+  /**
+   * Use fullDocument: required on the changeStream.
+   *
+   * Collections are automatically configured with:
+   * `changeStreamPreAndPostImages: { enabled: true }`
+   *
+   * This is the recommended behavior for new instances.
+   */
+  AUTO_CONFIGURE = 'auto_configure',
+
+  /**
+   *
+   * Use fullDocument: required on the changeStream.
+   *
+   * Collections are not automatically configured. Each
+   * collection must be configured configured manually before
+   * replicating with:
+   *
+   * `changeStreamPreAndPostImages: { enabled: true }`
+   *
+   * Use when the collMod permission is not available.
+   */
+  READ_ONLY = 'read_only'
+}
+
 export interface NormalizedMongoConnectionConfig {
   id: string;
   tag: string;
@@ -13,6 +49,8 @@ export interface NormalizedMongoConnectionConfig {
 
   username?: string;
   password?: string;
+
+  postImages: PostImagesOption;
 }
 
 export const MongoConnectionConfig = service_types.configFile.DataSourceConfig.and(
@@ -25,7 +63,9 @@ export const MongoConnectionConfig = service_types.configFile.DataSourceConfig.a
     uri: t.string,
     username: t.string.optional(),
     password: t.string.optional(),
-    database: t.string.optional()
+    database: t.string.optional(),
+
+    post_images: t.literal('off').or(t.literal('auto_configure')).or(t.literal('read_only')).optional()
   })
 );
 
@@ -48,10 +88,10 @@ export function normalizeConnectionConfig(options: MongoConnectionConfig): Norma
   const base = normalizeMongoConfig(options);
 
   return {
+    ...base,
     id: options.id ?? 'default',
     tag: options.tag ?? 'default',
-
-    ...base
+    postImages: (options.post_images as PostImagesOption | undefined) ?? PostImagesOption.OFF
   };
 }