ggaction 0.0.13 → 0.0.16

package/src/selectors/markOwners.js

@@ -0,0 +1,46 @@
+import { findLayer } from "./layers.js";
+
+export function ownedChildren(program, id) {
+  const config = program.markConfigs[id] ?? {};
+  return [
+    config.errorBar?.lowerCapId,
+    config.errorBar?.upperCapId,
+    config.errorBand?.lowerBoundaryId,
+    config.errorBand?.upperBoundaryId,
+    config.regression?.bandId,
+    config.regression?.lineId,
+    config.boxPlot?.whiskerId,
+    config.boxPlot?.medianId,
+    config.boxPlot?.outlierId,
+    config.gradientPlot?.centerId,
+    config.intervalPlot?.intervalId,
+    config.endpointPlot?.roles?.stemId,
+    config.endpointPlot?.roles?.startId,
+    config.endpointPlot?.roles?.connectorId,
+    ...(config.raincloudPlot?.ownedChildIds ?? [])
+  ].concat(
+    program.semanticSpec.layers
+      .filter(layer => layer.source === id)
+      .map(layer => layer.id)
+  ).concat(
+    program.semanticSpec.layers
+      .filter(layer =>
+        program.markConfigs[layer.id]?.statisticalReference?.source === id
+      )
+      .map(layer => layer.id)
+  ).filter(child => child !== undefined && child !== id && findLayer(program, child) !== undefined);
+}
+
+export function ownership(program) {
+  const ownerByChild = new Map();
+  for (const layer of program.semanticSpec.layers) {
+    for (const child of ownedChildren(program, layer.id)) {
+      if (program.markConfigs[child]?.statisticalReference !== undefined) {
+        continue;
+      }
+      ownerByChild.set(child, layer.id);
+    }
+  }
+  return ownerByChild;
+}
+

package/src/selectors/scales.js

@@ -1,21 +1,23 @@
+import { annotateError } from "../core/diagnostics.js";
+
 export function findSemanticScale(program, id) {
   return program.semanticSpec.scales.find(scale => scale.id === id);
 }
 
 export function requireSemanticScale(program, id) {
   const scale = findSemanticScale(program, id);
-  if (scale === undefined) throw new Error(`Unknown scale "${id}".`);
+  if (scale === undefined) throw annotateError(new Error(`Unknown scale "${id}".`), { code: "missing-resource", resourceId: id });
   return scale;
 }
 
 export function requireResolvedScale(program, id, type) {
-  const scale = program.resolvedScales[id];
+  const scale = Object.hasOwn(program.resolvedScales, id) ? program.resolvedScales[id] : undefined;
   if (scale === undefined || (type !== undefined && scale.type !== type)) {
-    throw new Error(
+    throw annotateError(new Error(
       type === undefined
         ? `Unknown resolved scale "${id}".`
         : `Expected resolved ${type} scale "${id}".`
-    );
+    ), { code: scale === undefined ? "missing-resource" : "incompatible-resource", resourceId: id });
   }
   return scale;
 }

package/src/theme/defaults.js

@@ -1,4 +1,5 @@
-export const DEFAULT_FONT_FAMILY = "sans-serif";
+import { DEFAULT_FONT_FAMILY } from "../core/font.js";
+export { DEFAULT_FONT_FAMILY };
 
 export const DEFAULT_POINT_RADIUS = 3;
 
@@ -23,6 +24,56 @@ export const DEFAULT_COLORS = Object.freeze({
 
 export const THEME_NAMES = Object.freeze(["light", "dark"]);
 
+export const THEME_TOKEN_KEYS = Object.freeze([
+  "background",
+  "mark",
+  "text",
+  "strongText",
+  "mutedText",
+  "axis",
+  "axisTitle",
+  "grid",
+  "border",
+  "sizeSymbol",
+  "regressionBand",
+  "boxLine",
+  "boxMedian",
+  "referenceLine",
+  "referenceBand",
+  "gradientCenter",
+  "highlight",
+  "fontFamily"
+]);
+
+const THEME_DEFINITION_KEYS = Object.freeze(["base", "tokens"]);
+
+function isPlainObject(value) {
+  if (value === null || typeof value !== "object" || Array.isArray(value)) {
+    return false;
+  }
+  const prototype = Object.getPrototypeOf(value);
+  return prototype === Object.prototype || prototype === null;
+}
+
+function own(value) {
+  return Object.freeze({ ...value });
+}
+
+function validateKeys(value, allowed, label) {
+  const supported = new Set(allowed);
+  const unknown = Object.keys(value).find(key => !supported.has(key));
+  if (unknown !== undefined) {
+    throw new Error(`Unknown ${label} option "${unknown}".`);
+  }
+}
+
+function validateNonEmptyString(value, label) {
+  if (typeof value !== "string" || value.length === 0) {
+    throw new TypeError(`${label} must be a non-empty string.`);
+  }
+  return value;
+}
+
 export const THEME_TOKENS = Object.freeze({
   light: Object.freeze({
     background: "white",
@@ -54,3 +105,54 @@ export const THEME_TOKENS = Object.freeze({
 export function themeTokens(name = "light") {
   return THEME_TOKENS[name];
 }
+
+function validateThemeName(value, label) {
+  if (!THEME_NAMES.includes(value)) {
+    throw new Error(`Unsupported ${label} "${value}".`);
+  }
+  return value;
+}
+
+function normalizeThemeTokens(tokens) {
+  if (!isPlainObject(tokens)) {
+    throw new TypeError("applyTheme theme.tokens must be a plain object.");
+  }
+  validateKeys(tokens, THEME_TOKEN_KEYS, "applyTheme theme.tokens");
+  const normalized = {};
+  for (const [key, value] of Object.entries(tokens)) {
+    validateNonEmptyString(value, `applyTheme theme.tokens.${key}`);
+    normalized[key] = value;
+  }
+  return own(normalized);
+}
+
+export function normalizeThemeDefinition(definition) {
+  if (typeof definition === "string") {
+    return own({
+      name: validateThemeName(definition, "theme"),
+      tokens: own({})
+    });
+  }
+  if (!isPlainObject(definition)) {
+    throw new TypeError(
+      "applyTheme theme must be a built-in name or a plain { base, tokens } object."
+    );
+  }
+  validateKeys(definition, THEME_DEFINITION_KEYS, "applyTheme theme");
+  if (!Object.hasOwn(definition, "base") ||
+      !Object.hasOwn(definition, "tokens")) {
+    throw new Error("applyTheme custom theme requires base and tokens.");
+  }
+  return own({
+    name: validateThemeName(definition.base, "theme base"),
+    tokens: normalizeThemeTokens(definition.tokens)
+  });
+}
+
+export function resolveThemeTokens(definition = "light") {
+  const normalized = normalizeThemeDefinition(definition);
+  return own({
+    ...THEME_TOKENS[normalized.name],
+    ...normalized.tokens
+  });
+}

package/src/version.js

@@ -0,0 +1,2 @@
+// Must match package.json; enforced by the snapshot producer-version test.
+export const packageVersion = "0.0.16";

package/types/accessibility.d.ts

@@ -0,0 +1,37 @@
+import type { ChartProgram } from "./program.js";
+import type { BasicChartProgram } from "./basic.js";
+
+export interface AccessibleColumn {
+  readonly key: string;
+  readonly role: string;
+  readonly component: string;
+  readonly field?: string;
+  readonly aggregate?: string;
+  readonly unit?: "utc-milliseconds";
+}
+export interface AccessibleRow {
+  readonly component: string;
+  readonly series: Readonly<Record<string, unknown>>;
+  readonly values: Readonly<Record<string, unknown>>;
+}
+export interface AccessibleOwnerView {
+  readonly ownerId: string;
+  readonly markType: string;
+  readonly columns: readonly AccessibleColumn[];
+  readonly rows: readonly AccessibleRow[];
+  readonly units: Readonly<Record<string, "utc-milliseconds">>;
+}
+export interface AccessibleChildView {
+  readonly ownerId: string;
+  readonly kind: "composition-child";
+  readonly title: string | null;
+  readonly facet?: Readonly<Record<string, unknown>>;
+  readonly views: readonly AccessibleView[];
+}
+export type AccessibleView = AccessibleOwnerView | AccessibleChildView;
+export interface AccessibleData {
+  readonly schemaVersion: 1;
+  readonly title: string | null;
+  readonly views: readonly AccessibleView[];
+}
+export function exportAccessibleData(program: ChartProgram | BasicChartProgram, options?: { readonly target?: string }): AccessibleData;

package/types/basic.d.ts

@@ -1,4 +1,4 @@
-import type { ChartProgram, BasicSeriesLayoutOptions } from "./program.js";
+import type { ChartProgram, BasicSeriesLayoutOptions, CreateDataOptions } from "./program.js";
 
 export type {
   AxisLabelOptions,
@@ -6,6 +6,8 @@ export type {
   AxisTickOptions,
   AxisTicksAndLabelsOptions,
   AxisTitleOptions,
+  DisplayLabelMap,
+  DisplayLabelOptions,
   ApplyThemeOptions,
   BarWidthOptions,
   BasicSeriesLayoutOptions,
@@ -15,6 +17,7 @@ export type {
   CompleteAxisOptions,
   CreateAxesOptions,
   CreateBarPlotOptions,
+  CreateDataOptions,
   CreateGridOptions,
   CreateGuidesOptions,
   CreateHeatmapOptions,
@@ -29,12 +32,16 @@ export type {
   LegendOptions,
   PositionEncodingOptions,
   RectMarkOptions,
+  RectStyleDetails,
   ScaleOptions,
   SecondaryPositionEncodingOptions,
   SemanticSpec,
   StrokeDashEncodingOptions,
+  StrokeStyleDetails,
   TemporalInputUnit,
+  ThemeDefinition,
   ThemeName,
+  ThemeTokens,
   TraceNode,
   XAxisPosition,
   XOffsetEncodingOptions,
@@ -105,7 +112,8 @@ type RebindMethod<T> = T extends (...args: infer Args) => ChartProgram
 
 export type BasicChartProgram =
   Pick<ChartProgram, BasicStateKey> &
-  { readonly [Key in BasicMethodKey]: RebindMethod<ChartProgram[Key]> } &
+  { readonly [Key in Exclude<BasicMethodKey, "createData">]: RebindMethod<ChartProgram[Key]> } &
+  { createData<Row extends object>(options: CreateDataOptions<Row>): BasicChartProgram } &
   { readonly layoutSeries: (options: BasicSeriesLayoutOptions) => BasicChartProgram };
 
 export function chart(): BasicChartProgram;

package/types/diagnostics.d.ts

@@ -0,0 +1,15 @@
+export type ErrorCode = "invalid-option" | "invalid-value" | "missing-resource" |
+  "ambiguous-resource" | "incompatible-resource" | "resource-in-use" |
+  "resource-limit" | "unsupported-format" | "action-failed";
+
+export interface ErrorDetails {
+  readonly code: ErrorCode;
+  readonly operation?: string;
+  readonly optionPath?: string;
+  readonly resourceId?: string;
+  readonly candidates?: readonly string[];
+  readonly limit?: number;
+  readonly actual?: number;
+}
+
+export function getErrorDetails(error: unknown): ErrorDetails | undefined;

package/types/index.d.ts

@@ -1,6 +1,11 @@
 import type { ChartProgram, CompositionOptions } from "./program.js";
 
 export type {
+  TextMetricFontWeight,
+  TextMeasurement,
+  TextMetricsProfile,
+  ApplyTextMetricsOptions,
+  ReviseDataOptions,
   ActionOptions,
   AxisFormat,
   AxisFormatString,
@@ -18,6 +23,8 @@ export type {
   AxisTickStyleOptions,
   AxisTitleOptions,
   AxisValue,
+  DisplayLabelMap,
+  DisplayLabelOptions,
   BarWidthOptions,
   BoxPlotOptions,
   BinnedHeatmapColorOptions,
@@ -30,6 +37,7 @@ export type {
   BinDataOptions,
   BinDataOutputFields,
   BindMarkDataOptions,
+  RemoveResourceOptions,
   CanvasOptions,
   FitCanvasOptions,
   FoldDataOptions,
@@ -41,20 +49,37 @@ export type {
   ColorLayout,
   SeriesLayoutOptions,
   BasicSeriesLayoutOptions,
+  StrokeStyleDetails,
+  RectStyleDetails,
   CreateAreaPlotOptions,
   AreaPlotIndependentChannel,
   AreaPlotMeasureChannel,
   ColorEncodingOptions,
+  StrokeEncodingOptions,
+  EncodeChannelsOptions,
+  EncodingChannelAssignments,
+  SizeEncodingOptions,
+  ShapeEncodingOptions,
+  AngleEncodingOptions,
   CompleteAxisOptions,
   ConcatCompositionSpec,
   CompositionAlign,
   CompositionOptions,
   EditFacetSourceOptions,
+  FacetHeaderRole,
+  FacetHeaderSide,
+  FacetHeaderAlign,
   CompositionPadding,
   CompositionProgramEntry,
   CompositionSpec,
   ComputedDataOptions,
   ComputedExpression,
+  CompleteDataOptions,
+  ImputedDataOptions,
+  NormalizedDataOptions,
+  NormalizeBaseline,
+  NormalizeMethod,
+  NormalizeZeroDenominator,
   ChartProgram,
   ConcretePathCommand,
   CurveInterpolation,
@@ -75,10 +100,20 @@ export type {
   CreateThetaAxisTicksOptions,
   CreateRadialAxisTicksOptions,
   CreateThetaAxisLabelsOptions,
+  ThetaAxisLabelOptions,
+  ThetaTicksAndLabelsOptions,
+  CompleteThetaAxisOptions,
+  EditThetaAxisOptions,
   CreateRadialAxisLabelsOptions,
   CreateThetaAxisTitleOptions,
   CreateRadialAxisTitleOptions,
   CreateCoordinateOptions,
+  CoordinateAspect,
+  CoordinateAspectAlign,
+  PolarFrameCenter,
+  PolarFrameRadius,
+  PolarFrameOptions,
+  EditCoordinateOptions,
   CreateGuidesOptions,
   CreateGridOptions,
   CreateBarPlotOptions,
@@ -155,6 +190,9 @@ export type {
   ECDFOutputFields,
   ECDFDataOptions,
   DatasetComputedTransform,
+  DatasetCompleteTransform,
+  DatasetImputedTransform,
+  DatasetNormalizedTransform,
   DatasetHorizonTransform,
   DensityPlacement,
   BaselineDensityPlacement,
@@ -173,12 +211,33 @@ export type {
   DatasetWindowOperation,
   DatasetWindowSort,
   DatasetWindowTransform,
+  DurationWindowFrame,
+  DurationWindowUnit,
   DatasetRegressionTransform,
   DatasetScalar,
+  StatisticalWeight,
   DatasetStackTransform,
   DatasetTransform,
+  RequestedDatasetTransform,
+  DerivedDataDependents,
+  EditDerivedDataOptions,
   EditGraphicsOptions,
   EditBin2DDataOptions,
+  EditComputedDataOptions,
+  EditFilteredDataOptions,
+  EditFoldDataOptions,
+  EditSummaryDataOptions,
+  EditBinDataOptions,
+  EditTimeUnitDataOptions,
+  EditWindowDataOptions,
+  EditDensityDataOptions,
+  EditStackDataOptions,
+  EditRegressionDataOptions,
+  EditIntervalDataOptions,
+  EditECDFDataOptions,
+  EditNormalizedDataOptions,
+  EditCompleteDataOptions,
+  EditImputedDataOptions,
   EditHorizonOptions,
   EditCompositionLayoutOptions,
   EditFacetHeadersOptions,
@@ -198,6 +257,18 @@ export type {
   EditLegendSymbolsOptions,
   EditLegendTitleOptions,
   EditScaleOptions,
+  EditXScaleOptions,
+  EditYScaleOptions,
+  EditParallelScaleOptions,
+  EditThetaScaleOptions,
+  EditRScaleOptions,
+  EditColorScaleOptions,
+  EditStrokeScaleOptions,
+  EditSizeScaleOptions,
+  EditOpacityScaleOptions,
+  EditShapeScaleOptions,
+  EditStrokeWidthScaleOptions,
+  EditStrokeDashScaleOptions,
   EditSemanticOptions,
   FieldType,
   FillPaint,
@@ -249,6 +320,10 @@ export type {
   LabelLayoutOptions,
   LabelLeaderOptions,
   LegendOptions,
+  LegendChannel,
+  LegendBlockTextPatch,
+  LegendBlockSymbolPatch,
+  EditLegendBlockOptions,
   EditLegendOptions,
   ContinuousColorInterpolation,
   ContinuousColorScaleOptions,
@@ -256,6 +331,9 @@ export type {
   OpacityScaleOptions,
   OrderCategoriesOptions,
   OffsetScaleOptions,
+  OffsetScaleEditPatch,
+  EditXOffsetScaleOptions,
+  EditYOffsetScaleOptions,
   PathOrderEncodingOptions,
   ParallelCoordinatesEncodingOptions,
   ParallelDimension,
@@ -317,8 +395,11 @@ export type {
   ThetaScaleOptions,
   TimeUnit,
   TimeUnitDataOptions,
+  RowWindowFrame,
   TemporalInputUnit,
+  ThemeDefinition,
   ThemeName,
+  ThemeTokens,
   ApplyThemeOptions,
   TraceNode,
   TitleOptions,
@@ -330,12 +411,21 @@ export type {
   TextMarkOptions,
   DatumPositionEncodingOptions,
   CreateMarkLabelsOptions,
+  EditMarkLabelPlacementOptions,
+  EditMarkLabelSelectionOptions,
+  MarkLabelAnchor,
+  MarkLabelPlacement,
+  MarkLabelPlacementLeaderOptions,
+  MarkLabelSelectionOptions,
+  RemoveMarkLabelsOptions,
   CreateAnnotationOptions,
+  ReferenceStatistic,
   CreateReferenceLineOptions,
   CreateReferenceBandOptions,
   XAxisPosition,
   YAxisPosition,
   WindowDataOptions,
+  WindowFrame,
   WindowOperation,
   WindowSort,
   WindowSortOrder,

package/types/pdf.d.ts

@@ -24,3 +24,12 @@ export function renderToPDF(
   program: Pick<ChartProgram, "graphicSpec">,
   options: PDFRenderOptions
 ): Promise<PDFRenderResult>;
+
+export interface PDFBufferResult extends Omit<PDFRenderResult, "output"> {
+  readonly buffer: Uint8Array;
+}
+
+export function renderToPDFBuffer(
+  program: Pick<ChartProgram, "graphicSpec">,
+  options?: { metadata?: PDFMetadata }
+): Promise<PDFBufferResult>;

package/types/persistence.d.ts

@@ -0,0 +1,7 @@
+import type { ChartProgram } from "./program.js";
+import type { BasicChartProgram } from "./basic.js";
+
+export function serializeProgram(program: ChartProgram | BasicChartProgram): string;
+export function deserializeProgram(text: string): ChartProgram;
+export function serializeGraphic(program: Pick<ChartProgram, "graphicSpec">): string;
+export function deserializeGraphic(text: string): Readonly<Pick<ChartProgram, "graphicSpec">>;

package/types/png.d.ts

@@ -12,3 +12,12 @@ export function renderToPNG(
   program: Pick<ChartProgram, "graphicSpec">,
   options: { output: string; pixelRatio?: number }
 ): Promise<PNGRenderResult>;
+
+export interface PNGBufferResult extends Omit<PNGRenderResult, "output"> {
+  readonly buffer: Uint8Array;
+}
+
+export function renderToPNGBuffer(
+  program: Pick<ChartProgram, "graphicSpec">,
+  options?: { pixelRatio?: number }
+): Promise<PNGBufferResult>;