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

Convert FLE to Typescript

    • Type: Icon: Task Task
    • Resolution: Duplicate
    • Priority: Icon: Unknown Unknown
    • None
    • Affects Version/s: None
    • Component/s: Tooling
    • Not Needed
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?

      Use Case

      As a Node driver engineer,
      I want our FLE bindings to be in Typescript as well,
      So that

      • our development environment is the same across our main repos
      • we can enable linter rules to help prevent bugs
      • we can improve typescript support for FLE for existing users because Typescript would be first class, not an add-on
      • we can streamline our documentation generation for FLE and reduce duplicate type documentation
      • we can use the types from FLE directly in the driver instead of defining them in two places
      • we can use driver types where applicable in FLE

      User Impact

      tbd

      Dependencies

      • upstream and/or downstream requirements and timelines to bear in mind

      Unknowns

      • will the c++ bindings make typescript more complex?  I would guess no, but I'm not sure.
      • Should we continue to use the module "extension" that we currently use to export from mongodb-client-encryption or should we directly export from libmongocrypt?
      • Will this cause compatibility issues with version 3x of the driver?
      • Should the types live in a separate npm package that the driver can directly depend on? 

      Acceptance Criteria

      tbd

      Implementation Requirements

      • tbd

      Testing Requirements

      • set up tsd and add type tests to relevant types
      • additional tests tbd

      Documentation Requirements

      • docsp ticket maybe? 
      • set up tsdoc to build api documentation (perhaps)

            Assignee:
            Unassigned Unassigned
            Reporter:
            bailey.pearson@mongodb.com Bailey Pearson
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: