models

type Document struct {
	gorm.Model

	// GoogleFileID is the Google Drive file ID of the document.
	GoogleFileID string `gorm:"index;not null;unique"`

	// Approvers is the list of users whose approval is requested for the
	// document.
	Approvers []*User `gorm:"many2many:document_reviews;"`

	// ApproverGroups is the list of groups whose approval is requested for the
	// document.
	ApproverGroups []*Group `gorm:"many2many:document_group_reviews;"`

	// Contributors are users who have contributed to the document.
	Contributors []*User `gorm:"many2many:document_contributors;"`

	// CustomFields contains custom fields.
	CustomFields []*DocumentCustomField

	// DocumentCreatedAt is the time of document creation.
	DocumentCreatedAt time.Time

	// DocumentModifiedAt is the time the document was last modified.
	DocumentModifiedAt time.Time

	// DocumentNumber is a document number unique to each product/area. It
	// pairs with the product abbreviation to form a document identifier
	// (e.g., "TF-123").
	DocumentNumber int `gorm:"index:latest_product_number"`

	// DocumentType is the document type.
	DocumentType   DocumentType
	DocumentTypeID uint

	// DocumentFileRevision are the file revisions for the document.
	FileRevisions []DocumentFileRevision

	// Imported is true if the document was not created through the application.
	Imported bool

	// Locked is true if the document cannot be updated (may be in a bad state).
	Locked bool

	// Owner is the owner of the document.
	Owner   *User `gorm:"default:null;not null"`
	OwnerID *uint `gorm:"default:null"`

	// Product is the product or area that the document relates to.
	Product   Product
	ProductID uint `gorm:"index:latest_product_number"`

	// RelatedResources are the related resources for the document.
	RelatedResources []*DocumentRelatedResource

	// Status is the status of the document.
	Status DocumentStatus

	// ShareableAsDraft is true if the document can be shared in the WIP (draft)
	// status.
	ShareableAsDraft bool

	// Summary is a summary of the document.
	Summary *string

	// Title is the title of the document. It only contains the title, and not the
	// product abbreviation, document number, or document type.
	Title string
}

type DocumentCustomField struct {
	DocumentID                uint `gorm:"primaryKey"`
	DocumentTypeCustomFieldID uint `gorm:"primaryKey"`
	DocumentTypeCustomField   DocumentTypeCustomField
	// Value                     datatypes.JSON
	Value string
}

type DocumentFileRevision struct {
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt gorm.DeletedAt `gorm:"index"`

	Document   Document
	DocumentID uint `gorm:"primaryKey"`

	// GoogleDriveFileRevisionID is the ID of the Google Drive file revision.
	GoogleDriveFileRevisionID string `gorm:"primaryKey"`

	// Name is the name of the document file revision.
	Name string `gorm:"primaryKey"`
}

type DocumentFileRevisions []DocumentFileRevision

type DocumentGroupReview struct {
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt gorm.DeletedAt `gorm:"index"`

	DocumentID uint `gorm:"primaryKey"`
	Document   Document
	GroupID    uint `gorm:"primaryKey"`
	Group      Group
}

type DocumentGroupReviews []DocumentGroupReview

type DocumentRelatedResource struct {
	gorm.Model

	// Document is the document that the related resource is attached to.
	Document   Document
	DocumentID uint `gorm:"uniqueIndex:document_id_sort_order_unique"`

	// RelatedResourceID is the foreign key of the related resource, set by a Gorm
	// polymorphic relationship.
	RelatedResourceID uint `gorm:"default:null;not null"`

	// RelatedResourceType is the table for the related resource, set by a Gorm
	// polymorphic relationship.
	RelatedResourceType string `gorm:"default:null;not null"`

	// SortOrder is the relative order of the related resource in comparison to
	// all of the document's other related resources.
	SortOrder int `gorm:"default:null;not null;uniqueIndex:document_id_sort_order_unique"`
}

type DocumentRelatedResourceExternalLink struct {
	gorm.Model

	RelatedResource DocumentRelatedResource `gorm:"polymorphic:RelatedResource"`

	Name string `gorm:"default:null;not null"`

	URL string `gorm:"default:null;not null"`
}

type DocumentRelatedResourceExternalLinks []DocumentRelatedResourceExternalLink

type DocumentRelatedResourceHermesDocument struct {
	gorm.Model

	RelatedResource DocumentRelatedResource `gorm:"polymorphic:RelatedResource"`

	// Document is the target related document.
	Document   Document
	DocumentID uint
}

type DocumentReview struct {
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt gorm.DeletedAt `gorm:"index"`

	DocumentID uint `gorm:"primaryKey"`
	Document   Document
	UserID     uint `gorm:"primaryKey"`
	User       User
	Status     DocumentReviewStatus
}

type DocumentReviewStatus int

type DocumentReviews []DocumentReview

type DocumentStatus int

type DocumentType struct {
	gorm.Model

	// Name is the name of the document type, generally an abbreviation.
	// Example: "RFC"
	Name string `gorm:"index;not null;unique"`

	// LongName is the longer name for the document type.
	// Example: "Request for Comments"
	LongName string `gorm:"default:null;not null"`

	// Description is the description of the document type.
	// Example: "Create a Request for Comments document to present a proposal to
	// colleagues for their review and feedback."
	Description string

	// FlightIcon is the name of the Helios flight icon.
	// From: https://helios.hashicorp.design/icons/library
	FlightIcon string

	// MoreInfoLinkText is the text for a "more info" link.
	// Example: "When should I create an RFC?"
	MoreInfoLinkText string

	// MoreInfoLinkURL is the URL for a "more info" link.
	MoreInfoLinkURL string

	// CustomFields contain custom fields that are specific to a particular
	// document type.
	CustomFields []DocumentTypeCustomField

	// Checks are document type checks, which require acknowledging a check box in
	// order to publish a document.
	Checks datatypes.JSON
}

type DocumentTypeCustomField struct {
	gorm.Model

	Name           string
	DocumentTypeID uint
	DocumentType   DocumentType
	ReadOnly       bool
	Type           DocumentTypeCustomFieldType
}

type DocumentTypeCustomFieldType int

type DocumentTypes []DocumentType

type Documents []Document

type Group struct {
	gorm.Model

	// EmailAddress is the email address of the group.
	EmailAddress string `gorm:"default:null;index;not null;type:citext;unique"`
}

type IndexerFolder struct {
	gorm.Model

	// GoogleDriveID is the Google Drive ID of the folder.
	GoogleDriveID string `gorm:"default:null;not null;uniqueIndex"`

	// LastIndexedAt is the time that the folder was last indexed.
	LastIndexedAt time.Time
}

type IndexerMetadata struct {
	gorm.Model

	// LastFullIndexAt is the time that the indexer last completed a full index.
	LastFullIndexAt time.Time
}

type Product struct {
	gorm.Model

	// Name is the name of the product.
	Name string `gorm:"default:null;index;not null;type:citext;unique"`

	// Abbreviation is a short group of capitalized letters to represent the
	// product.
	Abbreviation string `gorm:"default:null;not null;type:citext;unique"`

	// UserSubscribers are the users that subscribed to this product.
	UserSubscribers []User `gorm:"many2many:user_product_subscriptions;"`
}

type ProductLatestDocumentNumber struct {
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt gorm.DeletedAt `gorm:"index"`

	DocumentType   DocumentType
	DocumentTypeID uint `gorm:"primaryKey"`
	Product        Product
	ProductID      uint `gorm:"primaryKey"`

	// LatestDocumentNumber is a the latest document number per product and
	// document type.
	LatestDocumentNumber int `gorm:"default:null;not null"`
}

type Project struct {
	gorm.Model

	// Creator is the user that created the project.
	Creator   User
	CreatorID uint `gorm:"default:null;not null"`

	// Description is a description of the project.
	Description *string

	// JiraIssueID is the ID of the Jira issue associated with the project.
	JiraIssueID *string

	// ProjectCreatedAt is the time of project creation.
	ProjectCreatedAt time.Time `gorm:"default:null;not null"`

	// ProjectModifiedAt is the time the project was last modified.
	ProjectModifiedAt time.Time `gorm:"default:null;not null"`

	// RelatedResources are the related resources for the project.
	RelatedResources []*ProjectRelatedResource

	// Status is the status of the document.
	Status ProjectStatus `gorm:"default:null;not null"`

	// Title is the title of the project.
	Title string `gorm:"default:null;not null"`
}

type ProjectRelatedResource struct {
	gorm.Model

	// Project is the project that the related resource is attached to.
	Project   Project
	ProjectID uint `gorm:"uniqueIndex:project_id_sort_order_unique"`

	// RelatedResourceID is the foreign key of the related resource, set by a Gorm
	// polymorphic relationship.
	RelatedResourceID uint `gorm:"default:null;not null"`

	// RelatedResourceType is the table for the related resource, set by a Gorm
	// polymorphic relationship.
	RelatedResourceType string `gorm:"default:null;not null"`

	// SortOrder is the relative order of the related resource in comparison to
	// all of the project's other related resources.
	SortOrder int `gorm:"default:null;not null;uniqueIndex:project_id_sort_order_unique"`
}

type ProjectRelatedResourceExternalLink struct {
	gorm.Model

	RelatedResource ProjectRelatedResource `gorm:"polymorphic:RelatedResource"`

	Name string `gorm:"default:null;not null"`

	URL string `gorm:"default:null;not null"`
}

type ProjectRelatedResourceExternalLinks []ProjectRelatedResourceExternalLink

type ProjectRelatedResourceHermesDocument struct {
	gorm.Model

	RelatedResource ProjectRelatedResource `gorm:"polymorphic:RelatedResource"`

	// Document is the target related Hermes document.
	Document   Document
	DocumentID uint
}

type ProjectStatus int

type RecentlyViewedDoc struct {
	UserID     int `gorm:"primaryKey"`
	DocumentID int `gorm:"primaryKey"`
	ViewedAt   time.Time
}

type RecentlyViewedProject struct {
	UserID    int `gorm:"primaryKey"`
	ProjectID int `gorm:"primaryKey"`
	ViewedAt  time.Time
}

type User struct {
	gorm.Model

	// EmailAddress is the email address of the user.
	EmailAddress string `gorm:"default:null;index;not null;type:citext;unique"`

	// ProductSubscriptions are the products that have been subscribed to by the
	// user.
	ProductSubscriptions []Product `gorm:"many2many:user_product_subscriptions;"`

	// RecentlyViewedDocs are the documents recently viewed by the user.
	RecentlyViewedDocs []Document `gorm:"many2many:recently_viewed_docs;"`

	// RecentlyViewedProjects are the projects recently viewed by the user.
	RecentlyViewedProjects []Project `gorm:"many2many:recently_viewed_projects;"`
}