flow-api-translator 0.331.0 → 0.332.0

package/README.md

@@ -29,6 +29,23 @@ await fs.writeFile('output/myFile.d.ts', translate.translateFlowToTSDef(sourceFi
 await fs.writeFile('output/myFile.js', translate.translateFlowToJS(sourceFile, prettierConfig));
 ```
 
+By default, documentation remains attached to the declaration it originally
+described. To associate that documentation with a generated default-export
+symbol, pass `defaultExportDocPlacement` to either definition translator:
+
+```
+await fs.writeFile(
+  'output/myFile.d.ts',
+  translate.translateFlowToTSDef(sourceFile, prettierConfig, {
+    defaultExportDocPlacement: 'export',
+  }),
+);
+```
+
+The supported placements are `declaration` (the default), `export`, and `both`.
+`both` retains the documentation on the original declaration as well as
+attaching it to the default export.
+
 ### Flow (with Haste modules) -> TS Lib
 
 Haste module paths are commonly used with Flow libraries. TypeScript does not support this so they needs to be converted back to relative paths first:

package/dist/TSDefToFlowDef.js

@@ -264,11 +264,15 @@ const getTransforms = (originalCode, opts) => {
           value: node.source.value,
           raw: node.source.raw
         });
-        const specifiers = node.specifiers.map(specifier => constructFlowNode({
-          type: 'ExportSpecifier',
-          local: Transform.Identifier(specifier.local),
-          exported: Transform.Identifier(specifier.exported)
-        }));
+        const specifiers = node.specifiers.map(specifier => {
+          var _specifier$exportKind;
+          return constructFlowNode({
+            type: 'ExportSpecifier',
+            local: Transform.Identifier(specifier.local),
+            exported: Transform.Identifier(specifier.exported),
+            exportKind: (_specifier$exportKind = specifier.exportKind) != null ? _specifier$exportKind : 'value'
+          });
+        });
         return constructFlowNode({
           type: 'DeclareExportDeclaration',
           declaration: null,
@@ -318,7 +322,8 @@ const getTransforms = (originalCode, opts) => {
               specifiers: [constructFlowNode({
                 type: 'ExportSpecifier',
                 local: decl.id,
-                exported: decl.id
+                exported: decl.id,
+                exportKind: 'value'
               })]
             })];
           }
@@ -814,6 +819,9 @@ const getTransforms = (originalCode, opts) => {
       const namesRev = [];
       while (qualifier.type !== 'Identifier') {
         namesRev.push(qualifier.id.name);
+        if (qualifier.qualification.type === 'ImportType') {
+          return unsupportedAnnotation(node, 'nested import types in import type qualifiers');
+        }
         qualifier = qualifier.qualification;
       }
       namesRev.push(qualifier.name);
@@ -949,10 +957,12 @@ const getTransforms = (originalCode, opts) => {
         keyTparam,
         propType: Transform.TSTypeAnnotationOpt(node.typeAnnotation),
         sourceType,
-        variance: node.readonly === '+' || Boolean(node.readonly) ? constructFlowNode({
+        nameType: node.nameType == null ? null : Transform.TSTypeAnnotation(node.nameType),
+        variance: node.readonly != null && node.readonly !== false ? constructFlowNode({
           type: 'Variance',
           kind: 'plus'
         }) : null,
+        varianceOp: node.readonly === '+' ? '+' : node.readonly === '-' ? '-' : null,
         optional: node.optional === '+' ? 'PlusOptional' : node.optional === '-' ? 'MinusOptional' : Boolean(node.optional) ? 'Optional' : null
       });
       return constructFlowNode({

package/dist/TSDefToFlowDef.js.flow

@@ -391,6 +391,7 @@ const getTransforms = (originalCode: string, opts: TranslationOptions) => {
             type: 'ExportSpecifier',
             local: Transform.Identifier(specifier.local),
             exported: Transform.Identifier(specifier.exported),
+            exportKind: specifier.exportKind ?? 'value',
           }),
         );
         return constructFlowNode<FlowESTree.DeclareExportDeclarationNamedWithSpecifiers>(
@@ -465,6 +466,7 @@ const getTransforms = (originalCode: string, opts: TranslationOptions) => {
                   type: 'ExportSpecifier',
                   local: decl.id,
                   exported: decl.id,
+                  exportKind: 'value',
                 }),
               ],
             }),
@@ -1063,10 +1065,18 @@ const getTransforms = (originalCode: string, opts: TranslationOptions) => {
       if (node.qualifier == null) {
         return base;
       }
-      let qualifier = Transform.EntityNameToTypeIdentifier(node.qualifier);
+      let qualifier:
+        FlowESTree.Identifier | FlowESTree.QualifiedTypeIdentifier =
+        Transform.EntityNameToTypeIdentifier(node.qualifier);
       const namesRev: Array<string> = [];
       while (qualifier.type !== 'Identifier') {
         namesRev.push(qualifier.id.name);
+        if (qualifier.qualification.type === 'ImportType') {
+          return unsupportedAnnotation(
+            node,
+            'nested import types in import type qualifiers',
+          );
+        }
         qualifier = qualifier.qualification;
       }
       namesRev.push(qualifier.name);
@@ -1267,13 +1277,19 @@ const getTransforms = (originalCode: string, opts: TranslationOptions) => {
         keyTparam,
         propType: Transform.TSTypeAnnotationOpt(node.typeAnnotation),
         sourceType,
+        nameType:
+          node.nameType == null
+            ? null
+            : Transform.TSTypeAnnotation(node.nameType),
         variance:
-          node.readonly === '+' || Boolean(node.readonly)
+          node.readonly != null && node.readonly !== false
             ? constructFlowNode<FlowESTree.Variance>({
                 type: 'Variance',
                 kind: 'plus',
               })
             : null,
+        varianceOp:
+          node.readonly === '+' ? '+' : node.readonly === '-' ? '-' : null,
         optional:
           node.optional === '+'
             ? 'PlusOptional'