Module analyticsExperimental

@honua/sdk-js/analytics — the versioned linked-analytics and chart presentation contract.

Honua does not ship a chart suite. This entrypoint is the seam that lets a server-pushdown widget model, a bounded columnar reduction, a small accessible default presentation, and any specialist chart library share one filter / selection / temporal / capability / provenance model.

The barrel intentionally exports no chart adapters. Third-party adapters live behind their own subpath (@honua/sdk-js/analytics/uplot) and load their peer through a dynamic import, so an app that never charts pays nothing — which the /analytics bundle guard asserts structurally.

Example

import { createWidgetSource } from "@honua/sdk-js/contract";
import {
  acceptWidgetTimeSeriesArtifact,
  createAnalyticsAdapterRegistry,
  createAnalyticsLinkedSession,
  createDefaultAnalyticsPresentation,
} from "@honua/sdk-js/analytics";

const widgets = createWidgetSource(source);
const response = await widgets.timeSeries({ field: "reported_at", interval: { unit: "day" } });
const artifact = acceptWidgetTimeSeriesArtifact(response, { artifactId: "incidents-by-day" });

const registry = createAnalyticsAdapterRegistry({
  adapters: [createDefaultAnalyticsPresentation()],
});
const session = createAnalyticsLinkedSession({ view, artifact, registry });
await session.present({ target: panel });

Not yet covered by the SDK's semver contract — these shapes may change in any minor release prior to 1.0.0.

Index

Classes

HonuaAnalyticsError

Interfaces

AcceptAnalyticsOptions AcceptWidgetArtifactOptions AnalyticsAdapterRegistry AnalyticsAggregateArtifact AnalyticsAggregateMark AnalyticsArtifactIdentity AnalyticsBounds AnalyticsCategoryArtifact AnalyticsCategoryMark AnalyticsClearInteraction AnalyticsDegradation AnalyticsFilterClauseIds AnalyticsFilterContribution AnalyticsFreshnessState AnalyticsHistogramArtifact AnalyticsHistogramMark AnalyticsHoverInteraction AnalyticsIdentityInput AnalyticsLinkBindingOptions AnalyticsLinkCommit AnalyticsLinkedSession AnalyticsLinkedState AnalyticsLinkedStateBinding AnalyticsMarkBase AnalyticsMarkSelectInteraction AnalyticsMeasure AnalyticsMountRequest AnalyticsNumericRange AnalyticsOrdering AnalyticsPresentationAdapter AnalyticsPresentationHandle AnalyticsPresentationHost AnalyticsPresentationResolution AnalyticsPresentOptions AnalyticsProvenance AnalyticsProvenanceInput AnalyticsRangeBrushInteraction AnalyticsSessionPresentation AnalyticsTableModel AnalyticsTableRow AnalyticsTemporalBrushInteraction AnalyticsTemporalWindow AnalyticsTimeSeriesArtifact AnalyticsTimeSeriesMark AnalyticsUpdateDecision CreateAnalyticsAdapterRegistryOptions CreateAnalyticsLinkedSessionOptions DefaultAnalyticsPresentationOptions DisposableHandleSpec ResolveAnalyticsPresentationOptions

Type Aliases

AnalyticsArtifact AnalyticsArtifactKind AnalyticsArtifactStatus AnalyticsComputeSite AnalyticsContractVersion AnalyticsFreshness AnalyticsInteraction AnalyticsInteractionChannel AnalyticsMark AnalyticsNullPolicy AnalyticsOrderingKey AnalyticsSupportDecision AnalyticsUnsupportedReason AnalyticsUpdateDisposition HonuaAnalyticsErrorCode

Variables

ANALYTICS_CONTRACT_VERSION ANALYTICS_NULL_RENDERING DEFAULT_BUCKET_ORDERING DEFAULT_CATEGORY_ORDERING DEFAULT_TIME_ORDERING EMPTY_ANALYTICS_LINKED_STATE MAX_ANALYTICS_MARKS UNBOUNDED

Functions

acceptAggregateArtifact acceptCategoryArtifact acceptHistogramArtifact acceptTimeSeriesArtifact acceptWidgetAggregateArtifact acceptWidgetCategoriesArtifact acceptWidgetHistogramArtifact acceptWidgetTimeSeriesArtifact analyticsArtifactIdentity analyticsBrushIndices analyticsClauseIds analyticsFilterContributions analyticsMarkByKey analyticsMarkFilterClause analyticsProvenance analyticsRangeFilterClause analyticsTableModel analyticsTableModelOf analyticsTemporalFilterClause assertAnalyticsContractVersion assertAnalyticsPushdown bindAnalyticsToExploration categoryMarkKey createAccessibleTableAdapter createAnalyticsAdapterRegistry createAnalyticsLinkedSession createDefaultAnalyticsPresentation createDisposableHandle renderAnalyticsBrushHtml renderAnalyticsTableHtml resolveAnalyticsStatus resolveAnalyticsUpdateDisposition selectAnalyticsLinkedState temporalWindowForMarks unsupportedAnalyticsArtifact validateAnalyticsArtifact widgetResponseProvenance

Settings

Member Visibility