@orangelogic/design-system 2.114.0 → 2.115.0

package/library/packages/utils/src/image/waveform.d.ts

@@ -0,0 +1,29 @@
+export interface WaveformExtractionOptions {
+    /** Target number of sample columns. Defaults to the image's natural pixel width for maximum detail. */
+    sampleCount?: number;
+    /** Luminance threshold 0–1 for non-white detection. Default: 0.92. */
+    threshold?: number;
+}
+export interface WaveformData {
+    height: number;
+    /** Normalized 0–1 amplitudes, length === sampleCount. */
+    peaks: number[];
+    width: number;
+}
+/**
+ * Loads an image from `url`, draws it onto an offscreen canvas, and samples
+ * `sampleCount` columns to extract the visible waveform amplitude.
+ * When `sampleCount` is omitted the image's natural pixel width is used, giving
+ * one sample per source column for maximum fidelity.
+ *
+ * Returns `null` on any error (network, CORS, canvas SecurityError, etc.).
+ */
+export declare function extractWaveformPeaks(url: string, options?: WaveformExtractionOptions): Promise<WaveformData | null>;
+/**
+ * Builds a filled, vertically mirrored SVG path string representing a waveform.
+ * Each sample is rendered as a flat-topped bar (step-function) so the output
+ * matches server-rendered bar-style waveform images without diagonal interpolation.
+ *
+ * Returns an empty string when `peaks` is empty.
+ */
+export declare function buildWaveformPath(peaks: number[], viewBoxWidth: number, viewBoxHeight: number): string;