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

libs/internal-sdk/src/react-query/workflowsList.ts
153 строки4 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 {
  InvalidateQueryFilters,
  QueryClient,
  useQuery,
  UseQueryResult,
  useSuspenseQuery,
  UseSuspenseQueryResult,
} from "@tanstack/react-query";
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 { useNovuContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildWorkflowsListQuery,
  prefetchWorkflowsList,
  queryKeyWorkflowsList,
  WorkflowsListQueryData,
} from "./workflowsList.core.js";
export {
  buildWorkflowsListQuery,
  prefetchWorkflowsList,
  queryKeyWorkflowsList,
  type WorkflowsListQueryData,
};

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

/**
 * List all workflows
 *
 * @remarks
 * Retrieves a list of workflows with optional filtering and pagination
 */
export function useWorkflowsList(
  request: operations.WorkflowControllerSearchWorkflowsRequest,
  options?: QueryHookOptions<WorkflowsListQueryData, WorkflowsListQueryError>,
): UseQueryResult<WorkflowsListQueryData, WorkflowsListQueryError> {
  const client = useNovuContext();
  return useQuery({
    ...buildWorkflowsListQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * List all workflows
 *
 * @remarks
 * Retrieves a list of workflows with optional filtering and pagination
 */
export function useWorkflowsListSuspense(
  request: operations.WorkflowControllerSearchWorkflowsRequest,
  options?: SuspenseQueryHookOptions<
    WorkflowsListQueryData,
    WorkflowsListQueryError
  >,
): UseSuspenseQueryResult<WorkflowsListQueryData, WorkflowsListQueryError> {
  const client = useNovuContext();
  return useSuspenseQuery({
    ...buildWorkflowsListQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setWorkflowsListData(
  client: QueryClient,
  queryKeyBase: [
    parameters: {
      limit?: number | undefined;
      offset?: number | undefined;
      orderDirection?: components.DirectionEnum | undefined;
      orderBy?: components.WorkflowResponseDtoSortField | undefined;
      query?: string | undefined;
      tags?: Array<string> | undefined;
      status?: Array<components.WorkflowStatusEnum> | undefined;
      idempotencyKey?: string | undefined;
    },
  ],
  data: WorkflowsListQueryData,
): WorkflowsListQueryData | undefined {
  const key = queryKeyWorkflowsList(...queryKeyBase);

  return client.setQueryData<WorkflowsListQueryData>(key, data);
}

export function invalidateWorkflowsList(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [parameters: {
      limit?: number | undefined;
      offset?: number | undefined;
      orderDirection?: components.DirectionEnum | undefined;
      orderBy?: components.WorkflowResponseDtoSortField | undefined;
      query?: string | undefined;
      tags?: Array<string> | undefined;
      status?: Array<components.WorkflowStatusEnum> | undefined;
      idempotencyKey?: string | undefined;
    }]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@novu/api", "Workflows", "list", ...queryKeyBase],
  });
}

export function invalidateAllWorkflowsList(
  client: QueryClient,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@novu/api", "Workflows", "list"],
  });
}