layerchart 2.0.0-next.5 → 2.0.0-next.51

package/dist/utils/array.test.js

@@ -0,0 +1,200 @@
+import { describe, it, expect } from 'vitest';
+import { applyLanes } from './array.js';
+describe('applyLanes', () => {
+    it('should assign same lane to non-overlapping events', () => {
+        const data = [
+            { id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-02') },
+            { id: 2, start: new Date('2023-01-03'), end: new Date('2023-01-05') },
+            { id: 3, start: new Date('2023-01-06'), end: new Date('2023-01-08') },
+        ];
+        const result = applyLanes(data);
+        expect(result).toEqual([
+            { id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-02'), lane: 0 },
+            { id: 2, start: new Date('2023-01-03'), end: new Date('2023-01-05'), lane: 0 },
+            { id: 3, start: new Date('2023-01-06'), end: new Date('2023-01-08'), lane: 0 },
+        ]);
+    });
+    it('should assign different lanes to overlapping events', () => {
+        const data = [
+            { id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-03') },
+            { id: 2, start: new Date('2023-01-02'), end: new Date('2023-01-04') },
+            { id: 3, start: new Date('2023-01-02T12:00:00'), end: new Date('2023-01-05') },
+        ];
+        const result = applyLanes(data);
+        expect(result).toEqual([
+            { id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-03'), lane: 0 },
+            { id: 2, start: new Date('2023-01-02'), end: new Date('2023-01-04'), lane: 1 },
+            { id: 3, start: new Date('2023-01-02T12:00:00'), end: new Date('2023-01-05'), lane: 2 },
+        ]);
+    });
+    it('should reuse lanes when events no longer overlap', () => {
+        const data = [
+            { id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-02') },
+            { id: 2, start: new Date('2023-01-01T12:00:00'), end: new Date('2023-01-03') },
+            { id: 3, start: new Date('2023-01-04'), end: new Date('2023-01-06') }, // starts after id: 1 ends
+            { id: 4, start: new Date('2023-01-05'), end: new Date('2023-01-07') }, // starts after id: 2 ends
+        ];
+        const result = applyLanes(data);
+        expect(result).toEqual([
+            { id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-02'), lane: 0 },
+            { id: 2, start: new Date('2023-01-01T12:00:00'), end: new Date('2023-01-03'), lane: 1 },
+            { id: 3, start: new Date('2023-01-04'), end: new Date('2023-01-06'), lane: 0 }, // reuses lane 0
+            { id: 4, start: new Date('2023-01-05'), end: new Date('2023-01-07'), lane: 1 }, // reuses lane 1
+        ]);
+    });
+    it('should handle events that start exactly when another ends', () => {
+        const data = [
+            { id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-02') },
+            { id: 2, start: new Date('2023-01-02'), end: new Date('2023-01-04') }, // starts exactly when id: 1 ends
+            { id: 3, start: new Date('2023-01-01T12:00:00'), end: new Date('2023-01-03') }, // overlaps with both
+        ];
+        const result = applyLanes(data);
+        expect(result).toEqual([
+            { id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-02'), lane: 0 },
+            { id: 2, start: new Date('2023-01-02'), end: new Date('2023-01-04'), lane: 0 }, // can reuse lane 0
+            { id: 3, start: new Date('2023-01-01T12:00:00'), end: new Date('2023-01-03'), lane: 1 }, // overlaps, needs new lane
+        ]);
+    });
+    it('should work with string keys for start and end', () => {
+        const data = [
+            { name: 'Task 1', startTime: new Date('2023-01-01'), endTime: new Date('2023-01-03') },
+            { name: 'Task 2', startTime: new Date('2023-01-02'), endTime: new Date('2023-01-04') },
+        ];
+        const result = applyLanes(data, { start: 'startTime', end: 'endTime' });
+        expect(result).toEqual([
+            {
+                name: 'Task 1',
+                startTime: new Date('2023-01-01'),
+                endTime: new Date('2023-01-03'),
+                lane: 0,
+            },
+            {
+                name: 'Task 2',
+                startTime: new Date('2023-01-02'),
+                endTime: new Date('2023-01-04'),
+                lane: 1,
+            },
+        ]);
+    });
+    it('should work with nested string keys for start and end', () => {
+        const data = [
+            { name: 'Task 1', duration: { start: new Date('2023-01-01'), end: new Date('2023-01-02') } },
+            { name: 'Task 2', duration: { start: new Date('2023-01-03'), end: new Date('2023-01-04') } },
+        ];
+        const result = applyLanes(data, { start: 'duration.start', end: 'duration.end' });
+        expect(result).toEqual([
+            {
+                name: 'Task 1',
+                duration: { start: new Date('2023-01-01'), end: new Date('2023-01-02') },
+                lane: 0,
+            },
+            {
+                name: 'Task 2',
+                duration: { start: new Date('2023-01-03'), end: new Date('2023-01-04') },
+                lane: 0,
+            },
+        ]);
+    });
+    it('should work with function accessors for start and end', () => {
+        const data = [
+            { name: 'Task 1', duration: { start: new Date('2023-01-01'), end: new Date('2023-01-02') } },
+            { name: 'Task 2', duration: { start: new Date('2023-01-03'), end: new Date('2023-01-04') } },
+        ];
+        const result = applyLanes(data, { start: (d) => d.duration.start, end: (d) => d.duration.end });
+        expect(result).toEqual([
+            {
+                name: 'Task 1',
+                duration: { start: new Date('2023-01-01'), end: new Date('2023-01-02') },
+                lane: 0,
+            },
+            {
+                name: 'Task 2',
+                duration: { start: new Date('2023-01-03'), end: new Date('2023-01-04') },
+                lane: 0,
+            },
+        ]);
+    });
+    it('should handle empty array', () => {
+        const data = [];
+        const result = applyLanes(data);
+        expect(result).toEqual([]);
+    });
+    it('should handle single event', () => {
+        const data = [{ id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-02') }];
+        const result = applyLanes(data);
+        expect(result).toEqual([
+            { id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-02'), lane: 0 },
+        ]);
+    });
+    it('should handle complex overlapping scenario', () => {
+        const data = [
+            { id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-05') }, // long event
+            { id: 2, start: new Date('2023-01-02'), end: new Date('2023-01-03') }, // short event inside
+            { id: 3, start: new Date('2023-01-02T12:00:00'), end: new Date('2023-01-04') }, // overlaps with both
+            { id: 4, start: new Date('2023-01-03'), end: new Date('2023-01-04T12:00:00') }, // overlaps with 1 and 3
+            { id: 5, start: new Date('2023-01-06'), end: new Date('2023-01-08') }, // separate event
+        ];
+        const result = applyLanes(data);
+        expect(result).toEqual([
+            { id: 1, start: new Date('2023-01-01'), end: new Date('2023-01-05'), lane: 0 },
+            { id: 2, start: new Date('2023-01-02'), end: new Date('2023-01-03'), lane: 1 },
+            { id: 3, start: new Date('2023-01-02T12:00:00'), end: new Date('2023-01-04'), lane: 2 },
+            { id: 4, start: new Date('2023-01-03'), end: new Date('2023-01-04T12:00:00'), lane: 1 }, // can reuse lane 1 since id: 2 ended
+            { id: 5, start: new Date('2023-01-06'), end: new Date('2023-01-08'), lane: 0 }, // can reuse lane 0 since id: 1 ended
+        ]);
+    });
+    it('should preserve all original properties', () => {
+        const data = [
+            {
+                id: 1,
+                start: new Date('2023-01-01'),
+                end: new Date('2023-01-02'),
+                name: 'First',
+                priority: 'high',
+                metadata: { foo: 'bar' },
+            },
+            {
+                id: 2,
+                start: new Date('2023-01-01T12:00:00'),
+                end: new Date('2023-01-03'),
+                name: 'Second',
+                priority: 'low',
+                metadata: { baz: 'qux' },
+            },
+        ];
+        const result = applyLanes(data);
+        expect(result).toEqual([
+            {
+                id: 1,
+                start: new Date('2023-01-01'),
+                end: new Date('2023-01-02'),
+                name: 'First',
+                priority: 'high',
+                metadata: { foo: 'bar' },
+                lane: 0,
+            },
+            {
+                id: 2,
+                start: new Date('2023-01-01T12:00:00'),
+                end: new Date('2023-01-03'),
+                name: 'Second',
+                priority: 'low',
+                metadata: { baz: 'qux' },
+                lane: 1,
+            },
+        ]);
+    });
+    it('should work with numeric values', () => {
+        const data = [
+            { id: 1, start: 0, end: 3 },
+            { id: 2, start: 1, end: 4 },
+            { id: 3, start: 5, end: 7 },
+        ];
+        const result = applyLanes(data);
+        expect(result).toEqual([
+            { id: 1, start: 0, end: 3, lane: 0 },
+            { id: 2, start: 1, end: 4, lane: 1 },
+            { id: 3, start: 5, end: 7, lane: 0 }, // can reuse lane 0 since id: 1 ended
+        ]);
+    });
+});

package/dist/utils/attributes.d.ts

@@ -1,14 +1,4 @@
-/**
- * Creates a string containing a class name that can be used by
- * developers to target a specific layer/element within a LayerChart.
- *
- * This is a function so that the class names remain consistent and the
- * prefix/structure can be changed in the future if needed
- *
- * @param layerName - the name of the layer to be appended to the generated class name
- * @returns a string to be used as a class on an element
- */
-export declare function layerClass(layerName: string): string;
+import type { ClassValue } from 'svelte/elements';
 type ExtractObjectType<T> = T extends object ? (T extends Function ? never : T) : never;
 type WithClass<T> = T & {
     class?: string;
@@ -21,9 +11,9 @@ type DefaultProps = WithClass<{
  * a class name to its class property to identify the layer for CSS targeting.
  *
  * @param props The props to be extracted, can be an object, function or any other type
- * @param layerName The name of the layer used to apply a layer classname for targeting styling
+ * @param className The class name to be applied to the layer for targeting styling (e.g. 'lc-layer')
  * @param extraClasses Additional classes to be applied to the layer if they don't exist in the props already
  * @returns a typed spreadable object with props for the layer
  */
-export declare function extractLayerProps<T>(props: T, layerName: string, extraClasses?: string): WithClass<ExtractObjectType<T> extends never ? DefaultProps : ExtractObjectType<T>>;
+export declare function extractLayerProps<T>(props: T, className: string, ...extraClasses: ClassValue[]): WithClass<ExtractObjectType<T> extends never ? DefaultProps : ExtractObjectType<T>>;
 export {};

package/dist/utils/attributes.js

@@ -1,17 +1,4 @@
 import { cls } from '@layerstack/tailwind';
-/**
- * Creates a string containing a class name that can be used by
- * developers to target a specific layer/element within a LayerChart.
- *
- * This is a function so that the class names remain consistent and the
- * prefix/structure can be changed in the future if needed
- *
- * @param layerName - the name of the layer to be appended to the generated class name
- * @returns a string to be used as a class on an element
- */
-export function layerClass(layerName) {
-    return `lc-${layerName}`;
-}
 // type guard to narrow props to an object with optional class
 // for extractLayerProps
 function isObjectWithClass(val) {
@@ -22,19 +9,18 @@ function isObjectWithClass(val) {
  * a class name to its class property to identify the layer for CSS targeting.
  *
  * @param props The props to be extracted, can be an object, function or any other type
- * @param layerName The name of the layer used to apply a layer classname for targeting styling
+ * @param className The class name to be applied to the layer for targeting styling (e.g. 'lc-layer')
  * @param extraClasses Additional classes to be applied to the layer if they don't exist in the props already
  * @returns a typed spreadable object with props for the layer
  */
-export function extractLayerProps(props, layerName, extraClasses) {
-    const className = layerClass(layerName);
+export function extractLayerProps(props, className, ...extraClasses) {
     if (isObjectWithClass(props)) {
         return {
             ...props,
-            class: cls(className, props.class ?? '', extraClasses),
+            class: cls(className, ...extraClasses, props.class),
         };
     }
     return {
-        class: cls(className, extraClasses),
+        class: cls(className, ...extraClasses),
     };
 }

package/dist/utils/canvas.d.ts

@@ -0,0 +1,83 @@
+import type { ClassValue } from 'svelte/elements';
+import type { PatternShape } from '../components/Pattern.svelte';
+/** @deprecated - use `isTransparentFill` instead */
+export declare const DEFAULT_FILL = "rgb(0, 0, 0)";
+type StyleOptions = Partial<Omit<CSSStyleDeclaration, 'fillOpacity' | 'strokeOpacity' | 'strokeWidth' | 'opacity'> & {
+    fillOpacity?: number | string;
+    strokeOpacity?: number | string;
+    strokeWidth?: number | string;
+    opacity?: number | string;
+}>;
+export type ComputedStylesOptions = {
+    styles?: StyleOptions;
+    classes?: ClassValue | null;
+    /** Inline style string (e.g., 'stroke-dasharray: 6 4') - will be parsed and merged with styles */
+    style?: string | null;
+};
+/**
+ * Appends or reuses `<svg>` element below `<canvas>` to resolve CSS variables and classes (ex. `stroke: var(--color-primary)` => `stroke: rgb(...)` )
+ */
+export declare function _getComputedStyles(canvas: HTMLCanvasElement, { styles, classes }?: ComputedStylesOptions): CSSStyleDeclaration;
+export declare const getComputedStyles: typeof _getComputedStyles;
+/** Render SVG path data onto canvas context.  Supports CSS variables and classes by tranferring to hidden `<svg>` element before retrieval) */
+export declare function renderPathData(ctx: CanvasRenderingContext2D, pathData: string | null | undefined, styleOptions?: ComputedStylesOptions): void;
+export declare function renderText(ctx: CanvasRenderingContext2D, text: string | number | null | undefined, coords: {
+    x: number;
+    y: number;
+}, styleOptions?: ComputedStylesOptions): void;
+export declare function renderRect(ctx: CanvasRenderingContext2D, coords: {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    rx?: number;
+    ry?: number;
+}, styleOptions?: ComputedStylesOptions): void;
+export declare function renderCircle(ctx: CanvasRenderingContext2D, coords: {
+    cx: number;
+    cy: number;
+    r: number;
+}, styleOptions?: ComputedStylesOptions): void;
+export declare function renderEllipse(ctx: CanvasRenderingContext2D, coords: {
+    cx: number;
+    cy: number;
+    rx: number;
+    ry: number;
+}, styleOptions?: ComputedStylesOptions): void;
+/** Clear canvas accounting for Canvas `context.translate(...)` */
+export declare function clearCanvasContext(ctx: CanvasRenderingContext2D, options: {
+    containerWidth: number;
+    containerHeight: number;
+    padding: {
+        top: number;
+        bottom: number;
+        left: number;
+        right: number;
+    };
+}): void;
+/**
+    Scales a canvas for high DPI / retina displays.
+  @see: https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio#examples
+  @see: https://web.dev/articles/canvas-hidipi
+*/
+export declare function scaleCanvas(ctx: CanvasRenderingContext2D, width: number, height: number): {
+    width: number;
+    height: number;
+};
+/** Get pixel color (r,g,b,a) at canvas coordinates */
+export declare function getPixelColor(ctx: CanvasRenderingContext2D, x: number, y: number): {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+};
+export declare function _createLinearGradient(ctx: CanvasRenderingContext2D, x0: number, y0: number, x1: number, y1: number, stops: {
+    offset: number;
+    color: string;
+}[]): CanvasGradient;
+/** Create linear gradient and memoize result to fix reactivity */
+export declare const createLinearGradient: typeof _createLinearGradient;
+export declare function _createPattern(ctx: CanvasRenderingContext2D, width: number, height: number, shapes: PatternShape[], background?: string): CanvasPattern | null;
+/** Create pattern and memoize result to fix reactivity */
+export declare const createPattern: typeof _createPattern;
+export {};