@johnmorrisdotca/houseki 0.4.1 → 0.4.2

package/dist/falling-triplets/match.d.ts

@@ -3,7 +3,31 @@ export interface MatchWave {
     readonly cells: readonly number[];
     readonly colour: Colour;
 }
-/** Finds the union of every maximal horizontal, vertical, and diagonal run of at least three. */
+/** Finds the union of every maximal horizontal, vertical, and diagonal run of at least three.
+ *
+ * @param board - The row-major native board; null cells are empty or masked.
+ * @param width - The native board width in cells.
+ * @param height - The native board height in cells.
+ * @returns Finds the union of every maximal horizontal, vertical, and diagonal run of at least three.
+ * @example
+ * ```ts
+ * import { findMatches } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * console.log(findMatches(Array(72).fill(null),6,12).length);
+ * ```
+ */
 export declare function findMatches(board: readonly (Gem | null)[], width: number, height: number): readonly MatchWave[];
-/** Compacts each column downward while preserving the top-to-bottom order of survivors. */
+/** Compacts each column downward while preserving the top-to-bottom order of survivors.
+ *
+ * @param board - The row-major native board; null cells are empty or masked.
+ * @param width - The native board width in cells.
+ * @param height - The native board height in cells.
+ * @returns Compacts each column downward while preserving the top-to-bottom order of survivors. Nested null values denote empty board cells, absent active pieces, unselected tools or outcomes not yet reached; optional undefined fields are absent until applicable.
+ * @example
+ * ```ts
+ * import { compactBoard } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * console.log(compactBoard(Array(72).fill(null),6,12).length);
+ * ```
+ */
 export declare function compactBoard(board: readonly (Gem | null)[], width: number, height: number): readonly (Gem | null)[];

package/dist/falling-triplets/match.js

@@ -1,4 +1,16 @@
-/** Finds the union of every maximal horizontal, vertical, and diagonal run of at least three. */
+/** Finds the union of every maximal horizontal, vertical, and diagonal run of at least three.
+ *
+ * @param board - The row-major native board; null cells are empty or masked.
+ * @param width - The native board width in cells.
+ * @param height - The native board height in cells.
+ * @returns Finds the union of every maximal horizontal, vertical, and diagonal run of at least three.
+ * @example
+ * ```ts
+ * import { findMatches } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * console.log(findMatches(Array(72).fill(null),6,12).length);
+ * ```
+ */
 export function findMatches(board, width, height) {
     const directions = [[1, 0], [0, 1], [1, 1], [1, -1]];
     const found = new Map();
@@ -28,7 +40,19 @@ export function findMatches(board, width, height) {
         }
     return [...found].map(([colour, cells]) => ({ colour, cells: [...cells].sort((a, b) => a - b) }));
 }
-/** Compacts each column downward while preserving the top-to-bottom order of survivors. */
+/** Compacts each column downward while preserving the top-to-bottom order of survivors.
+ *
+ * @param board - The row-major native board; null cells are empty or masked.
+ * @param width - The native board width in cells.
+ * @param height - The native board height in cells.
+ * @returns Compacts each column downward while preserving the top-to-bottom order of survivors. Nested null values denote empty board cells, absent active pieces, unselected tools or outcomes not yet reached; optional undefined fields are absent until applicable.
+ * @example
+ * ```ts
+ * import { compactBoard } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * console.log(compactBoard(Array(72).fill(null),6,12).length);
+ * ```
+ */
 export function compactBoard(board, width, height) {
     const result = Array(width * height).fill(null);
     for (let x = 0; x < width; x++) {

package/dist/falling-triplets/random.d.ts

@@ -1,9 +1,40 @@
 import type { Colour } from './types.js';
-/** Hashes a string seed with UTF-8 FNV-1a and returns a nonzero uint32 state. */
+/** Hashes a string seed with UTF-8 FNV-1a and returns a nonzero uint32 state.
+ *
+ * @param seed - A string seed hashed into a nonzero deterministic random state.
+ * @returns Hashes a string seed with UTF-8 FNV-1a and returns a nonzero uint32 state.
+ * @example
+ * ```ts
+ * import { seedState } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * console.log(seedState("docs"));
+ * ```
+ */
 export declare function seedState(seed: string): number;
-/** Advances the reference xorshift32 source. */
+/** Advances the reference xorshift32 source.
+ *
+ * @param state - The immutable native state to read or transition; the input is retained.
+ * @returns Advances the reference xorshift32 source.
+ * @example
+ * ```ts
+ * import { nextUint32, seedState } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * console.log(nextUint32(seedState("docs")));
+ * ```
+ */
 export declare function nextUint32(state: number): readonly [number, number];
-/** Draws an unbiased integer and updated state using rejection sampling. */
+/** Draws an unbiased integer and updated state using rejection sampling.
+ *
+ * @param state - The immutable native state to read or transition; the input is retained.
+ * @param n - The positive upper bound of the integer draw; the result is below this bound.
+ * @returns Draws an unbiased integer and updated state using rejection sampling.
+ * @example
+ * ```ts
+ * import { nextInt, seedState } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * console.log(nextInt(seedState("docs"),6));
+ * ```
+ */
 export declare function nextInt(state: number, n: number): readonly [number, number];
 /** Creates a shuffled bag with three of each available colour. */
 export declare function drawBag(bag: readonly Colour[], state: number, count: 4 | 5 | 6): readonly [readonly Colour[], number];

package/dist/falling-triplets/random.js

@@ -1,12 +1,32 @@
 const COLOURS = ['red', 'blue', 'green', 'gold', 'purple', 'teal'];
-/** Hashes a string seed with UTF-8 FNV-1a and returns a nonzero uint32 state. */
+/** Hashes a string seed with UTF-8 FNV-1a and returns a nonzero uint32 state.
+ *
+ * @param seed - A string seed hashed into a nonzero deterministic random state.
+ * @returns Hashes a string seed with UTF-8 FNV-1a and returns a nonzero uint32 state.
+ * @example
+ * ```ts
+ * import { seedState } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * console.log(seedState("docs"));
+ * ```
+ */
 export function seedState(seed) {
     let hash = 0x811c9dc5;
     for (const byte of new TextEncoder().encode(seed))
         hash = Math.imul(hash ^ byte, 0x01000193) >>> 0;
     return hash || 0x6d2b79f5;
 }
-/** Advances the reference xorshift32 source. */
+/** Advances the reference xorshift32 source.
+ *
+ * @param state - The immutable native state to read or transition; the input is retained.
+ * @returns Advances the reference xorshift32 source.
+ * @example
+ * ```ts
+ * import { nextUint32, seedState } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * console.log(nextUint32(seedState("docs")));
+ * ```
+ */
 export function nextUint32(state) {
     let next = state >>> 0;
     next ^= next << 13;
@@ -15,7 +35,18 @@ export function nextUint32(state) {
     next >>>= 0;
     return [next, next];
 }
-/** Draws an unbiased integer and updated state using rejection sampling. */
+/** Draws an unbiased integer and updated state using rejection sampling.
+ *
+ * @param state - The immutable native state to read or transition; the input is retained.
+ * @param n - The positive upper bound of the integer draw; the result is below this bound.
+ * @returns Draws an unbiased integer and updated state using rejection sampling.
+ * @example
+ * ```ts
+ * import { nextInt, seedState } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * console.log(nextInt(seedState("docs"),6));
+ * ```
+ */
 export function nextInt(state, n) {
     if (!Number.isInteger(n) || n < 1 || n > 0x100000000)
         throw new RangeError('n must be an integer from 1 to 2^32');

package/dist/falling-triplets/types.d.ts

@@ -1,13 +1,65 @@
-/** A gem colour ID. */
+/** A gem colour ID.
+ *
+ * @example
+ * ```ts
+ * import type { Colour } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: Colour = "red";
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export type Colour = 'red' | 'blue' | 'green' | 'gold' | 'purple' | 'teal';
-/** A settled or active gem with a stable run-local identity. */
+/** A settled or active gem with a stable run-local identity.
+ *
+ * @example
+ * ```ts
+ * import type { Gem } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: Gem = {id:1,colour:"red"};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface Gem {
     readonly id: number;
     readonly colour: Colour;
     readonly target?: boolean;
 }
+/** The native game mode; authored challenges have fixed setup and queue rules.
+ *
+ * @example
+ * ```ts
+ * import type { Mode } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: Mode = "relaxed";
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export type Mode = 'relaxed' | 'arcade' | 'daily' | 'challenge';
+/** The native falling, resolution, pause and ending phases.
+ *
+ * @example
+ * ```ts
+ * import { createGame } from "@johnmorrisdotca/houseki/falling-triplets";
+ * import type { Phase } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const state=createGame({seed:"docs"});
+ * const value: Phase = state.phase;
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export type Phase = 'falling' | 'clear-mark' | 'clear-remove' | 'gravity' | 'paused' | 'won' | 'lost' | 'finished';
+/** The native falling triplet with stable gem ids, orientation, descent and lock counters.
+ *
+ * @example
+ * ```ts
+ * import { createGame } from "@johnmorrisdotca/houseki/falling-triplets";
+ * import type { Piece } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const state=createGame({seed:"docs"});
+ * const value: Piece = state.active!;
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface Piece {
     readonly gems: readonly [Gem, Gem, Gem];
     readonly x: number;
@@ -19,6 +71,18 @@ export interface Piece {
     readonly lockResets: number;
     readonly lockStarted: boolean;
 }
+/** Validated settings fixed at native game creation.
+ *
+ * @example
+ * ```ts
+ * import { createGame } from "@johnmorrisdotca/houseki/falling-triplets";
+ * import type { Settings } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const state=createGame({seed:"docs"});
+ * const value: Settings = state.settings;
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface Settings {
     readonly mode: Mode;
     readonly width: number;
@@ -33,35 +97,129 @@ export interface Settings {
     readonly challengeQueue?: readonly Triplet[];
     readonly witness?: readonly ChallengeHint[];
 }
+/** Three ordered gem colours composing one falling triplet.
+ *
+ * @example
+ * ```ts
+ * import type { Triplet } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: Triplet = ["red","green","blue"];
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export type Triplet = readonly [Colour, Colour, Colour];
+/** A Falling Triplets objective requiring the supplied stable target ids to be cleared.
+ *
+ * @example
+ * ```ts
+ * import type { ChallengeGoalTargets } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: ChallengeGoalTargets = {type:"targets",targetIds:[1]};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface ChallengeGoalTargets {
     readonly type: 'targets';
     readonly targetIds: readonly number[];
 }
+/** A Falling Triplets objective requiring at least the supplied chain depth.
+ *
+ * @example
+ * ```ts
+ * import type { ChallengeGoalChain } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: ChallengeGoalChain = {type:"chain",minimumChain:2};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface ChallengeGoalChain {
     readonly type: 'chain';
     readonly minimumChain: number;
 }
+/** A Falling Triplets objective requiring an empty board.
+ *
+ * @example
+ * ```ts
+ * import type { ChallengeGoalEmpty } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: ChallengeGoalEmpty = {type:"empty"};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface ChallengeGoalEmpty {
     readonly type: 'empty';
 }
+/** A native authored challenge objective; its discriminant selects target, chain, empty-board or score requirements.
+ *
+ * @example
+ * ```ts
+ * import type { ChallengeGoal } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: ChallengeGoal = {type:"empty"};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export type ChallengeGoal = ChallengeGoalTargets | ChallengeGoalChain | ChallengeGoalEmpty;
+/** One witnessed Falling Triplets placement with a column and cycle orientation.
+ *
+ * @example
+ * ```ts
+ * import type { ChallengeHint } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: ChallengeHint = {x:0,orientation:0};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface ChallengeHint {
     readonly x: number;
     readonly orientation: 0 | 1 | 2;
 }
+/** The fixed Falling Triplets challenge settings with the original board and finite triplet queue.
+ *
+ * @example
+ * ```ts
+ * import { createGame } from "@johnmorrisdotca/houseki/falling-triplets";
+ * import type { ChallengeSettings } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const state=createGame({seed:"docs"});
+ * const value: ChallengeSettings = {...state.settings,mode:"challenge",goal:"empty",challengeBoard:state.board,challengeQueue:[["red","green","blue"]]};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface ChallengeSettings extends Settings {
     readonly mode: 'challenge';
     readonly goal: ChallengeGoal['type'];
     readonly challengeBoard: readonly (Gem | null)[];
     readonly challengeQueue: readonly Triplet[];
 }
+/** One simultaneous native match wave, its cleared cells and chain score.
+ *
+ * @example
+ * ```ts
+ * import type { Wave } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: Wave = {chain:1,cells:[],points:0,clearedIds:[]};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface Wave {
     readonly clearedIds: readonly number[];
     readonly cells: readonly number[];
     readonly chain: number;
     readonly points: number;
 }
+/** The immutable authoritative native game state, including its board, random state and recording.
+ *
+ * @example
+ * ```ts
+ * import { createGame } from "@johnmorrisdotca/houseki/falling-triplets";
+ * import type { GameState } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const state=createGame({seed:"docs"});
+ * const value: GameState = state;
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface GameState {
     readonly game: 'falling-triplets';
     readonly rules: 'triplets-1';
@@ -92,16 +250,50 @@ export interface GameState {
     readonly recording: readonly RecordedAction[];
     readonly reason?: string;
 }
+/** A native player action accepted or rejected according to the current phase and rules.
+ *
+ * @example
+ * ```ts
+ * import type { Action } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const action: Action={kind:"left"};
+ * const value: Action = action;
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export type Action = {
     readonly kind: 'left' | 'right' | 'soft-drop' | 'hard-drop' | 'place' | 'cycle-forward' | 'cycle-backward' | 'pause' | 'resume' | 'hint' | 'tick';
 };
+/** The resulting native state, emitted events and acceptance decision; rejected actions preserve the input.
+ *
+ * @example
+ * ```ts
+ * import { applyAction, createGame } from "@johnmorrisdotca/houseki/falling-triplets";
+ * import type { Action, Transition } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const state=createGame({seed:"docs"});
+ * const action: Action={kind:"left"};
+ * const value: Transition = applyAction(state,action);
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface Transition {
     readonly state: GameState;
     readonly events: readonly GameEvent[];
     readonly accepted: boolean;
     readonly reason?: string;
 }
-/** One accepted canonical action and its logical tick position. */
+/** One accepted canonical action and its logical tick position.
+ *
+ * @example
+ * ```ts
+ * import type { Action, RecordedAction } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const action: Action={kind:"left"};
+ * const value: RecordedAction = {tick:0,ordinal:0,action};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface RecordedAction {
     readonly tick: number;
     readonly ordinal: number;
@@ -109,10 +301,30 @@ export interface RecordedAction {
         readonly kind: 'tick';
     }>;
 }
+/** An event emitted by one native transition; type selects the event’s additional fields.
+ *
+ * @example
+ * ```ts
+ * import type { GameEvent } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: GameEvent = {type:"host-example"};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface GameEvent {
     readonly type: string;
     readonly [key: string]: unknown;
 }
+/** Creation settings for this native engine; dimensions, mode, seed and optional mechanics are validated together.
+ *
+ * @example
+ * ```ts
+ * import type { CreateOptions } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const value: CreateOptions = {seed:"docs"};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface CreateOptions {
     readonly mode?: Exclude<Mode, 'challenge'>;
     readonly seed?: string;
@@ -122,6 +334,18 @@ export interface CreateOptions {
     readonly colourCount?: 4 | 5 | 6;
     readonly pieceLimit?: number;
 }
+/** Authored challenge inputs including the starting board, finite goal and supplied witness.
+ *
+ * @example
+ * ```ts
+ * import { createGame } from "@johnmorrisdotca/houseki/falling-triplets";
+ * import type { ChallengeOptions } from "@johnmorrisdotca/houseki/falling-triplets";
+ *
+ * const state=createGame({seed:"docs"});
+ * const value: ChallengeOptions = {width:6,height:12,board:state.board,queue:[["red","green","blue"]],goal:{type:"empty"}};
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface ChallengeOptions {
     readonly seed?: string;
     readonly width?: number;

package/dist/gem-swap/content.d.ts

@@ -1,5 +1,27 @@
 import type { Action, CreateOptions, ReplayOperation } from './types.js';
+/** The existing campaign’s human-review-pending status; an engine witness is not human review.
+ *
+ * @example
+ * ```ts
+ * import type { GemSwapReviewStatus } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * const value: GemSwapReviewStatus = "human-review-pending";
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export type GemSwapReviewStatus = 'human-review-pending';
+/** One authored native challenge with its stable id, setup, winning witness, measurements and review status.
+ *
+ * @example
+ * ```ts
+ * import { GEM_SWAP_CAMPAIGN } from "@johnmorrisdotca/houseki/gem-swap";
+ * import type { GemSwapCampaignLevel } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * const level=GEM_SWAP_CAMPAIGN[0];
+ * const value: GemSwapCampaignLevel = level;
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface GemSwapCampaignLevel {
     readonly id: string;
     readonly number: number;
@@ -23,6 +45,17 @@ export interface GemSwapCampaignLevel {
     readonly proofStatus: 'engine-witness-verified';
     readonly reviewStatus: GemSwapReviewStatus;
 }
+/** One bilingual native lesson instruction and the corresponding action or tick step.
+ *
+ * @example
+ * ```ts
+ * import type { GemSwapLessonStep } from "@johnmorrisdotca/houseki/gem-swap";
+ * import { GEM_SWAP_LESSONS } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * const value: GemSwapLessonStep = GEM_SWAP_LESSONS[0].steps[0];
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export type GemSwapLessonStep = {
     readonly kind: 'action';
     readonly id: string;
@@ -47,6 +80,17 @@ export type GemSwapLessonStep = {
         readonly ja: string;
     };
 };
+/** One bilingual native lesson with its authored setup, teaching steps and winning witness.
+ *
+ * @example
+ * ```ts
+ * import type { GemSwapLesson } from "@johnmorrisdotca/houseki/gem-swap";
+ * import { GEM_SWAP_LESSONS } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * const value: GemSwapLesson = GEM_SWAP_LESSONS[0];
+ * console.log(value == null ? value : typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 export interface GemSwapLesson {
     readonly id: string;
     readonly title: {
@@ -58,9 +102,45 @@ export interface GemSwapLesson {
     readonly witness: readonly ReplayOperation[];
     readonly reviewStatus: GemSwapReviewStatus;
 }
+/** The stored Gem Swap campaign generation revision.
+ *
+ * @example
+ * ```ts
+ * import { GENERATION_REVISION } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * console.log(GENERATION_REVISION);
+ * ```
+ */
 export declare const GENERATION_REVISION = "gem-swap-campaign-1.3.0";
+/** The measurement/normalization revision used to grade Gem Swap challenges.
+ *
+ * @example
+ * ```ts
+ * import { GRADING_VERSION } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * console.log(GRADING_VERSION);
+ * ```
+ */
 export declare const GRADING_VERSION = "swap-choice-forgiveness-1";
+/** The fixed number of seeded playout samples used in the stored Gem Swap grading.
+ *
+ * @example
+ * ```ts
+ * import { SAMPLE_BUDGET } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * console.log(SAMPLE_BUDGET);
+ * ```
+ */
 export declare const SAMPLE_BUDGET = 24;
+/** The bounded Gem Swap metric weights used in the recorded grading formula.
+ *
+ * @example
+ * ```ts
+ * import { GRADING_WEIGHTS } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * console.log(Object.keys(GRADING_WEIGHTS));
+ * ```
+ */
 export declare const GRADING_WEIGHTS: {
     seededPlayoutDifficulty: number;
     choiceDifficulty: number;
@@ -69,7 +149,43 @@ export declare const GRADING_WEIGHTS: {
     witnessLength: number;
     specialCombination: number;
 };
+/** The stored Gem Swap campaign content fingerprint.
+ *
+ * @example
+ * ```ts
+ * import { CAMPAIGN_CHECKSUM } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * console.log(CAMPAIGN_CHECKSUM);
+ * ```
+ */
 export declare const CAMPAIGN_CHECKSUM = "eb7c54a583db428d596b8fbdab0d63a9ad39ad5b9e39948dc4ccab84ba1196aa";
+/** The number of stored Gem Swap campaign challenges.
+ *
+ * @example
+ * ```ts
+ * import { CAMPAIGN_COUNT } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * console.log(CAMPAIGN_COUNT);
+ * ```
+ */
 export declare const CAMPAIGN_COUNT = 50;
+/** The frozen measured Gem Swap challenges with stable ids, setups, witnesses and review status.
+ *
+ * @example
+ * ```ts
+ * import { GEM_SWAP_CAMPAIGN } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * console.log(GEM_SWAP_CAMPAIGN.length);
+ * ```
+ */
 export declare const GEM_SWAP_CAMPAIGN: readonly GemSwapCampaignLevel[];
+/** The frozen bilingual Gem Swap lessons with setup, teaching steps and witnesses.
+ *
+ * @example
+ * ```ts
+ * import { GEM_SWAP_LESSONS } from "@johnmorrisdotca/houseki/gem-swap";
+ *
+ * console.log(GEM_SWAP_LESSONS.length);
+ * ```
+ */
 export declare const GEM_SWAP_LESSONS: readonly GemSwapLesson[];