@pixotope/query 0.0.1

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../utils/dist/comparison/index.js","../src/factories.ts","../src/useMutation.ts","../src/useQuery.ts","../src/useSubscriptionCore.ts","../src/useSubscription.ts"],"sourcesContent":["\"use strict\";\nvar __defProp = Object.defineProperty;\nvar __getOwnPropDesc = Object.getOwnPropertyDescriptor;\nvar __getOwnPropNames = Object.getOwnPropertyNames;\nvar __hasOwnProp = Object.prototype.hasOwnProperty;\nvar __export = (target, all) => {\n  for (var name in all)\n    __defProp(target, name, { get: all[name], enumerable: true });\n};\nvar __copyProps = (to, from, except, desc) => {\n  if (from && typeof from === \"object\" || typeof from === \"function\") {\n    for (let key of __getOwnPropNames(from))\n      if (!__hasOwnProp.call(to, key) && key !== except)\n        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });\n  }\n  return to;\n};\nvar __toCommonJS = (mod) => __copyProps(__defProp({}, \"__esModule\", { value: true }), mod);\n\n// src/comparison/index.ts\nvar comparison_exports = {};\n__export(comparison_exports, {\n  shallowEqual: () => shallowEqual\n});\nmodule.exports = __toCommonJS(comparison_exports);\n\n// src/comparison/shallowEqual.ts\nfunction shallowEqual(objA, objB) {\n  if (Object.is(objA, objB)) {\n    return true;\n  }\n  if (typeof objA !== \"object\" || objA === null || typeof objB !== \"object\" || objB === null) {\n    return false;\n  }\n  if (objA instanceof Map && objB instanceof Map) {\n    if (objA.size !== objB.size) return false;\n    for (const [key, value] of objA) {\n      if (!Object.is(value, objB.get(key))) {\n        return false;\n      }\n    }\n    return true;\n  }\n  if (objA instanceof Set && objB instanceof Set) {\n    if (objA.size !== objB.size) return false;\n    for (const value of objA) {\n      if (!objB.has(value)) {\n        return false;\n      }\n    }\n    return true;\n  }\n  const keysA = Object.keys(objA);\n  if (keysA.length !== Object.keys(objB).length) {\n    return false;\n  }\n  for (let i = 0; i < keysA.length; i++) {\n    if (!Object.prototype.hasOwnProperty.call(objB, keysA[i]) || !Object.is(objA[keysA[i]], objB[keysA[i]])) {\n      return false;\n    }\n  }\n  return true;\n}\n// Annotate the CommonJS export names for ESM import in node:\n0 && (module.exports = {\n  shallowEqual\n});\n","import { useCallback, useMemo } from \"react\";\nimport { MutationOptions, useMutation } from \"./useMutation\";\nimport { QueryOptions, useQuery } from \"./useQuery\";\nimport type { DHClientWebSocketProxy } from \"@pixotope/zmq-client\";\n\nexport type MutationInfo<TData, TError, TParams> = {\n  data: TData;\n  error: TError;\n  params: TParams;\n};\n\ntype FnToParamsBase = Record<string, MutationInfo<unknown, unknown, unknown>>;\n\nconst useCallMutationBase = <\n  TFnToParams extends FnToParamsBase,\n  TData = unknown,\n  TError = unknown,\n  TParams = unknown,\n>(\n  clientProxy: DHClientWebSocketProxy,\n  functionName: keyof TFnToParams,\n  service: string,\n  options?: Omit<MutationOptions<TData, TError, TParams>, \"mutationFn\"> & {\n    avoidTimeout?: boolean;\n    customTimeout?: number;\n  }\n) => {\n  const {\n    avoidTimeout = true,\n    customTimeout = undefined,\n    ...rest\n  } = useMemo(() => options ?? {}, [options]);\n  const mutationFn = useCallback(\n    async (parameters: TParams) => {\n      try {\n        const res = await clientProxy.callAsync<TData, TParams>({\n          service,\n          functionName: functionName.toString(),\n          parameters,\n          options: {\n            avoidTimeout,\n            customTimeout,\n          },\n        });\n\n        return res.message.Result;\n      } catch (e: any) {\n        throw e.message;\n      }\n    },\n    [avoidTimeout, customTimeout, functionName, service]\n  );\n\n  return useMutation<TData, TError, TParams>({\n    mutationFn,\n    ...rest,\n  });\n};\n\nexport function buildMutationHook<TFnToParams extends FnToParamsBase>(\n  socketClientProxy: DHClientWebSocketProxy,\n  genTargetService: (machine: string | undefined) => string\n) {\n  return function useCallMutationBuilder<TFn extends keyof TFnToParams>(\n    func: TFn,\n    options?: Parameters<\n      typeof useCallMutationBase<\n        TFnToParams,\n        TFnToParams[TFn][\"data\"],\n        TFnToParams[TFn][\"error\"],\n        TFnToParams[TFn][\"params\"]\n      >\n    >[3] & { machine?: string }\n  ) {\n    const targetService = genTargetService(options?.machine);\n\n    return useCallMutationBase<\n      TFnToParams,\n      TFnToParams[TFn][\"data\"],\n      TFnToParams[TFn][\"error\"],\n      TFnToParams[TFn][\"params\"]\n    >(socketClientProxy, func, targetService, options);\n  };\n}\n\nconst useCallQueryBase = <\n  TFnToParams extends FnToParamsBase,\n  TData = unknown,\n  TError = unknown,\n  TParams = unknown,\n  TSelect = TData,\n>(\n  clientProxy: DHClientWebSocketProxy,\n  functionName: keyof TFnToParams,\n  params: TParams,\n  service: string,\n  options?: Omit<QueryOptions<TData, TError, TParams, TSelect>, \"queryFn\"> & {\n    avoidTimeout?: boolean;\n    customTimeout?: number;\n  }\n) => {\n  const {\n    avoidTimeout = true,\n    customTimeout = undefined,\n    ...rest\n  } = useMemo(() => options ?? {}, [options]);\n  const queryFn = useCallback(\n    async (refetchParams: TParams | void, overrideTargetMachine?: string) => {\n      try {\n        const res = await clientProxy.callAsync<TData, TParams>({\n          service: overrideTargetMachine ?? service,\n          functionName: functionName.toString(),\n          parameters: refetchParams ?? params,\n          options: {\n            avoidTimeout,\n            customTimeout,\n          },\n        });\n        return res.message.Result;\n      } catch (e) {\n        if (e instanceof Error) {\n          throw e;\n        }\n        throw new Error(e as string);\n      }\n    },\n    [avoidTimeout, customTimeout, functionName, service, params]\n  );\n\n  return useQuery<TData, TError, TParams, TSelect>({\n    queryFn,\n    ...rest,\n  });\n};\n\nexport function buildQueryHook<TFnToParams extends FnToParamsBase>(\n  clientSocketProxy: DHClientWebSocketProxy,\n  getTargetService: (machine: string | undefined) => string\n) {\n  return function useCallQueryBuilder<\n    TFn extends keyof TFnToParams,\n    TSelect = TFnToParams[TFn][\"data\"],\n  >(\n    func: TFn,\n    params: TFnToParams[TFn][\"params\"],\n    options?: Parameters<\n      typeof useCallQueryBase<\n        TFnToParams,\n        TFnToParams[TFn][\"data\"],\n        TFnToParams[TFn][\"error\"],\n        TFnToParams[TFn][\"params\"],\n        TSelect\n      >\n    >[4] & { machine?: string }\n  ) {\n    const targetService = getTargetService(options?.machine);\n\n    return useCallQueryBase<\n      TFnToParams,\n      TFnToParams[TFn][\"data\"],\n      TFnToParams[TFn][\"error\"],\n      TFnToParams[TFn][\"params\"],\n      TSelect\n    >(clientSocketProxy, func, params, targetService, options);\n  };\n}\n","import { useCallback, useRef, useState } from \"react\";\n\nexport type MutationFunction<TData = unknown, TParams = unknown> = (\n  params: TParams,\n  overrideTargetMachine?: string\n) => Promise<TData>;\n\nexport interface MutationOptions<\n  TData = unknown,\n  TError = unknown,\n  TParams = void,\n> {\n  mutationFn: MutationFunction<TData, TParams>;\n  params?: TParams;\n  onSuccess?: (data: TData, variables: TParams) => Promise<unknown> | unknown;\n  onError?: (error: TError, variables: TParams) => Promise<unknown> | unknown;\n  onSettled?: (\n    data: TData | undefined,\n    error: TError | null,\n    variables: TParams\n  ) => Promise<unknown> | unknown;\n  compareOrThrow?: (result: TData | TError) => boolean;\n  timeout?: number;\n  prepareParams?: (variables: TParams, defaults?: TParams) => TParams;\n}\n\nexport interface MutateOptions<\n  TData = unknown,\n  TError = unknown,\n  TParams = void,\n> {\n  onSuccess?: (data: TData, variables: TParams) => void;\n  onError?: (error: TError, variables: TParams) => void;\n  onSettled?: (\n    data: TData | undefined,\n    error: TError | null,\n    variables: TParams\n  ) => void;\n}\n\ntype MutationStatus = \"idle\" | \"loading\" | \"success\" | \"error\";\ntype RaceErrorReason = \"timeout\";\ntype RacePromises<T> = Promise<T | RaceErrorReason>;\n\nexport class ComparisonFailError<TPayload = unknown> extends Error {\n  public readonly payload: TPayload;\n\n  constructor(message: string, payload: TPayload) {\n    super(message);\n    this.name = this.constructor.name;\n    this.payload = payload;\n\n    if (Error.captureStackTrace) {\n      Error.captureStackTrace(this, ComparisonFailError);\n    }\n  }\n}\n\n/**\n * `useMutation` is a hook that allows you to perform a mutation/push updates to the services while\n * providing extensive API to tap into the status and results of the mutation.\n * @param mutationFn The mutation function to be called when the `mutate` function is called.\n * `useMutation` does not care about what the function does, all it needs it a function that returns\n * a promise.\n * @param options Options to configure the mutation.\n * @returns An object with the following properties:\n * - `mutateAsync`: A function that takes in the variables and returns a promise that resolves to the\n * result of the mutation. This function can be awaited to get the result of the mutation. Callbacks can\n * be passed to this function to be called when the mutation is successful or when it fails. It's good idea\n * to wrap this function in a try/catch block.\n * - `mutate`: A function that takes in the variables and returns nothing. This function does not\n * return a promise. Callbacks can be passed to this function to be called when the mutation is\n * successful or when it fails.\n * - `status`: The status of the mutation. Can be one of `idle`, `loading`, `success` or `error`.\n * - `result`: The result of the mutation. This is undefined until the mutation is successful.\n * - `reset`: A function that resets the mutation to the initial state.\n * - `error`: The error object if the mutation has failed.\n * @example\n * ```typescript\n * const mutationRes = useMutation({\n *    mutationFn: (variables) => {\n *      return ZMQHelper.callSomethingAsync(variables)\n *    },\n *    onSuccess: (data) => {\n *      // do something with the result\n *    },\n *    onError: (error) => {\n *      // do something with the error\n *    },\n *    onSettled: (data, error) => {\n *      // do something when the mutation is done\n *   }});\n *\n * // call the mutation\n * const res = await mutationRes.mutateAsync({ foo: \"bar\" });\n * // OR\n * mutationRes.mutate({ foo: \"bar\" }, {\n *  onSuccess: (data) => {\n *    // do something with the result\n *    // for example show a toast message\n *    // stop local loading state\n * });\n * ```\n */\nexport const useMutation = <TData = unknown, TError = unknown, TParams = void>(\n  options: MutationOptions<TData, TError, TParams>\n) => {\n  const {\n    mutationFn,\n    compareOrThrow,\n    onError,\n    onSettled,\n    onSuccess,\n    prepareParams,\n    params,\n    timeout,\n  } = options;\n  const [status, setStatus] = useState<MutationStatus>(\"idle\");\n  const [error, setError] = useState<TError | null>(null);\n  const [result, setResult] = useState<TData | undefined>(undefined);\n  const mutationFnRef = useRef(mutationFn);\n  const internalOptionsRef = useRef({\n    params,\n    timeout,\n  });\n  const internalCallbackRefistry = <const>{\n    onSuccess,\n    onError,\n    onSettled,\n    compareOrThrow,\n    prepareParams,\n  };\n  const internalCallbackRef = useRef(internalCallbackRefistry);\n  internalCallbackRef.current = internalCallbackRefistry;\n\n  const mutateAsync = useCallback(\n    async (params: TParams, overrideTargetMachine?: string) => {\n      setStatus(\"loading\");\n      setError(null);\n\n      try {\n        const promises: RacePromises<TData>[] = [\n          mutationFnRef.current(\n            internalCallbackRef.current.prepareParams\n              ? internalCallbackRef.current.prepareParams(\n                  params,\n                  internalOptionsRef.current.params\n                )\n              : params,\n            overrideTargetMachine\n          ),\n          ...(internalOptionsRef.current.timeout\n            ? [\n                new Promise<RaceErrorReason>((resolve) =>\n                  setTimeout(\n                    () => resolve(\"timeout\"),\n                    internalOptionsRef.current.timeout\n                  )\n                ),\n              ]\n            : []),\n        ];\n\n        const res = await Promise.race(promises);\n\n        if (res === \"timeout\") {\n          throw new Error(\"timeout\");\n        }\n\n        if (internalCallbackRef.current.compareOrThrow?.(res)) {\n          throw new ComparisonFailError(JSON.stringify(res), res);\n        }\n\n        setResult(res);\n        setStatus(\"success\");\n\n        internalCallbackRef.current.onSuccess?.(res, params);\n        internalCallbackRef.current.onSettled?.(res, null, params);\n\n        return res;\n      } catch (error: any) {\n        setError(error);\n        setStatus(\"error\");\n\n        if (internalCallbackRef.current.onError) {\n          internalCallbackRef.current.onError(error, params);\n        }\n\n        if (internalCallbackRef.current.onSettled) {\n          internalCallbackRef.current.onSettled(undefined, error, params);\n        }\n\n        throw error;\n      }\n    },\n    []\n  );\n\n  const mutate = useCallback(\n    (\n      variables: TParams,\n      options?: MutateOptions<TData, TError, TParams> & {\n        overrideTargetMachine?: string;\n      }\n    ) => {\n      mutateAsync(variables, options?.overrideTargetMachine).then(\n        (data) => {\n          options?.onSuccess?.(data, variables);\n          options?.onSettled?.(data, null, variables);\n        },\n        (error) => {\n          options?.onError?.(error, variables);\n          options?.onSettled?.(undefined, error, variables);\n        }\n      );\n    },\n    [mutateAsync]\n  );\n\n  return {\n    mutateAsync,\n    status,\n    result,\n    mutate,\n    reset: () => setStatus(\"idle\"),\n    error,\n  };\n};\n","import { useCallback, useEffect, useRef, useState } from \"react\";\n\nexport interface QueryOptions<\n  TData = unknown,\n  TError = unknown,\n  TParams = void,\n  TSelectData = TData,\n  Stateless extends true | undefined = undefined,\n> {\n  queryFn: (params: TParams | undefined | void) => Promise<TData>;\n  onSuccess?: (data: TData) => Promise<void> | void;\n  onError?: (error: TError) => Promise<void> | void;\n  onSettled?: (\n    data: TData | undefined,\n    error: TError | undefined\n  ) => Promise<void> | void;\n  timeout?: number;\n  enabled?: boolean;\n  initialData?: TData | Functionize<TData>;\n  select?: (data: TData) => TSelectData;\n  refetchOnWindowFocus?: boolean;\n  refetchInterval?: number;\n  compareOrThrow?: (data: TData) => boolean;\n  stateless?: Stateless;\n  key?: TQueryKey;\n}\n\ntype Functionize<T> = () => T;\ntype QueryStatus = \"idle\" | \"loading\" | \"success\" | \"error\" | \"timeout\";\ntype RaceErrorReason = \"timeout\";\ntype RacePromises<T> = Promise<T | RaceErrorReason>;\ntype WithData<TData> = { data: TData | undefined };\ntype TQueryKey = readonly any[];\n\nexport type UseQueryResult<\n  TData = unknown,\n  TError = unknown,\n  TParams = void,\n  TSelectData = TData,\n  Stateless extends true | undefined = undefined,\n> = {\n  error: TError | null;\n  status: QueryStatus;\n  refetch: (params: TParams | void | undefined) => Promise<void>;\n  reset: () => void;\n  // eslint-disable-next-line @typescript-eslint/no-empty-object-type\n} & (Stateless extends true ? {} : WithData<TSelectData>);\n\nfunction normalizeQueryKey(queryKey: TQueryKey): string {\n  return JSON.stringify(queryKey);\n}\n\ntype TInternalCallbackRef<TData, TError, TSelectData> = {\n  onError?: (error: TError) => Promise<void> | void;\n  onSuccess?: (data: TData) => Promise<void> | void;\n  onSettled?: (\n    data: TData | undefined,\n    error: TError | undefined\n  ) => Promise<void> | void;\n  compareOrThrow?: (data: TData) => boolean;\n  select?: (data: TData) => TSelectData;\n};\n\ntype TInternalOptionsRef<TData> = {\n  timeout?: number;\n  enabled: boolean;\n  refetchOnWindowFocus: boolean;\n  refetchInterval: number;\n  compareOrThrow?: (data: TData) => boolean;\n  stateless?: boolean;\n};\n\nexport const useQuery = <\n  TData = unknown,\n  TError = unknown,\n  TParams = void,\n  TSelected = TData,\n  Stateless extends true | undefined = undefined,\n>({\n  queryFn,\n  ...options\n}: QueryOptions<TData, TError, TParams, TSelected, Stateless>): UseQueryResult<\n  TSelected,\n  TError,\n  TParams,\n  TSelected,\n  Stateless\n> => {\n  const {\n    enabled = true,\n    refetchOnWindowFocus = false,\n    refetchInterval = 0,\n    initialData,\n    select,\n    onError,\n    onSuccess,\n    onSettled,\n    timeout,\n    compareOrThrow,\n    stateless,\n    key: queryKeyPassed,\n  } = options;\n  const queryKey = normalizeQueryKey(queryKeyPassed ?? []);\n  const promiseResolutionInProgress = useRef(false);\n  const lastFetchedAt = useRef<number | null>(null);\n  const lastQueryKey = useRef<string | undefined>(undefined);\n  const queryFnRef = useRef(queryFn);\n  queryFnRef.current = queryFn;\n  const internalCallbackRef = useRef<\n    TInternalCallbackRef<TData, TError, TSelected>\n  >({});\n  internalCallbackRef.current = {\n    onError,\n    onSuccess,\n    onSettled,\n    compareOrThrow,\n    select,\n  };\n  const internalOptionsRef = useRef<TInternalOptionsRef<TData>>({\n    enabled,\n    refetchOnWindowFocus,\n    refetchInterval,\n    compareOrThrow,\n    stateless,\n    timeout,\n  });\n  internalOptionsRef.current = {\n    enabled,\n    refetchOnWindowFocus,\n    refetchInterval,\n    compareOrThrow,\n    stateless,\n    timeout,\n  };\n\n  const [status, setStatus] = useState<QueryStatus>(() => {\n    return \"idle\";\n  });\n  const [error, setError] = useState<TError | null>(null);\n  const [data, setData] = useState<TData | undefined>(() => {\n    if (initialData !== undefined) {\n      if (typeof initialData === \"function\") {\n        return (initialData as Functionize<TData>)();\n      }\n\n      return initialData as TData;\n    }\n\n    return undefined;\n  });\n\n  const handleSetData = useCallback((data: TData) => {\n    if (internalOptionsRef.current.stateless) {\n      return;\n    }\n\n    setData(data);\n  }, []);\n\n  const shouldRefetch = useCallback(() => {\n    if (!internalOptionsRef.current.enabled) {\n      return false;\n    }\n\n    if (lastFetchedAt.current === null) {\n      return true;\n    }\n\n    return (\n      new Date().getTime() - lastFetchedAt.current >\n      internalOptionsRef.current?.refetchInterval\n    );\n  }, []);\n\n  const refetch = useCallback(\n    async (params: TParams | void | undefined = undefined) => {\n      if (\n        promiseResolutionInProgress.current ||\n        !internalOptionsRef.current.enabled\n      ) {\n        return;\n      }\n\n      setStatus(\"loading\");\n      setError(null);\n\n      try {\n        const promises: RacePromises<TData>[] = [\n          queryFnRef.current(params),\n          ...(internalOptionsRef.current.timeout\n            ? [\n                new Promise<RaceErrorReason>((resolve) =>\n                  setTimeout(\n                    () => resolve(\"timeout\"),\n                    internalOptionsRef.current.timeout\n                  )\n                ),\n              ]\n            : []),\n        ];\n\n        promiseResolutionInProgress.current = true;\n        const res = await Promise.race(promises);\n        promiseResolutionInProgress.current = false;\n\n        if (res === \"timeout\") {\n          throw new Error(\"timeout\");\n        }\n\n        handleSetData(res);\n\n        if (\n          internalCallbackRef.current.compareOrThrow &&\n          internalCallbackRef.current.compareOrThrow(res) === true\n        ) {\n          throw new Error(\"compareOrThrow\");\n        }\n\n        setStatus(\"success\");\n        lastFetchedAt.current = new Date().getTime();\n        internalCallbackRef.current.onSuccess?.(res);\n        internalCallbackRef.current.onSettled?.(res, undefined);\n      } catch (error: any) {\n        setError(error);\n        setStatus(\"error\");\n        internalCallbackRef.current.onError?.(error);\n        internalCallbackRef.current.onSettled?.(undefined, error);\n      }\n    },\n    [handleSetData]\n  );\n\n  const reset = useCallback(() => {\n    setData(undefined);\n    setStatus(\"idle\");\n    setError(null);\n    refetch();\n  }, [refetch]);\n\n  useEffect(() => {\n    if (enabled) {\n      refetch();\n    }\n  }, [enabled, refetch, queryKey]);\n\n  useEffect(() => {\n    if (lastQueryKey.current === undefined) {\n      lastQueryKey.current = queryKey;\n      refetch();\n      return;\n    }\n\n    if (queryKey !== lastQueryKey.current) {\n      lastQueryKey.current = queryKey;\n      refetch();\n    }\n  }, [queryKey, refetch, enabled]);\n\n  useEffect(() => {\n    if (refetchOnWindowFocus) {\n      const queryHandleFocus = () => {\n        if (shouldRefetch()) {\n          refetch();\n        }\n      };\n\n      window.addEventListener(\"focus\", queryHandleFocus);\n\n      return () => {\n        window.removeEventListener(\"focus\", queryHandleFocus);\n      };\n    }\n  }, [refetchOnWindowFocus, refetch, shouldRefetch]);\n\n  useEffect(() => {\n    if (refetchInterval !== 0) {\n      const interval = setInterval(\n        () => {\n          if (shouldRefetch()) {\n            refetch();\n          }\n        },\n        Math.max(refetchInterval, 1000)\n      );\n\n      return () => {\n        clearInterval(interval);\n      };\n    }\n  }, [refetch, refetchInterval, shouldRefetch]);\n\n  return {\n    data:\n      select && data !== undefined\n        ? select(data as TData)\n        : (data as unknown as TSelected),\n    error,\n    status,\n    refetch,\n    reset,\n  };\n};\n","/**\n * @fileoverview useSubscriptionCore\n * @name useSubscriptionCore.ts\n * @description useSubscriptionCore | This hook handle core subscription logic\n * and provides a way to subscribe and unsubscribe to a topic via any callback\n */\n\nimport { shallowEqual } from \"@pixotope/utils/comparison\";\nimport { useCallback, useEffect, useMemo, useRef, useState } from \"react\";\n\ntype SubscriptionState = \"idle\" | \"subscribed\" | \"subscribing\";\nexport type MessageHandler<TMessage> = (message: TMessage) => void;\nexport type Connection = {\n  acknowledge: () => void;\n};\nexport type SubscriptionCoreOptions<\n  TData,\n  TMessage = TData,\n  Stateless extends true | undefined = undefined,\n> = {\n  /**\n   * @description Function that will be called when the message is received.\n   */\n  onMessage?: (message: TMessage) => void;\n  /**\n   * @description Function that will be called when the subscription is created.\n   */\n  onSubscribed?: (message: TMessage) => void;\n  /**\n   * @description Function that will be called when the subscription is created.\n   */\n  onError?: (error: TMessage) => void;\n  /**\n   * @description Whether the subscription is enabled.\n   * @default true\n   */\n  enabled?: boolean;\n  /**\n   * @description Function that will be called to compare the message with the\n   * previous message. If the function returns true, the message will be ignored.\n   */\n  compareOrThrow?: (data: TMessage) => boolean;\n  /**\n   * @description Function that will be called to select the data from the message.\n   */\n  select?: (data: TMessage) => TData;\n  /**\n   * @description Initial state of the subscription.\n   * @default undefined\n   */\n  initialState?: TData;\n  /**\n   * @description Function that will be called when the subscription is created.\n   */\n  subscriberFn: (\n    handler: MessageHandler<TMessage>,\n    connection: Connection\n  ) => () => void /** unsubscribe Fn */;\n  /**\n   * @description Whether the subscription is stateless. Data will not be\n   * stored by the hook internally.\n   * @default false\n   */\n  stateless?: Stateless;\n  /**\n   * @description Custom equality function for comparing data.\n   * @default shallowEqual\n   */\n  isEqual?: <T = TData>(a: T, b: T) => boolean;\n};\n\ntype WithStatus = {\n  status: SubscriptionState;\n};\n\ntype WithData<TData> = {\n  data: TData;\n};\n\nexport type SubscriptionCoreReturnType<\n  TData,\n  Stateless extends true | undefined,\n> = {\n  reSubscribe: () => void;\n  // eslint-disable-next-line @typescript-eslint/no-empty-object-type\n} & (Stateless extends true ? {} : WithStatus & WithData<TData>);\n\n/**\n * @description `useSubscriptionCore` | This hook handle core subscription logic\n * and provides a way to subscribe and unsubscribe to a topic via any callback.\n * The hook expose a handler function. All the consumer code need to do is to\n * call this handler function with the message received from the topic or pass\n * it directly to the callback function that is passed to the subscriberFn.\n *  - `status` - current status of the subscription\n *  - `data` - the data after the select function is applied to the message\n *  - `reSubscribe` - function that can be called to re-subscribe to the topic\n *\n * An example how this hook works can be found in {@link ./useSubscription.ts}\n */\nexport function useSubscriptionCore<\n  TData = unknown,\n  TMessage = TData,\n  Stateless extends true | undefined = undefined,\n>(\n  options: SubscriptionCoreOptions<TData, TMessage, Stateless>\n): SubscriptionCoreReturnType<TData, Stateless> {\n  const {\n    enabled = true,\n    initialState = undefined,\n    onSubscribed,\n    stateless,\n    compareOrThrow,\n    subscriberFn,\n    onMessage,\n    onError,\n    select,\n    isEqual = shallowEqual,\n  } = options;\n  const [status, setStatus] = useState<SubscriptionState>(\"idle\");\n  const [data, setData] = useState<TData | undefined>(initialState);\n  const unsubcribeRef = useRef<() => void | undefined>(undefined);\n  const initialStateRef = useRef(initialState);\n  const subscriberFnRef = useRef(subscriberFn);\n  const callbackRefRegistry = <const>{\n    onMessage,\n    onError,\n    select,\n    compareOrThrow,\n    onSubscribed,\n    isEqual,\n  };\n  const internalCallbacksRef = useRef(callbackRefRegistry);\n  internalCallbacksRef.current = callbackRefRegistry;\n\n  const updateStatus = useCallback(\n    (newStatus: SubscriptionState, message?: TMessage) => {\n      if (stateless) {\n        return;\n      }\n\n      setStatus((prev) => {\n        if (prev === newStatus) {\n          return prev;\n        }\n\n        if (newStatus === \"subscribed\" && message) {\n          internalCallbacksRef.current.onSubscribed?.(message);\n        }\n\n        return newStatus;\n      });\n    },\n    [stateless]\n  );\n\n  const connection: Connection = useMemo(\n    () => ({\n      acknowledge: () => {\n        updateStatus(\"subscribed\");\n      },\n    }),\n    [updateStatus]\n  );\n\n  const handler = useCallback(\n    async (message: TMessage) => {\n      if (internalCallbacksRef.current.compareOrThrow?.(message)) {\n        internalCallbacksRef.current.onError?.(message);\n\n        return;\n      }\n\n      const selectedMessage = <TData>(\n        (internalCallbacksRef.current.select?.(message) ?? message)\n      );\n\n      if (!stateless) {\n        setData((prev) => {\n          if (isEqual(prev, selectedMessage)) {\n            return prev;\n          }\n\n          return selectedMessage;\n        });\n      }\n\n      updateStatus(\"subscribed\", message);\n      internalCallbacksRef.current.onMessage?.(message);\n    },\n    [stateless, updateStatus]\n  );\n\n  const unsubscribe = useCallback(() => {\n    updateStatus(\"idle\");\n    unsubcribeRef.current?.();\n    unsubcribeRef.current = undefined;\n  }, [updateStatus]);\n\n  const subscribe = useCallback(() => {\n    unsubcribeRef.current?.();\n    updateStatus(\"subscribing\");\n    setData(initialStateRef.current);\n    unsubcribeRef.current = subscriberFnRef.current(handler, connection);\n  }, [connection, handler, updateStatus]);\n\n  useEffect(() => {\n    if (enabled) {\n      subscribe();\n    } else {\n      unsubscribe();\n    }\n\n    return () => {\n      unsubscribe();\n    };\n  }, [enabled, subscribe, unsubscribe]);\n\n  return {\n    status,\n    data,\n    reSubscribe: subscribe,\n  } as unknown as any;\n}\n","import type { DHClientWebSocketProxy } from \"@pixotope/zmq-client\";\nimport {\n  SubscriptionCoreOptions,\n  useSubscriptionCore,\n} from \"./useSubscriptionCore\";\n\nexport type SubscriptionOptions<\n  TData,\n  TMessage = unknown,\n  Stateless extends true | undefined = undefined,\n> = Omit<\n  SubscriptionCoreOptions<TData, TMessage, Stateless>,\n  \"subscriberFn\"\n> & {\n  service: string;\n  topic: string;\n  maxDownwardDepth?: number;\n};\n\nexport type TSubscriptionHandlerFunction<TMessage> = (opts: {\n  service: string;\n  topic: string;\n  callback: (message: TMessage) => void;\n  maxDownwardDepth?: number;\n}) => () => void;\n\nexport function useSubscription<\n  TData = unknown,\n  TMessage = TData,\n  Stateless extends true | undefined = undefined,\n>(\n  subscriptionHandler: TSubscriptionHandlerFunction<TMessage>,\n  options: SubscriptionOptions<TData, TMessage, Stateless>\n) {\n  const { topic, service, maxDownwardDepth = 1000 } = options;\n\n  return useSubscriptionCore<TData, TMessage, Stateless>({\n    ...options,\n    subscriberFn: (handler) => {\n      const unsubscribe = subscriptionHandler({\n        service,\n        topic,\n        callback: (message: TMessage) => {\n          handler(message);\n        },\n        maxDownwardDepth,\n      });\n\n      return unsubscribe;\n    },\n  });\n}\n\nexport function buildServiceSubscriptionHook(\n  subscriptionHandler: TSubscriptionHandlerFunction<unknown>,\n  targetMachine: (machine: string | undefined) => string\n) {\n  return function useSubscriptionBuilder<\n    TData,\n    TMessage = TData,\n    Stateless extends true | undefined = undefined,\n  >(\n    options: Omit<\n      SubscriptionOptions<TData, TMessage, Stateless>,\n      \"service\"\n    > & {\n      machine?: string;\n    }\n  ) {\n    const targetService = targetMachine(options.machine);\n    return useSubscription<TData, TMessage, Stateless>(\n      <TSubscriptionHandlerFunction<TMessage>>subscriptionHandler,\n      {\n        service: targetService,\n        ...options,\n      }\n    );\n  };\n}\n\nexport function bindClientSocketProxy(\n  socketClientProxy: DHClientWebSocketProxy\n) {\n  return (\n    ...args: Parameters<Parameters<typeof buildServiceSubscriptionHook>[0]>\n  ) => socketClientProxy.mirror(...args)[0];\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AACA,QAAIA,aAAY,OAAO;AACvB,QAAIC,oBAAmB,OAAO;AAC9B,QAAIC,qBAAoB,OAAO;AAC/B,QAAIC,gBAAe,OAAO,UAAU;AACpC,QAAI,WAAW,CAAC,QAAQ,QAAQ;AAC9B,eAAS,QAAQ;AACf,QAAAH,WAAU,QAAQ,MAAM,EAAE,KAAK,IAAI,IAAI,GAAG,YAAY,KAAK,CAAC;AAAA,IAChE;AACA,QAAII,eAAc,CAAC,IAAI,MAAM,QAAQ,SAAS;AAC5C,UAAI,QAAQ,OAAO,SAAS,YAAY,OAAO,SAAS,YAAY;AAClE,iBAAS,OAAOF,mBAAkB,IAAI;AACpC,cAAI,CAACC,cAAa,KAAK,IAAI,GAAG,KAAK,QAAQ;AACzC,YAAAH,WAAU,IAAI,KAAK,EAAE,KAAK,MAAM,KAAK,GAAG,GAAG,YAAY,EAAE,OAAOC,kBAAiB,MAAM,GAAG,MAAM,KAAK,WAAW,CAAC;AAAA,MACvH;AACA,aAAO;AAAA,IACT;AACA,QAAI,eAAe,CAAC,QAAQG,aAAYJ,WAAU,CAAC,GAAG,cAAc,EAAE,OAAO,KAAK,CAAC,GAAG,GAAG;AAGzF,QAAI,qBAAqB,CAAC;AAC1B,aAAS,oBAAoB;AAAA,MAC3B,cAAc,MAAMK;AAAA,IACtB,CAAC;AACD,WAAO,UAAU,aAAa,kBAAkB;AAGhD,aAASA,cAAa,MAAM,MAAM;AAChC,UAAI,OAAO,GAAG,MAAM,IAAI,GAAG;AACzB,eAAO;AAAA,MACT;AACA,UAAI,OAAO,SAAS,YAAY,SAAS,QAAQ,OAAO,SAAS,YAAY,SAAS,MAAM;AAC1F,eAAO;AAAA,MACT;AACA,UAAI,gBAAgB,OAAO,gBAAgB,KAAK;AAC9C,YAAI,KAAK,SAAS,KAAK,KAAM,QAAO;AACpC,mBAAW,CAAC,KAAK,KAAK,KAAK,MAAM;AAC/B,cAAI,CAAC,OAAO,GAAG,OAAO,KAAK,IAAI,GAAG,CAAC,GAAG;AACpC,mBAAO;AAAA,UACT;AAAA,QACF;AACA,eAAO;AAAA,MACT;AACA,UAAI,gBAAgB,OAAO,gBAAgB,KAAK;AAC9C,YAAI,KAAK,SAAS,KAAK,KAAM,QAAO;AACpC,mBAAW,SAAS,MAAM;AACxB,cAAI,CAAC,KAAK,IAAI,KAAK,GAAG;AACpB,mBAAO;AAAA,UACT;AAAA,QACF;AACA,eAAO;AAAA,MACT;AACA,YAAM,QAAQ,OAAO,KAAK,IAAI;AAC9B,UAAI,MAAM,WAAW,OAAO,KAAK,IAAI,EAAE,QAAQ;AAC7C,eAAO;AAAA,MACT;AACA,eAAS,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;AACrC,YAAI,CAAC,OAAO,UAAU,eAAe,KAAK,MAAM,MAAM,CAAC,CAAC,KAAK,CAAC,OAAO,GAAG,KAAK,MAAM,CAAC,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG;AACvG,iBAAO;AAAA,QACT;AAAA,MACF;AACA,aAAO;AAAA,IACT;AAAA;AAAA;;;AC9DA,SAAS,eAAAC,cAAa,eAAe;;;ACArC,SAAS,aAAa,QAAQ,gBAAgB;AA4CvC,IAAM,sBAAN,MAAM,6BAAgD,MAAM;AAAA,EAGjE,YAAY,SAAiB,SAAmB;AAC9C,UAAM,OAAO;AAHf,wBAAgB;AAId,SAAK,OAAO,KAAK,YAAY;AAC7B,SAAK,UAAU;AAEf,QAAI,MAAM,mBAAmB;AAC3B,YAAM,kBAAkB,MAAM,oBAAmB;AAAA,IACnD;AAAA,EACF;AACF;AAgDO,IAAM,cAAc,CACzB,YACG;AACH,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI;AACJ,QAAM,CAAC,QAAQ,SAAS,IAAI,SAAyB,MAAM;AAC3D,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAwB,IAAI;AACtD,QAAM,CAAC,QAAQ,SAAS,IAAI,SAA4B,MAAS;AACjE,QAAM,gBAAgB,OAAO,UAAU;AACvC,QAAM,qBAAqB,OAAO;AAAA,IAChC;AAAA,IACA;AAAA,EACF,CAAC;AACD,QAAM,2BAAkC;AAAA,IACtC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACA,QAAM,sBAAsB,OAAO,wBAAwB;AAC3D,sBAAoB,UAAU;AAE9B,QAAM,cAAc;AAAA,IAClB,CAAOC,SAAiB,0BAAmC;AAxI/D;AAyIM,gBAAU,SAAS;AACnB,eAAS,IAAI;AAEb,UAAI;AACF,cAAM,WAAkC;AAAA,UACtC,cAAc;AAAA,YACZ,oBAAoB,QAAQ,gBACxB,oBAAoB,QAAQ;AAAA,cAC1BA;AAAA,cACA,mBAAmB,QAAQ;AAAA,YAC7B,IACAA;AAAA,YACJ;AAAA,UACF;AAAA,UACA,GAAI,mBAAmB,QAAQ,UAC3B;AAAA,YACE,IAAI;AAAA,cAAyB,CAAC,YAC5B;AAAA,gBACE,MAAM,QAAQ,SAAS;AAAA,gBACvB,mBAAmB,QAAQ;AAAA,cAC7B;AAAA,YACF;AAAA,UACF,IACA,CAAC;AAAA,QACP;AAEA,cAAM,MAAM,MAAM,QAAQ,KAAK,QAAQ;AAEvC,YAAI,QAAQ,WAAW;AACrB,gBAAM,IAAI,MAAM,SAAS;AAAA,QAC3B;AAEA,aAAI,+BAAoB,SAAQ,mBAA5B,4BAA6C,MAAM;AACrD,gBAAM,IAAI,oBAAoB,KAAK,UAAU,GAAG,GAAG,GAAG;AAAA,QACxD;AAEA,kBAAU,GAAG;AACb,kBAAU,SAAS;AAEnB,wCAAoB,SAAQ,cAA5B,4BAAwC,KAAKA;AAC7C,wCAAoB,SAAQ,cAA5B,4BAAwC,KAAK,MAAMA;AAEnD,eAAO;AAAA,MACT,SAASC,QAAY;AACnB,iBAASA,MAAK;AACd,kBAAU,OAAO;AAEjB,YAAI,oBAAoB,QAAQ,SAAS;AACvC,8BAAoB,QAAQ,QAAQA,QAAOD,OAAM;AAAA,QACnD;AAEA,YAAI,oBAAoB,QAAQ,WAAW;AACzC,8BAAoB,QAAQ,UAAU,QAAWC,QAAOD,OAAM;AAAA,QAChE;AAEA,cAAMC;AAAA,MACR;AAAA,IACF;AAAA,IACA,CAAC;AAAA,EACH;AAEA,QAAM,SAAS;AAAA,IACb,CACE,WACAC,aAGG;AACH,kBAAY,WAAWA,YAAA,gBAAAA,SAAS,qBAAqB,EAAE;AAAA,QACrD,CAAC,SAAS;AA9MlB;AA+MU,gBAAAA,YAAA,gBAAAA,SAAS,cAAT,wBAAAA,UAAqB,MAAM;AAC3B,gBAAAA,YAAA,gBAAAA,SAAS,cAAT,wBAAAA,UAAqB,MAAM,MAAM;AAAA,QACnC;AAAA,QACA,CAACD,WAAU;AAlNnB;AAmNU,gBAAAC,YAAA,gBAAAA,SAAS,YAAT,wBAAAA,UAAmBD,QAAO;AAC1B,gBAAAC,YAAA,gBAAAA,SAAS,cAAT,wBAAAA,UAAqB,QAAWD,QAAO;AAAA,QACzC;AAAA,MACF;AAAA,IACF;AAAA,IACA,CAAC,WAAW;AAAA,EACd;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,OAAO,MAAM,UAAU,MAAM;AAAA,IAC7B;AAAA,EACF;AACF;;;ACnOA,SAAS,eAAAE,cAAa,WAAW,UAAAC,SAAQ,YAAAC,iBAAgB;AAgDzD,SAAS,kBAAkB,UAA6B;AACtD,SAAO,KAAK,UAAU,QAAQ;AAChC;AAsBO,IAAM,WAAW,CAMtB,OASG;AATH,eACA;AAAA;AAAA,EA/EF,IA8EE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AASA,QAAM;AAAA,IACJ,UAAU;AAAA,IACV,uBAAuB;AAAA,IACvB,kBAAkB;AAAA,IAClB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,KAAK;AAAA,EACP,IAAI;AACJ,QAAM,WAAW,kBAAkB,0CAAkB,CAAC,CAAC;AACvD,QAAM,8BAA8BC,QAAO,KAAK;AAChD,QAAM,gBAAgBA,QAAsB,IAAI;AAChD,QAAM,eAAeA,QAA2B,MAAS;AACzD,QAAM,aAAaA,QAAO,OAAO;AACjC,aAAW,UAAU;AACrB,QAAM,sBAAsBA,QAE1B,CAAC,CAAC;AACJ,sBAAoB,UAAU;AAAA,IAC5B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACA,QAAM,qBAAqBA,QAAmC;AAAA,IAC5D;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACD,qBAAmB,UAAU;AAAA,IAC3B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,CAAC,QAAQ,SAAS,IAAIC,UAAsB,MAAM;AACtD,WAAO;AAAA,EACT,CAAC;AACD,QAAM,CAAC,OAAO,QAAQ,IAAIA,UAAwB,IAAI;AACtD,QAAM,CAAC,MAAM,OAAO,IAAIA,UAA4B,MAAM;AACxD,QAAI,gBAAgB,QAAW;AAC7B,UAAI,OAAO,gBAAgB,YAAY;AACrC,eAAQ,YAAmC;AAAA,MAC7C;AAEA,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT,CAAC;AAED,QAAM,gBAAgBC,aAAY,CAACC,UAAgB;AACjD,QAAI,mBAAmB,QAAQ,WAAW;AACxC;AAAA,IACF;AAEA,YAAQA,KAAI;AAAA,EACd,GAAG,CAAC,CAAC;AAEL,QAAM,gBAAgBD,aAAY,MAAM;AA/J1C,QAAAE;AAgKI,QAAI,CAAC,mBAAmB,QAAQ,SAAS;AACvC,aAAO;AAAA,IACT;AAEA,QAAI,cAAc,YAAY,MAAM;AAClC,aAAO;AAAA,IACT;AAEA,YACE,oBAAI,KAAK,GAAE,QAAQ,IAAI,cAAc,YACrCA,MAAA,mBAAmB,YAAnB,gBAAAA,IAA4B;AAAA,EAEhC,GAAG,CAAC,CAAC;AAEL,QAAM,UAAUF;AAAA,IACd,CAAO,SAAqC,WAAc;AA/K9D,UAAAE,KAAAC,KAAA;AAgLM,UACE,4BAA4B,WAC5B,CAAC,mBAAmB,QAAQ,SAC5B;AACA;AAAA,MACF;AAEA,gBAAU,SAAS;AACnB,eAAS,IAAI;AAEb,UAAI;AACF,cAAM,WAAkC;AAAA,UACtC,WAAW,QAAQ,MAAM;AAAA,UACzB,GAAI,mBAAmB,QAAQ,UAC3B;AAAA,YACE,IAAI;AAAA,cAAyB,CAAC,YAC5B;AAAA,gBACE,MAAM,QAAQ,SAAS;AAAA,gBACvB,mBAAmB,QAAQ;AAAA,cAC7B;AAAA,YACF;AAAA,UACF,IACA,CAAC;AAAA,QACP;AAEA,oCAA4B,UAAU;AACtC,cAAM,MAAM,MAAM,QAAQ,KAAK,QAAQ;AACvC,oCAA4B,UAAU;AAEtC,YAAI,QAAQ,WAAW;AACrB,gBAAM,IAAI,MAAM,SAAS;AAAA,QAC3B;AAEA,sBAAc,GAAG;AAEjB,YACE,oBAAoB,QAAQ,kBAC5B,oBAAoB,QAAQ,eAAe,GAAG,MAAM,MACpD;AACA,gBAAM,IAAI,MAAM,gBAAgB;AAAA,QAClC;AAEA,kBAAU,SAAS;AACnB,sBAAc,WAAU,oBAAI,KAAK,GAAE,QAAQ;AAC3C,SAAAA,OAAAD,MAAA,oBAAoB,SAAQ,cAA5B,gBAAAC,IAAA,KAAAD,KAAwC;AACxC,wCAAoB,SAAQ,cAA5B,4BAAwC,KAAK;AAAA,MAC/C,SAASE,QAAY;AACnB,iBAASA,MAAK;AACd,kBAAU,OAAO;AACjB,wCAAoB,SAAQ,YAA5B,4BAAsCA;AACtC,wCAAoB,SAAQ,cAA5B,4BAAwC,QAAWA;AAAA,MACrD;AAAA,IACF;AAAA,IACA,CAAC,aAAa;AAAA,EAChB;AAEA,QAAM,QAAQJ,aAAY,MAAM;AAC9B,YAAQ,MAAS;AACjB,cAAU,MAAM;AAChB,aAAS,IAAI;AACb,YAAQ;AAAA,EACV,GAAG,CAAC,OAAO,CAAC;AAEZ,YAAU,MAAM;AACd,QAAI,SAAS;AACX,cAAQ;AAAA,IACV;AAAA,EACF,GAAG,CAAC,SAAS,SAAS,QAAQ,CAAC;AAE/B,YAAU,MAAM;AACd,QAAI,aAAa,YAAY,QAAW;AACtC,mBAAa,UAAU;AACvB,cAAQ;AACR;AAAA,IACF;AAEA,QAAI,aAAa,aAAa,SAAS;AACrC,mBAAa,UAAU;AACvB,cAAQ;AAAA,IACV;AAAA,EACF,GAAG,CAAC,UAAU,SAAS,OAAO,CAAC;AAE/B,YAAU,MAAM;AACd,QAAI,sBAAsB;AACxB,YAAM,mBAAmB,MAAM;AAC7B,YAAI,cAAc,GAAG;AACnB,kBAAQ;AAAA,QACV;AAAA,MACF;AAEA,aAAO,iBAAiB,SAAS,gBAAgB;AAEjD,aAAO,MAAM;AACX,eAAO,oBAAoB,SAAS,gBAAgB;AAAA,MACtD;AAAA,IACF;AAAA,EACF,GAAG,CAAC,sBAAsB,SAAS,aAAa,CAAC;AAEjD,YAAU,MAAM;AACd,QAAI,oBAAoB,GAAG;AACzB,YAAM,WAAW;AAAA,QACf,MAAM;AACJ,cAAI,cAAc,GAAG;AACnB,oBAAQ;AAAA,UACV;AAAA,QACF;AAAA,QACA,KAAK,IAAI,iBAAiB,GAAI;AAAA,MAChC;AAEA,aAAO,MAAM;AACX,sBAAc,QAAQ;AAAA,MACxB;AAAA,IACF;AAAA,EACF,GAAG,CAAC,SAAS,iBAAiB,aAAa,CAAC;AAE5C,SAAO;AAAA,IACL,MACE,UAAU,SAAS,SACf,OAAO,IAAa,IACnB;AAAA,IACP;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;;;AFhSA,IAAM,sBAAsB,CAM1B,aACA,cACA,SACA,YAIG;AACH,QAII,aAAQ,MAAM,4BAAW,CAAC,GAAG,CAAC,OAAO,CAAC,GAHxC;AAAA,mBAAe;AAAA,IACf,gBAAgB;AAAA,EA7BpB,IA+BM,IADC,iBACD,IADC;AAAA,IAFH;AAAA,IACA;AAAA;AAGF,QAAM,aAAaK;AAAA,IACjB,CAAO,eAAwB;AAC7B,UAAI;AACF,cAAM,MAAM,MAAM,YAAY,UAA0B;AAAA,UACtD;AAAA,UACA,cAAc,aAAa,SAAS;AAAA,UACpC;AAAA,UACA,SAAS;AAAA,YACP;AAAA,YACA;AAAA,UACF;AAAA,QACF,CAAC;AAED,eAAO,IAAI,QAAQ;AAAA,MACrB,SAAS,GAAQ;AACf,cAAM,EAAE;AAAA,MACV;AAAA,IACF;AAAA,IACA,CAAC,cAAc,eAAe,cAAc,OAAO;AAAA,EACrD;AAEA,SAAO,YAAoC;AAAA,IACzC;AAAA,KACG,KACJ;AACH;AAEO,SAAS,kBACd,mBACA,kBACA;AACA,SAAO,SAAS,uBACd,MACA,SAQA;AACA,UAAM,gBAAgB,iBAAiB,mCAAS,OAAO;AAEvD,WAAO,oBAKL,mBAAmB,MAAM,eAAe,OAAO;AAAA,EACnD;AACF;AAEA,IAAM,mBAAmB,CAOvB,aACA,cACA,QACA,SACA,YAIG;AACH,QAII,aAAQ,MAAM,4BAAW,CAAC,GAAG,CAAC,OAAO,CAAC,GAHxC;AAAA,mBAAe;AAAA,IACf,gBAAgB;AAAA,EAvGpB,IAyGM,IADC,iBACD,IADC;AAAA,IAFH;AAAA,IACA;AAAA;AAGF,QAAM,UAAUA;AAAA,IACd,CAAO,eAA+B,0BAAmC;AACvE,UAAI;AACF,cAAM,MAAM,MAAM,YAAY,UAA0B;AAAA,UACtD,SAAS,wDAAyB;AAAA,UAClC,cAAc,aAAa,SAAS;AAAA,UACpC,YAAY,wCAAiB;AAAA,UAC7B,SAAS;AAAA,YACP;AAAA,YACA;AAAA,UACF;AAAA,QACF,CAAC;AACD,eAAO,IAAI,QAAQ;AAAA,MACrB,SAAS,GAAG;AACV,YAAI,aAAa,OAAO;AACtB,gBAAM;AAAA,QACR;AACA,cAAM,IAAI,MAAM,CAAW;AAAA,MAC7B;AAAA,IACF;AAAA,IACA,CAAC,cAAc,eAAe,cAAc,SAAS,MAAM;AAAA,EAC7D;AAEA,SAAO,SAA0C;AAAA,IAC/C;AAAA,KACG,KACJ;AACH;AAEO,SAAS,eACd,mBACA,kBACA;AACA,SAAO,SAAS,oBAId,MACA,QACA,SASA;AACA,UAAM,gBAAgB,iBAAiB,mCAAS,OAAO;AAEvD,WAAO,iBAML,mBAAmB,MAAM,QAAQ,eAAe,OAAO;AAAA,EAC3D;AACF;;;AG9JA,wBAA6B;AAC7B,SAAS,eAAAC,cAAa,aAAAC,YAAW,WAAAC,UAAS,UAAAC,SAAQ,YAAAC,iBAAgB;AA2F3D,SAAS,oBAKd,SAC8C;AAC9C,QAAM;AAAA,IACJ,UAAU;AAAA,IACV,eAAe;AAAA,IACf;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,UAAU;AAAA,EACZ,IAAI;AACJ,QAAM,CAAC,QAAQ,SAAS,IAAIC,UAA4B,MAAM;AAC9D,QAAM,CAAC,MAAM,OAAO,IAAIA,UAA4B,YAAY;AAChE,QAAM,gBAAgBC,QAA+B,MAAS;AAC9D,QAAM,kBAAkBA,QAAO,YAAY;AAC3C,QAAM,kBAAkBA,QAAO,YAAY;AAC3C,QAAM,sBAA6B;AAAA,IACjC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACA,QAAM,uBAAuBA,QAAO,mBAAmB;AACvD,uBAAqB,UAAU;AAE/B,QAAM,eAAeC;AAAA,IACnB,CAAC,WAA8B,YAAuB;AACpD,UAAI,WAAW;AACb;AAAA,MACF;AAEA,gBAAU,CAAC,SAAS;AA5I1B;AA6IQ,YAAI,SAAS,WAAW;AACtB,iBAAO;AAAA,QACT;AAEA,YAAI,cAAc,gBAAgB,SAAS;AACzC,2CAAqB,SAAQ,iBAA7B,4BAA4C;AAAA,QAC9C;AAEA,eAAO;AAAA,MACT,CAAC;AAAA,IACH;AAAA,IACA,CAAC,SAAS;AAAA,EACZ;AAEA,QAAM,aAAyBC;AAAA,IAC7B,OAAO;AAAA,MACL,aAAa,MAAM;AACjB,qBAAa,YAAY;AAAA,MAC3B;AAAA,IACF;AAAA,IACA,CAAC,YAAY;AAAA,EACf;AAEA,QAAM,UAAUD;AAAA,IACd,CAAO,YAAsB;AArKjC;AAsKM,WAAI,gCAAqB,SAAQ,mBAA7B,4BAA8C,UAAU;AAC1D,yCAAqB,SAAQ,YAA7B,4BAAuC;AAEvC;AAAA,MACF;AAEA,YAAM,mBACH,sCAAqB,SAAQ,WAA7B,4BAAsC,aAAtC,YAAkD;AAGrD,UAAI,CAAC,WAAW;AACd,gBAAQ,CAAC,SAAS;AAChB,cAAI,QAAQ,MAAM,eAAe,GAAG;AAClC,mBAAO;AAAA,UACT;AAEA,iBAAO;AAAA,QACT,CAAC;AAAA,MACH;AAEA,mBAAa,cAAc,OAAO;AAClC,uCAAqB,SAAQ,cAA7B,4BAAyC;AAAA,IAC3C;AAAA,IACA,CAAC,WAAW,YAAY;AAAA,EAC1B;AAEA,QAAM,cAAcA,aAAY,MAAM;AAhMxC;AAiMI,iBAAa,MAAM;AACnB,wBAAc,YAAd;AACA,kBAAc,UAAU;AAAA,EAC1B,GAAG,CAAC,YAAY,CAAC;AAEjB,QAAM,YAAYA,aAAY,MAAM;AAtMtC;AAuMI,wBAAc,YAAd;AACA,iBAAa,aAAa;AAC1B,YAAQ,gBAAgB,OAAO;AAC/B,kBAAc,UAAU,gBAAgB,QAAQ,SAAS,UAAU;AAAA,EACrE,GAAG,CAAC,YAAY,SAAS,YAAY,CAAC;AAEtC,EAAAE,WAAU,MAAM;AACd,QAAI,SAAS;AACX,gBAAU;AAAA,IACZ,OAAO;AACL,kBAAY;AAAA,IACd;AAEA,WAAO,MAAM;AACX,kBAAY;AAAA,IACd;AAAA,EACF,GAAG,CAAC,SAAS,WAAW,WAAW,CAAC;AAEpC,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,aAAa;AAAA,EACf;AACF;;;ACpMO,SAAS,gBAKd,qBACA,SACA;AACA,QAAM,EAAE,OAAO,SAAS,mBAAmB,IAAK,IAAI;AAEpD,SAAO,oBAAgD,iCAClD,UADkD;AAAA,IAErD,cAAc,CAAC,YAAY;AACzB,YAAM,cAAc,oBAAoB;AAAA,QACtC;AAAA,QACA;AAAA,QACA,UAAU,CAAC,YAAsB;AAC/B,kBAAQ,OAAO;AAAA,QACjB;AAAA,QACA;AAAA,MACF,CAAC;AAED,aAAO;AAAA,IACT;AAAA,EACF,EAAC;AACH;AAEO,SAAS,6BACd,qBACA,eACA;AACA,SAAO,SAAS,uBAKd,SAMA;AACA,UAAM,gBAAgB,cAAc,QAAQ,OAAO;AACnD,WAAO;AAAA,MACmC;AAAA,MACxC;AAAA,QACE,SAAS;AAAA,SACN;AAAA,IAEP;AAAA,EACF;AACF;AAEO,SAAS,sBACd,mBACA;AACA,SAAO,IACF,SACA,kBAAkB,OAAO,GAAG,IAAI,EAAE,CAAC;AAC1C;","names":["__defProp","__getOwnPropDesc","__getOwnPropNames","__hasOwnProp","__copyProps","shallowEqual","useCallback","params","error","options","useCallback","useRef","useState","useRef","useState","useCallback","data","_a","_b","error","useCallback","useCallback","useEffect","useMemo","useRef","useState","useState","useRef","useCallback","useMemo","useEffect"]}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@pixotope/query",
+  "version": "0.0.1",
+  "description": "",
+  "private": false,
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "devDependencies": {
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^16.3.0",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/jsdom": "^21.1.7",
+    "@types/node": "^22.10.2",
+    "@types/react": "^19.1.8",
+    "jsdom": "^26.1.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.7.2",
+    "vitest": "^3.2.4",
+    "react": "^19.1.0",
+    "@pixotope/zmq-client": "0.0.1",
+    "@pixotope/utils": "0.0.1"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --sourcemap",
+    "check-types": "tsc --noEmit",
+    "test": "vitest"
+  }
+}

package/src/factories.ts

@@ -0,0 +1,166 @@
+import { useCallback, useMemo } from "react";
+import { MutationOptions, useMutation } from "./useMutation";
+import { QueryOptions, useQuery } from "./useQuery";
+import type { DHClientWebSocketProxy } from "@pixotope/zmq-client";
+
+export type MutationInfo<TData, TError, TParams> = {
+  data: TData;
+  error: TError;
+  params: TParams;
+};
+
+type FnToParamsBase = Record<string, MutationInfo<unknown, unknown, unknown>>;
+
+const useCallMutationBase = <
+  TFnToParams extends FnToParamsBase,
+  TData = unknown,
+  TError = unknown,
+  TParams = unknown,
+>(
+  clientProxy: DHClientWebSocketProxy,
+  functionName: keyof TFnToParams,
+  service: string,
+  options?: Omit<MutationOptions<TData, TError, TParams>, "mutationFn"> & {
+    avoidTimeout?: boolean;
+    customTimeout?: number;
+  }
+) => {
+  const {
+    avoidTimeout = true,
+    customTimeout = undefined,
+    ...rest
+  } = useMemo(() => options ?? {}, [options]);
+  const mutationFn = useCallback(
+    async (parameters: TParams) => {
+      try {
+        const res = await clientProxy.callAsync<TData, TParams>({
+          service,
+          functionName: functionName.toString(),
+          parameters,
+          options: {
+            avoidTimeout,
+            customTimeout,
+          },
+        });
+
+        return res.message.Result;
+      } catch (e: any) {
+        throw e.message;
+      }
+    },
+    [avoidTimeout, customTimeout, functionName, service]
+  );
+
+  return useMutation<TData, TError, TParams>({
+    mutationFn,
+    ...rest,
+  });
+};
+
+export function buildMutationHook<TFnToParams extends FnToParamsBase>(
+  socketClientProxy: DHClientWebSocketProxy,
+  genTargetService: (machine: string | undefined) => string
+) {
+  return function useCallMutationBuilder<TFn extends keyof TFnToParams>(
+    func: TFn,
+    options?: Parameters<
+      typeof useCallMutationBase<
+        TFnToParams,
+        TFnToParams[TFn]["data"],
+        TFnToParams[TFn]["error"],
+        TFnToParams[TFn]["params"]
+      >
+    >[3] & { machine?: string }
+  ) {
+    const targetService = genTargetService(options?.machine);
+
+    return useCallMutationBase<
+      TFnToParams,
+      TFnToParams[TFn]["data"],
+      TFnToParams[TFn]["error"],
+      TFnToParams[TFn]["params"]
+    >(socketClientProxy, func, targetService, options);
+  };
+}
+
+const useCallQueryBase = <
+  TFnToParams extends FnToParamsBase,
+  TData = unknown,
+  TError = unknown,
+  TParams = unknown,
+  TSelect = TData,
+>(
+  clientProxy: DHClientWebSocketProxy,
+  functionName: keyof TFnToParams,
+  params: TParams,
+  service: string,
+  options?: Omit<QueryOptions<TData, TError, TParams, TSelect>, "queryFn"> & {
+    avoidTimeout?: boolean;
+    customTimeout?: number;
+  }
+) => {
+  const {
+    avoidTimeout = true,
+    customTimeout = undefined,
+    ...rest
+  } = useMemo(() => options ?? {}, [options]);
+  const queryFn = useCallback(
+    async (refetchParams: TParams | void, overrideTargetMachine?: string) => {
+      try {
+        const res = await clientProxy.callAsync<TData, TParams>({
+          service: overrideTargetMachine ?? service,
+          functionName: functionName.toString(),
+          parameters: refetchParams ?? params,
+          options: {
+            avoidTimeout,
+            customTimeout,
+          },
+        });
+        return res.message.Result;
+      } catch (e) {
+        if (e instanceof Error) {
+          throw e;
+        }
+        throw new Error(e as string);
+      }
+    },
+    [avoidTimeout, customTimeout, functionName, service, params]
+  );
+
+  return useQuery<TData, TError, TParams, TSelect>({
+    queryFn,
+    ...rest,
+  });
+};
+
+export function buildQueryHook<TFnToParams extends FnToParamsBase>(
+  clientSocketProxy: DHClientWebSocketProxy,
+  getTargetService: (machine: string | undefined) => string
+) {
+  return function useCallQueryBuilder<
+    TFn extends keyof TFnToParams,
+    TSelect = TFnToParams[TFn]["data"],
+  >(
+    func: TFn,
+    params: TFnToParams[TFn]["params"],
+    options?: Parameters<
+      typeof useCallQueryBase<
+        TFnToParams,
+        TFnToParams[TFn]["data"],
+        TFnToParams[TFn]["error"],
+        TFnToParams[TFn]["params"],
+        TSelect
+      >
+    >[4] & { machine?: string }
+  ) {
+    const targetService = getTargetService(options?.machine);
+
+    return useCallQueryBase<
+      TFnToParams,
+      TFnToParams[TFn]["data"],
+      TFnToParams[TFn]["error"],
+      TFnToParams[TFn]["params"],
+      TSelect
+    >(clientSocketProxy, func, params, targetService, options);
+  };
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./factories";
+export * from "./useSubscription";
+export * from "./useQuery";

package/src/mock/useQuery.ts

@@ -0,0 +1,48 @@
+export class MockPromise<TData = any> {
+  private _data: TData;
+  private _resolve!: (value: TData) => void;
+  private _reject!: (reason?: any) => void;
+  public promise: Promise<TData>;
+
+  public constructor(data: TData) {
+    this._data = data;
+    this.promise = new Promise((resolve, reject) => {
+      this._resolve = resolve;
+      this._reject = reject;
+    });
+  }
+
+  public async resolve() {
+    this._resolve(this._data);
+  }
+
+  public async reject() {
+    this._reject();
+  }
+}
+
+export class MockUseQueryUtils<TData = any> {
+  private _data: TData;
+  private _mockPromise: MockPromise<TData>;
+
+  public constructor(data: TData) {
+    this._data = data;
+    this._mockPromise = new MockPromise(data);
+  }
+
+  public getMockedQueryFn() {
+    return this._mockPromise.promise;
+  }
+
+  public resolve() {
+    return this._mockPromise.resolve();
+  }
+
+  public reject() {
+    this._mockPromise.reject();
+  }
+
+  public getData() {
+    return this._data;
+  }
+}

package/src/useMutation.ts

@@ -0,0 +1,228 @@
+import { useCallback, useRef, useState } from "react";
+
+export type MutationFunction<TData = unknown, TParams = unknown> = (
+  params: TParams,
+  overrideTargetMachine?: string
+) => Promise<TData>;
+
+export interface MutationOptions<
+  TData = unknown,
+  TError = unknown,
+  TParams = void,
+> {
+  mutationFn: MutationFunction<TData, TParams>;
+  params?: TParams;
+  onSuccess?: (data: TData, variables: TParams) => Promise<unknown> | unknown;
+  onError?: (error: TError, variables: TParams) => Promise<unknown> | unknown;
+  onSettled?: (
+    data: TData | undefined,
+    error: TError | null,
+    variables: TParams
+  ) => Promise<unknown> | unknown;
+  compareOrThrow?: (result: TData | TError) => boolean;
+  timeout?: number;
+  prepareParams?: (variables: TParams, defaults?: TParams) => TParams;
+}
+
+export interface MutateOptions<
+  TData = unknown,
+  TError = unknown,
+  TParams = void,
+> {
+  onSuccess?: (data: TData, variables: TParams) => void;
+  onError?: (error: TError, variables: TParams) => void;
+  onSettled?: (
+    data: TData | undefined,
+    error: TError | null,
+    variables: TParams
+  ) => void;
+}
+
+type MutationStatus = "idle" | "loading" | "success" | "error";
+type RaceErrorReason = "timeout";
+type RacePromises<T> = Promise<T | RaceErrorReason>;
+
+export class ComparisonFailError<TPayload = unknown> extends Error {
+  public readonly payload: TPayload;
+
+  constructor(message: string, payload: TPayload) {
+    super(message);
+    this.name = this.constructor.name;
+    this.payload = payload;
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, ComparisonFailError);
+    }
+  }
+}
+
+/**
+ * `useMutation` is a hook that allows you to perform a mutation/push updates to the services while
+ * providing extensive API to tap into the status and results of the mutation.
+ * @param mutationFn The mutation function to be called when the `mutate` function is called.
+ * `useMutation` does not care about what the function does, all it needs it a function that returns
+ * a promise.
+ * @param options Options to configure the mutation.
+ * @returns An object with the following properties:
+ * - `mutateAsync`: A function that takes in the variables and returns a promise that resolves to the
+ * result of the mutation. This function can be awaited to get the result of the mutation. Callbacks can
+ * be passed to this function to be called when the mutation is successful or when it fails. It's good idea
+ * to wrap this function in a try/catch block.
+ * - `mutate`: A function that takes in the variables and returns nothing. This function does not
+ * return a promise. Callbacks can be passed to this function to be called when the mutation is
+ * successful or when it fails.
+ * - `status`: The status of the mutation. Can be one of `idle`, `loading`, `success` or `error`.
+ * - `result`: The result of the mutation. This is undefined until the mutation is successful.
+ * - `reset`: A function that resets the mutation to the initial state.
+ * - `error`: The error object if the mutation has failed.
+ * @example
+ * ```typescript
+ * const mutationRes = useMutation({
+ *    mutationFn: (variables) => {
+ *      return ZMQHelper.callSomethingAsync(variables)
+ *    },
+ *    onSuccess: (data) => {
+ *      // do something with the result
+ *    },
+ *    onError: (error) => {
+ *      // do something with the error
+ *    },
+ *    onSettled: (data, error) => {
+ *      // do something when the mutation is done
+ *   }});
+ *
+ * // call the mutation
+ * const res = await mutationRes.mutateAsync({ foo: "bar" });
+ * // OR
+ * mutationRes.mutate({ foo: "bar" }, {
+ *  onSuccess: (data) => {
+ *    // do something with the result
+ *    // for example show a toast message
+ *    // stop local loading state
+ * });
+ * ```
+ */
+export const useMutation = <TData = unknown, TError = unknown, TParams = void>(
+  options: MutationOptions<TData, TError, TParams>
+) => {
+  const {
+    mutationFn,
+    compareOrThrow,
+    onError,
+    onSettled,
+    onSuccess,
+    prepareParams,
+    params,
+    timeout,
+  } = options;
+  const [status, setStatus] = useState<MutationStatus>("idle");
+  const [error, setError] = useState<TError | null>(null);
+  const [result, setResult] = useState<TData | undefined>(undefined);
+  const mutationFnRef = useRef(mutationFn);
+  const internalOptionsRef = useRef({
+    params,
+    timeout,
+  });
+  const internalCallbackRefistry = <const>{
+    onSuccess,
+    onError,
+    onSettled,
+    compareOrThrow,
+    prepareParams,
+  };
+  const internalCallbackRef = useRef(internalCallbackRefistry);
+  internalCallbackRef.current = internalCallbackRefistry;
+
+  const mutateAsync = useCallback(
+    async (params: TParams, overrideTargetMachine?: string) => {
+      setStatus("loading");
+      setError(null);
+
+      try {
+        const promises: RacePromises<TData>[] = [
+          mutationFnRef.current(
+            internalCallbackRef.current.prepareParams
+              ? internalCallbackRef.current.prepareParams(
+                  params,
+                  internalOptionsRef.current.params
+                )
+              : params,
+            overrideTargetMachine
+          ),
+          ...(internalOptionsRef.current.timeout
+            ? [
+                new Promise<RaceErrorReason>((resolve) =>
+                  setTimeout(
+                    () => resolve("timeout"),
+                    internalOptionsRef.current.timeout
+                  )
+                ),
+              ]
+            : []),
+        ];
+
+        const res = await Promise.race(promises);
+
+        if (res === "timeout") {
+          throw new Error("timeout");
+        }
+
+        if (internalCallbackRef.current.compareOrThrow?.(res)) {
+          throw new ComparisonFailError(JSON.stringify(res), res);
+        }
+
+        setResult(res);
+        setStatus("success");
+
+        internalCallbackRef.current.onSuccess?.(res, params);
+        internalCallbackRef.current.onSettled?.(res, null, params);
+
+        return res;
+      } catch (error: any) {
+        setError(error);
+        setStatus("error");
+
+        if (internalCallbackRef.current.onError) {
+          internalCallbackRef.current.onError(error, params);
+        }
+
+        if (internalCallbackRef.current.onSettled) {
+          internalCallbackRef.current.onSettled(undefined, error, params);
+        }
+
+        throw error;
+      }
+    },
+    []
+  );
+
+  const mutate = useCallback(
+    (
+      variables: TParams,
+      options?: MutateOptions<TData, TError, TParams> & {
+        overrideTargetMachine?: string;
+      }
+    ) => {
+      mutateAsync(variables, options?.overrideTargetMachine).then(
+        (data) => {
+          options?.onSuccess?.(data, variables);
+          options?.onSettled?.(data, null, variables);
+        },
+        (error) => {
+          options?.onError?.(error, variables);
+          options?.onSettled?.(undefined, error, variables);
+        }
+      );
+    },
+    [mutateAsync]
+  );
+
+  return {
+    mutateAsync,
+    status,
+    result,
+    mutate,
+    reset: () => setStatus("idle"),
+    error,
+  };
+};