Feature Branch for Consolidated SDK Docs

docs-release-notes.md

@@ -1662,7 +1662,7 @@ Prepare docs for C++ GA release, including:
 - Model Data
   - Define an Object Model: Update info for C# nullable reference types and nullable-aware context, add a Bluehawked code example
   - Data Binding: Move a section about data binding and MVVM from Define an Object Model to Data Binding page
-- React to Changes: Add a callout with info about binding data to the UI and a link to the the Data Binding page
+- React to Changes: Add a callout with info about binding data to the UI and a link to the Data Binding page
 
 ## Node.js SDK
 

examples/dotnet/Examples/Asymmetrics.cs

@@ -11,25 +11,26 @@ namespace Examples
 {
     public partial class Asymmetrics
     {
-        App app;
-        Realms.Sync.User user;
         Realm realm;
-        const string myRealmAppId = Config.FSAppId;
+        const string myAppId = Config.FSAppId;
 
         [OneTimeSetUp]
         public void Setup()
         {
-            app = App.Create(myRealmAppId);
-            user = app.LogInAsync(
+            // :snippet-start: connect-and-authenticate
+            App app = App.Create(myAppId);
+            Realms.Sync.User user = app.LogInAsync(
                 Credentials.Anonymous()).Result;
-
+            // :snippet-end:
+
+            // :snippet-start: configure-and-open-db
             var config = new FlexibleSyncConfiguration(user)
             {
                 Schema = new[] { typeof(Measurement) }
             };
 
-
             realm = Realm.GetInstance(config);
+            // :snippet-end:
 
             // You cannot add a subscription for an AsymmetricObject
             // This causes a compile-time error:
@@ -40,22 +41,18 @@ public void Setup()
             //});
             // :uncomment-end:
         }
-
-        // :snippet-start: asymmetry
-        // :remove-start:
         [Realms.Explicit]
-        // :remove-end:
+        // :snippet-start: define-asymmetric-object
         private partial class Measurement : IAsymmetricObject
         {
             [PrimaryKey, MapTo("_id")]
             public Guid Id { get; private set; } = Guid.NewGuid();
             public double Value { get; set; }
             public DateTimeOffset Timestamp { get; private set; } = DateTimeOffset.UtcNow;
         }
-
-        // :remove-start:
+        // :snippet-end:
         [Test]
-        // :remove-end:
+        // :snippet-start: asymmetry
         public void SendMeasurementToRealm()
         {
             var measurement = new Measurement

examples/java/sync/app/src/androidTest/java/com/mongodb/realm/examples/java/ClientResetTest.java

@@ -238,7 +238,7 @@ public void handleManualReset(App app, SyncSession session, ClientResetRequiredE
 
             Log.w("EXAMPLE", "Opened a fresh instance of the realm.");
 
-            // Open the the realm backup -- as a dynamic realm
+            // Open the realm backup -- as a dynamic realm
             // (no formal schema; access all data through field lookups)
             DynamicRealm backupRealm = DynamicRealm.getInstance(error.getBackupRealmConfiguration());
             Log.w("EXAMPLE", "Opened the backup realm.");

examples/java/sync/app/src/androidTest/java/com/mongodb/realm/examples/kotlin/ClientResetTest.kt

@@ -265,7 +265,7 @@ class ClientResetTest : RealmTest() {
             }
             Log.w("EXAMPLE", "Opened a fresh instance of the realm.")
 
-            // Open the the realm backup -- as a dynamic realm
+            // Open the realm backup -- as a dynamic realm
             // (no formal schema; access all data through field lookups)
             val backupRealm =
                 DynamicRealm.getInstance(error.backupRealmConfiguration)

examples/node/legacy/Examples/realm-query-language.js

@@ -1,9 +1,12 @@
 import Realm, { BSON } from "realm";
 import { ItemModel, ProjectModel } from "./schemas/rql-data-models";
 
-// Tests for new RQL operators or updates should be placed in the new 
-// file compatible with JSv12 and later, located at 
-// examples/node/v12/__tests__/realm-query-language.test.js
+/*
+  DON'T UPDATE THIS FILE. DEPRECATED IN FAVOR OF V12 TESTS.
+  Tests for new RQL operators or updates should be placed in the new
+  files compatible with JSv12 and later, located at:
+  examples/node/v12/__tests__/realm-query-language.test.js/ts
+*/
 
 describe("Realm Query Language Reference", () => {
   let realm;
@@ -148,7 +151,7 @@ describe("Realm Query Language Reference", () => {
     const progressMinutesRange = items.filtered(
       // :remove-end:
 
-      // Find to-do items within a certain time range by finding items 
+      // Find to-do items within a certain time range by finding items
       // where the progressMinutes property is between two numbers.
       "progressMinutes BETWEEN { $0 , $1 }", 30, 60
       // :remove-start:
@@ -406,7 +409,7 @@ describe("Realm Query Language Reference", () => {
       );
       expect(shallowResultLinkingObjects.length).toBe(1);
       expect(shallowResultLinkingObjects[0].name).toBe("Get coffee");
-      
+
       const shallowResultAtLinks = realm.objects("Item").filtered(
         // :remove-end:
         // Find items that are not referenced by any project

examples/node/legacy/Examples/rql-data-models.js

@@ -1,6 +1,13 @@
 import Realm from "realm";
 import { ItemModel, ProjectModel } from "./schemas/rql-data-models";
 
+/*
+  DON'T UPDATE THIS FILE. DEPRECATED IN FAVOR OF V12 TESTS.
+  Updates should be placed in the new files compatible with
+  JSv12 and later, located at:
+  examples/node/v12/__tests__/rql-data-models.test.js/ts
+*/
+
 describe("test models", () => {
   let realm;
   const config = {

examples/node/legacy/Examples/schemas/rql-data-models.js

@@ -1,3 +1,9 @@
+/*
+  DON'T UPDATE THIS FILE. DEPRECATED IN FAVOR OF V12 MODELS.
+  Updates should be placed in the new file compatible with
+  JSv12 and later, located at:
+  examples/node/v12/__tests__/models/rql-data-models.ts
+*/
 // :snippet-start: rql-data-models
 const ItemModel = {
   name: "Item",

examples/node/v12/__tests__/models/rql-data-models.js

@@ -0,0 +1,54 @@
+// Models for embedded objects & dot notation queries
+const Address = {
+  name: "Address",
+  embedded: true,
+  properties: {
+    name: "string",
+    street: "string",
+    zipcode: "int",
+  },
+};
+
+const Office = {
+  name: "Office",
+  properties: {
+    name: "string",
+    address: "Address",
+  },
+};
+
+// :snippet-start: rql-data-models
+const Item = {
+  name: "Item",
+  properties: {
+    _id: "objectId",
+    name: { type: "string", indexed: "full-text" },
+    isComplete: { type: "bool", default: false },
+    assignee: "string?",
+    priority: { type: "int", default: 0 },
+    progressMinutes: { type: "int", default: 0 },
+    projects: {
+      type: "linkingObjects",
+      objectType: "Project",
+      property: "items",
+    },
+  },
+  primaryKey: "_id",
+};
+
+const Project = {
+  name: "Project",
+  properties: {
+    _id: "objectId",
+    name: "string",
+    items: "Item[]",
+    quota: "int?",
+    comments: "string?{}",
+    projectLocation: "Office?",
+    additionalInfo: "mixed",
+  },
+  primaryKey: "_id",
+};
+// :snippet-end:
+
+export { Address, Item, Office, Project };

examples/node/v12/__tests__/models/rql-data-models.ts

@@ -1,5 +1,36 @@
 import Realm, { BSON, ObjectSchema } from "realm";
 
+// Models for embedded objects & dot notation queries
+export class Address extends Realm.Object<Address> {
+  name!: string;
+  street!: string;
+  zipcode!: number;
+
+  static schema: ObjectSchema = {
+    name: "Address",
+    embedded: true,
+    properties: {
+      name: "string",
+      street: "string",
+      zipcode: "int",
+    },
+  };
+}
+
+export class Office extends Realm.Object<Office> {
+  name!: string;
+  address!: Address;
+
+  static schema: ObjectSchema = {
+    name: "Office",
+    properties: {
+      name: "string",
+      address: "Address",
+    },
+  };
+}
+
+// :snippet-start: rql-data-models
 export class Item extends Realm.Object<Item> {
   _id!: BSON.ObjectId;
   name!: string;
@@ -12,17 +43,11 @@ export class Item extends Realm.Object<Item> {
     name: "Item",
     properties: {
       _id: "objectId",
-      name: { type:"string", indexed: "full-text" },
+      name: { type: "string", indexed: "full-text" },
       isComplete: { type: "bool", default: false },
       assignee: "string?",
-      priority: {
-        type: "int",
-        default: 0,
-      },
-      progressMinutes: {
-        type: "int",
-        default: 0,
-      },
+      priority: { type: "int", default: 0 },
+      progressMinutes: { type: "int", default: 0 },
       projects: {
         type: "linkingObjects",
         objectType: "Project",
@@ -32,12 +57,14 @@ export class Item extends Realm.Object<Item> {
     primaryKey: "_id",
   };
 }
-
 export class Project extends Realm.Object<Project> {
   _id!: BSON.ObjectId;
   name!: string;
-  items!: Realm.List<Item>
-  quota?: number
+  items!: Realm.List<Item>;
+  quota?: number;
+  comments?: Realm.Dictionary<string>;
+  projectLocation?: Office;
+  additionalInfo!: Realm.Mixed;
 
   static schema: ObjectSchema = {
     name: "Project",
@@ -46,7 +73,11 @@ export class Project extends Realm.Object<Project> {
       name: "string",
       items: "Item[]",
       quota: "int?",
+      comments: "string?{}",
+      projectLocation: "Office?",
+      additionalInfo: "mixed",
     },
     primaryKey: "_id",
-  }
-};
+  };
+}
+// :snippet-end: