@fugood/bricks-project 2.24.0-beta.4 → 2.24.0-beta.41

package/utils/id.ts

@@ -21,6 +21,7 @@ export const makeId = (
     | 'property_bank_command'
     | 'property_bank_calc'
     | 'dynamic-brick'
+    | 'automation_map'
     | 'test'
     | 'test_case'
     | 'test_var'
@@ -61,6 +62,9 @@ export const makeId = (
     case 'property_bank_calc':
       prefix = 'PROPERTY_BANK_COMMAND_MAP_'
       break
+    case 'automation_map':
+      prefix = 'AUTOMATION_MAP_'
+      break
     case 'test':
       prefix = 'TEST_'
       break

package/api/index.ts

@@ -1 +0,0 @@
-export * from './instance'

package/api/instance.ts

@@ -1,213 +0,0 @@
-const apiUrlMap = {
-  production: 'https://display.bricks.tools/api/graphql-workspace',
-  beta: 'https://display-beta.bricks.tools/api/graphql-workspace',
-  development: 'http://localhost:3001/api/graphql-workspace',
-}
-
-const workspaceToken = process.env.BRICKS_WORKSPACE_TOKEN
-
-type Stage = 'production' | 'beta' | 'development'
-
-const doGQL = async (stage: Stage, query: string, variables: Record<string, any>) => {
-  if (!workspaceToken) throw new Error('env BRICKS_WORKSPACE_TOKEN is not set')
-
-  const apiURL = apiUrlMap[stage]
-  if (!apiURL) throw new Error(`Invalid stage: ${stage}`)
-
-  const data = await fetch(apiURL, {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/json',
-      Authorization: `Bearer ${workspaceToken}`,
-    },
-    body: JSON.stringify({ query, variables }),
-  }).then((res) => res.json())
-
-  if (data.error && data.error.message) throw new Error(data.error.message)
-  return data
-}
-
-export const pullApp = async (stage: Stage, appId: string) => {
-  const { data, errors } = await doGQL(
-    stage,
-    `query BRICKS_PROJECT_application($id: ID!) {
-      application(id: $id) {
-        _id
-        name
-        description
-        config
-        lock {
-          enabled
-        }
-        dev_ref {
-          is_dev
-        }
-      }
-    }`,
-    { id: appId },
-  )
-  if (errors) throw new Error(errors[0].message)
-
-  const app = data.application
-  if (!app) throw new Error('App not found')
-  if (app.lock.enabled) throw new Error('App is locked')
-  // TODO: Uncomment it on leaving experimental
-  // if (!app.dev_ref.is_dev)
-  //   throw new Error(
-  //     'Currently BRICKS Project is experimental, please use the fork version of the app',
-  //   )
-  return app
-}
-
-type Config = { title?: string }
-
-export const deployApp = async (
-  stage: Stage,
-  appId: string,
-  config: Config,
-  lastCommitId?: string,
-  changelogs?: string,
-  version?: string,
-) => {
-  const app = await pullApp(stage, appId)
-  if (app.config?.bricks_project_last_commit_id === lastCommitId)
-    throw new Error('No changes to deploy')
-
-  const versionName = version || app.name || 'Untitled'
-  const releaseNote = changelogs
-    ? `${changelogs}\n\nRelease by BRICKS Project`
-    : 'Release by BRICKS Project'
-
-  const { errors } = await doGQL(
-    stage,
-    `mutation BRICKS_PROJECT_releaseApplication(
-      $id: ID!,
-      $config: String,
-      $releaseCurrentVersion: String,
-      $releaseCurrentVersionNote: String
-    ) {
-      updateApplication(
-        id: $id,
-        config: $config,
-        releaseCurrentVersion: $releaseCurrentVersion,
-        releaseCurrentVersionNote: $releaseCurrentVersionNote
-      ) {
-        _id
-        name
-      }
-    }`,
-    {
-      id: appId,
-      config: JSON.stringify({
-        ...config,
-        title: versionName,
-        bricks_project_last_commit_id: lastCommitId,
-      }),
-      releaseCurrentVersion: versionName,
-      releaseCurrentVersionNote: releaseNote,
-    },
-  )
-  if (errors) throw new Error(errors[0].message)
-  return true
-}
-
-export const pullApplicationProject = async (stage: Stage, appId: string) => {
-  const { data, errors } = await doGQL(
-    stage,
-    `query BRICKS_PROJECT_applicationProject($id: ID!) {
-      UNSTABLE_applicationProject(id: $id, buildApplicationOnly: true)
-    }`,
-    { id: appId },
-  )
-  if (errors) throw new Error(errors[0].message)
-  if (!data.UNSTABLE_applicationProject) throw new Error('Application not found')
-  return data.UNSTABLE_applicationProject
-}
-
-export const pullModule = async (stage: Stage, modId: string) => {
-  const { data, errors } = await doGQL(
-    stage,
-    `query BRICKS_PROJECT_module($id: ID!) {
-      module(id: $id) {
-        _id
-        name
-        description
-        is_public
-        config
-      }
-    }`,
-    { id: modId },
-  )
-  if (errors) throw new Error(errors[0].message)
-  const mod = data.module
-  if (!mod) throw new Error('Module not found')
-  if (mod.is_public)
-    throw new Error(
-      'Currently BRICKS Project is experimental, public module deployment is temporary not recommended',
-    )
-  return mod
-}
-
-export const deployModule = async (
-  stage: Stage,
-  modId: string,
-  config: Config,
-  lastCommitId?: string,
-  changelogs?: string,
-  version?: string,
-) => {
-  const mod = await pullModule(stage, modId)
-  if (mod.config?.bricks_project_last_commit_id === lastCommitId)
-    throw new Error('No changes to deploy')
-
-  const versionName = version || mod.name || 'Untitled'
-  const releaseNote = changelogs
-    ? `${changelogs}\n\nRelease by BRICKS Project`
-    : 'Release by BRICKS Project'
-
-  const { errors } = await doGQL(
-    stage,
-    `mutation BRICKS_PROJECT_releaseModule(
-      $id: ID!,
-      $config: String,
-      $releaseCurrentVersion: String,
-      $releaseCurrentVersionNote: String
-    ) {
-      updateModule(
-        id: $id
-        config: $config
-        validateConfig: true
-        releaseCurrentVersion: $releaseCurrentVersion
-        releaseCurrentVersionNote: $releaseCurrentVersionNote
-      ) {
-        _id
-        name
-      }
-    }`,
-    {
-      id: modId,
-      config: JSON.stringify({
-        ...config,
-        title: versionName,
-        bricks_project_last_commit_id: lastCommitId,
-      }),
-      releaseCurrentVersion: versionName,
-      releaseCurrentVersionNote: releaseNote,
-    },
-  )
-  if (errors) throw new Error(errors[0].message)
-  return true
-}
-
-export const pullModuleProject = async (stage: Stage, modId: string) => {
-  const { data, errors } = await doGQL(
-    stage,
-    `query BRICKS_PROJECT_moduleProject($id: ID!) {
-      UNSTABLE_moduleProject(id: $id, buildApplicationOnly: true)
-    }`,
-    { id: modId },
-  )
-  if (errors) throw new Error(errors[0].message)
-  if (!data.UNSTABLE_moduleProject) throw new Error('Module not found')
-  return data.UNSTABLE_moduleProject
-}

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

@@ -1,175 +0,0 @@
-# Automations
-
-E2E testing and scheduled execution for BRICKS applications. Simulates user behavior and validates application state.
-
-## 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 |
-
-## Simulation Actions
-
-Automations can simulate:
-- **Brick Press**: Tap/click on bricks
-- **Key Events**: Key up/down for keyboard input
-- **HTTP Request**: API calls
-- **Execute Action**: Trigger system or generator actions
-
-## Assertions
-
-Automations can validate:
-- **Brick Exists**: Check if brick is rendered
-- **Event Triggered**: Verify event from Brick/Generator/Canvas
-- **Canvas Changed**: Confirm canvas navigation
-- **Property Assert**: Check Data Bank values
-- **Property Updated**: Wait for property change
-- **Match Screenshot**: Visual regression testing
-
-## TypeScript Example
-
-```typescript
-const testLoginFlow: AutomationTest = {
-  __typename: 'AutomationTest',
-  id: 'test-login-flow',
-  title: 'Test Login Flow',
-  timeout: 30000,
-  trigger_type: 'launch',
-  cases: [
-    {
-      __typename: 'TestCase',
-      id: 'wait-login-canvas',
-      name: 'Wait for login canvas',
-      run: ['wait_until_canvas_change', () => mainSubspace, () => loginCanvas, 5000],
-      exit_on_failed: true,
-      commented: false,
-      pre_delay: 0,
-      post_delay: 0,
-      jump_cond: [],
-    },
-    {
-      __typename: 'TestCase',
-      id: 'press-username',
-      name: 'Press username input',
-      run: ['brick_press', () => mainSubspace, () => usernameInput],
-      exit_on_failed: true,
-      commented: false,
-      pre_delay: 0,
-      post_delay: 100,
-      jump_cond: [],
-    },
-    {
-      __typename: 'TestCase',
-      id: 'assert-username',
-      name: 'Assert username value',
-      run: ['assert_property', () => mainSubspace, () => usernameData, 'testuser'],
-      exit_on_failed: true,
-      commented: false,
-      pre_delay: 0,
-      post_delay: 0,
-      jump_cond: [],
-    },
-    {
-      __typename: 'TestCase',
-      id: 'press-login',
-      name: 'Press login button',
-      run: ['brick_press', () => mainSubspace, () => loginButton],
-      exit_on_failed: true,
-      commented: false,
-      pre_delay: 0,
-      post_delay: 0,
-      jump_cond: [],
-    },
-    {
-      __typename: 'TestCase',
-      id: 'wait-dashboard',
-      name: 'Wait for dashboard',
-      run: ['wait_until_canvas_change', () => mainSubspace, () => dashboardCanvas, 10000],
-      exit_on_failed: true,
-      commented: false,
-      pre_delay: 0,
-      post_delay: 0,
-      jump_cond: [],
-    },
-  ],
-  variables: [],
-}
-```
-
-## 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 |
-
-## Recording Automations
-
-In BRICKS Editor Preview mode:
-1. Perform operations normally
-2. Open menu (right-bottom corner)
-3. Select "Record Events as Automation"
-4. Generated automation appears in Automations list
-
-## 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.
-
-## Screenshot Testing
-
-Visual regression testing with screenshot comparison:
-
-```typescript
-{
-  __typename: 'TestCase',
-  id: 'screenshot-dashboard',
-  name: 'Match dashboard screenshot',
-  run: ['match_screenshot', 'dashboard-initial-state', 0.01, 3],
-  exit_on_failed: true,
-  commented: false,
-  pre_delay: 500, // Wait for UI to settle
-  post_delay: 0,
-  jump_cond: [],
-}
-```
-
-Screenshots can be stored:
-- Local file system
-- Media Flow workspace
-
-First run captures baseline. Use "Run with Update" to update baseline.
-
-## Module Support
-
-Automations work with Modules. Use Manual Run in Preview mode for module testing.
-
-## 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
-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

package/types/generators/TextToSpeechApple.ts

@@ -1,113 +0,0 @@
-/* Auto generated by build script */
-import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
-import type { Data, DataLink } from '../data'
-import type {
-  Generator,
-  EventAction,
-  ActionWithDataParams,
-  ActionWithParams,
-  Action,
-  EventProperty,
-} from '../common'
-
-/* Load the TTS model */
-export type GeneratorAppleTTSActionLoadModel = Action & {
-  __actionName: 'GENERATOR_APPLE_TTS_LOAD_MODEL'
-}
-
-/* Generate audio */
-export type GeneratorAppleTTSActionGenerate = ActionWithParams & {
-  __actionName: 'GENERATOR_APPLE_TTS_GENERATE'
-  params?: Array<{
-    input: 'text'
-    value?: string | DataLink | EventProperty
-    mapping?: string
-  }>
-}
-
-/* Clean cache */
-export type GeneratorAppleTTSActionCleanCache = Action & {
-  __actionName: 'GENERATOR_APPLE_TTS_CLEAN_CACHE'
-}
-
-/* Cancel current generation and clear queue */
-export type GeneratorAppleTTSActionCancel = Action & {
-  __actionName: 'GENERATOR_APPLE_TTS_CANCEL'
-}
-
-interface GeneratorAppleTTSDef {
-  /*
-Default property:
-{
-  "language": "en-US",
-  "outputType": "play",
-  "cacheGenerated": true,
-  "autoInferEnable": false,
-  "softBreakRegex": "^[^\\r\\n\\t\\f\\v]*([\\r\\n]+|[。！？!?.]\\B)",
-  "hardBreakTime": 500
-}
-  */
-  property?: {
-    /* Initialize the TTS context on generator initialization */
-    init?: boolean | DataLink
-    /* Voice identifier */
-    voice?: string | DataLink
-    /* Language/locale (e.g., 'en-US') */
-    language?: string | DataLink
-    /* Output mode */
-    outputType?: 'play' | 'file' | DataLink
-    /* Enable cache for generated audio */
-    cacheGenerated?: boolean | DataLink
-    /* Text to generate */
-    prompt?: string | DataLink
-    /* Auto inference when prompt changes */
-    autoInferEnable?: boolean | DataLink
-    /* Segmentation rule for auto inference */
-    softBreakRegex?: string | DataLink
-    /* Time to force inference when softBreakRegex is not satisfied */
-    hardBreakTime?: number | DataLink
-  }
-  events?: {
-    /* Event triggered when state change */
-    onContextStateChange?: Array<EventAction>
-    /* Event triggered when error occurs */
-    onError?: Array<EventAction>
-  }
-  outlets?: {
-    /* Context state */
-    contextState?: () => Data
-    /* Generated audio file */
-    generatedAudio?: () => Data
-    /* Generated audio file is playing */
-    generatedAudioPlaying?: () => Data
-  }
-}
-
-/* Text-to-speech synthesis using Apple's native speech synthesis  
-
- ## Features  
- - Native Apple speech synthesis  
- - Natural sounding voices  
- - Privacy-focused on-device processing  
- - Multiple voice options  
- - Requires iOS 13+ (native speech synthesis) */
-export type GeneratorAppleTTS = Generator &
-  GeneratorAppleTTSDef & {
-    templateKey: 'GENERATOR_APPLE_TTS'
-    switches: Array<
-      SwitchDef &
-        GeneratorAppleTTSDef & {
-          conds?: Array<{
-            method: '==' | '!=' | '>' | '<' | '>=' | '<='
-            cond:
-              | SwitchCondInnerStateCurrentCanvas
-              | SwitchCondData
-              | {
-                  __typename: 'SwitchCondInnerStateOutlet'
-                  outlet: 'contextState' | 'generatedAudio' | 'generatedAudioPlaying'
-                  value: any
-                }
-          }>
-        }
-    >
-  }

package/types/generators/TtsAppleBuiltin.ts

@@ -1,105 +0,0 @@
-import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
-import type { Data, DataLink } from '../data'
-import type { Generator, EventAction, ActionWithParams, Action, EventProperty } from '../common'
-
-/* Load the TTS model */
-export type GeneratorAppleTTSActionLoadModel = Action & {
-  __actionName: 'GENERATOR_APPLE_TTS_LOAD_MODEL'
-}
-
-/* Generate audio */
-export type GeneratorAppleTTSActionGenerate = ActionWithParams & {
-  __actionName: 'GENERATOR_APPLE_TTS_GENERATE'
-  params?: Array<{
-    input: 'text'
-    value?: string | DataLink | EventProperty
-    mapping?: string
-  }>
-}
-
-/* Clean cache */
-export type GeneratorAppleTTSActionCleanCache = Action & {
-  __actionName: 'GENERATOR_APPLE_TTS_CLEAN_CACHE'
-}
-
-/* Cancel current generation and clear queue */
-export type GeneratorAppleTTSActionCancel = Action & {
-  __actionName: 'GENERATOR_APPLE_TTS_CANCEL'
-}
-
-interface GeneratorAppleTTSDef {
-  /*
-Default property:
-{
-  "language": "en-US",
-  "outputType": "play",
-  "cacheGenerated": true,
-  "autoInferEnable": false,
-  "softBreakRegex": "^[^\\r\\n\\t\\f\\v]*([\\r\\n]+|[。！？!?.]\\B)",
-  "hardBreakTime": 500
-}
-  */
-  property?: {
-    /* Initialize the TTS context on generator initialization */
-    init?: boolean | DataLink
-    /* Voice identifier */
-    voice?: string | DataLink
-    /* Language/locale (e.g., 'en-US') */
-    language?: string | DataLink
-    /* Output mode */
-    outputType?: 'play' | 'file' | DataLink
-    /* Enable cache for generated audio */
-    cacheGenerated?: boolean | DataLink
-    /* Text to generate */
-    prompt?: string | DataLink
-    /* Auto inference when prompt changes */
-    autoInferEnable?: boolean | DataLink
-    /* Segmentation rule for auto inference */
-    softBreakRegex?: string | DataLink
-    /* Time to force inference when softBreakRegex is not satisfied */
-    hardBreakTime?: number | DataLink
-  }
-  events?: {
-    /* Event triggered when state change */
-    onContextStateChange?: Array<EventAction>
-    /* Event triggered when error occurs */
-    onError?: Array<EventAction>
-  }
-  outlets?: {
-    /* Context state */
-    contextState?: () => Data
-    /* Generated audio file */
-    generatedAudio?: () => Data
-    /* Generated audio file is playing */
-    generatedAudioPlaying?: () => Data
-  }
-}
-
-/* Text-to-speech synthesis using Apple's native speech synthesis
-
- ## Features
- - Native Apple speech synthesis
- - Natural sounding voices
- - Privacy-focused on-device processing
- - Multiple voice options
- - Requires iOS 13+ (native speech synthesis) */
-export type GeneratorAppleTTS = Generator &
-  GeneratorAppleTTSDef & {
-    templateKey: 'GENERATOR_APPLE_TTS'
-    switches: Array<
-      SwitchDef &
-        GeneratorAppleTTSDef & {
-          conds?: Array<{
-            method: '==' | '!=' | '>' | '<' | '>=' | '<='
-            cond:
-              | SwitchCondInnerStateCurrentCanvas
-              | SwitchCondData
-              | {
-                  __typename: 'SwitchCondInnerStateOutlet'
-                  outlet: 'contextState' | 'generatedAudio' | 'generatedAudioPlaying'
-                  value: any
-                }
-          }>
-        }
-    >
-  }