@luxonis/depthai-viewer-common 3.7.5 → 3.8.0

package/protobuf-gen.win.ps1

@@ -0,0 +1,130 @@
+$ErrorActionPreference = 'Stop'
+
+$scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
+$workspaceRoot = Resolve-Path (Join-Path $scriptDir '..\..')
+$outputDir = Join-Path $scriptDir 'src\visualizer\protobuf.generated'
+$tempProtoDir = Join-Path $scriptDir '~proto'
+
+$protoRepo = 'luxonis/depthai-core'
+$protoPath = 'protos'
+$protoBranch = 'develop'
+$requestHeaders = @{
+	'User-Agent' = 'depthai-visualizer-protobuf-build-win'
+}
+
+try {
+	[Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12
+}
+catch {
+	# Ignore if the host PowerShell does not expose TLS configuration.
+}
+
+$pluginPathCandidates = @(
+	(Join-Path $scriptDir 'node_modules\.bin\protoc-gen-ts_proto.cmd'),
+	(Join-Path $workspaceRoot 'node_modules\.bin\protoc-gen-ts_proto.cmd')
+)
+
+$pluginPath = $pluginPathCandidates | Where-Object { Test-Path $_ } | Select-Object -First 1
+if (-not $pluginPath) {
+	Write-Error 'Unable to locate protoc-gen-ts_proto.cmd in workspace or package node_modules/.bin'
+	exit 1
+}
+
+# --- Step 1: Fetch .proto files into ~proto/ (mirrors protobuf-gen.sh) ---
+
+Write-Host '[Protobuf Gen] Fetching protobuf definitions...'
+
+if (Test-Path $tempProtoDir) { Remove-Item -Path $tempProtoDir -Recurse -Force }
+New-Item -ItemType Directory -Path $tempProtoDir -Force | Out-Null
+
+try {
+	$apiUrl = "https://api.github.com/repos/${protoRepo}/contents/${protoPath}?ref=${protoBranch}"
+	$entriesResponse = Invoke-RestMethod -Uri $apiUrl -Headers $requestHeaders
+
+	# GitHub returns a single object with a 'message' field on errors (rate limit, 404, etc.)
+	if ($null -eq $entriesResponse) {
+		throw 'GitHub API returned an empty response'
+	}
+
+	if ($entriesResponse -isnot [System.Array] -and ($entriesResponse.PSObject.Properties.Name -contains 'message')) {
+		throw "GitHub API error: $($entriesResponse.message)"
+	}
+
+	$entries = @($entriesResponse)
+	$downloadUrls = @($entries |
+		Where-Object { $_.type -eq 'file' -and $_.name -like '*.proto' -and $_.download_url } |
+		Select-Object -ExpandProperty download_url)
+
+	if ($downloadUrls.Count -eq 0) { throw 'GitHub API returned no .proto files in the expected location' }
+
+	foreach ($url in $downloadUrls) {
+		$fileName = Split-Path -Path $url -Leaf
+		Write-Host "- $fileName"
+		Invoke-WebRequest -Uri $url -Headers $requestHeaders -OutFile (Join-Path $tempProtoDir $fileName)
+	}
+}
+catch {
+	Write-Warning "[Protobuf Gen] Failed to fetch definitions: $($_.Exception.Message)"
+}
+
+# --- Step 2: Compile if files were downloaded, else reuse existing .ts sources ---
+
+Write-Host '[Protobuf Gen] Compiling protobuf definitions...'
+
+$downloadedProtos = @(Get-ChildItem -Path $tempProtoDir -Filter *.proto -File)
+
+New-Item -ItemType Directory -Path $outputDir -Force | Out-Null
+$resolvedOutputDir = (Resolve-Path $outputDir).Path
+
+if ($downloadedProtos.Count -gt 0) {
+	$protoSourceDir = $tempProtoDir
+	$protoFiles = $downloadedProtos | ForEach-Object { $_.Name }
+}
+else {
+	# Fallback 1: compile committed .proto files from src/protobuf.generated
+	$localProtos = @(Get-ChildItem -Path $outputDir -Filter *.proto -File)
+	if ($localProtos.Count -gt 0) {
+		Write-Host '[Protobuf Gen] No protobuf definitions were downloaded, compiling local .proto files.'
+		$protoSourceDir = $resolvedOutputDir
+		$protoFiles = $localProtos | ForEach-Object { $_.Name }
+	}
+	# Fallback 2 (matches protobuf-gen.sh): reuse existing generated .ts files
+	elseif (@(Get-ChildItem -Path $outputDir -Filter *.ts -File).Count -gt 0) {
+		Write-Host '[Protobuf Gen] No protobuf definitions were downloaded, reusing existing generated sources.'
+		$protoSourceDir = $null
+	}
+	else {
+		Write-Error '[Protobuf Gen] No protobuf definitions were downloaded and no generated sources are available.'
+		exit 1
+	}
+}
+
+if ($protoSourceDir) {
+	$protocCommand = Get-Command protoc -ErrorAction SilentlyContinue
+	if (-not $protocCommand) {
+		Write-Error '[Protobuf Gen] Unable to locate protoc on PATH. Install the Protocol Buffers compiler and restart the shell.'
+		exit 1
+	}
+
+	Push-Location $protoSourceDir
+	& $protocCommand.Source -I . --experimental_allow_proto3_optional --plugin=protoc-gen-ts_proto=$pluginPath --ts_proto_opt=esModuleInterop=true --ts_proto_opt=importSuffix=.js --ts_proto_out=$resolvedOutputDir $protoFiles
+	$exitCode = $LASTEXITCODE
+	Pop-Location
+
+	if ($exitCode -ne 0) { exit $exitCode }
+}
+
+if (Test-Path $tempProtoDir) { Remove-Item -Path $tempProtoDir -Recurse -Force }
+
+# --- Step 3: Append protobufName exports (mirrors protobuf-gen.sh) ---
+
+Write-Host '[Protobuf Gen] Adding protobuf names...'
+
+Get-ChildItem $resolvedOutputDir -Filter *.ts | ForEach-Object {
+	$protoName = [System.IO.Path]::GetFileNameWithoutExtension($_.Name)
+	$content = Get-Content $_.FullName | Where-Object { $_ -notmatch '^export const protobufName = ' }
+	$line = ('export const protobufName = ''{0}'';' -f $protoName)
+	Set-Content -Path $_.FullName -Value ($content + $line)
+}
+
+Write-Host '[Protobuf Gen] BUILD SUCCESSFUL'

package/scripts/browser-decoder-fixtures.html

@@ -0,0 +1,54 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>Browser Decoder Fixtures</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style>
+      body {
+        margin: 0;
+        padding: 24px;
+        font-family: ui-monospace, SFMono-Regular, Menlo, monospace;
+        background: #101418;
+        color: #e8eef5;
+      }
+
+      h1 {
+        margin: 0 0 12px;
+        font-size: 20px;
+      }
+
+      p {
+        margin: 0 0 16px;
+        color: #b9c4d0;
+      }
+
+      pre {
+        margin: 0;
+        padding: 16px;
+        border-radius: 12px;
+        background: #18202a;
+        overflow: auto;
+      }
+
+      body[data-status="passed"] pre {
+        outline: 1px solid #2f9e44;
+      }
+
+      body[data-status="failed"] pre {
+        outline: 1px solid #e03131;
+      }
+    </style>
+  </head>
+  <body data-status="running">
+    <h1>Browser Decoder Fixtures</h1>
+    <p>
+      Run <code>npm run fixtures:browser:build -w @luxonis/depthai-viewer-common</code> first,
+      then serve this file over http (not <code>file://</code> — the worker and codec paths
+      need a secure origin). <code>npm run fixtures:browser</code> does both and reports the
+      result headlessly.
+    </p>
+    <pre id="results">Running...</pre>
+    <script type="module" src="./dist/browser-decoder-fixtures-entry.js"></script>
+  </body>
+</html>

package/scripts/fixtures.vite.config.mjs

@@ -0,0 +1,30 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { defineConfig } from 'vite';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+/**
+ * Bundles the browser decode fixtures into a self-contained script.
+ *
+ * `packages/common` deliberately ships unbundled ESM with bare specifiers, which consumer
+ * bundlers resolve. A plain browser cannot, so the standalone fixtures page needs its own
+ * bundle. This mirrors what a real consumer's bundler does to the same sources.
+ */
+export default defineConfig({
+	root: __dirname,
+	// Relative base so the emitted worker URLs resolve next to the HTML rather than at
+	// the server root, which lets the page be served from any prefix.
+	base: './',
+	build: {
+		outDir: path.join(__dirname, 'dist'),
+		emptyOutDir: true,
+		target: 'esnext',
+		rollupOptions: {
+			input: path.join(__dirname, '../src/visualizer/browser-decoder-fixtures-entry.ts'),
+			output: {
+				entryFileNames: 'browser-decoder-fixtures-entry.js',
+			},
+		},
+	},
+});

package/scripts/run-decoder-fixtures.mjs

@@ -0,0 +1,45 @@
+// Node-side decode compatibility harness for the visualizer subtree.
+//
+// These fixtures cover the browser-independent decode paths only. Anything that depends
+// on Worker, VideoDecoder, canvas or WebGPU must be validated in a real browser via
+// scripts/browser-decoder-fixtures.html — a pass here is not sufficient to clear the
+// encoded H.264/H.265 paths.
+//
+// Runs against the built output, so `npm run build -w @luxonis/depthai-viewer-common`
+// must have completed first.
+
+import path from "node:path";
+import process from "node:process";
+import { fileURLToPath } from "node:url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const fixturesModule = path.join(__dirname, "../dist/visualizer/messaging/decoder-fixtures.js");
+
+const formatError = (error) => {
+	if (error instanceof Error) {
+		return error.stack ?? error.message;
+	}
+
+	return String(error);
+};
+
+try {
+	const { runBuiltInDecoderFixtures } = await import(fixturesModule);
+	const results = await runBuiltInDecoderFixtures();
+	console.log(JSON.stringify(results, null, 2));
+
+	const failures = Array.isArray(results)
+		? results.filter((result) => result?.passed === false)
+		: [];
+	if (failures.length > 0) {
+		console.error(`\n${failures.length} decoder fixture(s) failed.`);
+		process.exitCode = 1;
+	}
+} catch (error) {
+	console.error(formatError(error));
+	console.error(
+		`\nCould not load ${path.relative(process.cwd(), fixturesModule)}. ` +
+			"Build the package first: npm run build -w @luxonis/depthai-viewer-common",
+	);
+	process.exitCode = 1;
+}