@automatajs/core 0.2.0

package/dist/types.d.ts

@@ -0,0 +1,113 @@
+export type NeighborhoodType = "moore" | "vonneumann";
+export interface GridOptions {
+    /** Enable toroidal wrapping (default: true) */
+    wrap?: boolean;
+    /** Neighborhood type (default: "moore") */
+    neighborhood?: NeighborhoodType;
+}
+/**
+ * RGBA color tuple: [red, green, blue, alpha], each 0–255.
+ */
+export type RGBA = [number, number, number, number];
+/**
+ * Context object passed to each cell during a rule evaluation.
+ * Provides easy access to the cell's own state, its neighbors,
+ * and the ability to read any cell on the grid.
+ */
+export interface CellContext {
+    /** Current state of this cell (0 = dead, 1+ = alive / multi-state) */
+    self: number;
+    /** Column coordinate */
+    x: number;
+    /** Row coordinate */
+    y: number;
+    /** Number of alive neighbors (count of neighbors with state > 0) */
+    neighborCount: number;
+    /** Array of individual neighbor state values (Moore: 8, Von Neumann: 4) */
+    neighbors: number[];
+    /** Read any cell on the grid by coordinate */
+    get(x: number, y: number): number;
+    /** Grid width */
+    cols: number;
+    /** Grid height */
+    rows: number;
+}
+/**
+ * Style function signature.
+ * Determines the visual appearance of a cell based on its state and context.
+ * Return an RGBA color tuple, a CSS color string, or a boolean (true = alive color).
+ *
+ * @param state - Current state of the cell
+ * @param ctx - Cell context with position and grid access
+ * @returns RGBA tuple, CSS color string, or boolean
+ *
+ * @example
+ * ```ts
+ * // Fade based on neighbor density
+ * const heatmap: StyleFunction = (state, ctx) => {
+ *   const intensity = Math.floor((ctx.neighborCount / 8) * 255);
+ *   return [intensity, 50, 255 - intensity, 255];
+ * };
+ * ```
+ */
+export type StyleFunction = (state: number, ctx: CellContext) => RGBA | string | boolean;
+export interface AutomataOptions extends GridOptions {
+    /** Number of columns */
+    cols?: number;
+    /** Number of rows */
+    rows?: number;
+    /** Frames per second (default: 10) */
+    fps?: number;
+    /** Color for alive cells (default: "#22d3ee") */
+    aliveColor?: string;
+    /** Color for dead cells (default: "#0f172a") */
+    deadColor?: string;
+    /** Background color (default: "#020617") */
+    backgroundColor?: string;
+    /** Show grid lines (default: true) */
+    showGridLines?: boolean;
+    /** Grid line color (default: "#1e293b") */
+    gridLineColor?: string;
+    /** Cell size in pixels (auto-calculated if omitted) */
+    cellSize?: number;
+    /** Rule function — determines next state for each cell */
+    rule?: RuleFunction;
+    /** Style function — determines visual appearance per cell (optional) */
+    style?: StyleFunction;
+}
+/**
+ * Rule function signature.
+ *
+ * Receives a CellContext with everything you need: self state, neighbor
+ * values, neighbor count, coordinates, and a grid accessor.
+ *
+ * Also supports the legacy positional signature for backward compatibility:
+ * `(neighbors, currentState, x, y, grid) => number`
+ *
+ * @param ctx - Cell context object
+ * @returns New state for the cell (0 = dead, 1+ = alive)
+ *
+ * @example
+ * ```ts
+ * // Game of Life using CellContext
+ * const gol: RuleFunction = (ctx) => {
+ *   if (ctx.self === 1) {
+ *     return ctx.neighborCount === 2 || ctx.neighborCount === 3 ? 1 : 0;
+ *   }
+ *   return ctx.neighborCount === 3 ? 1 : 0;
+ * };
+ *
+ * // Access individual neighbor values
+ * const custom: RuleFunction = (ctx) => {
+ *   const aliveAbove = ctx.get(ctx.x, ctx.y - 1);
+ *   return aliveAbove ? 1 : 0;
+ * };
+ * ```
+ */
+export type RuleFunction = ((ctx: CellContext) => number) | ((neighbors: number, currentState: number, x?: number, y?: number, grid?: Uint8Array) => number);
+export type CellCallback = (x: number, y: number, state: number) => void;
+export interface ExportOptions {
+    scale?: number;
+    format?: "png" | "jpeg";
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,YAAY,CAAC;AAEtD,MAAM,WAAW,WAAW;IAC1B,+CAA+C;IAC/C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,2CAA2C;IAC3C,YAAY,CAAC,EAAE,gBAAgB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAEpD;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,CAAC,EAAE,MAAM,CAAC;IACV,qBAAqB;IACrB,CAAC,EAAE,MAAM,CAAC;IACV,oEAAoE;IACpE,aAAa,EAAE,MAAM,CAAC;IACtB,2EAA2E;IAC3E,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,8CAA8C;IAC9C,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,aAAa,GAAG,CAC1B,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,WAAW,KACb,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC;AAE7B,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4CAA4C;IAC5C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sCAAsC;IACtC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,2CAA2C;IAC3C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,wEAAwE;IACxE,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,MAAM,YAAY,GACpB,CAAC,CAAC,GAAG,EAAE,WAAW,KAAK,MAAM,CAAC,GAC9B,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,KAAK,MAAM,CAAC,CAAC;AAErG,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzE,MAAM,WAAW,aAAa;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACzB"}

package/dist/types.js

@@ -0,0 +1,3 @@
+// ─── Type Definitions for automata.js ───
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,2CAA2C"}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@automatajs/core",
+  "version": "0.2.0",
+  "description": "A focused cellular automata engine for the browser",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "author": "alex <alex@n3m3th.com>",
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "readme": "cd ../.. && npm run readme",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  },
+  "license": "MIT"
+}