things

type Backup struct {
	Things           []Thing
	Profiles         []Profile
	Groups           []Group
	GroupMemberships []GroupMembership
}

type Config struct {
	ContentType string      `json:"content_type"`
	Transformer Transformer `json:"transformer"`
}

type Group struct {
	ID          string
	OrgID       string
	Name        string
	Description string
	Metadata    Metadata
	CreatedAt   time.Time
	UpdatedAt   time.Time
}

type GroupCache interface {
	// RemoveGroupEntities removes all entities related to the group identified by groupID.
	RemoveGroupEntities(context.Context, string) error

	// SaveGroupMembership stores role for given groupID and memberID.
	SaveGroupMembership(context.Context, string, string, string) error

	// ViewRole returns role for given groupID and memberID.
	ViewRole(context.Context, string, string) (string, error)

	// RemoveGroupMembership removes group membership for given groupID and memberID.
	RemoveGroupMembership(context.Context, string, string) error

	// RetrieveGroupIDsByMember returns group IDs for given memberID.
	RetrieveGroupIDsByMember(context.Context, string) ([]string, error)
}

type GroupMembership struct {
	GroupID  string
	MemberID string
	Email    string
	Role     string
}

type GroupMemberships interface {
	// CreateGroupMemberships adds memberships to a group identified by the provided ID.
	CreateGroupMemberships(ctx context.Context, token string, gms ...GroupMembership) error

	// ListGroupMemberships retrieves a paginated list of group memberships for the given group.
	ListGroupMemberships(ctx context.Context, token, groupID string, pm apiutil.PageMetadata) (GroupMembershipsPage, error)

	// UpdateGroupMemberships updates roles of a specific group membership.
	UpdateGroupMemberships(ctx context.Context, token string, gms ...GroupMembership) error

	// RemoveGroupMemberships removes memberships from the given group.
	RemoveGroupMemberships(ctx context.Context, token, groupID string, memberIDs ...string) error
}

type GroupMembershipsBackup struct {
	GroupMemberships []GroupMembership
}

type GroupMembershipsPage struct {
	Total            uint64
	GroupMemberships []GroupMembership
}

type GroupMembershipsRepository interface {
	// Save persists group memberships.
	Save(ctx context.Context, gms ...GroupMembership) error

	// RetrieveRole retrieves role of a specific group membership.
	RetrieveRole(ctx context.Context, gm GroupMembership) (string, error)

	// RetrieveByGroup retrieves a paginated list of group memberships by group ID.
	RetrieveByGroup(ctx context.Context, groupID string, pm apiutil.PageMetadata) (GroupMembershipsPage, error)

	// BackupAll retrieves all group memberships. Used for backup.
	BackupAll(ctx context.Context) ([]GroupMembership, error)

	// BackupByGroup retrieves all group memberships by group ID. This is used for backup.
	BackupByGroup(ctx context.Context, groupID string) ([]GroupMembership, error)

	// RetrieveGroupIDsByMember retrieves IDs of groups where the member belongs.
	RetrieveGroupIDsByMember(ctx context.Context, memberID string) ([]string, error)

	// Remove removes the provided group memberships.
	Remove(ctx context.Context, groupID string, memberIDs ...string) error

	// Update updates existing group memberships.
	Update(ctx context.Context, gms ...GroupMembership) error
}

type GroupPage struct {
	Total  uint64
	Groups []Group
}

type GroupRepository interface {
	// Save group
	Save(ctx context.Context, g ...Group) ([]Group, error)

	// Update a group
	Update(ctx context.Context, g Group) (Group, error)

	// Remove a groups
	Remove(ctx context.Context, groupIDs ...string) error

	// RetrieveByID retrieves group by its id
	RetrieveByID(ctx context.Context, id string) (Group, error)

	// RetrieveByIDs retrieves groups by their ids
	RetrieveByIDs(ctx context.Context, groupIDs []string, pm apiutil.PageMetadata) (GroupPage, error)

	// BackupAll retrieves all groups.
	BackupAll(ctx context.Context) ([]Group, error)

	// BackupByOrg retrieves all groups by organization ID.
	BackupByOrg(ctx context.Context, orgID string) ([]Group, error)

	// RetrieveIDsByOrgMembership retrieves group IDs by org membership
	RetrieveIDsByOrgMembership(ctx context.Context, orgID, memberID string) ([]string, error)

	// RetrieveIDsByOrg retrieves all group IDs by org
	RetrieveIDsByOrg(ctx context.Context, orgID string) ([]string, error)

	// RetrieveAll retrieves all groups with pagination.
	RetrieveAll(ctx context.Context, pm apiutil.PageMetadata) (GroupPage, error)
}

type Groups interface {
	// CreateGroups adds groups to the user identified by the provided key.
	CreateGroups(ctx context.Context, token, orgID string, groups ...Group) ([]Group, error)

	// UpdateGroup updates the group identified by the provided ID.
	UpdateGroup(ctx context.Context, token string, g Group) (Group, error)

	// ViewGroup retrieves data about the group identified by ID.
	ViewGroup(ctx context.Context, token, id string) (Group, error)

	// ListGroups retrieves page of all groups.
	ListGroups(ctx context.Context, token string, pm apiutil.PageMetadata) (GroupPage, error)

	// ListGroupsByOrg retrieves page of groups that are assigned to an org identified by ID.
	ListGroupsByOrg(ctx context.Context, token, orgID string, pm apiutil.PageMetadata) (GroupPage, error)

	// ListThingsByGroup retrieves page of things that are assigned to a group identified by ID.
	ListThingsByGroup(ctx context.Context, token, groupID string, pm apiutil.PageMetadata) (ThingsPage, error)

	// ListProfilesByGroup retrieves page of profiles that are assigned to a group identified by ID.
	ListProfilesByGroup(ctx context.Context, token, groupID string, pm apiutil.PageMetadata) (ProfilesPage, error)

	// ViewGroupByThing retrieves group that thing belongs to.
	ViewGroupByThing(ctx context.Context, token, thingID string) (Group, error)

	// RemoveGroups removes the groups identified with the provided IDs.
	RemoveGroups(ctx context.Context, token string, ids ...string) error

	// ViewGroupByProfile retrieves group that profile belongs to.
	ViewGroupByProfile(ctx context.Context, token, profileID string) (Group, error)
}

type GroupsBackup struct {
	Groups []Group
}

type Identity struct {
	ID    string
	Email string
}

type Metadata map[string]interface{}

type Profile struct {
	ID       string
	GroupID  string
	Name     string
	Config   map[string]interface{}
	Metadata map[string]interface{}
}

type ProfileCache interface {
	// SaveGroup stores group ID by given profile ID.
	SaveGroup(context.Context, string, string) error

	// RemoveGroup removes group ID by given profile ID.
	RemoveGroup(context.Context, string) error

	// ViewGroup returns group ID by given profile ID.
	ViewGroup(context.Context, string) (string, error)
}

type ProfileRepository interface {
	// Save persists multiple profiles. Profiles are saved using a transaction. If one profile
	// fails then none will be saved. Successful operation is indicated by non-nil
	// error response.
	Save(ctx context.Context, prs ...Profile) ([]Profile, error)

	// Update performs an update to the existing profile. A non-nil error is
	// returned to indicate operation failure.
	Update(ctx context.Context, c Profile) error

	// RetrieveByID retrieves the profile having the provided identifier, that is owned
	// by the specified user.
	RetrieveByID(ctx context.Context, id string) (Profile, error)

	// RetrieveByThing retrieves the profile connected to the given thing id.
	RetrieveByThing(ctx context.Context, thID string) (Profile, error)

	// Remove removes the profiles having the provided identifiers, that is owned
	// by the specified user.
	Remove(ctx context.Context, id ...string) error

	// BackupAll retrieves all profiles for all users.
	BackupAll(ctx context.Context) ([]Profile, error)

	// BackupByGroups retrieves all profiles specified by given group ids.
	BackupByGroups(ctx context.Context, groupIDs []string) ([]Profile, error)

	// RetrieveAll retrieves all profiles for all users with pagination.
	RetrieveAll(ctx context.Context, pm apiutil.PageMetadata) (ProfilesPage, error)

	// RetrieveByGroups retrieves the subset of profiles specified by given group ids.
	RetrieveByGroups(ctx context.Context, groupIDs []string, pm apiutil.PageMetadata) (ProfilesPage, error)
}

type ProfilesBackup struct {
	Profiles []Profile
}

type ProfilesPage struct {
	Total    uint64
	Profiles []Profile
}

type PubConfInfo struct {
	PublisherID   string
	ProfileConfig map[string]interface{}
}

type Service interface {
	// CreateThings adds things to the user identified by the token.
	// The group ID for each thing is assigned based on the provided profile ID.
	CreateThings(ctx context.Context, token, profileID string, things ...Thing) ([]Thing, error)

	// UpdateThing updates the Thing identified by the provided ID, as the user authenticated by 'token',
	// who must possess required permissions in the Thing's belonging Group.
	UpdateThing(ctx context.Context, token string, thing Thing) error

	// UpdateThingGroupAndProfile updates the Thing's belonging Profile or Group.
	UpdateThingGroupAndProfile(ctx context.Context, token string, thing Thing) error

	// UpdateThingsMetadata updates the things metadata identified by the provided IDs, that
	// belongs to the user identified by the provided token.
	UpdateThingsMetadata(ctx context.Context, token string, things ...Thing) error

	// ViewThing retrieves data about the thing identified with the provided
	// ID, that belongs to the user identified by the provided key.
	ViewThing(ctx context.Context, token, id string) (Thing, error)

	// ListThings retrieves data about subset of things that belongs to the
	// user identified by the provided key.
	ListThings(ctx context.Context, token string, pm apiutil.PageMetadata) (ThingsPage, error)

	// ListThingsByOrg retrieves page of things that belong to an org identified by ID.
	ListThingsByOrg(ctx context.Context, token string, orgID string, pm apiutil.PageMetadata) (ThingsPage, error)

	// ListThingsByProfile retrieves data about subset of things that are
	// connected or not connected to specified profile and belong to the user identified by
	// the provided key.
	ListThingsByProfile(ctx context.Context, token, prID string, pm apiutil.PageMetadata) (ThingsPage, error)

	// BackupThingsByGroup retrieves all things for given group ID.
	BackupThingsByGroup(ctx context.Context, token string, groupID string) (ThingsBackup, error)

	// RestoreThingsByGroup adds all things for a given group ID from a backup.
	RestoreThingsByGroup(ctx context.Context, token string, groupID string, backup ThingsBackup) error

	// BackupThingsByOrg retrieves all things for given org ID.
	BackupThingsByOrg(ctx context.Context, token string, orgID string) (ThingsBackup, error)

	// RestoreThingsByOrg adds all things for a given org ID from a backup.
	RestoreThingsByOrg(ctx context.Context, token string, orgID string, backup ThingsBackup) error

	// RemoveThings removes the things identified with the provided IDs, that
	// belongs to the user identified by the provided key.
	RemoveThings(ctx context.Context, token string, id ...string) error

	// CreateProfiles adds profiles to the user identified by the token.
	// The group ID is assigned to each profile.
	CreateProfiles(ctx context.Context, token, groupID string, profiles ...Profile) ([]Profile, error)

	// UpdateProfile updates the profile identified by the provided ID, that
	// belongs to the user identified by the provided key.
	UpdateProfile(ctx context.Context, token string, profile Profile) error

	// ViewProfile retrieves data about the profile identified by the provided
	// ID, that belongs to the user identified by the provided key.
	ViewProfile(ctx context.Context, token, id string) (Profile, error)

	// ListProfiles retrieves data about subset of profiles that belongs to the
	// user identified by the provided key.
	ListProfiles(ctx context.Context, token string, pm apiutil.PageMetadata) (ProfilesPage, error)

	// ListProfilesByOrg retrieves page of profiles that belong to an org identified by ID.
	ListProfilesByOrg(ctx context.Context, token string, orgID string, pm apiutil.PageMetadata) (ProfilesPage, error)

	// ViewProfileByThing retrieves data about profile that have
	// specified thing connected or not connected to it and belong to the user identified by
	// the provided key.
	ViewProfileByThing(ctx context.Context, token, thID string) (Profile, error)

	// ViewMetadataByKey retrieves metadata about the thing identified by the given key.
	ViewMetadataByKey(ctx context.Context, key ThingKey) (Metadata, error)

	// RemoveProfiles removes the things identified by the provided IDs, that
	// belongs to the user identified by the provided key.
	RemoveProfiles(ctx context.Context, token string, ids ...string) error

	// GetPubConfByKey determines whether the profile can be accessed using the
	// provided key and returns thing's id if access is allowed.
	GetPubConfByKey(ctx context.Context, key ThingKey) (PubConfInfo, error)

	// GetConfigByThingID returns profile config for given thing ID.
	GetConfigByThingID(ctx context.Context, thingID string) (map[string]interface{}, error)

	// CanUserAccessThing determines whether a user has access to a thing.
	CanUserAccessThing(ctx context.Context, req UserAccessReq) error

	// CanUserAccessProfile determines whether a user has access to a profile.
	CanUserAccessProfile(ctx context.Context, req UserAccessReq) error

	// CanUserAccessGroup determines whether a user has access to a group.
	CanUserAccessGroup(ctx context.Context, req UserAccessReq) error

	// CanThingAccessGroup determines whether a given thing has access to a group with a key.
	CanThingAccessGroup(ctx context.Context, req ThingAccessReq) error

	// Identify returns thing ID for given thing key.
	Identify(ctx context.Context, key ThingKey) (string, error)

	// GetGroupIDByThingID returns a thing's group ID for given thing ID.
	GetGroupIDByThingID(ctx context.Context, thingID string) (string, error)

	// GetGroupIDByProfileID returns a profile's group ID for given profile ID.
	GetGroupIDByProfileID(ctx context.Context, profileID string) (string, error)

	// GetGroupIDsByOrg returns all group IDs belonging to an org.
	GetGroupIDsByOrg(ctx context.Context, orgID string, token string) ([]string, error)

	// UpdateExternalKey updates the external key of the Thing identified by `thingID`. The authenticated user must have Editor rights within the Thing's belonging Group.
	UpdateExternalKey(ctx context.Context, token, key, thingID string) error

	// RemoveExternalKey removes the external thing key of the Thing identified by `thingID`.
	// The authenticated user must have Editor rights within the Thing's belonging Group.
	RemoveExternalKey(ctx context.Context, token, thingID string) error

	// Backup retrieves all things, profiles, groups, and groups memberships for all users. Only accessible by admin.
	Backup(ctx context.Context, token string) (Backup, error)

	// BackupGroupsByOrg retrieves all groups for given org ID.
	BackupGroupsByOrg(ctx context.Context, token string, orgID string) (GroupsBackup, error)

	// RestoreGroupsByOrg adds all groups for given org ID from a backup.
	RestoreGroupsByOrg(ctx context.Context, token string, orgID string, backup GroupsBackup) error

	// BackupGroupMemberships retrieves all group memberships for given group ID.
	BackupGroupMemberships(ctx context.Context, token string, groupID string) (GroupMembershipsBackup, error)

	// RestoreGroupMemberships adds all group memberships for given group ID from a backup.
	RestoreGroupMemberships(ctx context.Context, token string, groupID string, backup GroupMembershipsBackup) error

	// BackupProfilesByOrg retrieves all profiles for given org ID.
	BackupProfilesByOrg(ctx context.Context, token string, orgID string) (ProfilesBackup, error)

	// RestoreProfilesByOrg adds all profiles for given org ID from a backup.
	RestoreProfilesByOrg(ctx context.Context, token string, orgID string, backup ProfilesBackup) error

	// BackupProfilesByGroup retrieves all profiles for given group ID.
	BackupProfilesByGroup(ctx context.Context, token string, groupID string) (ProfilesBackup, error)

	// RestoreProfilesByGroup adds all profiles for given group ID from a backup.
	RestoreProfilesByGroup(ctx context.Context, token string, groupID string, backup ProfilesBackup) error

	// Restore adds things, profiles, groups, and groups memberships from a backup. Only accessible by admin.
	Restore(ctx context.Context, token string, backup Backup) error

	// GetThingIDsByProfile returns the IDs of all things associated with the given profile ID.
	GetThingIDsByProfile(ctx context.Context, profileID string) ([]string, error)

	Groups

	GroupMemberships
}

type Thing struct {
	ID          string
	GroupID     string
	ProfileID   string
	Name        string
	Key         string
	ExternalKey string
	Metadata    Metadata
}

type ThingAccessReq struct {
	ThingKey
	ID string
}

type ThingCache interface {
	// Save stores the pair (thing key, thing id).
	Save(ctx context.Context, key ThingKey, thingID string) error

	// ID returns thing ID for a given thing key.
	ID(ctx context.Context, key ThingKey) (string, error)

	// RemoveThing removes thing from cache.
	RemoveThing(context.Context, string) error

	// RemoveKey removes a specific thing key from the cache.
	RemoveKey(ctx context.Context, key ThingKey) error

	// SaveGroup stores group ID by given thing ID.
	SaveGroup(context.Context, string, string) error

	// ViewGroup returns group ID by given thing ID.
	ViewGroup(context.Context, string) (string, error)

	// RemoveGroup removes group ID by given thing ID.
	RemoveGroup(context.Context, string) error
}

type ThingKey struct {
	Value string `json:"key"`
	Type  string `json:"type"`
}

type ThingRepository interface {
	// Save persists multiple things. Things are saved using a transaction. If one thing
	// fails then none will be saved. Successful operation is indicated by non-nil
	// error response.
	Save(ctx context.Context, ths ...Thing) ([]Thing, error)

	// Update performs an update to the existing thing. A non-nil error is
	// returned to indicate operation failure.
	Update(ctx context.Context, t Thing) error

	// UpdateGroupAndProfile performs a an update of an existing Thing's Profile and/or Group. A non-nil error is
	// returned to indicate operation failure.
	UpdateGroupAndProfile(ctx context.Context, t Thing) error

	// RetrieveByID retrieves the thing having the provided identifier, that is owned
	// by the specified user.
	RetrieveByID(ctx context.Context, id string) (Thing, error)

	// RetrieveByKey returns thing ID for given thing key based on its type.
	RetrieveByKey(ctx context.Context, key ThingKey) (string, error)

	// RetrieveByGroups retrieves the subset of things specified by given group ids.
	RetrieveByGroups(ctx context.Context, groupIDs []string, pm apiutil.PageMetadata) (ThingsPage, error)

	// RetrieveByProfile retrieves the subset of things assigned to the specified profile.
	RetrieveByProfile(ctx context.Context, prID string, pm apiutil.PageMetadata) (ThingsPage, error)

	// BackupByGroups retrieves all things specified by given group ids.
	BackupByGroups(ctx context.Context, groupIDs []string) ([]Thing, error)

	// Remove removes the things having the provided identifiers, that is owned
	// by the specified user.
	Remove(ctx context.Context, ids ...string) error

	// BackupAll retrieves all things for all users.
	BackupAll(ctx context.Context) ([]Thing, error)

	// RetrieveAll retrieves all things for all users with pagination.
	RetrieveAll(ctx context.Context, pm apiutil.PageMetadata) (ThingsPage, error)

	// UpdateExternalKey sets/updates the external key of the Thing identified by `thingID`.
	UpdateExternalKey(ctx context.Context, key, thingID string) error

	// RemoveExternalKey removes an external key from the thing identified by `thingID`.
	RemoveExternalKey(ctx context.Context, thingID string) error
}

type ThingsBackup struct {
	Things []Thing
}

type ThingsPage struct {
	Total  uint64
	Things []Thing
}

type Transformer struct {
	DataFilters  []string `json:"data_filters"`
	DataField    string   `json:"data_field"`
	TimeField    string   `json:"time_field"`
	TimeFormat   string   `json:"time_format"`
	TimeLocation string   `json:"time_location"`
}

type UserAccessReq struct {
	Token  string
	ID     string
	Action string
}