svelteplot 0.10.3 → 0.11.0-pr-514.0

package/dist/types/scale.d.ts

@@ -1,7 +1,7 @@
-import type { ScaleBand, ScaleLinear, ScaleOrdinal } from 'd3-scale';
-import type { ChannelAccessor, RawValue, ScaledChannelName } from './index.js';
+import type { ChannelAccessor, ColorScheme, RawValue, ScaledChannelName } from './index.js';
 export type AxisXAnchor = 'bottom' | 'top' | 'both';
 export type AxisYAnchor = 'left' | 'right' | 'both';
+export type TickFormatFunction = (d: RawValue, index: number, ticks: RawValue[]) => string | string[];
 export type ScaleName = 'x' | 'y' | 'r' | 'color' | 'opacity' | 'length' | 'symbol' | 'fx' | 'fy' | 'projection';
 export type ScaleOptions = {
     /**
@@ -21,8 +21,18 @@ export type ScaleOptions = {
      * Reverse the scale.
      */
     reverse: boolean;
+    /**
+     * the axis label for this scale, or false to disable the automatic label
+     */
     label: string | false;
+    /**
+     * the interval for ordinal/temporal scales, e.g. 'day', 'month', or a numeric step
+     */
     interval: string | number;
+    /**
+     * clamp values outside the domain to the nearest domain boundary
+     * (applicable to quantitative scales only)
+     */
     clamp: boolean;
     /**
      * Extend the domain to nice round numbers (applicable to quantitative scales only)
@@ -32,8 +42,18 @@ export type ScaleOptions = {
      * Include zero in the scale domain (applicable to quantitative scales only)
      */
     zero: boolean;
+    /**
+     * round interpolated values to integers (applicable to quantitative scales only)
+     */
     round: boolean;
+    /**
+     * format values as percentages and append (%) to the axis label
+     * (applicable to quantitative scales only)
+     */
     percent: boolean;
+    /**
+     * custom transformation function applied to values before scaling
+     */
     transform?: (d: RawValue) => RawValue;
     /**
      * set the padding for band scales
@@ -51,23 +71,62 @@ export type ScaleOptions = {
      * set the outer padding for band scales
      */
     paddingOuter: number;
+    /**
+     * reduce the scale range by this many pixels on the left side
+     */
     insetLeft: number;
+    /**
+     * reduce the scale range by this many pixels on the right side
+     */
     insetRight: number;
+    /**
+     * reduce the scale range by this many pixels on the top side
+     */
     insetTop: number;
+    /**
+     * reduce the scale range by this many pixels on the bottom side
+     */
     insetBottom: number;
-    ticks: (number | Date)[];
+    /**
+     * explicit tick values to use instead of automatic tick generation
+     */
+    ticks: RawValue[];
+    /**
+     * desired pixel distance between ticks for automatic tick generation
+     */
     tickSpacing: number;
+    /**
+     * the logarithm base for log scales (default 10)
+     */
     base: number;
+    /**
+     * controls domain ordering for band and point scales; can be a channel
+     * accessor, a comparator function, or an object with channel and order
+     */
     sort: ChannelAccessor | ((a: RawValue, b: RawValue) => number) | {
         channel: string;
         order: 'ascending' | 'descending';
     };
+    /**
+     * the constant parameter for symlog scales, controlling the transition
+     * between linear and logarithmic behavior near zero (default 1)
+     */
     constant: number;
 };
 export type ColorScaleOptions = ScaleOptions & {
+    /**
+     * if true, show a color legend for this scale
+     */
     legend: boolean;
+    /**
+     * the color scale type; extends the base scale types with color-specific
+     * types like categorical, sequential, diverging, etc.
+     */
     type: ScaleType | 'categorical' | 'sequential' | 'cyclical' | 'threshold' | 'quantile' | 'quantize' | 'diverging' | 'diverging-log' | 'diverging-pow' | 'diverging-sqrt' | 'diverging-symlog';
-    scheme: string;
+    /**
+     * the name of the color scheme to use, e.g. 'blues', 'turbo', 'rdylbu'
+     */
+    scheme: ColorScheme | string[];
     /**
      * fallback color used for null/undefined
      */
@@ -80,11 +139,14 @@ export type ColorScaleOptions = ScaleOptions & {
      * number of colors for quantize and quantile-threshold scales
      */
     n: number;
+    /**
+     * custom interpolation function for the color scale output
+     */
     interpolate: (d: any) => typeof d;
     /**
      * The tick format for the color scale legend.
      */
-    tickFormat: false | Intl.NumberFormatOptions | ((d: RawValue) => string);
+    tickFormat: false | Intl.NumberFormatOptions | TickFormatFunction;
 };
 export type ScaleType = 'linear' | 'pow' | 'sqrt' | 'log' | 'symlog' | 'time' | 'point' | 'ordinal' | 'sequential' | 'band' | 'categorical' | 'cyclical' | 'threshold' | 'quantile-cont' | 'quantile' | 'quantize' | 'diverging' | 'diverging-log' | 'diverging-pow' | 'diverging-sqrt' | 'diverging-symlog';
 export type XScaleOptions = ScaleOptions & {
@@ -104,8 +166,15 @@ export type XScaleOptions = ScaleOptions & {
      * rotate the axis ticks
      */
     tickRotate: number;
+    /**
+     * horizontal position of the axis label
+     */
     labelAnchor: 'auto' | 'left' | 'center' | 'right';
-    tickFormat: false | Intl.NumberFormatOptions | ((d: RawValue) => string);
+    /**
+     * custom tick format; false to hide tick labels, an Intl.NumberFormatOptions
+     * object, or a function mapping values to strings
+     */
+    tickFormat: 'auto' | false | Intl.NumberFormatOptions | Intl.DateTimeFormatOptions | TickFormatFunction;
     /**
      * Enable word wrapping for axis tick labels, default true
      */
@@ -128,20 +197,55 @@ export type YScaleOptions = ScaleOptions & {
      * add an explicit AxisY mark to your plot instead of using the implicit axes.
      */
     axis: AxisYAnchor | false;
-    tickFormat: false | Intl.NumberFormatOptions | ((d: RawValue) => string);
+    /**
+     * custom tick format; false to hide tick labels, an Intl.NumberFormatOptions
+     * object, or a function mapping values to strings
+     */
+    tickFormat: 'auto' | false | Intl.NumberFormatOptions | Intl.DateTimeFormatOptions | TickFormatFunction;
     /**
      * rotate the axis ticks
      */
     tickRotate: number;
+    /**
+     * vertical position of the axis label
+     */
     labelAnchor: 'auto' | 'bottom' | 'middle' | 'top';
 };
 export type LegendScaleOptions = ScaleOptions & {
+    /**
+     * if true, show a legend for this scale
+     */
     legend: boolean;
 };
+/**
+ * Broad callable shape for resolved d3 scale functions used internally by marks.
+ * Specific methods only exist for certain scale types and may be undefined.
+ */
+export type PlotScaleFunction = ((value: any) => any) & {
+    range: () => RawValue[];
+    invert: (value: number) => RawValue;
+    bandwidth: () => number;
+    ticks: (count: number) => RawValue[];
+    quantiles: () => number[];
+    thresholds: () => number[];
+    domain: () => RawValue[];
+};
 export type PlotScale = {
+    /**
+     * the resolved scale type
+     */
     type: ScaleType;
+    /**
+     * the resolved domain of the scale
+     */
     domain: RawValue[];
+    /**
+     * the resolved range of the scale
+     */
     range: RawValue[];
+    /**
+     * automatically computed axis label based on data channel names
+     */
     autoTitle?: string;
     /**
      * The number of marks that are using this scale.
@@ -151,7 +255,20 @@ export type PlotScale = {
      * Set of accessors used in channels that are bound to this scale.
      */
     uniqueScaleProps: Set<ChannelAccessor>;
+    /**
+     * tracks which marks should skip this scale for specific channels,
+     * e.g. when channel values are already in output space
+     */
     skip: Map<ScaledChannelName, Set<symbol>>;
-    fn: ScaleLinear<RawValue, number> & ScaleBand<RawValue[]> & ScaleOrdinal<string | Date, number> & ScaleOrdinal<string | Date, string>;
+    /**
+     * the underlying d3 scale function that maps domain values to range values.
+     * Typed as a broad callable since the actual type depends on the scale type
+     * (linear, band, ordinal, etc.) and may be augmented with custom methods.
+     */
+    fn: PlotScaleFunction;
+    /**
+     * whether this is a dummy scale (created when no scale was defined)
+     */
+    isDummy?: boolean;
 };
 export type PlotScales = Record<ScaleName, PlotScale>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "svelteplot",
-    "version": "0.10.3",
+    "version": "0.11.0-pr-514.0",
     "description": "A Svelte-native data visualization framework based on the layered grammar of graphics principles.",
     "keywords": [
         "svelte",
@@ -25,7 +25,6 @@
         "name": "Gregor Aisch",
         "email": "gka@users.noreply.github.com"
     },
-    "packageManager": "pnpm@10.0.0",
     "type": "module",
     "exports": {
         ".": {
@@ -66,10 +65,12 @@
         "docs:api:marks": "node scripts/generate-api.js --marks && prettier --write .",
         "docs:api:plot": "node scripts/generate-api.js --plot && prettier --write .",
         "docs:api:transforms": "node scripts/generate-api.js --transforms && prettier --write .",
-        "format": "prettier --write . && eslint --fix package.json",
-        "lint": "prettier --check src && eslint src package.json",
-        "lint:types": "tsc --noEmit",
-        "prepack": "npx svelte-package",
+        "format": "eslint --fix package.json && prettier --write .",
+        "lint": "pnpm run lint:oxlint && pnpm run lint:eslint && pnpm run lint:types",
+        "lint:eslint": "prettier --check src && eslint src package.json",
+        "lint:oxlint": "oxlint --type-aware",
+        "lint:types": "svelte-kit sync && tsc --noEmit -p tsconfig.lint-types.json",
+        "prepack": "npx svelte-package && node scripts/fix-js-imports.js dist",
         "preview": "vite preview",
         "release-next": "npm version prerelease --preid next && npm publish && git push && git push --tags && sleep 1 && npm dist-tag add svelteplot@$(npm view . version) next",
         "screenshots": "node screenshot-examples.js",
@@ -96,18 +97,15 @@
         "interval-tree-1d": "^1.0.4",
         "merge-deep": "^3.0.3"
     },
-    "peerDependencies": {
-        "svelte": "^5.43.0"
-    },
     "devDependencies": {
         "@aitodotai/json-stringify-pretty-compact": "^1.3.0",
         "@emotion/css": "^11.13.5",
-        "@shikijs/twoslash": "^3.21.0",
-        "@sveltejs/adapter-auto": "^7.0.0",
+        "@shikijs/twoslash": "^3.22.0",
+        "@sveltejs/adapter-auto": "^7.0.1",
         "@sveltejs/adapter-static": "^3.0.10",
-        "@sveltejs/enhanced-img": "^0.9.3",
-        "@sveltejs/eslint-config": "^8.3.4",
-        "@sveltejs/kit": "^2.50.1",
+        "@sveltejs/enhanced-img": "^0.10.2",
+        "@sveltejs/eslint-config": "^8.3.5",
+        "@sveltejs/kit": "^2.53.4",
         "@sveltejs/package": "^2.5.7",
         "@sveltejs/vite-plugin-svelte": "6.2.4",
         "@sveltepress/twoslash": "^1.3.6",
@@ -128,9 +126,9 @@
         "@types/geojson": "^7946.0.16",
         "@types/topojson": "^3.2.6",
         "@types/topojson-client": "^3.1.5",
-        "@typescript-eslint/eslint-plugin": "^8.54.0",
-        "@typescript-eslint/parser": "^8.54.0",
-        "@unocss/extractor-svelte": "^66.6.0",
+        "@typescript-eslint/eslint-plugin": "^8.56.1",
+        "@typescript-eslint/parser": "^8.56.1",
+        "@unocss/extractor-svelte": "^66.6.3",
         "@vite-pwa/sveltekit": "^1.1.0",
         "csstype": "^3.2.3",
         "d3-dsv": "^3.0.1",
@@ -138,45 +136,52 @@
         "d3-force": "^3.0.0",
         "eslint": "^9.39.2",
         "eslint-config-prettier": "^10.1.8",
-        "eslint-plugin-package-json": "^0.88.2",
+        "eslint-plugin-package-json": "^0.88.3",
         "eslint-plugin-regexp": "^2.10.0",
-        "eslint-plugin-svelte": "3.14.0",
+        "eslint-plugin-svelte": "3.15.0",
         "jqmath": "^0.4.9",
         "jsdom": "^27.4.0",
-        "log-update": "^7.0.2",
-        "lru-cache": "^11.2.5",
-        "mdast-util-from-markdown": "^2.0.2",
+        "log-update": "^7.1.0",
+        "lru-cache": "^11.2.6",
+        "magic-string": "^0.30.21",
+        "mdast-util-from-markdown": "^2.0.3",
         "mdast-util-gfm": "^3.1.0",
+        "oxlint": "^1.48.0",
+        "oxlint-tsgolint": "^0.14.0",
         "pixelmatch": "^7.1.0",
         "pngjs": "^7.0.0",
         "prettier": "^3.8.1",
-        "prettier-plugin-svelte": "^3.4.1",
-        "puppeteer": "^24.36.1",
+        "prettier-plugin-svelte": "^3.5.0",
+        "puppeteer": "^24.37.5",
         "remark-code-extra": "^1.0.1",
         "remark-code-frontmatter": "^1.0.0",
         "remark-math": "^6.0.0",
         "resize-observer-polyfill": "^1.5.1",
         "sass": "^1.97.3",
-        "shiki": "^3.21.0",
-        "svelte-check": "^4.3.5",
-        "svelte-eslint-parser": "1.4.1",
+        "shiki": "^3.22.0",
+        "svelte": "^5.53.5",
+        "svelte-check": "^4.4.1",
+        "svelte-eslint-parser": "1.5.1",
         "svelte-highlight": "^7.9.0",
-        "svelte": "5",
         "svg-path-parser": "^1.1.0",
         "temml": "^0.13.1",
         "topojson-client": "^3.1.0",
         "ts-essentials": "^10.1.1",
         "tslib": "^2.8.1",
-        "typedoc": "^0.28.16",
-        "typedoc-plugin-markdown": "^4.9.0",
+        "typedoc": "^0.28.17",
+        "typedoc-plugin-markdown": "^4.10.0",
         "typescript": "^5.9.3",
         "uid": "^2.0.2",
         "unist-util-visit": "^5.1.0",
-        "unocss": "^66.6.0",
+        "unocss": "^66.6.2",
         "vite": "^7.3.1",
         "vitest": "^4.0.18",
         "vitest-matchmedia-mock": "^2.0.3",
         "wx-svelte-grid": "^2.5.0",
         "yoctocolors": "^2.1.2"
-    }
+    },
+    "peerDependencies": {
+        "svelte": "^5.53.5"
+    },
+    "packageManager": "pnpm@10.30.3"
 }

package/dist/helpers/autoTicks.d.ts

@@ -1,12 +0,0 @@
-import type { RawValue, ScaleType } from '../types/index.js';
-type IntervalLike = {
-    floor: (d: number) => number;
-    round?: (d: number) => number;
-    offset: (d: number, step?: number) => number;
-    range: (lo: number, hi: number) => number[];
-};
-export declare function maybeInterval(interval: null | number | string | IntervalLike): any;
-export declare function autoTicks(type: ScaleType, ticks: RawValue[], interval: string | number | null, domain: RawValue[], scaleFn: {
-    ticks?: (count: number) => RawValue[];
-}, count: number): any;
-export {};