@guinetik/gcanvas 1.0.0

package/types/index.d.ts

@@ -0,0 +1,309 @@
+/**
+ * GCanvas - TypeScript Definitions
+ * A minimalist 2D canvas rendering library with shapes, game engine, and animations.
+ *
+ * @version 0.0.3-alpha
+ * @see https://github.com/guinetik/gcanvas
+ * @license ISC
+ */
+
+// ==========================================================================
+// Common Types (re-exported for direct import)
+// ==========================================================================
+
+export {
+  // Basic types
+  Point,
+  Bounds,
+  EasingFunction,
+  EventCallback,
+
+  // Motion types
+  MotionCallbacks,
+  MotionState,
+  MotionResult,
+  MotionPositionResult,
+  MotionValueResult,
+  SpringResult,
+  WaypointResult,
+
+  // Layout types
+  LayoutOptions,
+  LayoutResult,
+
+  // Penrose types
+  RGBAColor,
+  PenroseTilingOptions
+} from './common';
+
+// ==========================================================================
+// Logger Module
+// ==========================================================================
+
+export {
+  Logger,
+  Loggable,
+  LoggableOptions,
+  DebugTab
+} from './logger';
+
+// ==========================================================================
+// Shapes Module
+// ==========================================================================
+
+export {
+  // Base classes
+  Euclidian,
+  EuclidianOptions,
+  Geometry2d,
+  Geometry2dOptions,
+  Traceable,
+  Renderable,
+  RenderableOptions,
+  Transformable,
+  TransformableOptions,
+  Transform,
+  TransformProps,
+  Shape,
+  ShapeOptions,
+  Group,
+  GroupOptions,
+
+  // Basic shapes
+  Circle,
+  Rectangle,
+  RoundedRectangle,
+  RoundedRectangleOptions,
+  Square,
+  Arc,
+  ArcOptions,
+  Line,
+  Triangle,
+  Star,
+  StarOptions,
+  Polygon,
+  Hexagon,
+  Diamond,
+  Cross,
+  Heart,
+  Ring,
+  RingOptions,
+  Cloud,
+  Pin,
+  Arrow,
+  PieSlice,
+  PieSliceOptions,
+  BezierShape,
+  SVGShape,
+  StickFigure,
+  PatternRectangle,
+  PatternRectangleOptions,
+  ImageShape,
+  ImageShapeOptions,
+
+  // 2.5D shapes
+  Cube,
+  CubeOptions,
+  Cylinder,
+  Cone,
+  Prism,
+  Sphere,
+
+  // Text shapes
+  TextShape,
+  TextShapeOptions,
+  OutlinedText,
+  OutlinedTextOptions,
+  WrappedText
+} from './shapes';
+
+// ==========================================================================
+// Painter Module
+// ==========================================================================
+
+export {
+  Painter,
+  PainterColors,
+  PainterEffects,
+  PainterImages,
+  PainterLines,
+  PainterOpacity,
+  PainterShapes,
+  PainterText
+} from './painter';
+
+// ==========================================================================
+// IO Module
+// ==========================================================================
+
+export {
+  EventEmitter,
+  Mouse,
+  Keys,
+  Touch,
+  Input
+} from './io';
+
+// ==========================================================================
+// Game Module
+// ==========================================================================
+
+export {
+  Game,
+  Pipeline,
+  GameObject,
+  GameObjectOptions,
+  Scene,
+  SceneOptions,
+  GameObjectShapeWrapper,
+  ShapeGOFactory,
+  Text,
+  TextGameObjectOptions,
+  ImageGo,
+
+  // Layout scenes
+  LayoutScene,
+  HorizontalLayout,
+  VerticalLayout,
+  TileLayout,
+  GridLayout,
+
+  // UI components
+  Button,
+  ButtonOptions,
+  ToggleButton,
+  Cursor,
+  CursorOptions,
+  FPSCounter
+} from './game';
+
+// ==========================================================================
+// Motion Module
+// ==========================================================================
+
+export {
+  Easing,
+  Tween,
+  Tweenetik,
+  TweenetikOptions,
+  Motion,
+  SpringParams,
+  PositionTarget
+} from './motion';
+
+// ==========================================================================
+// Math Module
+// ==========================================================================
+
+export {
+  Random,
+  Complex,
+  Fractals,
+  Patterns,
+  Noise,
+  generatePenroseTilingPixels
+} from './math';
+
+// ==========================================================================
+// Util Module
+// ==========================================================================
+
+export {
+  ZOrderedCollection,
+  ZOrderedCollectionOptions,
+  Position,
+  TaskManager,
+
+  // Layout types
+  LayoutItem,
+  ApplyLayoutOptions,
+  LinearLayoutOptions,
+  TileLayoutOptions,
+  GridLayoutOptions,
+
+  // Layout functions
+  applyLayout,
+  horizontalLayout,
+  verticalLayout,
+  tileLayout,
+  gridLayout
+} from './util';
+
+// ==========================================================================
+// Mixins Module
+// ==========================================================================
+
+export {
+  applyDraggable,
+  DraggableOptions,
+  applyAnchor,
+  AnchorOptions
+} from './mixins';
+
+// ==========================================================================
+// Sound Module
+// ==========================================================================
+
+export {
+  // Main classes
+  Synth,
+  Sound,
+
+  // Sub-modules
+  SynthOscillators,
+  SynthEffects,
+  SynthEnvelope,
+  SynthNoise,
+  SynthMusical,
+  SynthAnalyzer,
+
+  // Types
+  SynthOptions,
+  ToneOptions,
+  ContinuousOscillatorController,
+  DelayEffect,
+  TremoloEffect,
+  DroneController,
+  EnvelopeOptions,
+  EnvelopePresets,
+  ScaleName,
+  ChordType
+} from './sound';
+
+// ==========================================================================
+// Collision Module
+// ==========================================================================
+
+export {
+  // Main classes
+  Collision,
+  CollisionSystem,
+
+  // Types
+  CollisionCircle,
+  LineSegment,
+  SweepResult,
+  OverlapResult,
+  MTVResult,
+  Collidable,
+  CollisionPairOptions,
+  CollisionCallback
+} from './collision';
+
+// ==========================================================================
+// State Module
+// ==========================================================================
+
+export {
+  // Main class
+  StateMachine,
+
+  // Types
+  StateTransition,
+  StateEvents,
+  StateConfig,
+  States,
+  StateMachineOptions,
+  PhaseConfig,
+  SequenceOptions
+} from './state';

package/types/io.d.ts

@@ -0,0 +1,188 @@
+/**
+ * GCanvas IO Module
+ * Input handling and event system.
+ * @module io
+ */
+
+import { EventCallback } from './common';
+import type { Game } from './game';
+
+// ==========================================================================
+// Event Emitter
+// ==========================================================================
+
+/**
+ * Core event management system.
+ * Provides publish/subscribe pattern for custom events.
+ *
+ * @example
+ * const emitter = new EventEmitter();
+ * emitter.on('explosion', (data) => console.log('Boom!', data));
+ * emitter.emit('explosion', { x: 100, y: 200 });
+ */
+export class EventEmitter {
+  /** Map of event types to listener arrays */
+  listeners: Record<string, EventCallback[]>;
+
+  constructor();
+
+  /**
+   * Subscribe to an event.
+   * @param type - Event type/name
+   * @param callback - Handler function
+   */
+  on<T = any>(type: string, callback: EventCallback<T>): void;
+
+  /**
+   * Unsubscribe from an event.
+   * @param type - Event type/name
+   * @param callback - Handler function to remove
+   */
+  off<T = any>(type: string, callback: EventCallback<T>): void;
+
+  /**
+   * Emit an event to all subscribers.
+   * @param type - Event type/name
+   * @param payload - Data to pass to handlers
+   */
+  emit<T = any>(type: string, payload?: T): void;
+}
+
+// ==========================================================================
+// Mouse Input
+// ==========================================================================
+
+/**
+ * Mouse input tracking.
+ * Static class that tracks mouse position and button state.
+ *
+ * @example
+ * // After initialization
+ * if (Mouse.isDown) {
+ *   console.log(`Mouse clicked at ${Mouse.x}, ${Mouse.y}`);
+ * }
+ */
+export class Mouse {
+  /** Current mouse X position relative to canvas */
+  static x: number;
+  /** Current mouse Y position relative to canvas */
+  static y: number;
+  /** Whether primary mouse button is pressed */
+  static isDown: boolean;
+
+  /**
+   * Initialize mouse tracking for a game instance.
+   * @param game - Game instance to track mouse on
+   */
+  static init(game: Game): void;
+}
+
+// ==========================================================================
+// Keyboard Input
+// ==========================================================================
+
+/**
+ * Keyboard input with key mapping.
+ * Static class that tracks key states with named constants.
+ *
+ * @example
+ * if (Keys.isDown(Keys.SPACE)) {
+ *   player.jump();
+ * }
+ * if (Keys.isDown('a') || Keys.isDown(Keys.LEFT)) {
+ *   player.moveLeft();
+ * }
+ */
+export class Keys {
+  // Key constants
+  /** Left arrow key */
+  static readonly LEFT: string;
+  /** Right arrow key */
+  static readonly RIGHT: string;
+  /** Up arrow key */
+  static readonly UP: string;
+  /** Down arrow key */
+  static readonly DOWN: string;
+  /** Spacebar */
+  static readonly SPACE: string;
+  /** Enter key */
+  static readonly ENTER: string;
+  /** Escape key */
+  static readonly ESCAPE: string;
+  /** Shift key */
+  static readonly SHIFT: string;
+  /** Control key */
+  static readonly CTRL: string;
+  /** Alt key */
+  static readonly ALT: string;
+
+  /**
+   * Initialize keyboard tracking for a game instance.
+   * @param game - Game instance
+   */
+  static init(game: Game): void;
+
+  /**
+   * Check if a key is currently pressed.
+   * @param key - Key code or Key constant
+   * @returns Whether the key is down
+   */
+  static isDown(key: string): boolean;
+}
+
+// ==========================================================================
+// Touch Input
+// ==========================================================================
+
+/**
+ * Touch input handling for mobile devices.
+ * Static class that tracks touch position and state.
+ *
+ * @example
+ * if (Touch.isDown) {
+ *   console.log(`Touch at ${Touch.x}, ${Touch.y}`);
+ * }
+ */
+export class Touch {
+  /** Current touch X position relative to canvas */
+  static x: number;
+  /** Current touch Y position relative to canvas */
+  static y: number;
+  /** Whether screen is being touched */
+  static isDown: boolean;
+
+  /**
+   * Initialize touch tracking for a game instance.
+   * @param game - Game instance
+   */
+  static init(game: Game): void;
+}
+
+// ==========================================================================
+// Unified Input
+// ==========================================================================
+
+/**
+ * Unified input system (mouse + touch normalization).
+ * Provides a single interface for both mouse and touch input.
+ *
+ * @example
+ * // Works with both mouse and touch
+ * if (Input.isDown) {
+ *   console.log(`Pointer at ${Input.x}, ${Input.y}`);
+ * }
+ */
+export class Input {
+  /** Current pointer X position (mouse or touch) */
+  static x: number;
+  /** Current pointer Y position (mouse or touch) */
+  static y: number;
+  /** Whether pointer is active (mouse down or touching) */
+  static isDown: boolean;
+
+  /**
+   * Initialize unified input for a game instance.
+   * @param game - Game instance
+   */
+  static init(game: Game): void;
+}

package/types/logger.d.ts

@@ -0,0 +1,127 @@
+/**
+ * GCanvas Logger Module
+ * Logging utilities and debug visualization.
+ * @module logger
+ */
+
+// ==========================================================================
+// Logger Class
+// ==========================================================================
+
+/**
+ * Logger class for debugging and console output.
+ * Provides named loggers with configurable levels and output.
+ */
+export class Logger {
+  /** Debug log level */
+  static DEBUG: number;
+  /** Info log level */
+  static INFO: number;
+  /** Warning log level */
+  static WARN: number;
+  /** Error log level */
+  static ERROR: number;
+
+  /**
+   * Creates a new Logger instance.
+   * @param name - The name/category for this logger
+   */
+  constructor(name: string);
+
+  /** Log a debug message */
+  log(...args: any[]): void;
+  /** Log an info message */
+  info(...args: any[]): void;
+  /** Log a warning message */
+  warn(...args: any[]): void;
+  /** Log an error message */
+  error(...args: any[]): void;
+  /** Start a collapsed console group */
+  groupCollapsed(label: string): void;
+  /** End a console group */
+  groupEnd(): void;
+  /** Start a timer with the given label */
+  time(label: string): void;
+  /** End and log a timer */
+  timeEnd(label: string): void;
+
+  /**
+   * Get or create a logger with the given name.
+   * @param name - Logger name/category
+   */
+  static getLogger(name: string): Logger;
+  /** Set the global log level */
+  static setLevel(level: number): void;
+  /** Set the output target (console or custom object) */
+  static setOutput(output: Console | object): void;
+  /** Enable all loggers */
+  static enable(): void;
+  /** Disable all loggers */
+  static disable(): void;
+  /** Enable all loggers (alias) */
+  static enableAll(): void;
+  /** Disable all loggers (alias) */
+  static disableAll(): void;
+  /** Enable a specific logger by name */
+  static enableFor(name: string): void;
+  /** Disable a specific logger by name */
+  static disableFor(name: string): void;
+}
+
+// ==========================================================================
+// Loggable Base Class
+// ==========================================================================
+
+/** Options for Loggable constructor */
+export interface LoggableOptions {
+  /** Name for the logger instance */
+  name?: string;
+}
+
+/**
+ * Base class that provides logging capabilities to subclasses.
+ * Extend this class to add automatic logging support.
+ */
+export class Loggable {
+  /** Instance name */
+  name: string;
+  /** @internal Logger instance */
+  protected _logger: Logger;
+
+  /**
+   * Creates a new Loggable instance.
+   * @param options - Configuration options
+   */
+  constructor(options?: LoggableOptions);
+
+  /** Get the logger instance for this object */
+  get logger(): Logger;
+
+  /**
+   * Log a trace message with optional custom text.
+   * @param msg - Optional message to include
+   */
+  trace(msg?: string): void;
+
+  /**
+   * Get or create a logger for this instance.
+   * @param options - Logger options
+   * @internal
+   */
+  protected getLogger(options?: LoggableOptions): Logger;
+}
+
+// ==========================================================================
+// Debug Tab
+// ==========================================================================
+
+/**
+ * Debug visualization panel for runtime inspection.
+ * Singleton class that provides on-screen debug information.
+ */
+export class DebugTab {
+  /**
+   * Get the singleton DebugTab instance.
+   */
+  static getInstance(): DebugTab;
+}