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

libs/internal-sdk/src/react-query/cancel.ts
116 строк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 { cancel } from "../funcs/cancel.js";
import { combineSignals } from "../lib/primitives.js";
import { RequestOptions } from "../lib/sdks.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 CancelMutationVariables = {
  transactionId: string;
  idempotencyKey?: string | undefined;
  options?: RequestOptions;
};

export type CancelMutationData = operations.EventsControllerCancelResponse;

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

/**
 * Cancel triggered event
 *
 * @remarks
 *
 *     Using a previously generated transactionId during the event trigger,
 *      will cancel any active or pending workflows. This is useful to cancel active digests, delays etc...
 */
export function useCancelMutation(
  options?: MutationHookOptions<
    CancelMutationData,
    CancelMutationError,
    CancelMutationVariables
  >,
): UseMutationResult<
  CancelMutationData,
  CancelMutationError,
  CancelMutationVariables
> {
  const client = useNovuContext();
  return useMutation({
    ...buildCancelMutation(client, options),
    ...options,
  });
}

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

export function buildCancelMutation(
  client$: NovuCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: CancelMutationVariables,
  ) => Promise<CancelMutationData>;
} {
  return {
    mutationKey: mutationKeyCancel(),
    mutationFn: function cancelMutationFn({
      transactionId,
      idempotencyKey,
      options,
    }): Promise<CancelMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(cancel(
        client$,
        transactionId,
        idempotencyKey,
        mergedOptions,
      ));
    },
  };
}