Refactor Comment type to use XrmAttributeType DU

Author: Mosh-K

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## [Unreleased]
 ### Changed
+- Refactored `Comment` type to use `XrmAttributeType` DU (24 SDK attribute types) instead of strings for type-safe formatting
+- Extracted `XrmAttributeType` and `RelType` DUs to `Domain.fs` for better organization and constraint satisfaction (Set operations in form intersection)
+- Moved formatting logic into `Comment.ToCommentStrings()` and `XrmAttributeType.fromDisplayName()` for cleaner separation of concerns
 - Lookup logical name variables are now derived from attributes rather than relationships, using a union type of all target entity names; duplicate variable names are merged into union types instead of being renamed
 - Section control interfaces now include a JSDoc comment with the tab display name and a `{@link}` reference to the containing tab section interface
 - Added `{@link}` comments to `ui.tabs.get()`, `tab.sections.get()`, and `ui.quickForms.get()` overloads

src/CreateTypeScript/CreateWebEntities.fs

@@ -5,7 +5,6 @@ open TsStringUtil
 open Constants
 open InterpretCommon
 open IntermediateRepresentation
-open Microsoft.Xrm.Sdk.Metadata
 
 
 let INTERNAL_NS = "_"
@@ -18,7 +17,7 @@ let currencyId = {
   schemaName = "TransactionCurrencyId"
   specialType = SpecialType.EntityReference
   varType = TsType.String
-  typeName = AttributeTypeDisplayName.LookupType.Value
+  colType = XrmAttributeType.Lookup
   targetEntitySets = Some [| "transactioncurrency", "transactioncurrencies", "Currency" |]
   readable = true
   createable = true
@@ -108,12 +107,12 @@ let defToFormattedVars (a, comment, _, _) =
   Variable.Create(formattedName a, TsType.String, comment, optional = true  ) 
 
 let getEntityRefDef nameFormat (a: XrmAttribute) =
-  nameFormat a, [ a, Comment.Create (a.displayName, colType = a.typeName), a.varType, Some guidName ]
+  nameFormat a, [ a, Comment.Create (a.displayName, colType = a.colType), a.varType, Some guidName ]
 
 let getResultDef (ent: XrmEntity) (attr: XrmAttribute) = 
   let vType = attr.varType
   let name = attr.logicalName
-  let comment = Comment.Create(attr.displayName, colType = attr.typeName, link = getLink ent attr)
+  let comment = Comment.Create(attr.displayName, colType = attr.colType, link = getLink ent attr)
 
   match attr.specialType with
   | SpecialType.EntityReference -> getEntityRefDef guidName attr
@@ -166,7 +165,7 @@ let getLookupNameVariable (a: XrmAttribute) =
       Variable.Create(
         lookupName a,
         unionType,
-        Comment.Create(a.displayName, colType = a.typeName),
+        Comment.Create(a.displayName, colType = a.colType),
         optional = true
       )
     )

src/Domain.fs

@@ -6,6 +6,67 @@ open Microsoft.Xrm.Sdk.Metadata
 open Microsoft.Xrm.Sdk.Client
 open System.Runtime.Serialization
 
+type RelType =
+  | ManyToOne
+  | OneToMany
+  | ManyToMany
+
+type XrmAttributeType =
+  | Boolean
+  | Customer
+  | DateTime
+  | Decimal
+  | Double
+  | Integer
+  | Lookup
+  | Memo
+  | Money
+  | Owner
+  | PartyList
+  | Picklist
+  | State
+  | Status
+  | String
+  | Uniqueidentifier
+  | CalendarRules
+  | Virtual
+  | BigInt
+  | ManagedProperty
+  | EntityName
+  | Image
+  | MultiSelectPicklist
+  | File
+
+module XrmAttributeType =
+  let private map = [
+    AttributeTypeDisplayName.BooleanType,             Boolean
+    AttributeTypeDisplayName.CustomerType,            Customer
+    AttributeTypeDisplayName.DateTimeType,            DateTime
+    AttributeTypeDisplayName.DecimalType,             Decimal
+    AttributeTypeDisplayName.DoubleType,              Double
+    AttributeTypeDisplayName.IntegerType,             Integer
+    AttributeTypeDisplayName.LookupType,              Lookup
+    AttributeTypeDisplayName.MemoType,                Memo
+    AttributeTypeDisplayName.MoneyType,               Money
+    AttributeTypeDisplayName.OwnerType,               Owner
+    AttributeTypeDisplayName.PartyListType,           PartyList
+    AttributeTypeDisplayName.PicklistType,            Picklist
+    AttributeTypeDisplayName.StateType,               State
+    AttributeTypeDisplayName.StatusType,              Status
+    AttributeTypeDisplayName.StringType,              String
+    AttributeTypeDisplayName.UniqueidentifierType,    Uniqueidentifier
+    AttributeTypeDisplayName.CalendarRulesType,       CalendarRules
+    AttributeTypeDisplayName.VirtualType,             Virtual
+    AttributeTypeDisplayName.BigIntType,              BigInt
+    AttributeTypeDisplayName.ManagedPropertyType,     ManagedProperty
+    AttributeTypeDisplayName.EntityNameType,          EntityName
+    AttributeTypeDisplayName.ImageType,               Image
+    AttributeTypeDisplayName.MultiSelectPicklistType, MultiSelectPicklist
+    AttributeTypeDisplayName.FileType,                File ]
+
+  let fromDisplayName t =
+    map |> List.tryFind (fst >> (=) t) |> Option.map snd |> Option.defaultValue Virtual
+
 type Version = int * int * int * int
 type Intersect = string * Guid[]
 

src/IntermediateRepresentation.fs

@@ -26,7 +26,7 @@ type XrmAttribute = {
   varType: TsType
   specialType: SpecialType
   targetEntitySets: (string * string * string)[] option
-  typeName: string
+  colType: XrmAttributeType
   readable: bool
   createable: bool
   updateable: bool
@@ -37,7 +37,7 @@ type XrmRelationship = {
   schemaName: string
   attributeName: string
   displayName: string
-  relType: string
+  relType: RelType
   relatedSetName: string
   relatedSchemaName: string
   navProp: string

src/Interpretation/InterpretCommon.fs

@@ -2,21 +2,18 @@ module internal DG.XrmTypeScript.InterpretCommon
 
 open Constants
 open IntermediateRepresentation
-open Microsoft.Xrm.Sdk.Metadata
 
 
 let getLink (e: XrmEntity) (a: XrmAttribute) =
-  if
-    [ AttributeTypeDisplayName.PicklistType.Value
-      AttributeTypeDisplayName.MultiSelectPicklistType.Value
-      AttributeTypeDisplayName.StateType.Value
-      AttributeTypeDisplayName.StatusType.Value ]
-    |> List.contains a.typeName
-  then
+  match a.colType with
+  | XrmAttributeType.Picklist
+  | XrmAttributeType.MultiSelectPicklist
+  | XrmAttributeType.State
+  | XrmAttributeType.Status ->
     let enumName = TsStringUtil.typeToString(a.varType).Split '.' |> Array.last
     let enum = e.optionSets |> List.tryFind (fun o -> o.name = enumName)
+
     match enum with
     | Some e -> $"{ENUM_NS}.{e.name} {e.displayName}"
     | None -> ""
-  else
-    ""
+  | _ -> ""

src/Interpretation/InterpretEntityMetadata.fs

@@ -94,7 +94,7 @@ let interpretAttribute (nameMap: Map<string, EntityInfo>) labelMapping (a: Attri
       logicalName = a.LogicalName
       varType = vType
       specialType = sType
-      typeName = a.AttributeTypeName.Value
+      colType = XrmAttributeType.fromDisplayName a.AttributeTypeName
       targetEntitySets = targetEntitySets
       readable = a.IsValidForRead.GetValueOrDefault(false)
       createable = a.IsValidForCreate.GetValueOrDefault(false)
@@ -134,7 +134,7 @@ let interpretRelationship (nameMap: Map<string, EntityInfo>) referencing (attrib
             if referencing then rel.ReferencingAttribute 
             else rel.ReferencedAttribute
           displayName = eInfo.DisplayName
-          relType = if referencing then "ManyToOne" else "OneToMany"
+          relType = if referencing then RelType.ManyToOne else RelType.OneToMany
           navProp = 
             if referencing then rel.ReferencingEntityNavigationPropertyName
             else rel.ReferencedEntityNavigationPropertyName
@@ -160,7 +160,7 @@ let interpretM2MRelationship (nameMap: Map<string, EntityInfo>) logicalName (rel
       { XrmRelationship.schemaName = rel.SchemaName 
         attributeName = rel.SchemaName
         displayName = eInfo.DisplayName
-        relType = "ManyToMany"
+        relType = RelType.ManyToMany
         navProp = 
           if logicalName = rel.Entity2LogicalName then rel.Entity1NavigationPropertyName
           else rel.Entity2NavigationPropertyName

src/Interpretation/InterpretFormXml.fs

@@ -56,16 +56,11 @@ let getTargetEntities (tes: string option) (a: XrmAttribute option) =
       let el = tes' |> Array.map (fun (l, _, _) -> l) |> Array.toList
       match el.IsEmpty with
       | true -> "\"NoTargets\""
-      | false -> List.fold(fun acc e -> sprintf "%s | \"%s\"" acc e) (sprintf "\"%s\"" el.Head) el.Tail
+      | false -> List.fold(fun acc e -> $"{acc} | \"{e}\"") ($"\"{el.Head}\"") el.Tail
 
 let getAttributeType = function
   | None -> TsType.Undefined
   | Some a -> a.varType
-let getTargetDisplayName (a: XrmAttribute) =
-    match a.targetEntitySets with
-    | None -> ""
-    | Some tes ->
-      tes |> Array.map (fun (_, _, dn) -> dn) |> String.concat " | "
 
 let getAttribute (enums:Map<string,TsType>) (entity: XrmEntity) (cField: ControlField): XrmFormAttribute option =
   if String.IsNullOrEmpty cField.dataFieldName then None else 
@@ -77,7 +72,7 @@ let getAttribute (enums:Map<string,TsType>) (entity: XrmEntity) (cField: Control
   let comment = 
     match attribute with
     | None -> Comment.Create cField.displayName
-    | Some attr -> Comment.Create(attr.displayName, colType = attr.typeName, table = getTargetDisplayName attr, link = getLink entity attr)
+    | Some attr -> Comment.Create(attr.displayName, colType = attr.colType, ?targetEntitySets = attr.targetEntitySets, link = getLink entity attr)
 
   let attrType = getAttributeType attribute
 
@@ -141,7 +136,7 @@ let getControl  (enums:Map<string,TsType>) (entity: XrmEntity) (cField:ControlFi
     | None -> Comment.Create cField.displayName
     | Some attr ->
       let label = if cField.displayName.Trim() <> attr.displayName.Trim() then cField.displayName else ""
-      Comment.Create(attr.displayName, label = label, colType = attr.typeName, table = getTargetDisplayName attr, link = getLink entity attr)
+      Comment.Create(attr.displayName, label = label, colType = attr.colType, ?targetEntitySets = attr.targetEntitySets, link = getLink entity attr)
 
   let cType = 
     match cField.controlClass with
@@ -297,20 +292,20 @@ let getQuickViewFormControls : ControlField list -> XrmFormQuickViewForm list =
 
 let getControlFields (entity: XrmEntity) (form: XElement) : ControlField list =
     let controlDescriptions =
-      form.Descendants(XName.Get("controlDescription"))
+      form.Descendants(XName.Get "controlDescription")
       |> Seq.choose (fun cd -> 
-        cd.Elements(XName.Get("customControl"))
+        cd.Elements(XName.Get "customControl")
         |> Seq.choose (fun cc -> 
           match getValue cc "id" with 
           | null -> None 
           | x -> Some (getValue cd "forControl", x))
         |> Seq.tryHead)
       |> Map.ofSeq
 
-    form.Descendants(XName.Get("cell"))
-    |> Seq.filter (fun cell -> cell.Descendants(XName.Get("control")) |> Seq.isEmpty |> not) // Filter out cells that don't have a control
+    form.Descendants(XName.Get "cell")
+    |> Seq.filter (fun cell -> cell.Descendants(XName.Get "control") |> Seq.isEmpty |> not) // Filter out cells that don't have a control
     |> Seq.map (fun cell -> 
-      let ctrl = cell.Descendants(XName.Get("control")) |> Seq.head
+      let ctrl = cell.Descendants(XName.Get "control") |> Seq.head
 
       let id = getValue ctrl "id"
       let classId = getValue ctrl "classid"
@@ -319,23 +314,23 @@ let getControlFields (entity: XrmEntity) (form: XElement) : ControlField list =
       let datafieldname = getValue ctrl "datafieldname"
 
       let targetEntities = 
-        let parms = ctrl.Descendants(XName.Get("parameters")) 
+        let parms = ctrl.Descendants(XName.Get "parameters") 
         if Seq.isEmpty parms then
           let rel = getValue ctrl "relationship"
           entity.allRelationships
           |> List.choose (fun r -> if r.schemaName = rel then Some r.relatedSetName else None)
         else
           parms
-          |> Seq.collect (fun p -> p.Elements(XName.Get("TargetEntityType")))
+          |> Seq.collect (fun p -> p.Elements(XName.Get "TargetEntityType"))
           |> Seq.map (fun e -> e.Value)
           |> Seq.toList
 
       let quickViewForms =
-        let parms = ctrl.Descendants(XName.Get("parameters"))
+        let parms = ctrl.Descendants(XName.Get "parameters")
         if Seq.isEmpty parms then None
         else
           parms
-          |> Seq.collect (fun p -> p.Elements(XName.Get("QuickForms")))
+          |> Seq.collect (fun p -> p.Elements(XName.Get "QuickForms"))
           |> Seq.map (fun e -> e.Value)
           |> Seq.toList
           |> function
@@ -359,9 +354,9 @@ let getControlFields (entity: XrmEntity) (form: XElement) : ControlField list =
          targetEntitySets = None; 
          quickViewForms = quickViewForms }
 
-      if(targetEntities.Length > 0) then
+      if targetEntities.Length > 0 then
         let tes =
-          Seq.fold(fun acc e -> sprintf "%s | \"%s\"" acc e) (sprintf "\"%s\"" targetEntities.Head) targetEntities.Tail
+          Seq.fold(fun acc e -> $"{acc} | \"{e}\"") ($"\"{targetEntities.Head}\"") targetEntities.Tail
         {baseControl with targetEntitySets = Some tes}
       else baseControl
     )

src/TypeScript/TypeScript.fs

@@ -48,26 +48,31 @@ and Variable =
 and Comment =
   { displayName: string
     label: string
-    colType: string
-    table: string
-    relType: string
+    colType: XrmAttributeType option
+    targetEntitySets: (string * string * string)[] option
+    relType: RelType option
     tab: string
     link: string }
-  static member Create(?displayName, ?label, ?colType, ?table, ?relType, ?tab, ?link) =
+  static member Create(?displayName, ?label, ?colType, ?targetEntitySets, ?relType, ?tab, ?link) =
     { displayName = defaultArg displayName ""
       label = defaultArg label ""
-      colType = defaultArg colType ""
-      table = defaultArg table ""
-      relType = defaultArg relType ""
+      colType = colType
+      targetEntitySets = targetEntitySets
+      relType = relType
       tab = defaultArg tab ""
       link = defaultArg link "" }
   member c.ToCommentStrings() =
     let dsLine = if String.IsNullOrWhiteSpace c.displayName then None else Some $"**{c.displayName.Trim()}**"
-    let tabLine = if String.IsNullOrWhiteSpace c.tab then None else Some $"Tab: *{c.tab.Trim()}*"
+    let tabLine = if String.IsNullOrWhiteSpace c.tab then None else Some $"Tab: {c.tab.Trim()}"
     let labelLine = if String.IsNullOrWhiteSpace c.label then None else Some $"Label: {c.label.Trim()}"
-    let colTypeLine = if String.IsNullOrWhiteSpace c.colType then None else Some $"Column Type: *{c.colType.Trim()}*"
-    let tableLine = if String.IsNullOrWhiteSpace c.table then None else Some $"Table: *{c.table.Trim()}*"
-    let relTypeLine = if String.IsNullOrWhiteSpace c.relType then None else Some $"Relationship Type: *{c.relType.Trim()}*"
+    let colTypeLine = c.colType |> Option.map (fun t -> $"Column Type: {t}")
+    let tableLine =
+      match c.targetEntitySets with
+      | None | Some [||] -> None
+      | Some tes ->
+        let formatted = tes |> Array.map (fun (ln, _, dn) -> $"{dn} (`{ln}`)") |> String.concat " | "
+        Some $"Table: {formatted}"
+    let relTypeLine = c.relType |> Option.map (fun t -> $"Relationship Type: {t}")
     let linkLine = if String.IsNullOrWhiteSpace c.link then None else Some (sprintf "{@link %s}" (c.link.Trim()))
 
     let lines = [ dsLine; tabLine; labelLine; colTypeLine; tableLine; relTypeLine; linkLine ] |> List.choose id