move to use dedicated @gentype.satisfies

Author: zth

compiler/gentype/Annotation.ml

@@ -29,10 +29,14 @@ let tag_is_tag s = s = "tag"
 let tag_is_unboxed s = s = "unboxed" || s = "ocaml.unboxed"
 let tag_is_gentype_import s = s = "genType.import" || s = "gentype.import"
 let tag_is_gentype_opaque s = s = "genType.opaque" || s = "gentype.opaque"
+let tag_is_gentype_satisfies s = s = "genType.satisfies" || s = "gentype.satisfies"
 
 let tag_is_one_of_the_gentype_annotations s =
-  tag_is_gentype s || tag_is_gentype_as s || tag_is_gentype_import s
+  tag_is_gentype s
+  || tag_is_gentype_as s
+  || tag_is_gentype_import s
   || tag_is_gentype_opaque s
+  || tag_is_gentype_satisfies s
 
 let tag_is_gentype_ignore_interface s =
   s = "genType.ignoreInterface" || s = "gentype.ignoreInterface"
@@ -169,6 +173,25 @@ let get_attribute_import_renaming attributes =
     (Some import_string, gentype_as_renaming, None, Some rename_string)
   | _ -> (None, gentype_as_renaming, None, None)
 
+let get_attribute_satisfies attributes =
+  match attributes |> get_attribute_payload tag_is_gentype_satisfies with
+  | Some (_loc, TuplePayload payloads) -> (
+    let strings =
+      payloads
+      |> List.fold_left
+           (fun acc p ->
+             match p with
+             | StringPayload s -> s :: acc
+             | _ -> acc)
+           []
+      |> List.rev
+    in
+    match strings with
+    | [] -> None
+    | import_str :: path -> Some (import_str, path))
+  | Some (_loc, StringPayload s) -> Some (s, [])
+  | _ -> None
+
 let get_tag attributes =
   match attributes |> get_attribute_payload tag_is_tag with
   | Some (_, StringPayload s) -> Some s

compiler/gentype/EmitJs.ml

@@ -680,6 +680,11 @@ let emit_translation_as_string ~(config : Config.t) ~file_name
          ~input_cmt_translate_type_declarations ~output_file_relative ~resolver
          ~type_name_is_interface
   in
+  let emitters =
+    match config.emit_satisfies_helper with
+    | true -> EmitType.emit_satisfies_helper ~emitters
+    | false -> emitters
+  in
   let env, emitters =
     export_from_type_declarations
     |> emit_export_from_type_declarations ~config ~emitters ~env

compiler/gentype/EmitType.ml

@@ -424,6 +424,12 @@ let require ~early =
 let emit_import_react ~emitters =
   "import * as React from 'react';" |> require ~early:true ~emitters
 
+let emit_satisfies_helper ~emitters =
+  let alias =
+    "export type $RescriptTypeSatisfiesTypeScriptType<RescriptType, TypeScriptType extends RescriptType> = TypeScriptType;"
+  in
+  Emitters.export_early ~emitters alias
+
 let emit_import_type_as ~emitters ~config ~type_name ~as_type_name
     ~type_name_is_interface ~import_path =
   let type_name = sanitize_type_name type_name in

compiler/gentype/GenTypeCommon.ml

@@ -180,10 +180,13 @@ let ident ?(builtin = true) ?(type_args = []) name =
   Ident {builtin; name; type_args}
 
 let sanitize_type_name name =
-  name
-  |> String.map (function
-       | '\'' -> '_'
-       | c -> c)
+  (* Preserve TS import("...") expressions intact. *)
+  if String.length name >= 7 && String.sub name 0 7 = "import(" then name
+  else
+    name
+    |> String.map (function
+         | '\'' -> '_'
+         | c -> c)
 let unknown = ident "unknown"
 let bigint_t = ident "BigInt"
 let boolean_t = ident "boolean"

compiler/gentype/GenTypeConfig.ml

@@ -17,6 +17,7 @@ type t = {
   bs_dependencies: string list;
   mutable emit_import_curry: bool;
   mutable emit_import_react: bool;
+  mutable emit_satisfies_helper: bool;
   mutable emit_type_prop_done: bool;
   mutable everything: bool;
   export_interfaces: bool;
@@ -37,6 +38,7 @@ let default =
     bs_dependencies = [];
     emit_import_curry = false;
     emit_import_react = false;
+    emit_satisfies_helper = false;
     emit_type_prop_done = false;
     everything = false;
     export_interfaces = false;
@@ -228,6 +230,7 @@ let read_config ~get_config_file ~namespace =
       suffix;
       emit_import_curry = false;
       emit_import_react = false;
+      emit_satisfies_helper = false;
       emit_type_prop_done = false;
       everything;
       export_interfaces;

compiler/gentype/TranslateTypeDeclarations.ml

@@ -62,6 +62,30 @@ let traslate_declaration_kind ~config ~loc ~output_file_relative ~resolver
   let import_string_opt, name_as, _import_exact_opt, remote_export_name_opt =
     type_attributes |> Annotation.get_attribute_import_renaming
   in
+  let satisfies_opt = type_attributes |> Annotation.get_attribute_satisfies in
+  let annotation_for_export =
+    match satisfies_opt with
+    | Some _ -> Annotation.GenType
+    | None -> annotation
+  in
+  let apply_satisfies_wrapper type_ =
+    match satisfies_opt with
+    | None -> type_
+    | Some (import_str, path) ->
+      (* Ensure we emit the helper once. *)
+      config.emit_satisfies_helper <- true;
+      let import_path = ImportPath.from_string_unsafe import_str in
+      let import_path_str = ImportPath.emit import_path in
+      let inline_import =
+        let base = "import(\"" ^ import_path_str ^ "\")" in
+        match path with
+        | [] -> base
+        | _ -> base ^ "." ^ String.concat "." path
+      in
+      let ts_type = ident ~builtin:true inline_import in
+      ident ~builtin:true ~type_args:[type_; ts_type]
+        "$RescriptTypeSatisfiesTypeScriptType"
+  in
   let unboxed_annotation =
     type_attributes |> Annotation.has_attribute Annotation.tag_is_unboxed
   in
@@ -75,8 +99,11 @@ let traslate_declaration_kind ~config ~loc ~output_file_relative ~resolver
       (translation : TranslateTypeExprFromTypes.translation) =
     let export_from_type_declaration =
       type_name
-      |> create_export_type_from_type_declaration ~annotation ~loc ~name_as
-           ~opaque ~type_:translation.type_ ~type_env ~doc_string ~type_vars
+      |> create_export_type_from_type_declaration ~annotation:annotation_for_export
+           ~loc ~name_as
+           ~opaque
+           ~type_:(apply_satisfies_wrapper translation.type_)
+           ~type_env ~doc_string ~type_vars
     in
     let import_types =
       translation.dependencies
@@ -220,7 +247,8 @@ let traslate_declaration_kind ~config ~loc ~output_file_relative ~resolver
           ~polymorphic:true ~tag:None ~unboxed:false
       | _ -> translation.type_
     in
-    {translation with type_} |> handle_general_declaration
+    {translation with type_ = apply_satisfies_wrapper type_}
+    |> handle_general_declaration
     |> return_type_declaration
   | RecordDeclarationFromTypes label_declarations, None ->
     let {TranslateTypeExprFromTypes.dependencies; type_} =
@@ -235,8 +263,10 @@ let traslate_declaration_kind ~config ~loc ~output_file_relative ~resolver
       CodeItem.import_types;
       export_from_type_declaration =
         type_name
-        |> create_export_type_from_type_declaration ~doc_string ~annotation ~loc
-             ~name_as ~opaque ~type_ ~type_env ~type_vars;
+        |> create_export_type_from_type_declaration ~doc_string
+             ~annotation:annotation_for_export ~loc
+             ~name_as ~opaque ~type_:(apply_satisfies_wrapper type_)
+             ~type_env ~type_vars;
     }
     |> return_type_declaration
   | VariantDeclarationFromTypes constructor_declarations, None ->
@@ -302,12 +332,12 @@ let traslate_declaration_kind ~config ~loc ~output_file_relative ~resolver
             loc;
             name_as;
             opaque;
-            type_ = variant_typ;
+            type_ = apply_satisfies_wrapper variant_typ;
             type_vars;
             resolved_type_name;
             doc_string;
           };
-        annotation;
+        annotation = annotation_for_export;
       }
     in
     let import_types =

lib/rescript.lock

@@ -1 +1 @@
-69167
+45559

tests/gentype_tests/genimport-single/src/AriaComponents.gen.tsx

@@ -3,6 +3,12 @@
 /* eslint-disable */
 /* tslint:disable */
 
-import type {GroupRenderProps as GroupRenderProps$TypeScript} from 'react-aria-components';
+export type $RescriptTypeSatisfiesTypeScriptType<RescriptType, TypeScriptType extends RescriptType> = TypeScriptType;
 
-export type groupRenderProps = GroupRenderProps$TypeScript;
+export type groupRenderProps = $RescriptTypeSatisfiesTypeScriptType<{
+  readonly isHovered: boolean; 
+  readonly isFocusWithin: boolean; 
+  readonly isFocusVisible: boolean; 
+  readonly isDisabled: boolean; 
+  readonly isInvalid: boolean
+},import("react-aria-components").GroupRenderProps>;

tests/gentype_tests/genimport-single/src/AriaComponents.res

@@ -1,4 +1,4 @@
-@genType.import(("react-aria-components", "GroupRenderProps"))
+@gentype.satisfies(("react-aria-components", "GroupRenderProps"))
 type groupRenderProps = {
   isHovered: bool,
   isFocusWithin: bool,

tests/gentype_tests/typescript-react-example/src/ImportHookDefault.gen.tsx

@@ -3,7 +3,7 @@
 /* eslint-disable */
 /* tslint:disable */
 
-import {default as makeNotChecked} from './hookExample';
+import {make as makeNotChecked} from './hookExample';
 
 import {default as defaultNotChecked} from './hookExample';