groupsync

type Error string

type Group struct {
	// ID is the group's ID in the group system.
	ID string `json:"id,omitempty"`
	// Attributes represent arbitrary attributes about the group
	// in the given group system. This field is typically set by
	// the corresponding GroupReader when retrieving the group.
	Attributes any `json:"attributes,omitempty"`
}

type GroupMember struct {
	Grp *Group
}

type GroupReadWriter interface {
	GroupReader
	GroupWriter
}

type GroupReader interface {
	// Descendants retrieve all users (children, recursively) of a group.
	Descendants(ctx context.Context, groupID string) ([]*User, error)

	// GetGroup retrieves the Group with the given ID.
	GetGroup(ctx context.Context, groupID string) (*Group, error)

	// GetMembers retrieves the direct members (children) of the group with given ID.
	GetMembers(ctx context.Context, groupID string) ([]Member, error)

	// GetUser retrieves the User with the given ID.
	GetUser(ctx context.Context, userID string) (*User, error)
}

type GroupWriter interface {
	// SetMembers replaces the members of the group with the given ID with the given members.
	SetMembers(ctx context.Context, groupID string, members []Member) error
}

type ManyToManySyncer struct {
	// contains filtered or unexported fields
}

type ManyToOneSyncer struct {
	// contains filtered or unexported fields
}

type Mapping struct {
	GroupID string `json:"group_id,omitempty"`
	// The system where the Group comes from.
	System   string          `json:"system,omitempty"`
	Metadata MappingMetadata `json:"metadata,omitempty"`
}

type MappingMetadata interface {
	Combine(other MappingMetadata) MappingMetadata
}

type Member interface {
	// ID is the member's ID int the group system.
	ID() string

	// IsGroup returns whether this Member is a Group.
	IsGroup() bool

	// IsUser returns whether this Member is a User.
	IsUser() bool

	// Group returns the underlying group if this Member is a group and never an error.
	// Otherwise, if this member is a user, then it always returns an error and never a group.
	// A common pattern is to use IsGroup as a guard before using this method:
	//
	//   if member.IsGroup() {
	//      group, _ := member.Group()
	//   }
	Group() (*Group, error)

	// User returns the underlying user if this Member is a user and never an error.
	// Otherwise, if this member is a group, then it always returns an error and never a user.
	// A common pattern is to use IsUser as a guard before using this method:
	//
	//   if member.IsUser() {
	//      user, _ := member.User()
	//   }
	User() (*User, error)
}

type OneToManyGroupMapper interface {
	// AllGroupIDs returns the set of groupIDs being mapped (the key set).
	AllGroupIDs(ctx context.Context) ([]string, error)

	// ContainsGroupID returns whether this mapper contains a mapping for the given group ID.
	ContainsGroupID(ctx context.Context, groupID string) (bool, error)

	// MappedGroupIDs returns the list of group IDs mapped to the given group ID.
	MappedGroupIDs(ctx context.Context, groupID string) ([]string, error)

	// Mappings returns the list of Mappings (group ID and arbitrary metadata) mapped to the given group ID.
	Mappings(ctx context.Context, groupID string) ([]Mapping, error)
}

type OneToOneGroupMapper interface {
	// AllGroupIDs returns the set of groupIDs being mapped (the key set).
	AllGroupIDs(ctx context.Context) ([]string, error)

	// ContainsGroupID returns whether this mapper contains a mapping for the given group ID.
	ContainsGroupID(ctx context.Context, groupID string) (bool, error)

	// MappedGroupID returns the group ID mapped to the given group ID.
	MappedGroupID(ctx context.Context, groupID string) (string, error)

	// Mapping returns the Mapping (group ID and arbitrary metadata) mapped to the given group ID.
	Mapping(ctx context.Context, groupID string) (Mapping, error)
}

type OneToOneSyncer struct {
	// contains filtered or unexported fields
}

type OneToOneSyncerParams struct {
	Name              string
	SourceSystem      string
	TargetSystem      string
	SourceGroupReader GroupReader
	TargetGroupWriter GroupWriter
	SourceGroupMapper OneToOneGroupMapper
	UserMapper        UserMapper
}

type User struct {
	// ID is the user's ID in the group system.
	ID string `json:"id,omitempty"`
	// System is where the user comes from.
	System string `json:"system,omitempty"`
	// Attributes represent arbitrary attributes about the user
	// in the given group system. This field is typically set by
	// the corresponding GroupReader when retrieving the user.
	Attributes any `json:"attributes,omitempty"`
	// Metadata for a user is calculated by combining metadata
	// from multiple source groups mapping this user to a target group.
	Metadata MappingMetadata `json:"metadata,omitempty"`
}

type UserMapper interface {
	// MappedUserID returns the user ID mapped to the given user ID.
	MappedUserID(ctx context.Context, userID string) (string, error)
	// MappedUser returns the user mapped to the given user.
	MappedUser(ctx context.Context, user *User) (*User, error)
}

type UserMember struct {
	Usr *User
}