Class DynamicTrigger

packages/trigger-sdk/src/triggers/dynamic.ts:40–169

/** `DynamicTrigger` allows you to define a trigger that can be configured dynamically at runtime. */
export class DynamicTrigger<
  TEventSpec extends EventSpecification<any>,
  TExternalSource extends ExternalSource<any, any, any>,
> implements Trigger<TEventSpec>
{
  #client: TriggerClient;
  #options: DynamicTriggerOptions<TEventSpec, TExternalSource>;
  source: TExternalSource;

  /** `DynamicTrigger` allows you to define a trigger that can be configured dynamically at runtime.
   * @param client The `TriggerClient` instance to use for registering the trigger.
   * @param options The options for the dynamic trigger.
   * */
  constructor(client: TriggerClient, options: DynamicTriggerOptions<TEventSpec, TExternalSource>) {
    this.#client = client;
    this.#options = options;
    this.source = options.source;

    client.attachDynamicTrigger(this);
  }

  toJSON(): TriggerMetadata {
    return {
      type: "dynamic",
      id: this.#options.id,
    };
  }

  get id() {
    return this.#options.id;
  }

  get event() {
    return this.#options.event;
  }

  // @internal
  registeredTriggerForParams(
    params: ExternalSourceParams<TExternalSource>,
    options: { accountId?: string; filter?: EventFilter } = {}
  ): RegisterTriggerBodyV2 {
    const key = slugifyId(this.source.key(params));

    return {
      rule: {
        event: this.event.name,
        source: this.event.source,
        payload: deepMergeFilters(
          this.source.filter(params),
          this.event.filter ?? {},
          options.filter ?? {}
        ),
      },
      source: {
        version: "2",
        key,
        channel: this.source.channel,
        params,