newtab fields

Author: jfcote87

gen-esign/main.go

@@ -72,6 +72,7 @@ func main() {
 		}
 		structName = def.Name
 	}
+
 	// create templates
 	if !strings.HasPrefix(*templDir, "/") {
 		*templDir = path.Join(*baseDir, *templDir)
@@ -171,7 +172,7 @@ func doModel(modelTempl *template.Template, defList []Definition, defMap map[str
 	}()
 	// get field overrides and tab overrides
 	fldOverrides := GetFieldOverrides()
-	tabDefs := TabDefs(defMap, fldOverrides)
+	tabDefs := V21TabDefs(defMap, fldOverrides)
 	var data = struct {
 		Definitions   []Definition
 		DefMap        map[string]Definition

gen-esign/overrides.go

@@ -1255,6 +1255,202 @@ func GetDownloadAdditions(opID string) []DownloadAddition {
 // TabDefs creates a list definitions for embedded tab structs from the defMap parameter.
 // overrides is updated with new override entries to allow tab definitions to generate.
 func TabDefs(defMap map[string]Definition, overrides map[string]map[string]string) []Definition {
+	// list of tab objects
+	var tabObjects = []string{
+		"approve",
+		"checkbox",
+		"company",
+		"dateSigned",
+		"date",
+		"decline",
+		"emailAddress",
+		"email",
+		"envelopeId",
+		"firstName",
+		"formulaTab",
+		"fullName",
+		"initialHere",
+		"lastName",
+		"list",
+		"notarize",
+		"note",
+		"number",
+		"radioGroup",
+		"signerAttachment",
+		"signHere",
+		"ssn",
+		"text",
+		"tabGroup",
+		"title",
+		"view",
+		"zip",
+	}
+
+	// list of types of tabs
+	tabDefs := map[string]Definition{
+		"Base": {
+			ID:          "TabBase",
+			Name:        "TabBase",
+			Type:        "Object",
+			Description: "contains common fields for all tabs",
+			Summary:     "contains common fields for all tabs",
+			Category:    "",
+		},
+		"Position": {
+			ID:          "TabPosition",
+			Name:        "TabPosition",
+			Type:        "Object",
+			Description: "contains common fields for all tabs that can position themselves on document",
+			Summary:     "contains common fields for all tabs that can position themselves on document",
+			Category:    "",
+		},
+		"Style": {
+			ID:          "TabStyle",
+			Name:        "TabStyle",
+			Type:        "Object",
+			Description: "contains common fields for all tabs that can set a display style",
+			Summary:     "contains common fields for all tabs that can set a display style",
+			Category:    "",
+		},
+		"Value": {
+			ID:          "TabValue",
+			Name:        "TabValue",
+			Type:        "Object",
+			Description: "add Value() func to tab",
+			Summary:     "add Value() func to tab",
+			Category:    "",
+		},
+	}
+	// list of fields for each tab type
+	tabFields := map[string][]string{
+		"Base": {
+			"conditionalParentLabel",
+			"conditionalParentValue",
+			"documentId",
+			"recipientId",
+		},
+		"Position": {
+			"anchorCaseSensitive",
+			"anchorHorizontalAlignment",
+			"anchorIgnoreIfNotPresent",
+			"anchorMatchWholeWord",
+			"anchorString",
+			"anchorUnits",
+			"anchorXOffset",
+			"anchorYOffset",
+			"customTabId",
+			"errorDetails",
+			"mergeField",
+			"pageNumber",
+			"status",
+			"tabId",
+			"tabLabel",
+			"tabOrder",
+			"templateLocked",
+			"templateRequired",
+			"xPosition",
+			"yPosition",
+		},
+		"Style": {
+			"bold",
+			"boldMetadata",
+			"font",
+			"fontMetadata",
+			"fontColor",
+			"fontColorMetadata",
+			"fontSize",
+			"fontSizeMetadata",
+			"italic",
+			"italicMetadata",
+			"name",
+			"nameMetadata",
+			"underline",
+			"underlineMetadata",
+		},
+		"Value": {
+			"value",
+			"valueMetadata",
+		},
+	}
+	// loop thru each tab definition
+	for _, tabname := range tabObjects {
+		dx := defMap["#/definitions/"+tabname]
+		// create map of fields for easy lookup
+		xmap := make(map[string]bool)
+		// NOTE:  add tabLabel to notary and name to view.
+		//This seems to be an error  in swagger definition.
+		// TODO: remove when fixed in swagger file
+		if tabname == "notarize" {
+			xmap["tabLabel"] = true
+		}
+		if tabname == "view" {
+			xmap["name"] = true
+		}
+
+		for _, f := range dx.Fields {
+			xmap[f.Name] = true
+		}
+		// Get Overrides for this tab definition
+		defOverrides, ok := overrides[dx.ID]
+		if !ok {
+			defOverrides = make(map[string]string)
+			overrides[dx.ID] = defOverrides
+		}
+		memberOf := make([]string, 0) // tab types for this tab
+		// Loop thru each tab type
+		for _, nm := range []string{"Base", "Position", "Style", "Value"} {
+			// check for match by checking for existence of each field
+			isType := true
+			for _, s := range tabFields[nm] {
+				if isType = xmap[s]; !isType {
+					break
+				}
+			}
+			// if match, mark override for each field
+			if isType {
+				for _, f := range tabFields[nm] {
+					// Definition.StructFields() will know to skip
+					// outputting this field for the type def
+					defOverrides[f] = "-"
+				}
+				memberOf = append(memberOf, "Tab"+nm)
+			}
+		}
+		// create override.  Definition.StructFields will know to output
+		// these embedded types.
+		if len(memberOf) > 0 {
+			defOverrides["TABS"] = strings.Join(memberOf, ",")
+		}
+	}
+
+	// Get field definitions for embedded types.  Assume that
+	// the Text tab meets all definitions so copy appropriate field
+	// from its definition
+	txtDef := defMap["#/definitions/text"]
+	xmap := make(map[string]Field)
+	for _, f := range txtDef.Fields {
+		xmap[f.Name] = f
+
+	}
+	results := make([]Definition, 0)
+	for _, tabDefName := range []string{"Base", "Position", "Style", "Value"} {
+		ndef := tabDefs[tabDefName]
+		for _, s := range tabFields[tabDefName] {
+			fx, ok := xmap[s]
+			if ok {
+				ndef.Fields = append(ndef.Fields, fx)
+			}
+		}
+		results = append(results, ndef)
+
+	}
+	// return list of embedded tab definitions
+	return results
+}
+
+// V21TabDefs creates a list definitions for embedded tab structs from the defMap parameter.
+// overrides is updated with new override entries to allow tab definitions to generate.
+func V21TabDefs(defMap map[string]Definition, overrides map[string]map[string]string) []Definition {
 	// list of tab objects
 	var tabObjects = []string{
 		"approve",
@@ -1299,6 +1495,14 @@ func TabDefs(defMap map[string]Definition, overrides map[string]map[string]strin
 			Summary:     "contains common fields for all tabs",
 			Category:    "",
 		},
+		"GuidedForm": {
+			ID:          "TabGuidedForm",
+			Name:        "TabGuidedForm",
+			Type:        "Object",
+			Description: "contains common fields for all text box tabs",
+			Summary:     "contains common fields for all text box tabs",
+			Category:    "",
+		},
 		"Position": {
 			ID:          "TabPosition",
 			Name:        "TabPosition",
@@ -1328,31 +1532,69 @@ func TabDefs(defMap map[string]Definition, overrides map[string]map[string]strin
 	tabFields := map[string][]string{
 		"Base": {
 			"conditionalParentLabel",
+			"conditionalParentLabelMetadata",
 			"conditionalParentValue",
+			"conditionalParentValueMetadata",
 			"documentId",
+			"documentIdMetadata",
 			"recipientId",
+			"recipientIdMetadata",
+			"recipientIdGuid",
+			"recipientIdGuidMetadata",
+			"tabGroupLabels",
+			"tabGroupLabelsMetadata",
+			"tabType",
+			"tabTypeMetadata",
+		},
+		"GuidedForm": {
+			"formOrder",
+			"formOrderMetadata",
+			"formPageLabel",
+			"formPageLabelMetadata",
+			"formPageNumber",
+			"formPageNumberMetadata",
 		},
 		"Position": {
 			"anchorCaseSensitive",
+			"anchorCaseSensitiveMetadata",
 			"anchorHorizontalAlignment",
+			"anchorHorizontalAlignmentMetadata",
 			"anchorIgnoreIfNotPresent",
+			"anchorIgnoreIfNotPresentMetadata",
 			"anchorMatchWholeWord",
+			"anchorMatchWholeWordMetadata",
 			"anchorString",
+			"anchorStringMetadata",
+			"anchorTabProcessorVersion",
+			"anchorTabProcessorVersionMetadata",
 			"anchorUnits",
+			"anchorUnitsMetadata",
 			"anchorXOffset",
+			"anchorXOffsetMetadata",
 			"anchorYOffset",
+			"anchorYOffsetMetadata",
 			"customTabId",
+			"customTabIdMetadata",
 			"errorDetails",
 			"mergeField",
 			"pageNumber",
+			"pageNumberMetadata",
 			"status",
+			"statusMetadata",
 			"tabId",
+			"tabIdMetadata",
 			"tabLabel",
+			"tabLabelMetadata",
 			"tabOrder",
+			"tabOrderMetadata",
 			"templateLocked",
+			"templateLockedMetadata",
 			"templateRequired",
+			"templateRequiredMetadata",
 			"xPosition",
+			"xPositionMetadata",
 			"yPosition",
+			"yPositionMetadata",
 		},
 		"Style": {
 			"bold",
@@ -1381,6 +1623,10 @@ func TabDefs(defMap map[string]Definition, overrides map[string]map[string]strin
 		if tabname == "view" {
 			xmap["name"] = true
 		}
+		if tabname == "radioGroup" {
+			xmap["tabGroupLabels"] = true
+			xmap["tabGroupLabelsMetadata"] = true
+		}
 
 		for _, f := range dx.Fields {
 			xmap[f.Name] = true
@@ -1393,7 +1639,7 @@ func TabDefs(defMap map[string]Definition, overrides map[string]map[string]strin
 		}
 		memberOf := make([]string, 0) // tab types for this tab
 		// Loop thru each tab type
-		for _, nm := range []string{"Base", "Position", "Style", "Value"} {
+		for _, nm := range []string{"Base", "GuidedForm", "Position", "Style", "Value"} {
 			// check for match by checking for existence of each field
 			isType := true
 			for _, s := range tabFields[nm] {
@@ -1428,7 +1674,7 @@ func TabDefs(defMap map[string]Definition, overrides map[string]map[string]strin
 
 	}
 	results := make([]Definition, 0)
-	for _, tabDefName := range []string{"Base", "Position", "Style", "Value"} {
+	for _, tabDefName := range []string{"Base", "GuidedForm", "Position", "Style", "Value"} {
 		ndef := tabDefs[tabDefName]
 		for _, s := range tabFields[tabDefName] {
 			fx, ok := xmap[s]
@@ -1479,6 +1725,9 @@ func GetTabValues(tabs Tabs) []NameValue {
 	for _, v := range tabs.TextTabs {
 		results = append(results, NameValue{Name: v.TabLabel, OriginalValue: v.OriginalValue, Value: v.Value})
 	}
+	for _, v := range tabs.ZipTabs {
+		results = append(results, NameValue{Name: v.TabLabel, OriginalValue: v.OriginalValue, Value: v.Value})
+	}
 	return results
 }
 

gen-esign/swagger.go

@@ -677,8 +677,15 @@ func ToGoNameLC(name string) string {
 	return strings.ToLower(nm[0:1]) + nm[1:]
 }
 
+var registeredGoNames = map[string]bool{
+	"TabGuidedForm": true,
+}
+
 // ToGoName translates a swagger name which can be underscored or camel cased to a name that golint likes
 func ToGoName(name string) string {
+	if _, ok := registeredGoNames[name]; ok {
+		return name
+	}
 	var out []string
 	for _, w := range split(name) {
 		uw := strings.ToUpper(w)