Merge pull request #1168 from IntersectMBO/improve-comment-for-object-type

cardano-wasm: Add examples of object type names to objectType typescript documentation

Author: palas

cardano-wasm/lib-wrapper/cardano-api.d.ts

@@ -12,6 +12,8 @@ import Wallet from './wallet';
 declare interface CardanoApi {
     /**
      * The type of the object, used for identification (the "CardanoApi" string).
+     * Other types of objects would be:
+     * "GrpcConnection", "SignedTx", "UnsignedTx", and "Wallet"
      */
     objectType: string;
 

cardano-wasm/lib-wrapper/grpc-connection.d.ts

@@ -6,6 +6,8 @@
 declare interface GrpcConnection {
     /**
      * The type of the object, used for identification (the "GrpcConnection" string).
+     * Other types of objects would be:
+     * "CardanoApi", "SignedTx", "UnsignedTx", and "Wallet"
      */
     objectType: string;
 

cardano-wasm/lib-wrapper/signed-tx.d.ts

@@ -6,6 +6,8 @@
 declare interface SignedTx {
     /**
      * The type of the object, used for identification (the "SignedTx" string).
+     * Other types of objects would be:
+     * "CardanoApi", "GrpcConnection", "UnsignedTx", and "Wallet"
      */
     objectType: string;
 

cardano-wasm/lib-wrapper/unsigned-tx.d.ts

@@ -8,6 +8,8 @@ import SignedTx from './signed-tx';
 declare interface UnsignedTx {
     /**
      * The type of the object, used for identification (the "UnsignedTx" string).
+     * Other types of objects would be:
+     * "CardanoApi", "GrpcConnection", "SignedTx", and "Wallet"
      */
     objectType: string;
 

cardano-wasm/lib-wrapper/wallet.d.ts

@@ -6,6 +6,8 @@
 declare interface Wallet {
     /**
      * The type of the object, used for identification (the "Wallet" string).
+     * Other types of objects would be:
+     * "CardanoApi", "GrpcConnection", "SignedTx", and "UnsignedTx"
      */
     objectType: string;
 

cardano-wasm/src-lib/Cardano/Wasm/Api/InfoToTypeScript.hs

@@ -16,6 +16,7 @@ apiInfoToTypeScriptFile apiInfo =
       { TypeScript.typeScriptFileName = Info.dashCaseName (Info.mainObject apiInfo) <> ".d.ts"
       , TypeScript.typeScriptFileContent =
           virtualObjectInfoToInterfaceDecs
+            mainObjectName
             False
             voMap
             (Info.mainObject apiInfo)
@@ -38,10 +39,12 @@ apiInfoToTypeScriptFile apiInfo =
     : virtualObjectInterfaces
  where
   virtualObjectInterfaces =
-    map (virtualObjectInfoToTypeScriptFile voMap) (Info.virtualObjects apiInfo)
+    map (virtualObjectInfoToTypeScriptFile mainObjectName voMap) (Info.virtualObjects apiInfo)
 
   voMap = Map.fromList [(Info.virtualObjectName vo, vo) | vo <- Info.virtualObjects apiInfo]
 
+  mainObjectName = Info.virtualObjectName $ Info.mainObject apiInfo
+
 importDeclaration :: Info.VirtualObjectInfo -> TypeScript.Declaration
 importDeclaration vo =
   TypeScript.Declaration
@@ -69,16 +72,27 @@ flattenMethods = concatMap flattenMethods'
   flattenMethods' (Info.MethodGroupEntry (Info.MethodGroup{Info.groupMethods = methods})) = flattenMethods methods
 
 virtualObjectInfoToTypeScriptFile
-  :: Map String Info.VirtualObjectInfo -> Info.VirtualObjectInfo -> TypeScript.TypeScriptFile
-virtualObjectInfoToTypeScriptFile voMap vo =
+  :: String -> Map String Info.VirtualObjectInfo -> Info.VirtualObjectInfo -> TypeScript.TypeScriptFile
+virtualObjectInfoToTypeScriptFile mainObjectName voMap vo =
   TypeScript.TypeScriptFile
     { TypeScript.typeScriptFileName = Info.dashCaseName vo <> ".d.ts"
-    , TypeScript.typeScriptFileContent = virtualObjectInfoToInterfaceDecs True voMap vo
+    , TypeScript.typeScriptFileContent = virtualObjectInfoToInterfaceDecs mainObjectName True voMap vo
     }
 
+oxfordCommaSeparatedList :: [String] -> String
+oxfordCommaSeparatedList [] = ""
+oxfordCommaSeparatedList [l] = l
+oxfordCommaSeparatedList [p, l] = p <> " and " <> l
+oxfordCommaSeparatedList [a, p, l] = a <> ", " <> p <> ", and " <> l
+oxfordCommaSeparatedList (h : t) = h <> ", " <> oxfordCommaSeparatedList t
+
 virtualObjectInfoToInterfaceDecs
-  :: Bool -> Map String Info.VirtualObjectInfo -> Info.VirtualObjectInfo -> [TypeScript.Declaration]
-virtualObjectInfoToInterfaceDecs isDefaultExport voMap vo =
+  :: String
+  -> Bool
+  -> Map String Info.VirtualObjectInfo
+  -> Info.VirtualObjectInfo
+  -> [TypeScript.Declaration]
+virtualObjectInfoToInterfaceDecs mainObjectName isDefaultExport voMap vo =
   importDeclarations voMap vo
     ++ [ TypeScript.Declaration
            [Info.virtualObjectDoc vo]
@@ -89,6 +103,17 @@ virtualObjectInfoToInterfaceDecs isDefaultExport voMap vo =
                        [ "The type of the object, used for identification (the \""
                            <> Info.virtualObjectName vo
                            <> "\" string)."
+                       , "Other types of objects would be:"
+                       , oxfordCommaSeparatedList
+                           ( ( if mainObjectName == Info.virtualObjectName vo
+                                 then id
+                                 else (show mainObjectName :)
+                             )
+                               [ show $ Info.virtualObjectName v
+                               | v <- Map.elems voMap
+                               , Info.virtualObjectName v /= Info.virtualObjectName vo
+                               ]
+                           )
                        ]
                        (TypeScript.InterfaceProperty "objectType" "string")
                  ]