goro-charts 1.0.0 → 1.3.0

package/dist/index.d.ts

@@ -9,5 +9,5 @@ export { LineChart } from './charts/line-chart.js';
 export { AreaChart } from './charts/area-chart.js';
 export { ScatterChart } from './charts/scatter-chart.js';
 export { DARK, LIGHT } from './presets.js';
-export type { ChartOpts, SeriesConfig } from './types.js';
+export type { ChartOpts, SeriesConfig, DataOwnership } from './types.js';
 export type { SeriesHit } from './render/crosshair.js';

package/dist/types.d.ts

@@ -7,6 +7,17 @@
  * contract the renderers depend on instead of the concrete data store — it
  * decouples `render/` from `data/` so either can change independently.
  */
+/**
+ * Data-array ownership for snapshot mode (`setData`).
+ *
+ * - `'copy'` (default): the store copies the caller's arrays into fresh buffers;
+ *   the caller may mutate the originals freely without affecting the chart.
+ * - `'borrowed'`: the store keeps the caller's arrays by reference — the caller
+ *   **must** treat them as immutable for as long as the chart holds them. The
+ *   arrays are read-only to the chart; mutating them externally leads to
+ *   undefined behaviour.
+ */
+export type DataOwnership = 'copy' | 'borrowed';
 /** Per-series visual configuration. */
 export interface SeriesConfig {
     /** Display name for legends and the crosshair tooltip. */
@@ -79,12 +90,14 @@ export interface ChartOpts {
     autoDraw?: boolean;
     /**
      * Fixed Y-axis lower bound. When set the grid domain is pinned to this
-     * value instead of auto-expanding from data. Pair with {@link yMax}.
+     * value instead of auto-expanding from data. `undefined` (default) = auto.
+     * Pair with {@link yMax}.
      */
     yMin?: number;
     /**
      * Fixed Y-axis upper bound. When set the grid domain is pinned to this
-     * value instead of auto-expanding from data. Pair with {@link yMin}.
+     * value instead of auto-expanding from data. `undefined` (default) = auto.
+     * Pair with {@link yMin}.
      */
     yMax?: number;
     /**
@@ -93,8 +106,14 @@ export interface ChartOpts {
      */
     maxDots?: number;
 }
-/** Fully-resolved options (every field present). */
-export type ResolvedOpts = Required<ChartOpts>;
+/** Fully-resolved options (every field present).
+ *
+ * `yMin` and `yMax` are `number | undefined` because `undefined` is the
+ * sentinel for "auto" domain — `0` is a legitimate fixed bound. */
+export type ResolvedOpts = Required<Omit<ChartOpts, 'yMin' | 'yMax'>> & {
+    yMin: number | undefined;
+    yMax: number | undefined;
+};
 /** Plot area rectangle in CSS pixels, padding already applied. */
 export interface PlotRect {
     /** Left edge (x of the plot origin). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "goro-charts",
-  "version": "1.0.0",
+  "version": "1.3.0",
   "description": "Minimal high-performance line and area chart engine. Canvas 2D, zero dependencies, framework-agnostic.",
   "type": "module",
   "license": "MIT",
@@ -55,6 +55,7 @@
     "preview:demo": "vite preview --config vite.demo.config.ts",
     "prepublishOnly": "npm run build",
     "fix:all": "eslint --fix . && prettier --write .",
+    "check:readme": "node scripts/check-readme.mjs",
     "test": "vitest run",
     "test:watch": "vitest",
     "test:ui": "vitest --ui",