@brika/plugin-example-echo 0.3.0

package/README.md

@@ -0,0 +1,104 @@
+# @brika/plugin-example-echo
+
+A simple example plugin demonstrating how to create reactive blocks for BRIKA.
+
+## Overview
+
+This plugin provides a basic echo block that passes input data to output, optionally with prefix/suffix transformation. It's useful for learning how BRIKA plugins work and for testing workflows.
+
+## Available Blocks
+
+### Echo
+
+Echoes input data to output with optional prefix/suffix for string messages.
+
+**Inputs:**
+- `in` (generic) — Any data to echo
+
+**Outputs:**
+- `out` (generic) — The echoed data
+
+**Config:**
+- `prefix` (string, optional) — Prefix to add to string messages
+- `suffix` (string, optional) — Suffix to add to string messages
+
+## Usage
+
+### In Workflows
+
+```yaml
+blocks:
+  - id: clock
+    type: "@brika/blocks-builtin:clock"
+    config:
+      interval: 5000
+
+  - id: echo
+    type: "@brika/plugin-example-echo:echo"
+    config:
+      prefix: "[Echo] "
+
+  - id: log
+    type: "@brika/blocks-builtin:log"
+    config:
+      message: "Received: {{ JSON.stringify(inputs.in) }}"
+
+connections:
+  - from: clock
+    fromPort: tick
+    to: echo
+    toPort: in
+  - from: echo
+    fromPort: out
+    to: log
+    toPort: in
+```
+
+## Implementation
+
+```typescript
+import { defineReactiveBlock, input, output, log, onStop, z } from "@brika/sdk";
+
+export const echo = defineReactiveBlock(
+  {
+    id: "echo",
+    inputs: {
+      in: input(z.generic(), { name: "Input" }),
+    },
+    outputs: {
+      out: output(z.passthrough("in"), { name: "Output" }),
+    },
+    config: z.object({
+      prefix: z.string().optional().describe("Optional prefix for string messages"),
+      suffix: z.string().optional().describe("Optional suffix for string messages"),
+    }),
+  },
+  ({ inputs, outputs, config }) => {
+    inputs.in.on((data) => {
+      if (typeof data === "string" && (config.prefix || config.suffix)) {
+        const prefix = config.prefix ?? "";
+        const suffix = config.suffix ?? "";
+        const result = `${prefix}${data}${suffix}`;
+        log.info(`Echo: ${result}`);
+        outputs.out.emit(result);
+      } else {
+        log.info(`Echo: ${JSON.stringify(data)}`);
+        outputs.out.emit(data);
+      }
+    });
+  }
+);
+
+onStop(() => log.info("Echo plugin stopping"));
+log.info("Echo plugin loaded");
+```
+
+## Installation
+
+Add to your `brika.yml`:
+
+```yaml
+install:
+  - ref: "workspace:example-echo"
+    enabled: true
+```

package/locales/en/plugin.json

@@ -0,0 +1,17 @@
+{
+  "name": "Echo Plugin",
+  "description": "Simple example plugin that echoes messages",
+  "tools": {
+    "echo": {
+      "name": "Echo",
+      "description": "Echo back the provided message"
+    }
+  },
+  "fields": {
+    "message": {
+      "label": "Message",
+      "description": "The message to echo back"
+    }
+  }
+}
+

package/locales/fr/plugin.json

@@ -0,0 +1,17 @@
+{
+  "name": "Plugin Écho",
+  "description": "Plugin d'exemple simple qui renvoie des messages en écho",
+  "tools": {
+    "echo": {
+      "name": "Écho",
+      "description": "Renvoyer le message fourni en écho"
+    }
+  },
+  "fields": {
+    "message": {
+      "label": "Message",
+      "description": "Le message à renvoyer"
+    }
+  }
+}
+

package/package.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "https://schema.brika.dev/plugin.schema.json",
+  "name": "@brika/plugin-example-echo",
+  "displayName": "Echo Example",
+  "version": "0.3.0",
+  "description": "Example echo plugin demonstrating reactive blocks",
+  "author": "BRIKA Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/brikalabs/brika.git",
+    "directory": "plugins/example-echo"
+  },
+  "keywords": [
+    "brika",
+    "brika-plugin",
+    "example",
+    "echo",
+    "demo"
+  ],
+  "engines": {
+    "brika": "^0.3.0"
+  },
+  "type": "module",
+  "main": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "files": ["src", "locales", "README.md"],
+  "scripts": {
+    "link": "bun link",
+    "typecheck": "tsgo --noEmit",
+    "prepublishOnly": "brika-verify-plugin"
+  },
+  "blocks": [
+    {
+      "id": "echo",
+      "name": "Echo",
+      "description": "Echoes input to output with optional prefix/suffix",
+      "category": "transform",
+      "icon": "message-circle",
+      "color": "#3b82f6"
+    }
+  ],
+  "sparks": [
+    {
+      "id": "echoed",
+      "name": "Message Echoed",
+      "description": "Emitted when a message is echoed"
+    }
+  ],
+  "dependencies": {
+    "@brika/sdk": "0.3.1"
+  }
+}

package/src/index.ts

@@ -0,0 +1,74 @@
+/**
+ * Echo Plugin - Example plugin demonstrating reactive blocks and sparks
+ */
+
+import { defineReactiveBlock, defineSpark, input, log, onStop, output, z } from '@brika/sdk';
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Sparks - Typed Events
+// ─────────────────────────────────────────────────────────────────────────────
+
+/** Emitted when a message is echoed */
+export const echoed = defineSpark({
+  id: 'echoed',
+  schema: z.object({
+    original: z.any(),
+    result: z.any(),
+    timestamp: z.number(),
+  }),
+});
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Echo Block - Echoes input to output with optional transformation
+// ─────────────────────────────────────────────────────────────────────────────
+
+export const echo = defineReactiveBlock(
+  {
+    id: 'echo',
+    inputs: {
+      in: input(z.generic(), { name: 'Input' }),
+    },
+    outputs: {
+      out: output(z.passthrough('in'), { name: 'Output' }),
+    },
+    config: z.object({
+      prefix: z.string().optional().describe('Optional prefix to add to string messages'),
+      suffix: z.string().optional().describe('Optional suffix to add to string messages'),
+    }),
+  },
+  ({ inputs, outputs, config }) => {
+    inputs.in.on((data) => {
+      let result: unknown;
+
+      // If data is a string and we have prefix/suffix, apply them
+      if (typeof data === 'string' && (config.prefix || config.suffix)) {
+        const prefix = config.prefix ?? '';
+        const suffix = config.suffix ?? '';
+        result = `${prefix}${data}${suffix}`;
+        log.info(`Echo: ${result}`);
+      } else {
+        result = data;
+        log.info(`Echo: ${JSON.stringify(data)}`);
+      }
+
+      // Emit spark when message is echoed
+      echoed.emit({
+        original: data,
+        result,
+        timestamp: Date.now(),
+      });
+
+      outputs.out.emit(result);
+    });
+  }
+);
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Lifecycle
+// ─────────────────────────────────────────────────────────────────────────────
+
+onStop(() => {
+  log.info('Echo plugin stopping');
+});
+
+log.info('Echo plugin loaded');