clarity-decode 0.6.23

package/src/performance.ts

@@ -0,0 +1,38 @@
+import { Data, Performance } from "clarity-js";
+import { PerformanceEvent } from "../types/performance";
+
+export function decode(tokens: Data.Token[]): PerformanceEvent  {
+    let time = tokens[0] as number;
+    let event = tokens[1] as Data.Event;
+    switch (event) {
+        case Data.Event.Connection:
+            let connectionData: Performance.ConnectionData = {
+                downlink: tokens[2] as number,
+                rtt: tokens[3] as number,
+                saveData: tokens[4] as number,
+                type: tokens[5] as string
+            };
+            return { time, event, data: connectionData };
+        case Data.Event.Navigation:
+            let navigationData: Performance.NavigationData = {
+                fetchStart: tokens[2] as number,
+                connectStart: tokens[3] as number,
+                connectEnd: tokens[4] as number,
+                requestStart: tokens[5] as number,
+                responseStart: tokens[6] as number,
+                responseEnd: tokens[7] as number,
+                domInteractive: tokens[8] as number,
+                domComplete: tokens[9] as number,
+                loadEventStart: tokens[10] as number,
+                loadEventEnd: tokens[11] as number,
+                redirectCount: tokens[12] as number,
+                size: tokens[13] as number,
+                type: tokens[14] as string,
+                protocol: tokens[15] as string,
+                encodedSize: tokens[16] as number,
+                decodedSize: tokens[17] as number
+            };
+            return { time, event, data: navigationData };
+    }
+    return null;
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "esnext",
+        "target": "es5",
+        "lib": ["es6", "dom", "es2016", "es2017"],
+        "moduleResolution": "node",
+        "forceConsistentCasingInFileNames": true,
+        "noImplicitReturns": true,
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "esModuleInterop": true,
+        "baseUrl": ".",
+        "paths": {
+            "@src/*": ["src/*"],
+            "@clarity-types/*": ["types/*"]
+        }
+    },
+    "include":["src/**/*.ts","types/**/*.d.ts"],
+    "exclude": ["node_modules", "build"]
+}

package/tslint.json

@@ -0,0 +1,33 @@
+{
+  "extends": "tslint:recommended",
+  "rules": {
+    "max-line-length": [
+      true,
+      140
+    ],
+    "no-console": [
+      false
+    ],
+    "no-string-literal": false,
+    "prefer-const": false,
+    "prefer-for-of": false,
+    "object-literal-sort-keys": false,
+    "one-variable-per-declaration": false,
+    "trailing-comma": [
+      false
+    ],
+    "variable-name": false,
+    "interface-name": false,
+    "interface-over-type-literal": false,
+    "only-arrow-functions": false,
+    "typedef": [
+      true,
+      "call-signature",
+      "parameter",
+      "property-declaration",
+      "member-variable-declaration",
+      "object-destructuring",
+      "array-destructuring"
+    ]
+  }
+}

package/types/core.d.ts

@@ -0,0 +1,8 @@
+import { Core, Data } from "clarity-js";
+
+export import Config = Core.Config;
+
+export interface PartialEvent {
+    time: number;
+    event: Data.Event;
+}

package/types/data.d.ts

@@ -0,0 +1,84 @@
+import { Data } from "clarity-js";
+import { DiagnosticEvent, ImageErrorEvent, LogEvent, ScriptErrorEvent } from "./diagnostic";
+import { ClickEvent, InputEvent, InteractionEvent, PointerEvent, ResizeEvent } from "./interaction";
+import { ScrollEvent, SelectionEvent, TimelineEvent, UnloadEvent, VisibilityEvent } from "./interaction";
+import { BoxEvent, DocumentEvent, DomEvent, LayoutEvent, RegionEvent } from "./layout";
+import { ConnectionEvent, NavigationEvent, PerformanceEvent } from "./performance";
+import { PartialEvent } from "./core";
+
+/* Redeclare enums */
+export import Envelope = Data.Envelope;
+export import Code = Data.Code;
+export import Dimension = Data.Dimension;
+export import Event = Data.Event;
+export import Metric = Data.Metric;
+export import Payload = Data.Payload;
+export import BooleanFlag = Data.BooleanFlag;
+export import Constant = Data.Constant;
+export import Setting = Data.Setting;
+
+/* Data Events */
+export interface BaselineEvent extends PartialEvent { data: Data.BaselineData; }
+export interface DimensionEvent extends PartialEvent { data: Data.DimensionData; }
+export interface MetricEvent extends PartialEvent { data: Data.MetricData; }
+export interface CustomEvent extends PartialEvent { data: Data.CustomData; }
+export interface VariableEvent extends PartialEvent { data: Data.VariableData; }
+export interface PingEvent extends PartialEvent { data: Data.PingData; }
+export interface LimitEvent extends PartialEvent { data: Data.LimitData; }
+export interface SummaryEvent extends PartialEvent { data: Data.SummaryData; }
+export interface UpgradeEvent extends PartialEvent { data: Data.UpgradeData; }
+export interface UploadEvent extends PartialEvent { data: Data.UploadData; }
+export interface DataEvent extends PartialEvent {
+    data: Data.BaselineData |
+    Data.DimensionData | 
+    Data.MetricData |
+    Data.CustomData |
+    Data.VariableData |
+    Data.PingData |
+    Data.LimitData |
+    Data.SummaryData |
+    Data.UpgradeData |
+    Data.UploadData;
+}
+
+export type DecodedEvent = DataEvent | DiagnosticEvent | InteractionEvent | LayoutEvent | PerformanceEvent;
+
+export interface DecodedPayload {
+    timestamp: number;
+    envelope: Data.Envelope;
+    metric?: MetricEvent[];
+    dimension?: DimensionEvent[];
+    ping?: PingEvent[];
+    limit?: LimitEvent[];
+    image?: ImageErrorEvent[];
+    script?: ScriptErrorEvent[];
+    input?: InputEvent[];
+    pointer?: PointerEvent[];
+    click?: ClickEvent[];
+    resize?: ResizeEvent[];
+    scroll?: ScrollEvent[];
+    selection?: SelectionEvent[];
+    summary?: SummaryEvent[];
+    timeline?: TimelineEvent[];
+    unload?: UnloadEvent[];
+    upgrade?: UpgradeEvent[];
+    upload?: UploadEvent[];
+    visibility?: VisibilityEvent[];
+    box?: BoxEvent[];
+    region?: RegionEvent[];
+    dom?: DomEvent[];
+    doc?: DocumentEvent[];
+    connection?: ConnectionEvent[];
+    navigation?: NavigationEvent[];
+    log?: LogEvent[];
+    baseline?: BaselineEvent[];
+    variable?: VariableEvent[];
+    custom?: CustomEvent[];
+}
+
+export interface DecodedVersion {
+    major: number;
+    minor: number;
+    patch: number;
+    beta: number;
+}

package/types/diagnostic.d.ts

@@ -0,0 +1,9 @@
+import { Diagnostic } from "clarity-js";
+import { PartialEvent } from "./core";
+
+export interface ImageErrorEvent extends PartialEvent { data: Diagnostic.ImageErrorData; }
+export interface ScriptErrorEvent extends PartialEvent { data: Diagnostic.ScriptErrorData; }
+export interface LogEvent extends PartialEvent { data: Diagnostic.LogData; }
+export interface DiagnosticEvent extends PartialEvent {
+    data: Diagnostic.ImageErrorData | Diagnostic.LogData | Diagnostic.ScriptErrorData;
+}

package/types/index.d.ts

@@ -0,0 +1,10 @@
+import * as Core from "./core";
+import * as Data from "./data";
+import * as Diagnostic from "./diagnostic";
+import * as Layout from "./layout";
+import * as Interaction from "./interaction";
+import * as Performance from "./performance";
+
+export function decode(data: string): Data.DecodedPayload;
+
+export { Core, Data, Diagnostic, Layout, Interaction, Performance };

package/types/interaction.d.ts

@@ -0,0 +1,23 @@
+import { Interaction } from "clarity-js";
+import { PartialEvent } from "./core";
+
+export interface InputEvent extends PartialEvent { data: Interaction.InputData; }
+export interface ClickEvent extends PartialEvent { data: Interaction.ClickData; }
+export interface PointerEvent extends PartialEvent { data: Interaction.PointerData; }
+export interface ResizeEvent extends PartialEvent { data: Interaction.ResizeData; }
+export interface ScrollEvent extends PartialEvent { data: Interaction.ScrollData; }
+export interface SelectionEvent extends PartialEvent { data: Interaction.SelectionData; }
+export interface TimelineEvent extends PartialEvent { data: Interaction.TimelineData; }
+export interface UnloadEvent extends PartialEvent { data: Interaction.UnloadData; }
+export interface VisibilityEvent extends PartialEvent { data: Interaction.VisibilityData; }
+export interface InteractionEvent extends PartialEvent {
+    data: Interaction.ClickData |
+    Interaction.InputData |
+    Interaction.PointerData |
+    Interaction.ResizeData |
+    Interaction.ScrollData |
+    Interaction.SelectionData |
+    Interaction.TimelineData |
+    Interaction.UnloadData |
+    Interaction.VisibilityData;
+}

package/types/layout.d.ts

@@ -0,0 +1,29 @@
+import { Layout } from "clarity-js";
+import { PartialEvent } from "./core";
+
+export interface RegionEvent extends PartialEvent { data: Layout.RegionData[]; }
+export interface DocumentEvent extends PartialEvent { data: Layout.DocumentData; }
+export interface DomEvent extends PartialEvent { data: DomData[]; }
+export interface BoxEvent extends PartialEvent { data: Layout.BoxData[]; }
+export interface LayoutEvent extends PartialEvent {
+    data: Layout.RegionData[] | Layout.DocumentData | DomData[] | Layout.BoxData[];
+}
+
+/* Redeclare enums */
+export import Constant = Layout.Constant;
+export import Interaction = Layout.InteractionState;
+
+/* Event Data */
+export interface DomData {
+    id: number;
+    parent: number;
+    previous: number;
+    tag: string;
+    position: number;
+    selector: string;
+    hash: string;
+    attributes?: Layout.Attributes;
+    value?: string;
+    width?: number;
+    height?: number;
+}

package/types/performance.d.ts

@@ -0,0 +1,8 @@
+import { Performance } from "clarity-js";
+import { PartialEvent } from "./core";
+
+export interface ConnectionEvent extends PartialEvent { data: Performance.ConnectionData; }
+export interface NavigationEvent extends PartialEvent { data: Performance.NavigationData; }
+export interface PerformanceEvent extends PartialEvent {
+    data: Performance.ConnectionData | Performance.NavigationData
+}