@cloudcare/guance-front-tools 1.0.0

package/lib/src/dashboard-charts.ts

@@ -0,0 +1 @@
+export * from '../generated/dashboardCharts'

package/lib/src/index.ts

@@ -0,0 +1,2 @@
+export * from './session-replay'
+export * from './dashboard-charts'

package/lib/src/session-replay-browser.ts

@@ -0,0 +1,98 @@
+import type * as SessionReplay from '../generated/browserSessionReplay'
+
+export * from '../generated/browserSessionReplay'
+
+/**
+ * For backward compatibility reasons, `undefined` should be accepted as a possible value for Browser segments, too.
+ **/
+export const BrowserSource = {
+  Browser: 'browser',
+} as const
+
+export type BrowserSource = typeof BrowserSource[keyof typeof BrowserSource]
+
+export const RecordType: {
+  FullSnapshot: SessionReplay.BrowserFullSnapshotRecord['type']
+  IncrementalSnapshot: SessionReplay.BrowserIncrementalSnapshotRecord['type']
+  Meta: SessionReplay.MetaRecord['type']
+  Focus: SessionReplay.FocusRecord['type']
+  ViewEnd: SessionReplay.ViewEndRecord['type']
+  VisualViewport: SessionReplay.VisualViewportRecord['type']
+  FrustrationRecord: SessionReplay.FrustrationRecord['type']
+} = {
+  FullSnapshot: 2,
+  IncrementalSnapshot: 3,
+  Meta: 4,
+  Focus: 6,
+  ViewEnd: 7,
+  VisualViewport: 8,
+  FrustrationRecord: 9,
+} as const
+
+export type RecordType = typeof RecordType[keyof typeof RecordType]
+
+export const NodeType: {
+  Document: SessionReplay.DocumentNode['type']
+  DocumentType: SessionReplay.DocumentTypeNode['type']
+  Element: SessionReplay.ElementNode['type']
+  Text: SessionReplay.TextNode['type']
+  CDATA: SessionReplay.CDataNode['type']
+  DocumentFragment: SessionReplay.DocumentFragmentNode['type']
+} = {
+  Document: 0,
+  DocumentType: 1,
+  Element: 2,
+  Text: 3,
+  CDATA: 4,
+  DocumentFragment: 11,
+} as const
+
+export type NodeType = typeof NodeType[keyof typeof NodeType]
+
+export const IncrementalSource: {
+  Mutation: SessionReplay.BrowserMutationData['source']
+  MouseMove: Exclude<SessionReplay.MousemoveData['source'], 6>
+  MouseInteraction: SessionReplay.MouseInteractionData['source']
+  Scroll: SessionReplay.ScrollData['source']
+  ViewportResize: SessionReplay.ViewportResizeData['source']
+  Input: SessionReplay.InputData['source']
+  TouchMove: Exclude<SessionReplay.MousemoveData['source'], 1>
+  MediaInteraction: SessionReplay.MediaInteractionData['source']
+  StyleSheetRule: SessionReplay.StyleSheetRuleData['source']
+  PointerInteraction: SessionReplay.PointerInteractionData['source']
+} = {
+  Mutation: 0,
+  MouseMove: 1,
+  MouseInteraction: 2,
+  Scroll: 3,
+  ViewportResize: 4,
+  Input: 5,
+  TouchMove: 6,
+  MediaInteraction: 7,
+  StyleSheetRule: 8,
+  PointerInteraction: 9,
+  // Font : 10,
+} as const
+
+export type IncrementalSource = typeof IncrementalSource[keyof typeof IncrementalSource]
+
+export const MouseInteractionType = {
+  MouseUp: 0,
+  MouseDown: 1,
+  Click: 2,
+  ContextMenu: 3,
+  DblClick: 4,
+  Focus: 5,
+  Blur: 6,
+  TouchStart: 7,
+  TouchEnd: 9,
+} as const
+
+export type MouseInteractionType = typeof MouseInteractionType[keyof typeof MouseInteractionType]
+
+export const MediaInteractionType = {
+  Play: 0,
+  Pause: 1,
+} as const
+
+export type MediaInteractionType = typeof MediaInteractionType[keyof typeof MediaInteractionType]

package/lib/src/session-replay-mobile.ts

@@ -0,0 +1,54 @@
+import type * as SessionReplay from '../generated/mobileSessionReplay'
+
+export * from '../generated/mobileSessionReplay'
+
+export const MobileSource = {
+  Android: 'android',
+  Ios: 'ios',
+  Flutter: 'flutter',
+  ReactNative: 'react-native',
+} as const
+
+export type MobileSource = typeof MobileSource[keyof typeof MobileSource]
+
+export const RecordType: {
+  FullSnapshot: SessionReplay.MobileFullSnapshotRecord['type']
+  IncrementalSnapshot: SessionReplay.MobileIncrementalSnapshotRecord['type']
+  Meta: SessionReplay.MetaRecord['type']
+  Focus: SessionReplay.FocusRecord['type']
+  ViewEnd: SessionReplay.ViewEndRecord['type']
+  VisualViewport: SessionReplay.VisualViewportRecord['type']
+} = {
+  FullSnapshot: 10,
+  IncrementalSnapshot: 11,
+  Meta: 4,
+  Focus: 6,
+  ViewEnd: 7,
+  VisualViewport: 8,
+} as const
+
+export type RecordType = typeof RecordType[keyof typeof RecordType]
+
+export const WireframeType: {
+  Shape: SessionReplay.ShapeWireframe['type']
+  Text: SessionReplay.TextWireframe['type']
+} = {
+  Shape: 'shape',
+  Text: 'text',
+} as const
+
+export type WireframeType = typeof WireframeType[keyof typeof WireframeType]
+
+export const IncrementalSource: {
+  Mutation: SessionReplay.MobileMutationData['source']
+  Touch: SessionReplay.TouchData['source']
+  ViewportResize: SessionReplay.ViewportResizeData['source']
+  PointerInteraction: SessionReplay.PointerInteractionData['source']
+} = {
+  Mutation: 0,
+  Touch: 2,
+  ViewportResize: 4,
+  PointerInteraction: 9,
+} as const
+
+export type IncrementalSource = typeof IncrementalSource[keyof typeof IncrementalSource]

package/lib/src/session-replay.ts

@@ -0,0 +1,61 @@
+import type {
+  IncrementalSource as BrowserIncrementalSource,
+  RecordType as BrowserRecordType,
+} from './session-replay-browser'
+import type {
+  IncrementalSource as MobileIncrementalSource,
+  RecordType as MobileRecordType,
+} from './session-replay-mobile'
+
+export * from '../generated/sessionReplay'
+
+export {
+  BrowserSource,
+  NodeType,
+  IncrementalSource as BrowserIncrementalSource,
+  MouseInteractionType,
+  MediaInteractionType,
+} from './session-replay-browser'
+export { IncrementalSource as MobileIncrementalSource, MobileSource, WireframeType } from './session-replay-mobile'
+
+export const RecordType: {
+  BrowserFullSnapshot: typeof BrowserRecordType.FullSnapshot
+  BrowserIncrementalSnapshot: typeof BrowserRecordType.IncrementalSnapshot
+  Meta: typeof BrowserRecordType.Meta
+  Focus: typeof BrowserRecordType.Focus
+  ViewEnd: typeof BrowserRecordType.ViewEnd
+  VisualViewport: typeof BrowserRecordType.VisualViewport
+  FrustrationRecord: typeof BrowserRecordType.FrustrationRecord
+  MobileFullSnapshot: typeof MobileRecordType.FullSnapshot
+  MobileIncrementalSnapshot: typeof MobileRecordType.IncrementalSnapshot
+} = {
+  BrowserFullSnapshot: 2,
+  BrowserIncrementalSnapshot: 3,
+  Meta: 4,
+  Focus: 6,
+  ViewEnd: 7,
+  VisualViewport: 8,
+  FrustrationRecord: 9,
+  MobileFullSnapshot: 10,
+  MobileIncrementalSnapshot: 11,
+} as const
+
+export type RecordType = typeof RecordType[keyof typeof RecordType]
+
+export type IncrementalSource = BrowserIncrementalSource | MobileIncrementalSource
+
+export const PointerEventType = {
+  PointerDown: 'down',
+  PointerUp: 'up',
+  PointerMove: 'move',
+} as const
+
+export type PointerEventType = typeof PointerEventType[keyof typeof PointerEventType]
+
+export const PointerType = {
+  Mouse: 'mouse',
+  Touch: 'touch',
+  Pen: 'pen',
+} as const
+
+export type PointerType = typeof PointerType[keyof typeof PointerType]

package/package.json

@@ -0,0 +1,45 @@
+{
+    "name": "@cloudcare/guance-front-tools",
+    "version": "1.0.0",
+    "publishConfig": {
+        "access": "public"
+    },
+    "config": {
+        "path:generated": "./lib/generated"
+    },
+    "bin": {
+        "grafanaCovertToGuance": "cli.js"
+    },
+    "description": "观测云前端工具",
+    "type": "module",
+    "main": "lib/cjs/src/index.js",
+    "types": "lib/cjs/src/index.d.ts",
+    "module": "lib/esm/src/index.js",
+    "scripts": {
+        "build": "npm run clean && npm run generate && npm run build:cjs && npm run build:esm && npm run build:script",
+        "build:cjs": "tsc -p tsconfig.cjs.json",
+        "build:esm": "tsc -p tsconfig.esm.json",
+        "build:script": "tsc -p tsconfig.script.json",
+        "clean": "rm -rf ./lib/generated && rm -rf ./lib/esm && rm -rf ./lib/cjs",
+        "generate": "node scripts/generate.mjs",
+        "format": "prettier -c .",
+        "validate": "node scripts/validate.mjs"
+    },
+    "devDependencies": {
+        "ajv": "8.11.0",
+        "install": "^0.13.0",
+        "json-schema-to-typescript": "^15.0.2",
+        "npm": "^10.8.3",
+        "prettier": "2.7.1",
+        "typescript": ">=4.5",
+        "@types/node": "^12.20.55"
+    },
+    "engines": {
+        "node": ">=12.7.0"
+    },
+    "author": "",
+    "license": "ISC",
+    "dependencies": {
+        "yargs": "^17.7.2"
+    }
+}