@walkeros/destination-demo 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 elbWalker GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,125 @@
+<div align="center">
+  <a href="https://www.elbwalker.com">
+    <img alt="elbwalker" src="https://www.elbwalker.com/img/elbwalker-logo.png" height="40px" />
+  </a>
+</div>
+
+# walkerOS Destination Demo
+
+A demo destination that logs walkerOS events to console with optional field
+filtering - perfect for debugging, testing, and demonstrations.
+
+> Learn more at [walkeros.io/docs](https://www.walkeros.io/docs/destinations/)
+
+## What It Does
+
+- Logs events to console with JSON formatting
+- Supports field filtering using dot notation
+- Zero external dependencies - ideal for demos and debugging
+- Simple destination interface compatible with walkerOS architecture
+
+## Installation
+
+```bash
+npm install @walkeros/destination-demo
+```
+
+## Quick Start
+
+```typescript
+import { startFlow } from '@walkeros/collector';
+import { destinationDemo } from '@walkeros/destination-demo';
+
+const { collector } = await startFlow({
+  destinations: {
+    demo: destinationDemo,
+  },
+});
+
+await collector.push('page view', { title: 'Home' });
+// Console output: [demo] { "name": "page view", "data": { "title": "Home" }, ... }
+```
+
+## Configuration
+
+| Name   | Type            | Description                                      | Required |
+| ------ | --------------- | ------------------------------------------------ | -------- |
+| name   | `string`        | Custom prefix for log messages (default: "demo") | No       |
+| values | `Array<string>` | Dot notation paths to extract specific fields    | No       |
+
+## Example
+
+Complete example showing filtered field logging:
+
+```typescript
+import { startFlow } from '@walkeros/collector';
+import { sourceDemo } from '@walkeros/source-demo';
+import { destinationDemo } from '@walkeros/destination-demo';
+
+const { collector } = await startFlow({
+  sources: {
+    demo: {
+      code: sourceDemo,
+      config: {
+        settings: {
+          events: [
+            {
+              name: 'product view',
+              data: { id: 'P123', name: 'Laptop', price: 999 },
+            },
+          ],
+        },
+      },
+    },
+  },
+  destinations: {
+    demo: {
+      ...destinationDemo,
+      config: {
+        settings: {
+          name: 'MyApp',
+          values: ['name', 'data.id', 'data.name', 'timestamp'],
+        },
+      },
+    },
+  },
+});
+
+// Console output: [MyApp] {
+//   "name": "product view",
+//   "data.id": "P123",
+//   "data.name": "Laptop",
+//   "timestamp": 1647261462000
+// }
+```
+
+### Without Field Filtering
+
+Omit the `values` setting to log the complete event object:
+
+```typescript
+const { collector } = await startFlow({
+  destinations: {
+    demo: {
+      ...destinationDemo,
+      config: {
+        settings: {
+          name: 'Debug',
+        },
+      },
+    },
+  },
+});
+
+// Console output: [Debug] { "name": "page view", "data": {...}, "context": {...}, ... }
+```
+
+## Contribute
+
+We welcome contributions! Please see our
+[contribution guidelines](https://github.com/elbwalker/walkerOS) for more
+information.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,38 @@
+import { Destination as Destination$1 } from '@walkeros/core';
+
+interface Settings {
+    name?: string;
+    values?: string[];
+}
+interface Mapping {
+}
+interface Env extends Destination$1.BaseEnv {
+    log?: (msg: string) => void;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env>;
+type Destination = Destination$1.Instance<Types>;
+type Config = Destination$1.Config<Types>;
+type InitFn = Destination$1.InitFn<Types>;
+type PushFn = Destination$1.PushFn<Types>;
+
+type types_Config = Config;
+type types_Destination = Destination;
+type types_Env = Env;
+type types_InitFn = InitFn;
+type types_Mapping = Mapping;
+type types_PushFn = PushFn;
+type types_Settings = Settings;
+type types_Types = Types;
+declare namespace types {
+  export type { types_Config as Config, types_Destination as Destination, types_Env as Env, types_InitFn as InitFn, types_Mapping as Mapping, types_PushFn as PushFn, types_Settings as Settings, types_Types as Types };
+}
+
+/**
+ * Demo destination for walkerOS
+ *
+ * Logs events using env.log (or console.log fallback) with optional field filtering.
+ * Perfect for testing and demonstrations without external dependencies.
+ */
+declare const destinationDemo: Destination;
+
+export { types as DestinationDemo, destinationDemo as default, destinationDemo };

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+import { Destination as Destination$1 } from '@walkeros/core';
+
+interface Settings {
+    name?: string;
+    values?: string[];
+}
+interface Mapping {
+}
+interface Env extends Destination$1.BaseEnv {
+    log?: (msg: string) => void;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env>;
+type Destination = Destination$1.Instance<Types>;
+type Config = Destination$1.Config<Types>;
+type InitFn = Destination$1.InitFn<Types>;
+type PushFn = Destination$1.PushFn<Types>;
+
+type types_Config = Config;
+type types_Destination = Destination;
+type types_Env = Env;
+type types_InitFn = InitFn;
+type types_Mapping = Mapping;
+type types_PushFn = PushFn;
+type types_Settings = Settings;
+type types_Types = Types;
+declare namespace types {
+  export type { types_Config as Config, types_Destination as Destination, types_Env as Env, types_InitFn as InitFn, types_Mapping as Mapping, types_PushFn as PushFn, types_Settings as Settings, types_Types as Types };
+}
+
+/**
+ * Demo destination for walkerOS
+ *
+ * Logs events using env.log (or console.log fallback) with optional field filtering.
+ * Perfect for testing and demonstrations without external dependencies.
+ */
+declare const destinationDemo: Destination;
+
+export { types as DestinationDemo, destinationDemo as default, destinationDemo };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var e,t=Object.defineProperty,o=Object.getOwnPropertyDescriptor,n=Object.getOwnPropertyNames,r=Object.prototype.hasOwnProperty,i={};((e,o)=>{for(var n in o)t(e,n,{get:o[n],enumerable:!0})})(i,{DestinationDemo:()=>s,default:()=>l,destinationDemo:()=>a}),module.exports=(e=i,((e,i,s,a)=>{if(i&&"object"==typeof i||"function"==typeof i)for(let l of n(i))r.call(e,l)||l===s||t(e,l,{get:()=>i[l],enumerable:!(a=o(i,l))||a.enumerable});return e})(t({},"__esModule",{value:!0}),e));var s={},a={type:"demo",config:{settings:{name:"demo"}},init({config:e,env:t}){(t?.log||console.log)(`[${(e?.settings||{name:"demo"}).name}] initialized`)},push(e,{config:t,env:o}){const n=o?.log||console.log,r=t?.settings||{name:"demo"},i=r.values?function(e,t){const o={};for(const n of t){const t=n.split(".").reduce((e,t)=>e?.[t],e);void 0!==t&&(o[n]=t)}return o}(e,r.values):e;n(`[${r.name}] ${JSON.stringify(i,null,2)}`)}};var l=a;//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/types.ts"],"sourcesContent":["import type { WalkerOS } from '@walkeros/core';\nimport type { Destination } from './types';\n\nexport * as DestinationDemo from './types';\n\n/**\n * Demo destination for walkerOS\n *\n * Logs events using env.log (or console.log fallback) with optional field filtering.\n * Perfect for testing and demonstrations without external dependencies.\n */\nexport const destinationDemo: Destination = {\n  type: 'demo',\n\n  config: {\n    settings: {\n      name: 'demo',\n    },\n  },\n\n  init({ config, env }) {\n    // eslint-disable-next-line no-console\n    const log = env?.log || console.log;\n    const settings = config?.settings || { name: 'demo' };\n\n    // Log initialization\n    log(`[${settings.name}] initialized`);\n  },\n\n  push(event, { config, env }) {\n    // eslint-disable-next-line no-console\n    const log = env?.log || console.log;\n    const settings = config?.settings || { name: 'demo' };\n\n    const output = settings.values\n      ? extractValues(\n          event as unknown as Record<string, unknown>,\n          settings.values,\n        )\n      : event;\n\n    log(`[${settings.name}] ${JSON.stringify(output, null, 2)}`);\n  },\n};\n\n/**\n * Extract values from object using dot notation paths\n */\nfunction extractValues(\n  obj: Record<string, unknown>,\n  paths: string[],\n): Record<string, unknown> {\n  const result: Record<string, unknown> = {};\n\n  for (const path of paths) {\n    const value = path\n      .split('.')\n      .reduce<unknown>(\n        (acc, key) => (acc as Record<string, unknown>)?.[key],\n        obj,\n      );\n    if (value !== undefined) {\n      result[path] = value;\n    }\n  }\n\n  return result;\n}\n\nexport default destinationDemo;\n","import type { Destination as CoreDestination } from '@walkeros/core';\n\nexport interface Settings {\n  name?: string;\n  values?: string[];\n}\n\nexport interface Mapping {}\n\nexport interface Env extends CoreDestination.BaseEnv {\n  log?: (msg: string) => void;\n}\n\nexport type Types = CoreDestination.Types<Settings, Mapping, Env>;\n\nexport type Destination = CoreDestination.Instance<Types>;\nexport type Config = CoreDestination.Config<Types>;\nexport type InitFn = CoreDestination.InitFn<Types>;\nexport type PushFn = CoreDestination.PushFn<Types>;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA;;;ADWO,IAAM,kBAA+B;AAAA,EAC1C,MAAM;AAAA,EAEN,QAAQ;AAAA,IACN,UAAU;AAAA,MACR,MAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,KAAK,EAAE,QAAQ,IAAI,GAAG;AAEpB,UAAM,MAAM,KAAK,OAAO,QAAQ;AAChC,UAAM,WAAW,QAAQ,YAAY,EAAE,MAAM,OAAO;AAGpD,QAAI,IAAI,SAAS,IAAI,eAAe;AAAA,EACtC;AAAA,EAEA,KAAK,OAAO,EAAE,QAAQ,IAAI,GAAG;AAE3B,UAAM,MAAM,KAAK,OAAO,QAAQ;AAChC,UAAM,WAAW,QAAQ,YAAY,EAAE,MAAM,OAAO;AAEpD,UAAM,SAAS,SAAS,SACpB;AAAA,MACE;AAAA,MACA,SAAS;AAAA,IACX,IACA;AAEJ,QAAI,IAAI,SAAS,IAAI,KAAK,KAAK,UAAU,QAAQ,MAAM,CAAC,CAAC,EAAE;AAAA,EAC7D;AACF;AAKA,SAAS,cACP,KACA,OACyB;AACzB,QAAM,SAAkC,CAAC;AAEzC,aAAW,QAAQ,OAAO;AACxB,UAAM,QAAQ,KACX,MAAM,GAAG,EACT;AAAA,MACC,CAAC,KAAK,QAAS,MAAkC,GAAG;AAAA,MACpD;AAAA,IACF;AACF,QAAI,UAAU,QAAW;AACvB,aAAO,IAAI,IAAI;AAAA,IACjB;AAAA,EACF;AAEA,SAAO;AACT;AAEA,IAAO,gBAAQ;","names":[]}

package/dist/index.mjs

@@ -0,0 +1 @@
+var n={},e={type:"demo",config:{settings:{name:"demo"}},init({config:n,env:e}){(e?.log||console.log)(`[${(n?.settings||{name:"demo"}).name}] initialized`)},push(n,{config:e,env:o}){const t=o?.log||console.log,s=e?.settings||{name:"demo"},i=s.values?function(n,e){const o={};for(const t of e){const e=t.split(".").reduce((n,e)=>n?.[e],n);void 0!==e&&(o[t]=e)}return o}(n,s.values):n;t(`[${s.name}] ${JSON.stringify(i,null,2)}`)}};var o=e;export{n as DestinationDemo,o as default,e as destinationDemo};//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts","../src/index.ts"],"sourcesContent":["import type { Destination as CoreDestination } from '@walkeros/core';\n\nexport interface Settings {\n  name?: string;\n  values?: string[];\n}\n\nexport interface Mapping {}\n\nexport interface Env extends CoreDestination.BaseEnv {\n  log?: (msg: string) => void;\n}\n\nexport type Types = CoreDestination.Types<Settings, Mapping, Env>;\n\nexport type Destination = CoreDestination.Instance<Types>;\nexport type Config = CoreDestination.Config<Types>;\nexport type InitFn = CoreDestination.InitFn<Types>;\nexport type PushFn = CoreDestination.PushFn<Types>;\n","import type { WalkerOS } from '@walkeros/core';\nimport type { Destination } from './types';\n\nexport * as DestinationDemo from './types';\n\n/**\n * Demo destination for walkerOS\n *\n * Logs events using env.log (or console.log fallback) with optional field filtering.\n * Perfect for testing and demonstrations without external dependencies.\n */\nexport const destinationDemo: Destination = {\n  type: 'demo',\n\n  config: {\n    settings: {\n      name: 'demo',\n    },\n  },\n\n  init({ config, env }) {\n    // eslint-disable-next-line no-console\n    const log = env?.log || console.log;\n    const settings = config?.settings || { name: 'demo' };\n\n    // Log initialization\n    log(`[${settings.name}] initialized`);\n  },\n\n  push(event, { config, env }) {\n    // eslint-disable-next-line no-console\n    const log = env?.log || console.log;\n    const settings = config?.settings || { name: 'demo' };\n\n    const output = settings.values\n      ? extractValues(\n          event as unknown as Record<string, unknown>,\n          settings.values,\n        )\n      : event;\n\n    log(`[${settings.name}] ${JSON.stringify(output, null, 2)}`);\n  },\n};\n\n/**\n * Extract values from object using dot notation paths\n */\nfunction extractValues(\n  obj: Record<string, unknown>,\n  paths: string[],\n): Record<string, unknown> {\n  const result: Record<string, unknown> = {};\n\n  for (const path of paths) {\n    const value = path\n      .split('.')\n      .reduce<unknown>(\n        (acc, key) => (acc as Record<string, unknown>)?.[key],\n        obj,\n      );\n    if (value !== undefined) {\n      result[path] = value;\n    }\n  }\n\n  return result;\n}\n\nexport default destinationDemo;\n"],"mappings":";AAAA;;;ACWO,IAAM,kBAA+B;AAAA,EAC1C,MAAM;AAAA,EAEN,QAAQ;AAAA,IACN,UAAU;AAAA,MACR,MAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,KAAK,EAAE,QAAQ,IAAI,GAAG;AAEpB,UAAM,MAAM,KAAK,OAAO,QAAQ;AAChC,UAAM,WAAW,QAAQ,YAAY,EAAE,MAAM,OAAO;AAGpD,QAAI,IAAI,SAAS,IAAI,eAAe;AAAA,EACtC;AAAA,EAEA,KAAK,OAAO,EAAE,QAAQ,IAAI,GAAG;AAE3B,UAAM,MAAM,KAAK,OAAO,QAAQ;AAChC,UAAM,WAAW,QAAQ,YAAY,EAAE,MAAM,OAAO;AAEpD,UAAM,SAAS,SAAS,SACpB;AAAA,MACE;AAAA,MACA,SAAS;AAAA,IACX,IACA;AAEJ,QAAI,IAAI,SAAS,IAAI,KAAK,KAAK,UAAU,QAAQ,MAAM,CAAC,CAAC,EAAE;AAAA,EAC7D;AACF;AAKA,SAAS,cACP,KACA,OACyB;AACzB,QAAM,SAAkC,CAAC;AAEzC,aAAW,QAAQ,OAAO;AACxB,UAAM,QAAQ,KACX,MAAM,GAAG,EACT;AAAA,MACC,CAAC,KAAK,QAAS,MAAkC,GAAG;AAAA,MACpD;AAAA,IACF;AACF,QAAI,UAAU,QAAW;AACvB,aAAO,IAAI,IAAI;AAAA,IACjB;AAAA,EACF;AAEA,SAAO;AACT;AAEA,IAAO,gBAAQ;","names":[]}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@walkeros/destination-demo",
+  "description": "Demo destination for walkerOS - logs events to console",
+  "version": "0.3.0",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/**"
+  ],
+  "scripts": {
+    "build": "tsup --silent",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
+    "dev": "jest --watchAll --colors",
+    "lint": "tsc && eslint \"**/*.ts*\"",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@walkeros/core": "0.3.0"
+  },
+  "repository": {
+    "url": "git+https://github.com/elbwalker/walkerOS.git",
+    "directory": "apps/demos/destination"
+  },
+  "author": "elbwalker <hello@elbwalker.com>",
+  "homepage": "https://github.com/elbwalker/walkerOS#readme",
+  "bugs": {
+    "url": "https://github.com/elbwalker/walkerOS/issues"
+  },
+  "keywords": [
+    "walker",
+    "walkerOS",
+    "destination",
+    "demo"
+  ]
+}