packages/shared/src/utils/buildWorkflowPreferences.ts - next - githubmirror/novu

packages/shared/src/utils/buildWorkflowPreferences.ts

64 строки2 KB

Dima Grossman

fix(api-service): remove setImmediate yielding in subscriber preferences hot path fixes NV-8111 (#11635)

23 июн 2026, 13:01

23 июн 2026, 13:016088176

import { DEFAULT_WORKFLOW_PREFERENCES } from '../consts';
import { IPreferenceChannels } from '../entities/subscriber-preference';
import { ChannelTypeEnum, WorkflowPreference, WorkflowPreferences, WorkflowPreferencesPartial } from '../types';

/**
 * Given any partial input of preferences, output a complete preferences object that:
 * - First uses channel-level preferences
 * - Uses the workflow-level preference as defaults for channel preferences if not specified
 * - Lastly, uses the defaults we've defined
 */
export const buildWorkflowPreferences = (
  inputPreferences: WorkflowPreferencesPartial | undefined | null,
  defaultPreferences: WorkflowPreferences = DEFAULT_WORKFLOW_PREFERENCES
): WorkflowPreferences => {
  if (!inputPreferences) {
    return defaultPreferences;
  }

  const defaultChannelPreference =
    inputPreferences.all?.enabled !== undefined ? { enabled: inputPreferences.all.enabled } : {};

  const channels = { ...defaultPreferences.channels };

  for (const channel of Object.values(ChannelTypeEnum)) {
    channels[channel] = {
      ...defaultPreferences.channels[channel],
      ...defaultChannelPreference,
      ...inputPreferences.channels?.[channel],
    };
  }

  return {
    ...defaultPreferences,
    all: {
      ...defaultPreferences.all,
      // DeepPartial loosens json-logic types; assert back to the concrete workflow preference before merging.
      ...(inputPreferences.all as WorkflowPreference),
    },
    channels,
  };
};

/**
 * Given a `critical` flag and a `IPreferenceChannels` object, build a `WorkflowPreferences` object
 *
 * @deprecated use `buildWorkflowPreferences` instead
 */
export const buildWorkflowPreferencesFromPreferenceChannels = (
  critical: boolean = false,
  preferenceChannels: IPreferenceChannels = {}
): WorkflowPreferences => {
  return buildWorkflowPreferences({
    all: { enabled: true, readOnly: critical },
    channels: Object.entries(preferenceChannels).reduce(
      (output, [channel, value]) => ({
        ...output,
        [channel as ChannelTypeEnum]: {
          enabled: value,
        },
      }),
      {} as WorkflowPreferences['channels']
    ),
  });
};