Allow overrides for disallowed types (e.g. 64 bit integers)

core/data/tests/can_override_disallowed_types/input.rs

@@ -0,0 +1,10 @@
+#[typeshare]
+struct DisallowedType {
+    #[typeshare(typescript(type = "bigint"))]
+    disallowed_type: u64,
+    #[typeshare(typescript(type = "number"))]
+    another_disallowed_type: i64,
+    #[typeshare(typescript(type = "string"))]
+    #[serde(with = "my_string_serde_impl")]
+    disallowed_type_serde_with: u64,
+}

core/data/tests/can_override_disallowed_types/output.go

@@ -0,0 +1,9 @@
+package proto
+
+import "encoding/json"
+
+type DisallowedType struct {
+	DisallowedType uint64 `json:"disallowed_type"`
+	AnotherDisallowedType int64 `json:"another_disallowed_type"`
+	DisallowedTypeSerdeWith uint64 `json:"disallowed_type_serde_with"`
+}

core/data/tests/can_override_disallowed_types/output.kt

@@ -0,0 +1,12 @@
+package com.agilebits.onepassword
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.SerialName
+
+@Serializable
+data class DisallowedType (
+	val disallowed_type: ULong,
+	val another_disallowed_type: Long,
+	val disallowed_type_serde_with: ULong
+)
+

core/data/tests/can_override_disallowed_types/output.scala

@@ -0,0 +1,19 @@
+package com.agilebits
+
+package object onepassword {
+
+type UByte = Byte
+type UShort = Short
+type UInt = Int
+type ULong = Int
+
+}
+package onepassword {
+
+case class DisallowedType (
+	disallowed_type: ULong,
+	another_disallowed_type: Long,
+	disallowed_type_serde_with: ULong
+)
+
+}

core/data/tests/can_override_disallowed_types/output.swift

@@ -0,0 +1,13 @@
+import Foundation
+
+public struct DisallowedType: Codable {
+	public let disallowed_type: UInt64
+	public let another_disallowed_type: Int64
+	public let disallowed_type_serde_with: UInt64
+
+	public init(disallowed_type: UInt64, another_disallowed_type: Int64, disallowed_type_serde_with: UInt64) {
+		self.disallowed_type = disallowed_type
+		self.another_disallowed_type = another_disallowed_type
+		self.disallowed_type_serde_with = disallowed_type_serde_with
+	}
+}

core/data/tests/can_override_disallowed_types/output.ts

@@ -0,0 +1,6 @@
+export interface DisallowedType {
+	disallowed_type: bigint;
+	another_disallowed_type: number;
+	disallowed_type_serde_with: string;
+}
+

core/data/tests/can_override_pointer_sized_types/input.rs

@@ -0,0 +1,15 @@
+#[typeshare]
+struct PointerSizedType {
+    #[typeshare(kotlin(type = "ULong"))]
+    #[typeshare(scala(type = "ULong"))]
+    #[typeshare(swift(type = "UInt64"))]
+    #[typeshare(typescript(type = "number"))]
+    #[typeshare(go(type = "uint64"))]
+    unsigned: usize,
+    #[typeshare(kotlin(type = "Long"))]
+    #[typeshare(scala(type = "Long"))]
+    #[typeshare(swift(type = "Int64"))]
+    #[typeshare(typescript(type = "number"))]
+    #[typeshare(go(type = "int64"))]
+    signed: isize,
+}

core/data/tests/can_override_pointer_sized_types/output.go

@@ -0,0 +1,8 @@
+package proto
+
+import "encoding/json"
+
+type PointerSizedType struct {
+	Unsigned uint64 `json:"unsigned"`
+	Signed int64 `json:"signed"`
+}

core/data/tests/can_override_pointer_sized_types/output.kt

@@ -0,0 +1,11 @@
+package com.agilebits.onepassword
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.SerialName
+
+@Serializable
+data class PointerSizedType (
+	val unsigned: ULong,
+	val signed: Long
+)
+

core/data/tests/can_override_pointer_sized_types/output.scala

@@ -0,0 +1,18 @@
+package com.agilebits
+
+package object onepassword {
+
+type UByte = Byte
+type UShort = Short
+type UInt = Int
+type ULong = Int
+
+}
+package onepassword {
+
+case class PointerSizedType (
+	unsigned: ULong,
+	signed: Long
+)
+
+}

core/data/tests/can_override_pointer_sized_types/output.swift

@@ -0,0 +1,11 @@
+import Foundation
+
+public struct PointerSizedType: Codable {
+	public let unsigned: UInt64
+	public let signed: Int64
+
+	public init(unsigned: UInt64, signed: Int64) {
+		self.unsigned = unsigned
+		self.signed = signed
+	}
+}

core/data/tests/can_override_pointer_sized_types/output.ts

@@ -0,0 +1,5 @@
+export interface PointerSizedType {
+	unsigned: number;
+	signed: number;
+}
+

core/src/language/go.rs

@@ -156,9 +156,7 @@ impl Language for Go {
             | SpecialRustType::U8
             | SpecialRustType::U16
             | SpecialRustType::I32
-            | SpecialRustType::I16
-            | SpecialRustType::ISize
-            | SpecialRustType::USize => "int".into(),
+            | SpecialRustType::I16 => "int".into(),
             SpecialRustType::U32 => "uint32".into(),
             SpecialRustType::I54 | SpecialRustType::I64 => "int64".into(),
             SpecialRustType::U53 | SpecialRustType::U64 => "uint64".into(),
@@ -169,6 +167,12 @@ impl Language for Go {
                 self.add_import("time");
                 "time.Time".into()
             }
+            SpecialRustType::ISize | SpecialRustType::USize => {
+                panic!(
+                    "Pointer-sized types require an explicit output type. \
+                    See: https://1password.github.io/typeshare/usage/annotations.html#special-note-on-pointer-sized-types for more information."
+                )
+            }
         })
     }
 

core/src/language/kotlin.rs

@@ -79,12 +79,12 @@ impl Language for Kotlin {
             // https://kotlinlang.org/docs/basic-types.html#integer-types
             SpecialRustType::I8 => "Byte".into(),
             SpecialRustType::I16 => "Short".into(),
-            SpecialRustType::ISize | SpecialRustType::I32 => "Int".into(),
+            SpecialRustType::I32 => "Int".into(),
             SpecialRustType::I54 | SpecialRustType::I64 => "Long".into(),
             // https://kotlinlang.org/docs/basic-types.html#unsigned-integers
             SpecialRustType::U8 => "UByte".into(),
             SpecialRustType::U16 => "UShort".into(),
-            SpecialRustType::USize | SpecialRustType::U32 => "UInt".into(),
+            SpecialRustType::U32 => "UInt".into(),
             SpecialRustType::U53 | SpecialRustType::U64 => "ULong".into(),
             SpecialRustType::Bool => "Boolean".into(),
             SpecialRustType::F32 => "Float".into(),
@@ -95,6 +95,12 @@ impl Language for Kotlin {
                     special_ty.to_string(),
                 ))
             }
+            SpecialRustType::ISize | SpecialRustType::USize => {
+                panic!(
+                    "Pointer-sized types require an explicit output type. \
+                    See: https://1password.github.io/typeshare/usage/annotations.html#special-note-on-pointer-sized-types for more information."
+                )
+            }
         })
     }
 

core/src/language/scala.rs

@@ -102,12 +102,12 @@ impl Language for Scala {
             SpecialRustType::String | SpecialRustType::Char => "String".into(),
             SpecialRustType::I8 => "Byte".into(),
             SpecialRustType::I16 => "Short".into(),
-            SpecialRustType::ISize | SpecialRustType::I32 => "Int".into(),
+            SpecialRustType::I32 => "Int".into(),
             SpecialRustType::I54 | SpecialRustType::I64 => "Long".into(),
             // Scala does not support unsigned integers, so upcast it to the closest one
             SpecialRustType::U8 => "UByte".into(),
             SpecialRustType::U16 => "UShort".into(),
-            SpecialRustType::USize | SpecialRustType::U32 => "UInt".into(),
+            SpecialRustType::U32 => "UInt".into(),
             SpecialRustType::U53 | SpecialRustType::U64 => "ULong".into(),
             SpecialRustType::Bool => "Boolean".into(),
             SpecialRustType::F32 => "Float".into(),
@@ -118,6 +118,12 @@ impl Language for Scala {
                     special_ty.to_string(),
                 ))
             }
+            SpecialRustType::ISize | SpecialRustType::USize => {
+                panic!(
+                    "Pointer-sized types require an explicit output type. \
+                    See: https://1password.github.io/typeshare/usage/annotations.html#special-note-on-pointer-sized-types for more information."
+                )
+            }
         })
     }
 

core/src/language/swift.rs

@@ -206,8 +206,6 @@ impl Language for Swift {
             SpecialRustType::U8 => "UInt8".into(),
             SpecialRustType::I16 => "Int16".into(),
             SpecialRustType::U16 => "UInt16".into(),
-            SpecialRustType::USize => "UInt".into(),
-            SpecialRustType::ISize => "Int".into(),
             SpecialRustType::I32 => "Int32".into(),
             SpecialRustType::U32 => "UInt32".into(),
             SpecialRustType::I54 | SpecialRustType::I64 => "Int64".into(),
@@ -221,6 +219,12 @@ impl Language for Swift {
                     special_ty.to_string(),
                 ))
             }
+            SpecialRustType::ISize | SpecialRustType::USize => {
+                panic!(
+                    "Pointer-sized types require an explicit output type. \
+                    See: https://1password.github.io/typeshare/usage/annotations.html#special-note-on-pointer-sized-types for more information."
+                )
+            }
         })
     }
 

core/src/language/typescript.rs

@@ -128,11 +128,17 @@ export const ReplacerFunc = (key: string, value: unknown): unknown => {{
             | SpecialRustType::F32
             | SpecialRustType::F64 => Ok("number".into()),
             SpecialRustType::Bool => Ok("boolean".into()),
-            SpecialRustType::U64
-            | SpecialRustType::I64
-            | SpecialRustType::ISize
-            | SpecialRustType::USize => {
-                panic!("64 bit types not allowed in Typeshare")
+            SpecialRustType::U64 | SpecialRustType::I64 => {
+                panic!(
+                    "64 bit integer types require an explicit output type for TypeScript. \
+                    See: https://1password.github.io/typeshare/usage/annotations.html#special-note-on-64-bit-integer-types for more information."
+                )
+            }
+            SpecialRustType::ISize | SpecialRustType::USize => {
+                panic!(
+                    "Pointer-sized types require an explicit output type. \
+                    See: https://1password.github.io/typeshare/usage/annotations.html#special-note-on-pointer-sized-types for more information."
+                )
             }
         }
     }

core/src/rust_types.rs

@@ -387,13 +387,14 @@ impl TryFrom<&syn::Type> for RustType {
                     "u16" => Self::Special(SpecialRustType::U16),
                     "u32" => Self::Special(SpecialRustType::U32),
                     "U53" => Self::Special(SpecialRustType::U53),
-                    "u64" | "i64" | "usize" | "isize" => {
-                        return Err(RustTypeParseError::UnsupportedType(vec![id]))
-                    }
+                    "u64" => Self::Special(SpecialRustType::U64),
+                    "usize" => Self::Special(SpecialRustType::USize),
                     "i8" => Self::Special(SpecialRustType::I8),
                     "i16" => Self::Special(SpecialRustType::I16),
                     "i32" => Self::Special(SpecialRustType::I32),
                     "I54" => Self::Special(SpecialRustType::I54),
+                    "i64" => Self::Special(SpecialRustType::I64),
+                    "isize" => Self::Special(SpecialRustType::ISize),
                     "f32" => Self::Special(SpecialRustType::F32),
                     "f64" => Self::Special(SpecialRustType::F64),
                     _ => {

core/tests/agnostic_tests.rs

@@ -3,7 +3,6 @@ use typeshare_core::{
     context::{ParseContext, ParseFileContext},
     language::{CrateTypes, Language, TypeScript},
     parser::{self, ParseError},
-    rust_types::RustTypeParseError,
     ProcessInputError,
 };
 /// Parse and generate types for a single Rust input file.
@@ -36,68 +35,6 @@ pub fn process_input(
     Ok(())
 }
 
-mod blocklisted_types {
-    use std::collections::HashMap;
-
-    use super::*;
-
-    fn assert_type_is_blocklisted(ty: &str, blocklisted_type: &str) {
-        let source = format!(
-            r##"
-    #[typeshare]
-    #[serde(default, rename_all = "camelCase")]
-    pub struct Foo {{
-        pub bar: {ty},
-    }}
-    "##,
-            ty = ty
-        );
-
-        let mut out: Vec<u8> = Vec::new();
-        assert!(matches!(
-            process_input(&source, &mut TypeScript::default(), &HashMap::new(), &mut out),
-            Err(ProcessInputError::ParseError(
-                ParseError::RustTypeParseError(RustTypeParseError::UnsupportedType(contents))
-            )) if contents == vec![blocklisted_type.to_owned()]
-        ));
-    }
-
-    #[test]
-    fn test_i64_blocklisted_struct() {
-        assert_type_is_blocklisted("i64", "i64");
-    }
-
-    #[test]
-    fn test_u64_blocklisted_struct() {
-        assert_type_is_blocklisted("u64", "u64");
-    }
-
-    #[test]
-    fn test_isize_blocklisted_struct() {
-        assert_type_is_blocklisted("isize", "isize");
-    }
-
-    #[test]
-    fn test_usize_blocklisted_in_struct() {
-        assert_type_is_blocklisted("usize", "usize");
-    }
-
-    #[test]
-    fn test_optional_blocklisted_struct() {
-        assert_type_is_blocklisted("Option<i64>", "i64");
-    }
-
-    #[test]
-    fn test_vec_blocklisted_struct() {
-        assert_type_is_blocklisted("Vec<i64>", "i64");
-    }
-
-    #[test]
-    fn test_hashmap_blocklisted_struct() {
-        assert_type_is_blocklisted("HashMap<String, i64>", "i64");
-    }
-}
-
 mod serde_attributes_on_enums {
     use std::collections::HashMap;
 

core/tests/snapshot_tests.rs

@@ -557,6 +557,8 @@ tests! {
         python
     ];
     can_override_types: [swift, kotlin, scala, typescript, go];
+    can_override_disallowed_types: [swift, kotlin, scala, typescript, go];
+    can_override_pointer_sized_types: [swift, kotlin, scala, typescript, go];
 
     /// Structs
     can_generate_simple_struct_with_a_comment: [kotlin, swift, typescript, scala, go, python];