Elb

Author: alexanderkirtzel

packages/sources/walkerjs/src/types/elb.ts

@@ -1,42 +1,47 @@
-import type { WalkerOS } from '@elbwalker/types';
+import type { Elb, WalkerOS } from '@elbwalker/types';
 import { State } from './source';
 import type { On, DestinationWeb, Walker } from '.';
 
-export interface Fn
-  extends CommandInit,
-    CommandDestination,
-    CommandRun,
-    CommandOn,
-    Parameters,
-    WalkerOS.DeepPartialEvent {}
+export interface Fn<R = void>
+  extends CommandInit<R>,
+    CommandDestination<R>,
+    CommandRun<R>,
+    CommandOn<R>,
+    Parameters<R>,
+    Event<R> {}
 
-export type CommandInit = (
+export type CommandInit<R = void> = (
   event: 'walker init',
   scope: Scope | Scope[],
-) => void;
+) => R;
 
-export type CommandDestination = (
+export type CommandDestination<R = void> = (
   event: 'walker destination',
   destination: DestinationWeb.Destination | DestinationWeb.DestinationInit,
   config?: DestinationWeb.Config,
-) => void;
+) => R;
 
-export type CommandRun = (event: 'walker run', state?: Partial<State>) => void;
+export type CommandRun<R = void> = (
+  event: 'walker run',
+  state?: Partial<State>,
+) => R;
 
-export type CommandOn = (
+export type CommandOn<R = void> = (
   event: 'walker on',
   type: 'consent',
   rules: WalkerOS.SingleOrArray<On.ConsentConfig>,
-) => void;
+) => R;
 
-export type Parameters = (
+export type Parameters<R = void> = (
   event: string | unknown,
   data?: PushData,
   options?: PushOptions,
   context?: PushContext,
   nested?: WalkerOS.Entities,
   custom?: WalkerOS.Properties,
-) => void;
+) => R;
+
+export type Event<R = void> = (partialEvent: WalkerOS.DeepPartialEvent) => R;
 
 export type Layer = [
   string?,
@@ -48,14 +53,14 @@ export type Layer = [
 ];
 
 export type PushData =
-  | WalkerOS.PushData
+  | Elb.PushData
   | DestinationWeb.Destination
   | DestinationWeb.DestinationInit
   | Partial<State>
   | ScopeType;
 
 export type PushOptions =
-  | WalkerOS.PushOptions
+  | Elb.PushOptions
   | Walker.Trigger
   | WalkerOS.SingleOrArray<On.Options>
   | DestinationWeb.Config;

packages/types/src/elb.ts

@@ -0,0 +1,50 @@
+import type { Hooks, WalkerOS } from '.';
+
+export interface Fn<R = void>
+  extends CommandConfig<R>,
+    CommandConsent<R>,
+    CommandHook<R>,
+    CommandRun<R>,
+    CommandUser<R>,
+    CommandPush<R>,
+    Event<R> {}
+
+export type CommandConfig<R = void> = (
+  event: 'walker config',
+  config: Partial<WalkerOS.Config>,
+) => R;
+export type CommandConsent<R = void> = (
+  event: 'walker consent',
+  consent: WalkerOS.Consent,
+) => R;
+export type CommandHook<R = void> = <K extends keyof Hooks.Functions>(
+  event: 'walker hook',
+  name: K,
+  hookFn: Hooks.Functions[K],
+) => R;
+export type CommandRun<R = void> = (event: 'walker run') => R;
+export type CommandUser<R = void> = (
+  event: 'walker user',
+  user: WalkerOS.User,
+) => R;
+export type CommandPush<R = void> = (
+  event: string,
+  data?: PushData,
+  options?: PushOptions,
+  context?: PushContext,
+  nested?: WalkerOS.Entities,
+  custom?: WalkerOS.Properties,
+) => R;
+export type Event<R = void> = (partialEvent: WalkerOS.DeepPartialEvent) => R;
+
+export type PushData =
+  | string
+  | object
+  | WalkerOS.DeepPartial<WalkerOS.Config>
+  | WalkerOS.Consent
+  | WalkerOS.User
+  | WalkerOS.Properties;
+
+export type PushOptions = Hooks.AnyFunction | object;
+
+export type PushContext = WalkerOS.OrderedProperties;

packages/types/src/index.ts

@@ -1,5 +1,6 @@
 export * as Data from './data';
 export * as Destination from './destination';
+export * as Elb from './elb';
 export * as Handler from './handler';
 export * as Hooks from './hooks';
 export * as Mapping from './mapping';

packages/types/src/walkeros.ts

@@ -1,11 +1,11 @@
-import type { Destination, Hooks } from '.';
+import type { Destination, Elb, Hooks } from '.';
 
 export type AnyObject = Record<string, unknown>;
 export type AnyFunction = (...args: unknown[]) => unknown;
 export type SingleOrArray<T> = T | Array<T>;
 
 export interface Instance extends State {
-  push: Elb;
+  push: Elb.Fn;
 }
 
 export interface State {
@@ -30,40 +30,6 @@ export interface Config {
   verbose?: boolean; // Enable verbose logging
 }
 
-export interface Elb<R = void> {
-  (event: 'walker config', config: Partial<Config>): R;
-  (event: 'walker consent', consent: Consent): R;
-
-  <K extends keyof Hooks.Functions>(
-    event: 'walker hook',
-    name: K,
-    hookFn: Hooks.Functions[K],
-  ): R;
-  (event: 'walker run'): R;
-  (event: 'walker user', user: User): R;
-  (
-    event: string,
-    data?: PushData,
-    options?: PushOptions,
-    context?: PushContext,
-    nested?: Entities,
-    custom?: Properties,
-  ): R;
-  (partialEvent: DeepPartialEvent): R;
-}
-
-export type PushData =
-  | string
-  | object
-  | Partial<Config>
-  | Consent
-  | User
-  | Properties;
-
-export type PushOptions = Hooks.AnyFunction | object;
-
-export type PushContext = OrderedProperties;
-
 export interface Destinations {
   [name: string]: Destination.Destination;
 }