graph.go

package hsc

import (
	"fmt"
	"strings"
	"sync"

	"github.com/marcozac/hubspot-go"
	"golang.org/x/tools/go/packages"
)

type Graph struct {
	// OutDir is the output directory for the generated files.
	//
	// Default: "."
	OutDir string

	// PackageName is the name of the package for the generated files.
	//
	// Default: "hubspot"
	PackageName string

	// PackagePath is the path of the package for the generated files.
	//
	// Example: "github.com/marcozac/hubspot-go"
	PackagePath string

	// Imports is a map formatted as "path:alias" for the imports of the graph.
	Imports map[string]string

	// Objects is a list of objects of the node.
	Objects []*Object

	// Header is the header for the generated files.
	//
	// Default: "Code generated by hsc. DO NOT EDIT."
	Header string

	// importHS is true if the types should imported from the hubspot-go package
	importHS bool

	mu sync.RWMutex
}

// ImportHS returns true if the types should imported from the hubspot-go package
func (g *Graph) ImportHS() bool {
	return g.importHS
}

func (g *Graph) Init() error {
	if g.OutDir == "" {
		g.OutDir = "."
	}
	if g.PackageName == "" {
		g.PackageName = "hubspot"
	}
	if g.Header == "" {
		g.Header = "Code generated by hsc. DO NOT EDIT."
	}
	return g.resolveImports()
}

func (g *Graph) resolveImports() error {
	if g.Imports == nil {
		g.Imports = make(map[string]string)
	}
	g.importHS = g.PackagePath != "github.com/marcozac/hubspot-go"
	if g.importHS {
		g.Imports["github.com/marcozac/hubspot-go"] = "hubspot"
	}
	for _, o := range g.Objects {
		o.importHS = g.importHS
		if g.importHS {
			for _, p := range o.Properties {
				p.importHS = true
			}
		}
		if o.EndpointTarget != nil {
			g.mu.RLock()
			alias, ok := g.Imports[o.EndpointTarget.Package]
			g.mu.RUnlock()
			if !ok {
				g.mu.Lock()
				pkgs, err := packages.Load(&packages.Config{}, o.EndpointTarget.Package)
				if err != nil {
					return fmt.Errorf("load packages: %w", err)
				}
				if l := len(pkgs); l == 0 || l > 1 {
					return fmt.Errorf("unexpected number of packages: %d", l)
				}
				pkg := pkgs[0]
				var i int
				alias = pkg.Name
			importsLoop:
				for _, a := range g.Imports {
					if alias == a {
						i++
						alias = fmt.Sprintf("%s_%d", pkg.Name, i)
						goto importsLoop // restart the loop and check the new alias
					}
				}
				g.Imports[o.EndpointTarget.Package] = alias
				g.mu.Unlock()
			}
			o.EndpointTarget.alias = alias // update the alias of the endpoint target
		}
	}
	return nil
}

type Object struct {
	// Name is the name of the object.
	//
	// Example: "Contact"
	Name string

	// Properties is a list of properties of the object.
	Properties []*Property

	// Endpoint is the endpoint of the object.
	//
	// Example: "https://api.hubapi.com/crm/v3/objects/contacts"
	Endpoint string

	// EndpointTarget is the target endpoint for the object.
	//
	// It is used if [Object.Endpoint] is empty.
	EndpointTarget *EndpointTarget

	// importHS is true if the types should imported from the hubspot-go package
	importHS bool
}

// ImportHS returns true if the types should imported from the hubspot-go package
func (o *Object) ImportHS() bool {
	return o.importHS
}

type Property struct {
	*hubspot.Property
	fieldName       string
	structFieldType string

	// importHS is true if the types should imported from the hubspot-go package
	importHS bool
}

// ImportHS returns true if the types should imported from the hubspot-go package
func (p *Property) ImportHS() bool {
	return p.importHS
}

// IsDefault returns true if the property is a HubSpot default property.
func (p Property) IsDefault() bool {
	return p.CreatedUserId == ""
}

func (p *Property) StructFieldName() string {
	if p.fieldName == "" {
		var sb strings.Builder
		ss := strings.Split(p.Name, "_")
		for _, s := range ss {
			if len(s) == 0 {
				// Keep the underscore if the string is empty.
				// It happens when the property name is, for example,
				// "hs__something". The underscore is kept to avoid
				// collisions with other properties.
				sb.WriteString("_")
				continue
			}
			sb.WriteString(strings.ToUpper(s[:1]))
			if len(s) > 1 {
				sb.WriteString(s[1:])
			}
		}
		p.fieldName = sb.String()
	}
	return p.fieldName
}

func (p *Property) StructFieldType() string {
	if p.structFieldType == "" {
		if p.importHS {
			p.structFieldType = "hubspot."
		}
		switch p.Type {
		case hubspot.PropertyTypeString, hubspot.PropertyTypePhoneNumber:
			p.structFieldType = "string" // override the import (if any)
		case hubspot.PropertyTypeNumber:
			// Set the type to Int64 for the hs_object_id property.
			//
			// Currently HubSpot uses int64 for Contact ID, this covers also the future case
			// where they might use int64 for other properties.
			//
			// See: https://developers.hubspot.com/changelog/increasing-the-size-of-contact-record-ids
			if p.Name == "hs_object_id" {
				p.structFieldType += "Int64"
			} else {
				p.structFieldType += "Int"
			}
		case hubspot.PropertyTypeBool:
			p.structFieldType += "Bool"
		case hubspot.PropertyTypeDate:
			// must to be a pointer to respect the omitempty tag
			p.structFieldType = "*" + p.structFieldType + "Date"
		case hubspot.PropertyTypeDateTime:
			// must to be a pointer to respect the omitempty tag
			p.structFieldType = "*" + p.structFieldType + "DateTime"
		case hubspot.PropertyTypeEnumeration:
			switch p.FieldType {
			case hubspot.PropertyFieldTypeRadio, hubspot.PropertyFieldTypeSelect, hubspot.PropertyFieldTypeCalculationEquation:
				p.structFieldType = "string"
			case hubspot.PropertyFieldTypeBooleanCheckbox:
				p.structFieldType += "Bool"
			case hubspot.PropertyFieldTypeNumber:
				p.structFieldType += "Int"
			case hubspot.PropertyFieldTypeCheckbox, hubspot.PropertyFieldTypeCalculationRollup:
				p.structFieldType += "Enumeration"
			default:
				panic(fmt.Errorf("unknown property field type: %s", p.FieldType))
			}
		default:
			panic(fmt.Errorf("unknown property type: %s", p.Type))
		}
	}
	return p.structFieldType
}

func (p Property) StructFieldJSONTag() string {
	return fmt.Sprintf("`json:\"%s,omitempty\"`", p.Name)
}

type EndpointTarget struct {
	// Name is the name of the endpoint target.
	//
	// It must be equal to an exported name in the endpoint package.
	//
	// Example: "Contacts" => github.com/marcozac/hubspot-go/endpoint.Contacts
	Name string

	// Package is the package of the endpoint target.
	//
	// Example: "github.com/marcozac/hubspot-go/endpoint"
	Package string

	// alias is the alias of the endpoint target used for imports.
	alias string
}

// Alias returns the alias of the endpoint target used for imports.
//
// Since the alias may be altered by [Graph], this method should be called only
// after [Graph.resolveImports] has been called or (better) in a template.
func (et *EndpointTarget) Alias() string {
	return et.alias
}