Mapping

The Mapping.Config stores all individual Mapping.EventConfig configurations for each entity-action event. The getMappingEvent function returns the matching event mapping while the getMappingValue is used to resolve a Mapping.Value settings for a specific property to return an actual value. The custom property is used by each destination individually.

getMappingEvent

getMappingEvent(event: string, mapping?: Mapping.Config<unknown>): EventMapping returns the matching eventMapping configuration and the used mappingKey for the given entity-action event name. If no mapping is found, it will return an empty object. An explicit key is favored over an asterisk * key. If available a condition will be checked to determine if the EventConfig applies. It's used by the sources.

Configuration

getMappingEvent(
  { event: 'entity action' },
  {
    entity: {
      action: { name: 'entity_action' },
    },
  }
);

getMappingEvent( { event: 'entity action' }, { entity: { action: { name: 'entity_action' }, }, } );

Result

0

0

Specify multiple Mapping.EventConfig as an array and use condition to check which EventConfig should be used. To test uncomment the globals property.

Configuration

getMappingEvent(
  {
    event: 'order complete',
    // globals: { env: 'prod' },
  },
  {
    order: {
      complete: [
        {
          // EventConfig only for production
          condition: (event) =>
            event.globals?.env === 'prod',
          ignore: true,
        },
        { name: 'purchase' }, // Fallback EventConfig
      ],
    },
  }
);

getMappingEvent( { event: 'order complete', // globals: { env: 'prod' }, }, { order: { complete: [ { // EventConfig only for production condition: (event) => event.globals?.env === 'prod', ignore: true, }, { name: 'purchase' }, // Fallback EventConfig ], }, } );

Result

0

0

getMappingValue

getMappingValue(event: WalkerOS.Event, mapping: Mapping.Value, options?: Mapping.Options): WalkerOS.Property | undefined primarily used by destinations to process values from the original event. This offers flexibility to configure individual tagging setups to standard fields of the destination.

string

Configuration

getMappingValue(
  { a: 0, b: 1, c: 2 },
  'b',
)

getMappingValue( { a: 0, b: 1, c: 2 }, 'b', )

Result

1

1

Configuration

getMappingValue(
  { arr: ['foo', 'bar'] },
  'arr.1',
);

getMappingValue( { arr: ['foo', 'bar'] }, 'arr.1', );

Result

"bar"

"bar"

key

Configuration

getMappingValue(
  { foo: 'bar' },
  { key: 'foo' },
);

getMappingValue( { foo: 'bar' }, { key: 'foo' }, );

Result

"bar"

"bar"

value

Configuration

getMappingValue({}, { value: 'foo' });

getMappingValue({}, { value: 'foo' });

Result

"foo"

"foo"

fn

Configuration

getMappingValue(
  { foo: 'bar' },
  { fn: (obj) => obj.foo.toUpperCase() },
);

getMappingValue( { foo: 'bar' }, { fn: (obj) => obj.foo.toUpperCase() }, );

Result

"BAR"

"BAR"

map

Configuration

getMappingValue(
  { foo: 'bar' },
  {
    map: {
      foo: 'foo',
      bar: { value: 'baz' },
      obj: { map: { recursive: { value: true } } },
    },
  },
);

getMappingValue( { foo: 'bar' }, { map: { foo: 'foo', bar: { value: 'baz' }, obj: { map: { recursive: { value: true } } }, }, }, );

Result

{
  foo: 'bar',
  bar: 'baz',
  obj: { recursive: true },
}

{ foo: 'bar', bar: 'baz', obj: { recursive: true }, }

loop

Configuration

getMappingValue(
  { arr: [{ id: 'foo' }, { id: 'bar' }] },
  { loop: ['arr', 'id'] },
);

getMappingValue( { arr: [{ id: 'foo' }, { id: 'bar' }] }, { loop: ['arr', 'id'] }, );

Result

['foo', 'bar']

['foo', 'bar']

validate

Configuration

getMappingValue(
  { foo: 'bar' },
  {
    key: 'foo',
    validate: (v) => v === 'bar',
  },
);

getMappingValue( { foo: 'bar' }, { key: 'foo', validate: (v) => v === 'bar', }, );

Result

"bar"

"bar"

consent

Configuration

getMappingValue(
  {
    name: 'foo',
    consent: {
      functional: true,
      // marketing: true // uncomment me
    },
  },
  {
    key: 'name',
    consent: { marketing: true }, // required consent
  },
);

getMappingValue( { name: 'foo', consent: { functional: true, // marketing: true // uncomment me }, }, { key: 'name', consent: { marketing: true }, // required consent }, );

Result

undefined (no marketing consent)

undefined (no marketing consent)

First the condition is checked to determine if the ValueConfig should be used. Second, the consent state gets checked if an instance is provided. If no required consent is given, no value will be returned. If a fn is provided, it will be called to define the value, otherwise the key or initial string value will be used with byPath. The current value will be check using the validate function and set to undefined if it fails. Finally, the value will be cast to match the WalkerOS.Property type. An empty ValueType will return undefined.

info

If you need professional support with your walkerOS implementation, check out our services.