@bitcobblers/wod-wiki-engine 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,273 @@
+import { IDialect, AnalyticsDataPoint, Note, NoteSegment, BlockIndexRow, WorkoutResult, StoredOutputStatement, WorkoutResults, ICodeStatement, IOutputStatement } from '@bitcobblers/wod-wiki-core';
+export * from '@bitcobblers/wod-wiki-core';
+import { IRealtimeProcessor, ISummaryProcessor, IEffort, IScript, INowProvider } from '@bitcobblers/wod-wiki-lang';
+export { AnalyticsContext, AnalyticsEngine, AnalyticsResult, AnalyticsTransformer, BUILTIN_CALCS, BUNDLED_EFFORT_COUNT, BehaviorContext, BlockContext, CONSUMED_HINTS, CalcDefinition, CalcEngine, CalcOrigin, CalcScope, CalculateBlockProcessor, CalculationRegistry, CardioDialect, ClimbDialect, ClimbMetricType, CrossFitDialect, DEFAULT_RESOLVER_OPTIONS, DEFAULT_UNRESOLVED_EFFORT_MET, DIM_LENGTH, DIM_MASS, DIM_TIME, DIM_ZERO, DialectStack, EFFORT_REGISTRY_ORIGINS, EffortBaseAttributes, EffortDerivation, EffortRegistrySource, EffortResolutionOptions, EffortResolver, EffortResolverOptions, EventBus, ExecutionContext, HabitsDialect, IAnalyticsEngine, IAnalyticsProcessorDescriptor, IAnalyticsProfile, IEffortRegistry, IEffortResolver, ILookupTable, INTENSITY_TIERS, INowProvider, IRealtimeProcessor, IRuntimeBlockStrategy, IScript, ISummaryProcessor, InMemoryEffortRegistry, IntensityTier, JitCompiler, LookupRegistry, MdTimerRuntime, NextEvent, OutputEmitter, PRODUCTION_STRATEGIES, Registry, ResolvedEffort, ResolvedEffortData, RuntimeBlock, RuntimeBlockOptions, RuntimeClock, RuntimeController, RuntimeFactory, RuntimeLogger, RuntimeMemory, RuntimeStack, STORE_CALCS, ScriptRuntime, SegmentWithMetadata, SnapshotClock, StandardAnalyticsProfile, StartSessionAction, StartSessionOptions, TwoPassEffortResolutionProcess, UnitsDialect, WhiteboardScript, WodDialect, YogaDialect, bundledEfforts, createAnalyticsEngineForBlock, createCalcEngine, createCompiler, createDialectStack, createMockClock, createParser, dialectRegistry, dialectStack, evaluate, evaluateCalculateDefinitions, extractMetrics, extractStatements, findBestFuzzyMatch, frozenNow, getAnalyticsFromLogs, getHints, hintsToContainer, isWithinThreshold, levenshteinDistance, normalizeForFuzzy, parseCalcLine, parseCalculateBlock, parseExpression, parseScript, realtimeProcessorRegistry, strategyRegistry, summaryProcessorRegistry, toStoredOutputStatement, wallClockNow } from '@bitcobblers/wod-wiki-lang';
+import { FactQueryStore, QueryResult, RowsQueryResult, FindQueryResult } from '@bitcobblers/wod-wiki-wql';
+export { Aggregator, AnyParsedQuery, BlockQueryStore, ComparisonOp, DASHBOARD_GRID_MAX_COLS, DASHBOARD_WIDGET_TYPES, DEFAULT_DASHBOARD_TITLE, DashboardDocument, DashboardMeta, DashboardToken, DashboardWidget, EffortQueryStore, FactQueryStore, FindOptions, FindPredicate, FindQueryResult, MetricPredicate, NoteQueryStore, PLANNED_WIDGET_TYPES, ParsedFindQuery, ParsedQuery, ParsedRowsQuery, QueryOptions, QueryResult, QueryService, QueryServiceStores, QueryWidgetSuffix, ResultLogStore, RowsQueryResult, RowsRun, Series, SeriesPoint, TagFilter, TagValue, WQL_AGGREGATORS, WQL_CALC_TARGETS, WQL_COMPARISON_OPS, WQL_CONTENT_FILTER_KEYS, WQL_DISPLAY_UNITS, WQL_FIND_TARGETS, WQL_GRAINS, WQL_INTENSITY_TIERS, WQL_KEYWORDS, WQL_METRIC_AGGREGATES, WQL_METRIC_FAMILIES, WQL_ROLLUP_PERIODS, WQL_SOURCES, WQL_TAG_KEYS, WQL_VIRTUAL_DIMS, buildDashboardDocument, buildDashboardScaffold, dashboardSlug, defaultTokenValues, extractDashboardTokens, isDashboardMeta, isDashboardWidgetType, isFindQuery, isRowsQuery, parseQuery, parseQueryWidgetSuffix, parseWqlSuffixes, resolveWidgetType, splitAtWhere, splitWidgetBody, substituteTokens, unknownTokensMessage, unknownWidgetTypeMessage, wql, wqlLanguage, wqlParser, wqlTerms } from '@bitcobblers/wod-wiki-wql';
+
+/**
+ * Language Pack API — umbrella sugar over per-package slices
+ *
+ * Implements docs/adr/language-pack-api.md.
+ * Provides defineLanguagePack() factory and registerLanguagePack() fan-out
+ * into core tag identity, lang dialect stack, and analytics registries.
+ */
+
+interface LanguagePackIdentity {
+    id?: string;
+    name: string;
+    tags?: readonly string[];
+    aliases?: readonly string[];
+    runnable?: boolean;
+}
+interface LanguagePackLangSlice {
+    analyzer?: new () => IDialect;
+    analytics?: ReadonlyArray<new () => IRealtimeProcessor | ISummaryProcessor>;
+}
+interface LanguagePackUiSlice {
+    widgetBlock?: unknown;
+}
+interface LanguagePack {
+    identity?: LanguagePackIdentity;
+    lang?: LanguagePackLangSlice;
+    ui?: LanguagePackUiSlice;
+}
+declare function defineLanguagePack(pack: LanguagePack): LanguagePack;
+declare function registerLanguagePack(pack: LanguagePack): void;
+declare function unregisterLanguagePack(packOrId: LanguagePack | string): void;
+declare function listLanguagePacks(): LanguagePack[];
+declare function getRegisteredLanguagePacks(): LanguagePack[];
+
+/**
+ * In-memory FactQueryStore over a golden IR fixture — the state-free store
+ * seam for QueryService and Storybook workbench.
+ *
+ * Implements FactQueryStore contract without database or browser dependencies.
+ */
+
+declare function inMemoryFactStore(facts: readonly AnalyticsDataPoint[], noteTags?: Readonly<Record<string, readonly string[]>>): FactQueryStore;
+
+/**
+ * Pure JSON Intermediate Representation (IR) Schemas & Envelope
+ *
+ * Implements wayfinder #955 and research asset `docs/research/json-ir-schemas-2026-08-17.md`.
+ * Freezes the existing result vocabulary (QueryResult, RowsQueryResult, FindQueryResult,
+ * StoredOutputStatement, AnalyticsDataPoint, WorkoutResult, StatementNode) in a
+ * versioned envelope safe for JSON round-trips.
+ */
+
+type IrKind = 'fact-set' | 'result-set' | 'note-set' | 'corpus' | 'query-result' | 'find-result' | 'rows-result' | 'parse-tree' | 'execution-log';
+/**
+ * Universal JSON envelope for all headless IR fixtures and output artifacts.
+ */
+interface WodWikiIRFile<T> {
+    $schema: 'https://wod-wiki.dev/ir/v1.json';
+    kind: IrKind;
+    generatedAt: number;
+    source: string;
+    data: T;
+}
+declare function createIRFile<T>(kind: IrKind, data: T, optionsOrSource?: string | {
+    source?: string;
+    generatedAt?: number;
+}, generatedAt?: number): WodWikiIRFile<T>;
+declare function isIRFile<T = unknown>(obj: unknown): obj is WodWikiIRFile<T>;
+interface MetricNode {
+    type: string;
+    image?: string;
+    value?: unknown;
+    origin?: string;
+}
+interface StatementNode {
+    id: number;
+    type: 'statement' | 'duration' | 'rounds' | 'rest' | 'segment' | 'root';
+    raw: string;
+    from: number;
+    to: number;
+    metrics: MetricNode[];
+    hints?: string[];
+    children?: StatementNode[];
+}
+declare function statementToNode(stmt: ICodeStatement, idMap: Map<number, ICodeStatement>): StatementNode;
+/** Builds a StatementNode tree from a parsed WhiteboardScript. */
+declare function buildStatementTree(script: IScript): StatementNode;
+interface ExecutionLog {
+    results: WorkoutResults;
+    logs: StoredOutputStatement[];
+    statements?: StoredOutputStatement[];
+    blockKey?: string;
+    sourceScript?: string;
+}
+interface CorpusIRData {
+    notes?: Note[];
+    segments?: NoteSegment[];
+    blocks?: BlockIndexRow[];
+    results?: WorkoutResult[];
+    facts?: AnalyticsDataPoint[];
+    efforts?: IEffort[];
+    logs?: StoredOutputStatement[];
+    tags?: Record<string, string[]>;
+}
+
+/**
+ * Headless Parse Command Runner
+ *
+ * Parses Whiteboard Script source text and emits a versioned IR parse-tree envelope.
+ */
+
+declare class ParseSyntaxError extends Error {
+    readonly errors: Array<{
+        message: string;
+        line?: number;
+    }>;
+    constructor(errors: Array<{
+        message: string;
+        line?: number;
+    }>, message?: string);
+}
+interface ParseOptions {
+    sport?: string;
+    sourceLabel?: string;
+}
+/**
+ * Parses Whiteboard Script source directly into a StatementNode IR envelope.
+ */
+declare function runParse(source: string, options?: ParseOptions): WodWikiIRFile<StatementNode>;
+
+/**
+ * Headless Execution Command Runner
+ *
+ * Executes Whiteboard Script through JIT compiler and runtime state machine,
+ * emitting a versioned execution-log IR envelope.
+ */
+
+interface RunOptions {
+    sport?: string;
+    startTime?: number;
+    maxIterations?: number;
+    now?: INowProvider;
+    sourceLabel?: string;
+}
+declare function buildWorkoutResults(outputs: readonly IOutputStatement[], options: {
+    readonly startTime?: number;
+    readonly elapsedTime: number;
+    readonly completed: boolean;
+    readonly now: INowProvider;
+}): WorkoutResults;
+/**
+ * Runs a workout script to completion using headless state machine and Node clock.
+ */
+declare function runExecution(source: string, options?: RunOptions): Promise<WodWikiIRFile<ExecutionLog>>;
+
+/**
+ * Headless WQL Query Command Runner
+ *
+ * Evaluates WQL queries against in-memory stores sourced from --corpus,
+ * --stdin-log, or --stdin-facts, and emits a versioned IR envelope.
+ */
+
+declare class WqlSyntaxError extends Error {
+    readonly query: string;
+    readonly syntaxError: string;
+    constructor(query: string, syntaxError: string);
+}
+interface QueryCliOptions {
+    corpusPath?: string;
+    stdinLog?: string;
+    stdinFacts?: string;
+    preferredUnit?: string;
+    sourceLabel?: string;
+}
+interface LoadedData {
+    facts: AnalyticsDataPoint[];
+    results: WorkoutResult[];
+    notes: Note[];
+    blocks: BlockIndexRow[];
+    efforts: IEffort[];
+    noteTags: Record<string, string[]>;
+}
+declare function loadQueryData(options: QueryCliOptions): LoadedData;
+/**
+ * Runs a WQL query against the provided in-memory dataset and returns a versioned IR envelope.
+ */
+declare function runQueryCli(wqlString: string, options?: QueryCliOptions): Promise<WodWikiIRFile<QueryResult | RowsQueryResult | FindQueryResult>>;
+
+/**
+ * Dynamic Language Pack Loader
+ *
+ * Dynamically loads and registers Language Packs passed via `--pack <module-spec>`.
+ * Throws PackLoadError on failure, enabling exit code 3 handling.
+ */
+
+declare class PackLoadError extends Error {
+    readonly spec: string;
+    readonly originalError: unknown;
+    constructor(spec: string, originalError: unknown);
+}
+/**
+ * Dynamically imports a Language Pack module and registers it.
+ *
+ * @param moduleSpec - Relative or absolute path, or package name.
+ */
+declare function loadLanguagePack(moduleSpec: string): Promise<LanguagePack>;
+
+/**
+ * CLI Output Formatters (JSON, ASCII Table, CSV)
+ *
+ * Implements presentation formatting for parse-tree, execution-log,
+ * and WQL query results across json, table, and csv formats.
+ */
+
+type OutputFormat = 'json' | 'table' | 'csv';
+/**
+ * Format StatementNode parse tree
+ */
+declare function formatParseOutput(ir: WodWikiIRFile<StatementNode>, format: OutputFormat, pretty?: boolean): string;
+/**
+ * Format ExecutionLog runtime output
+ */
+declare function formatExecutionOutput(ir: WodWikiIRFile<ExecutionLog>, format: OutputFormat, pretty?: boolean): string;
+/**
+ * Format QueryResult / RowsQueryResult / FindQueryResult
+ */
+declare function formatQueryOutput(ir: WodWikiIRFile<QueryResult | RowsQueryResult | FindQueryResult>, format: OutputFormat, pretty?: boolean): string;
+
+/**
+ * Unified `wod` CLI Runner
+ *
+ * Implements CLI command routing, argument parsing, pipe handling,
+ * and exit code conventions per wayfinder #962 and issue #967.
+ *
+ * Exit Codes:
+ *   0 - OK / Success (including empty query results)
+ *   1 - Runtime error (file missing, bad arguments, execution error)
+ *   2 - Parse / Syntax error (invalid Whiteboard Script or malformed WQL)
+ *   3 - Pack load error (failed to import or register --pack)
+ */
+
+interface CliParsedArgs {
+    subcommand?: 'parse' | 'run' | 'query' | 'help' | 'version';
+    target?: string;
+    corpus?: string;
+    stdinLog?: boolean;
+    stdinFacts?: boolean;
+    format: OutputFormat;
+    output?: string;
+    packs: string[];
+    sport?: string;
+    unit?: string;
+    help?: boolean;
+    version?: boolean;
+}
+declare function parseCliArgs(args: string[]): CliParsedArgs;
+declare function readStdin(): Promise<string>;
+/**
+ * Main CLI entry point. Returns numeric exit code.
+ */
+declare function cliMain(argv?: string[], io?: {
+    stdout?: (text: string) => void;
+    stderr?: (text: string) => void;
+    readStdinFn?: () => Promise<string>;
+}): Promise<number>;
+
+export { type CliParsedArgs, type CorpusIRData, type ExecutionLog, type IrKind, type LanguagePack, type LanguagePackIdentity, type LanguagePackLangSlice, type LanguagePackUiSlice, type MetricNode, type OutputFormat, PackLoadError, type ParseOptions, ParseSyntaxError, type QueryCliOptions, type RunOptions, type StatementNode, type WodWikiIRFile, WqlSyntaxError, buildStatementTree, buildWorkoutResults, cliMain, createIRFile, defineLanguagePack, formatExecutionOutput, formatParseOutput, formatQueryOutput, getRegisteredLanguagePacks, inMemoryFactStore, isIRFile, listLanguagePacks, loadLanguagePack, loadQueryData, parseCliArgs, readStdin, registerLanguagePack, runExecution, runParse, runQueryCli, statementToNode, unregisterLanguagePack };

package/dist/index.mjs

@@ -0,0 +1,17 @@
+export { PackLoadError, ParseSyntaxError, WqlSyntaxError, buildStatementTree, buildWorkoutResults, cliMain, createIRFile, defineLanguagePack, formatExecutionOutput, formatParseOutput, formatQueryOutput, getRegisteredLanguagePacks, isIRFile, listLanguagePacks, loadLanguagePack, loadQueryData, parseCliArgs, readStdin, registerLanguagePack, runExecution, runParse, runQueryCli, statementToNode, unregisterLanguagePack } from './chunk-2LP6DUB5.mjs';
+export * from '@bitcobblers/wod-wiki-core';
+export { AnalyticsEngine, AnalyticsTransformer, BUILTIN_CALCS, BUNDLED_EFFORT_COUNT, CONSUMED_HINTS, CalcEngine, CalculationRegistry, CardioDialect, ClimbDialect, ClimbMetricType, CrossFitDialect, DEFAULT_RESOLVER_OPTIONS, DEFAULT_UNRESOLVED_EFFORT_MET, DIM_LENGTH, DIM_MASS, DIM_TIME, DIM_ZERO, DialectStack, EFFORT_REGISTRY_ORIGINS, EffortResolver, EventBus, HabitsDialect, INTENSITY_TIERS, InMemoryEffortRegistry, JitCompiler, LookupRegistry, MdTimerRuntime, NextEvent, OutputEmitter, PRODUCTION_STRATEGIES, Registry, RuntimeClock, RuntimeFactory, RuntimeMemory, RuntimeStack, STORE_CALCS, ScriptRuntime, SnapshotClock, StandardAnalyticsProfile, StartSessionAction, UnitsDialect, WhiteboardScript, WodDialect, YogaDialect, bundledEfforts, createAnalyticsEngineForBlock, createCalcEngine, createCompiler, createDialectStack, createMockClock, createParser, dialectRegistry, dialectStack, evaluate, evaluateCalculateDefinitions, extractMetrics, extractStatements, findBestFuzzyMatch, frozenNow, getAnalyticsFromLogs, getHints, hintsToContainer, isWithinThreshold, levenshteinDistance, normalizeForFuzzy, parseCalcLine, parseCalculateBlock, parseExpression, parseScript, realtimeProcessorRegistry, strategyRegistry, summaryProcessorRegistry, toStoredOutputStatement, wallClockNow } from '@bitcobblers/wod-wiki-lang';
+export { DASHBOARD_GRID_MAX_COLS, DASHBOARD_WIDGET_TYPES, DEFAULT_DASHBOARD_TITLE, PLANNED_WIDGET_TYPES, QueryService, WQL_AGGREGATORS, WQL_CALC_TARGETS, WQL_COMPARISON_OPS, WQL_CONTENT_FILTER_KEYS, WQL_DISPLAY_UNITS, WQL_FIND_TARGETS, WQL_GRAINS, WQL_INTENSITY_TIERS, WQL_KEYWORDS, WQL_METRIC_AGGREGATES, WQL_METRIC_FAMILIES, WQL_ROLLUP_PERIODS, WQL_SOURCES, WQL_TAG_KEYS, WQL_VIRTUAL_DIMS, buildDashboardDocument, buildDashboardScaffold, dashboardSlug, defaultTokenValues, extractDashboardTokens, isDashboardMeta, isDashboardWidgetType, isFindQuery, isRowsQuery, parseQuery, parseQueryWidgetSuffix, parseWqlSuffixes, resolveWidgetType, splitAtWhere, splitWidgetBody, substituteTokens, unknownTokensMessage, unknownWidgetTypeMessage, wql, wqlLanguage, wqlParser, wqlTerms } from '@bitcobblers/wod-wiki-wql';
+
+// src/store.ts
+function inMemoryFactStore(facts, noteTags = {}) {
+  return {
+    getFactsByMetric: async (metricKey) => facts.filter((f) => f.metricKey === metricKey || f.type === metricKey),
+    getFactsByTimeRange: async (start, end) => facts.filter((f) => f.timestamp >= start && f.timestamp <= end),
+    getNoteTagLabels: async (noteId) => [...noteTags[noteId] ?? []]
+  };
+}
+
+export { inMemoryFactStore };
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/store.ts"],"names":[],"mappings":";;;;;;AASO,SAAS,iBAAA,CACd,KAAA,EACA,QAAA,GAAwD,EAAC,EACzC;AAChB,EAAA,OAAO;AAAA,IACL,gBAAA,EAAkB,OAAO,SAAA,KACvB,KAAA,CAAM,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,SAAA,KAAc,SAAA,IAAa,CAAA,CAAE,IAAA,KAAS,SAAS,CAAA;AAAA,IACvE,mBAAA,EAAqB,OAAO,KAAA,EAAe,GAAA,KACzC,KAAA,CAAM,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,SAAA,IAAa,KAAA,IAAS,CAAA,CAAE,aAAa,GAAG,CAAA;AAAA,IAChE,gBAAA,EAAkB,OAAO,MAAA,KAAmB,CAAC,GAAI,QAAA,CAAS,MAAM,CAAA,IAAK,EAAG;AAAA,GAC1E;AACF","file":"index.mjs","sourcesContent":["/**\n * In-memory FactQueryStore over a golden IR fixture — the state-free store\n * seam for QueryService and Storybook workbench.\n *\n * Implements FactQueryStore contract without database or browser dependencies.\n */\nimport type { AnalyticsDataPoint } from '@bitcobblers/wod-wiki-core';\nimport type { FactQueryStore } from '@bitcobblers/wod-wiki-wql';\n\nexport function inMemoryFactStore(\n  facts: readonly AnalyticsDataPoint[],\n  noteTags: Readonly<Record<string, readonly string[]>> = {},\n): FactQueryStore {\n  return {\n    getFactsByMetric: async (metricKey: string) =>\n      facts.filter((f) => f.metricKey === metricKey || f.type === metricKey),\n    getFactsByTimeRange: async (start: number, end: number) =>\n      facts.filter((f) => f.timestamp >= start && f.timestamp <= end),\n    getNoteTagLabels: async (noteId: string) => [...(noteTags[noteId] ?? [])],\n  };\n}\n"]}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@bitcobblers/wod-wiki-engine",
+  "version": "0.1.0",
+  "description": "Umbrella package for Whiteboard Language & WQL engine with CLI runner",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "wod": "./dist/bin/wod.mjs"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@bitcobblers/wod-wiki-core": "workspace:*",
+    "@bitcobblers/wod-wiki-lang": "workspace:*",
+    "@bitcobblers/wod-wiki-wql": "workspace:*"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  }
+}