@patternfly/chatbot 2.2.0-prerelease.43 → 2.2.0-prerelease.44

package/dist/cjs/tracking/console_tracking_provider.d.ts

@@ -1,10 +1,9 @@
-import { TrackingSpi } from './tracking_spi';
+import { InitProps, TrackingSpi } from './tracking_spi';
 import { TrackingApi, TrackingEventProperties } from './tracking_api';
 export declare class ConsoleTrackingProvider implements TrackingSpi, TrackingApi {
+    private verbose;
     trackPageView(url: string | undefined): void;
-    registerProvider(): void;
-    initialize(): void;
-    identify(userID: string): void;
+    initialize(props: InitProps): void;
+    identify(userID: string, userProperties?: TrackingEventProperties): void;
     trackSingleItem(item: string, properties?: TrackingEventProperties): void;
-    getKey(): string;
 }

package/dist/cjs/tracking/console_tracking_provider.js

@@ -2,26 +2,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConsoleTrackingProvider = void 0;
 class ConsoleTrackingProvider {
+    constructor() {
+        this.verbose = false;
+    }
     trackPageView(url) {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider pageView', url);
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider pageView ', url);
+        }
     }
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    registerProvider() { }
-    initialize() {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider initialize');
+    initialize(props) {
+        this.verbose = props.verbose;
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider initialize');
+        }
     }
-    identify(userID) {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider identify', userID);
+    identify(userID, userProperties = {}) {
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider identify ', userID, userProperties);
+        }
     }
     trackSingleItem(item, properties) {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider: ' + item, properties);
-    }
-    getKey() {
-        return 'console';
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider: ' + item, properties);
+        }
     }
 }
 exports.ConsoleTrackingProvider = ConsoleTrackingProvider;

package/dist/cjs/tracking/posthog_tracking_provider.d.ts

@@ -1,9 +1,9 @@
 import { TrackingApi, TrackingEventProperties } from './tracking_api';
 import { InitProps, TrackingSpi } from './tracking_spi';
 export declare class PosthogTrackingProvider implements TrackingSpi, TrackingApi {
-    getKey(): string;
+    private verbose;
     initialize(props: InitProps): void;
-    identify(userID: string): void;
+    identify(userID: string, userProperties?: TrackingEventProperties): void;
     trackPageView(url: string | undefined): void;
     trackSingleItem(item: string, properties?: TrackingEventProperties): void;
 }

package/dist/cjs/tracking/posthog_tracking_provider.js

@@ -3,12 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PosthogTrackingProvider = void 0;
 const posthog_js_1 = require("posthog-js");
 class PosthogTrackingProvider {
-    getKey() {
-        return 'posthogKey';
+    constructor() {
+        this.verbose = false;
     }
     initialize(props) {
-        // eslint-disable-next-line no-console
-        console.log('PosthogProvider initialize');
+        this.verbose = props.verbose;
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('PosthogProvider initialize');
+        }
         const posthogKey = props.posthogKey;
         posthog_js_1.posthog.init(posthogKey, {
             // eslint-disable-next-line camelcase
@@ -17,20 +20,26 @@ class PosthogTrackingProvider {
             person_profiles: 'identified_only' // or 'always' to create profiles for anonymous users as well
         });
     }
-    identify(userID) {
-        // eslint-disable-next-line no-console
-        console.log('PosthogProvider userID: ' + userID);
-        posthog_js_1.posthog.identify(userID);
+    identify(userID, userProperties = {}) {
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('PosthogProvider userID: ' + userID);
+        }
+        posthog_js_1.posthog.identify(userID, userProperties);
     }
     trackPageView(url) {
-        // eslint-disable-next-line no-console
-        console.log('PostHogProvider url', url);
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('PostHogProvider url ', url);
+        }
         // TODO posthog seems to record that automatically.
         //  How to not clash with this here? Just leave as no-op?
     }
     trackSingleItem(item, properties) {
-        // eslint-disable-next-line no-console
-        console.log('PosthogProvider: trackSingleItem' + item, properties);
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('PosthogProvider: trackSingleItem ' + item, properties);
+        }
         posthog_js_1.posthog.capture(item, { properties });
     }
 }

package/dist/cjs/tracking/segment_tracking_provider.d.ts

@@ -2,9 +2,9 @@ import { TrackingApi, TrackingEventProperties } from './tracking_api';
 import { InitProps, TrackingSpi } from './tracking_spi';
 export declare class SegmentTrackingProvider implements TrackingSpi, TrackingApi {
     private analytics;
-    getKey(): string;
+    private verbose;
     initialize(props: InitProps): void;
-    identify(userID: string): void;
+    identify(userID: string, userProperties?: TrackingEventProperties): void;
     trackPageView(url: string | undefined): void;
     trackSingleItem(item: string, properties?: TrackingEventProperties): void;
 }

package/dist/cjs/tracking/segment_tracking_provider.js

@@ -3,12 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SegmentTrackingProvider = void 0;
 const analytics_next_1 = require("@segment/analytics-next");
 class SegmentTrackingProvider {
-    getKey() {
-        return 'segmentKey';
+    constructor() {
+        this.verbose = false;
     }
     initialize(props) {
-        // eslint-disable-next-line no-console
-        console.log('SegmentProvider initialize');
+        this.verbose = props.verbose;
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('SegmentProvider initialize');
+        }
         const segmentKey = props.segmentKey;
         // We need to create an object here, as ts lint is unhappy otherwise
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -20,16 +23,20 @@ class SegmentTrackingProvider {
             integrations: Object.assign({}, integrations)
         });
     }
-    identify(userID) {
-        // eslint-disable-next-line no-console
-        console.log('SegmentProvider userID: ' + userID);
+    identify(userID, userProperties = {}) {
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('SegmentProvider userID: ' + userID);
+        }
         if (this.analytics) {
-            this.analytics.identify(userID);
+            this.analytics.identify(userID, userProperties);
         }
     }
     trackPageView(url) {
-        // eslint-disable-next-line no-console
-        console.log('SegmentProvider url', url);
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('SegmentProvider url ', url);
+        }
         if (this.analytics) {
             if (url) {
                 this.analytics.page(url);
@@ -40,8 +47,10 @@ class SegmentTrackingProvider {
         }
     }
     trackSingleItem(item, properties) {
-        // eslint-disable-next-line no-console
-        console.log('SegmentProvider: trackSingleItem' + item, properties);
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('SegmentProvider: trackSingleItem ' + item, properties);
+        }
         if (this.analytics) {
             this.analytics.track(item, { properties });
         }

package/dist/cjs/tracking/trackingProviderProxy.d.ts

@@ -2,7 +2,7 @@ import { TrackingApi, TrackingEventProperties } from './tracking_api';
 declare class TrackingProviderProxy implements TrackingApi {
     providers: TrackingApi[];
     constructor(providers: TrackingApi[]);
-    identify(userID: string): void;
+    identify(userID: string, userProperties?: TrackingEventProperties): void;
     trackSingleItem(eventName: string, properties?: TrackingEventProperties): void;
     trackPageView(url: string | undefined): void;
 }

package/dist/cjs/tracking/trackingProviderProxy.js

@@ -5,9 +5,9 @@ class TrackingProviderProxy {
         this.providers = [];
         this.providers = providers;
     }
-    identify(userID) {
+    identify(userID, userProperties = {}) {
         for (const provider of this.providers) {
-            provider.identify(userID);
+            provider.identify(userID, userProperties);
         }
     }
     trackSingleItem(eventName, properties) {

package/dist/cjs/tracking/tracking_api.d.ts

@@ -2,7 +2,7 @@ export interface TrackingEventProperties {
     [key: string]: string | number | boolean | undefined;
 }
 export interface TrackingApi {
-    identify: (userID: string) => void;
+    identify: (userID: string, userProperties: TrackingEventProperties) => void;
     trackPageView: (url: string | undefined) => void;
     trackSingleItem: (eventName: string, properties: TrackingEventProperties | undefined) => void;
 }

package/dist/cjs/tracking/tracking_registry.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTrackingProviders = void 0;
+const tracking_spi_1 = require("./tracking_spi");
 const trackingProviderProxy_1 = __importDefault(require("./trackingProviderProxy"));
 const console_tracking_provider_1 = require("./console_tracking_provider");
 const segment_tracking_provider_1 = require("./segment_tracking_provider");
@@ -11,23 +12,56 @@ const posthog_tracking_provider_1 = require("./posthog_tracking_provider");
 const umami_tracking_provider_1 = require("./umami_tracking_provider");
 const getTrackingProviders = (initProps) => {
     const providers = [];
-    providers.push(new segment_tracking_provider_1.SegmentTrackingProvider());
-    providers.push(new posthog_tracking_provider_1.PosthogTrackingProvider());
-    providers.push(new umami_tracking_provider_1.UmamiTrackingProvider());
-    // TODO dynamically find and register providers
+    if (initProps.activeProviders) {
+        let tmpProps = initProps.activeProviders;
+        // Theoretically we get an array of provider names, but it could also be a CSV string...
+        if (!Array.isArray(initProps.activeProviders)) {
+            const tmpString = initProps.activeProviders;
+            if (tmpString && tmpString.indexOf(',') !== -1) {
+                tmpProps = tmpString.split(',');
+            }
+            else {
+                tmpProps = [tmpString];
+            }
+        }
+        tmpProps.forEach((provider) => {
+            switch (tracking_spi_1.Providers[provider]) {
+                case tracking_spi_1.Providers.Segment:
+                    providers.push(new segment_tracking_provider_1.SegmentTrackingProvider());
+                    break;
+                case tracking_spi_1.Providers.Umami:
+                    providers.push(new umami_tracking_provider_1.UmamiTrackingProvider());
+                    break;
+                case tracking_spi_1.Providers.Posthog:
+                    providers.push(new posthog_tracking_provider_1.PosthogTrackingProvider());
+                    break;
+                case tracking_spi_1.Providers.Console:
+                    providers.push(new console_tracking_provider_1.ConsoleTrackingProvider());
+                    break;
+                case tracking_spi_1.Providers.None: // Do nothing, just a placeholder
+                    break;
+                default:
+                    if (providers.length > 1) {
+                        if (initProps.verbose) {
+                            // eslint-disable-next-line no-console
+                            console.error("Unknown provider '" + provider);
+                        }
+                    }
+                    break;
+            }
+        });
+    }
     // Initialize them
-    const enabledProviders = [];
     for (const provider of providers) {
-        const key = provider.getKey();
-        if (Object.keys(initProps).indexOf(key) > -1) {
+        try {
             provider.initialize(initProps);
-            enabledProviders.push(provider);
+        }
+        catch (e) {
+            // eslint-disable-next-line no-console
+            console.error(e);
         }
     }
-    // Add the console provider
-    const consoleTrackingProvider = new console_tracking_provider_1.ConsoleTrackingProvider();
-    enabledProviders.push(consoleTrackingProvider); // TODO noop- provider?
-    return new trackingProviderProxy_1.default(enabledProviders);
+    return new trackingProviderProxy_1.default(providers);
 };
 exports.getTrackingProviders = getTrackingProviders;
 exports.default = exports.getTrackingProviders;

package/dist/cjs/tracking/tracking_spi.d.ts

@@ -1,9 +1,19 @@
-import { TrackingApi, TrackingEventProperties } from './tracking_api';
-export interface InitProps {
-    [key: string]: string | number | boolean;
+import { TrackingApi } from './tracking_api';
+export declare enum Providers {
+    None = 0,
+    Segment = 1,
+    Umami = 2,
+    Posthog = 3,
+    Console = 4
+}
+export type ProviderAsString = keyof typeof Providers;
+export interface BaseProps {
+    verbose: boolean;
+    activeProviders: [ProviderAsString];
 }
+export type InitProps = {
+    [key: string]: string | number | boolean;
+} & BaseProps;
 export interface TrackingSpi extends TrackingApi {
-    getKey: () => string;
     initialize: (props: InitProps) => void;
-    trackSingleItem: (item: string, properties?: TrackingEventProperties) => void;
 }

package/dist/cjs/tracking/tracking_spi.js

@@ -1,2 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Providers = void 0;
+var Providers;
+(function (Providers) {
+    Providers[Providers["None"] = 0] = "None";
+    Providers[Providers["Segment"] = 1] = "Segment";
+    Providers[Providers["Umami"] = 2] = "Umami";
+    Providers[Providers["Posthog"] = 3] = "Posthog";
+    Providers[Providers["Console"] = 4] = "Console";
+})(Providers || (exports.Providers = Providers = {}));

package/dist/cjs/tracking/umami_tracking_provider.d.ts

@@ -6,9 +6,13 @@ declare global {
     }
 }
 export declare class UmamiTrackingProvider implements TrackingSpi, TrackingApi {
-    getKey(): string;
+    private verbose;
+    private websiteId;
+    private queue;
     initialize(props: InitProps): void;
-    identify(userID: string): void;
+    identify(userID: string, userProperties?: TrackingEventProperties): void;
     trackPageView(url: string | undefined): void;
     trackSingleItem(item: string, properties?: TrackingEventProperties): void;
+    flushQueue(): void;
+    log(msg: string): void;
 }

package/dist/cjs/tracking/umami_tracking_provider.js

@@ -2,43 +2,87 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UmamiTrackingProvider = void 0;
 class UmamiTrackingProvider {
-    getKey() {
-        return 'umamiKey';
+    constructor() {
+        this.verbose = false;
+        this.queue = [];
     }
     initialize(props) {
-        // eslint-disable-next-line no-console
-        console.log('UmamiProvider initialize');
-        const umamiKey = props.umamiKey;
+        this.verbose = props.verbose;
+        this.log('UmamiProvider initialize');
+        this.websiteId = props.umamiKey;
         const hostUrl = props.umamiHostUrl;
         const script = document.createElement('script');
         script.src = hostUrl + '/script.js';
         script.async = true;
         script.defer = true;
         // Configure Umami properties
-        script.setAttribute('data-website-id', umamiKey);
-        script.setAttribute('data-domains', 'localhost'); // TODO ?
+        script.setAttribute('data-website-id', this.websiteId);
+        script.setAttribute('data-host-url', hostUrl);
         script.setAttribute('data-auto-track', 'false');
-        script.setAttribute('data-host-url', hostUrl); // TODO ?
-        script.setAttribute('data-exclude-search', 'false'); // TODO ?
+        script.setAttribute('data-exclude-search', 'false');
+        // Now get from config, which may override some of the above.
+        const UMAMI_PREFIX = 'umami-';
+        for (const prop in props) {
+            if (prop.startsWith(UMAMI_PREFIX)) {
+                const att = 'data-' + prop.substring(UMAMI_PREFIX.length);
+                const val = props[prop];
+                script.setAttribute(att, String(val));
+            }
+        }
+        script.onload = () => {
+            this.log('UmamiProvider script loaded');
+            this.flushQueue();
+        };
         document.body.appendChild(script);
     }
-    identify(userID) {
-        var _a;
-        // eslint-disable-next-line no-console
-        console.log('UmamiProvider userID: ' + userID);
-        (_a = window.umami) === null || _a === void 0 ? void 0 : _a.identify({ userID });
+    identify(userID, userProperties = {}) {
+        this.log('UmamiProvider userID: ' + userID + ' => ' + JSON.stringify(userProperties));
+        if (window.umami) {
+            window.umami.identify({ userID, userProperties });
+        }
+        else {
+            this.queue.push({ what: 'i', name: userID, payload: userProperties });
+        }
     }
     trackPageView(url) {
-        var _a;
-        // eslint-disable-next-line no-console
-        console.log('UmamiProvider url', url);
-        (_a = window.umami) === null || _a === void 0 ? void 0 : _a.track({ url });
+        this.log('UmamiProvider url ' + url);
+        if (window.umami) {
+            window.umami.track({ url, website: this.websiteId });
+        }
+        else {
+            this.queue.push({ what: 'p', name: String(url) });
+        }
     }
     trackSingleItem(item, properties) {
-        var _a;
-        // eslint-disable-next-line no-console
-        console.log('UmamiProvider: trackSingleItem' + item, properties);
-        (_a = window.umami) === null || _a === void 0 ? void 0 : _a.track(item, properties);
+        this.log('UmamiProvider: trackSingleItem ' + item + JSON.stringify(properties));
+        if (window.umami) {
+            window.umami.track(item, properties);
+        }
+        else {
+            this.queue.push({ what: 't', name: item, payload: properties });
+        }
+    }
+    flushQueue() {
+        for (const item of this.queue) {
+            this.log('Queue flush ' + JSON.stringify(item));
+            switch (item.what) {
+                case 'i':
+                    this.identify(item.name, item.payload);
+                    break;
+                case 't':
+                    this.trackSingleItem(item.name, item.payload);
+                    break;
+                case 'p':
+                    this.trackPageView(item.name);
+                    break;
+            }
+        }
+    }
+    log(msg) {
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.debug('UmamiProvider: ', msg);
+        }
     }
 }
 exports.UmamiTrackingProvider = UmamiTrackingProvider;

package/dist/esm/tracking/console_tracking_provider.d.ts

@@ -1,10 +1,9 @@
-import { TrackingSpi } from './tracking_spi';
+import { InitProps, TrackingSpi } from './tracking_spi';
 import { TrackingApi, TrackingEventProperties } from './tracking_api';
 export declare class ConsoleTrackingProvider implements TrackingSpi, TrackingApi {
+    private verbose;
     trackPageView(url: string | undefined): void;
-    registerProvider(): void;
-    initialize(): void;
-    identify(userID: string): void;
+    initialize(props: InitProps): void;
+    identify(userID: string, userProperties?: TrackingEventProperties): void;
     trackSingleItem(item: string, properties?: TrackingEventProperties): void;
-    getKey(): string;
 }

package/dist/esm/tracking/console_tracking_provider.js

@@ -1,23 +1,30 @@
 export class ConsoleTrackingProvider {
+    constructor() {
+        this.verbose = false;
+    }
     trackPageView(url) {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider pageView', url);
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider pageView ', url);
+        }
     }
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    registerProvider() { }
-    initialize() {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider initialize');
+    initialize(props) {
+        this.verbose = props.verbose;
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider initialize');
+        }
     }
-    identify(userID) {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider identify', userID);
+    identify(userID, userProperties = {}) {
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider identify ', userID, userProperties);
+        }
     }
     trackSingleItem(item, properties) {
-        // eslint-disable-next-line no-console
-        console.log('ConsoleProvider: ' + item, properties);
-    }
-    getKey() {
-        return 'console';
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('ConsoleProvider: ' + item, properties);
+        }
     }
 }

package/dist/esm/tracking/posthog_tracking_provider.d.ts

@@ -1,9 +1,9 @@
 import { TrackingApi, TrackingEventProperties } from './tracking_api';
 import { InitProps, TrackingSpi } from './tracking_spi';
 export declare class PosthogTrackingProvider implements TrackingSpi, TrackingApi {
-    getKey(): string;
+    private verbose;
     initialize(props: InitProps): void;
-    identify(userID: string): void;
+    identify(userID: string, userProperties?: TrackingEventProperties): void;
     trackPageView(url: string | undefined): void;
     trackSingleItem(item: string, properties?: TrackingEventProperties): void;
 }

package/dist/esm/tracking/posthog_tracking_provider.js

@@ -1,11 +1,14 @@
 import { posthog } from 'posthog-js';
 export class PosthogTrackingProvider {
-    getKey() {
-        return 'posthogKey';
+    constructor() {
+        this.verbose = false;
     }
     initialize(props) {
-        // eslint-disable-next-line no-console
-        console.log('PosthogProvider initialize');
+        this.verbose = props.verbose;
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('PosthogProvider initialize');
+        }
         const posthogKey = props.posthogKey;
         posthog.init(posthogKey, {
             // eslint-disable-next-line camelcase
@@ -14,20 +17,26 @@ export class PosthogTrackingProvider {
             person_profiles: 'identified_only' // or 'always' to create profiles for anonymous users as well
         });
     }
-    identify(userID) {
-        // eslint-disable-next-line no-console
-        console.log('PosthogProvider userID: ' + userID);
-        posthog.identify(userID);
+    identify(userID, userProperties = {}) {
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('PosthogProvider userID: ' + userID);
+        }
+        posthog.identify(userID, userProperties);
     }
     trackPageView(url) {
-        // eslint-disable-next-line no-console
-        console.log('PostHogProvider url', url);
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('PostHogProvider url ', url);
+        }
         // TODO posthog seems to record that automatically.
         //  How to not clash with this here? Just leave as no-op?
     }
     trackSingleItem(item, properties) {
-        // eslint-disable-next-line no-console
-        console.log('PosthogProvider: trackSingleItem' + item, properties);
+        if (this.verbose) {
+            // eslint-disable-next-line no-console
+            console.log('PosthogProvider: trackSingleItem ' + item, properties);
+        }
         posthog.capture(item, { properties });
     }
 }

package/dist/esm/tracking/segment_tracking_provider.d.ts

@@ -2,9 +2,9 @@ import { TrackingApi, TrackingEventProperties } from './tracking_api';
 import { InitProps, TrackingSpi } from './tracking_spi';
 export declare class SegmentTrackingProvider implements TrackingSpi, TrackingApi {
     private analytics;
-    getKey(): string;
+    private verbose;
     initialize(props: InitProps): void;
-    identify(userID: string): void;
+    identify(userID: string, userProperties?: TrackingEventProperties): void;
     trackPageView(url: string | undefined): void;
     trackSingleItem(item: string, properties?: TrackingEventProperties): void;
 }