@codecademy/tracking 1.0.3-alpha.49041f645.0 → 1.0.3-alpha.baf09f912.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecademy/tracking",
   "description": "Tracking library for Codecademy",
-  "version": "1.0.3-alpha.49041f645.0",
+  "version": "1.0.3-alpha.baf09f912.0",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "dependencies": {
     "@babel/runtime": "^7.12.1"
@@ -16,5 +16,5 @@
     "access": "public"
   },
   "repository": "git@github.com:codecademy-engineering/mono.git",
-  "gitHead": "b6518e3dcad38e4ed8ac1eb02ca484649fd14e9c"
+  "gitHead": "5a5ccc11f8bb80d0e4b39aef485cba264ffc7b18"
 }

package/dist/events/index.d.ts

@@ -1,3 +0,0 @@
-export * from './track';
-export * from './user';
-export * from './types';

package/dist/events/track.d.ts

@@ -1,12 +0,0 @@
-import type { BaseEventData, EventDataTypes, TrackingOptions, UserClickData, UserImpressionData, UserVisitData } from './types';
-export declare type TrackerOptions = {
-    apiBaseUrl: string;
-    verbose?: boolean;
-};
-export declare const createTracker: ({ apiBaseUrl, verbose }: TrackerOptions) => {
-    event: <Category extends keyof EventDataTypes, Event_1 extends string & keyof EventDataTypes[Category], Data extends EventDataTypes[Category][Event_1] & BaseEventData>(category: Category, event: Event_1, userData: Data, options?: TrackingOptions) => void;
-    click: (data: UserClickData) => void;
-    impression: (data: UserImpressionData) => void;
-    visit: (data: UserVisitData) => void;
-    pushDataLayerEvent: (eventName: string) => void;
-};

package/dist/events/types.d.ts

@@ -1,250 +0,0 @@
-/**
- * The Data types for all of our events.
- * Follows the format EventDataTypes[Category].[Event].EventData
- * Category + Event gives the corresponding event table in redshift
- */
-export declare type EventDataTypes = {
-    user: {
-        click: UserClickData;
-        visit: UserVisitData;
-        impression: UserImpressionData;
-        email_trigger: BaseEventAnyData;
-        content_completed: BaseEventAnyData;
-        submit: BaseEventAnyData;
-        workspace_init: BaseEventAnyData;
-        meaningful_content_loaded: BaseEventAnyData;
-        practice_completed: BaseEventAnyData;
-    };
-    ad: {
-        click: BaseEventAnyData;
-        impression: BaseEventAnyData;
-    };
-    calendar: {
-        reminder: BaseEventAnyData;
-    };
-    notification: {
-        clicked: BaseEventAnyData;
-        ion: BaseEventAnyData;
-    };
-    form: {
-        submit: BaseEventAnyData;
-    };
-    sorting_quiz: {
-        result: BaseEventAnyData;
-        impression: BaseEventAnyData;
-        answer: EventAnswerData;
-    };
-    onboarding_survey: {
-        answer: BaseEventAnyData;
-        recommendation: BaseEventAnyData;
-        user_selected_recommendation: BaseEventAnyData;
-    };
-    exercise: {
-        force_pass: BaseEventAnyData;
-    };
-    experiment: {
-        contentful_experiment_assignment_event: BaseEventAnyData;
-    };
-    payments: {
-        cancel_survey: BaseEventAnyData;
-    };
-    search: {
-        visit: BaseEventAnyData;
-        click: BaseEventAnyData;
-        query: BaseEventAnyData;
-        result: BaseEventAnyData;
-    };
-    page: {
-        career_path_visited: PagePathVisitedData;
-        skill_path_visited: PagePathVisitedData;
-        course_page_visited: CoursePageVisitedData;
-    };
-    business: {
-        filter_event: BusinessFilterData;
-        search_event: BusinessSearchData;
-    };
-};
-/**
- * Base event data shared by all events
- */
-export declare type BaseEventData = {
-    fullpath?: null;
-    search?: null;
-    path?: null;
-    title?: null;
-    url?: null;
-    referrer?: string | null;
-    id?: null;
-};
-/**
- * Generic type to use for event data not typed yet
- */
-export declare type BaseEventAnyData = BaseEventData & {
-    [key: string]: any;
-};
-/**
- * Options to pass to the tracking function
- */
-export declare type TrackingOptions = {
-    /** tells backend not to merge user-identifying data onto the event payload */
-    gdprSafe?: boolean;
-};
-/**
- * The Content IDs related to the current event, to help build the content context of the event.
- * These IDs get hashed into a single value and overwrite content_id before they are sent to
- * redshift in lib/content_group_id.rb
- */
-export declare type TrackingContentIds = {
-    assessment_id?: string;
-    content_item_id?: string;
-    exercise_id?: string;
-    learning_standard_id?: string;
-    module_id?: string;
-    path_id?: string;
-    program_id?: string;
-    program_unit_id?: string;
-    review_card_id?: string;
-    track_id?: string;
-    journey_id?: string;
-};
-/**
- * Shared data relevant for all user events
- */
-export declare type UserSharedData = BaseEventData & {
-    /** the click target of the event */
-    target?: string;
-    /** the page the event is coming from */
-    page_name?: string;
-    /** a context id for the event, for events that occur in more than one place */
-    context?: string;
-    /** the link being clicked on */
-    href?: string;
-    /** a version id for the element (ex. different version ids for redesigns) */
-    version?: string;
-    /** an object of content ids related to this event */
-    content_ids?: TrackingContentIds;
-    /** the repo that this event is being fired from */
-    source_codebase?: string;
-    /** Should be used for arbitrary JSON that has been passed through JSON.stringify. */
-    misc?: string;
-};
-/**
- * Data sent to user click event table
- * NOTE: avoid adding additional properties to these objects
- * Instead, reuse existing properties, or make any additional properties generic so that they can be reused.
- * https://www.notion.so/codecademy/Guide-to-Event-Tracking-Schema-5d40b09a297743f7a30a2690208194c8#800bbf6cdf2e44de9823cd75bcc574e5
- */
-export declare type UserClickData = UserSharedData & {
-    target: string;
-    id?: string;
-    distinct_id?: string;
-    content_id?: string;
-    slug?: string;
-    name?: string;
-    action?: string;
-    type?: string;
-    location?: string;
-    element?: string;
-    weekly_goal?: string | number;
-    complete?: string;
-    video_url?: string;
-    path_id?: string;
-    path_slug?: string;
-    event_name?: string;
-    onboarding_entrypoint?: string;
-    content_slug?: string;
-    module_id?: string;
-    track_slug?: string;
-    module_slug?: string;
-    button?: string;
-    current_challenge_day?: string | number;
-    track_id?: string;
-    course?: string;
-    path_name?: string;
-    event_id?: string;
-    unit?: string;
-    lesson?: string;
-    community_prompt?: string;
-    contentItem?: any;
-    unit_slug?: string;
-    course_slug?: string;
-    course_progress?: number;
-    assessment_id?: string;
-    container_slugs?: string[];
-    search_id?: string;
-    is_ugc?: boolean;
-    business_user?: BaseEventAnyData;
-};
-/**
- * Data sent to user visit event table
- * NOTE: avoid adding additional properties to these objects
- * Instead, reuse existing properties, or make any additional properties generic so that they can be reused.
- * https://www.notion.so/codecademy/Guide-to-Event-Tracking-Schema-5d40b09a297743f7a30a2690208194c8#800bbf6cdf2e44de9823cd75bcc574e5
- */
-export declare type UserVisitData = UserSharedData & {
-    page_name: string;
-    category?: string;
-    distinct_id?: string;
-    type?: string;
-    target?: string;
-    section?: string;
-    plan?: string;
-    path_id?: string;
-    post?: string;
-    story_type?: string;
-    path_title?: string;
-    onboarding_entrypoint?: string;
-    course_slug?: string;
-    course?: string;
-    interstitial_name?: string;
-    content_id?: string;
-    story_slug?: string;
-    unit?: string;
-    lesson?: string;
-    is_ugc?: boolean;
-};
-export declare type UserImpressionData = Pick<UserSharedData, 'context' | 'source_codebase' | 'content_ids'> & {
-    page_name: string;
-    target: string;
-    slug?: string;
-    is_ugc?: boolean;
-};
-export declare type EventAnswerData = BaseEventData & {
-    question_index: number;
-    answer_index: number;
-    answer: any;
-    answer_slug: string;
-};
-export declare type User = {
-    id?: string;
-    auth_token: string;
-    profile_image_url?: string;
-    email?: string;
-    is_pro?: boolean;
-    username?: string;
-    location: {
-        in_eu: boolean;
-        geo_country: string;
-    };
-    features: string[];
-};
-export declare type UseUserResponse = {
-    user?: User;
-    status: string;
-};
-export declare type PagePathVisitedData = BaseEventData & {
-    path_id: string;
-    path_full_title: string;
-};
-export declare type CoursePageVisitedData = BaseEventData & {
-    course_id: string;
-    course_full_title: string;
-};
-export declare type FilterType = string | string[] | number | boolean;
-export declare type BusinessFilterData = BaseEventData & {
-    filter_key: string;
-    filter_value: FilterType;
-};
-export declare type BusinessSearchData = BaseEventData & {
-    search_query: string;
-};

package/dist/events/user.d.ts

@@ -1,2 +0,0 @@
-import { User } from './types';
-export declare const fetchUser: (apiBaseUrl: string) => Promise<User>;

package/dist/integrations/conditionallyLoadAnalytics.d.ts

@@ -1,9 +0,0 @@
-import { SegmentAnalytics, UserIntegrationSummary } from './types';
-export declare type AnalyticsLoadOptions = {
-    analytics: SegmentAnalytics;
-    destinationPreferences: Record<string, boolean>;
-    identifyPreferences: Record<string, boolean>;
-    user?: UserIntegrationSummary;
-    writeKey: string;
-};
-export declare const conditionallyLoadAnalytics: ({ analytics, destinationPreferences, identifyPreferences, user, writeKey, }: AnalyticsLoadOptions) => void;

package/dist/integrations/consent.d.ts

@@ -1,9 +0,0 @@
-/**
- * @see https://www.notion.so/codecademy/GDPR-Compliance-141ebcc7ffa542daa0da56e35f482b41
- */
-export declare enum Consent {
-    Functional = "C0003",
-    Performance = "C0002",
-    StrictlyNecessary = "C0001",
-    Targeting = "C0004"
-}

package/dist/integrations/device.d.ts

@@ -1,13 +0,0 @@
-/**
- * @returns Whether the site is running both in ChromeOS and in PWA mode.
- */
-export declare const isChromeOSPWA: () => boolean;
-/**
- * @returns Whether the site is running in ChromeOS
- */
-export declare const isChromeOS: () => boolean;
-export declare enum ClientTypes {
-    PWA = "pwa",
-    Default = "default"
-}
-export declare const getClientType: () => ClientTypes;

package/dist/integrations/fetchDestinationsForWriteKey.d.ts

@@ -1,6 +0,0 @@
-import { SegmentDestination } from './types';
-export declare type FetchDestinationsSettings = {
-    onError: (message: string) => void;
-    writeKey: string;
-};
-export declare const fetchDestinationsForWriteKey: ({ writeKey, onError, }: FetchDestinationsSettings) => Promise<SegmentDestination[] | undefined>;

package/dist/integrations/getConsentDecision.d.ts

@@ -1,8 +0,0 @@
-import { Consent } from './consent';
-import { TrackingWindow } from './types';
-export interface ConsentDecisionOptions {
-    scope: TrackingWindow;
-    optedOutExternalTracking?: boolean;
-}
-export declare const OPT_OUT_DATALAYER_VAR = "user_opted_out_external_tracking";
-export declare const getConsentDecision: ({ scope, optedOutExternalTracking, }: ConsentDecisionOptions) => Consent[];

package/dist/integrations/index.d.ts

@@ -1,31 +0,0 @@
-import { TrackingWindow, UserIntegrationSummary } from './types';
-export declare type TrackingIntegrationsSettings = {
-    /**
-     * Called whenever a network request fails.
-     */
-    onError: (message: string) => void;
-    /**
-     * Whether this is running in a production environment.
-     */
-    production: boolean;
-    /**
-     * Global scope (often the window) where globals such as analytics are stored.
-     */
-    scope: TrackingWindow;
-    /**
-     * User details to identify in Segment.
-     */
-    user?: UserIntegrationSummary;
-    /**
-     * Whether user has opted out or is excluded from external tracking
-     */
-    optedOutExternalTracking?: boolean;
-    /**
-     * Segment write key.
-     */
-    writeKey: string;
-};
-/**
- * @see README.md for details and usage.
- */
-export declare const initializeTrackingIntegrations: ({ onError, production, scope, user, optedOutExternalTracking, writeKey, }: TrackingIntegrationsSettings) => Promise<void>;

package/dist/integrations/mapDestinations.d.ts

@@ -1,13 +0,0 @@
-import { Consent } from './consent';
-import { SegmentDestination } from './types';
-export declare type DestinationMapOptions = {
-    consentDecision?: Consent[];
-    destinations: SegmentDestination[];
-};
-/**
- * @see https://www.notion.so/codecademy/GDPR-Compliance-141ebcc7ffa542daa0da56e35f482b41
- */
-export declare const mapDestinations: ({ consentDecision, destinations, }: DestinationMapOptions) => {
-    destinationPreferences: Record<string, boolean>;
-    identifyPreferences: Record<string, boolean>;
-};

package/dist/integrations/onetrust.d.ts

@@ -1,6 +0,0 @@
-import { TrackingWindow } from './types';
-export declare type OneTrustSettings = {
-    production: boolean;
-    scope: TrackingWindow;
-};
-export declare const initializeOneTrust: ({ production, scope, }: OneTrustSettings) => Promise<void>;

package/dist/integrations/runSegmentSnippet.d.ts

@@ -1,7 +0,0 @@
-/**
- * This code is copypasta from the Segment documentation.
- * It creates the global analytics object and loads the Segment Analytics API that uses it.
- *
- * @see https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-copy-the-segment-snippet
- */
-export declare const runSegmentSnippet: () => void;

package/dist/integrations/types.d.ts

@@ -1,24 +0,0 @@
-import { Consent } from './consent';
-export interface UserIntegrationSummary {
-    email: string;
-    id: string;
-}
-export interface SegmentAnalytics {
-    identify(id: string, details: Record<string, string>, options: SegmentAnalyticsOptions): void;
-    initialize?: boolean;
-    load(writeKey: string, options: SegmentAnalyticsOptions): void;
-    page(): void;
-}
-export interface SegmentDestination {
-    category: string;
-    id: string;
-}
-export interface SegmentAnalyticsOptions {
-    integrations: Record<string, boolean>;
-}
-export interface TrackingWindow {
-    analytics?: SegmentAnalytics;
-    dataLayer?: unknown[];
-    OnetrustActiveGroups?: Consent[] | string;
-    OptanonWrapper?: () => void;
-}