metadata

type Annotation struct {
	CreationDate time.Time `json:"createdAt"`
	ID           string    `json:"id"`
	Title        string    `json:"title"`
	Type         string    `json:"type"`
	// Data will be a computer-friendly structure. The structure itself is not decided yet.
	Data StringMap `json:"data"`
	// Position on the image/video.
	X1 int `json:"x1"`
	X2 int `json:"x2"`
	Y1 int `json:"y1"`
	Y2 int `json:"y2"`
	// Position, in milliseconds
	StartPosition int `json:"startPosition"`
	// EndPosition, in milliseconds
	EndPosition int `json:"endPosition"`
}

type Bookmark struct {
	CreationDate time.Time `json:"creationTime"`
	ID           string    `json:"id"`
	Title        string    `json:"title"`
	// Position, in milliseconds
	StartPosition int `json:"startPosition"`
	// EndPosition, in milliseconds
	EndPosition int `json:"endPosition"`
}

type CheckSum struct {
	Value, Kind, Code, Notes string
}

type ClientMessage struct {
	Kind    InternalInfoStr
	Message string
}

type Creator struct {
	// Can be an identifier, like an officer's badge-id, or a userId in the system.
	SysId      string `json:"sysId"`
	Attributes map[string]string
	Person
}

type EventKind string

type FormFields struct {
	// The metadata-key.
	Key string `json:"key"`
	// The id of the field, where available.
	FieldId string `json:"fieldId"`
	// The key used to get the translated VisualName, where available.
	TranslationKey string `json:"translationKey"`
	// The visual name, as reported by the client.
	VisualName string `json:"visualName"`
	// The value of the field, e.g. the user-input
	Value string `json:"value"`
	// Marks whether or not field is required or not.
	Required bool `json:"required"`
	// The kind of data in the Value-field.
	DataType       string         `json:"dataType"`
	ValidationRule ValidationRule `json:"validationRule"`
}

type GenderType string

type InternalInfoStr string

type Location struct {
	// The text for the current location, like the current address, city, etc.
	Text string `json:"text"`
	// Geo-location
	Latitude float64 `json:"latitude"`
	// Geo-location
	Longitude float64 `json:"longitude"`
	Address   string  `json:"address"`
	Address2  string  `json:"address2"`
	ZipCode   string  `json:"zipCode"`
	PostArea  string  `json:"postArea"`
	Country   string  `json:"country"`
	Accuracy  float64 `json:"accuracy"`
	Altitude  float64 `json:"altitude"`
}

type Mapper func(data Metadata) Metadata

type MetaChecksum struct {
	// The raw value of any checksum
	Value string `json:"value"`
	// SHA256, MD5, Blake3, CRC. Please advice with Indico before use.
	ChecksumType string `json:"checksumType"`
}

type Metadata map[string]string

type Parent struct {
	Id          string     `json:"id"`
	BatchId     string     `json:"batchId"`
	Name        string     `json:"name"`
	Description string     `json:"description"`
	CreatedAt   *time.Time `json:"createdAt"`
	UpdatedAt   *time.Time `json:"updatedAt"`
}

type Person struct {
	FirstName string `json:"firstName"`
	LastName  string `json:"lastName"`
	Id        string `json:"id"`
	// Date of birth
	Dob         *time.Time `json:"dob"`
	Gender      GenderType `json:"gender"`
	Nationality string     `json:"nationality"`
	Workplace   string     `json:"workplace"`
	// TBD
	Status    string `json:"status"`
	WorkPhone string `json:"workPhone"`
	Phone     string `json:"phone"`
	Mobile    string `json:"mobile"`
	// TBD
	Present bool `json:"isPresent"`
	Location
}

type RecordingEvent struct {
	Id string
	// Optional
	Title string
	// Optional
	Description string
	// Required
	Kind EventKind
	// Required
	Start time.Time
	// Optional
	StartFrame int64
	// Optional
	End *time.Time
	// Optional
	EndFrame *int64
	// Optional
	EndKind *EventKind
	// Optional
	EndId *string
}

type RecordingEvents []RecordingEvent

type StringMap map[string]string

type Upl struct {
	UploadMetadata
}

type UploadMetadata struct {
	// A unique identifier for the user in the backend-system
	UserId string `json:"userId"`
	// Active-Directory-user, if available
	AdSid string `json:"adSid"`
	// Active-Directory-user, if available, in the format 'user@domainname@
	AdLogin string `json:"adLogin"`
	// The parent of the current media.
	Parent Parent `json:"parent"`
	// The time of which the media was created in the backend-database
	CreatedAt *time.Time `json:"createdAt"`
	// The time of which the media was last updated in the backend-database
	UpdatedAt *time.Time `json:"updatedAt"`
	// Is the item marked as archived, meaning it is marked to be deleted (soft-deleted). If null, the item is
	// not scheduled for deletion, if a date is set, the item is marked for deletion at that time.
	ArchiveAt *time.Time `json:"archiveAt"`
	// The date of which the item was marked as completed, E.g. the case was closed.
	CompletedAt *time.Time `json:"completedAt"`
	// The time of which the media was created by the user, on the client.
	CapturedAt *time.Time `json:"capturedAt"`
	// The fileType, as in MimeType. Example: 'image/jpeg' or 'video/mp4'
	FileType string `json:"fileType"`
	// A short description of the current file, submitted by the user
	FileSize    int64  `json:"fileSize"`
	DisplayName string `json:"displayName"`
	// A longer description of the current file, submitted by the uer.
	Description string `json:"description"`
	// Any checksums already calculated by the client.
	Checksum []MetaChecksum `json:"checksum"`
	// The filename,
	FileName string `json:"fileName"`
	// Tags
	Tags []string `json:"tags"`
	// The backend-database ID of the current file. Provide if updating metadata.
	ExtId string `json:"extId"`
	// A case-number returned by the user
	CaseNumber string `json:"caseNumber"`
	// Duration of the media, if audio or video. Int64. Should be in milliseconds when sending.
	Duration int64 `json:"duration"`
	// The creator of the current file, as in the current user, interviewer etc.
	Creator Creator `json:"creator"`
	// The location of the captured media
	Location Location `json:"location"`
	// Any subjects in the captured media.
	Subject []Person `json:"subject"`
	// TBD
	EquipmentId string `json:"equipmentId"`
	// TBD
	InterviewType   string          `json:"interviewType"`
	Bookmarks       []Bookmark      `json:"bookmarks"`
	RecordingEvents RecordingEvents `json:"recordingEvents"`
	Annotations     []Annotation    `json:"annotations"`
	// TBD
	Notes string `json:"notes"`
	// A unique identifier of the file on the client.
	ClientMediaId string `json:"clientMediaId"`
	// ID of any backend-provided Group-id
	GroupId string `json:"groupId"`
	// Name of any backend-group. Providing it will c create a groupName, if supported by the backend.
	GroupName string `json:"groupName"`
	// Any custom-field. Should only be used for customer-specific fields that do not fit in any other field. Before use, please request Indico to add your required fields.
	FormFields []FormFields `json:"formFields"`
	// Transcribed audio/video-details
	Transcription []Utterance `json:"transcription"`
}

type Utterance struct {
	Type      UtteranceType `json:"type"`
	Person    Person        `json:"person"`
	EventKind string        `json:"eventKind"`
	Source    string        `json:"source"`
	Text      string        `json:"text"`
	// Position, in milliseconds
	StartPosition int `json:"startPosition"`
	// EndPosition, in milliseconds
	EndPosition int `json:"endPosition"`
}

type UtteranceType string

type ValidationRule struct {
	Min int `json:"min"`
	Max int `json:"max"`
}