@cloudcare/guance-front-tools 1.0.0

package/lib/esm/generated/dashboardCharts.js

@@ -0,0 +1,5 @@
+/* eslint-disable */
+/**
+ * DO NOT MODIFY IT BY HAND. Run `yarn generate` instead.
+ */
+export {};

package/lib/esm/generated/mobileSessionReplay.d.ts

@@ -0,0 +1,653 @@
+/**
+ * DO NOT MODIFY IT BY HAND. Run `yarn generate` instead.
+ */
+/**
+ * Mobile-specific. Schema of a Session Replay data Segment.
+ */
+export type MobileSegment = MobileSegmentMetadata & {
+    /**
+     * The records contained by this Segment.
+     */
+    records: MobileRecord[];
+};
+/**
+ * Mobile-specific. Schema of a Session Replay Segment metadata.
+ */
+export type MobileSegmentMetadata = SegmentContext & CommonSegmentMetadataSchema & {
+    /**
+     * The source of this record
+     */
+    source: 'android' | 'ios' | 'flutter' | 'react-native';
+};
+/**
+ * Mobile-specific. Schema of a Session Replay Record.
+ */
+export type MobileRecord = MobileFullSnapshotRecord | MobileIncrementalSnapshotRecord | MetaRecord | FocusRecord | ViewEndRecord | VisualViewportRecord;
+/**
+ * Mobile-specific. Schema of a Record type which contains the full snapshot of a screen.
+ */
+export type MobileFullSnapshotRecord = CommonRecordSchema & {
+    /**
+     * The type of this Record.
+     */
+    type: 10;
+    data: {
+        /**
+         * The Wireframes contained by this Record.
+         */
+        wireframes: Wireframe[];
+    };
+};
+/**
+ * Schema of a Wireframe type.
+ */
+export type Wireframe = ShapeWireframe | TextWireframe | ImageWireframe | PlaceholderWireframe | WebviewWireframe;
+/**
+ * Schema of all properties of a ShapeWireframe.
+ */
+export type ShapeWireframe = CommonShapeWireframe & {
+    /**
+     * The type of the wireframe.
+     */
+    type: 'shape';
+};
+/**
+ * Schema of common properties for ShapeWireframe events type and all its sub - types.
+ */
+export type CommonShapeWireframe = CommonWireframe & {
+    shapeStyle?: ShapeStyle;
+    border?: ShapeBorder;
+};
+/**
+ * The style of this wireframe.
+ */
+export type ShapeStyle = {
+    /**
+     * The background color for this wireframe as a String hexadecimal. Follows the #RRGGBBAA color format with the alpha value as optional. The default value is #FFFFFF00.
+     */
+    backgroundColor?: string;
+    /**
+     * The opacity of this wireframe. Takes values from 0 to 1, default value is 1.
+     */
+    opacity?: number;
+    /**
+     * The corner(border) radius of this wireframe in pixels. The default value is 0.
+     */
+    cornerRadius?: number;
+};
+/**
+ * The border properties of this wireframe. The default value is null (no-border).
+ */
+export type ShapeBorder = {
+    /**
+     * The border color as a String hexadecimal. Follows the #RRGGBBAA color format with the alpha value as optional.
+     */
+    color: string;
+    /**
+     * The width of the border in pixels.
+     */
+    width: number;
+};
+/**
+ * Schema of all properties of a TextWireframe.
+ */
+export type TextWireframe = CommonShapeWireframe & {
+    /**
+     * The type of the wireframe.
+     */
+    type: 'text';
+    /**
+     * The text value of the wireframe.
+     */
+    text: string;
+    textStyle: TextStyle;
+    textPosition?: TextPosition;
+};
+/**
+ * Schema of all properties of a TextStyle.
+ */
+export type TextStyle = {
+    /**
+     * The preferred font family collection, ordered by preference and formatted as a String list: e.g. Century Gothic, Verdana, sans-serif
+     */
+    family: string;
+    /**
+     * The font size in pixels.
+     */
+    size: number;
+    /**
+     * The font color as a string hexadecimal. Follows the #RRGGBBAA color format with the alpha value as optional.
+     */
+    color: string;
+};
+/**
+ * Schema of all properties of a TextPosition.
+ */
+export type TextPosition = {
+    padding?: {
+        /**
+         * The top padding in pixels. The default value is 0.
+         */
+        top?: number;
+        /**
+         * The bottom padding in pixels. The default value is 0.
+         */
+        bottom?: number;
+        /**
+         * The left padding in pixels. The default value is 0.
+         */
+        left?: number;
+        /**
+         * The right padding in pixels. The default value is 0.
+         */
+        right?: number;
+    };
+    alignment?: {
+        /**
+         * The horizontal text alignment. The default value is `left`.
+         */
+        horizontal?: 'left' | 'right' | 'center';
+        /**
+         * The vertical text alignment. The default value is `top`.
+         */
+        vertical?: 'top' | 'bottom' | 'center';
+    };
+};
+/**
+ * Schema of all properties of a ImageWireframe.
+ */
+export type ImageWireframe = CommonShapeWireframe & {
+    /**
+     * The type of the wireframe.
+     */
+    type: 'image';
+    /**
+     * base64 representation of the image. Not required as the ImageWireframe can be initialised without any base64
+     */
+    base64?: string;
+    /**
+     * Unique identifier of the image resource
+     */
+    resourceId?: string;
+    /**
+     * MIME type of the image file
+     */
+    mimeType?: string;
+    /**
+     * Flag describing an image wireframe that should render an empty state placeholder
+     */
+    isEmpty?: boolean;
+};
+/**
+ * Schema of all properties of a PlaceholderWireframe.
+ */
+export type PlaceholderWireframe = CommonWireframe & {
+    /**
+     * The type of the wireframe.
+     */
+    type: 'placeholder';
+    /**
+     * Label of the placeholder
+     */
+    label?: string;
+};
+/**
+ * Schema of all properties of a WebviewWireframe.
+ */
+export type WebviewWireframe = CommonShapeWireframe & {
+    /**
+     * The type of the wireframe.
+     */
+    type: 'webview';
+    /**
+     * Unique Id of the slot containing this webview.
+     */
+    slotId: string;
+    /**
+     * Whether this webview is visible or not.
+     */
+    isVisible?: boolean;
+};
+/**
+ * Mobile-specific. Schema of a Record type which contains mutations of a screen.
+ */
+export type MobileIncrementalSnapshotRecord = CommonRecordSchema & {
+    /**
+     * The type of this Record.
+     */
+    type: 11;
+    data: MobileIncrementalData;
+};
+/**
+ * Mobile-specific. Schema of a Session Replay IncrementalData type.
+ */
+export type MobileIncrementalData = MobileMutationData | TouchData | ViewportResizeData | PointerInteractionData;
+/**
+ * Mobile-specific. Schema of a MutationData.
+ */
+export type MobileMutationData = {
+    /**
+     * The source of this type of incremental data.
+     */
+    source: 0;
+} & MobileMutationPayload;
+/**
+ * Mobile-specific. Schema of a MutationPayload.
+ */
+export type MobileMutationPayload = {
+    /**
+     * Contains the newly added wireframes.
+     */
+    adds?: {
+        /**
+         * The previous wireframe id next or after which this new wireframe is drawn or attached to, respectively.
+         */
+        previousId?: number;
+        wireframe: Wireframe;
+    }[];
+    /**
+     * Contains the removed wireframes as an array of ids.
+     */
+    removes?: {
+        /**
+         * The id of the wireframe that needs to be removed.
+         */
+        id: number;
+    }[];
+    /**
+     * Contains the updated wireframes mutations.
+     */
+    updates?: WireframeUpdateMutation[];
+};
+/**
+ * Schema of a WireframeUpdateMutation type.
+ */
+export type WireframeUpdateMutation = TextWireframeUpdate | ShapeWireframeUpdate | ImageWireframeUpdate | PlaceholderWireframeUpdate | WebviewWireframeUpdate;
+/**
+ * Schema of all properties of a TextWireframeUpdate.
+ */
+export type TextWireframeUpdate = CommonShapeWireframeUpdate & {
+    /**
+     * The type of the wireframe.
+     */
+    type: 'text';
+    /**
+     * The text value of the wireframe.
+     */
+    text?: string;
+    textStyle?: TextStyle;
+    textPosition?: TextPosition;
+};
+/**
+ * Schema of common properties for ShapeWireframeUpdate events type and all its sub - types.
+ */
+export type CommonShapeWireframeUpdate = CommonWireframeUpdate & {
+    shapeStyle?: ShapeStyle;
+    border?: ShapeBorder;
+};
+/**
+ * Schema of a ShapeWireframeUpdate.
+ */
+export type ShapeWireframeUpdate = CommonShapeWireframeUpdate & {
+    /**
+     * The type of the wireframe.
+     */
+    type: 'shape';
+};
+/**
+ * Schema of all properties of a ImageWireframeUpdate.
+ */
+export type ImageWireframeUpdate = CommonShapeWireframeUpdate & {
+    /**
+     * The type of the wireframe.
+     */
+    type: 'image';
+    /**
+     * base64 representation of the image. Not required as the ImageWireframe can be initialised without any base64
+     */
+    base64?: string;
+    /**
+     * Unique identifier of the image resource
+     */
+    resourceId?: string;
+    /**
+     * MIME type of the image file
+     */
+    mimeType?: string;
+    /**
+     * Flag describing an image wireframe that should render an empty state placeholder
+     */
+    isEmpty?: boolean;
+};
+/**
+ * Schema of all properties of a PlaceholderWireframe.
+ */
+export type PlaceholderWireframeUpdate = CommonWireframeUpdate & {
+    /**
+     * The type of the wireframe.
+     */
+    type: 'placeholder';
+    /**
+     * Label of the placeholder
+     */
+    label?: string;
+};
+/**
+ * Schema of all properties of a WebviewWireframeUpdate.
+ */
+export type WebviewWireframeUpdate = CommonShapeWireframeUpdate & {
+    /**
+     * The type of the wireframe.
+     */
+    type: 'webview';
+    /**
+     * Unique Id of the slot containing this webview.
+     */
+    slotId: string;
+    /**
+     * Whether this webview is visible or not.
+     */
+    isVisible?: boolean;
+};
+/**
+ * Schema of a TouchData.
+ */
+export type TouchData = {
+    /**
+     * The source of this type of incremental data.
+     */
+    source: 2;
+    /**
+     * Contains the positions of the finger on the screen during the touchDown/touchUp event lifecycle.
+     */
+    positions?: {
+        /**
+         * The touch id of the touch event this position corresponds to. In mobile it is possible to have multiple touch events (fingers touching the screen) happening at the same time.
+         */
+        id: number;
+        /**
+         * The x coordinate value of the position.
+         */
+        x: number;
+        /**
+         * The y coordinate value of the position.
+         */
+        y: number;
+        /**
+         * The UTC timestamp in milliseconds corresponding to the moment the position change was recorded. Each timestamp is computed as the UTC interval since 00:00:00.000 01.01.1970.
+         */
+        timestamp: number;
+    }[];
+};
+/**
+ * Schema of a ViewportResizeData.
+ */
+export type ViewportResizeData = {
+    /**
+     * The source of this type of incremental data.
+     */
+    source: 4;
+} & ViewportResizeDimension;
+/**
+ * Schema of a PointerInteractionData.
+ */
+export type PointerInteractionData = {
+    /**
+     * The source of this type of incremental data.
+     */
+    source: 9;
+} & PointerInteraction;
+/**
+ * Schema of a Record which contains the screen properties.
+ */
+export type MetaRecord = SlotSupportedCommonRecordSchema & {
+    /**
+     * The type of this Record.
+     */
+    type: 4;
+    /**
+     * The data contained by this record.
+     */
+    data: {
+        /**
+         * The width of the screen in pixels, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the normalized width is the current width divided by 2.
+         */
+        width: number;
+        /**
+         * The height of the screen in pixels, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the normalized height is the current height divided by 2.
+         */
+        height: number;
+        /**
+         * Browser-specific. URL of the view described by this record.
+         */
+        href?: string;
+    };
+};
+/**
+ * Schema of common properties for a Record event type that is supported by slots.
+ */
+export type SlotSupportedCommonRecordSchema = CommonRecordSchema & {
+    /**
+     * Unique ID of the slot that generated this record.
+     */
+    slotId?: string;
+};
+/**
+ * Schema of a Record type which contains focus information.
+ */
+export type FocusRecord = SlotSupportedCommonRecordSchema & {
+    /**
+     * The type of this Record.
+     */
+    type: 6;
+    data: {
+        /**
+         * Whether this screen has a focus or not. For now it will always be true for mobile.
+         */
+        has_focus: boolean;
+    };
+};
+/**
+ * Schema of a Record which signifies that view lifecycle ended.
+ */
+export type ViewEndRecord = SlotSupportedCommonRecordSchema & {
+    /**
+     * The type of this Record.
+     */
+    type: 7;
+};
+/**
+ * Schema of a Record which signifies that the viewport properties have changed.
+ */
+export type VisualViewportRecord = SlotSupportedCommonRecordSchema & {
+    data: {
+        height: number;
+        offsetLeft: number;
+        offsetTop: number;
+        pageLeft: number;
+        pageTop: number;
+        scale: number;
+        width: number;
+    };
+    /**
+     * The type of this Record.
+     */
+    type: 8;
+};
+/**
+ * Schema of a Session Replay Segment context.
+ */
+export interface SegmentContext {
+    /**
+     * Application properties
+     */
+    application: {
+        /**
+         * UUID of the application
+         */
+        id: string;
+    };
+    /**
+     * Session properties
+     */
+    session: {
+        /**
+         * UUID of the session
+         */
+        id: string;
+    };
+    /**
+     * View properties
+     */
+    view: {
+        /**
+         * UUID of the view
+         */
+        id: string;
+    };
+}
+/**
+ * Schema of common properties for a Segment Metadata type.
+ */
+export interface CommonSegmentMetadataSchema {
+    /**
+     * The start UTC timestamp in milliseconds corresponding to the first record in the Segment data. Each timestamp is computed as the UTC interval since 00:00:00.000 01.01.1970.
+     */
+    start: number;
+    /**
+     * The end UTC timestamp in milliseconds corresponding to the last record in the Segment data. Each timestamp is computed as the UTC interval since 00:00:00.000 01.01.1970.
+     */
+    end: number;
+    /**
+     * The number of records in this Segment.
+     */
+    records_count: number;
+    /**
+     * The index of this Segment in the segments list that was recorded for this view ID. Starts from 0.
+     */
+    index_in_view?: number;
+    /**
+     * Whether this Segment contains a full snapshot record or not.
+     */
+    has_full_snapshot?: boolean;
+}
+/**
+ * Schema of common properties for a Record event type.
+ */
+export interface CommonRecordSchema {
+    /**
+     * Defines the UTC time in milliseconds when this Record was performed.
+     */
+    timestamp: number;
+}
+/**
+ * Schema of common properties for Wireframe events type.
+ */
+export interface CommonWireframe {
+    /**
+     * Defines the unique ID of the wireframe. This is persistent throughout the view lifetime.
+     */
+    id: number;
+    /**
+     * The position in pixels on X axis of the UI element in absolute coordinates. The anchor point is always the top-left corner of the wireframe.
+     */
+    x: number;
+    /**
+     * The position in pixels on Y axis of the UI element in absolute coordinates. The anchor point is always the top-left corner of the wireframe.
+     */
+    y: number;
+    /**
+     * The width in pixels of the UI element, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the width of all UI elements is divided by 2 to get a normalized width.
+     */
+    width: number;
+    /**
+     * The height in pixels of the UI element, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the height of all UI elements is divided by 2 to get a normalized height.
+     */
+    height: number;
+    clip?: WireframeClip;
+}
+/**
+ * Schema of clipping information for a Wireframe.
+ */
+export interface WireframeClip {
+    /**
+     * The amount of space in pixels that needs to be clipped (masked) at the top of the wireframe.
+     */
+    top?: number;
+    /**
+     * The amount of space in pixels that needs to be clipped (masked) at the bottom of the wireframe.
+     */
+    bottom?: number;
+    /**
+     * The amount of space in pixels that needs to be clipped (masked) at the left of the wireframe.
+     */
+    left?: number;
+    /**
+     * The amount of space in pixels that needs to be clipped (masked) at the right of the wireframe.
+     */
+    right?: number;
+}
+/**
+ * Schema of common properties for WireframeUpdate events type.
+ */
+export interface CommonWireframeUpdate {
+    /**
+     * Defines the unique ID of the wireframe. This is persistent throughout the view lifetime.
+     */
+    id: number;
+    /**
+     * The position in pixels on X axis of the UI element in absolute coordinates. The anchor point is always the top-left corner of the wireframe.
+     */
+    x?: number;
+    /**
+     * The position in pixels on Y axis of the UI element in absolute coordinates. The anchor point is always the top-left corner of the wireframe.
+     */
+    y?: number;
+    /**
+     * The width in pixels of the UI element, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the width of all UI elements is divided by 2 to get a normalized width.
+     */
+    width?: number;
+    /**
+     * The height in pixels of the UI element, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the height of all UI elements is divided by 2 to get a normalized height.
+     */
+    height?: number;
+    clip?: WireframeClip;
+}
+/**
+ * Schema of a ViewportResizeDimension.
+ */
+export interface ViewportResizeDimension {
+    /**
+     * The new width of the screen in pixels, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the width is divided by 2 to get a normalized width.
+     */
+    width: number;
+    /**
+     * The new height of the screen in pixels, normalized based on the device pixels per inch density (DPI). Example: if a device has a DPI = 2, the height is divided by 2 to get a normalized height.
+     */
+    height: number;
+}
+/**
+ * Schema of a PointerInteraction.
+ */
+export interface PointerInteraction {
+    /**
+     * Schema of an PointerEventType
+     */
+    pointerEventType: 'down' | 'up' | 'move';
+    /**
+     * Schema of an PointerType
+     */
+    pointerType: 'mouse' | 'touch' | 'pen';
+    /**
+     * Id of the pointer of this PointerInteraction.
+     */
+    pointerId: number;
+    /**
+     * X-axis coordinate for this PointerInteraction.
+     */
+    x: number;
+    /**
+     * Y-axis coordinate for this PointerInteraction.
+     */
+    y: number;
+}

package/lib/esm/generated/mobileSessionReplay.js

@@ -0,0 +1,5 @@
+/* eslint-disable */
+/**
+ * DO NOT MODIFY IT BY HAND. Run `yarn generate` instead.
+ */
+export {};