model

type Action uint

type Applier func(rootContext Dictionary, parentContext Dictionary, key string, value Entry) (Action, Entry)

type ApplyType struct {
	URI string `yaml:"uri" json:"uri" jsonschema_description:"URI of the mask resource"`
}

type Cache interface {
	SetLookupValue(key Entry)
	Get(key Entry) (Entry, bool)
	Put(key Entry, value Entry)
	Subscribe(key Entry, observer Observer)
	Iterate() Source
}

type CacheDefinition struct {
	Unique  bool `` /* 200-byte string literal not displayed */
	Reverse bool `` /* 154-byte string literal not displayed */
}

type ChoiceInCSVType struct {
	URI             string           `yaml:"uri" json:"uri" jsonschema_description:"URI of the CSV resource"`
	Header          bool             `yaml:"header,omitempty" json:"header,omitempty" jsonschema_description:"Does the CSV resource contains a header line"`
	Separator       string           `yaml:"separator,omitempty" json:"separator,omitempty" jsonschema_description:"Separator character"`
	Comment         string           `` /* 158-byte string literal not displayed */
	FieldsPerRecord int              `` /* 200-byte string literal not displayed */
	TrimSpace       bool             `yaml:"trim,omitempty" json:"trim,omitempty" jsonschema_description:"If true leading white space in a field is ignored"`
	Identifier      EmbeddedSha3Type `yaml:"identifier,omitempty" json:"identifier,omitempty" jsonschema_description:"Configure a collision resistant ID generator"`
}

type Class struct {
	Input  string `yaml:"input" json:"input" jsonschema_description:"Characters to replace in the input value"`
	Output string `yaml:"output" json:"output" jsonschema_description:"Characters to use to generate the output value"`
}

type Collector interface {
	Collect(Entry)
}

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

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

type DateParserType struct {
	InputFormat  string `` /* 226-byte string literal not displayed */
	OutputFormat string `` /* 229-byte string literal not displayed */
}

type Definition struct {
	Version   string                     `yaml:"version" json:"version" jsonschema_description:"Version of the pipeline definition, use the value 1"`
	Seed      int64                      `` /* 129-byte string literal not displayed */
	Functions map[string]Function        `yaml:"functions,omitempty" json:"functions,omitempty" jsonschema_description:"Declare functions to be used in the masking"`
	Masking   []Masking                  `yaml:"masking" json:"masking" jsonschema_description:"Masking pipeline definition"`
	Caches    map[string]CacheDefinition `yaml:"caches,omitempty" json:"caches,omitempty" jsonschema_description:"Declare in-memory caches"`
}

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

type Dictionary struct {
	*ordered.OrderedMap
}

type EmbeddedSha3Type struct {
	Sha3Type `yaml:",inline"`
	Field    string `yaml:"field" json:"field" jsonschema_description:"Name of the identifier"`
}

type Entry interface{}

type ExactMatchType struct {
	CSV   string `yaml:"csv" json:"csv" jsonschema_description:"Characters exact to match in the csv file"`
	Entry string `yaml:"entry" json:"entry" jsonschema_description:"Characters exact to find in the entry file"`
}

type FF1Type struct {
	KeyFromEnv string  `` /* 130-byte string literal not displayed */
	TweakField string  `` /* 273-byte string literal not displayed */
	Radix      uint    `` /* 263-byte string literal not displayed */
	Domain     string  `` /* 167-byte string literal not displayed */
	Preserve   string  `` /* 136-byte string literal not displayed */
	OnError    *string `` /* 138-byte string literal not displayed */
	Decrypt    bool    `yaml:"decrypt,omitempty" json:"decrypt,omitempty" jsonschema_description:"Decrypt the value instead of encrypt"`
}

type FalsePredicate struct{}

type FindInCSVType struct {
	URI             string         `yaml:"uri" json:"uri" jsonschema_description:"URI of the CSV resource"`
	ExactMatch      ExactMatchType `` /* 147-byte string literal not displayed */
	JaccardMatch    ExactMatchType `` /* 157-byte string literal not displayed */
	Expected        string         `` /* 129-byte string literal not displayed */
	Header          bool           `yaml:"header,omitempty" json:"header,omitempty" jsonschema_description:"Does the CSV resource contains a header line"`
	Separator       string         `yaml:"separator,omitempty" json:"separator,omitempty" jsonschema_description:"Separator character"`
	Comment         string         `` /* 158-byte string literal not displayed */
	FieldsPerRecord int            `` /* 200-byte string literal not displayed */
	TrimSpace       bool           `yaml:"trim,omitempty" json:"trim,omitempty" jsonschema_description:"If true leading white space in a field is ignored"`
}

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

type Function struct {
	Params []Param `yaml:"params" json:"params" jsonschema_description:"Declare parameters function"`
	Body   string  `yaml:"body" json:"body" jsonschema_description:"Declare body function"`
}

type FunctionMaskContextEngine struct {
	Function func(Dictionary, string, ...Dictionary) (Dictionary, error)
}

type FunctionMaskEngine struct {
	Function func(Entry, ...Dictionary) (Entry, error)
}

type HasCleaner interface {
	GetCleaner() FunctionMaskContextEngine
}

type IncrementalType struct {
	Start     int `yaml:"start" json:"start" jsonschema_description:"First value in the sequence"`
	Increment int `yaml:"increment" json:"increment" jsonschema_description:"Increment to add to reach the next value in the sequence"`
}

type Iterable[T any] interface {
	Resource
	Values() iter.Seq2[T, error]
}

type LogType struct {
	Message string `` /* 156-byte string literal not displayed */
	Level   string `` /* 163-byte string literal not displayed */
}

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

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

type LuhnType struct {
	Universe string `` /* 139-byte string literal not displayed */
}

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

type Mapper func(Dictionary) (Dictionary, error)

type MarkovType struct {
	MaxSize   int    `yaml:"max-size,omitempty" json:"max-size,omitempty" jsonschema_description:"Maximum length for the generated text"`
	Sample    string `` /* 126-byte string literal not displayed */
	Separator string `` /* 158-byte string literal not displayed */
	Order     int    `` /* 209-byte string literal not displayed */
}

type MaskCacheEngine struct {
	Cache          Cache
	OriginalEngine MaskEngine
}

type MaskContextCacheEngine struct {
	Cache          Cache
	OriginalEngine MaskContextEngine
}

type MaskContextEngine interface {
	MaskContext(Dictionary, string, ...Dictionary) (Dictionary, error)
}

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

type MaskContextFactory func(MaskFactoryConfiguration) (MaskContextEngine, bool, error)

type MaskEngine interface {
	Mask(Entry, ...Dictionary) (Entry, error)
}

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

type MaskFactory func(MaskFactoryConfiguration) (MaskEngine, bool, error)

type MaskFactoryConfiguration struct {
	Masking   Masking
	Seed      int64
	Cache     map[string]Cache
	Functions tmpl.FuncMap
}

type MaskType struct {
	Add               Entry                `` /* 135-byte string literal not displayed */
	AddTransient      Entry                `` /* 217-byte string literal not displayed */
	Constant          Entry                `` /* 179-byte string literal not displayed */
	RandomChoice      []Entry              `` /* 224-byte string literal not displayed */
	RandomChoiceInURI string               `` /* 265-byte string literal not displayed */
	RandomChoiceInCSV ChoiceInCSVType      `` /* 251-byte string literal not displayed */
	Command           string               `` /* 197-byte string literal not displayed */
	RandomInt         RandIntType          `` /* 217-byte string literal not displayed */
	WeightedChoice    []WeightedChoiceType `` /* 317-byte string literal not displayed */
	Regex             string               `` /* 215-byte string literal not displayed */
	Hash              []Entry              `` /* 259-byte string literal not displayed */
	HashInURI         string               `` /* 305-byte string literal not displayed */
	HashInCSV         ChoiceInCSVType      `` /* 286-byte string literal not displayed */
	RandDate          RandDateType         `` /* 208-byte string literal not displayed */
	Incremental       IncrementalType      `` /* 207-byte string literal not displayed */
	Replacement       string               `` /* 201-byte string literal not displayed */
	Template          string               `` /* 212-byte string literal not displayed */
	TemplateEach      TemplateEachType     `` /* 280-byte string literal not displayed */
	Duration          string               `` /* 241-byte string literal not displayed */
	Remove            bool                 `` /* 163-byte string literal not displayed */
	RangeMask         int                  `` /* 182-byte string literal not displayed */
	RandomDuration    RandomDurationType   `` /* 265-byte string literal not displayed */
	FluxURI           string               `` /* 242-byte string literal not displayed */
	RandomDecimal     RandomDecimalType    `` /* 229-byte string literal not displayed */
	DateParser        DateParserType       `` /* 178-byte string literal not displayed */
	FromCache         string               `` /* 228-byte string literal not displayed */
	FF1               FF1Type              `` /* 192-byte string literal not displayed */
	Pipe              PipeType             `` /* 279-byte string literal not displayed */
	FromJSON          string               `` /* 220-byte string literal not displayed */
	Luhn              *LuhnType            `` /* 196-byte string literal not displayed */
	Markov            MarkovType           `` /* 167-byte string literal not displayed */
	Transcode         *TranscodeType       `` /* 217-byte string literal not displayed */
	FindInCSV         FindInCSVType        `` /* 242-byte string literal not displayed */
	XML               XMLType              `` /* 159-byte string literal not displayed */
	TimeLine          TimeLineType         `` /* 181-byte string literal not displayed */
	Sequence          SequenceType         `` /* 187-byte string literal not displayed */
	Sha3              Sha3Type             `` /* 184-byte string literal not displayed */
	Apply             ApplyType            `` /* 148-byte string literal not displayed */
	Partition         []PartitionType      `` /* 212-byte string literal not displayed */
	Segment           SegmentType          `` /* 191-byte string literal not displayed */
	Log               *LogType             `` /* 134-byte string literal not displayed */
}

type Masking struct {
	// Masking requires at least one Selector and one Mask definition.
	// Case1: One selector, One mask
	// Case2: One selector, Multiple masks
	// Case3: Multiple selectors, One mask
	// Case4: Multiple selectors, Multiple masks
	Selector  SelectorType   `` /* 190-byte string literal not displayed */
	Selectors []SelectorType `` /* 182-byte string literal not displayed */
	Mask      MaskType       `` /* 172-byte string literal not displayed */
	Masks     []MaskType     `` /* 174-byte string literal not displayed */
	Cache     string         `` /* 146-byte string literal not displayed */
	Preserve  string         `` /* 353-byte string literal not displayed */
	PreserveL []Entry        `yaml:"preserve-list,omitempty" json:"preserve-list,omitempty" jsonschema_description:"Preserve (do not mask) given values"`
	Seed      SeedType       `` /* 135-byte string literal not displayed */
}

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

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

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

type Observer interface {
	Notify(key Entry, value Entry)
}

type PackProcess struct{}

type Param struct {
	Name string `yaml:"name" json:"name" jsonschema_description:"Declare name parameters"`
}

type PartitionType struct {
	Name string     `yaml:"name" json:"name" jsonschema_description:"name of the partition"`
	When string     `yaml:"when,omitempty" json:"when,omitempty" jsonschema_description:"template to execute, if true the condition is active"`
	Then []MaskType `yaml:"then,omitempty" json:"then,omitempty" jsonschema_description:"list of masks to execute if the condition is active"`
}

type PipeType struct {
	Masking        []Masking `` /* 155-byte string literal not displayed */
	InjectParent   string    `` /* 177-byte string literal not displayed */
	InjectRoot     string    `` /* 171-byte string literal not displayed */
	DefinitionFile string    `` /* 128-byte string literal not displayed */
}

type Pipeline interface {
	Source() Source
	Process(Processor) Pipeline
	WithSource(Source) Pipeline
	AddSink(SinkProcess) SinkedPipeline
}

type Predicate interface {
	Reset() error
	Test(value Entry) bool
	Error() error
}

type ProcessPipeline struct {
	*ProcessWrapper
}

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

type Processor interface {
	Open() error
	ProcessDictionary(Dictionary, Collector) error
}

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

type RandDateType struct {
	DateMin time.Time `yaml:"dateMin" json:"dateMin" jsonschema_description:"Lower bound of the date range"`
	DateMax time.Time `yaml:"dateMax" json:"dateMax" jsonschema_description:"Higher bound of the date range"`
}

type RandIntType struct {
	Min int `yaml:"min" json:"min" jsonschema_description:"Lower bound of the integer range"`
	Max int `yaml:"max" json:"max" jsonschema_description:"Lower bound of the integer range"`
}

type RandomDecimalType struct {
	Min       float64 `yaml:"min" json:"min" jsonschema_description:"Lower bound of the decimal range"`
	Max       float64 `yaml:"max" json:"max" jsonschema_description:"Lower bound of the decimal range"`
	Precision int     `yaml:"precision" json:"precision" jsonschema_description:"Precision of the generated value"`
}

type RandomDurationType struct {
	Min string `yaml:"min" json:"min" jsonschema_description:"Lower bound of the duration range (ISO 8601 notation)"`
	Max string `yaml:"max" json:"max" jsonschema_description:"Higher bound of the duration range (ISO 8601 notation)"`
}

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

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

type Resource interface {
	Open() error
	Close() error
}

type SeedType struct {
	Field string `` /* 173-byte string literal not displayed */
}

type Seeder func(Dictionary) (int64, bool, error)

type SegmentType struct {
	Regex   string                `yaml:"regex" json:"regex" jsonschema_description:"regex used to create segments using group captures, groups must be named"`
	Match   map[string][]MaskType `yaml:"match" json:"match" jsonschema_description:"list of masks to execute for each group if the regex matched"`
	NoMatch []MaskType            `` /* 141-byte string literal not displayed */
}

type Selector interface {
	Apply(Dictionary, ...Applier) bool
	ApplyContext(Dictionary, ...Applier) bool

	// old interface
	Delete(Dictionary) Dictionary
	ReadContext(Dictionary) (Dictionary, string, bool)
	WriteContext(Dictionary, Entry) Dictionary
	Read(Dictionary) (Entry, bool)
	Write(Dictionary, Entry) Dictionary

	fmt.Stringer
}

type SelectorType struct {
	Jsonpath string `yaml:"jsonpath" json:"jsonpath" jsonschema_description:"Path of the target value to mask in the JSON input"`
}

type SequenceType struct {
	Format  string `yaml:"format" json:"format" jsonschema_description:"Format of the sequenced ID"`
	Varying string `` /* 140-byte string literal not displayed */
}

type Sha3Type struct {
	Length     int    `` /* 146-byte string literal not displayed */
	Resistance int    `` /* 165-byte string literal not displayed */
	Domain     string `` /* 155-byte string literal not displayed */
	MaxStrLen  int    `` /* 158-byte string literal not displayed */
}

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

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

type SinkProcess interface {
	Open() error
	ProcessDictionary(Entry) error
}

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

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

type SinkedPipeline interface {
	Run() error
}

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

type Source Iterable[Entry]

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

type TemplateEachType struct {
	Item     string `` /* 128-byte string literal not displayed */
	Index    string `` /* 130-byte string literal not displayed */
	Template string `` /* 152-byte string literal not displayed */
}

type TimeLineConstraintType struct {
	Before  string `` /* 160-byte string literal not displayed */
	After   string `` /* 156-byte string literal not displayed */
	OnError string `` /* 281-byte string literal not displayed */
	Epsilon string `` /* 138-byte string literal not displayed */
}

type TimeLinePointType struct {
	Name        string                   `yaml:"name" json:"name" jsonschema_description:"Name of the point in the timeline"`
	From        string                   `` /* 133-byte string literal not displayed */
	Min         string                   `yaml:"min" json:"min" jsonschema_description:"Minimum shift relative to the reference point (ISO 8601 notation)"`
	Max         string                   `yaml:"max" json:"max" jsonschema_description:"Maximum shift relative to the reference point (ISO 8601 notation)"`
	Constraints []TimeLineConstraintType `yaml:"constraints,omitempty" json:"constraints,omitempty" jsonschema_description:"List of constraints to fulfill"`
	Default     string                   `` /* 173-byte string literal not displayed */
}

type TimeLineStartType struct {
	Name  string `yaml:"name" json:"name" jsonschema_description:"Name of the starting point in the timeline"`
	Value string `` /* 187-byte string literal not displayed */
}

type TimeLineType struct {
	Start    TimeLineStartType   `yaml:"start" json:"start" jsonschema_description:"Origin of the timeline"`
	Format   string              `` /* 207-byte string literal not displayed */
	Points   []TimeLinePointType `yaml:"points" json:"points" jsonschema_description:"List of points in the timeline"`
	MaxRetry *int                `` /* 142-byte string literal not displayed */
	Epsilon  string              `` /* 133-byte string literal not displayed */
}

type TranscodeType struct {
	Classes []Class `` /* 146-byte string literal not displayed */
}

type TruePredicate struct{}

type UniqueCache interface {
	Cache
	PutUnique(key Entry, value Entry) bool
}

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

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

type UniqueMemCache struct {
	MemCache
	// contains filtered or unexported fields
}

type UnpackProcess struct{}

type WeightedChoiceType struct {
	Choice Entry `yaml:"choice" json:"choice" jsonschema_description:"Value for this choice"`
	Weight uint  `yaml:"weight" json:"weight" jsonschema_description:"Weight of this choice, higher weights will be selected more frequently"`
}

type XMLType struct {
	XPath        string    `yaml:"xpath" json:"xpath" jsonschema_description:"Specifies the XPath expression to target the XML"`
	InjectParent string    `` /* 158-byte string literal not displayed */
	Masking      []Masking `` /* 138-byte string literal not displayed */
}