@cloudcare/guance-front-tools 1.0.18 → 1.0.19

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mobile/text-position-schema.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/text-position-schema.json",
+  "title": "TextPosition",
+  "type": "object",
+  "description": "Schema of all properties of a TextPosition.",
+  "allOf": [
+    {
+      "properties": {
+        "padding": {
+          "type": "object",
+          "properties": {
+            "top": {
+              "type": "integer",
+              "description": "The top padding in pixels. The default value is 0.",
+              "readOnly": true
+            },
+            "bottom": {
+              "type": "integer",
+              "description": "The bottom padding in pixels. The default value is 0.",
+              "readOnly": true
+            },
+            "left": {
+              "type": "integer",
+              "description": "The left padding in pixels. The default value is 0.",
+              "readOnly": true
+            },
+            "right": {
+              "type": "integer",
+              "description": "The right padding in pixels. The default value is 0.",
+              "readOnly": true
+            }
+          },
+          "readOnly": true
+        },
+        "alignment": {
+          "type": "object",
+          "properties": {
+            "horizontal": {
+              "type": "string",
+              "description": "The horizontal text alignment. The default value is `left`.",
+              "enum": ["left", "right", "center"],
+              "readOnly": true
+            },
+            "vertical": {
+              "type": "string",
+              "description": "The vertical text alignment. The default value is `top`.",
+              "enum": ["top", "bottom", "center"],
+              "readOnly": true
+            }
+          },
+          "readOnly": true
+        }
+      }
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mobile/text-style-schema.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/text-style-schema.json",
+  "title": "TextStyle",
+  "type": "object",
+  "description": "Schema of all properties of a TextStyle.",
+  "allOf": [
+    {
+      "required": ["color", "family", "size"],
+      "properties": {
+        "family": {
+          "type": "string",
+          "description": "The preferred font family collection, ordered by preference and formatted as a String list: e.g. Century Gothic, Verdana, sans-serif",
+          "readOnly": true
+        },
+        "size": {
+          "type": "integer",
+          "description": "The font size in pixels.",
+          "readOnly": true
+        },
+        "color": {
+          "type": "string",
+          "pattern": "^#[A-Fa-f0-9]{6}([A-Fa-f0-9]{2})?$",
+          "description": "The font color as a string hexadecimal. Follows the #RRGGBBAA color format with the alpha value as optional.",
+          "readOnly": true
+        }
+      },
+      "readOnly": true
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mobile/text-wireframe-schema.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/text-wireframe-schema.json",
+  "title": "TextWireframe",
+  "type": "object",
+  "description": "Schema of all properties of a TextWireframe.",
+  "allOf": [
+    {
+      "$ref": "_common-shape-wireframe-schema.json"
+    },
+    {
+      "required": ["text", "type", "textStyle"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of the wireframe.",
+          "const": "text",
+          "readOnly": true
+        },
+        "text": {
+          "type": "string",
+          "description": "The text value of the wireframe.",
+          "readOnly": false
+        },
+        "textStyle": {
+          "$ref": "text-style-schema.json"
+        },
+        "textPosition": {
+          "$ref": "text-position-schema.json"
+        }
+      }
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mobile/text-wireframe-update-schema.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/text-wireframe-update-schema.json",
+  "title": "TextWireframeUpdate",
+  "type": "object",
+  "description": "Schema of all properties of a TextWireframeUpdate.",
+  "allOf": [
+    {
+      "$ref": "_common-shape-wireframe-update-schema.json"
+    },
+    {
+      "required": ["type"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of the wireframe.",
+          "const": "text",
+          "readOnly": true
+        },
+        "text": {
+          "type": "string",
+          "description": "The text value of the wireframe.",
+          "readOnly": false
+        },
+        "textStyle": {
+          "$ref": "text-style-schema.json"
+        },
+        "textPosition": {
+          "$ref": "text-position-schema.json"
+        }
+      }
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mobile/touch-data-schema.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/touch-data-schema.json",
+  "title": "TouchData",
+  "type": "object",
+  "description": "Schema of a TouchData.",
+  "allOf": [
+    {
+      "required": ["source"],
+      "properties": {
+        "source": {
+          "type": "integer",
+          "const": 2,
+          "description": "The source of this type of incremental data.",
+          "readOnly": true
+        },
+        "positions": {
+          "type": "array",
+          "readOnly": true,
+          "items": {
+            "type": "object",
+            "required": ["id", "x", "y", "timestamp"],
+            "properties": {
+              "id": {
+                "type": "integer",
+                "description": "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.",
+                "readOnly": true
+              },
+              "x": {
+                "type": "integer",
+                "description": "The x coordinate value of the position.",
+                "readOnly": true
+              },
+              "y": {
+                "type": "integer",
+                "description": "The y coordinate value of the position.",
+                "readOnly": true
+              },
+              "timestamp": {
+                "type": "integer",
+                "description": "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.",
+                "readOnly": true
+              }
+            }
+          },
+          "description": "Contains the positions of the finger on the screen during the touchDown/touchUp event lifecycle."
+        }
+      }
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mobile/webview-wireframe-schema.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/webview-wireframe-schema.json",
+  "title": "WebviewWireframe",
+  "type": "object",
+  "description": "Schema of all properties of a WebviewWireframe.",
+  "allOf": [
+    {
+      "$ref": "_common-shape-wireframe-schema.json"
+    },
+    {
+      "required": ["type", "slotId"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of the wireframe.",
+          "const": "webview",
+          "readOnly": true
+        },
+        "slotId": {
+          "type": "string",
+          "description": "Unique Id of the slot containing this webview.",
+          "readOnly": true
+        },
+        "isVisible": {
+          "type": "boolean",
+          "description": "Whether this webview is visible or not.",
+          "readOnly": true
+        }
+      }
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mobile/webview-wireframe-update-schema.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/webview-wireframe-update-schema.json",
+  "title": "WebviewWireframeUpdate",
+  "type": "object",
+  "description": "Schema of all properties of a WebviewWireframeUpdate.",
+  "allOf": [
+    {
+      "$ref": "_common-shape-wireframe-update-schema.json"
+    },
+    {
+      "required": ["type", "slotId"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of the wireframe.",
+          "const": "webview",
+          "readOnly": true
+        },
+        "slotId": {
+          "type": "string",
+          "description": "Unique Id of the slot containing this webview.",
+          "readOnly": true
+        },
+        "isVisible": {
+          "type": "boolean",
+          "description": "Whether this webview is visible or not.",
+          "readOnly": true
+        }
+      }
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mobile/wireframe-clip-schema.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/wireframe-clip-schema.json",
+  "title": "WireframeClip",
+  "type": "object",
+  "description": "Schema of clipping information for a Wireframe.",
+  "properties": {
+    "top": {
+      "type": "integer",
+      "description": "The amount of space in pixels that needs to be clipped (masked) at the top of the wireframe.",
+      "readOnly": true
+    },
+    "bottom": {
+      "type": "integer",
+      "description": "The amount of space in pixels that needs to be clipped (masked) at the bottom of the wireframe.",
+      "readOnly": true
+    },
+    "left": {
+      "type": "integer",
+      "description": "The amount of space in pixels that needs to be clipped (masked) at the left of the wireframe.",
+      "readOnly": true
+    },
+    "right": {
+      "type": "integer",
+      "description": "The amount of space in pixels that needs to be clipped (masked) at the right of the wireframe.",
+      "readOnly": true
+    }
+  }
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mobile/wireframe-schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/wireframe-schema.json",
+  "title": "Wireframe",
+  "type": "object",
+  "description": "Schema of a Wireframe type.",
+  "oneOf": [
+    {
+      "$ref": "shape-wireframe-schema.json"
+    },
+    {
+      "$ref": "text-wireframe-schema.json"
+    },
+    {
+      "$ref": "image-wireframe-schema.json"
+    },
+    {
+      "$ref": "placeholder-wireframe-schema.json"
+    },
+    {
+      "$ref": "webview-wireframe-schema.json"
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mobile/wireframe-update-mutation-schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mobile/wireframe-update-mutation-schema.json",
+  "title": "WireframeUpdateMutation",
+  "type": "object",
+  "description": "Schema of a WireframeUpdateMutation type.",
+  "oneOf": [
+    {
+      "$ref": "text-wireframe-update-schema.json"
+    },
+    {
+      "$ref": "shape-wireframe-update-schema.json"
+    },
+    {
+      "$ref": "image-wireframe-update-schema.json"
+    },
+    {
+      "$ref": "placeholder-wireframe-update-schema.json"
+    },
+    {
+      "$ref": "webview-wireframe-update-schema.json"
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mutation-data-schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mutation-data-schema.json",
+  "title": "MutationData",
+  "description": "Schema of a MutationData.",
+  "oneOf": [
+    {
+      "$ref": "browser/mutation-data-schema.json"
+    },
+    {
+      "$ref": "mobile/mutation-data-schema.json"
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/mutation-payload-schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/mutation-payload-schema.json",
+  "title": "MutationPayload",
+  "description": "Schema of a MutationPayload.",
+  "oneOf": [
+    {
+      "$ref": "browser/mutation-payload-schema.json"
+    },
+    {
+      "$ref": "mobile/mutation-payload-schema.json"
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/record-schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/record-schema.json",
+  "title": "Record",
+  "description": "Schema of a Session Replay Record.",
+  "oneOf": [
+    {
+      "$ref": "browser/record-schema.json"
+    },
+    {
+      "$ref": "mobile/record-schema.json"
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/segment-metadata-schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/segment-metadata-schema.json",
+  "title": "SegmentMetadata",
+  "description": "Schema of a Session Replay SegmentMetadata.",
+  "oneOf": [
+    {
+      "$ref": "browser/segment-metadata-schema.json"
+    },
+    {
+      "$ref": "mobile/segment-metadata-schema.json"
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay/segment-schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "session-replay/segment-schema.json",
+  "title": "Segment",
+  "type": "object",
+  "description": "Schema of a Session Replay data Segment.",
+  "oneOf": [
+    {
+      "$ref": "browser/segment-schema.json"
+    },
+    {
+      "$ref": "mobile/segment-schema.json"
+    }
+  ]
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay-browser-schema.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "session-replay-browser-schema.json",
+    "$ref": "session-replay/browser/segment-schema.json"
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay-mobile-schema.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "session-replay-mobile-schema.json",
+    "$ref": "session-replay/mobile/segment-schema.json"
+}

package/skills/grafana-to-guance-dashboard/schemas/session-replay-schema.json

@@ -0,0 +1,33 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "session-replay-schema.json",
+    "title": "SessionReplay",
+    "type": "object",
+    "description": "Schema of all properties of Session Replay",
+    "allOf": [
+        {
+            "$ref": "session-replay/segment-schema.json"
+        },
+        {
+            "$ref": "session-replay/segment-metadata-schema.json"
+        },
+        {
+            "$ref": "session-replay/record-schema.json"
+        },
+        {
+            "$ref": "session-replay/full-snapshot-record-schema.json"
+        },
+        {
+            "$ref": "session-replay/incremental-snapshot-record-schema.json"
+        },
+        {
+            "$ref": "session-replay/incremental-data-schema.json"
+        },
+        {
+            "$ref": "session-replay/mutation-data-schema.json"
+        },
+        {
+            "$ref": "session-replay/mutation-payload-schema.json"
+        }
+    ]
+}

package/skills/grafana-to-guance-dashboard/scripts/convert-grafana-dashboard.mjs

@@ -4,6 +4,8 @@ import path from 'path';
 import { pathToFileURL } from 'url';
 import Ajv from 'ajv';
 import { convertDashboard } from './convert-grafana-dashboard-core.js';
+const SCRIPT_DIRECTORY = path.dirname(new URL(import.meta.url).pathname);
+const SKILL_ROOT = path.resolve(SCRIPT_DIRECTORY, '..');
 if (isDirectExecution()) {
     main();
 }
@@ -75,8 +77,7 @@ function printHelp() {
     console.error('Usage: node convert-grafana-dashboard.mjs --input <grafana.json> [--output <guance.json>] [--validate] [--schema <schema-id>] [--guance-promql-compatible] [--keep-grafana-meta]');
 }
 export function validateDashboardFile(filePath, schemaId) {
-    const projectRoot = findProjectRoot();
-    const schemasDirectory = path.join(projectRoot, 'schemas');
+    const schemasDirectory = resolveSchemasDirectory();
     const ajv = new Ajv({ allErrors: true });
     forEachFile(schemasDirectory, (schemaPath) => {
         if (!schemaPath.endsWith('.json'))
@@ -95,18 +96,12 @@ export function validateDashboardFile(filePath, schemaId) {
     }
     process.exit(1);
 }
-function findProjectRoot() {
-    let currentDirectory = process.cwd();
-    while (true) {
-        if (fs.existsSync(path.join(currentDirectory, 'schemas', 'dashboard-schema.json'))) {
-            return currentDirectory;
-        }
-        const parentDirectory = path.dirname(currentDirectory);
-        if (parentDirectory === currentDirectory) {
-            throw new Error('Could not locate project root containing schemas/dashboard-schema.json');
-        }
-        currentDirectory = parentDirectory;
+function resolveSchemasDirectory() {
+    const skillSchemasDirectory = path.join(SKILL_ROOT, 'schemas');
+    if (fs.existsSync(path.join(skillSchemasDirectory, 'dashboard-schema.json'))) {
+        return skillSchemasDirectory;
     }
+    throw new Error(`Could not locate standalone schemas at ${skillSchemasDirectory}`);
 }
 function readJson(filePath) {
     return JSON.parse(fs.readFileSync(filePath, 'utf8'));

package/skills/grafana-to-guance-dashboard/scripts/validate-file.mjs

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+import Ajv from 'ajv';
+import fs from 'fs';
+import path from 'path';
+
+const SCRIPT_DIRECTORY = path.dirname(new URL(import.meta.url).pathname);
+const SKILL_ROOT = path.resolve(SCRIPT_DIRECTORY, '..');
+const SCHEMAS_DIRECTORY = path.join(SKILL_ROOT, 'schemas');
+
+const args = process.argv.slice(2);
+const schemaFlagIndex = args.indexOf('--schema');
+const schemaId = schemaFlagIndex >= 0 ? args[schemaFlagIndex + 1] : 'dashboard-schema.json';
+const jsonPaths = schemaFlagIndex >= 0 ? args.filter((_, index) => index !== schemaFlagIndex && index !== schemaFlagIndex + 1) : args;
+
+if (jsonPaths.length === 0) {
+    console.error('Usage: node scripts/validate-file.mjs <json-path...> [--schema <schema-id>]');
+    process.exit(1);
+}
+if (!fs.existsSync(path.join(SCHEMAS_DIRECTORY, 'dashboard-schema.json'))) {
+    console.error(`Could not locate standalone schemas at ${SCHEMAS_DIRECTORY}`);
+    process.exit(1);
+}
+
+const ajv = new Ajv({ allErrors: true });
+forEachFile(SCHEMAS_DIRECTORY, (schemaPath) => {
+    if (!schemaPath.endsWith('.json'))
+        return;
+    ajv.addSchema(readJson(schemaPath));
+});
+
+let hasError = false;
+for (const jsonPath of jsonPaths) {
+    const valid = ajv.validate(schemaId, readJson(jsonPath));
+    if (valid) {
+        console.log(`Validated ${jsonPath} against ${schemaId}`);
+        continue;
+    }
+    hasError = true;
+    console.error(`Validation failed for ${jsonPath} against ${schemaId}:`);
+    for (const error of ajv.errors || []) {
+        const instancePath = error.instancePath || '/';
+        console.error(`- ${instancePath} ${error.message}`);
+    }
+}
+
+process.exit(hasError ? 1 : 0);
+
+function forEachFile(directoryPath, visitor) {
+    const entries = fs.readdirSync(directoryPath, { withFileTypes: true });
+    for (const entry of entries) {
+        const entryPath = path.join(directoryPath, entry.name);
+        if (entry.isDirectory()) {
+            forEachFile(entryPath, visitor);
+            continue;
+        }
+        visitor(entryPath);
+    }
+}
+
+function readJson(filePath) {
+    return JSON.parse(fs.readFileSync(filePath, 'utf8'));
+}

package/skills/grafana-to-guance-dashboard/test/convert.test.mjs

@@ -0,0 +1,54 @@
+import test from 'node:test';
+import assert from 'node:assert/strict';
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { execFileSync } from 'node:child_process';
+
+const TEST_DIRECTORY = path.dirname(new URL(import.meta.url).pathname);
+const SKILL_ROOT = path.resolve(TEST_DIRECTORY, '..');
+const FIXTURE_INPUT = path.join(SKILL_ROOT, 'fixtures', 'grafana-dashboard.json');
+const FIXTURE_DASHBOARD = JSON.parse(fs.readFileSync(FIXTURE_INPUT, 'utf8'));
+
+test('standalone converter produces schema-valid dashboard output', () => {
+  const tempDirectory = fs.mkdtempSync(path.join(os.tmpdir(), 'grafana-to-guance-skill-'));
+  const outputPath = path.join(tempDirectory, 'dashboard.guance.json');
+
+  execFileSync(
+    process.execPath,
+    ['scripts/convert-grafana-dashboard.mjs', '--input', FIXTURE_INPUT, '--output', outputPath, '--validate'],
+    {
+      cwd: SKILL_ROOT,
+      stdio: 'pipe',
+    }
+  );
+
+  const output = JSON.parse(fs.readFileSync(outputPath, 'utf8'));
+  assert.equal(output.title, FIXTURE_DASHBOARD.title);
+  assert.equal(output.main.type, 'template');
+  assert.ok(Array.isArray(output.main.charts));
+  assert.ok(output.main.charts.length > 0);
+});
+
+test('standalone validator accepts generated dashboard output', () => {
+  const tempDirectory = fs.mkdtempSync(path.join(os.tmpdir(), 'grafana-to-guance-skill-'));
+  const outputPath = path.join(tempDirectory, 'dashboard.guance.json');
+
+  execFileSync(
+    process.execPath,
+    ['scripts/convert-grafana-dashboard.mjs', '--input', FIXTURE_INPUT, '--output', outputPath],
+    {
+      cwd: SKILL_ROOT,
+      stdio: 'pipe',
+    }
+  );
+
+  execFileSync(
+    process.execPath,
+    ['scripts/validate-file.mjs', outputPath],
+    {
+      cwd: SKILL_ROOT,
+      stdio: 'pipe',
+    }
+  );
+});