@walkeros/transformer-demo 4.8.1 → 4.8.3-next-1793115089237

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,35 @@
1
1
  # @walkeros/transformer-demo
2
2
 
3
+ ## 4.8.3-next-1793115089237
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies [34fd225]
8
+ - Updated dependencies [5313635]
9
+ - Updated dependencies [5313635]
10
+ - Updated dependencies [5313635]
11
+ - Updated dependencies [5313635]
12
+ - Updated dependencies [5313635]
13
+ - Updated dependencies [34fd225]
14
+ - Updated dependencies [5313635]
15
+ - @walkeros/core@4.8.3-next-1793115089237
16
+
17
+ ## 4.8.2
18
+
19
+ ### Patch Changes
20
+
21
+ - Updated dependencies [2374f54]
22
+ - Updated dependencies [7e5fc27]
23
+ - Updated dependencies [2374f54]
24
+ - Updated dependencies [964590a]
25
+ - Updated dependencies [4100ede]
26
+ - Updated dependencies [2374f54]
27
+ - Updated dependencies [2374f54]
28
+ - Updated dependencies [15eb7b2]
29
+ - Updated dependencies [33a2779]
30
+ - Updated dependencies [33a2779]
31
+ - @walkeros/core@4.8.2
32
+
3
33
  ## 4.8.1
4
34
 
5
35
  ### Patch Changes
package/README.md CHANGED
@@ -21,14 +21,22 @@ npm install @walkeros/transformer-demo
21
21
 
22
22
  ## Quick start
23
23
 
24
- Add the transformer to a flow's `transformers` block and wire it into a source's
25
- chain:
24
+ Add the transformer to a flow's `transformers` block and name it in a chain,
25
+ here the demo source's `next`:
26
26
 
27
27
  ```json
28
28
  {
29
29
  "version": 4,
30
30
  "flows": {
31
31
  "default": {
32
+ "config": { "platform": "web" },
33
+ "sources": {
34
+ "demo": {
35
+ "package": "@walkeros/source-demo",
36
+ "config": { "settings": { "events": [{ "name": "page view" }] } },
37
+ "next": "demo"
38
+ }
39
+ },
32
40
  "transformers": {
33
41
  "demo": { "package": "@walkeros/transformer-demo" }
34
42
  }
@@ -37,9 +45,21 @@ chain:
37
45
  }
38
46
  ```
39
47
 
48
+ Each event the demo source emits is logged to the console as
49
+ `[transformer-demo] {...}` and passes on unchanged. A transformer that no chain
50
+ names never runs, and nothing reports it.
51
+
52
+ ## Settings
53
+
54
+ | Setting | Type | Required | Description |
55
+ | ------------------ | ---------- | -------- | ------------------------------------------------------------------------------------ |
56
+ | `name` | `string` | no | Prefix of each log line. Default: `transformer-demo`. |
57
+ | `fields` | `string[]` | no | Dot-notation paths to log instead of the whole event, such as `data.title`. |
58
+ | `addProcessedFlag` | `boolean` | no | Adds `_processed: true` and `_processedBy` (the `name`) to `event.data` when `true`. |
59
+
40
60
  ## Documentation
41
61
 
42
- Full configuration, mapping, and examples live in the docs:
62
+ How transformers are wired into a flow:
43
63
  **https://www.walkeros.io/docs/transformers**
44
64
 
45
65
  ## Contribute
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$meta": {
3
3
  "package": "@walkeros/transformer-demo",
4
- "version": "4.8.1",
4
+ "version": "4.8.3-next-1793115089237",
5
5
  "type": "transformer",
6
6
  "platform": [
7
7
  "web",
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@walkeros/transformer-demo",
3
3
  "description": "Demo transformer for walkerOS - logs and passes through events",
4
- "version": "4.8.1",
4
+ "version": "4.8.3-next-1793115089237",
5
5
  "license": "MIT",
6
6
  "main": "./dist/index.js",
7
7
  "module": "./dist/index.mjs",
@@ -26,7 +26,7 @@
26
26
  "test": "jest"
27
27
  },
28
28
  "dependencies": {
29
- "@walkeros/core": "4.8.1"
29
+ "@walkeros/core": "4.8.3-next-1793115089237"
30
30
  },
31
31
  "repository": {
32
32
  "url": "git+https://github.com/elbwalker/walkerOS.git",