Skip to content

v0.28.8 - Expose Public Options Types and Fix TypeDoc Warnings (2026-03-21)

What Changed?

This release exposes options types that were previously internal-only, making them available as part of the public TypeScript API. It also fixes all remaining TypeDoc warnings by adding @internal tags to implementation-only types and configuring intentionallyNotExported in typedoc.json. TypeDoc now generates documentation with 0 warnings (down from 21).

What's New

Main Feature: Public Options Types

What it does: Options types used in constructors and method calls are now exported as part of the public API. Users can import and use these types to annotate their own code with correct TypeScript types.

How to use it:

TypeScript
import type {
  FlameForgeOptions,
  FlameWrightOptions,
} from "gaslamp";

const options: FlameWrightOptions = { strict: true, logLevel: "debug" };
const fw = new FlameWright("myValidator", options);
TypeScript
import type { JoinOptions, ConcatOptions } from "gaslamp";

const joinOpts: JoinOptions = { on: "id", how: "inner" };
const result = df1.join(df2, joinOpts);

Added

  • typedoc.json — added intentionallyNotExported list for internal types

Changed

  • @internal tags added to implementation-only types: RowData, ColumnData, RowObject, ColumnObject, VersionInfo, ReadOptions, ColumnFormatReturnType, DataFrameValidation

Fixed

  • FlameWright: exported FlameForgeOptions, FlameForgeCoreOptions, FlameWrightOptions, FlameWrightCoreOptions
  • Gaslets: exported BookArtisanOptions, BookArtisanCoreOptions, TriggerArtisanOptions, TriggerArtisanCoreOptions
  • Gears: exported ClockSmithOptions, ClockSmithCoreOptions
  • Torch/DataFrame: exported JoinOptions, ConcatOptions, LazyFrameOptions, LazyFrameCoreOptions and re-exported GetRowOptions, GetColumnOptions, ToArraysOptions from dataframe/index.ts
  • RemnantFlicker: replaced @description with plain description text (invalid TypeDoc tag)
  • TypeDoc: reduced warnings from 21 to 0

Is It Safe to Upgrade?

  • Breaking Changes: No
  • Backward Compatible: Yes

Only additions — no existing APIs were changed or removed.

Release Details

  • Date: 2026-03-21
  • Version: v0.28.8
  • gaslamp: ??
  • pilotlamp: ??
  • Files Changed: 15
  • Commits:
    • 3341da2 bump: version 0.28.7 → 0.28.8
    • 319df36 fix(typedoc): suppress referenced-but-not-exported warnings for internal types
    • d358597 fix(torch/dataframe): export JoinOptions, ConcatOptions, LazyFrameOptions and related types
    • ae792e5 fix(gears): export ClockSmithOptions
    • 0df5ddd fix(gaslets): export BookArtisanOptions and TriggerArtisanOptions
    • d43bc23 fix(flamewright): export FlameForgeOptions and FlameWrightOptions
    • 63cc41a fix(remnantflicker): replace @description with plain description text

Known Issues

  • GAS version numbers for v0.28.3–v0.28.8 are not yet recorded in RemnantFlicker.versions.

Next Steps

  • Push bundle to GAS and record the GAS version number for v0.28.8.