gqlshield

type ClientRole struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
}

type Config struct {
	// WhitelistOption enables query whitelisting when true
	WhitelistOption WhitelistOption

	// PersistencyManager is used for configuration state persistency.
	// Persistency is disabled if PersistencyManager is nil
	PersistencyManager PersistencyManager
}

type Entry struct {
	Query          string
	Name           string
	Parameters     map[string]Parameter
	WhitelistedFor []int
}

type Error struct {
	Code    ErrorCode
	Message string
}

type ErrorCode string

type GraphQLShield interface {
	// WhitelistQueries adds the given queries to the whitelist
	// returning an error if one of the queries doesn't meet the requirements.
	WhitelistQueries(newEntry ...Entry) ([]Query, error)

	// RemoveQuery removes a query from the whitelist and returns true
	// if any query was removed as well as the actual removed query.
	RemoveQuery(query Query) error

	// Check returns an error if the given query isn't allowed for the given
	// client role to be executed or if the provided arguments are unacceptable.
	//
	// WARNING: query will be mutated during normalization! Manually copy the
	// query byte-slice if you don't want your inputs to be mutated.
	Check(
		clientRole int,
		query []byte,
		arguments map[string]*string,
	) ([]byte, error)

	// ListQueries returns all whitelisted queries.
	ListQueries() (map[string]Query, error)
}

type ID string

type Parameter struct {
	MaxValueLength uint32 `json:"max-value-length"`
}

type PersistencyManager interface {
	// Load loads the GraphQL shield configuration
	Load() (*State, error)

	// Save persists the GraphQL shield configuration
	Save(*State) error
}

type Query interface {
	// Query returns a copy of the query string
	Query() []byte

	// ID returns the unique identifier of the query
	ID() ID

	// Creation returns the time of creation
	Creation() time.Time

	// Name returns the query name
	Name() string

	// Parameters returns a copy of the list of query parameters
	Parameters() map[string]Parameter

	// WhitelistedFor returns the copy of role IDs the query is whitelisted for
	WhitelistedFor() []int
}

type QueryModel struct {
	Query          string               `json:"query"`
	Creation       time.Time            `json:"creation"`
	Name           string               `json:"name"`
	Parameters     map[string]Parameter `json:"parameters"`
	WhitelistedFor []int                `json:"whitelisted-for"`
}

type State struct {
	Roles              []ClientRole          `json:"roles"`
	WhitelistedQueries map[string]QueryModel `json:"whitelisted-queries"`
}

type WhitelistOption byte