snowplow/snowplow-javascript-tracker

/*
 * Copyright (c) 2022 Snowplow Analytics Ltd, 2010 Anthon Pang
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * Schema for an Optimizely experiment context (http://developers.optimizely.com/javascript/reference/#experiments)
 */
export interface Experiment {
  id?: string | null;
  code?: string | null;
  manual?: boolean | null;
  conditional?: boolean | null;
  name?: string | null;
  variationIds?: (string | null)[];
  [key: string]: unknown;
}

/**
 * Schema for an Optimizely summary context
 */
export interface OptimizelySummary {
  activeExperimentId?: string;
  variation?: string;
  conditional?: boolean;
  manual?: boolean;
  name?: string;
  [key: string]: unknown;
}

/**
 * Schema for an Optimizely state context (http://developers.optimizely.com/javascript/reference/#state)
 */
export interface State {
  experimentId?: string | null;
  isActive?: boolean | null;
  variationIndex?: number | null;
  variationId?: string | null;
  variationName?: string | null;
  [key: string]: unknown;
}

/**
 * Schema for an Optimizely variation context (http://developers.optimizely.com/javascript/reference/#variations)
 */
export interface Variation {
  id?: string | null;
  name?: string | null;
  code?: string | null;
  [key: string]: unknown;
}

/**
 * Schema for an Optimizely visitor_audience context
 */
export interface VisitorAudience {
  id?: string | null;
  isMember?: boolean | null;
  [key: string]: unknown;
}

/**
 * Schema for an Optimizely visitor_dimension context
 */
export interface VisitorDimension {
  id?: string | null;
  value?: string | null;
  [key: string]: unknown;
}

/**
 * Schema for an Optimizely visitor context (http://developers.optimizely.com/javascript/reference/#experiments)
 */
export interface Visitor {
  browser?: string | null;
  browserVersion?: string | null;
  device?: string | null;
  deviceType?: string | null;
  ip?: string | null;
  platformId?: string | null;
  platformVersion?: string | null;
  locationCity?: string | null;
  locationRegion?: string | null;
  locationCountry?: string | null;
  mobile?: boolean | null;
  mobileId?: string | null;
  referrer?: string | null;
  os?: string | null;
  [key: string]: unknown;
}