@sandustry-modding/types 0.1.0 → 0.3.1

package/src/worker/api/elements.d.ts

@@ -0,0 +1,266 @@
+import type { CellCoordinates, Vector2 } from "../../shared/player";
+import { shared } from "../../shared";
+
+/**
+ * Worker-thread `sandkit.api.elements` — shared reads plus immediate grid mutations.
+ *
+ * Worker-entry mutations apply immediately. Main thread defers matching helpers in
+ * `sandkit.api.elements`.
+ *
+ * @internal Worker extension; not interchangeable with main-thread
+ * `sandkit.api.elements`.
+ *
+ * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements`
+ */
+export namespace elements {
+  /** Numeric id for a registered element type. */
+  export import ElementType = shared.api.elements.ElementType;
+  /** Mod or built-in element string id. */
+  export import ElementId = shared.api.elements.ElementId;
+  /** Type handle or string id accepted by lookup helpers. */
+  export import ElementRef = shared.api.elements.ElementRef;
+  /** Matter category for element physics behavior. */
+  export import MatterType = shared.api.elements.MatterType;
+  /** Full definition used to register a custom element. */
+  export import ElementDefinition = shared.api.elements.ElementDefinition;
+  /** Options for {@link createAtCell} and replace helpers. */
+  export import ElementCreateOptions = shared.api.elements.ElementCreateOptions;
+  /** Options for {@link removeAtCell}. */
+  export import ElementRemovalOptions = shared.api.elements.ElementRemovalOptions;
+
+  /** Returns the mod string id for a numeric element type. */
+  export import getIdByType = shared.api.elements.getIdByType;
+  /** Resolves a string element id to its numeric type. */
+  export import getTypeById = shared.api.elements.getTypeById;
+  /**
+   * @deprecated Use {@link getTypeById} instead.
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.elements.getTypeById`
+   */
+  export import getTypeFromId = shared.api.elements.getTypeFromId;
+  /** Returns the definition for an element type. */
+  export import getDefinitionByType = shared.api.elements.getDefinitionByType;
+  /** Returns the element type at a cell, or null. */
+  export import getTypeAtCell = shared.api.elements.getTypeAtCell;
+  /** Returns the resolved element type at a cell, or null. */
+  export import getResolvedTypeAtCell = shared.api.elements.getResolvedTypeAtCell;
+  /** Returns the resolved element type from a cell id, or null. */
+  export import getResolvedTypeFromCellId = shared.api.elements.getResolvedTypeFromCellId;
+  /** Returns element info at a cell, or null. */
+  export import getInfoAtCell = shared.api.elements.getInfoAtCell;
+  /** Returns the matter type at a cell, or null. */
+  export import getMatterTypeAtCell = shared.api.elements.getMatterTypeAtCell;
+  /** Returns true when the cell contains the given element type or id. */
+  export import isTypeAtCell = shared.api.elements.isTypeAtCell;
+  /** Returns true when the element at the cell is free-falling. */
+  export import isFreeFallingAtCell = shared.api.elements.isFreeFallingAtCell;
+  /** Returns particle velocity at a cell, or null. */
+  export import getVelocityAtCell = shared.api.elements.getVelocityAtCell;
+  /** Returns a data field value at a cell, or null. */
+  export import getDataFieldAtCell = shared.api.elements.getDataFieldAtCell;
+
+  /**
+   * Create an element at a cell immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @param elementTypeOrId - Numeric type or string id.
+   * @param options - Optional spawn overrides.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.createAtCell`
+   */
+  export function createAtCell(
+    ...args: [...CellCoordinates, elementTypeOrId: ElementRef, options?: ElementCreateOptions]
+  ): void;
+
+  /**
+   * Replace the element at a cell immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @param elementTypeOrId - Numeric type or string id.
+   * @param options - Optional spawn overrides.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.replaceAtCell`
+   */
+  export function replaceAtCell(
+    ...args: [...CellCoordinates, elementTypeOrId: ElementRef, options?: ElementCreateOptions]
+  ): void;
+
+  /**
+   * Remove the element at a cell immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @param options - Optional removal flags.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.removeAtCell`
+   */
+  export function removeAtCell(
+    ...args: [...CellCoordinates, options?: ElementRemovalOptions]
+  ): void;
+
+  /**
+   * Move an element between cells immediately on this worker.
+   *
+   * @param fromCellX - Source cell column.
+   * @param fromCellY - Source cell row.
+   * @param toCellX - Destination cell column.
+   * @param toCellY - Destination cell row.
+   * @returns True when the move succeeded.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.moveBetweenCells`
+   */
+  export function moveBetweenCells(
+    fromCellX: number,
+    fromCellY: number,
+    toCellX: number,
+    toCellY: number
+  ): boolean;
+
+  /**
+   * Teleport an element between cells immediately on this worker.
+   *
+   * @param fromCellX - Source cell column.
+   * @param fromCellY - Source cell row.
+   * @param toCellX - Destination cell column.
+   * @param toCellY - Destination cell row.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.teleportBetweenCells`
+   */
+  export function teleportBetweenCells(
+    fromCellX: number,
+    fromCellY: number,
+    toCellX: number,
+    toCellY: number
+  ): void;
+
+  /**
+   * Swap elements between two cells immediately on this worker.
+   *
+   * @param firstCellX - First cell column.
+   * @param firstCellY - First cell row.
+   * @param secondCellX - Second cell column.
+   * @param secondCellY - Second cell row.
+   * @returns True when the swap succeeded.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.swapBetweenCells`
+   */
+  export function swapBetweenCells(
+    firstCellX: number,
+    firstCellY: number,
+    secondCellX: number,
+    secondCellY: number
+  ): boolean;
+
+  /**
+   * @deprecated Use {@link swapBetweenCells} instead.
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.elements.swapBetweenCells`
+   */
+  export function swapCells(
+    firstCellX: number,
+    firstCellY: number,
+    secondCellX: number,
+    secondCellY: number
+  ): boolean;
+
+  /**
+   * Mark an element index as movement-blocked for this tick.
+   *
+   * @param elementIndex - Element index from {@link getInfoAtCell}.
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.elements.markMovementBlockedByIndex`
+   */
+  export function markMovementBlockedByIndex(elementIndex: number): void;
+
+  /**
+   * @deprecated Use {@link markMovementBlockedByIndex} instead.
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.elements.markMovementBlockedByIndex`
+   */
+  export function markMovementBlockedByElementIndex(elementIndex: number): void;
+
+  /**
+   * Set particle velocity at a cell immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @param velocity - New velocity vector.
+   * @returns True when velocity was set.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.setVelocityAtCell`
+   */
+  export function setVelocityAtCell(...args: [...CellCoordinates, velocity: Vector2]): boolean;
+
+  /**
+   * Add velocity to a particle at a cell immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @param velocity - Velocity delta to add.
+   * @param maxSpeedCellsPerSecond - Optional speed cap after the addition.
+   * @returns True when velocity was updated.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.addParticleVelocityAtCell`
+   */
+  export function addParticleVelocityAtCell(
+    ...args: [...CellCoordinates, velocity: Vector2, maxSpeedCellsPerSecond?: number]
+  ): boolean;
+
+  /**
+   * Convert a cell element to a particle immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @param velocity - Initial particle velocity.
+   * @returns True when conversion succeeded.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.convertToParticleAtCell`
+   */
+  export function convertToParticleAtCell(...args: [...CellCoordinates, velocity: Vector2]): boolean;
+
+  /**
+   * Convert a particle back to a solid element immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @returns True when conversion succeeded.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.convertFromParticleAtCell`
+   */
+  export function convertFromParticleAtCell(...args: CellCoordinates): boolean;
+
+  /**
+   * Set a data field on the element at a cell immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @param fieldNumber - Data field index (1–4).
+   * @param value - New field value.
+   * @returns True when the field was set.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.setDataFieldAtCell`
+   */
+  export function setDataFieldAtCell(
+    ...args: [...CellCoordinates, fieldNumber: 1 | 2 | 3 | 4, value: number]
+  ): boolean;
+
+  /**
+   * Refresh the rendered color at a cell immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.refreshColorAtCell`
+   */
+  export function refreshColorAtCell(...args: CellCoordinates): void;
+
+  /**
+   * Set the physics skip mode at a cell immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @param physicsState - Physics skip flags for the element.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.setPhysicsAtCell`
+   */
+  export function setPhysicsAtCell(...args: [...CellCoordinates, physicsState: number]): void;
+
+  /**
+   * Set element duration at a cell immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @param durationTicks - Duration in simulation ticks.
+   * @param options - When `updateMax` is true, also update max duration.
+   * @returns True when duration was updated.
+   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.setDurationAtCell`
+   */
+  export function setDurationAtCell(
+    ...args: [...CellCoordinates, durationTicks: number, options?: { updateMax?: boolean; }]
+  ): boolean;
+}

package/src/worker/api/events.d.ts

@@ -0,0 +1,75 @@
+import type { elements as sharedElements } from "../../shared/api/elements";
+import type { LooseString } from "../../shared/nominal";
+
+/**
+ * Worker-thread `sandkit.api.events` — subscribe to and emit worker-scoped events.
+ *
+ * @internal Worker-only surface; do not use main-thread {@link sandkit.api.events}.
+ */
+export namespace events {
+  /**
+   * Subscribe to a worker event. Returns an unsubscribe function.
+   *
+   * @param eventId - Registered event name.
+   * @param callback - Called when the event is emitted.
+   * @param options - Required guard for filtered events.
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.events.on`
+   */
+  export function on<K extends EventId>(
+    eventId: K,
+    callback: (payload: EventPayload<K>) => void,
+    options?: EventOnOptions<K>,
+  ): () => void;
+
+  /**
+   * Emit a worker event with a payload to subscribers.
+   *
+   * @param eventId - Registered event name.
+   * @param payload - Serializable payload passed to listeners.
+   * @param options - Optional guard forwarded to filtered listeners.
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.events.emit`
+   */
+  export function emit<K extends EventId>(
+    eventId: K,
+    payload: EventPayload<K>,
+    options?: EventEmitOptions,
+  ): void;
+
+  /** Guard filter for worker events. */
+  export interface EventGuard {
+    /** Required when subscribing to `element:moved`. Optional on emit. */
+    elementType?: sharedElements.ElementType;
+    /** Required when subscribing to `terrain:updated`. Optional on emit. */
+    terrainType?: number;
+  }
+
+  /** Options for {@link on}. */
+  export type EventOnOptions<K extends EventId> =
+    K extends "element:moved"
+      ? { guard: { elementType: sharedElements.ElementType } }
+      : K extends "terrain:updated" | "terrain:update"
+        ? { guard: { terrainType: number } }
+        : { guard?: EventGuard };
+
+  /** Options for {@link emit}. */
+  export interface EventEmitOptions {
+    guard?: EventGuard;
+  }
+
+  /** Known worker event payloads. Unlisted ids still use `unknown`. */
+  export interface EventPayloadMap {
+    "element:moved": Record<string, unknown>;
+    "terrain:updated": Record<string, unknown>;
+    /** @deprecated Use `"terrain:updated"` instead. */
+    "terrain:update": EventPayloadMap["terrain:updated"];
+    "worker:update:post": Record<string, unknown>;
+    /** @deprecated Use `"worker:update:post"` instead. */
+    "update:post": EventPayloadMap["worker:update:post"];
+  }
+
+  /** Known worker event names plus any custom string id. */
+  export type EventId = LooseString<keyof EventPayloadMap>;
+
+  /** Event payload type for a given event id. */
+  export type EventPayload<K> = K extends keyof EventPayloadMap ? EventPayloadMap[K] : unknown;
+}

package/src/worker/api/fire.d.ts

@@ -0,0 +1,29 @@
+import type { CellCoordinates } from "../../shared/player";
+
+/**
+ * Worker-thread `sandkit.api.fire` — ignite and burn elements at grid cells.
+ *
+ * Worker burns are immediate. Main thread defers burns with `burnElementAtCell`.
+ *
+ * @internal Worker-only surface; do not use main-thread {@link sandkit.api.fire}.
+ */
+export namespace fire {
+  /**
+   * Return true when the element at the cell can burn.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.fire.canBurnElementAtCell`
+   */
+  export function canBurnElementAtCell(...args: CellCoordinates): boolean;
+
+  /**
+   * Burn the element at the cell immediately on this worker.
+   *
+   * @param cellX - Grid column of the target cell.
+   * @param cellY - Grid row of the target cell.
+   * @returns True when the burn succeeded.
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.fire.burnElementAtCell`
+   */
+  export function burnElementAtCell(...args: CellCoordinates): boolean;
+}

package/src/worker/api/grid.d.ts

@@ -0,0 +1,45 @@
+import { grid as sharedGrid } from "../../shared/api/grid";
+
+/**
+ * Worker-thread `sandkit.api.grid` — grid reads, activity, and excavation.
+ *
+ * Worker mutations are immediate. Main thread defers grid writes through `api.grid.mutate`.
+ *
+ * @internal Worker subset; do not import main-thread {@link sandkit.api.grid} iteration helpers here.
+ */
+export namespace grid {
+  /** Return the packed cell id at grid coordinates. */
+  export import getCellIdAtCell = sharedGrid.getCellIdAtCell;
+  /** Return true when the cell has no element or terrain content. */
+  export import isCellEmptyAtCell = sharedGrid.isCellEmptyAtCell;
+  /** Return true when the cell holds terrain (not an element). */
+  export import isTerrainAtCell = sharedGrid.isTerrainAtCell;
+  /** Mark the cell active for simulation this tick. */
+  export import reportActivityAtCell = sharedGrid.reportActivityAtCell;
+  /** Apply excavation damage and eject velocity at a cell. */
+  export import excavateAtCell = sharedGrid.excavateAtCell;
+  /** Return the world grid size in cells. */
+  export import getDimensions = sharedGrid.getDimensions;
+  /** Options for {@link excavateAtCell}. */
+  export import ExcavateOptions = sharedGrid.ExcavateOptions;
+  /** Packed cell id from {@link getCellIdAtCell}. */
+  export import CellId = sharedGrid.CellId;
+  /** World grid width and height in cells. */
+  export import GridDimensions = sharedGrid.GridDimensions;
+}
+
+/**
+ * @deprecated Use {@link grid} instead.
+ * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid`
+ */
+export namespace world {
+  export import getCellIdAtCell = grid.getCellIdAtCell;
+  export import isCellEmptyAtCell = grid.isCellEmptyAtCell;
+  export import isTerrainAtCell = grid.isTerrainAtCell;
+  export import reportActivityAtCell = grid.reportActivityAtCell;
+  export import excavateAtCell = grid.excavateAtCell;
+  export import getDimensions = grid.getDimensions;
+  export import ExcavateOptions = grid.ExcavateOptions;
+  export import CellId = grid.CellId;
+  export import GridDimensions = grid.GridDimensions;
+}

package/src/worker/api/hooks.d.ts

@@ -0,0 +1,111 @@
+import type { elements as sharedElements } from "../../shared/api/elements";
+import type { LooseString } from "../../shared/nominal";
+
+/**
+ * Worker-thread `sandkit.api.hooks` — intercept and modify simulation hook points.
+ *
+ * @internal Worker-only surface; do not use main-thread {@link sandkit.api.hooks}.
+ */
+export namespace hooks {
+  /**
+   * Register an intercept hook on this worker. Returns an unsubscribe function.
+   *
+   * @param hookId - Registered hook identifier.
+   * @param callback - Called with hook arguments and context; may cancel the hook.
+   * @param options - Optional guard and priority.
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.hooks.intercept`
+   */
+  export function intercept<K extends InterceptHookId>(
+    hookId: K,
+    callback: (args: InterceptHookArgs<K>, context: HookContext) => void,
+    options?: InterceptHookOptions<K>,
+  ): () => void;
+
+  /**
+   * Register a modifier hook on this worker. Returns an unsubscribe function.
+   *
+   * @param hookId - Registered hook identifier.
+   * @param callback - Called with hook arguments; may mutate hook payload.
+   * @param options - Optional guard and priority.
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.hooks.modify`
+   */
+  export function modify<K extends ModifyHookId>(
+    hookId: K,
+    callback: (args: ModifyHookArgs<K>) => void,
+    options?: ModifyHookOptions,
+  ): () => void;
+
+  /** Context passed to intercept hook callbacks. */
+  export interface HookContext {
+    /** When called, the intercepted action is skipped. */
+    cancel(): void;
+    /** True after {@link cancel} was called on this context. */
+    cancelled: boolean;
+  }
+
+  /** Guard filter for worker hook registration. */
+  export interface HookGuard {
+    /** Required for element-scoped intercept hooks and optional on emit. */
+    elementType?: sharedElements.ElementType;
+    /** Required for terrain-scoped event guards; optional on emit. */
+    terrainType?: number;
+  }
+
+  /** Options for {@link intercept}. */
+  export type InterceptHookOptions<K extends InterceptHookId> =
+    K extends ElementGuardedInterceptHookId
+      ? { guard: { elementType: sharedElements.ElementType }; priority?: number }
+      : { guard?: HookGuard; priority?: number };
+
+  /** Options for {@link modify}. */
+  export interface ModifyHookOptions {
+    guard?: HookGuard;
+    priority?: number;
+  }
+
+  /** Intercept hook ids with a required element guard. */
+  export type ElementGuardedInterceptHookId =
+    | "cell:process"
+    | "element:update"
+    | "element:move:blocked"
+    | "element:blocked"
+    | "element:duration:expire"
+    | "element:duration";
+
+  /** Known worker intercept hook ids plus custom strings. */
+  export type InterceptHookId = LooseString<
+    | ElementGuardedInterceptHookId
+    | "element:move"
+    | "fire:element:burn"
+    | "shaker:elementOn"
+  >;
+
+  /** Known worker modify hook ids plus custom strings. */
+  export type ModifyHookId = LooseString<string>;
+
+  /** Intercept hook argument shapes keyed by hook id. */
+  export interface InterceptHookMap {
+    "cell:process": Record<string, unknown>;
+    "element:update": Record<string, unknown>;
+    "element:move": Record<string, unknown>;
+    "element:move:blocked": Record<string, unknown>;
+    /** @deprecated Use `"element:move:blocked"` instead. */
+    "element:blocked": InterceptHookMap["element:move:blocked"];
+    "element:duration:expire": Record<string, unknown>;
+    /** @deprecated Use `"element:duration:expire"` instead. */
+    "element:duration": InterceptHookMap["element:duration:expire"];
+    "fire:element:burn": Record<string, unknown>;
+    "shaker:elementOn": Record<string, unknown>;
+  }
+
+  /** Modify hook argument shapes keyed by hook id. Unlisted ids use `unknown`. */
+  export type ModifyHookMap = Record<string, unknown>;
+
+  /** Intercept hook args for a given hook id. */
+  export type InterceptHookArgs<K extends InterceptHookId> =
+    K extends keyof InterceptHookMap ? InterceptHookMap[K] : unknown;
+
+  /** Modify hook args for a given hook id. */
+  export type ModifyHookArgs<K extends ModifyHookId> =
+    K extends keyof ModifyHookMap ? ModifyHookMap[K] : unknown;
+}

package/src/worker/api/lights.d.ts

@@ -0,0 +1,43 @@
+import type { shared } from "../../shared";
+
+/**
+ * Worker-thread `sandkit.api.lights` — temporary visual effect lights.
+ *
+ * @internal Worker exposes only {@link temporary}; persistent lights are main-thread only.
+ */
+export namespace lights {
+  /**
+   * Short-lived visual effect lights.
+   *
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.lights.temporary`
+   */
+  export namespace temporary {
+    /** Options for {@link createAtWorld}. */
+    export type TemporaryLightOptions = shared.api.effects.TemporaryLightOptions;
+
+    /** Handle returned by {@link createAtWorld}. */
+    export interface TemporaryLightHandle {
+      /** Runtime light id, or null when the pool is full. */
+      lightId: number | null;
+      /**
+       * @deprecated Use {@link lightId} instead.
+       * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `light.lightId`
+       */
+      index?: number | null;
+    }
+
+    /**
+     * Create a temporary light at world coordinates.
+     *
+     * @param worldX - World x position in pixels.
+     * @param worldY - World y position in pixels.
+     * @param options - Brightness, duration, colour, and dedup settings.
+     * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.lights.temporary.createAtWorld`
+     */
+    export function createAtWorld(
+      worldX: number,
+      worldY: number,
+      options?: TemporaryLightOptions,
+    ): TemporaryLightHandle;
+  }
+}

package/{worker → src/worker}/api/shared.d.ts

@@ -23,16 +23,21 @@ export namespace shared {
      *
      * @param key - Buffer name shared across threads.
      * @param config - Expected array type and length for validation.
+     * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.shared.buffers.require`
      */
     export function require(key: string, config: { type: SharedArrayType; length: number; }): SharedArray;
+
     /**
      * Read an existing buffer without validating type or length.
+     *
      * @param key - Buffer name shared across threads.
+     * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.shared.buffers.get`
      */
-    export import get = sharedApi.api.shared.buffers.get
+    export import get = sharedApi.api.shared.buffers.get;
   }
+
   /** Typed array backing store for a shared buffer. */
-  export import SharedArray = sharedApi.api.shared.SharedArray
+  export import SharedArray = sharedApi.api.shared.SharedArray;
   /** Discriminator for the underlying typed array kind. */
-  export import SharedArrayType = sharedApi.api.shared.SharedArrayType
+  export import SharedArrayType = sharedApi.api.shared.SharedArrayType;
 }

package/{worker → src/worker}/index.d.ts

@@ -11,19 +11,22 @@ export * from "./api/main"
 export * from "./api/shared"
 export * from "./api/worker"
 export * from "./api/elements"
+export * from "./api/hooks"
+export * from "./api/events"
+export * from "./api/effects"
+export * from "./api/fire"
+export * from "./api/grid"
+export * from "./api/lights"
 
-// Shared files
 export * from "../sandkit/api/collector"
-export * from "../sandkit/api/fire"
-export * from "../sandkit/api/hooks"
-export * from "../shared/api/maps"
+export * from "../sandkit/api/constants"
 export * from "../sandkit/api/patterns"
+export * from "../shared/api/maps"
 export * from "../shared/api/player"
 export * from "../sandkit/api/random"
 export * from "../shared/api/structures"
 export * from "../shared/api/terrains"
 export * from "../shared/api/ui"
 export * from "../sandkit/api/utils"
-export * from "../shared/api/world"
 
 export type { WorkerSandkitApi } from "./sandkit-api"

package/{worker → src/worker}/sandkit-api.d.ts

@@ -12,10 +12,15 @@
  * {@link sandkit.SandkitApi} on worker threads.
  */
 export type WorkerSandkitApi = {
+  constants: typeof import("../sandkit/api/constants").constants;
   collector: typeof import("../sandkit/api/collector").collector;
+  effects: typeof import("./api/effects").effects;
   elements: typeof import("./api/elements").elements;
-  fire: typeof import("../sandkit/api/fire").fire;
-  hooks: typeof import("../sandkit/api/hooks").hooks;
+  events: typeof import("./api/events").events;
+  fire: typeof import("./api/fire").fire;
+  grid: typeof import("./api/grid").grid;
+  hooks: typeof import("./api/hooks").hooks;
+  lights: typeof import("./api/lights").lights;
   main: typeof import("./api/main").main;
   maps: typeof import("../shared/api/maps").maps;
   patterns: typeof import("../sandkit/api/patterns").patterns;
@@ -27,5 +32,9 @@ export type WorkerSandkitApi = {
   ui: typeof import("../shared/api/ui").ui;
   utils: typeof import("../sandkit/api/utils").utils;
   worker: typeof import("./api/worker").worker;
-  world: typeof import("../shared/api/world").world;
+  /**
+   * @deprecated Use {@link grid} instead.
+   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid`
+   */
+  world: typeof import("./api/grid").world;
 };