@fugood/bricks-project 2.24.0-beta.2 → 2.24.0-beta.21

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@fugood/bricks-project",
-  "version": "2.24.0-beta.2",
+  "version": "2.24.0-beta.21",
   "main": "index.ts",
   "scripts": {
+    "typecheck": "tsc --noEmit",
     "build": "bun scripts/build.js"
   },
   "dependencies": {
-    "@fugood/bricks-cli": "^2.24.0-beta.2",
+    "@fugood/bricks-cli": "^2.24.0-beta.21",
     "@huggingface/gguf": "^0.3.2",
     "@iarna/toml": "^3.0.0",
     "@modelcontextprotocol/sdk": "^1.15.0",
     "@toon-format/toon": "^2.1.0",
+    "@types/bun": "^1.3.9",
     "@types/escodegen": "^0.0.10",
     "@types/lodash": "^4.17.12",
     "acorn": "^8.13.0",
@@ -19,5 +21,8 @@
     "lodash": "^4.17.4",
     "uuid": "^8.3.1"
   },
-  "gitHead": "f63649f1cb9ae4c3d0c4ac687152bfc1be6528bd"
+  "peerDependencies": {
+    "oxfmt": "^0.36.0"
+  },
+  "gitHead": "589c6464a2e195961d5904f31e8b2b12c7aff9c7"
 }

package/skills/bricks-project/rules/architecture-patterns.md

@@ -37,6 +37,13 @@ Built-in commands for direct state and UI changes.
 ### Data Calculation (Priority 4)
 ONLY for deriving, formatting, or aggregating values from other data. Not for orchestration, side effects, or flow control.
 
+## Entity Aliases
+
+Set `alias` on entities to give them a stable, human-readable name:
+- Code generation uses alias as the variable name (e.g., `alias: 'submitBtn'` → `export const submitBtn`)
+- At runtime, devtools MCP tools accept alias instead of short ID and selectors can match by alias. Note: bricks-project does not directly interact with devtools MCP — aliases here primarily affect code generation
+- Aliases must be unique across the application — duplicates are excluded from resolution
+
 ## Flow Decomposition
 
 When the user describes a complex flow, decompose it BEFORE writing code:

package/skills/bricks-project/rules/automations.md

@@ -4,15 +4,16 @@ E2E testing and scheduled execution for BRICKS applications. Simulates user beha
 
 ## Automation Types
 
-| Type | Description |
-|------|-------------|
-| `launch` | Run on application launch (restarts app when run manually) |
-| `anytime` | Execute anytime via manual trigger |
-| `cron` | Scheduled execution using crontab expressions |
+| Type      | Description                                                |
+| --------- | ---------------------------------------------------------- |
+| `launch`  | Run on application launch (restarts app when run manually) |
+| `anytime` | Execute anytime via manual trigger                         |
+| `cron`    | Scheduled execution using crontab expressions              |
 
 ## Simulation Actions
 
 Automations can simulate:
+
 - **Brick Press**: Tap/click on bricks
 - **Key Events**: Key up/down for keyboard input
 - **HTTP Request**: API calls
@@ -21,6 +22,7 @@ Automations can simulate:
 ## Assertions
 
 Automations can validate:
+
 - **Brick Exists**: Check if brick is rendered
 - **Event Triggered**: Verify event from Brick/Generator/Canvas
 - **Canvas Changed**: Confirm canvas navigation
@@ -33,14 +35,14 @@ Automations can validate:
 ```typescript
 const testLoginFlow: AutomationTest = {
   __typename: 'AutomationTest',
-  id: 'test-login-flow',
+  id: makeId('test'),
   title: 'Test Login Flow',
   timeout: 30000,
   trigger_type: 'launch',
   cases: [
     {
       __typename: 'TestCase',
-      id: 'wait-login-canvas',
+      id: makeId('test_case'),
       name: 'Wait for login canvas',
       run: ['wait_until_canvas_change', () => mainSubspace, () => loginCanvas, 5000],
       exit_on_failed: true,
@@ -51,7 +53,7 @@ const testLoginFlow: AutomationTest = {
     },
     {
       __typename: 'TestCase',
-      id: 'press-username',
+      id: makeId('test_case'),
       name: 'Press username input',
       run: ['brick_press', () => mainSubspace, () => usernameInput],
       exit_on_failed: true,
@@ -62,7 +64,7 @@ const testLoginFlow: AutomationTest = {
     },
     {
       __typename: 'TestCase',
-      id: 'assert-username',
+      id: makeId('test_case'),
       name: 'Assert username value',
       run: ['assert_property', () => mainSubspace, () => usernameData, 'testuser'],
       exit_on_failed: true,
@@ -73,7 +75,7 @@ const testLoginFlow: AutomationTest = {
     },
     {
       __typename: 'TestCase',
-      id: 'press-login',
+      id: makeId('test_case'),
       name: 'Press login button',
       run: ['brick_press', () => mainSubspace, () => loginButton],
       exit_on_failed: true,
@@ -84,7 +86,7 @@ const testLoginFlow: AutomationTest = {
     },
     {
       __typename: 'TestCase',
-      id: 'wait-dashboard',
+      id: makeId('test_case'),
       name: 'Wait for dashboard',
       run: ['wait_until_canvas_change', () => mainSubspace, () => dashboardCanvas, 10000],
       exit_on_failed: true,
@@ -100,25 +102,58 @@ const testLoginFlow: AutomationTest = {
 
 ## Test Methods
 
-| Method | Signature | Description |
-|--------|-----------|-------------|
-| `brick_press` | `[subspace, brick, options?]` | Simulate brick press |
-| `brick_exists` | `[subspace, brick, frame?]` | Check brick exists |
-| `wait_until_brick_exists` | `[subspace, brick, timeout?, frame?]` | Wait for brick |
-| `wait_until_event_trigger` | `[subspace, sender, eventKey, timeout?]` | Wait for event |
-| `wait_until_canvas_change` | `[subspace, canvas, timeout?]` | Wait for canvas |
-| `keydown` | `[keyCode, pressedKey?, flags?]` | Key down event |
-| `keyup` | `[keyCode, pressedKey?, flags?]` | Key up event |
-| `http_request` | `[url, options?]` | HTTP request |
-| `assert_property` | `[subspace, property, value]` | Assert data value |
-| `wait_until_property_change` | `[subspace, property, value, timeout?]` | Wait for value |
-| `execute_action` | `[subspace, handler, action, params?, options?]` | Execute action |
-| `match_screenshot` | `[name, threshold?, maxRetry?]` | Screenshot compare |
-| `delay` | `[subspace?, property?, defaultValue?]` | Delay execution |
+| Method                       | Signature                                        | Description          |
+| ---------------------------- | ------------------------------------------------ | -------------------- |
+| `brick_press`                | `[subspace, brick, options?]`                    | Simulate brick press |
+| `brick_exists`               | `[subspace, brick, frame?]`                      | Check brick exists   |
+| `wait_until_brick_exists`    | `[subspace, brick, timeout?, frame?]`            | Wait for brick       |
+| `wait_until_event_trigger`   | `[subspace, sender, eventKey, timeout?]`         | Wait for event       |
+| `wait_until_canvas_change`   | `[subspace, canvas, timeout?]`                   | Wait for canvas      |
+| `keydown`                    | `[keyCode, pressedKey?, flags?]`                 | Key down event       |
+| `keyup`                      | `[keyCode, pressedKey?, flags?]`                 | Key up event         |
+| `http_request`               | `[url, options?]`                                | HTTP request         |
+| `assert_property`            | `[subspace, property, value]`                    | Assert data value    |
+| `wait_until_property_change` | `[subspace, property, value, timeout?]`          | Wait for value       |
+| `execute_action`             | `[subspace, handler, action, params?, options?]` | Execute action       |
+| `match_screenshot`           | `[name, threshold?, maxRetry?]`                  | Screenshot compare   |
+| `delay`                      | `[subspace?, property?, defaultValue?]`          | Delay execution      |
+
+### execute_action Params
+
+The `params` object in `execute_action` uses **runtime event property keys** from `event-props.ts`, NOT the action config `input` names from type definitions.
+
+```typescript
+// CORRECT — use runtime event property key
+run: ['execute_action', () => subspace0, bricks.bInput.id, 'BRICK_TEXT_INPUT_SET_TEXT',
+  { BRICK_TEXT_INPUT_TEXT: 'hello' }]
+
+// WRONG — action config input name doesn't work in automation
+run: ['execute_action', () => subspace0, bricks.bInput.id, 'BRICK_TEXT_INPUT_SET_TEXT',
+  { text: 'hello' }]
+```
+
+Reference `event-props.ts` for the correct runtime keys (e.g., `BRICK_TEXT_INPUT_TEXT`, `GENERATOR_MQTT_PAYLOAD`).
+
+### Prefer UI Interactions Over Direct Generator Calls
+
+For realistic E2E testing, prefer simulating user actions (set text input + press button) over calling generator actions directly:
+
+```typescript
+// GOOD — simulates real user behavior
+{ run: ['execute_action', () => sub, bricks.bInput.id, 'BRICK_TEXT_INPUT_SET_TEXT',
+    { BRICK_TEXT_INPUT_TEXT: 'hello' }] },
+{ run: ['brick_press', () => sub, () => bricks.bSendBtn] },
+{ run: ['wait_until_property_change', () => sub, () => data.dPayload, 'hello', 10000] },
+
+// AVOID — bypasses UI, doesn't test the full flow
+{ run: ['execute_action', () => sub, generators.gClient.id, 'GENERATOR_MQTT_PUBLISH',
+    { topic: 'test', payload: 'hello', qos: '0' }] },
+```
 
 ## Recording Automations
 
 In BRICKS Editor Preview mode:
+
 1. Perform operations normally
 2. Open menu (right-bottom corner)
 3. Select "Record Events as Automation"
@@ -127,12 +162,15 @@ In BRICKS Editor Preview mode:
 ## Running Automations
 
 ### Manual Run
+
 `Menu` → `Automations` → Select automation → `Run`
 
 ### On Launch
+
 `Bind Device` → `Select Automation` (only `launch` or `cron` types)
 
 ### Scheduled (Cron)
+
 `Bind Device` → `Cron Automation` (allows multi-select)
 
 Use [crontab.guru](https://crontab.guru) to build cron expressions.
@@ -144,7 +182,7 @@ Visual regression testing with screenshot comparison:
 ```typescript
 {
   __typename: 'TestCase',
-  id: 'screenshot-dashboard',
+  id: makeId('test_case'),
   name: 'Match dashboard screenshot',
   run: ['match_screenshot', 'dashboard-initial-state', 0.01, 3],
   exit_on_failed: true,
@@ -156,6 +194,7 @@ Visual regression testing with screenshot comparison:
 ```
 
 Screenshots can be stored:
+
 - Local file system
 - Media Flow workspace
 
@@ -165,11 +204,18 @@ First run captures baseline. Use "Run with Update" to update baseline.
 
 Automations work with Modules. Use Manual Run in Preview mode for module testing.
 
+## Important Notes
+
+- **Automation map key**: Always use `'AUTOMATION_MAP_DEFAULT'` as the automation map ID (not `makeId()`). The preview test runner reads from `automationMap['AUTOMATION_MAP_DEFAULT']?.map`.
+- **Valid makeId types**: Use `'test'` for AutomationTest, `'test_case'` for TestCase, `'test_var'` for TestVariable. Do NOT use `'automation_test'` or `'automation_test_map'`.
+- **handler in execute_action**: Pass the entity's `.id` string (e.g., `bricks.bInput.id`), not a getter function.
+
 ## Best Practices
 
 1. **Test culture**: Create automations for every significant flow
 2. **CI/CD integration**: Use `launch` automations for deployment validation
-3. **Incremental waits**: Use `EXPECT_*` steps with appropriate timeouts
+3. **Incremental waits**: Use `wait_until_property_change` with appropriate timeouts
 4. **Visual testing**: Add screenshot comparisons for critical UI states
 5. **Cron monitoring**: Schedule health checks for production displays
 6. **Isolation**: Each automation should be independent and idempotent
+7. **UI-first testing**: Simulate real user interactions (text input, button press) rather than calling generators directly

package/skills/bricks-project/rules/buttress.md

@@ -14,8 +14,9 @@ When mobile devices or embedded systems lack hardware for local AI inference (LL
 
 ## Supported Generators
 
-- [LLM (GGML)](generator_LLM) - Local Large Language Model inference
-- [Speech-to-Text (GGML)](generator_SpeechInference) - Local Speech-to-Text inference
+- LLM (GGML) (LlmMlx.ts) - Local Large Language Model inference with GGML
+- LLM (MLX) (LlmGgml.ts) - Local Large Language Model inference with MLX
+- Speech-to-Text (GGML) (SpeechToTextGgml.ts) - Local Speech-to-Text inference with GGML
 
 ## Client Configuration
 
@@ -50,10 +51,12 @@ const llmGenerator: GeneratorLLM = {
   property: {
     modelUrl: 'https://huggingface.co/ggml-org/gemma-3-12b-it-qat-GGUF/resolve/main/gemma-3-12b-it-qat-q4_0.gguf',
     contextSize: 8192,
-    buttressEnabled: true,
-    buttressUrl: 'http://192.168.1.100:2080',
-    buttressFallbackType: 'use-local',
-    buttressStrategy: 'prefer-best',
+    buttressConnectionSettings: {
+      enabled: true,
+      url: 'http://192.168.1.100:2080',
+      fallbackType: 'use-local',
+      strategy: 'prefer-best',
+    },
   },
   events: {},
   switches: [],

package/tools/deploy.ts

@@ -4,29 +4,40 @@ import { parseArgs } from 'util'
 const cwd = process.cwd()
 
 const {
-  values: { changelogs: changelogsArg, 'changelogs-file': changelogsFile, yes },
+  values: {
+    changelogs: changelogsArg,
+    'changelogs-file': changelogsFile,
+    'auto-commit': autoCommit,
+    yes,
+    help,
+  },
 } = parseArgs({
   args: Bun.argv.slice(2),
   options: {
     changelogs: { type: 'string' },
     'changelogs-file': { type: 'string' },
+    'auto-commit': { type: 'boolean' },
     yes: { type: 'boolean', short: 'y' },
+    help: { type: 'boolean', short: 'h' },
   },
   allowPositionals: true,
 })
 
+if (help) {
+  console.log(`Options:
+  --changelogs <text>        Changelogs text for the release
+  --changelogs-file <path>   Read changelogs from a file
+  --auto-commit              Auto-commit unstaged changes before deploying
+  -y, --yes                  Skip all prompts
+  -h, --help                 Show this help message`)
+  process.exit(0)
+}
+
 // Check git status
-const { exitCode } = await $`cd ${cwd} && git status`.nothrow()
+const { exitCode } = await $`cd ${cwd} && git status`.quiet().nothrow()
 const isGitRepo = exitCode === 0
 
-let commitId = ''
-if (isGitRepo) {
-  const unstagedChanges = await $`cd ${cwd} && git diff --name-only --diff-filter=ACMR`.text()
-  if (unstagedChanges)
-    throw new Error('Unstaged changes found, please commit or stash your changes before deploying')
-
-  commitId = (await $`cd ${cwd} && git rev-parse HEAD`.text()).trim()
-} else if (!yes) {
+if (!isGitRepo && !yes) {
   const confirmContinue = prompt('No git repository found, continue? (y/n)')
   if (confirmContinue !== 'y') throw new Error('Deployment cancelled')
 }
@@ -53,6 +64,24 @@ if (changelogsArg) {
   changelogs = prompt('Enter changelogs (optional, press Enter to skip):') || ''
 }
 
+// Handle unstaged changes
+let commitId = ''
+if (isGitRepo) {
+  const unstagedChanges = await $`cd ${cwd} && git diff --name-only --diff-filter=ACMR`.text()
+  if (unstagedChanges) {
+    if (autoCommit) {
+      const commitMsg = `chore: release ${version || 'new version'}`
+      const commitBody = changelogs || '[no changelogs]'
+      await $`cd ${cwd} && git add -A && git commit -m ${commitMsg} -m ${commitBody}`
+    } else {
+      throw new Error(
+        'Unstaged changes found, please commit or stash your changes before deploying',
+      )
+    }
+  }
+  commitId = (await $`cd ${cwd} && git rev-parse HEAD`.text()).trim()
+}
+
 // Ask for confirmation
 if (!yes) {
   const confirm = prompt('Are you sure you want to deploy? (y/n)')