Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-4738

Remove dot notation typescript support by default

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Unknown Unknown
    • 5.0.0
    • Affects Version/s: None
    • Component/s: None
    • 3
    • Not Needed
    • Needed
    • Hide

      V5 of the driver will remove dot notation support by default. We will still provide the types we use to provide dot notation in 4x, but they will be marked as experimental and they will not be used by the driver.

      Show
      V5 of the driver will remove dot notation support by default. We will still provide the types we use to provide dot notation in 4x, but they will be marked as experimental and they will not be used by the driver.

      Use Case

      As a user of the node driver collection types
      I want to not have a negative impact on my code base because of dot notation support
      So that I can use advanced types and have fast compilation times

      User Impact

      • Improves experience for existing users of the driver; removes a nice to have IDE feature for new users of the driver

      Dependencies

      • None, but this is a breaking change

      Unknowns

      • Is there an easy way to make this opt-in rather than removed altogether?

      Acceptance Criteria

      • Rename dot notation support type and mark as experimental
      • Remove dot notation support from find and update APIs
      • Document change in the migration guide
        • Make sure documentation is clear that this is a TS only change, runtime dot notation is not impacted

      Implementation Requirements

      • TBD

      Testing Requirements

      • Ensure existing tests still pass for non-dot-notation related TS
      • Add tests to ensure recursive schemas are fully supported

      Documentation Requirements

      • Will need doc updates

      Follow Up Requirements

      • May want to file follow up ticket to design opt-in dot notation support
        • Support for dot notation in the follow up ticket should account for the type vs interface issue reported in NODE-4587

            Assignee:
            bailey.pearson@mongodb.com Bailey Pearson
            Reporter:
            daria.pardue@mongodb.com Daria Pardue
            Durran Jordan
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: