@epigraph/epigraph-std-lib 3.2.0 → 3.3.0

package/README.md

@@ -1,49 +1,50 @@
-# INTRODUCTION
-
-Epigraph Standard Library or epigraph-std-lib is a collection of standards that we follow across our solutions. The idea is to have a single source of truth across solutions while ensuring that the dependencies are always up to date with the industry standards.
-
-### EPIGRAPH
-A global object that must only be initialized once per session and provides some common functionalities across solutions in that session.
-
-### EPIGRAPH LIBRARY EXPORTS
-
-| Name  | Description  |
-|---|---|
-| EpigraphBaseSolution | A base class intended to enforce some common functionalities across our solutions |
-| EpigraphLogger | A logger class that provides a convenient way for logging info, warning or errors in any given session |
-| EpigraphQrCoreGenerator | A Utility class that allows the generation of a QR code from a give string input |
-| EpigraphUnitsConverter | A Utility class that allows conversion between different standard unit, including but not limited to Distance, Color, etc. |
-| EpigraphUrlProcessor | A Utility class that provides various methods to generate, process, manipulate URLs |
-
-
-### 3rd PARTY LIBRARY EXPORTS
-
-| Name  | Version  |
-|---|---|
-| [three](https://threejs.org/) | ![three version](https://img.shields.io/badge/three-0.169.0-green) |
-| [model-viewer](https://modelviewer.dev/) | ![@google/model-viewer version](https://img.shields.io/badge/model--viewer-4.0.0-green) |
-| [@epigraph/epigraph-analytics](https://www.npmjs.com/package/@epigraph/epigraph-analytics)  |![@epigraph/epigraph-analytics version](https://img.shields.io/badge/epigraph--analytics-1.0.0-green)|
-| [qr-creator](https://www.npmjs.com/package/qr-creator)  |![qr-creator version](https://img.shields.io/badge/qr--creator-1.0.0-green)|
-
-
-# HOW TO:
-
-### Add a new EpigraphLibrary:
-1. Create a new directory under lib/EpigraphLibs/`<MyEpigraphLibrary>`
-2. Create the module file/s. Ensure that the names of these files are in camelCase.
-3. Export this module in lib/EpigraphLibs/epigraph-std-lib.ts as `export * from "./ThirdPartyLibs/main";`
-4. Write a test for this Library under tests/<MyEpigraphLibrary.test.ts>
-
-### Write a test: 
-We use [vitest](https://vitest.dev/guide/) to write tests in this repository using [happy-dom](https://www.npmjs.com/package/happy-dom) to support some but not all browser functionalities. In order to write a new test:
-
-1. Create a new file for a specific test under tests/ as `<MyEpigraphLibrary>`.test.ts
-2. Write a test following the instructions and samples [here](https://vitest.dev/guide/#writing-tests)
-3. Make sure to import the library from "../dist/epigraph-std-lib" to avoid any issues that might come up after bundling.
-4. Open a terminal and execute "npm run test". This will build all the libraries under dist/ and then run tests using those.
-
-
-# REFERENCES
-A huge thanks to everyone who inspired the setup for this repository:
-1. [Andreas Riedmuller's Article](https://dev.to/receter/how-to-create-a-react-component-library-using-vites-library-mode-4lma)
-2. [Vitest Docs](https://vitest.dev/guide/)
+# INTRODUCTION
+
+Epigraph Standard Library or epigraph-std-lib is a collection of standards that we follow across our solutions. The idea is to have a single source of truth across solutions while ensuring that the dependencies are always up to date with the industry standards.
+
+### EPIGRAPH
+A global object that must only be initialized once per session and provides some common functionalities across solutions in that session.
+
+### EPIGRAPH LIBRARY EXPORTS
+
+| Name  | Description  |
+|---|---|
+| EpigraphBaseSolutionHtmlElement | A base class intended to enforce some common functionalities across our solutions, built by extending the HTMLElement |
+| EpigraphBaseSolutionLitElement | A base class intended to enforce some common functionalities across our solutions, built by extending the LitElement |
+| EpigraphLogger | A logger class that provides a convenient way for logging info, warning or errors in any given session |
+| EpigraphQrCoreGenerator | A Utility class that allows the generation of a QR code from a give string input |
+| EpigraphUnitsConverter | A Utility class that allows conversion between different standard unit, including but not limited to Distance, Color, etc. |
+| EpigraphUrlProcessor | A Utility class that provides various methods to generate, process, manipulate URLs |
+
+
+### 3rd PARTY LIBRARY EXPORTS
+
+| Name  | Version  |
+|---|---|
+| [three](https://threejs.org/) | ![three version](https://img.shields.io/badge/three-0.169.0-green) |
+| [model-viewer](https://modelviewer.dev/) | ![@google/model-viewer version](https://img.shields.io/badge/model--viewer-4.0.0-green) |
+| [@epigraph/epigraph-analytics](https://www.npmjs.com/package/@epigraph/epigraph-analytics)  |![@epigraph/epigraph-analytics version](https://img.shields.io/badge/epigraph--analytics-1.0.0-green)|
+| [qr-creator](https://www.npmjs.com/package/qr-creator)  |![qr-creator version](https://img.shields.io/badge/qr--creator-1.0.0-green)|
+
+
+# HOW TO:
+
+### Add a new EpigraphLibrary:
+1. Create a new directory under lib/EpigraphLibs/`<MyEpigraphLibrary>`
+2. Create the module file/s. Ensure that the names of these files are in camelCase.
+3. Export this module in lib/EpigraphLibs/epigraph-std-lib.ts as `export * from "./ThirdPartyLibs/main";`
+4. Write a test for this Library under tests/<MyEpigraphLibrary.test.ts>
+
+### Write a test: 
+We use [vitest](https://vitest.dev/guide/) to write tests in this repository using [happy-dom](https://www.npmjs.com/package/happy-dom) to support some but not all browser functionalities. In order to write a new test:
+
+1. Create a new file for a specific test under tests/ as `<MyEpigraphLibrary>`.test.ts
+2. Write a test following the instructions and samples [here](https://vitest.dev/guide/#writing-tests)
+3. Make sure to import the library from "../dist/epigraph-std-lib" to avoid any issues that might come up after bundling.
+4. Open a terminal and execute "npm run test". This will build all the libraries under dist/ and then run tests using those.
+
+
+# REFERENCES
+A huge thanks to everyone who inspired the setup for this repository:
+1. [Andreas Riedmuller's Article](https://dev.to/receter/how-to-create-a-react-component-library-using-vites-library-mode-4lma)
+2. [Vitest Docs](https://vitest.dev/guide/)

package/dist/Epigraph/constants/enums.d.ts

@@ -1,4 +1,4 @@
-export declare const enum ENVIRONMENT_TYPE {
+export declare enum ENVIRONMENT_TYPE {
     DEVELOPMENT = "development",
     STAGING = "staging",
     PRODUCTION = "production"

package/dist/Epigraph/epigraph.d.ts

@@ -1,7 +1,7 @@
 import { EpigraphLogger, LoggerModeNames } from '../EpigraphLibs/EpigraphLogger/epigraphLogger';
 import { ENVIRONMENT_TYPE } from './constants/enums';
 import { UrlProcessor } from '../EpigraphLibs/EpigraphUrlProcessor/epigraphUrlProcessor';
-import { EpigraphBaseSolution } from '../EpigraphLibs/EpigraphBaseSolution/epigraphBaseSolution';
+import { EpigraphBaseSolutionTypes, EpigraphBaseSolutionHtmlElement, EpigraphBaseSolutionLitElement } from './epigraphBaseSolution';
 /**
  * Epigraph component is intended to be a global source of truth/tracker in a given session for all of our components.
  * This object would be responsible for serving/communicating/validating information, wherever necessary
@@ -11,6 +11,7 @@ import { EpigraphBaseSolution } from '../EpigraphLibs/EpigraphBaseSolution/epigr
  * global analytics tracker, etc.
  */
 export declare class Epigraph {
+    private _loggerContext;
     id: string;
     private _isReady;
     private _logger;
@@ -20,15 +21,15 @@ export declare class Epigraph {
     private _environment;
     private _activeComponentsInSession;
     private _staleComponentsInSession;
-    constructor(environment: ENVIRONMENT_TYPE, initializer: EpigraphBaseSolution);
+    constructor(initializer: EpigraphBaseSolutionTypes);
     get isReady(): boolean;
     get logger(): EpigraphLogger;
     get urlProcessor(): UrlProcessor;
     get epigraphSessionId(): string;
     get environment(): ENVIRONMENT_TYPE;
-    get initializer(): EpigraphBaseSolution;
-    get activeComponentsInSession(): Map<string, EpigraphBaseSolution>;
-    get staleComponentsInSession(): Map<string, EpigraphBaseSolution>;
+    get initializer(): EpigraphBaseSolutionTypes;
+    get activeComponentsInSession(): Map<string, EpigraphBaseSolutionTypes>;
+    get staleComponentsInSession(): Map<string, EpigraphBaseSolutionTypes>;
     /**
      * Logs Epigraph Branding in the console to help redirect potential interests in the right direction.
      */
@@ -39,18 +40,18 @@ export declare class Epigraph {
      * registering any component that gets initialized in this session.
      * Any component that inherits from EpigraphBaseSolution should automatically register itself on initialization.
      *
-     * @param {EpigraphBaseSolution} solutionRef A type of Epigraph base component that is initialized in the session.
+     * @param {EpigraphBaseSolutionTypes} solutionRef A type of Epigraph base component that is initialized in the session.
      */
-    registerActiveComponent(solutionRef: EpigraphBaseSolution): void;
+    registerActiveComponent(solutionRef: EpigraphBaseSolutionTypes): void;
     /**
      * De-Registers a component that was initialized on this page.
      * This is optional from the perspective of the unmount flow but highly recommend
      * de-registering any component that gets removed in this session.
      * Any component that inherits from EpigraphBaseSolution should automatically de-register itself on unmount.
      *
-     * @param {EpigraphBaseSolution} solutionRef A type of Epigraph base component that is initialized in the session.
+     * @param {EpigraphBaseSolutionTypes} solutionRef A type of Epigraph base component that is initialized in the session.
      */
-    deregisterActiveComponent(solutionRef: EpigraphBaseSolution): void;
+    deregisterActiveComponent(solutionRef: EpigraphBaseSolutionTypes): void;
     /**
      * Gets the mode that the logger should be executed in, based on the runtime environment.
      *
@@ -72,7 +73,8 @@ export declare class Epigraph {
      */
     static generateXPath(element: HTMLElement): string;
 }
-export { ENVIRONMENT_TYPE, EpigraphBaseSolution };
+export { ENVIRONMENT_TYPE, EpigraphBaseSolutionHtmlElement, EpigraphBaseSolutionLitElement };
+export type { EpigraphBaseSolutionTypes };
 declare global {
     interface Window {
         epigraph: Epigraph;

package/dist/Epigraph/epigraphBaseSolution.d.ts

@@ -0,0 +1,43 @@
+import { LitElement } from 'lit';
+import { ENVIRONMENT_TYPE } from './epigraph';
+export declare class EpigraphBaseSolutionHtmlElement extends HTMLElement {
+    private _xPath;
+    private _uuid;
+    private _isReady;
+    private _environment;
+    protected _elementName: string;
+    protected _solutionVersion: string;
+    protected _loggerContextOverride: string;
+    constructor(solutionVersion: string, environment: ENVIRONMENT_TYPE);
+    get isReady(): boolean;
+    get environment(): ENVIRONMENT_TYPE;
+    get elementName(): string;
+    /**
+     * This is the npm package version of this solution.
+     */
+    get solutionVersion(): string;
+    get uuid(): string;
+    get xPath(): string;
+    disconnectedCallback(): void;
+}
+export declare class EpigraphBaseSolutionLitElement extends LitElement {
+    private _xPath;
+    private _uuid;
+    private _isReady;
+    private _environment;
+    protected _elementName: string;
+    protected _solutionVersion: string;
+    protected _loggerContextOverride: string;
+    constructor(solutionVersion: string, environment: ENVIRONMENT_TYPE);
+    get isReady(): boolean;
+    get environment(): ENVIRONMENT_TYPE;
+    get elementName(): string;
+    /**
+     * This is the npm package version of this solution.
+     */
+    get solutionVersion(): string;
+    get uuid(): string;
+    get xPath(): string;
+    disconnectedCallback(): void;
+}
+export type EpigraphBaseSolutionTypes = EpigraphBaseSolutionHtmlElement | EpigraphBaseSolutionLitElement;

package/dist/EpigraphLibs/EpigraphAnalytics/EpigraphAnalytics.d.ts

@@ -0,0 +1,42 @@
+import { IAnalyticsPlugin } from './analytics-plugin-interface';
+import { AnalyticsEvent } from './analytics-event-interface';
+import { GA3AnalyticsPlugin } from './plugins/ga3-analytics-plugin';
+import { GA4AnalyticsPlugin } from './plugins/ga4-analytics-plugin';
+import { NexusAnalyticsPlugin } from './plugins/nexus-analytics-plugin';
+import { IConsentPlugin } from './consent-plugin-interface';
+import { OneTrustConsentPlugin } from './consent-plugins/one-trust-consent-plugin';
+import { ConsentPluginNames } from './consent-plugins/consent-plugin-names';
+declare const $analyticsPluginsMap: unique symbol;
+export type AnalyticsTrackerMap = Map<string, IAnalyticsPlugin>;
+export type { AnalyticsEvent };
+export { GA3AnalyticsPlugin };
+export { GA4AnalyticsPlugin };
+export { NexusAnalyticsPlugin };
+export { OneTrustConsentPlugin };
+export { ConsentPluginNames };
+export declare class EpigraphAnalytics {
+    private [$analyticsPluginsMap];
+    _consentPlugin: IConsentPlugin | null;
+    constructor(consentPluginName: string | null, consentIdentifier: string | null);
+    /**
+     * Epigraph Analytics uses plugins to send events to multiple trackers at a time. You can create a customer tracker
+     * by implementing the IAnalyticsPlugin and then adding it via this function. This will also hold only a single
+     * instance of a plugin with a given Tracking Identifier.
+     *
+     * @param plugin
+     */
+    addEventPlugin(plugin: IAnalyticsPlugin): void;
+    /**
+     * Send an Event to all plugins
+     *
+     * @param eventData
+     */
+    sendEvent(eventData: AnalyticsEvent): void;
+    /**
+     * Returns an IConsentPlugin if something is passed to it. Returns null if we can't find the plugin named.
+     * @param consentPluginName
+     * @param consentIdentifier
+     * @private
+     */
+    private buildConsentPlugin;
+}

package/dist/EpigraphLibs/EpigraphAnalytics/analytics-event-interface.d.ts

@@ -0,0 +1,8 @@
+export interface AnalyticsEvent {
+    type: string;
+    category: string;
+    action: string;
+    label: string;
+    interaction: object;
+    parameters?: object;
+}

package/dist/EpigraphLibs/EpigraphAnalytics/analytics-plugin-interface.d.ts

@@ -0,0 +1,9 @@
+import { AnalyticsEvent } from './analytics-event-interface';
+import { IConsentPlugin } from './consent-plugin-interface';
+export interface IAnalyticsPlugin {
+    trackingID: string;
+    pluginName: string;
+    sendEvent(event: AnalyticsEvent, consentPlugin: IConsentPlugin | null): void;
+    getUniquePluginIdentifier(): string;
+    setupPlugin(): void;
+}

package/dist/EpigraphLibs/EpigraphAnalytics/consent-plugin-interface.d.ts

@@ -0,0 +1,5 @@
+export interface IConsentPlugin {
+    pluginName: string;
+    consentIdentifier: string;
+    hasConsent(): boolean;
+}

package/dist/EpigraphLibs/EpigraphAnalytics/consent-plugins/consent-plugin-names.d.ts

@@ -0,0 +1,3 @@
+export declare enum ConsentPluginNames {
+    OneTrust = "onetrust"
+}

package/dist/EpigraphLibs/EpigraphAnalytics/consent-plugins/one-trust-consent-plugin.d.ts

@@ -0,0 +1,13 @@
+import { IConsentPlugin } from '../consent-plugin-interface';
+export declare class OneTrustConsentPlugin implements IConsentPlugin {
+    consentSet: boolean;
+    consent: boolean;
+    pluginName: string;
+    consentIdentifier: string;
+    constructor(consentIdentifier: string);
+    /**
+     * Checks to see if the user has consented. If this is false, it will block all analytics
+     */
+    hasConsent(): boolean;
+    private addConsentChangedListener;
+}

package/dist/EpigraphLibs/EpigraphAnalytics/generics/node.d.ts

@@ -0,0 +1,11 @@
+declare const $data: unique symbol;
+declare const $next: unique symbol;
+export default class Node {
+    private [$data];
+    private [$next];
+    constructor(data: any);
+    get data(): any;
+    set next(node: Node | null);
+    get next(): Node | null;
+}
+export {};

package/dist/EpigraphLibs/EpigraphAnalytics/generics/queue.d.ts

@@ -0,0 +1,13 @@
+import { default as SLL } from './single-linked-list.js';
+declare const $queue: unique symbol;
+declare const $size: unique symbol;
+export default class Queue {
+    private [$queue];
+    private [$size];
+    constructor();
+    get queue(): SLL;
+    get size(): number;
+    enqueue(data: any): void;
+    dequeue(): any;
+}
+export {};

package/dist/EpigraphLibs/EpigraphAnalytics/generics/single-linked-list.d.ts

@@ -0,0 +1,11 @@
+import { default as Node } from './node.js';
+declare const $head: unique symbol;
+export default class SLL {
+    private [$head];
+    constructor();
+    set head(node: Node | null);
+    get head(): Node | null;
+    addToTail(data: any): Node;
+    removeHead(): any;
+}
+export {};

package/dist/EpigraphLibs/EpigraphAnalytics/plugins/ga3-analytics-plugin.d.ts

@@ -0,0 +1,44 @@
+import { IAnalyticsPlugin } from '../analytics-plugin-interface';
+import { AnalyticsEvent } from '../analytics-event-interface';
+export declare class GA3AnalyticsPlugin implements IAnalyticsPlugin {
+    name: string;
+    pluginName: string;
+    trackingID: string;
+    verboseLogging: boolean;
+    private queue;
+    private readonly user;
+    private readonly trackerName;
+    private trackerInterval;
+    private trackerCreated;
+    constructor(trackingID: string, verboseLogging: boolean, user: string, trackerName: string);
+    /**
+     * This function will send an Event to GA3.
+     *
+     * @param eventData AnalyticsEvent The event to be tracked
+     */
+    sendEvent(eventData: AnalyticsEvent): boolean;
+    /**
+     * Send all events that are in the queue
+     * @private
+     */
+    private dequeueAndSendEvents;
+    /**
+     * GA3 requires that a tracker be created prior to being sent. This is called from the constructor. It is
+     * important to note that the promise that is inherently returned is ignored in the constructor at this
+     * time. This is due to the events that are added will be queued from the page. This script requires
+     * that the GA script has been imported on the page already as it does not check for it today.
+     *
+     * @private
+     */
+    private createTracker;
+    /**
+     * Checks if verboseLogging is enabled, then logs the error
+     * @param err
+     */
+    private logger;
+    /**
+     * Returns a unique plugin identifier so that tracking ID's can be the same across multiple plugins.
+     */
+    getUniquePluginIdentifier(): string;
+    setupPlugin(): void;
+}

package/dist/EpigraphLibs/EpigraphAnalytics/plugins/ga4-analytics-plugin.d.ts

@@ -0,0 +1,44 @@
+import { IAnalyticsPlugin } from '../analytics-plugin-interface';
+import { AnalyticsEvent } from '../analytics-event-interface';
+import { IConsentPlugin } from '../consent-plugin-interface';
+declare global {
+    interface Window {
+        [key: string]: any;
+    }
+}
+export declare class GA4AnalyticsPlugin implements IAnalyticsPlugin {
+    name: string;
+    pluginName: string;
+    trackingID: string;
+    verboseLogging: boolean;
+    private queue;
+    dataLayer: Array<Record<string, any>>;
+    dataLayerName: string | undefined;
+    constructor(trackingID: string, verboseLogging: boolean);
+    private setupDataLayer;
+    private initGtag;
+    /**
+     * This function will send an Event to GA3.
+     *
+     * @param eventData AnalyticsEvent The event to be tracked
+     * @param consentPlugin
+     */
+    sendEvent(eventData: AnalyticsEvent, consentPlugin: IConsentPlugin | null): Promise<void>;
+    /**
+     * Send all events that are in the queue
+     * @private
+     */
+    private dequeueAndSendEvents;
+    /**
+     * Checks if verboseLogging is enabled, then logs the error
+     * @param err
+     */
+    private logger;
+    /**
+     * Returns a unique plugin identifier so that tracking ID's can be the same across multiple plugins.
+     */
+    getUniquePluginIdentifier(): string;
+    setupPlugin(): void;
+    private sendGA4LongParameters;
+    private findGA4ScriptInfo;
+}

package/dist/EpigraphLibs/EpigraphAnalytics/plugins/nexus-analytics-plugin.d.ts

@@ -0,0 +1,18 @@
+import { IAnalyticsPlugin } from '../analytics-plugin-interface';
+import { AnalyticsEvent } from '../analytics-event-interface';
+import { IConsentPlugin } from '../consent-plugin-interface';
+export declare class NexusAnalyticsPlugin implements IAnalyticsPlugin {
+    name: string;
+    pluginName: string;
+    trackingID: string;
+    verboseLogging: boolean;
+    url: string;
+    private queue;
+    private readonly sessionId;
+    private readonly xPath;
+    constructor(trackingID: string, sessionId: string, xPath: string, verboseLogging: boolean, sendToStaging?: boolean);
+    sendEvent(event: AnalyticsEvent, consentPlugin: IConsentPlugin | null): Promise<void>;
+    private dequeueAndSendEvents;
+    getUniquePluginIdentifier(): string;
+    setupPlugin(): void;
+}

package/dist/EpigraphLibs/epigraphLibs.d.ts

@@ -1,9 +1,9 @@
 export * as epigraphLogger from './EpigraphLogger/epigraphLogger';
 export * as epigraphUrlProcessor from './EpigraphUrlProcessor/epigraphUrlProcessor';
-export * as epigraphBaseSolution from './EpigraphBaseSolution/epigraphBaseSolution';
+export * as epigraphBaseSolution from '../Epigraph/epigraphBaseSolution';
 export * as epgUnitsConverter from './EpigraphUnitsConverter/epigraphUnitsConverter';
 export * as epigraphQrCodeGenerator from './EpigraphQrCodeGenerator/epigraphQrCodeGenerator';
-export { EpigraphAnalytics, GA3AnalyticsPlugin, GA4AnalyticsPlugin, OneTrustConsentPlugin, NexusAnalyticsPlugin, ConsentPluginNames } from '@epigraph/epigraph-analytics';
+export { EpigraphAnalytics, GA3AnalyticsPlugin, GA4AnalyticsPlugin, OneTrustConsentPlugin, NexusAnalyticsPlugin, ConsentPluginNames } from './EpigraphAnalytics/EpigraphAnalytics';
 export * from './EpigraphResultFactory/epigraphResultFactory';
 export * from './EpigraphNexusApi/epigraphNexusApi';
-export type { AnalyticsEvent } from '@epigraph/epigraph-analytics';
+export type { AnalyticsEvent } from './EpigraphAnalytics/EpigraphAnalytics';

package/dist/ThirdPartyLibs/thirdPartyLibs.d.ts

@@ -1,6 +1,9 @@
 import { default as WebGL } from 'three/addons/capabilities/WebGL.js';
 export * from 'three';
 export { GLTFLoader, DRACOLoader, GLTFExporter, USDZExporter, EffectComposer, HorizontalBlurShader, VerticalBlurShader, RGBELoader } from 'three/examples/jsm/Addons.js';
+export * from 'three';
+export * as GLTFMaterialsVariantsExtension from 'three-gltf-extensions/loaders/KHR_materials_variants/KHR_materials_variants.js';
+export * as GLTFExporterMaterialsVariantsExtension from 'three-gltf-extensions/exporters/KHR_materials_variants/KHR_materials_variants_exporter.js';
 export * as ModelViewer from '@google/model-viewer';
 export * as MODEL_VIEWER_CONSTANTS from '@google/model-viewer/lib/constants';
 export { WebGL };