libs/internal-sdk/src/react-query/triggerBroadcast.ts - next - githubmirror/novu

libs/internal-sdk/src/react-query/triggerBroadcast.ts
118 строк3 KB
Dima Grossman
chore(root): sdk gen version update for latest internal sdk changes (#10651)
10 апр 2026, 16:36
10 апр 2026, 16:36b5e0674
/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import {
  MutationKey,
  useMutation,
  UseMutationResult,
} from "@tanstack/react-query";
import { NovuCore } from "../core.js";
import { triggerBroadcast } from "../funcs/triggerBroadcast.js";
import { combineSignals } from "../lib/primitives.js";
import { RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import * as errors from "../models/errors/index.js";
import { NovuError } from "../models/errors/novuerror.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import * as operations from "../models/operations/index.js";
import { unwrapAsync } from "../types/fp.js";
import { useNovuContext } from "./_context.js";
import { MutationHookOptions } from "./_types.js";

export type TriggerBroadcastMutationVariables = {
  triggerEventToAllRequestDto: components.TriggerEventToAllRequestDto;
  idempotencyKey?: string | undefined;
  options?: RequestOptions;
};

export type TriggerBroadcastMutationData =
  operations.EventsControllerBroadcastEventToAllResponse;

export type TriggerBroadcastMutationError =
  | errors.PayloadValidationExceptionDto
  | errors.ErrorDto
  | errors.ValidationErrorDto
  | NovuError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Broadcast event to all
 *
 * @remarks
 * Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.
 *       In the future could be used to trigger events to a subset of subscribers based on defined filters.
 */
export function useTriggerBroadcastMutation(
  options?: MutationHookOptions<
    TriggerBroadcastMutationData,
    TriggerBroadcastMutationError,
    TriggerBroadcastMutationVariables
  >,
): UseMutationResult<
  TriggerBroadcastMutationData,
  TriggerBroadcastMutationError,
  TriggerBroadcastMutationVariables
> {
  const client = useNovuContext();
  return useMutation({
    ...buildTriggerBroadcastMutation(client, options),
    ...options,
  });
}

export function mutationKeyTriggerBroadcast(): MutationKey {
  return ["@novu/api", "triggerBroadcast"];
}

export function buildTriggerBroadcastMutation(
  client$: NovuCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: TriggerBroadcastMutationVariables,
  ) => Promise<TriggerBroadcastMutationData>;
} {
  return {
    mutationKey: mutationKeyTriggerBroadcast(),
    mutationFn: function triggerBroadcastMutationFn({
      triggerEventToAllRequestDto,
      idempotencyKey,
      options,
    }): Promise<TriggerBroadcastMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(triggerBroadcast(
        client$,
        triggerEventToAllRequestDto,
        idempotencyKey,
        mergedOptions,
      ));
    },
  };
}