@elbwalker/tagger/dist/index.d.ts

A helper to set up tracking based on walkerOS

import { Walker } from '@elbwalker/types';

declare namespace ITagger {
  interface Config {
    prefix: string;
  }

  export interface Instance {
    config: Config;
    entity: (name: string) => Walker.Properties;
    action: ActionMethod;
    property: PropertyMethod;
    context: ContextMethod;
    globals: GlobalsMethod;
  }

  type ActionMethod = {
    (trigger: Trigger, action?: string): Walker.Properties;
    (triggerActions: KevVal): Walker.Properties;
  };

  type ContextMethod = {
    (context: string, value?: Walker.Property): Walker.Properties;
    (context: KevVal): Walker.Properties;
  };

  type GlobalsMethod = {
    (global: string, value?: Walker.Property): Walker.Properties;
    (global: KevVal): Walker.Properties;
  };

  type PropertyMethod = {
    (entity: string, prop: string, value?: Walker.Property): Walker.Properties;
    (entity: string, properties: KevVal): Walker.Properties;
  };

  interface KevVal {
    [key: string | Trigger]: Walker.Property;
  }

  type Trigger =
    | 'click'
    | 'custom'
    | 'hover'
    | 'load'
    | 'pulse'
    | 'submit'
    | 'visible'
    | 'wait'
    | string;
}

declare function Tagger(config?: Partial<ITagger.Config>): ITagger.Instance;

export { Tagger as default };