DOCS-9003: adds method ref for db.collection.createIndexes() #3090
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mongo-cr-bot
pushed a commit
that referenced
this pull request
May 9, 2023
mongodb-server-docs-sync-bot bot
pushed a commit
that referenced
this pull request
Aug 25, 2025
* No default value for lists in .NET (#3057) ## Pull Request Info ### Jira https://jira.mongodb.org/browse/DOCSP-33473 ### Staged Changes https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/docsp-33473/sdk/dotnet/model-data/define-object-model/#default-field-values * DOCSP-30346: Update Kotlin Delete page (#3052) ## Pull Request Info Update existing [Delete](https://www.mongodb.com/docs/realm/sdk/kotlin/realm-database/crud/delete/) page with missing content and updated code examples ### Jira - https://jira.mongodb.org/browse/DOCSP-30346 ### Staged Changes - [Delete Realm Objects - Kotlin SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-30346-delete-page/sdk/kotlin/realm-database/crud/delete/) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) --------- Co-authored-by: lindseymoore <[email protected]> * (DOCSP-33534) Add authentication hooks to React Native docs (#3037) ## Pull Request Info This is a somewhat large PR, but don't let the lines changed intimidate you: that's mostly from the auto-generated `package-lock.json` file. I only address some of the needed auth changes in this PR. I created a small [Jira epic](https://jira.mongodb.org/browse/DOCSP-27838) to track the other work. Major changes: - New test files - Link identities - Anonymous login - Email/pass login - Content pages - Authenticate users - Manage email/password users - Link user identities The test suite has an issue with randomly aborting. I have a [Jira ticket](https://jira.mongodb.org/browse/DOCSP-33596) to track fixing it. ### Jira - https://jira.mongodb.org/browse/DOCSP-33534 ### Staged Changes Much of the content and examples for the new hook reference tables comes from Andrew Meyer's [additions to the Realm.js repo](https://github.com/realm/realm-js/pull/5719/files#diff-0a17fcc4976001d1d5e37d559a9cad782dd038759c6c5819477ca447a6bdaf5d). - [Authenticate Users](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-27838/sdk/react-native/manage-users/authenticate-users/) - Revamped these sections: Configure User Authentication in Client, Anonymous User, and Email/Password User. - New reference table for `useAuth`. - [Manage Email/Password Users](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-27838/sdk/react-native/manage-users/manage-email-password-users/) - Lots of updates to the examples and content throughout this page. - New reference table for `useEmailPasswordAuth`. - [Link User Identities](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-27838/sdk/react-native/manage-users/link-user-identities/) - New procedure with updated examples. - Trying a new thing where I break a whole React Native component into a procedure. The idea here is to give devs an idea of what a user management component could look like. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) ### Animal Wearing a Hat <img src="https://www.pocketpetpouch.store/cdn/shop/products/hedgehogsailorhat.jpg?v=1667878886" width=400> --------- Co-authored-by: cbullinger <[email protected]> * Update Expo references in React Native docs (#3058) ## Pull Request Info We got some docs feedback about Expo. We weren't giving enough indication of where Expo users should look for information. This PR shuffles some content and provides better sign posting for Expo users. ### Staged Changes - [Install Realm](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/update-expo-references/sdk/react-native/install/) - [Bootstrap with Expo](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/update-expo-references/sdk/react-native/bootstrap-with-expo/) - [Use @realm/react](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/update-expo-references/sdk/react-native/use-realm-react/) ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) ### Animal Wearing a Hat <img src="https://media-cldnry.s-nbcnews.com/image/upload/t_fit-1500w,f_auto,q_auto:best/streams/2012/September/120907/526472-ss-120906-chicks-hats-03.jpg" width=400 /> * DOCSP-33716 Add docs release notes for w/e October 20 (#3060) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-33716 * DOCS-33261: Add note that Java SDK is in Maintenance Mode (#3061) ## Pull Request Info Indicate to users that the Java SDK is in a best-effort maintenance mode and no longer receiving any new features. And, per [Slack convo](https://mongodb.slack.com/archives/CL9JSLTGE/p1698666451443479), confirm you can use other SDKs in a Java project. ### Jira - https://jira.mongodb.org/browse/DOCSP-33261 ### Staged Changes - [Java SDK landing](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-33261-java-sdk-guidance/sdk/java/) - [Install - Java SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-33261-java-sdk-guidance/sdk/java/install/) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-28276) Add argument to `useQuery` to allow result to be filtered and sorted (#3063) ## Pull Request Info This PR updates the syntax for `useQuery()` when it's used with `.filtered()` and `.sorted()`. Essentially, going from this: ```JS const contactsInArea = contacts.filtered(`address.postalCode == '${postalCode}'`); ``` to this: ```JS const contactsInArea = useQuery( Contact, contacts => { return contacts.filtered(`address.postalCode == '${postalCode}'`); }, [postalCode], ); ``` The new syntax has baked-in performance improvements and is the recommended way to handle filtering and sorted. We should avoid `useQuery(<ObjectClass>).sorted()` or `useQuery(<ObjectClass>).filtered()`. ### Jira - https://jira.mongodb.org/browse/DOCSP-28276 ### Staged Changes - [Code samples throughout the React Native SDK docs](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-28276/sdk/react-native/) ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) ### Animal Wearing a Hat <img src="https://images.unsplash.com/photo-1575425187336-d5ec5d0a1451?auto=format&fit=crop&q=80&w=1000&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8N3x8ZG9nJTIwaGF0fGVufDB8fDB8fHww" width=400> * React Native: Remove bad onError configuration (#3064) ## Pull Request Info Several of our examples had a bad error handler construction. This PR removes that construction. In all cases, the error handling bit wasn't necessary. ### Staged Changes [Multiple places in the React Native docs](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/remove-bad-on-error/sdk/react-native/) ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) ### Animal Wearing a Hat <img src="https://i.etsystatic.com/5376657/r/il/233f4d/650177589/il_570xN.650177589_rgoj.jpg" width=400> * Swift: Add docs for SyncSession.reconnect() (#3062) ## Pull Request Info A few questions for a tech reviewer based on the similar docs in Kotlin: - In Kotlin, we say "The SDK also automatically calls this method when a device toggles off airplane mode" - is this accurate in the Swift SDK, also? I didn't see anything special for this in the SDK PR so wondering if this is something in Core? - In Kotlin, we say "the SDK forces all sync sessions to attempt to reconnect immediately" - is this also true in Swift, or is it forcing only the `SyncSession` you call it on to reconnect? Does this change with session multiplexing enabled/disabled? - Kotlin has a callout about not being able to force a reconnection within the socket read timeout duration - is this also true in Swift? - It seems the [RLMSyncSession got docs for the new method](https://www.mongodb.com/docs/realm-sdks/objc/latest/Classes/RLMSyncSession.html), but [Swift's SyncSession](https://www.mongodb.com/docs/realm-sdks/swift/latest/Extensions/SyncSession.html) didn't. Could we add this, or am I looking in the wrong place? ### Jira - https://jira.mongodb.org/browse/DOCSP-33926 ### Staged Changes - [Manage Sync Sessions](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/DOCSP-33926/sdk/swift/sync/sync-session/) The rest of the examples in the test file were still using Partition-Based Sync, so I also updated those examples to FS. Those examples are at: - [Configure & Open a Synced Realm](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/DOCSP-33926/sdk/swift/sync/configure-and-open-a-synced-realm/#download-changes-before-open) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-29739): C++: Add documentation for Set data type (#3065) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-29739 ### Staged Changes - [Supported Types](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-29739/sdk/cpp/model-data/supported-types/#set) - [CRUD/Create](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-29739/sdk/cpp/crud/create/#create-an-object-with-a-set-property) - [CRUD/Read](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-29739/sdk/cpp/crud/read/#read-a-set-property) - [CRUD/Update](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-29739/sdk/cpp/crud/update/#update-a-set-property) - [CRUD/Delete](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-29739/sdk/cpp/crud/delete/#delete-set-values) - [React to Changes](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-29739/sdk/cpp/react-to-changes/#register-a-collection-change-listener) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-33254): C++: Doc asymmetric object link change that came with core update (#3066) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-33254 ### Staged Changes - [Object Types and Schemas](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33254/sdk/cpp/model-data/object-models/#define-an-asymmetric-object) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-33596) Fix React Native test suite issue (#3067) A previous PR commented out `module:metro-react-native-babel-preset` in `bable.config.cjs`. This line is necessary for CI Jest tests to work. So, it should remain uncommented in the source repo. However, it needs to be commented out to work with Metro and run local simulators. Still haven't been able to figure out a real fix for this issue. This PR also includes a couple minor changes to test code to account for configuration changes. ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-33596 ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) ### Animal Wearing a Hat <img src="https://blenderartists.org/uploads/default/original/4X/9/c/8/9c8b0f8cfac4baf8c58b93b8a55ee1cfa811a863.jpeg" width=400> * C++: Add generated Set snippet to the supported types table (#3070) ## Pull Request Info Noticed this quick fix while I was putting together release notes. ### Staged Changes - [Supported Types](https://preview-mongodbdacharyc.gatsbyjs.io/realm/fix-missed-set-code-snippet/sdk/cpp/model-data/supported-types/) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-33933): Add docs release notes for w/e Nov 3 (#3069) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-33933 * (DOCSP-33626) Document metadata encryption (#3068) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-33626 ### Staged Changes - Node: [Connect to an Atlas App Services Backend](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-33626/sdk/node/app-services/connect-to-app-services-backend/#encrypt-app-metadata) - Node: [Encrypt a Realm](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-33626/sdk/node/realm-files/encrypt/#encrypt-app-services-app-metadata) - React Native: [Connect to an Atlas App Services App](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-33626/sdk/react-native/app-services/connect-to-app-services-app/#encrypt-app-metadata) - React Native: [Encrypt a Realm](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-33626/sdk/react-native/realm-files/encrypt/#encrypt-app-services-app-metadata) ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) ### Animal Wearing a Hat <img src="https://i.pinimg.com/432x292/1c/c5/a7/1cc5a7f86c07156be178fff0b659306f.jpg" width=400> --------- Co-authored-by: cbullinger <[email protected]> * DOCSP-30345: Update Kotlin SDK's Update page (#3059) ## Pull Request Info Update existing [Update](https://www.mongodb.com/docs/realm/sdk/kotlin/realm-database/crud/update/) page with missing content and improved code examples using updated object models ### Jira - https://jira.mongodb.org/browse/DOCSP-30345 ### Staged Changes - [Update - Kotlin SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-30345-update-page/sdk/kotlin/realm-database/crud/update/) - add missing sections and update code examples - [Delete - Kotlin SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-30345-update-page/sdk/kotlin/realm-database/crud/delete/) - small updates - [Supported Types - Kotlin SDK ](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-30345-update-page/sdk/kotlin/realm-database/schemas/supported-types/)- small updates ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-33831): C++: Add docs for encryption and metadata encryption (#3073) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-33831 ### Staged Changes - [Encrypt a Realm](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33831/sdk/cpp/realm-files/encrypt-a-realm/): New page based on similar pages in other SDKs - [Connect to App Services](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33831/sdk/cpp/app-services/connect-to-app/#encrypt-app-metadata): Add a section about encrypting metadata. Update custom HTTP section for deprecated `realm::App(...)` ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) --------- Co-authored-by: cbullinger <[email protected]> * DOCSP-33852 Add Example Projects to Remaining SDK Landing Pages (#3075) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-33852 ### Staged Changes - [React Native](https://preview-mongodblindseymoore.gatsbyjs.io/realm/DOCSP-33852/sdk/react-native/) - [Node.js](https://preview-mongodblindseymoore.gatsbyjs.io/realm/DOCSP-33852/sdk/node/) - [Web](https://preview-mongodblindseymoore.gatsbyjs.io/realm/DOCSP-33852/web/) - [Flutter](https://preview-mongodblindseymoore.gatsbyjs.io/realm/DOCSP-33852/sdk/flutter/) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [ ] Create Jira ticket for corresponding docs-app-services update(s), if any - [ ] Checked/updated Admin API - [ ] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * DOCSP-34240: Document metadata encryption in Kotlin SDK (#3074) ## Pull Request Info Update existing [Encrypt a Realm](https://www.mongodb.com/docs/realm/sdk/kotlin/realm-database/realm-files/encrypt-a-realm/) and [Connect to App Services](https://www.mongodb.com/docs/realm/sdk/kotlin/app-services/connect-to-app-services-backend/) pages with info on App metadata encryption. ### Jira - https://jira.mongodb.org/browse/DOCSP-34240 ### Staged Changes - [Encrypt a Realm - Kotlin SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-34240-encrypt-app-metadata/sdk/kotlin/realm-database/realm-files/encrypt-a-realm/#std-label-kotlin-encryption-and-device-sync) - [Connect to Atlas App Services - Kotlin SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-34240-encrypt-app-metadata/sdk/kotlin/app-services/connect-to-app-services-backend/#encrypt-app-metadata) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-34097): Add docs release notes for w/e November 10 (#3077) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-34097 * (DOCSP-33483): Swift: Actor and Concurrency updates and fixes (#3072) ## Pull Request Info This PR: - Fixes and un-skips failing tests showing invalid examples of using Realm with Swift Actors - Corrects `writeAsync` mentions to `asyncWrite` - Corrects the conflated "Observe Notifications on an Actor-Isolated Realm" to "Observe Notifications on a Different Actor" - Adds more details about how to use Realm across actors based on docs feedback - Notes you can't currently use `thaw()` with Swift actors, and recommends `ThreadSafeReference` instead ### Jira - https://jira.mongodb.org/browse/DOCSP-33483 - https://jira.mongodb.org/browse/DOCSP-34052 - https://jira.mongodb.org/browse/DOCSP-33834 ### Staged Changes - [Use Realm with Actors](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33483/sdk/swift/use-realm-with-actors/) (formerly Actor-Isolated Realms - but that was conflating some of the functionality) - [Swift Concurrency](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33483/sdk/swift/swift-concurrency/) - [Threading](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33483/sdk/swift/crud/threading/) - [React to Changes](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33483/sdk/swift/react-to-changes/#react-to-changes-on-a-different-actor) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * Update Kotlin example README.md (#3079) Rename Kotlin Multiplatform Mobile (KMM) to Kotlin Multiplatform (KMP), as KMM is deprecated * Remove genre tag from 2 landing pages (#3084) ## Pull Request Info There is no Jira ticket for this one; it just came up during the Realm Team's taxonomy training workshop session. We determined not to put a genre tag for any Realm landing pages. @dacharyc, if all looks good, will you please merge? ### Staged Changes - https://preview-mongodbsarahemlin.gatsbyjs.io/realm/untag-landing-pages/ * (DOCSP-34500): Use Chris' docdoctor repo with updated `main` entrypoint (#3086) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-34500 * DOCSP-34366 Add docs release notes for w/e November 17 (#3083) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-34366 * DOCSP-33172 add meta::description for top 250 (#3087) ## Pull Request Info Hey @dacharyc! I'm on to the next round of top 250 updates. Please feel free to edit the descriptions I put in--I just picked a sentence from each page that looked good. We need something; doesn't have to be perfect but if you think something else would be better, please change! Thanks! Sarah ### Jira - https://jira.mongodb.org/browse/DOCSP-33172 ### Staged Changes - Staging link: https://preview-mongodbsarahemlin.gatsbyjs.io/realm/DOCSP-33172/ - Build log: https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=655bb2245b686d6bd9341da5 --------- Co-authored-by: Dachary <[email protected]> * Update PR template (#3088) ## Pull Request Info This PR updates the PR template to include guidance for final commit messages. It also reorganizes things a bit. * (DOCSP-34573): Add docs release notes for w/e November 24 (#3089) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34573 --------- Co-authored-by: lindseymoore <[email protected]> * Readability workflow: Check out a version tag instead of missing branch (#3091) The existing readability workflow points to a ref that existed on the old source repo (my fork of Chris's branch) but that ref does not exist on Chris's branch. Attempting to check out a version tag instead of a branch ref that doesn't exist to fix the failing workflow. * (DOCSP-33535) React Native: Update more user authentication examples (#3078) ## Pull Request Info This PR adds tests and content updates for lots of authentication content. For Facebook, Google, and Apple auth, I updated examples, but not they're not part of the test suite. Setting up real auth through these services would take considerable time. - Custom JWT - Custom function - Facebook - Google - Apple - Get a User Access Token I didn't get to updating the offline login example in this PR. I'll take another look at it later in this little epic. I also fixed several annoying bugs in the React Native test suite itself and refactored some other auth examples to make them less brittle. **CI Tests** Seems like the CI tests are still a bit flaky. But they pass consistently locally. I don't have time to make CI happy right now, but here's a screenshot of local tests passing: <img width="626" alt="Screenshot 2023-11-14 at 9 20 59 PM" src="https://github.com/mongodb/docs-realm/assets/115574589/9d92f6ef-f3b9-423c-8bcb-d5fd997116f4"> ### Jira - https://jira.mongodb.org/browse/DOCSP-33535 ### Staged Changes - [Authenticate Users](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-33535/sdk/react-native/manage-users/authenticate-users/) ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) ### Animal Wearing a Hat <img src="https://i.chzbgr.com/full/9566515968/hB5AF53C7/hat-as" width=400> * DOCSP-34421 Update Example Projects Page (#3082) ## Pull Request Info - Intelligent Cache (.NET) - In-App Purchases (Swift) ### Jira - https://jira.mongodb.org/browse/DOCSP-34421 ### Staged Changes - [Example Projects](https://preview-mongodblindseymoore.gatsbyjs.io/realm/DOCSP-34421/example-projects/) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [ ] Create Jira ticket for corresponding docs-app-services update(s), if any - [ ] Checked/updated Admin API - [ ] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-33121): C++: Update Sync error handling docs for v0.4.0-preview (#3081) ## Pull Request Info ### Jira - https://jira.mongodb.org/browse/DOCSP-33121 - https://jira.mongodb.org/browse/DOCSP-29744 - https://jira.mongodb.org/browse/DOCSP-28836 ### Staged Changes - [Write to a Synced Realm](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33121/sdk/cpp/sync/write-to-synced-realm/): New page with compensating write error info similar to other SDKs - [Handle Sync Errors](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33121/sdk/cpp/sync/handle-sync-errors/): Replace deprecated App init examples - [Connect to App Services](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33121/sdk/cpp/app-services/connect-to-app/): Replace deprecated App init examples - [Call a Function](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33121/sdk/cpp/app-services/call-a-function/): Replace deprecated App init examples - [Authenticate Users](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33121/sdk/cpp/users/authenticate-users/): Replace deprecated App init examples - [Stream Data to Atlas](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33121/sdk/cpp/sync/stream-data-to-atlas/): Replace deprecated App init examples - [Manage Sync Subscriptions](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33121/sdk/cpp/sync/sync-subscriptions/): Replace deprecated App init examples ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Release Notes - **C++ SDK** - Update App init examples throughout docs to use `realm::App(configuration)`. - Add `version changed` details throughout docs to specify `realm::App(...)` deprecation in favor of `realm::App(configuration)` in v0.4.0-preview. - Sync Data - Write to a Synced Realm: New page similar to other SDKs with tested, Bluehawked code examples about sync subscriptions, permissions, and compensating writes. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) --------- Co-authored-by: cbullinger <[email protected]> * (DOCSP-30678): Swift: Add final curated example app to landing page (#3094) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-30678 Staged changes: - [Swift SDK Landing Page](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-30678/sdk/swift/#example-projects): Add the final curated example app, emphasizing StoreKit and IAP in the description, which are the most relevant aspects for Swift app developers ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for corresponding docs-realm docs-app-services, if any ### Release Notes - **Swift SDK** - Landing Page: Add the "Integrating In-App Purchases" example app to the Example Projects cards. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * DOCSP-30332: Model Data with Device Sync page for Kotlin (#3085) ## Pull Request Info Add new Model Data with Device Sync page for Kotlin to the Model Data section, similar to the existing [Swift](https://www.mongodb.com/docs/realm/sdk/swift/model-data/model-data-device-sync/#create-object-models-and-schemas) page. ### Jira - https://jira.mongodb.org/browse/DOCSP-30332 ### Staged Changes - [Model Data with Device Sync - Kotlin SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-30332-model-data-sync/sdk/kotlin/realm-database/schemas/model-data-device-sync/) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [x] Create Jira ticket for corresponding docs-app-services update(s), if any - [x] Checked/updated Admin API - [x] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) ### Release Notes - Realm/Model Data: - Model Data with Device Sync: Add new page with tested, Bluehawked code examples that describes how to map data from the Device Sync App Services schema to the Realm schema used by the Kotlin SDK. - Property Annotations: Update Primary Key section to note that Device Sync requires a primary key named '_id'. - Sync Device Data/Add Sync to an App: Add note pointing users to the new Model Data with Device Sync page to learn more about mapping data between Atlas and the Kotlin SDK. * (DOCSP-34457) Update UUID page example (#3093) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34457 Staged changes: [UUID](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-34457/sdk/react-native/model-data/data-types/uuid/) ### Description A minor change to the UUID examples. The object model was being shared in different places and was using `BSON.ObjectId` instead of `BSON.UUID`, which would be expected on a page about UUID. So, I created a new object model specifically for UUID. Note: There's a whole bunch of failing tests in the CI. These are in the legacy testing suite. I wish I had time to go back and make them all work in the CI, but that's probably never going to happen. ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for corresponding docs-realm docs-app-services, if any ### Release Notes - **Model Data** - Data Types/UUID: Fix object model example that erroneously used `BSON.ObjectId` instead of `BSON.UUID`. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) ### Animal Wearing a Hat  * (DOCSP-34268): C++ SDK: Add HTTP tunneling details to docs (#3097) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34628 Staged changes: - [Connect to an App Services App](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34628/sdk/cpp/app-services/connect-to-app/#use-an-http-proxy-with-realm) ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for corresponding docs-realm docs-app-services, if any ### Release Notes - **C++ SDK** - App Services/Connect to an App Services App: Add a "Use an HTTP Proxy with Realm" section with details and Bluehawked code example. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-34629): C++ SDK: Add sort documentation (#3095) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34629 Staged changes: - [CRUD/Read](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34629/sdk/cpp/crud/read/#sort-lists-and-query-results): Add a "Sort Lists and Query Results" section - [CRUD/Filter Data](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34629/sdk/cpp/crud/filter-data/): Remove the note about not yet supporting sort, and link to the sort example on the Read page ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for corresponding docs-realm docs-app-services, if any ### Release Notes - **C++ SDK** - CRUD - Read: Add a "Sort Lists and Query Results" section with tested, Bluehawked code examples for sorting in C++ SDK. - Filter Data: Remove the note about not yet supporting sort, and link to the sort example on the Read page. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * DOCSP-34625 Add docs release notes for w/e December 1 (#3099) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34625 * (DOCSP-34639) Add Flutter link to API ref landing page (#3101) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34639 No staging page because this page isn't built as part of `docs-realm`. The live page is here: https://www.mongodb.com/docs/realm-sdks/ ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for corresponding docs-realm docs-app-services, if any ### Release Notes Don't include in release notes ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-34287) Add documentation for `App.EmailPassword.retryCustomConfirmation` (#3098) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34287 Staged changes: - [Manage Email/Password Users](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-34457/sdk/dotnet/manage-users/manage-email-password-users/#retry-a-user-confirmation-function) Add an example for the new App.EmailPassword.retryCustomConfirmation method. ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for corresponding docs-app-services work if needed ### Release Notes - **.NET SDK** - Manage Users/Manage Email/Password Users: Add an example for the new App.EmailPassword.retryCustomConfirmation method and the older, undocumented, App.EmailPassword.ResendConfirmationEmailAsync method. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) --------- Co-authored-by: cbullinger <[email protected]> * (DOCSP-33255): Add asymmetric object link details for SDKs (#3100) ## Pull Request Info Jira ticket: - https://jira.mongodb.org/browse/DOCSP-33255 - https://jira.mongodb.org/browse/DOCSP-33256 - https://jira.mongodb.org/browse/DOCSP-33257 - https://jira.mongodb.org/browse/DOCSP-33258 - https://jira.mongodb.org/browse/DOCSP-33259 Staged changes: - [Flutter - Define a Realm Object Schema](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33255/sdk/flutter/realm-database/model-data/define-realm-object-schema/#define-an-asymmetric-object) - [Kotlin - Define an Object Model](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33255/sdk/kotlin/realm-database/schemas/define-realm-object-model/#define-an-asymmetric-object-type) - [.NET - Stream Data to Atlas](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33255/sdk/dotnet/sync/asymmetric-sync/#sync-data-unidirectionally-from-a-client-application) - [Node.js - Define a Realm Object Model](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33255/sdk/node/model-data/define-a-realm-object-model/#define-an-asymmetric-object) - [RN - Define an Object Model](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-33255/sdk/react-native/model-data/define-a-realm-object-model/#define-an-asymmetric-object) These changes come along with a Core version update. I did not add `.. versionchanged::` admonitions in SDKs where we already have `.. versionadded::` for Asymmetric Sync, because this didn't seem to warrant stacking version admonitions. But that's an arbitrary decision so it may make sense to do this differently. ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for corresponding docs-realm docs-app-services, if any ### Release Notes - **Flutter SDK** - Realm Database/Model Data/Define a Realm Object Schema: Note that asymmetric objects support linking to Realm objects starting in v1.6.0. - **Kotlin SDK** - Realm/Model Data/Define an Object Model: Note that asymmetric objects support linking to Realm objects starting in v1.12.0. - **.NET SDK** - Sync Data/Stream Data to Atlas: Note that asymmetric objects support linking to Realm objects starting in v11.6.0. - **Node.js SDK** - Model Data/Define an Object Model: Note that asymmetric objects support linking to Realm objects starting in v12.2.1. - **React Native SDK** - Model Data/Define an Object Model: Note that asymmetric objects support linking to Realm objects starting in v12.2.1. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * Add tagging checklist item (#3090) ## Pull Request Info This PR adds a reminder about content tags to the PR checklist. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-34626): Realm Studio: New View Atlas Data with Device Sync page (#3103) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34626 Staged changes: - [View Data with Device Sync](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34626/studio/view-atlas-data-sync/): New page describing the new functionality and how to use it. - [Realm Studio landing page](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34626/studio/): Tweak the intro to mention the new functionality and reword "create Realm files." ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for corresponding docs-realm docs-app-services, if any ### Release Notes - **Realm Studio** - Landing Page: Add a bullet listing the ability to connect, view, and modify data using Device Sync. - View Data with Device Sync: New page describing how to use Realm Studio to test subscriptions and view Atlas data changes in real time with Device Sync. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-34725): Add docs release notes for w/e Dec 8 (#3105) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34725 * (DOCSP-27349) Update @realm/react reference page (#3071) ## Pull Request Info Jira: https://jira.mongodb.org/browse/DOCSP-27349 Staged Changes: - [RealmProvider (@realm/react)](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-27349/sdk/react-native/api-reference/realm-provider/) - [AppProvider (@realm/react)](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-27349/sdk/react-native/api-reference/app-provider/) - [UserProvider (@realm/react)](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-27349/sdk/react-native/api-reference/user-provider/) ### Description This PR completely revamps the `@realm/react` reference page by splitting it into three pages based on the `@realm/react` providers and hooks. The idea is that we can link to these reference pages from other places in the React Native docs so that we don't need to explain what the providers and hooks are and do in all of the task-based content. Previously, I used tables to communicate information about the providers and hooks. With this update, we wanted to add more information and the tables became unwieldy. So, I migrated away from tables. I took inspiration from the [React documentation](https://react.dev/reference/react/useCallback) and how they handle their API reference docs. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) ### Release Notes - **API Reference** - @realm/react Reference: Removed and distributed across three new pages for AppProvider, UserProvider, and RealmProvider. - AppProvider (@realm/react): New page that has detailed information about the provider and its hooks. - UserProvider (@realm/react): New page that has detailed information about the provider and its hooks. - RealmProvider (@realm/react): New page that has detailed information about the provider and its hooks. ### Animal Wearing a Hat <img src="https://www.mlive.com/resizer/M0BLoRO1eK4SwfEwoTYA90Tlmlk=/1280x0/smart/cloudfront-us-east-1.images.arcpublishing.com/advancelocal/DQFIS44BORCURH2EULX3QVSWNM.jpg" width=400> --------- Co-authored-by: Andrew Meyer <[email protected]> Co-authored-by: lindseymoore <[email protected]> * (DOCSP-34624): Device SDK Landing Page and Intro updates (#3092) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34624 This PR is a proof-of-concept of the initial pass of updating how we talk about Device SDK and Realm on the landing pages and in intro content. Once we're happy with these changes in Swift, I'll apply similar changes to all the SDKs before merging this PR. Staged changes: - [Device SDK Landing Page](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34624/): Renaming and minor wording changes to better reflect Device SDK positioning. - [Introduction](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34624/introduction/): Rework Introduction to combine Intro and Why Realm? pages, add details about Device SDK and how it compares to Drivers. - [Swift SDK Landing Page](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34624/sdk/swift/): Rename most instances of Realm to Device SDK, with minor wording changes to better reflect Device SDK positioning. - [Install (Swift)](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34624/sdk/swift/install/): Rename most instances of Realm to Device SDK, and note that Device SDK wraps Realm and package naming still reflects Realm naming - [Realm Files](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34624/sdk/swift/realm-files/#auxiliary-realm-files): New "Auxiliary Realm Files" section containing info moved from the Database Internals content - [React to Changes](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34624/sdk/swift/react-to-changes/): Move info from "Live Objects" to an intro on the page. As part of this work, I'm removing the "[Why Realm?](https://www.mongodb.com/docs/realm/sdk/swift/realm-database/)" page that currently exists in each SDK. It seemed redundant with the info at the root of the structure, and I don't think we need a specific version of it for each SDK. ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for corresponding docs-realm docs-app-services, if any ### Release Notes - Device SDK Landing Page: Renaming and minor wording changes to better reflect Device SDK positioning. - Introduction: Refactor to combine "Introduction" and "Why Realm?" pages, add details about Device SDK and how it compares to Drivers. - SDK landing pages and Install pages: Update all SDK landing pages and Install pages to reflect Device SDK naming, and clarify the relationship to Realm database and package names. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) --------- Co-authored-by: Kyle Rollins <[email protected]> Co-authored-by: lindseymoore <[email protected]> * (DOCSP-34288) Add `User.Changed` content and example (#3106) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34288 - [Authenticate Users](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-34288/sdk/dotnet/manage-users/authenticate/#observe-authentication-changes): Added information and example for new method that observes user object changes. Notes and other changes: - This new method is a partial implementation. As such, testing the code sample is interesting, but by asserting it returns the type we expect, we can have some confidence. - I also added a Bluehawk script for the .NET SDK. ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Did you tag pages appropriately? - genre - meta.keywords - meta.description - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for related docs-app-services work, if any ### Release Notes - **.NET SDK** - Manage Users/Authenticate Users: Add information and example for new `User.Changed` method that observes user object changes. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-34871): Fix broken links (#3108) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34871 - [CPP/React to Changes](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34871/sdk/cpp/react-to-changes/#register-a-collection-change-listener) - [Flutter/Define a Realm Object Schema](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34871/sdk/flutter/realm-database/model-data/define-realm-object-schema/#generate-the-realmobject) - [Kotlin/Read](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34871/sdk/kotlin/realm-database/crud/read/) - [Kotlin/Manage Sync Sessions](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34871/sdk/kotlin/sync/manage-sync-session/#sync-sessions) - [Kotlin/Write to a Synced Realm](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34871/sdk/kotlin/sync/write-to-synced-realm/#compensating-writes) - [Node.js/Change an Object Model](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34871/sdk/node/model-data/modify-an-object-schema/#delete-a-property) - [React Native/Bootstrap with Expo](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34871/sdk/react-native/bootstrap-with-expo/#prerequisites) - [React Native/Manage Flexible Sync Subscriptions](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34871/sdk/react-native/sync-data/flexible-sync/#manually-manage-subscriptions) - [Swift/Manage Flexible Sync Subscriptions](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34871/sdk/swift/sync/flexible-sync/#wait-for-a-query-subscription-to-sync) ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Did you tag pages appropriately? - genre - meta.keywords - meta.description - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for related docs-app-services work, if any ### Release Notes **Internal** - Throughout docs: Fix broken links. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * (DOCSP-34827) Fix one-character typo in Node.js docs (#3109) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-34827 - [Configure & Open a Synced Realm](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-34827/sdk/node/sync/configure-and-open-a-synced-realm/#open-synced-realm-at-specific-path): Replace `sßet` with `set`. ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Did you tag pages appropriately? - genre - meta.keywords - meta.description - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for related docs-app-services work, if any ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * [Snyk] Security upgrade firebase from 9.23.0 to 10.2.0 (#2966) <h3>Snyk has created this PR to fix one or more vulnerable packages in the `npm` dependencies of this project.</h3> #### Changes included in this PR - Changes to the following files to upgrade the vulnerable dependencies to a fixed version: - examples/web/package.json #### Vulnerabilities that will be fixed ##### With an upgrade: Severity | Priority Score (*) | Issue | Breaking Change | Exploit Maturity :-------------------------:|-------------------------|:-------------------------|:-------------------------|:-------------------------  | **791/1000** <br/> **Why?** Currently trending on Twitter, Proof of Concept exploit, Has a fix available, CVSS 8.6 | Prototype Pollution <br/>[SNYK-JS-PROTOBUFJS-5756498](https://snyk.io/vuln/SNYK-JS-PROTOBUFJS-5756498) | Yes | Proof of Concept (*) Note that the real score may have changed since the PR was raised. <details> <summary><b>Commit messages</b></summary> </br> <details> <summary>Package name: <b>firebase</b></summary> The new version differs by 70 commits.</br> <ul> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/03337aa720d363148394068ae7ed75a3c70efaf5">03337aa</a> Version Packages (#7560)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/b6afe397a2787efd653dc13d68438e17febe7623">b6afe39</a> Merge master into release</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/d1eca5467f60c8d9774f6b6a8eb443d8ffc83fcb">d1eca54</a> Fix changeset checker to write to github output correctly (#7554)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/5dac8b37a974309398317c5231ca6a41af2a48a5">5dac8b3</a> [Auth] Fix auth event uncancellable bug (#7498)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/89fb9fd1716c78a5d23dfd4b1e654f741bde5567">89fb9fd</a> Upgrade webpack to v5 (#7540)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/f497a400a5503db8d807f65a3f3466b8f73cb077">f497a40</a> Fix and skip flaky Firestore tests (#7552)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/040b0b450117f3bd64317e72d16a812d6adfd10f">040b0b4</a> Updates to our contributing guidance (#7526)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/f73b24d0ec0fdc8dea3a8e1c141797d3e7466915">f73b24d</a> Skip large sized bloom filter golden tests (#7537)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/6c7d079231f393196aa68ef8d6463dc32ffce798">6c7d079</a> Raise error if calling initializeRecaptchaConfig in node env (#7284)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/43e402fb49a081a59729290627c7b20099ca46a4">43e402f</a> fix: Update proto loader (#7520)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/c9e2b0b8cd5fd0db3cac7bc3a00629ae34302189">c9e2b0b</a> Add support for validating passwords against the password policy in auth (#7514)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/0038e116b68dc22190a15d99115ff9e904cbd0c5">0038e11</a> Setup firestore tests for named db (#7505)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/f9a232a2970e2f9b8919b6f2fe167e16dcb18d04">f9a232a</a> Separate the implementation of initializeRecaptchaConfig (#7515)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/b395277f3de5d017df7b2edfba329682a0928453">b395277</a> Fix: Aggregate query order-by normalization (#7507)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/e201e5390c32c8ab1d61e5ff34ef1bb7615be62f">e201e53</a> Firestore: equality_matcher.ts: fix missing custom assertion failure message in deep equals (#7519)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/e037eeed61c92375884c2aab3246364f0545b3df">e037eee</a> Export internal interface PrivateSettings for console (#7492)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/80a7f7cd183bce754929d516deecdd23b05027b0">80a7f7c</a> Pin the webdriver version in Firefox test to avoid install failures. (#7504)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/b11cf6127cffbf23dd0c987b77e0a3e0dd977774">b11cf61</a> Merge master into release</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/146b6993ad577b90532878ad4cee66f92d195441">146b699</a> Firestore: query_engine.test.ts: fix logic that checks `configureCsi` (#7501)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/503ca1eda8b0df1af9f039257117d973ec8c9f45">503ca1e</a> Increase GHA artifact retention from 2 to 14 days (#7495)</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/66cebfb6b30345c74d9c18328bdf52d18d703b14">66cebfb</a> Run E2E tests on canary releases #7475</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/a5bf94c3a5fe1dc98a71ea99e21ef44f47d62c25">a5bf94c</a> Firestore: query.test.ts: use a different Firestore instance instead of a WriteBatch</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/223ac18f705626aa21791ecfd6655fc2a6df83fe">223ac18</a> Merge branch 'release'</li> <li><a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/commit/1b9a21d4a72d6684059b7439ed65907ed63ac9b4">1b9a21d</a> Version Packages (#7478)</li> </ul> <a href="https://snyk.io/redirect/github/firebase/firebase-js-sdk/compare/74c3bfbfb64ae62f895e0e5c831b5584f70f6292...03337aa720d363148394068ae7ed75a3c70efaf5">See the full diff</a> </details> </details> Check the changes in this PR to ensure they won't cause issues with your project. ------------ **Note:** *You are seeing this because you or someone else with access to this repository has authorized Snyk to open fix PRs.* For more information: <img src="https://api.segment.io/v1/pixel/track?data=eyJ3cml0ZUtleSI6InJyWmxZcEdHY2RyTHZsb0lYd0dUcVg4WkFRTnNCOUEwIiwiYW5vbnltb3VzSWQiOiIwODhkZmZmMS0yNTY2LTQ3ZTEtODRkMS01ODdhNWVhYzg1NDYiLCJldmVudCI6IlBSIHZpZXdlZCIsInByb3BlcnRpZXMiOnsicHJJZCI6IjA4OGRmZmYxLTI1NjYtNDdlMS04NGQxLTU4N2E1ZWFjODU0NiJ9fQ==" width="0" height="0"/> 🧐 [View latest project report](https://app.snyk.io/org/sandbox-2ba/project/9043c51f-3f0d-45c6-8455-b658274f2872?utm_source=github&utm_medium=referral&page=fix-pr) 🛠 [Adjust project settings](https://app.snyk.io/org/sandbox-2ba/project/9043c51f-3f0d-45c6-8455-b658274f2872?utm_source=github&utm_medium=referral&page=fix-pr/settings) 📚 [Read more about Snyk's upgrade and patch logic](https://support.snyk.io/hc/en-us/articles/360003891078-Snyk-patches-to-fix-vulnerabilities) [//]: # (snyk:metadata:{"prId":"088dfff1-2566-47e1-84d1-587a5eac8546","prPublicId":"088dfff1-2566-47e1-84d1-587a5eac8546","dependencies":[{"name":"firebase","from":"9.23.0","to":"10.2.0"}],"packageManager":"npm","projectPublicId":"9043c51f-3f0d-45c6-8455-b658274f2872","projectUrl":"https://app.snyk.io/org/sandbox-2ba/project/9043c51f-3f0d-45c6-8455-b658274f2872?utm_source=github&utm_medium=referral&page=fix-pr","type":"auto","patch":[],"vulns":["SNYK-JS-PROTOBUFJS-5756498"],"upgrade":["SNYK-JS-PROTOBUFJS-5756498"],"isBreakingChange":true,"env":"prod","prType":"fix","templateVariants":["updated-fix-title","priorityScore"],"priorityScoreList":[791],"remediationStrategy":"vuln"}) --- **Learn how to fix vulnerabilities with free interactive lessons:** 🦉 [Prototype Pollution](https://learn.snyk.io/lesson/prototype-pollution/?loc=fix-pr) Co-authored-by: snyk-bot <[email protected]> * Add a note about removing RN binaries from Electron builds (#2877) ## Pull Request Info ### Jira - No Jira ticket but mentioned in https://github.com/realm/realm-js/issues/5153#issuecomment-1621820049 ### Staged Changes - [PAGE_NAME](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/BRANCH_NAME/) ### Reminder Checklist If your PR modifies the docs, you might need to also update some corresponding pages. Check if completed or N/A. - [ ] Create Jira ticket for corresponding docs-app-services update(s), if any - [ ] Checked/updated Admin API - [ ] Checked/updated CLI reference ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) --------- Co-authored-by: Kyle Rollins <[email protected]> * Kotlin: Update unit test suite for v 1.13.0 (#3111) ## Pull Request Info I had to upgrade a lot of Kotlin docs test suite dependencies in order to successfully upgrade to realm-kotlin version 1.13.0. I've fixed, removed, or commented out failing test assertions after upgrading realm-kotlin versions. A couple of docs tickets rely on these updates, so merging them separately to unblock work on the docs tickets. Running Bluehawk after this PR generates three changes to Serialization code examples based on failing test assertions, but I'm not re-generating those in this PR. I've flagged this info to the Kotlin SDK team and believe this issue may be some kind of bug, so we can rework or fix those examples after I have more info. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * DOCSP-33872: Proguard configuration for RN Android (#3107) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-33872 - [PAGE_NAME](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/BRANCH_NAME/): simple Proguard configuration for React Native on Android ### Reminder Checklist Before merging your PR, make sure to check a few things. - [ ] Did you tag pages appropriately? - genre - meta.keywords - meta.description - [ ] Describe your PR's changes in the Release Notes section - [ ] Create a Jira ticket for related docs-app-services work, if any ### Release Notes <!-- - **Kotlin** SDK - Realm/Manage Realm Files/Encrypt a Realm: Add information on encryption for local and synced realms. --> ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) --------- Co-authored-by: Kyle Rollins <[email protected]> * DOCSP-33752: Atlas Device Sync support for geospatial queries (#3102) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-33572 Staged changes: - .NET - [Geospatial Data Types - .NET SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-33572-geo-sync/sdk/dotnet/model-data/data-types/geospatials/#geospatial-data-types---.net-sdk) - [Manage Flexible Sync Subscriptions- .NET SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-33572-geo-sync/sdk/dotnet/sync/flexible-sync/#manage-your-subscriptions) - Kotlin - [Geospatial Data - Kotlin SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-33572-geo-sync/sdk/kotlin/realm-database/schemas/geospatials/#geospatial-data---kotlin-sdk) - [Manage Sync Subscriptions - Kotlin SDK ](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-33572-geo-sync/sdk/kotlin/sync/subscribe/#std-label-kotlin-subscriptions) - Node.js - [Geospatial - Node.js SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-33572-geo-sync/sdk/node/model-data/data-types/geospatial/) - [Manage Sync Subscriptions - Node.js SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-33572-geo-sync/sdk/node/sync/flexible-sync/#std-label-node-flexible-sync) - React Native - [Geospatial - React Native SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-33572-geo-sync/sdk/react-native/model-data/data-types/geospatial/) - [Manage Sync Subscriptions - React Native SDK](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-33572-geo-sync/sdk/react-native/sync-data/flexible-sync/#subscribe-to-queries) Update relevant SDKs to document the Geospatial support for Atlas Device sync feature (part of Core 13.23.0 upgrade). Update JS and .NET pages with note confirming that you cannot currently persist geo data types (per [reported feedback](https://mongodb.slack.com/archives/CG53S529Y/p1701784480762869)). ### Reminder Checklist Before merging your PR, make sure to check a few things. - [x] Describe your PR's changes in the Release Notes section - [x] Create a Jira ticket for corresponding docs-realm docs-app-services, if any ### Release Notes - .NET SDK - Model Data/Supported Data Types/Geospatial Data: Add version change information describing support for geospatial data in Atlas Device Sync. Add important callout to clarify that you cannot currently persist geospatial data types with the SDK. - Sync Data/Manage Flexible Sync Subscriptions: Add version change information to Manage Your Subscriptions section to note that you can create subscriptions to geospatial queries. - Kotlin SDK - Realm/Model Data/Geospatial Data: Add version change information describing support for geospatial data in Atlas Device Sync. - Sync Device Data/Manage Subscriptions: Add version change information to Subscribe to Object Types subsection to note that you can create subscriptions to geospatial queries. - Node.js SDK - Model Data/Data Types/Geospatial Data: Add version change information describing support for geospatial data in Atlas Device Sync. - Sync Data/Manage Flexible Sync Subscriptions: Add version change information to Subscribe to Queries section to note that you can create subscriptions to geospatial queries. - React Native SDK - Model Data/Data Types/Geospatial Data: Add version change information describing support for geospatial data in Atlas Device Sync. - Sync Data/Manage Flexible Sync Subscriptions: Add version change information to Subscribe to Queries section to note that you can create subscriptions to geospatial queries. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) * DOCSP-35056 Dart upgrade dependencies (#3114) ## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-35056 The following tests are not working: - test/sync_multiple_processes_test.dart - test/authenticate_users_test.dart - test/manage_sync_session_test.dart - test/open_flexible_sync_realm_test.dart * (DOCSP-34055): Swift: Add docs for wait for upload/download (#3076) ## Pull Request Info While the eng PR this documents has been merged to master, it is not yet released. Wait for the next release before publishing. Before publishing: - [x] Update Realm Swift to the release version - [x] Add links to the API reference docs ### Jira - https://jira.mongodb.org/browse/DOCSP-34055 ### Staged Changes - [Manage Sync Sessions](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-34055/sdk/swift/sync/sync…
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For v3.2, v3.4, and master -- sorry! It should merge nicely, though, I think.
First time doing new format of redirects, so please double-check that I've not messed that up 😁
This change is