synapse-react-client 4.0.46 → 4.0.47

package/dist/synapse-queries/dataaccess/useEDuc.js.map

@@ -1 +1 @@
-{"version":3,"file":"useEDuc.js","names":[],"sources":["../../../src/synapse-queries/dataaccess/useEDuc.ts"],"sourcesContent":["import { getAllOfNextPageTokenPaginatedService } from '@/synapse-client/SynapseClient'\nimport { useSynapseContext } from '@/utils/context/SynapseContext'\nimport {\n  AccessRequestList,\n  AccessRequestListRequest,\n  AccessRequestSummary,\n  EDucFileHandleId,\n  EDucSignatureQuota,\n  EDucSignatureStatus,\n  EDucTemplateListRequest,\n  EDucTemplatePage,\n  EDucTemplateValidationResult,\n} from '@sage-bionetworks/synapse-client'\nimport { SynapseClient } from '@sage-bionetworks/synapse-client/SynapseClient'\nimport { SynapseClientError } from '@sage-bionetworks/synapse-client/util/SynapseClientError'\nimport {\n  InfiniteData,\n  QueryKey,\n  useInfiniteQuery,\n  UseInfiniteQueryOptions,\n  useMutation,\n  UseMutationOptions,\n  useQuery,\n  useQueryClient,\n  UseQueryOptions,\n} from '@tanstack/react-query'\n\n/**\n * List the eDUC templates registered in DocuSign (all pages).\n * @see POST /repo/v1/eDuc/template\n */\nexport function useListEDucTemplates<TData = InfiniteData<EDucTemplatePage>>(\n  request: Omit<EDucTemplateListRequest, 'nextPageToken'> = {},\n  options?: Partial<\n    UseInfiniteQueryOptions<\n      EDucTemplatePage,\n      SynapseClientError,\n      TData,\n      QueryKey,\n      EDucTemplatePage['nextPageToken']\n    >\n  >,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useInfiniteQuery<\n    EDucTemplatePage,\n    SynapseClientError,\n    TData,\n    QueryKey,\n    EDucTemplatePage['nextPageToken']\n  >({\n    ...options,\n    queryKey: keyFactory.listEDucTemplatesQueryKey(request),\n    queryFn: context =>\n      synapseClient.dataAccessServicesClient.postRepoV1EDucTemplate({\n        eDucTemplateListRequest: {\n          ...request,\n          nextPageToken: context.pageParam,\n        },\n      }),\n    initialPageParam: undefined,\n    getNextPageParam: page => page.nextPageToken,\n  })\n}\n\n/**\n * Validate a single eDUC template by ID (ACT-only).\n * @see GET /repo/v1/eDuc/template/{templateId}/validation\n */\nexport function useGetEDucTemplateValidation(\n  templateId: string,\n  options?: Partial<\n    UseQueryOptions<EDucTemplateValidationResult, SynapseClientError>\n  >,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEDucTemplateValidationQueryKey(templateId),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.getRepoV1EDucTemplateTemplateIdValidation(\n        { templateId },\n      ),\n  })\n}\n\n/**\n * List the data access requests that the calling user created or participates in.\n * @see POST /repo/v1/dataAccessRequest/list\n */\nexport function useListUserDataAccessRequests(\n  request: AccessRequestListRequest = {},\n  options?: Partial<UseQueryOptions<AccessRequestList, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.listDataAccessRequestsQueryKey(request),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.postRepoV1DataAccessRequestList({\n        accessRequestListRequest: request,\n      }),\n  })\n}\n\n/**\n * List _all_ data access requests that the calling user created or participates in, walking every\n * page of `POST /repo/v1/dataAccessRequest/list` via `nextPageToken` inside the queryFn. Returns\n * the flattened list of {@link AccessRequestSummary}.\n *\n * Prefer this hook over {@link useListUserDataAccessRequests} when the caller needs the complete\n * list (for example, to filter results client-side). This avoids the render-per-page cascade of\n * `useInfiniteQuery` at the cost of a slightly longer initial load.\n *\n * @see POST /repo/v1/dataAccessRequest/list\n */\nexport function useListAllUserDataAccessRequests(\n  request: Omit<AccessRequestListRequest, 'nextPageToken'> = {},\n  options?: Partial<\n    UseQueryOptions<AccessRequestSummary[], SynapseClientError>\n  >,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.listAllDataAccessRequestsQueryKey(request),\n    queryFn: () =>\n      getAllOfNextPageTokenPaginatedService<AccessRequestSummary>(\n        async nextPageToken => {\n          const response =\n            await synapseClient.dataAccessServicesClient.postRepoV1DataAccessRequestList(\n              {\n                accessRequestListRequest: {\n                  ...request,\n                  nextPageToken: nextPageToken ?? undefined,\n                },\n              },\n            )\n          return {\n            results: response.results ?? [],\n            nextPageToken: response.nextPageToken,\n          }\n        },\n      ),\n  })\n}\n\n/**\n * Retrieve the pre-signing preview of the eDUC for a data access request. The document is rendered\n * from the request as it stands, via an envelope the service discards once the PDF exists, so\n * reading it neither routes anything for signature nor alters the request.\n *\n * @see GET /repo/v1/dataAccessRequest/{requestId}/preview\n */\nexport function useGetDataAccessRequestPreview(\n  requestId: string,\n  options?: Partial<UseQueryOptions<EDucFileHandleId, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDataAccessRequestPreviewQueryKey(requestId),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.getRepoV1DataAccessRequestRequestIdPreview(\n        { requestId },\n      ),\n  })\n}\n\n/**\n * Retrieve the current signature status of a data access request's routed eDUC.\n * @see GET /repo/v1/dataAccessRequest/{requestId}/signature/status\n */\nexport function useGetDataAccessRequestSignatureStatus(\n  requestId: string,\n  options?: Partial<UseQueryOptions<EDucSignatureStatus, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDataAccessRequestSignatureStatusQueryKey(requestId),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.getRepoV1DataAccessRequestRequestIdSignatureStatus(\n        { requestId },\n      ),\n  })\n}\n\n/**\n * Retrieve the file handle ID of the signed eDUC document for a data access request.\n * @see GET /repo/v1/dataAccessRequest/{requestId}/signature/filehandleId\n */\nexport function useGetDataAccessRequestSignedFileHandleId(\n  requestId: string,\n  options?: Partial<UseQueryOptions<EDucFileHandleId, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey:\n      keyFactory.getDataAccessRequestSignatureFileHandleIdQueryKey(requestId),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.getRepoV1DataAccessRequestRequestIdSignatureFilehandleId(\n        { requestId },\n      ),\n  })\n}\n\n/**\n * Retrieve the current eDUC signature quota (total allowed and remaining) for a data access\n * request. Used to preflight the \"send for signature\" action so it can be disabled when the\n * user is at or over quota.\n * @see GET /repo/v1/dataAccessRequest/{requestId}/signature/quota\n */\nexport function useGetDataAccessRequestSignatureQuota(\n  requestId: string,\n  options?: Partial<UseQueryOptions<EDucSignatureQuota, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDataAccessRequestSignatureQuotaQueryKey(requestId),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.getRepoV1DataAccessRequestRequestIdSignatureQuota(\n        { requestId },\n      ),\n  })\n}\n\n/**\n * Identifies the data access request a signature mutation acts on. The access requirement is\n * carried alongside the request id because these mutations all change `eDucSignatureEnvelopeId`\n * on the request itself, and the cache entry holding that field is keyed by access requirement\n * rather than by request.\n */\nexport type DataAccessRequestSignatureVariables = {\n  requestId: string\n  accessRequirementId: string\n}\n\n/**\n * Invalidates everything a change to the eDUC envelope makes obsolete.\n *\n * The preview is deliberately absent: it renders the request's own content, which routing does\n * not touch, and regenerating it costs a server-side PDF render.\n */\nfunction useInvalidateOnSignatureChange() {\n  const { keyFactory } = useSynapseContext()\n  const queryClient = useQueryClient()\n\n  return ({\n    requestId,\n    accessRequirementId,\n  }: DataAccessRequestSignatureVariables) =>\n    Promise.all([\n      queryClient.invalidateQueries({\n        queryKey: keyFactory.getDataAccessRequestSignatureQueryKey(requestId),\n      }),\n      // The listings report envelope status, so they move with every routing change.\n      queryClient.invalidateQueries({\n        queryKey: keyFactory.getDataAccessRequestListQueryKey(),\n      }),\n      // `eDucSignatureEnvelopeId` is how callers tell a first send from a re-send, so the request\n      // must not stay cached from before the routing changed.\n      queryClient.invalidateQueries({\n        queryKey:\n          keyFactory.getDataAccessRequestForUpdateQueryKey(accessRequirementId),\n      }),\n    ])\n}\n\n/**\n * Initiate the DocuSign routing for a data access request's eDUC, creating the envelope and\n * sending it to the signers.\n * @see POST /repo/v1/dataAccessRequest/{requestId}/signature\n */\nexport function useInitiateDataAccessRequestSignature(\n  options?: UseMutationOptions<\n    EDucSignatureQuota,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >,\n) {\n  const { synapseClient } = useSynapseContext()\n  const invalidateOnSignatureChange = useInvalidateOnSignatureChange()\n\n  return useMutation<\n    EDucSignatureQuota,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >({\n    ...options,\n    mutationFn: ({ requestId }) =>\n      synapseClient.dataAccessServicesClient.postRepoV1DataAccessRequestRequestIdSignature(\n        { requestId },\n      ),\n    onSuccess: async (data, variables, ctx) => {\n      await invalidateOnSignatureChange(variables)\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx)\n      }\n      return\n    },\n  })\n}\n\n/**\n * Reads the precheck's answer out of whichever shape it arrives in. The generated client types this\n * endpoint as a bare `boolean` because that is what the OpenAPI spec declares, but neither the\n * declared type nor the runtime value can be trusted directly: the deployed service answers with a\n * `{ result }` wrapper, and the client falls back to handing back the raw response text whenever\n * the content type isn't JSON. Every shape is therefore compared explicitly -- a truthiness check\n * would read both the object `{ result: false }` and the string `\"false\"` as `true`.\n *\n * The spec is what is wrong here, not this endpoint: it declares a bare `boolean` for every\n * BooleanResult-returning service (`GET /entity/{id}/access` and `GET /evaluation/{evalId}/access`\n * are the others), so the generated types misdescribe all of them. Tracked by PLFM-10007 --\n * delete this shim and read the generated type directly once the spec is corrected.\n */\nfunction parseSignaturePrecheckResponse(response: unknown): boolean {\n  const answer =\n    typeof response === 'object' && response !== null && 'result' in response\n      ? (response as { result: unknown }).result\n      : response\n  return answer === true || answer === 'true'\n}\n\n/**\n * Ask the server whether the data access request's pending changes can be applied to the envelope\n * that is already in flight. The service owns every reason an envelope might be uncorrectable --\n * completed, voided, cancelled, declined -- so the answer is never inferred from its status here.\n *\n * @see GET /repo/v1/dataAccessRequest/{requestId}/signature/precheck\n */\nasync function fetchSignaturePrecheck(\n  synapseClient: SynapseClient,\n  requestId: string,\n): Promise<boolean> {\n  const response: unknown =\n    await synapseClient.dataAccessServicesClient.getRepoV1DataAccessRequestRequestIdSignaturePrecheck(\n      { requestId },\n    )\n  return parseSignaturePrecheckResponse(response)\n}\n\n/**\n * {@link fetchSignaturePrecheck} as a mutation, for the moment a user commits to sending. Modeled\n * as a mutation despite being a GET because the answer decides which irreversible call follows, so\n * it must never be served from cache.\n */\nexport function useCheckDataAccessRequestSignatureUpdatable(\n  options?: UseMutationOptions<boolean, SynapseClientError, string>,\n) {\n  const { synapseClient } = useSynapseContext()\n\n  return useMutation<boolean, SynapseClientError, string>({\n    ...options,\n    mutationFn: (requestId: string) =>\n      fetchSignaturePrecheck(synapseClient, requestId),\n  })\n}\n\n/**\n * {@link fetchSignaturePrecheck} as a query, for screens that describe what sending *would* do\n * rather than acting on it. Use {@link useCheckDataAccessRequestSignatureUpdatable} at the point\n * of action, where a cached answer would be unsafe.\n */\nexport function useGetDataAccessRequestSignatureUpdatable(\n  requestId: string,\n  options?: Partial<UseQueryOptions<boolean, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey:\n      keyFactory.getDataAccessRequestSignaturePrecheckQueryKey(requestId),\n    queryFn: () => fetchSignaturePrecheck(synapseClient, requestId),\n  })\n}\n\n/**\n * Apply the data access request's pending changes to its in-flight eDUC envelope, preserving the\n * signatures that have already been collected.\n * @see PUT /repo/v1/dataAccessRequest/{requestId}/signature\n */\nexport function useUpdateDataAccessRequestSignature(\n  options?: UseMutationOptions<\n    EDucSignatureStatus,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >,\n) {\n  const { synapseClient } = useSynapseContext()\n  const invalidateOnSignatureChange = useInvalidateOnSignatureChange()\n\n  return useMutation<\n    EDucSignatureStatus,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >({\n    ...options,\n    mutationFn: ({ requestId }) =>\n      synapseClient.dataAccessServicesClient.putRepoV1DataAccessRequestRequestIdSignature(\n        { requestId },\n      ),\n    onSuccess: async (data, variables, ctx) => {\n      await invalidateOnSignatureChange(variables)\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx)\n      }\n      return\n    },\n  })\n}\n\n/**\n * Void the eDUC routing for a data access request, reverting the DAR to trad-DUC mode.\n * @see DELETE /repo/v1/dataAccessRequest/{requestId}/signature\n */\nexport function useVoidDataAccessRequestSignature(\n  options?: UseMutationOptions<\n    void,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >,\n) {\n  const { synapseClient } = useSynapseContext()\n  const invalidateOnSignatureChange = useInvalidateOnSignatureChange()\n\n  return useMutation<\n    void,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >({\n    ...options,\n    mutationFn: ({ requestId }) =>\n      synapseClient.dataAccessServicesClient.deleteRepoV1DataAccessRequestRequestIdSignature(\n        { requestId },\n      ),\n    onSuccess: async (data, variables, ctx) => {\n      await invalidateOnSignatureChange(variables)\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx)\n      }\n      return\n    },\n  })\n}\n"],"mappings":";;;;AA+BA,SAAgB,EACd,IAA0D,CAAC,GAC3D,GASA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAML;EACA,GAAG;EACH,UAAU,EAAW,0BAA0B,CAAO;EACtD,UAAS,MACP,EAAc,yBAAyB,uBAAuB,EAC5D,yBAAyB;GACvB,GAAG;GACH,eAAe,EAAQ;EACzB,EACF,CAAC;EACH,kBAAkB,KAAA;EAClB,mBAAkB,MAAQ,EAAK;CACjC,CAAC;AACH;AAMA,SAAgB,EACd,GACA,GAGA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,kCAAkC,CAAU;EACjE,eACE,EAAc,yBAAyB,0CACrC,EAAE,cAAW,CACf;CACJ,CAAC;AACH;AAMA,SAAgB,EACd,IAAoC,CAAC,GACrC,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,+BAA+B,CAAO;EAC3D,eACE,EAAc,yBAAyB,gCAAgC,EACrE,0BAA0B,EAC5B,CAAC;CACL,CAAC;AACH;AAaA,SAAgB,EACd,IAA2D,CAAC,GAC5D,GAGA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,kCAAkC,CAAO;EAC9D,eACE,EACE,OAAM,MAAiB;GACrB,IAAM,IACJ,MAAM,EAAc,yBAAyB,gCAC3C,EACE,0BAA0B;IACxB,GAAG;IACH,eAAe,KAAiB,KAAA;GAClC,EACF,CACF;GACF,OAAO;IACL,SAAS,EAAS,WAAW,CAAC;IAC9B,eAAe,EAAS;GAC1B;EACF,CACF;CACJ,CAAC;AACH;AASA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,oCAAoC,CAAS;EAClE,eACE,EAAc,yBAAyB,2CACrC,EAAE,aAAU,CACd;CACJ,CAAC;AACH;AAMA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,4CAA4C,CAAS;EAC1E,eACE,EAAc,yBAAyB,mDACrC,EAAE,aAAU,CACd;CACJ,CAAC;AACH;AAMA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UACE,EAAW,kDAAkD,CAAS;EACxE,eACE,EAAc,yBAAyB,yDACrC,EAAE,aAAU,CACd;CACJ,CAAC;AACH;AAQA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,2CAA2C,CAAS;EACzE,eACE,EAAc,yBAAyB,kDACrC,EAAE,aAAU,CACd;CACJ,CAAC;AACH;AAmBA,SAAS,IAAiC;CACxC,IAAM,EAAE,kBAAe,EAAkB,GACnC,IAAc,EAAe;CAEnC,QAAQ,EACN,cACA,6BAEA,QAAQ,IAAI;EACV,EAAY,kBAAkB,EAC5B,UAAU,EAAW,sCAAsC,CAAS,EACtE,CAAC;EAED,EAAY,kBAAkB,EAC5B,UAAU,EAAW,iCAAiC,EACxD,CAAC;EAGD,EAAY,kBAAkB,EAC5B,UACE,EAAW,sCAAsC,CAAmB,EACxE,CAAC;CACH,CAAC;AACL;AAOA,SAAgB,EACd,GAKA;CACA,IAAM,EAAE,qBAAkB,EAAkB,GACtC,IAA8B,EAA+B;CAEnE,OAAO,EAIL;EACA,GAAG;EACH,aAAa,EAAE,mBACb,EAAc,yBAAyB,8CACrC,EAAE,aAAU,CACd;EACF,WAAW,OAAO,GAAM,GAAW,MAAQ;GAEzC,IADA,MAAM,EAA4B,CAAS,GACvC,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,CAAG;EAGjD;CACF,CAAC;AACH;AAeA,SAAS,EAA+B,GAA4B;CAClE,IAAM,IACJ,OAAO,KAAa,YAAY,KAAqB,YAAY,IAC5D,EAAiC,SAClC;CACN,OAAO,MAAW,MAAQ,MAAW;AACvC;AASA,eAAe,EACb,GACA,GACkB;CAKlB,OAAO,EAA+B,MAH9B,EAAc,yBAAyB,qDAC3C,EAAE,aAAU,CACd,CAC4C;AAChD;AAOA,SAAgB,EACd,GACA;CACA,IAAM,EAAE,qBAAkB,EAAkB;CAE5C,OAAO,EAAiD;EACtD,GAAG;EACH,aAAa,MACX,EAAuB,GAAe,CAAS;CACnD,CAAC;AACH;AAOA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UACE,EAAW,8CAA8C,CAAS;EACpE,eAAe,EAAuB,GAAe,CAAS;CAChE,CAAC;AACH;AAOA,SAAgB,EACd,GAKA;CACA,IAAM,EAAE,qBAAkB,EAAkB,GACtC,IAA8B,EAA+B;CAEnE,OAAO,EAIL;EACA,GAAG;EACH,aAAa,EAAE,mBACb,EAAc,yBAAyB,6CACrC,EAAE,aAAU,CACd;EACF,WAAW,OAAO,GAAM,GAAW,MAAQ;GAEzC,IADA,MAAM,EAA4B,CAAS,GACvC,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,CAAG;EAGjD;CACF,CAAC;AACH;AAMA,SAAgB,EACd,GAKA;CACA,IAAM,EAAE,qBAAkB,EAAkB,GACtC,IAA8B,EAA+B;CAEnE,OAAO,EAIL;EACA,GAAG;EACH,aAAa,EAAE,mBACb,EAAc,yBAAyB,gDACrC,EAAE,aAAU,CACd;EACF,WAAW,OAAO,GAAM,GAAW,MAAQ;GAEzC,IADA,MAAM,EAA4B,CAAS,GACvC,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,CAAG;EAGjD;CACF,CAAC;AACH"}
+{"version":3,"file":"useEDuc.js","names":[],"sources":["../../../src/synapse-queries/dataaccess/useEDuc.ts"],"sourcesContent":["import { getAllOfNextPageTokenPaginatedService } from '@/synapse-client/SynapseClient'\nimport { useSynapseContext } from '@/utils/context/SynapseContext'\nimport {\n  AccessRequestList,\n  AccessRequestListRequest,\n  AccessRequestSummary,\n  EDucFileHandleId,\n  EDucSignatureQuota,\n  EDucSignatureStatus,\n  EDucTemplateListRequest,\n  EDucTemplatePage,\n  EDucTemplateValidationResult,\n} from '@sage-bionetworks/synapse-client'\nimport { SynapseClient } from '@sage-bionetworks/synapse-client/SynapseClient'\nimport { SynapseClientError } from '@sage-bionetworks/synapse-client/util/SynapseClientError'\nimport {\n  InfiniteData,\n  QueryKey,\n  useInfiniteQuery,\n  UseInfiniteQueryOptions,\n  useMutation,\n  UseMutationOptions,\n  useQuery,\n  useQueryClient,\n  UseQueryOptions,\n} from '@tanstack/react-query'\n\n/**\n * List the eDUC templates registered in DocuSign (all pages).\n * @see POST /repo/v1/eDuc/template\n */\nexport function useListEDucTemplates<TData = InfiniteData<EDucTemplatePage>>(\n  request: Omit<EDucTemplateListRequest, 'nextPageToken'> = {},\n  options?: Partial<\n    UseInfiniteQueryOptions<\n      EDucTemplatePage,\n      SynapseClientError,\n      TData,\n      QueryKey,\n      EDucTemplatePage['nextPageToken']\n    >\n  >,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useInfiniteQuery<\n    EDucTemplatePage,\n    SynapseClientError,\n    TData,\n    QueryKey,\n    EDucTemplatePage['nextPageToken']\n  >({\n    ...options,\n    queryKey: keyFactory.listEDucTemplatesQueryKey(request),\n    queryFn: context =>\n      synapseClient.dataAccessServicesClient.postRepoV1EDucTemplate({\n        eDucTemplateListRequest: {\n          ...request,\n          nextPageToken: context.pageParam,\n        },\n      }),\n    initialPageParam: undefined,\n    getNextPageParam: page => page.nextPageToken,\n  })\n}\n\n/**\n * Validate a single eDUC template by ID (ACT-only).\n * @see GET /repo/v1/eDuc/template/{templateId}/validation\n */\nexport function useGetEDucTemplateValidation(\n  templateId: string,\n  options?: Partial<\n    UseQueryOptions<EDucTemplateValidationResult, SynapseClientError>\n  >,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEDucTemplateValidationQueryKey(templateId),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.getRepoV1EDucTemplateTemplateIdValidation(\n        { templateId },\n      ),\n  })\n}\n\n/**\n * List the data access requests that the calling user created or participates in.\n * @see POST /repo/v1/dataAccessRequest/list\n */\nexport function useListUserDataAccessRequests(\n  request: AccessRequestListRequest = {},\n  options?: Partial<UseQueryOptions<AccessRequestList, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.listDataAccessRequestsQueryKey(request),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.postRepoV1DataAccessRequestList({\n        accessRequestListRequest: request,\n      }),\n  })\n}\n\n/**\n * List _all_ data access requests that the calling user created or participates in, walking every\n * page of `POST /repo/v1/dataAccessRequest/list` via `nextPageToken` inside the queryFn. Returns\n * the flattened list of {@link AccessRequestSummary}.\n *\n * Prefer this hook over {@link useListUserDataAccessRequests} when the caller needs the complete\n * list (for example, to filter results client-side). This avoids the render-per-page cascade of\n * `useInfiniteQuery` at the cost of a slightly longer initial load.\n *\n * @see POST /repo/v1/dataAccessRequest/list\n */\nexport function useListAllUserDataAccessRequests(\n  request: Omit<AccessRequestListRequest, 'nextPageToken'> = {},\n  options?: Partial<\n    UseQueryOptions<AccessRequestSummary[], SynapseClientError>\n  >,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.listAllDataAccessRequestsQueryKey(request),\n    queryFn: () =>\n      getAllOfNextPageTokenPaginatedService<AccessRequestSummary>(\n        async nextPageToken => {\n          const response =\n            await synapseClient.dataAccessServicesClient.postRepoV1DataAccessRequestList(\n              {\n                accessRequestListRequest: {\n                  ...request,\n                  nextPageToken: nextPageToken ?? undefined,\n                },\n              },\n            )\n          return {\n            results: response.results ?? [],\n            nextPageToken: response.nextPageToken,\n          }\n        },\n      ),\n  })\n}\n\n/**\n * Retrieve the pre-signing preview of the eDUC for a data access request. The document is rendered\n * from the request as it stands, via an envelope the service discards once the PDF exists, so\n * reading it neither routes anything for signature nor alters the request.\n *\n * @see GET /repo/v1/dataAccessRequest/{requestId}/preview\n */\nexport function useGetDataAccessRequestPreview(\n  requestId: string,\n  options?: Partial<UseQueryOptions<EDucFileHandleId, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDataAccessRequestPreviewQueryKey(requestId),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.getRepoV1DataAccessRequestRequestIdPreview(\n        { requestId },\n      ),\n  })\n}\n\n/**\n * Retrieve the current signature status of a data access request's routed eDUC.\n * @see GET /repo/v1/dataAccessRequest/{requestId}/signature/status\n */\nexport function useGetDataAccessRequestSignatureStatus(\n  requestId: string,\n  options?: Partial<UseQueryOptions<EDucSignatureStatus, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDataAccessRequestSignatureStatusQueryKey(requestId),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.getRepoV1DataAccessRequestRequestIdSignatureStatus(\n        { requestId },\n      ),\n  })\n}\n\n/**\n * Retrieve the file handle ID of the signed eDUC document for a data access request.\n * @see GET /repo/v1/dataAccessRequest/{requestId}/signature/filehandleId\n */\nexport function useGetDataAccessRequestSignedFileHandleId(\n  requestId: string,\n  options?: Partial<UseQueryOptions<EDucFileHandleId, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey:\n      keyFactory.getDataAccessRequestSignatureFileHandleIdQueryKey(requestId),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.getRepoV1DataAccessRequestRequestIdSignatureFilehandleId(\n        { requestId },\n      ),\n  })\n}\n\n/**\n * Retrieve the current eDUC signature quota (total allowed and remaining) for a data access\n * request. Used to preflight the \"send for signature\" action so it can be disabled when the\n * user is at or over quota.\n * @see GET /repo/v1/dataAccessRequest/{requestId}/signature/quota\n */\nexport function useGetDataAccessRequestSignatureQuota(\n  requestId: string,\n  options?: Partial<UseQueryOptions<EDucSignatureQuota, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDataAccessRequestSignatureQuotaQueryKey(requestId),\n    queryFn: () =>\n      synapseClient.dataAccessServicesClient.getRepoV1DataAccessRequestRequestIdSignatureQuota(\n        { requestId },\n      ),\n  })\n}\n\n/**\n * Identifies the data access request a signature mutation acts on. The access requirement is\n * carried alongside the request id because these mutations all change `eDucSignatureEnvelopeId`\n * on the request itself, and the cache entry holding that field is keyed by access requirement\n * rather than by request.\n */\nexport type DataAccessRequestSignatureVariables = {\n  requestId: string\n  accessRequirementId: string\n}\n\n/**\n * Invalidates everything a change to the eDUC envelope makes obsolete.\n *\n * The preview is deliberately absent: it renders the request's own content, which routing does\n * not touch, and regenerating it costs a server-side PDF render.\n */\nfunction useInvalidateOnSignatureChange() {\n  const { keyFactory } = useSynapseContext()\n  const queryClient = useQueryClient()\n\n  return ({\n    requestId,\n    accessRequirementId,\n  }: DataAccessRequestSignatureVariables) =>\n    Promise.all([\n      queryClient.invalidateQueries({\n        queryKey: keyFactory.getDataAccessRequestSignatureQueryKey(requestId),\n      }),\n      // The listings report envelope status, so they move with every routing change.\n      queryClient.invalidateQueries({\n        queryKey: keyFactory.getDataAccessRequestListQueryKey(),\n      }),\n      // `eDucSignatureEnvelopeId` is how callers tell a first send from a re-send, so the request\n      // must not stay cached from before the routing changed.\n      queryClient.invalidateQueries({\n        queryKey:\n          keyFactory.getDataAccessRequestForUpdateQueryKey(accessRequirementId),\n      }),\n    ])\n}\n\n/**\n * Initiate the DocuSign routing for a data access request's eDUC, creating the envelope and\n * sending it to the signers.\n * @see POST /repo/v1/dataAccessRequest/{requestId}/signature\n */\nexport function useInitiateDataAccessRequestSignature(\n  options?: UseMutationOptions<\n    EDucSignatureQuota,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >,\n) {\n  const { synapseClient } = useSynapseContext()\n  const invalidateOnSignatureChange = useInvalidateOnSignatureChange()\n\n  return useMutation<\n    EDucSignatureQuota,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >({\n    ...options,\n    mutationFn: ({ requestId }) =>\n      synapseClient.dataAccessServicesClient.postRepoV1DataAccessRequestRequestIdSignature(\n        { requestId },\n      ),\n    onSuccess: async (data, variables, ctx, ...rest) => {\n      await invalidateOnSignatureChange(variables)\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx, ...rest)\n      }\n      return\n    },\n  })\n}\n\n/**\n * Reads the precheck's answer out of whichever shape it arrives in. The generated client types this\n * endpoint as a bare `boolean` because that is what the OpenAPI spec declares, but neither the\n * declared type nor the runtime value can be trusted directly: the deployed service answers with a\n * `{ result }` wrapper, and the client falls back to handing back the raw response text whenever\n * the content type isn't JSON. Every shape is therefore compared explicitly -- a truthiness check\n * would read both the object `{ result: false }` and the string `\"false\"` as `true`.\n *\n * The spec is what is wrong here, not this endpoint: it declares a bare `boolean` for every\n * BooleanResult-returning service (`GET /entity/{id}/access` and `GET /evaluation/{evalId}/access`\n * are the others), so the generated types misdescribe all of them. Tracked by PLFM-10007 --\n * delete this shim and read the generated type directly once the spec is corrected.\n */\nfunction parseSignaturePrecheckResponse(response: unknown): boolean {\n  const answer =\n    typeof response === 'object' && response !== null && 'result' in response\n      ? (response as { result: unknown }).result\n      : response\n  return answer === true || answer === 'true'\n}\n\n/**\n * Ask the server whether the data access request's pending changes can be applied to the envelope\n * that is already in flight. The service owns every reason an envelope might be uncorrectable --\n * completed, voided, cancelled, declined -- so the answer is never inferred from its status here.\n *\n * @see GET /repo/v1/dataAccessRequest/{requestId}/signature/precheck\n */\nasync function fetchSignaturePrecheck(\n  synapseClient: SynapseClient,\n  requestId: string,\n): Promise<boolean> {\n  const response: unknown =\n    await synapseClient.dataAccessServicesClient.getRepoV1DataAccessRequestRequestIdSignaturePrecheck(\n      { requestId },\n    )\n  return parseSignaturePrecheckResponse(response)\n}\n\n/**\n * {@link fetchSignaturePrecheck} as a mutation, for the moment a user commits to sending. Modeled\n * as a mutation despite being a GET because the answer decides which irreversible call follows, so\n * it must never be served from cache.\n */\nexport function useCheckDataAccessRequestSignatureUpdatable(\n  options?: UseMutationOptions<boolean, SynapseClientError, string>,\n) {\n  const { synapseClient } = useSynapseContext()\n\n  return useMutation<boolean, SynapseClientError, string>({\n    ...options,\n    mutationFn: (requestId: string) =>\n      fetchSignaturePrecheck(synapseClient, requestId),\n  })\n}\n\n/**\n * {@link fetchSignaturePrecheck} as a query, for screens that describe what sending *would* do\n * rather than acting on it. Use {@link useCheckDataAccessRequestSignatureUpdatable} at the point\n * of action, where a cached answer would be unsafe.\n */\nexport function useGetDataAccessRequestSignatureUpdatable(\n  requestId: string,\n  options?: Partial<UseQueryOptions<boolean, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey:\n      keyFactory.getDataAccessRequestSignaturePrecheckQueryKey(requestId),\n    queryFn: () => fetchSignaturePrecheck(synapseClient, requestId),\n  })\n}\n\n/**\n * Apply the data access request's pending changes to its in-flight eDUC envelope, preserving the\n * signatures that have already been collected.\n * @see PUT /repo/v1/dataAccessRequest/{requestId}/signature\n */\nexport function useUpdateDataAccessRequestSignature(\n  options?: UseMutationOptions<\n    EDucSignatureStatus,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >,\n) {\n  const { synapseClient } = useSynapseContext()\n  const invalidateOnSignatureChange = useInvalidateOnSignatureChange()\n\n  return useMutation<\n    EDucSignatureStatus,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >({\n    ...options,\n    mutationFn: ({ requestId }) =>\n      synapseClient.dataAccessServicesClient.putRepoV1DataAccessRequestRequestIdSignature(\n        { requestId },\n      ),\n    onSuccess: async (data, variables, ctx, ...rest) => {\n      await invalidateOnSignatureChange(variables)\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx, ...rest)\n      }\n      return\n    },\n  })\n}\n\n/**\n * Void the eDUC routing for a data access request, reverting the DAR to trad-DUC mode.\n * @see DELETE /repo/v1/dataAccessRequest/{requestId}/signature\n */\nexport function useVoidDataAccessRequestSignature(\n  options?: UseMutationOptions<\n    void,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >,\n) {\n  const { synapseClient } = useSynapseContext()\n  const invalidateOnSignatureChange = useInvalidateOnSignatureChange()\n\n  return useMutation<\n    void,\n    SynapseClientError,\n    DataAccessRequestSignatureVariables\n  >({\n    ...options,\n    mutationFn: ({ requestId }) =>\n      synapseClient.dataAccessServicesClient.deleteRepoV1DataAccessRequestRequestIdSignature(\n        { requestId },\n      ),\n    onSuccess: async (data, variables, ctx, ...rest) => {\n      await invalidateOnSignatureChange(variables)\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx, ...rest)\n      }\n      return\n    },\n  })\n}\n"],"mappings":";;;;AA+BA,SAAgB,EACd,IAA0D,CAAC,GAC3D,GASA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAML;EACA,GAAG;EACH,UAAU,EAAW,0BAA0B,CAAO;EACtD,UAAS,MACP,EAAc,yBAAyB,uBAAuB,EAC5D,yBAAyB;GACvB,GAAG;GACH,eAAe,EAAQ;EACzB,EACF,CAAC;EACH,kBAAkB,KAAA;EAClB,mBAAkB,MAAQ,EAAK;CACjC,CAAC;AACH;AAMA,SAAgB,EACd,GACA,GAGA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,kCAAkC,CAAU;EACjE,eACE,EAAc,yBAAyB,0CACrC,EAAE,cAAW,CACf;CACJ,CAAC;AACH;AAMA,SAAgB,EACd,IAAoC,CAAC,GACrC,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,+BAA+B,CAAO;EAC3D,eACE,EAAc,yBAAyB,gCAAgC,EACrE,0BAA0B,EAC5B,CAAC;CACL,CAAC;AACH;AAaA,SAAgB,EACd,IAA2D,CAAC,GAC5D,GAGA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,kCAAkC,CAAO;EAC9D,eACE,EACE,OAAM,MAAiB;GACrB,IAAM,IACJ,MAAM,EAAc,yBAAyB,gCAC3C,EACE,0BAA0B;IACxB,GAAG;IACH,eAAe,KAAiB,KAAA;GAClC,EACF,CACF;GACF,OAAO;IACL,SAAS,EAAS,WAAW,CAAC;IAC9B,eAAe,EAAS;GAC1B;EACF,CACF;CACJ,CAAC;AACH;AASA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,oCAAoC,CAAS;EAClE,eACE,EAAc,yBAAyB,2CACrC,EAAE,aAAU,CACd;CACJ,CAAC;AACH;AAMA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,4CAA4C,CAAS;EAC1E,eACE,EAAc,yBAAyB,mDACrC,EAAE,aAAU,CACd;CACJ,CAAC;AACH;AAMA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UACE,EAAW,kDAAkD,CAAS;EACxE,eACE,EAAc,yBAAyB,yDACrC,EAAE,aAAU,CACd;CACJ,CAAC;AACH;AAQA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,2CAA2C,CAAS;EACzE,eACE,EAAc,yBAAyB,kDACrC,EAAE,aAAU,CACd;CACJ,CAAC;AACH;AAmBA,SAAS,IAAiC;CACxC,IAAM,EAAE,kBAAe,EAAkB,GACnC,IAAc,EAAe;CAEnC,QAAQ,EACN,cACA,6BAEA,QAAQ,IAAI;EACV,EAAY,kBAAkB,EAC5B,UAAU,EAAW,sCAAsC,CAAS,EACtE,CAAC;EAED,EAAY,kBAAkB,EAC5B,UAAU,EAAW,iCAAiC,EACxD,CAAC;EAGD,EAAY,kBAAkB,EAC5B,UACE,EAAW,sCAAsC,CAAmB,EACxE,CAAC;CACH,CAAC;AACL;AAOA,SAAgB,EACd,GAKA;CACA,IAAM,EAAE,qBAAkB,EAAkB,GACtC,IAA8B,EAA+B;CAEnE,OAAO,EAIL;EACA,GAAG;EACH,aAAa,EAAE,mBACb,EAAc,yBAAyB,8CACrC,EAAE,aAAU,CACd;EACF,WAAW,OAAO,GAAM,GAAW,GAAK,GAAG,MAAS;GAElD,IADA,MAAM,EAA4B,CAAS,GACvC,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,GAAK,GAAG,CAAI;EAG1D;CACF,CAAC;AACH;AAeA,SAAS,EAA+B,GAA4B;CAClE,IAAM,IACJ,OAAO,KAAa,YAAY,KAAqB,YAAY,IAC5D,EAAiC,SAClC;CACN,OAAO,MAAW,MAAQ,MAAW;AACvC;AASA,eAAe,EACb,GACA,GACkB;CAKlB,OAAO,EAA+B,MAH9B,EAAc,yBAAyB,qDAC3C,EAAE,aAAU,CACd,CAC4C;AAChD;AAOA,SAAgB,EACd,GACA;CACA,IAAM,EAAE,qBAAkB,EAAkB;CAE5C,OAAO,EAAiD;EACtD,GAAG;EACH,aAAa,MACX,EAAuB,GAAe,CAAS;CACnD,CAAC;AACH;AAOA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UACE,EAAW,8CAA8C,CAAS;EACpE,eAAe,EAAuB,GAAe,CAAS;CAChE,CAAC;AACH;AAOA,SAAgB,EACd,GAKA;CACA,IAAM,EAAE,qBAAkB,EAAkB,GACtC,IAA8B,EAA+B;CAEnE,OAAO,EAIL;EACA,GAAG;EACH,aAAa,EAAE,mBACb,EAAc,yBAAyB,6CACrC,EAAE,aAAU,CACd;EACF,WAAW,OAAO,GAAM,GAAW,GAAK,GAAG,MAAS;GAElD,IADA,MAAM,EAA4B,CAAS,GACvC,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,GAAK,GAAG,CAAI;EAG1D;CACF,CAAC;AACH;AAMA,SAAgB,EACd,GAKA;CACA,IAAM,EAAE,qBAAkB,EAAkB,GACtC,IAA8B,EAA+B;CAEnE,OAAO,EAIL;EACA,GAAG;EACH,aAAa,EAAE,mBACb,EAAc,yBAAyB,gDACrC,EAAE,aAAU,CACd;EACF,WAAW,OAAO,GAAM,GAAW,GAAK,GAAG,MAAS;GAElD,IADA,MAAM,EAA4B,CAAS,GACvC,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,GAAK,GAAG,CAAI;EAG1D;CACF,CAAC;AACH"}

package/dist/synapse-queries/dataaccess/useFormTemplate.js

@@ -61,8 +61,8 @@ function f(t) {
 	return i({
 		...t,
 		mutationFn: (e) => a.accessRequirementServicesClient.postRepoV1AccessRequirementFormTemplate({ formTemplate: e }),
-		onSuccess: async (e, i, a) => {
-			n.setQueryData(r.getFormTemplateByIdQueryKey(e.id), e), await n.invalidateQueries({ queryKey: r.getFormTemplateQueryKey() }), t?.onSuccess && await t.onSuccess(e, i, a);
+		onSuccess: async (e, i, a, ...o) => {
+			n.setQueryData(r.getFormTemplateByIdQueryKey(e.id), e), await n.invalidateQueries({ queryKey: r.getFormTemplateQueryKey() }), t?.onSuccess && await t.onSuccess(e, i, a, ...o);
 		}
 	});
 }
@@ -74,8 +74,8 @@ function p(t) {
 			templateId: e,
 			formTemplate: t
 		}),
-		onSuccess: async (e, i, a) => {
-			n.setQueryData(r.getFormTemplateByIdQueryKey(i.templateId), e), await n.invalidateQueries({ queryKey: r.getFormTemplateQueryKey() }), t?.onSuccess && await t.onSuccess(e, i, a);
+		onSuccess: async (e, i, a, ...o) => {
+			n.setQueryData(r.getFormTemplateByIdQueryKey(i.templateId), e), await n.invalidateQueries({ queryKey: r.getFormTemplateQueryKey() }), t?.onSuccess && await t.onSuccess(e, i, a, ...o);
 		}
 	});
 }

package/dist/synapse-queries/dataaccess/useFormTemplate.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFormTemplate.js","names":[],"sources":["../../../src/synapse-queries/dataaccess/useFormTemplate.ts"],"sourcesContent":["/*\n * Hooks for authoring and retrieving FormTemplates, which define how a JSON Schema is rendered\n * to a requester as a multi-step form.\n */\nimport { useSynapseContext } from '@/utils'\nimport {\n  FormTemplate,\n  FormTemplateSearchRequest,\n  FormTemplateSearchResponse,\n} from '@sage-bionetworks/synapse-client'\nimport { SynapseClientError } from '@sage-bionetworks/synapse-client/util/SynapseClientError'\nimport {\n  InfiniteData,\n  QueryKey,\n  skipToken,\n  useInfiniteQuery,\n  UseInfiniteQueryOptions,\n  useMutation,\n  UseMutationOptions,\n  useQueries,\n  useQuery,\n  useQueryClient,\n  UseQueryOptions,\n} from '@tanstack/react-query'\nimport { useMemo } from 'react'\n\n/**\n * Retrieve the latest version of a FormTemplate by its ID. Disabled while templateId is undefined.\n * @see GET /repo/v1/accessRequirement/formTemplate/{templateId}\n */\nexport function useGetFormTemplate(\n  templateId: string | undefined,\n  options?: Partial<UseQueryOptions<FormTemplate, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getFormTemplateByIdQueryKey(templateId ?? ''),\n    queryFn: templateId\n      ? () =>\n          synapseClient.accessRequirementServicesClient.getRepoV1AccessRequirementFormTemplateTemplateId(\n            { templateId },\n          )\n      : skipToken,\n  })\n}\n\n/**\n * Retrieve a specific version of a FormTemplate. Disabled while templateId or versionNumber is\n * undefined.\n * @see GET /repo/v1/accessRequirement/formTemplate/{templateId}/version/{versionNumber}\n */\nexport function useGetFormTemplateVersion(\n  templateId: string | undefined,\n  versionNumber: number | undefined,\n  options?: Partial<UseQueryOptions<FormTemplate, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getFormTemplateVersionQueryKey(\n      templateId ?? '',\n      versionNumber ?? 0,\n    ),\n    queryFn:\n      templateId != null && versionNumber != null\n        ? () =>\n            synapseClient.accessRequirementServicesClient.getRepoV1AccessRequirementFormTemplateTemplateIdVersionVersionNumber(\n              { templateId, versionNumber },\n            )\n        : skipToken,\n  })\n}\n\n/**\n * Retrieve every version of a FormTemplate. The API has no endpoint to list versions (PLFM-10045),\n * so this fetches the latest version and then each earlier version number in turn. `versions` is\n * ordered newest first and omits any version that has not loaded; `latestVersion` is always the\n * template's actual latest version. Disabled while templateId is undefined.\n */\nexport function useGetFormTemplateVersions(templateId: string | undefined) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n  const { data: latestVersion, error: latestVersionError } =\n    useGetFormTemplate(templateId)\n\n  const earlierVersionNumbers = useMemo(() => {\n    const earlierVersionCount = Math.max(\n      (latestVersion?.versionNumber ?? 0) - 1,\n      0,\n    )\n    return Array.from(\n      { length: earlierVersionCount },\n      (_, index) => earlierVersionCount - index,\n    )\n  }, [latestVersion?.versionNumber])\n\n  return useQueries({\n    queries: earlierVersionNumbers.map(versionNumber => ({\n      queryKey: keyFactory.getFormTemplateVersionQueryKey(\n        templateId ?? '',\n        versionNumber,\n      ),\n      queryFn: () =>\n        synapseClient.accessRequirementServicesClient.getRepoV1AccessRequirementFormTemplateTemplateIdVersionVersionNumber(\n          { templateId: templateId!, versionNumber },\n        ),\n    })),\n    combine: results => ({\n      latestVersion,\n      versions: [\n        ...(latestVersion ? [latestVersion] : []),\n        ...results.flatMap(result => (result.data ? [result.data] : [])),\n      ],\n      isLoading:\n        templateId != null &&\n        (latestVersion == null\n          ? latestVersionError == null\n          : results.some(result => result.isLoading)),\n      error: latestVersionError ?? results.find(result => result.error)?.error,\n    }),\n  })\n}\n\n/**\n * Search FormTemplates by name (all pages, via useInfiniteQuery). Only the latest version of each\n * matching template is returned.\n * @see POST /repo/v1/accessRequirement/formTemplate/search\n */\nexport function useSearchFormTemplatesInfinite<\n  TData = InfiniteData<FormTemplateSearchResponse>,\n>(\n  request: Omit<FormTemplateSearchRequest, 'nextPageToken'> = {},\n  options?: Partial<\n    UseInfiniteQueryOptions<\n      FormTemplateSearchResponse,\n      SynapseClientError,\n      TData,\n      QueryKey,\n      FormTemplateSearchResponse['nextPageToken']\n    >\n  >,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useInfiniteQuery<\n    FormTemplateSearchResponse,\n    SynapseClientError,\n    TData,\n    QueryKey,\n    FormTemplateSearchResponse['nextPageToken']\n  >({\n    ...options,\n    queryKey: keyFactory.searchFormTemplatesQueryKey(request),\n    queryFn: context =>\n      synapseClient.accessRequirementServicesClient.postRepoV1AccessRequirementFormTemplateSearch(\n        {\n          formTemplateSearchRequest: {\n            ...request,\n            nextPageToken: context.pageParam,\n          },\n        },\n      ),\n    initialPageParam: undefined,\n    getNextPageParam: page => page.nextPageToken,\n  })\n}\n\n/**\n * Create a new FormTemplate. Creating a template issues its first version.\n * @see POST /repo/v1/accessRequirement/formTemplate\n */\nexport function useCreateFormTemplate(\n  options?: Omit<\n    UseMutationOptions<FormTemplate, SynapseClientError, FormTemplate>,\n    'mutationFn'\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useMutation<FormTemplate, SynapseClientError, FormTemplate>({\n    ...options,\n    mutationFn: formTemplate =>\n      synapseClient.accessRequirementServicesClient.postRepoV1AccessRequirementFormTemplate(\n        { formTemplate },\n      ),\n    onSuccess: async (createdTemplate, variables, ctx) => {\n      queryClient.setQueryData(\n        keyFactory.getFormTemplateByIdQueryKey(createdTemplate.id!),\n        createdTemplate,\n      )\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getFormTemplateQueryKey(),\n      })\n      if (options?.onSuccess) {\n        await options.onSuccess(createdTemplate, variables, ctx)\n      }\n    },\n  })\n}\n\nexport type UpdateFormTemplateRequest = {\n  templateId: string\n  /**\n   * The new version's content. Must carry the `etag` of the version this update was based on so\n   * the server can reject the write if the template was concurrently modified.\n   */\n  formTemplate: FormTemplate\n}\n\n/**\n * Add a new version to an existing FormTemplate. The server uses the `etag` on `formTemplate` to\n * detect concurrent modification; if the template has since changed, the mutation's error will\n * reflect the conflict rather than silently overwriting the newer version.\n * @see POST /repo/v1/accessRequirement/formTemplate/{templateId}\n */\nexport function useUpdateFormTemplate(\n  options?: Omit<\n    UseMutationOptions<\n      FormTemplate,\n      SynapseClientError,\n      UpdateFormTemplateRequest\n    >,\n    'mutationFn'\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useMutation<\n    FormTemplate,\n    SynapseClientError,\n    UpdateFormTemplateRequest\n  >({\n    ...options,\n    mutationFn: ({ templateId, formTemplate }) =>\n      synapseClient.accessRequirementServicesClient.postRepoV1AccessRequirementFormTemplateTemplateId(\n        { templateId, formTemplate },\n      ),\n    onSuccess: async (updatedTemplate, variables, ctx) => {\n      queryClient.setQueryData(\n        keyFactory.getFormTemplateByIdQueryKey(variables.templateId),\n        updatedTemplate,\n      )\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getFormTemplateQueryKey(),\n      })\n      if (options?.onSuccess) {\n        await options.onSuccess(updatedTemplate, variables, ctx)\n      }\n    },\n  })\n}\n"],"mappings":";;;;;AA8BA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,4BAA4B,KAAc,EAAE;EACjE,SAAS,UAEH,EAAc,gCAAgC,iDAC5C,EAAE,cAAW,CACf,IACF;CACN,CAAC;AACH;AAOA,SAAgB,EACd,GACA,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,+BACnB,KAAc,IACd,KAAiB,CACnB;EACA,SACE,KAAc,QAAQ,KAAiB,aAEjC,EAAc,gCAAgC,qEAC5C;GAAE;GAAY;EAAc,CAC9B,IACF;CACR,CAAC;AACH;AAQA,SAAgB,EAA2B,GAAgC;CACzE,IAAM,EAAE,eAAY,qBAAkB,EAAkB,GAClD,EAAE,MAAM,GAAe,OAAO,MAClC,EAAmB,CAAU;CAa/B,OAAO,EAAW;EAChB,SAZ4B,QAAc;GAC1C,IAAM,IAAsB,KAAK,KAC9B,GAAe,iBAAiB,KAAK,GACtC,CACF;GACA,OAAO,MAAM,KACX,EAAE,QAAQ,EAAoB,IAC7B,GAAG,MAAU,IAAsB,CACtC;EACF,GAAG,CAAC,GAAe,aAAa,CAGrB,EAAsB,KAAI,OAAkB;GACnD,UAAU,EAAW,+BACnB,KAAc,IACd,CACF;GACA,eACE,EAAc,gCAAgC,qEAC5C;IAAc;IAAa;GAAc,CAC3C;EACJ,EAAE;EACF,UAAS,OAAY;GACnB;GACA,UAAU,CACR,GAAI,IAAgB,CAAC,CAAa,IAAI,CAAC,GACvC,GAAG,EAAQ,SAAQ,MAAW,EAAO,OAAO,CAAC,EAAO,IAAI,IAAI,CAAC,CAAE,CACjE;GACA,WACE,KAAc,SACb,KAAiB,OACd,KAAsB,OACtB,EAAQ,MAAK,MAAU,EAAO,SAAS;GAC7C,OAAO,KAAsB,EAAQ,MAAK,MAAU,EAAO,KAAK,GAAG;EACrE;CACF,CAAC;AACH;AAOA,SAAgB,EAGd,IAA4D,CAAC,GAC7D,GASA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAML;EACA,GAAG;EACH,UAAU,EAAW,4BAA4B,CAAO;EACxD,UAAS,MACP,EAAc,gCAAgC,8CAC5C,EACE,2BAA2B;GACzB,GAAG;GACH,eAAe,EAAQ;EACzB,EACF,CACF;EACF,kBAAkB,KAAA;EAClB,mBAAkB,MAAQ,EAAK;CACjC,CAAC;AACH;AAMA,SAAgB,EACd,GAIA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAA4D;EACjE,GAAG;EACH,aAAY,MACV,EAAc,gCAAgC,wCAC5C,EAAE,gBAAa,CACjB;EACF,WAAW,OAAO,GAAiB,GAAW,MAAQ;GAQpD,AAPA,EAAY,aACV,EAAW,4BAA4B,EAAgB,EAAG,GAC1D,CACF,GACA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,wBAAwB,EAC/C,CAAC,GACG,GAAS,aACX,MAAM,EAAQ,UAAU,GAAiB,GAAW,CAAG;EAE3D;CACF,CAAC;AACH;AAiBA,SAAgB,EACd,GAQA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAIL;EACA,GAAG;EACH,aAAa,EAAE,eAAY,sBACzB,EAAc,gCAAgC,kDAC5C;GAAE;GAAY;EAAa,CAC7B;EACF,WAAW,OAAO,GAAiB,GAAW,MAAQ;GAQpD,AAPA,EAAY,aACV,EAAW,4BAA4B,EAAU,UAAU,GAC3D,CACF,GACA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,wBAAwB,EAC/C,CAAC,GACG,GAAS,aACX,MAAM,EAAQ,UAAU,GAAiB,GAAW,CAAG;EAE3D;CACF,CAAC;AACH"}
+{"version":3,"file":"useFormTemplate.js","names":[],"sources":["../../../src/synapse-queries/dataaccess/useFormTemplate.ts"],"sourcesContent":["/*\n * Hooks for authoring and retrieving FormTemplates, which define how a JSON Schema is rendered\n * to a requester as a multi-step form.\n */\nimport { useSynapseContext } from '@/utils'\nimport {\n  FormTemplate,\n  FormTemplateSearchRequest,\n  FormTemplateSearchResponse,\n} from '@sage-bionetworks/synapse-client'\nimport { SynapseClientError } from '@sage-bionetworks/synapse-client/util/SynapseClientError'\nimport {\n  InfiniteData,\n  QueryKey,\n  skipToken,\n  useInfiniteQuery,\n  UseInfiniteQueryOptions,\n  useMutation,\n  UseMutationOptions,\n  useQueries,\n  useQuery,\n  useQueryClient,\n  UseQueryOptions,\n} from '@tanstack/react-query'\nimport { useMemo } from 'react'\n\n/**\n * Retrieve the latest version of a FormTemplate by its ID. Disabled while templateId is undefined.\n * @see GET /repo/v1/accessRequirement/formTemplate/{templateId}\n */\nexport function useGetFormTemplate(\n  templateId: string | undefined,\n  options?: Partial<UseQueryOptions<FormTemplate, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getFormTemplateByIdQueryKey(templateId ?? ''),\n    queryFn: templateId\n      ? () =>\n          synapseClient.accessRequirementServicesClient.getRepoV1AccessRequirementFormTemplateTemplateId(\n            { templateId },\n          )\n      : skipToken,\n  })\n}\n\n/**\n * Retrieve a specific version of a FormTemplate. Disabled while templateId or versionNumber is\n * undefined.\n * @see GET /repo/v1/accessRequirement/formTemplate/{templateId}/version/{versionNumber}\n */\nexport function useGetFormTemplateVersion(\n  templateId: string | undefined,\n  versionNumber: number | undefined,\n  options?: Partial<UseQueryOptions<FormTemplate, SynapseClientError>>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getFormTemplateVersionQueryKey(\n      templateId ?? '',\n      versionNumber ?? 0,\n    ),\n    queryFn:\n      templateId != null && versionNumber != null\n        ? () =>\n            synapseClient.accessRequirementServicesClient.getRepoV1AccessRequirementFormTemplateTemplateIdVersionVersionNumber(\n              { templateId, versionNumber },\n            )\n        : skipToken,\n  })\n}\n\n/**\n * Retrieve every version of a FormTemplate. The API has no endpoint to list versions (PLFM-10045),\n * so this fetches the latest version and then each earlier version number in turn. `versions` is\n * ordered newest first and omits any version that has not loaded; `latestVersion` is always the\n * template's actual latest version. Disabled while templateId is undefined.\n */\nexport function useGetFormTemplateVersions(templateId: string | undefined) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n  const { data: latestVersion, error: latestVersionError } =\n    useGetFormTemplate(templateId)\n\n  const earlierVersionNumbers = useMemo(() => {\n    const earlierVersionCount = Math.max(\n      (latestVersion?.versionNumber ?? 0) - 1,\n      0,\n    )\n    return Array.from(\n      { length: earlierVersionCount },\n      (_, index) => earlierVersionCount - index,\n    )\n  }, [latestVersion?.versionNumber])\n\n  return useQueries({\n    queries: earlierVersionNumbers.map(versionNumber => ({\n      queryKey: keyFactory.getFormTemplateVersionQueryKey(\n        templateId ?? '',\n        versionNumber,\n      ),\n      queryFn: () =>\n        synapseClient.accessRequirementServicesClient.getRepoV1AccessRequirementFormTemplateTemplateIdVersionVersionNumber(\n          { templateId: templateId!, versionNumber },\n        ),\n    })),\n    combine: results => ({\n      latestVersion,\n      versions: [\n        ...(latestVersion ? [latestVersion] : []),\n        ...results.flatMap(result => (result.data ? [result.data] : [])),\n      ],\n      isLoading:\n        templateId != null &&\n        (latestVersion == null\n          ? latestVersionError == null\n          : results.some(result => result.isLoading)),\n      error: latestVersionError ?? results.find(result => result.error)?.error,\n    }),\n  })\n}\n\n/**\n * Search FormTemplates by name (all pages, via useInfiniteQuery). Only the latest version of each\n * matching template is returned.\n * @see POST /repo/v1/accessRequirement/formTemplate/search\n */\nexport function useSearchFormTemplatesInfinite<\n  TData = InfiniteData<FormTemplateSearchResponse>,\n>(\n  request: Omit<FormTemplateSearchRequest, 'nextPageToken'> = {},\n  options?: Partial<\n    UseInfiniteQueryOptions<\n      FormTemplateSearchResponse,\n      SynapseClientError,\n      TData,\n      QueryKey,\n      FormTemplateSearchResponse['nextPageToken']\n    >\n  >,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useInfiniteQuery<\n    FormTemplateSearchResponse,\n    SynapseClientError,\n    TData,\n    QueryKey,\n    FormTemplateSearchResponse['nextPageToken']\n  >({\n    ...options,\n    queryKey: keyFactory.searchFormTemplatesQueryKey(request),\n    queryFn: context =>\n      synapseClient.accessRequirementServicesClient.postRepoV1AccessRequirementFormTemplateSearch(\n        {\n          formTemplateSearchRequest: {\n            ...request,\n            nextPageToken: context.pageParam,\n          },\n        },\n      ),\n    initialPageParam: undefined,\n    getNextPageParam: page => page.nextPageToken,\n  })\n}\n\n/**\n * Create a new FormTemplate. Creating a template issues its first version.\n * @see POST /repo/v1/accessRequirement/formTemplate\n */\nexport function useCreateFormTemplate(\n  options?: Omit<\n    UseMutationOptions<FormTemplate, SynapseClientError, FormTemplate>,\n    'mutationFn'\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useMutation<FormTemplate, SynapseClientError, FormTemplate>({\n    ...options,\n    mutationFn: formTemplate =>\n      synapseClient.accessRequirementServicesClient.postRepoV1AccessRequirementFormTemplate(\n        { formTemplate },\n      ),\n    onSuccess: async (createdTemplate, variables, ctx, ...rest) => {\n      queryClient.setQueryData(\n        keyFactory.getFormTemplateByIdQueryKey(createdTemplate.id!),\n        createdTemplate,\n      )\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getFormTemplateQueryKey(),\n      })\n      if (options?.onSuccess) {\n        await options.onSuccess(createdTemplate, variables, ctx, ...rest)\n      }\n    },\n  })\n}\n\nexport type UpdateFormTemplateRequest = {\n  templateId: string\n  /**\n   * The new version's content. Must carry the `etag` of the version this update was based on so\n   * the server can reject the write if the template was concurrently modified.\n   */\n  formTemplate: FormTemplate\n}\n\n/**\n * Add a new version to an existing FormTemplate. The server uses the `etag` on `formTemplate` to\n * detect concurrent modification; if the template has since changed, the mutation's error will\n * reflect the conflict rather than silently overwriting the newer version.\n * @see POST /repo/v1/accessRequirement/formTemplate/{templateId}\n */\nexport function useUpdateFormTemplate(\n  options?: Omit<\n    UseMutationOptions<\n      FormTemplate,\n      SynapseClientError,\n      UpdateFormTemplateRequest\n    >,\n    'mutationFn'\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { keyFactory, synapseClient } = useSynapseContext()\n\n  return useMutation<\n    FormTemplate,\n    SynapseClientError,\n    UpdateFormTemplateRequest\n  >({\n    ...options,\n    mutationFn: ({ templateId, formTemplate }) =>\n      synapseClient.accessRequirementServicesClient.postRepoV1AccessRequirementFormTemplateTemplateId(\n        { templateId, formTemplate },\n      ),\n    onSuccess: async (updatedTemplate, variables, ctx, ...rest) => {\n      queryClient.setQueryData(\n        keyFactory.getFormTemplateByIdQueryKey(variables.templateId),\n        updatedTemplate,\n      )\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getFormTemplateQueryKey(),\n      })\n      if (options?.onSuccess) {\n        await options.onSuccess(updatedTemplate, variables, ctx, ...rest)\n      }\n    },\n  })\n}\n"],"mappings":";;;;;AA8BA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,4BAA4B,KAAc,EAAE;EACjE,SAAS,UAEH,EAAc,gCAAgC,iDAC5C,EAAE,cAAW,CACf,IACF;CACN,CAAC;AACH;AAOA,SAAgB,EACd,GACA,GACA,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,+BACnB,KAAc,IACd,KAAiB,CACnB;EACA,SACE,KAAc,QAAQ,KAAiB,aAEjC,EAAc,gCAAgC,qEAC5C;GAAE;GAAY;EAAc,CAC9B,IACF;CACR,CAAC;AACH;AAQA,SAAgB,EAA2B,GAAgC;CACzE,IAAM,EAAE,eAAY,qBAAkB,EAAkB,GAClD,EAAE,MAAM,GAAe,OAAO,MAClC,EAAmB,CAAU;CAa/B,OAAO,EAAW;EAChB,SAZ4B,QAAc;GAC1C,IAAM,IAAsB,KAAK,KAC9B,GAAe,iBAAiB,KAAK,GACtC,CACF;GACA,OAAO,MAAM,KACX,EAAE,QAAQ,EAAoB,IAC7B,GAAG,MAAU,IAAsB,CACtC;EACF,GAAG,CAAC,GAAe,aAAa,CAGrB,EAAsB,KAAI,OAAkB;GACnD,UAAU,EAAW,+BACnB,KAAc,IACd,CACF;GACA,eACE,EAAc,gCAAgC,qEAC5C;IAAc;IAAa;GAAc,CAC3C;EACJ,EAAE;EACF,UAAS,OAAY;GACnB;GACA,UAAU,CACR,GAAI,IAAgB,CAAC,CAAa,IAAI,CAAC,GACvC,GAAG,EAAQ,SAAQ,MAAW,EAAO,OAAO,CAAC,EAAO,IAAI,IAAI,CAAC,CAAE,CACjE;GACA,WACE,KAAc,SACb,KAAiB,OACd,KAAsB,OACtB,EAAQ,MAAK,MAAU,EAAO,SAAS;GAC7C,OAAO,KAAsB,EAAQ,MAAK,MAAU,EAAO,KAAK,GAAG;EACrE;CACF,CAAC;AACH;AAOA,SAAgB,EAGd,IAA4D,CAAC,GAC7D,GASA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAML;EACA,GAAG;EACH,UAAU,EAAW,4BAA4B,CAAO;EACxD,UAAS,MACP,EAAc,gCAAgC,8CAC5C,EACE,2BAA2B;GACzB,GAAG;GACH,eAAe,EAAQ;EACzB,EACF,CACF;EACF,kBAAkB,KAAA;EAClB,mBAAkB,MAAQ,EAAK;CACjC,CAAC;AACH;AAMA,SAAgB,EACd,GAIA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAA4D;EACjE,GAAG;EACH,aAAY,MACV,EAAc,gCAAgC,wCAC5C,EAAE,gBAAa,CACjB;EACF,WAAW,OAAO,GAAiB,GAAW,GAAK,GAAG,MAAS;GAQ7D,AAPA,EAAY,aACV,EAAW,4BAA4B,EAAgB,EAAG,GAC1D,CACF,GACA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,wBAAwB,EAC/C,CAAC,GACG,GAAS,aACX,MAAM,EAAQ,UAAU,GAAiB,GAAW,GAAK,GAAG,CAAI;EAEpE;CACF,CAAC;AACH;AAiBA,SAAgB,EACd,GAQA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,eAAY,qBAAkB,EAAkB;CAExD,OAAO,EAIL;EACA,GAAG;EACH,aAAa,EAAE,eAAY,sBACzB,EAAc,gCAAgC,kDAC5C;GAAE;GAAY;EAAa,CAC7B;EACF,WAAW,OAAO,GAAiB,GAAW,GAAK,GAAG,MAAS;GAQ7D,AAPA,EAAY,aACV,EAAW,4BAA4B,EAAU,UAAU,GAC3D,CACF,GACA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,wBAAwB,EAC/C,CAAC,GACG,GAAS,aACX,MAAM,EAAQ,UAAU,GAAiB,GAAW,GAAK,GAAG,CAAI;EAEpE;CACF,CAAC;AACH"}

package/dist/synapse-queries/download/index.js

@@ -1,2 +1,2 @@
-import { useAddFileBatchToDownloadList as e, useAddFileToDownloadList as t, useAddToDownloadList as n, useGetAddToDownloadListStats as r, useGetAllDownloadListActionsRequired as i, useGetAvailableFilesToDownload as a, useGetAvailableFilesToDownloadInfinite as o, useGetDownloadListActionsRequiredInfinite as s, useGetDownloadListStatistics as c, useRemoveFilesFromDownloadList as l } from "./useDownloadList.js";
-export { e as useAddFileBatchToDownloadList, t as useAddFileToDownloadList, n as useAddToDownloadList, r as useGetAddToDownloadListStats, i as useGetAllDownloadListActionsRequired, a as useGetAvailableFilesToDownload, o as useGetAvailableFilesToDownloadInfinite, s as useGetDownloadListActionsRequiredInfinite, c as useGetDownloadListStatistics, l as useRemoveFilesFromDownloadList };
+import { MAX_DOWNLOAD_LIST_BATCH_SIZE as e, useAddFileBatchToDownloadList as t, useAddFileToDownloadList as n, useAddToDownloadList as r, useGetAddToDownloadListStats as i, useGetAllDownloadListActionsRequired as a, useGetAvailableFilesToDownload as o, useGetAvailableFilesToDownloadInfinite as s, useGetDownloadListActionsRequiredInfinite as c, useGetDownloadListStatistics as l, useRemoveFilesFromDownloadList as u } from "./useDownloadList.js";
+export { e as MAX_DOWNLOAD_LIST_BATCH_SIZE, t as useAddFileBatchToDownloadList, n as useAddFileToDownloadList, r as useAddToDownloadList, i as useGetAddToDownloadListStats, a as useGetAllDownloadListActionsRequired, o as useGetAvailableFilesToDownload, s as useGetAvailableFilesToDownloadInfinite, c as useGetDownloadListActionsRequiredInfinite, l as useGetDownloadListStatistics, u as useRemoveFilesFromDownloadList };

package/dist/synapse-queries/download/useDownloadList.d.ts

@@ -14,6 +14,11 @@ export declare function useAddFileToDownloadList(options?: Partial<UseMutationOp
     entityId: string;
     entityVersionNumber: number | undefined;
 }, unknown>;
+/**
+ * The most items that one request to add a batch to the Download List may carry. Each request is added all or nothing,
+ * so a larger set is not split across requests.
+ */
+export declare const MAX_DOWNLOAD_LIST_BATCH_SIZE = 1000;
 export declare function useAddFileBatchToDownloadList(options?: Partial<UseMutationOptions<AddBatchOfFilesToDownloadListResponse, SynapseClientError, {
     fileEntityId: string;
     versionNumber?: number;

package/dist/synapse-queries/download/useDownloadList.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useDownloadList.d.ts","sourceRoot":"","sources":["../../../src/synapse-queries/download/useDownloadList.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,6BAA6B,EAC7B,8BAA8B,EAE/B,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,0DAA0D,CAAA;AAC7F,OAAO,EACL,mBAAmB,EAEnB,sBAAsB,EACtB,qCAAqC,EACrC,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EACf,uBAAuB,EACvB,yCAAyC,EACzC,0CAA0C,EAC1C,IAAI,EACL,MAAM,iCAAiC,CAAA;AACxC,OAAO,EACL,YAAY,EACZ,QAAQ,EAER,uBAAuB,EAEvB,kBAAkB,EAGlB,eAAe,EAChB,MAAM,uBAAuB,CAAA;AAE9B,wBAAgB,8BAA8B,CAC5C,OAAO,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,eAAe,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,8FAStE;AAED,wBAAgB,sCAAsC,CACpD,KAAK,GAAG,YAAY,CAAC,sBAAsB,CAAC,EAE5C,IAAI,CAAC,EAAE,IAAI,EACX,MAAM,CAAC,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE,OAAO,CACf,uBAAuB,CACrB,sBAAsB,EACtB,kBAAkB,EAClB,KAAK,EACL,QAAQ,EACR,sBAAsB,CAAC,eAAe,CAAC,CACxC,CACF,qFA+BF;AAED,wBAAgB,oCAAoC,CAClD,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,mBAAmB,EAAE,EAAE,kBAAkB,CAAC,CAAC,6FAc9E;AAED,wBAAgB,yCAAyC,CACvD,KAAK,GAAG,YAAY,CAAC,sBAAsB,CAAC,EAE5C,OAAO,CAAC,EAAE,OAAO,CACf,uBAAuB,CACrB,sBAAsB,EACtB,kBAAkB,EAClB,KAAK,EACL,QAAQ,EACR,sBAAsB,CAAC,eAAe,CAAC,CACxC,CACF,qFAyBF;AAED,wBAAgB,4BAA4B,CAC1C,OAAO,CAAC,EAAE,OAAO,CACf,eAAe,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAC7D,+FAQF;AAED,wBAAgB,wBAAwB,CACtC,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAChB,qCAAqC,EACrC,kBAAkB,EAClB;IACE,QAAQ,EAAE,MAAM,CAAA;IAChB,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;CACxC,CACF,CACF;cAOa,MAAM;yBACK,MAAM,GAAG,SAAS;YAmB5C;AAED,wBAAgB,6BAA6B,CAC3C,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAChB,qCAAqC,EACrC,kBAAkB,EAClB;IACE,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,EAAE,CACJ,CACF;kBAJmB,MAAM;oBACJ,MAAM;cAuB7B;AAED,wBAAgB,oBAAoB,CAClC,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAChB,yBAAyB,EACzB,kBAAkB,EAClB,wBAAwB,CACzB,CACF,uIAoCF;AAED,wBAAgB,8BAA8B,CAC5C,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAChB,0CAA0C,EAC1C,kBAAkB,EAClB,yCAAyC,CAC1C,CACF,yKAmBF;AAED,wBAAgB,4BAA4B,CAC1C,6BAA6B,EAAE,6BAA6B,EAC5D,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,yFAuBhC"}
+{"version":3,"file":"useDownloadList.d.ts","sourceRoot":"","sources":["../../../src/synapse-queries/download/useDownloadList.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,6BAA6B,EAC7B,8BAA8B,EAE/B,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,0DAA0D,CAAA;AAC7F,OAAO,EACL,mBAAmB,EAEnB,sBAAsB,EACtB,qCAAqC,EACrC,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EACf,uBAAuB,EACvB,yCAAyC,EACzC,0CAA0C,EAC1C,IAAI,EACL,MAAM,iCAAiC,CAAA;AACxC,OAAO,EACL,YAAY,EACZ,QAAQ,EAER,uBAAuB,EAEvB,kBAAkB,EAGlB,eAAe,EAChB,MAAM,uBAAuB,CAAA;AAE9B,wBAAgB,8BAA8B,CAC5C,OAAO,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,eAAe,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,8FAStE;AAED,wBAAgB,sCAAsC,CACpD,KAAK,GAAG,YAAY,CAAC,sBAAsB,CAAC,EAE5C,IAAI,CAAC,EAAE,IAAI,EACX,MAAM,CAAC,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE,OAAO,CACf,uBAAuB,CACrB,sBAAsB,EACtB,kBAAkB,EAClB,KAAK,EACL,QAAQ,EACR,sBAAsB,CAAC,eAAe,CAAC,CACxC,CACF,qFA+BF;AAED,wBAAgB,oCAAoC,CAClD,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,mBAAmB,EAAE,EAAE,kBAAkB,CAAC,CAAC,6FAc9E;AAED,wBAAgB,yCAAyC,CACvD,KAAK,GAAG,YAAY,CAAC,sBAAsB,CAAC,EAE5C,OAAO,CAAC,EAAE,OAAO,CACf,uBAAuB,CACrB,sBAAsB,EACtB,kBAAkB,EAClB,KAAK,EACL,QAAQ,EACR,sBAAsB,CAAC,eAAe,CAAC,CACxC,CACF,qFAyBF;AAED,wBAAgB,4BAA4B,CAC1C,OAAO,CAAC,EAAE,OAAO,CACf,eAAe,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAC7D,+FAQF;AAED,wBAAgB,wBAAwB,CACtC,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAChB,qCAAqC,EACrC,kBAAkB,EAClB;IACE,QAAQ,EAAE,MAAM,CAAA;IAChB,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;CACxC,CACF,CACF;cAOa,MAAM;yBACK,MAAM,GAAG,SAAS;YAmB5C;AAED;;;GAGG;AACH,eAAO,MAAM,4BAA4B,OAAO,CAAA;AAEhD,wBAAgB,6BAA6B,CAC3C,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAChB,qCAAqC,EACrC,kBAAkB,EAClB;IACE,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,EAAE,CACJ,CACF;kBAJmB,MAAM;oBACJ,MAAM;cAuB7B;AAED,wBAAgB,oBAAoB,CAClC,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAChB,yBAAyB,EACzB,kBAAkB,EAClB,wBAAwB,CACzB,CACF,uIAoCF;AAED,wBAAgB,8BAA8B,CAC5C,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAChB,0CAA0C,EAC1C,kBAAkB,EAClB,yCAAyC,CAC1C,CACF,yKAmBF;AAED,wBAAgB,4BAA4B,CAC1C,6BAA6B,EAAE,6BAA6B,EAC5D,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,yFAuBhC"}

package/dist/synapse-queries/download/useDownloadList.js

@@ -59,23 +59,24 @@ function f(n) {
 		...n,
 		mutationFn: (t) => e.addFileToDownloadListV2(t.entityId, t.entityVersionNumber, r),
 		mutationKey: ["addFileToDownloadList"],
-		onSuccess: async (e, t, r) => {
-			if (await s.invalidateQueries({ queryKey: a.getDownloadListBaseQueryKey() }), n?.onSuccess) return n.onSuccess(e, t, r);
+		onSuccess: async (e, t, r, ...i) => {
+			if (await s.invalidateQueries({ queryKey: a.getDownloadListBaseQueryKey() }), n?.onSuccess) return n.onSuccess(e, t, r, ...i);
 		}
 	});
 }
-function p(n) {
+var p = 1e3;
+function m(n) {
 	let { accessToken: r, keyFactory: a } = t(), s = o();
 	return i({
 		...n,
 		mutationFn: (t) => e.addFileBatchToDownloadListV2(t, r),
 		mutationKey: ["addFileBatchToDownloadList"],
-		onSuccess: async (e, t, r) => {
-			if (await s.invalidateQueries({ queryKey: a.getDownloadListBaseQueryKey() }), n?.onSuccess) return n.onSuccess(e, t, r);
+		onSuccess: async (e, t, r, ...i) => {
+			if (await s.invalidateQueries({ queryKey: a.getDownloadListBaseQueryKey() }), n?.onSuccess) return n.onSuccess(e, t, r, ...i);
 		}
 	});
 }
-function m(e) {
+function h(e) {
 	let { synapseClient: r, keyFactory: a } = t(), s = o();
 	return i({
 		...e,
@@ -84,22 +85,22 @@ function m(e) {
 			return (await n(() => r.asynchronousJobServicesClient.getRepoV1AsynchronousJobJobId({ jobId: t }))).responseBody;
 		},
 		mutationKey: ["addQueryToDownloadList"],
-		onSuccess: async (t, n, r) => {
-			if (await s.invalidateQueries({ queryKey: a.getDownloadListBaseQueryKey() }), e?.onSuccess) return e.onSuccess(t, n, r);
+		onSuccess: async (t, n, r, ...i) => {
+			if (await s.invalidateQueries({ queryKey: a.getDownloadListBaseQueryKey() }), e?.onSuccess) return e.onSuccess(t, n, r, ...i);
 		}
 	});
 }
-function h(n) {
+function g(n) {
 	let { accessToken: r, keyFactory: a } = t(), s = o();
 	return i({
 		...n,
 		mutationFn: (t) => e.removeItemsFromDownloadListV2(t, r),
-		onSuccess: async (e, t, r) => {
-			if (await s.invalidateQueries({ queryKey: a.getDownloadListBaseQueryKey() }), n?.onSuccess) return n.onSuccess(e, t, r);
+		onSuccess: async (e, t, r, ...i) => {
+			if (await s.invalidateQueries({ queryKey: a.getDownloadListBaseQueryKey() }), n?.onSuccess) return n.onSuccess(e, t, r, ...i);
 		}
 	});
 }
-function g(e, r) {
+function _(e, r) {
 	let { synapseClient: i, keyFactory: o } = t();
 	return a({
 		queryKey: o.getAddToDownloadListStatsQueryKey(e),
@@ -111,6 +112,6 @@ function g(e, r) {
 	});
 }
 //#endregion
-export { p as useAddFileBatchToDownloadList, f as useAddFileToDownloadList, m as useAddToDownloadList, g as useGetAddToDownloadListStats, l as useGetAllDownloadListActionsRequired, s as useGetAvailableFilesToDownload, c as useGetAvailableFilesToDownloadInfinite, u as useGetDownloadListActionsRequiredInfinite, d as useGetDownloadListStatistics, h as useRemoveFilesFromDownloadList };
+export { p as MAX_DOWNLOAD_LIST_BATCH_SIZE, m as useAddFileBatchToDownloadList, f as useAddFileToDownloadList, h as useAddToDownloadList, _ as useGetAddToDownloadListStats, l as useGetAllDownloadListActionsRequired, s as useGetAvailableFilesToDownload, c as useGetAvailableFilesToDownloadInfinite, u as useGetDownloadListActionsRequiredInfinite, d as useGetDownloadListStatistics, g as useRemoveFilesFromDownloadList };
 
 //# sourceMappingURL=useDownloadList.js.map

package/dist/synapse-queries/download/useDownloadList.js.map

@@ -1 +1 @@
-{"version":3,"file":"useDownloadList.js","names":[],"sources":["../../../src/synapse-queries/download/useDownloadList.ts"],"sourcesContent":["import SynapseClient from '@/synapse-client'\nimport { useSynapseContext } from '@/utils/context/SynapseContext'\nimport {\n  AddToDownloadListRequest,\n  AddToDownloadListResponse,\n  AddToDownloadListStatsRequest,\n  AddToDownloadListStatsResponse,\n  waitForAsyncResult,\n} from '@sage-bionetworks/synapse-client'\nimport { SynapseClientError } from '@sage-bionetworks/synapse-client/util/SynapseClientError'\nimport {\n  ActionRequiredCount,\n  ActionRequiredRequest,\n  ActionRequiredResponse,\n  AddBatchOfFilesToDownloadListResponse,\n  AvailableFilesRequest,\n  AvailableFilesResponse,\n  AvailableFilter,\n  FilesStatisticsResponse,\n  RemoveBatchOfFilesFromDownloadListRequest,\n  RemoveBatchOfFilesFromDownloadListResponse,\n  Sort,\n} from '@sage-bionetworks/synapse-types'\nimport {\n  InfiniteData,\n  QueryKey,\n  useInfiniteQuery,\n  UseInfiniteQueryOptions,\n  useMutation,\n  UseMutationOptions,\n  useQuery,\n  useQueryClient,\n  UseQueryOptions,\n} from '@tanstack/react-query'\n\nexport function useGetAvailableFilesToDownload(\n  request: AvailableFilesRequest,\n  options?: UseQueryOptions<AvailableFilesResponse, SynapseClientError>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDownloadListAvailableFilesQueryKey(request),\n    queryFn: () =>\n      SynapseClient.getAvailableFilesToDownload(request, accessToken),\n  })\n}\n\nexport function useGetAvailableFilesToDownloadInfinite<\n  TData = InfiniteData<AvailableFilesResponse>,\n>(\n  sort?: Sort,\n  filter?: AvailableFilter,\n  options?: Partial<\n    UseInfiniteQueryOptions<\n      AvailableFilesResponse,\n      SynapseClientError,\n      TData,\n      QueryKey,\n      AvailableFilesResponse['nextPageToken']\n    >\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const request: AvailableFilesRequest = {\n    concreteType:\n      'org.sagebionetworks.repo.model.download.AvailableFilesRequest',\n  }\n  if (sort) {\n    request.sort = [sort]\n  }\n  if (filter) {\n    request.filter = filter\n  }\n  return useInfiniteQuery<\n    AvailableFilesResponse,\n    SynapseClientError,\n    TData,\n    QueryKey,\n    AvailableFilesResponse['nextPageToken']\n  >({\n    ...options,\n    queryKey: keyFactory.getDownloadListAvailableFilesInfiniteQueryKey(request),\n    queryFn: async context => {\n      return SynapseClient.getAvailableFilesToDownload(\n        { ...request, nextPageToken: context.pageParam },\n        accessToken,\n      )\n    },\n    initialPageParam: undefined,\n    getNextPageParam: page => page.nextPageToken,\n  })\n}\n\nexport function useGetAllDownloadListActionsRequired(\n  options?: Partial<UseQueryOptions<ActionRequiredCount[], SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const request: ActionRequiredRequest = {\n    concreteType:\n      'org.sagebionetworks.repo.model.download.ActionRequiredRequest',\n  }\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDownloadListActionsRequiredQueryKey(),\n    queryFn: () =>\n      SynapseClient.getAllDownloadListActionsRequired(request, accessToken),\n  })\n}\n\nexport function useGetDownloadListActionsRequiredInfinite<\n  TData = InfiniteData<ActionRequiredResponse>,\n>(\n  options?: Partial<\n    UseInfiniteQueryOptions<\n      ActionRequiredResponse,\n      SynapseClientError,\n      TData,\n      QueryKey,\n      ActionRequiredResponse['nextPageToken']\n    >\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const request: ActionRequiredRequest = {\n    concreteType:\n      'org.sagebionetworks.repo.model.download.ActionRequiredRequest',\n  }\n  return useInfiniteQuery<\n    ActionRequiredResponse,\n    SynapseClientError,\n    TData,\n    QueryKey,\n    ActionRequiredResponse['nextPageToken']\n  >({\n    ...options,\n    queryKey: keyFactory.getDownloadListActionsRequiredInfiniteQueryKey(),\n    queryFn: async context => {\n      return await SynapseClient.getDownloadListActionsRequired(\n        { ...request, nextPageToken: context.pageParam },\n        accessToken,\n      )\n    },\n    initialPageParam: undefined,\n    getNextPageParam: page => page.nextPageToken,\n  })\n}\n\nexport function useGetDownloadListStatistics(\n  options?: Partial<\n    UseQueryOptions<FilesStatisticsResponse, SynapseClientError>\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDownloadListStatisticsQueryKey(),\n    queryFn: () => SynapseClient.getDownloadListStatistics(accessToken),\n  })\n}\n\nexport function useAddFileToDownloadList(\n  options?: Partial<\n    UseMutationOptions<\n      AddBatchOfFilesToDownloadListResponse,\n      SynapseClientError,\n      {\n        entityId: string\n        entityVersionNumber: number | undefined\n      }\n    >\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const queryClient = useQueryClient()\n  return useMutation({\n    ...options,\n    mutationFn: (vars: {\n      entityId: string\n      entityVersionNumber: number | undefined\n    }) =>\n      SynapseClient.addFileToDownloadListV2(\n        vars.entityId,\n        vars.entityVersionNumber,\n        accessToken,\n      ),\n    mutationKey: ['addFileToDownloadList'],\n    onSuccess: async (data, variables, ctx) => {\n      // PORTALS-2222: Invalidate to load the accurate results\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getDownloadListBaseQueryKey(),\n      })\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx)\n      }\n      return\n    },\n  })\n}\n\nexport function useAddFileBatchToDownloadList(\n  options?: Partial<\n    UseMutationOptions<\n      AddBatchOfFilesToDownloadListResponse,\n      SynapseClientError,\n      {\n        fileEntityId: string\n        versionNumber?: number\n      }[]\n    >\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const queryClient = useQueryClient()\n  return useMutation({\n    ...options,\n    mutationFn: batchToAdd =>\n      SynapseClient.addFileBatchToDownloadListV2(batchToAdd, accessToken),\n    mutationKey: ['addFileBatchToDownloadList'],\n    onSuccess: async (data, variables, ctx) => {\n      // PORTALS-2222: Invalidate to load the accurate results\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getDownloadListBaseQueryKey(),\n      })\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx)\n      }\n      return\n    },\n  })\n}\n\nexport function useAddToDownloadList(\n  options?: Partial<\n    UseMutationOptions<\n      AddToDownloadListResponse,\n      SynapseClientError,\n      AddToDownloadListRequest\n    >\n  >,\n) {\n  const { synapseClient, keyFactory } = useSynapseContext()\n  const queryClient = useQueryClient()\n  return useMutation({\n    ...options,\n    mutationFn: async addToDownloadListRequest => {\n      const jobId = (\n        await synapseClient.downloadListServicesClient.postRepoV1DownloadListAddAsyncStart(\n          {\n            addToDownloadListRequest,\n          },\n        )\n      ).token!\n\n      const asyncJobResponse = await waitForAsyncResult(() =>\n        synapseClient.asynchronousJobServicesClient.getRepoV1AsynchronousJobJobId(\n          {\n            jobId,\n          },\n        ),\n      )\n      return asyncJobResponse.responseBody as AddToDownloadListResponse\n    },\n    mutationKey: ['addQueryToDownloadList'],\n    onSuccess: async (data, variables, ctx) => {\n      // Invalidate all download list queries\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getDownloadListBaseQueryKey(),\n      })\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx)\n      }\n      return\n    },\n  })\n}\n\nexport function useRemoveFilesFromDownloadList(\n  options?: Partial<\n    UseMutationOptions<\n      RemoveBatchOfFilesFromDownloadListResponse,\n      SynapseClientError,\n      RemoveBatchOfFilesFromDownloadListRequest\n    >\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const queryClient = useQueryClient()\n  return useMutation({\n    ...options,\n    mutationFn: request =>\n      SynapseClient.removeItemsFromDownloadListV2(request, accessToken),\n    onSuccess: async (data, variables, ctx) => {\n      // PORTALS-2222: Invalidate to load the accurate results\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getDownloadListBaseQueryKey(),\n      })\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx)\n      }\n      return\n    },\n  })\n}\n\nexport function useGetAddToDownloadListStats(\n  addToDownloadListStatsRequest: AddToDownloadListStatsRequest,\n  options?: { enabled?: boolean },\n) {\n  const { synapseClient, keyFactory } = useSynapseContext()\n  return useQuery({\n    queryKey: keyFactory.getAddToDownloadListStatsQueryKey(\n      addToDownloadListStatsRequest,\n    ),\n    queryFn: async () => {\n      const jobId = (\n        await synapseClient.downloadListServicesClient.postRepoV1DownloadListAddStatsAsyncStart(\n          { addToDownloadListStatsRequest },\n        )\n      ).token!\n\n      const asyncJobResponse = await waitForAsyncResult(() =>\n        synapseClient.asynchronousJobServicesClient.getRepoV1AsynchronousJobJobId(\n          { jobId },\n        ),\n      )\n      return asyncJobResponse.responseBody as AddToDownloadListStatsResponse\n    },\n    enabled: options?.enabled,\n  })\n}\n"],"mappings":";;;;;AAmCA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,sCAAsC,CAAO;EAClE,eACE,EAAc,4BAA4B,GAAS,CAAW;CAClE,CAAC;AACH;AAEA,SAAgB,EAGd,GACA,GACA,GASA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAiC,EACrC,cACE,gEACJ;CAOA,OANI,MACF,EAAQ,OAAO,CAAC,CAAI,IAElB,MACF,EAAQ,SAAS,IAEZ,EAML;EACA,GAAG;EACH,UAAU,EAAW,8CAA8C,CAAO;EAC1E,SAAS,OAAM,MACN,EAAc,4BACnB;GAAE,GAAG;GAAS,eAAe,EAAQ;EAAU,GAC/C,CACF;EAEF,kBAAkB,KAAA;EAClB,mBAAkB,MAAQ,EAAK;CACjC,CAAC;AACH;AAEA,SAAgB,EACd,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAiC,EACrC,cACE,gEACJ;CAEA,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,uCAAuC;EAC5D,eACE,EAAc,kCAAkC,GAAS,CAAW;CACxE,CAAC;AACH;AAEA,SAAgB,EAGd,GASA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAiC,EACrC,cACE,gEACJ;CACA,OAAO,EAML;EACA,GAAG;EACH,UAAU,EAAW,+CAA+C;EACpE,SAAS,OAAM,MACN,MAAM,EAAc,+BACzB;GAAE,GAAG;GAAS,eAAe,EAAQ;EAAU,GAC/C,CACF;EAEF,kBAAkB,KAAA;EAClB,mBAAkB,MAAQ,EAAK;CACjC,CAAC;AACH;AAEA,SAAgB,EACd,GAGA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,kCAAkC;EACvD,eAAe,EAAc,0BAA0B,CAAW;CACpE,CAAC;AACH;AAEA,SAAgB,EACd,GAUA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAc,EAAe;CACnC,OAAO,EAAY;EACjB,GAAG;EACH,aAAa,MAIX,EAAc,wBACZ,EAAK,UACL,EAAK,qBACL,CACF;EACF,aAAa,CAAC,uBAAuB;EACrC,WAAW,OAAO,GAAM,GAAW,MAAQ;GAKzC,IAHA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,4BAA4B,EACnD,CAAC,GACG,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,CAAG;EAGjD;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GAUA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAc,EAAe;CACnC,OAAO,EAAY;EACjB,GAAG;EACH,aAAY,MACV,EAAc,6BAA6B,GAAY,CAAW;EACpE,aAAa,CAAC,4BAA4B;EAC1C,WAAW,OAAO,GAAM,GAAW,MAAQ;GAKzC,IAHA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,4BAA4B,EACnD,CAAC,GACG,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,CAAG;EAGjD;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GAOA;CACA,IAAM,EAAE,kBAAe,kBAAe,EAAkB,GAClD,IAAc,EAAe;CACnC,OAAO,EAAY;EACjB,GAAG;EACH,YAAY,OAAM,MAA4B;GAC5C,IAAM,KACJ,MAAM,EAAc,2BAA2B,oCAC7C,EACE,4BACF,CACF,GACA;GASF,QAAO,MAPwB,QAC7B,EAAc,8BAA8B,8BAC1C,EACE,SACF,CACF,CACF,GACwB;EAC1B;EACA,aAAa,CAAC,wBAAwB;EACtC,WAAW,OAAO,GAAM,GAAW,MAAQ;GAKzC,IAHA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,4BAA4B,EACnD,CAAC,GACG,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,CAAG;EAGjD;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GAOA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAc,EAAe;CACnC,OAAO,EAAY;EACjB,GAAG;EACH,aAAY,MACV,EAAc,8BAA8B,GAAS,CAAW;EAClE,WAAW,OAAO,GAAM,GAAW,MAAQ;GAKzC,IAHA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,4BAA4B,EACnD,CAAC,GACG,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,CAAG;EAGjD;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,kBAAe,kBAAe,EAAkB;CACxD,OAAO,EAAS;EACd,UAAU,EAAW,kCACnB,CACF;EACA,SAAS,YAAY;GACnB,IAAM,KACJ,MAAM,EAAc,2BAA2B,yCAC7C,EAAE,iCAA8B,CAClC,GACA;GAOF,QAAO,MALwB,QAC7B,EAAc,8BAA8B,8BAC1C,EAAE,SAAM,CACV,CACF,GACwB;EAC1B;EACA,SAAS,GAAS;CACpB,CAAC;AACH"}
+{"version":3,"file":"useDownloadList.js","names":[],"sources":["../../../src/synapse-queries/download/useDownloadList.ts"],"sourcesContent":["import SynapseClient from '@/synapse-client'\nimport { useSynapseContext } from '@/utils/context/SynapseContext'\nimport {\n  AddToDownloadListRequest,\n  AddToDownloadListResponse,\n  AddToDownloadListStatsRequest,\n  AddToDownloadListStatsResponse,\n  waitForAsyncResult,\n} from '@sage-bionetworks/synapse-client'\nimport { SynapseClientError } from '@sage-bionetworks/synapse-client/util/SynapseClientError'\nimport {\n  ActionRequiredCount,\n  ActionRequiredRequest,\n  ActionRequiredResponse,\n  AddBatchOfFilesToDownloadListResponse,\n  AvailableFilesRequest,\n  AvailableFilesResponse,\n  AvailableFilter,\n  FilesStatisticsResponse,\n  RemoveBatchOfFilesFromDownloadListRequest,\n  RemoveBatchOfFilesFromDownloadListResponse,\n  Sort,\n} from '@sage-bionetworks/synapse-types'\nimport {\n  InfiniteData,\n  QueryKey,\n  useInfiniteQuery,\n  UseInfiniteQueryOptions,\n  useMutation,\n  UseMutationOptions,\n  useQuery,\n  useQueryClient,\n  UseQueryOptions,\n} from '@tanstack/react-query'\n\nexport function useGetAvailableFilesToDownload(\n  request: AvailableFilesRequest,\n  options?: UseQueryOptions<AvailableFilesResponse, SynapseClientError>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDownloadListAvailableFilesQueryKey(request),\n    queryFn: () =>\n      SynapseClient.getAvailableFilesToDownload(request, accessToken),\n  })\n}\n\nexport function useGetAvailableFilesToDownloadInfinite<\n  TData = InfiniteData<AvailableFilesResponse>,\n>(\n  sort?: Sort,\n  filter?: AvailableFilter,\n  options?: Partial<\n    UseInfiniteQueryOptions<\n      AvailableFilesResponse,\n      SynapseClientError,\n      TData,\n      QueryKey,\n      AvailableFilesResponse['nextPageToken']\n    >\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const request: AvailableFilesRequest = {\n    concreteType:\n      'org.sagebionetworks.repo.model.download.AvailableFilesRequest',\n  }\n  if (sort) {\n    request.sort = [sort]\n  }\n  if (filter) {\n    request.filter = filter\n  }\n  return useInfiniteQuery<\n    AvailableFilesResponse,\n    SynapseClientError,\n    TData,\n    QueryKey,\n    AvailableFilesResponse['nextPageToken']\n  >({\n    ...options,\n    queryKey: keyFactory.getDownloadListAvailableFilesInfiniteQueryKey(request),\n    queryFn: async context => {\n      return SynapseClient.getAvailableFilesToDownload(\n        { ...request, nextPageToken: context.pageParam },\n        accessToken,\n      )\n    },\n    initialPageParam: undefined,\n    getNextPageParam: page => page.nextPageToken,\n  })\n}\n\nexport function useGetAllDownloadListActionsRequired(\n  options?: Partial<UseQueryOptions<ActionRequiredCount[], SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const request: ActionRequiredRequest = {\n    concreteType:\n      'org.sagebionetworks.repo.model.download.ActionRequiredRequest',\n  }\n\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDownloadListActionsRequiredQueryKey(),\n    queryFn: () =>\n      SynapseClient.getAllDownloadListActionsRequired(request, accessToken),\n  })\n}\n\nexport function useGetDownloadListActionsRequiredInfinite<\n  TData = InfiniteData<ActionRequiredResponse>,\n>(\n  options?: Partial<\n    UseInfiniteQueryOptions<\n      ActionRequiredResponse,\n      SynapseClientError,\n      TData,\n      QueryKey,\n      ActionRequiredResponse['nextPageToken']\n    >\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const request: ActionRequiredRequest = {\n    concreteType:\n      'org.sagebionetworks.repo.model.download.ActionRequiredRequest',\n  }\n  return useInfiniteQuery<\n    ActionRequiredResponse,\n    SynapseClientError,\n    TData,\n    QueryKey,\n    ActionRequiredResponse['nextPageToken']\n  >({\n    ...options,\n    queryKey: keyFactory.getDownloadListActionsRequiredInfiniteQueryKey(),\n    queryFn: async context => {\n      return await SynapseClient.getDownloadListActionsRequired(\n        { ...request, nextPageToken: context.pageParam },\n        accessToken,\n      )\n    },\n    initialPageParam: undefined,\n    getNextPageParam: page => page.nextPageToken,\n  })\n}\n\nexport function useGetDownloadListStatistics(\n  options?: Partial<\n    UseQueryOptions<FilesStatisticsResponse, SynapseClientError>\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getDownloadListStatisticsQueryKey(),\n    queryFn: () => SynapseClient.getDownloadListStatistics(accessToken),\n  })\n}\n\nexport function useAddFileToDownloadList(\n  options?: Partial<\n    UseMutationOptions<\n      AddBatchOfFilesToDownloadListResponse,\n      SynapseClientError,\n      {\n        entityId: string\n        entityVersionNumber: number | undefined\n      }\n    >\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const queryClient = useQueryClient()\n  return useMutation({\n    ...options,\n    mutationFn: (vars: {\n      entityId: string\n      entityVersionNumber: number | undefined\n    }) =>\n      SynapseClient.addFileToDownloadListV2(\n        vars.entityId,\n        vars.entityVersionNumber,\n        accessToken,\n      ),\n    mutationKey: ['addFileToDownloadList'],\n    onSuccess: async (data, variables, ctx, ...rest) => {\n      // PORTALS-2222: Invalidate to load the accurate results\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getDownloadListBaseQueryKey(),\n      })\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx, ...rest)\n      }\n      return\n    },\n  })\n}\n\n/**\n * The most items that one request to add a batch to the Download List may carry. Each request is added all or nothing,\n * so a larger set is not split across requests.\n */\nexport const MAX_DOWNLOAD_LIST_BATCH_SIZE = 1000\n\nexport function useAddFileBatchToDownloadList(\n  options?: Partial<\n    UseMutationOptions<\n      AddBatchOfFilesToDownloadListResponse,\n      SynapseClientError,\n      {\n        fileEntityId: string\n        versionNumber?: number\n      }[]\n    >\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const queryClient = useQueryClient()\n  return useMutation({\n    ...options,\n    mutationFn: batchToAdd =>\n      SynapseClient.addFileBatchToDownloadListV2(batchToAdd, accessToken),\n    mutationKey: ['addFileBatchToDownloadList'],\n    onSuccess: async (data, variables, ctx, ...rest) => {\n      // PORTALS-2222: Invalidate to load the accurate results\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getDownloadListBaseQueryKey(),\n      })\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx, ...rest)\n      }\n      return\n    },\n  })\n}\n\nexport function useAddToDownloadList(\n  options?: Partial<\n    UseMutationOptions<\n      AddToDownloadListResponse,\n      SynapseClientError,\n      AddToDownloadListRequest\n    >\n  >,\n) {\n  const { synapseClient, keyFactory } = useSynapseContext()\n  const queryClient = useQueryClient()\n  return useMutation({\n    ...options,\n    mutationFn: async addToDownloadListRequest => {\n      const jobId = (\n        await synapseClient.downloadListServicesClient.postRepoV1DownloadListAddAsyncStart(\n          {\n            addToDownloadListRequest,\n          },\n        )\n      ).token!\n\n      const asyncJobResponse = await waitForAsyncResult(() =>\n        synapseClient.asynchronousJobServicesClient.getRepoV1AsynchronousJobJobId(\n          {\n            jobId,\n          },\n        ),\n      )\n      return asyncJobResponse.responseBody as AddToDownloadListResponse\n    },\n    mutationKey: ['addQueryToDownloadList'],\n    onSuccess: async (data, variables, ctx, ...rest) => {\n      // Invalidate all download list queries\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getDownloadListBaseQueryKey(),\n      })\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx, ...rest)\n      }\n      return\n    },\n  })\n}\n\nexport function useRemoveFilesFromDownloadList(\n  options?: Partial<\n    UseMutationOptions<\n      RemoveBatchOfFilesFromDownloadListResponse,\n      SynapseClientError,\n      RemoveBatchOfFilesFromDownloadListRequest\n    >\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const queryClient = useQueryClient()\n  return useMutation({\n    ...options,\n    mutationFn: request =>\n      SynapseClient.removeItemsFromDownloadListV2(request, accessToken),\n    onSuccess: async (data, variables, ctx, ...rest) => {\n      // PORTALS-2222: Invalidate to load the accurate results\n      await queryClient.invalidateQueries({\n        queryKey: keyFactory.getDownloadListBaseQueryKey(),\n      })\n      if (options?.onSuccess) {\n        return options.onSuccess(data, variables, ctx, ...rest)\n      }\n      return\n    },\n  })\n}\n\nexport function useGetAddToDownloadListStats(\n  addToDownloadListStatsRequest: AddToDownloadListStatsRequest,\n  options?: { enabled?: boolean },\n) {\n  const { synapseClient, keyFactory } = useSynapseContext()\n  return useQuery({\n    queryKey: keyFactory.getAddToDownloadListStatsQueryKey(\n      addToDownloadListStatsRequest,\n    ),\n    queryFn: async () => {\n      const jobId = (\n        await synapseClient.downloadListServicesClient.postRepoV1DownloadListAddStatsAsyncStart(\n          { addToDownloadListStatsRequest },\n        )\n      ).token!\n\n      const asyncJobResponse = await waitForAsyncResult(() =>\n        synapseClient.asynchronousJobServicesClient.getRepoV1AsynchronousJobJobId(\n          { jobId },\n        ),\n      )\n      return asyncJobResponse.responseBody as AddToDownloadListStatsResponse\n    },\n    enabled: options?.enabled,\n  })\n}\n"],"mappings":";;;;;AAmCA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,sCAAsC,CAAO;EAClE,eACE,EAAc,4BAA4B,GAAS,CAAW;CAClE,CAAC;AACH;AAEA,SAAgB,EAGd,GACA,GACA,GASA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAiC,EACrC,cACE,gEACJ;CAOA,OANI,MACF,EAAQ,OAAO,CAAC,CAAI,IAElB,MACF,EAAQ,SAAS,IAEZ,EAML;EACA,GAAG;EACH,UAAU,EAAW,8CAA8C,CAAO;EAC1E,SAAS,OAAM,MACN,EAAc,4BACnB;GAAE,GAAG;GAAS,eAAe,EAAQ;EAAU,GAC/C,CACF;EAEF,kBAAkB,KAAA;EAClB,mBAAkB,MAAQ,EAAK;CACjC,CAAC;AACH;AAEA,SAAgB,EACd,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAiC,EACrC,cACE,gEACJ;CAEA,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,uCAAuC;EAC5D,eACE,EAAc,kCAAkC,GAAS,CAAW;CACxE,CAAC;AACH;AAEA,SAAgB,EAGd,GASA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAiC,EACrC,cACE,gEACJ;CACA,OAAO,EAML;EACA,GAAG;EACH,UAAU,EAAW,+CAA+C;EACpE,SAAS,OAAM,MACN,MAAM,EAAc,+BACzB;GAAE,GAAG;GAAS,eAAe,EAAQ;EAAU,GAC/C,CACF;EAEF,kBAAkB,KAAA;EAClB,mBAAkB,MAAQ,EAAK;CACjC,CAAC;AACH;AAEA,SAAgB,EACd,GAGA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,kCAAkC;EACvD,eAAe,EAAc,0BAA0B,CAAW;CACpE,CAAC;AACH;AAEA,SAAgB,EACd,GAUA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAc,EAAe;CACnC,OAAO,EAAY;EACjB,GAAG;EACH,aAAa,MAIX,EAAc,wBACZ,EAAK,UACL,EAAK,qBACL,CACF;EACF,aAAa,CAAC,uBAAuB;EACrC,WAAW,OAAO,GAAM,GAAW,GAAK,GAAG,MAAS;GAKlD,IAHA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,4BAA4B,EACnD,CAAC,GACG,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,GAAK,GAAG,CAAI;EAG1D;CACF,CAAC;AACH;AAMA,IAAa,IAA+B;AAE5C,SAAgB,EACd,GAUA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAc,EAAe;CACnC,OAAO,EAAY;EACjB,GAAG;EACH,aAAY,MACV,EAAc,6BAA6B,GAAY,CAAW;EACpE,aAAa,CAAC,4BAA4B;EAC1C,WAAW,OAAO,GAAM,GAAW,GAAK,GAAG,MAAS;GAKlD,IAHA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,4BAA4B,EACnD,CAAC,GACG,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,GAAK,GAAG,CAAI;EAG1D;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GAOA;CACA,IAAM,EAAE,kBAAe,kBAAe,EAAkB,GAClD,IAAc,EAAe;CACnC,OAAO,EAAY;EACjB,GAAG;EACH,YAAY,OAAM,MAA4B;GAC5C,IAAM,KACJ,MAAM,EAAc,2BAA2B,oCAC7C,EACE,4BACF,CACF,GACA;GASF,QAAO,MAPwB,QAC7B,EAAc,8BAA8B,8BAC1C,EACE,SACF,CACF,CACF,GACwB;EAC1B;EACA,aAAa,CAAC,wBAAwB;EACtC,WAAW,OAAO,GAAM,GAAW,GAAK,GAAG,MAAS;GAKlD,IAHA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,4BAA4B,EACnD,CAAC,GACG,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,GAAK,GAAG,CAAI;EAG1D;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GAOA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB,GAChD,IAAc,EAAe;CACnC,OAAO,EAAY;EACjB,GAAG;EACH,aAAY,MACV,EAAc,8BAA8B,GAAS,CAAW;EAClE,WAAW,OAAO,GAAM,GAAW,GAAK,GAAG,MAAS;GAKlD,IAHA,MAAM,EAAY,kBAAkB,EAClC,UAAU,EAAW,4BAA4B,EACnD,CAAC,GACG,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,GAAK,GAAG,CAAI;EAG1D;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,kBAAe,kBAAe,EAAkB;CACxD,OAAO,EAAS;EACd,UAAU,EAAW,kCACnB,CACF;EACA,SAAS,YAAY;GACnB,IAAM,KACJ,MAAM,EAAc,2BAA2B,yCAC7C,EAAE,iCAA8B,CAClC,GACA;GAOF,QAAO,MALwB,QAC7B,EAAc,8BAA8B,8BAC1C,EAAE,SAAM,CACV,CACF,GACwB;EAC1B;EACA,SAAS,GAAS;CACpB,CAAC;AACH"}

package/dist/synapse-queries/entity/useEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useEntity.d.ts","sourceRoot":"","sources":["../../../src/synapse-queries/entity/useEntity.ts"],"names":[],"mappings":"AASA,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,iBAAiB,EACjB,WAAW,EACX,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,UAAU,EACV,UAAU,EACV,uBAAuB,EACvB,gBAAgB,EAChB,qBAAqB,EACrB,WAAW,EACZ,MAAM,iCAAiC,CAAA;AACxC,OAAO,EACL,YAAY,EAEZ,QAAQ,EAIR,uBAAuB,EAEvB,kBAAkB,EAIlB,eAAe,EAEf,uBAAuB,EACxB,MAAM,uBAAuB,CAAA;AAG9B,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAMvC,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,MAAM,MAGrD,WAAW,MAAM,EACjB,gBAAgB,MAAM,GAAG,MAAM,KAC9B,eAAe,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAY1C;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAC3C,QAAQ,CAAC,EAAE,MAAM,EACjB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAC/B,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,iHAO1D;AAED,wBAAgB,cAAc,CAC5B,aAAa,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,GAAG,eAAe,CAAC,EAAE,EAC3D,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC,mEAwBjE;AAED,wBAAgB,eAAe,CAC7B,OAAO,CAAC,EAAE,kBAAkB,CAC1B,MAAM,EACN,kBAAkB,EAClB,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,UAAU,GAAG,cAAc,CAAC,CACnE,8JAkCF;AAED,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAC9C,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,wFAwBhE;AAED,wBAAgB,eAAe,CAC7B,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAAC,MAAM,GAAG,SAAS,EAAE,kBAAkB,EAAE,MAAM,CAAC,CACnE,8GAyBF;AAED,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,MAAU,EAClB,KAAK,GAAE,MAAY,EACnB,OAAO,CAAC,EAAE,OAAO,CACf,eAAe,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,kBAAkB,CAAC,CACnE,qGAaF;AAED,wBAAgB,sBAAsB,CACpC,KAAK,GAAG,YAAY,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,EAEnD,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,OAAO,CACd,uBAAuB,CACrB,gBAAgB,CAAC,WAAW,CAAC,EAC7B,kBAAkB,EAClB,KAAK,EACL,QAAQ,EACR,MAAM,GAAG,SAAS,CACnB,CACF,qFAwBF;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAEpE;AAED,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,UAAU,GACf,MAAM,CACP,MAAM,EACN,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,GAAG,SAAS,CACxE,CAEA;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,yBAAyB,EAAE,OAAO,EAClC,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;;;;uBA+BnE;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAAC,UAAU,EAAE,kBAAkB,EAAE,UAAU,CAAC,CAC/D,0GA+BF;AAED,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC,kFAQnE;AAED,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAAC,yFAQ1E;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,QAAQ,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,uFAQxE;AAED,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,UAAU,EAAE,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,2FAS5E;AAED,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,OAAO,CACf,eAAe,CAAC,qBAAqB,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAClE,oGAQF;AAoBD,wBAAgB,kBAAkB,CAChC,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,CAAC,CAC7E,wHAsBF;AAED,wBAAgB,kBAAkB,CAChC,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,CAAC,CAC7E,wHAsBF;AAED,wBAAgB,kBAAkB,CAChC,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,CAAC,gGAiBxE;AAyBD;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAC/C,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,OAAO,CACf,uBAAuB,CACrB,YAAY,CAAC;IAAE,oBAAoB,EAAE,IAAI,CAAA;CAAE,CAAC,EAC5C,kBAAkB,EAClB,iBAAiB,CAClB,CACF,iGAOF;AAED,KAAK,0BAA0B,GAAG;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,EAAE,WAAW,EAAE,CAAA;IACnC,eAAe,EAAE,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,CAAA;CAClD,CAAA;AAED,wBAAgB,qBAAqB,CACnC,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,CAAC,CAC5E,uHA8BF;AAED,KAAK,qBAAqB,GAAG,MAAM,GAAG,IAAI,CAAA;AAC1C,wBAAgB,8BAA8B,KAG1C,qBAAqB,mBAAmB,KACvC,eAAe,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAY9D"}
+{"version":3,"file":"useEntity.d.ts","sourceRoot":"","sources":["../../../src/synapse-queries/entity/useEntity.ts"],"names":[],"mappings":"AASA,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EACL,iBAAiB,EACjB,WAAW,EACX,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,UAAU,EACV,UAAU,EACV,uBAAuB,EACvB,gBAAgB,EAChB,qBAAqB,EACrB,WAAW,EACZ,MAAM,iCAAiC,CAAA;AACxC,OAAO,EACL,YAAY,EAEZ,QAAQ,EAIR,uBAAuB,EAEvB,kBAAkB,EAIlB,eAAe,EAEf,uBAAuB,EACxB,MAAM,uBAAuB,CAAA;AAG9B,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAMvC,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,MAAM,MAGrD,WAAW,MAAM,EACjB,gBAAgB,MAAM,GAAG,MAAM,KAC9B,eAAe,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAY1C;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAC3C,QAAQ,CAAC,EAAE,MAAM,EACjB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAC/B,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,iHAO1D;AAED,wBAAgB,cAAc,CAC5B,aAAa,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,GAAG,eAAe,CAAC,EAAE,EAC3D,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,CAAC,mEAwBjE;AAED,wBAAgB,eAAe,CAC7B,OAAO,CAAC,EAAE,kBAAkB,CAC1B,MAAM,EACN,kBAAkB,EAClB,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,UAAU,GAAG,cAAc,CAAC,CACnE,8JAkCF;AAED,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,EAC9C,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC,wFAwBhE;AAED,wBAAgB,eAAe,CAC7B,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAAC,MAAM,GAAG,SAAS,EAAE,kBAAkB,EAAE,MAAM,CAAC,CACnE,8GAyBF;AAED,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,MAAU,EAClB,KAAK,GAAE,MAAY,EACnB,OAAO,CAAC,EAAE,OAAO,CACf,eAAe,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,kBAAkB,CAAC,CACnE,qGAaF;AAED,wBAAgB,sBAAsB,CACpC,KAAK,GAAG,YAAY,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,EAEnD,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,OAAO,CACd,uBAAuB,CACrB,gBAAgB,CAAC,WAAW,CAAC,EAC7B,kBAAkB,EAClB,KAAK,EACL,QAAQ,EACR,MAAM,GAAG,SAAS,CACnB,CACF,qFAwBF;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAEpE;AAED,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,UAAU,GACf,MAAM,CACP,MAAM,EACN,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,GAAG,SAAS,CACxE,CAEA;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,yBAAyB,EAAE,OAAO,EAClC,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;;;;uBA+BnE;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAAC,UAAU,EAAE,kBAAkB,EAAE,UAAU,CAAC,CAC/D,0GA+BF;AAED,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC,kFAQnE;AAED,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAAC,yFAQ1E;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,QAAQ,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,uFAQxE;AAED,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,UAAU,EAAE,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,2FAS5E;AAED,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,OAAO,CACf,eAAe,CAAC,qBAAqB,GAAG,IAAI,EAAE,kBAAkB,CAAC,CAClE,oGAQF;AAoBD,wBAAgB,kBAAkB,CAChC,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,CAAC,CAC7E,wHA2BF;AAED,wBAAgB,kBAAkB,CAChC,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,CAAC,CAC7E,wHA2BF;AAED,wBAAgB,kBAAkB,CAChC,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,CAAC,gGAiBxE;AAyBD;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAC/C,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,OAAO,CACf,uBAAuB,CACrB,YAAY,CAAC;IAAE,oBAAoB,EAAE,IAAI,CAAA;CAAE,CAAC,EAC5C,kBAAkB,EAClB,iBAAiB,CAClB,CACF,iGAOF;AAED,KAAK,0BAA0B,GAAG;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,EAAE,WAAW,EAAE,CAAA;IACnC,eAAe,EAAE,WAAW,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,CAAA;CAClD,CAAA;AAED,wBAAgB,qBAAqB,CACnC,OAAO,CAAC,EAAE,OAAO,CACf,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,CAAC,CAC5E,uHA8BF;AAED,KAAK,qBAAqB,GAAG,MAAM,GAAG,IAAI,CAAA;AAC1C,wBAAgB,8BAA8B,KAG1C,qBAAqB,mBAAmB,KACvC,eAAe,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAY9D"}

package/dist/synapse-queries/entity/useEntity.js

@@ -41,12 +41,12 @@ function S(e) {
 	let n = _(), { accessToken: r, keyFactory: o } = i();
 	return m({
 		mutationFn: (e) => t.createEntity(e, r),
-		onSuccess: async (t, r, i) => {
-			let s = o.getEntityQueryKey(t.id);
-			n.setQueryData(s, t), n.setQueryData(o.getEntityLookupQueryKey({
+		onSuccess: async (t, r, i, ...s) => {
+			let c = o.getEntityQueryKey(t.id);
+			n.setQueryData(c, t), n.setQueryData(o.getEntityLookupQueryKey({
 				parentId: t.parentId,
 				entityName: t.name
-			}), t.id), await a(n, o, t.id, s), e?.onSuccess && await e.onSuccess(t, r, i);
+			}), t.id), await a(n, o, t.id, c), e?.onSuccess && await e.onSuccess(t, r, i, ...s);
 		}
 	});
 }
@@ -55,9 +55,9 @@ function C(e) {
 	return m({
 		...e,
 		mutationFn: (e) => t.updateEntity(e, r),
-		onSuccess: async (t, r, i) => {
-			let s = o.getEntityQueryKey(t.id);
-			n.setQueryData(s, t), await a(n, o, t.id, s), e?.onSuccess && await e.onSuccess(t, r, i);
+		onSuccess: async (t, r, i, ...s) => {
+			let c = o.getEntityQueryKey(t.id);
+			n.setQueryData(c, t), await a(n, o, t.id, c), e?.onSuccess && await e.onSuccess(t, r, i, ...s);
 		}
 	});
 }
@@ -69,8 +69,8 @@ function w(e) {
 			let n = await t.getEntity(r, e);
 			return await t.deleteEntity(r, e), n.parentId;
 		},
-		onSuccess: async (t, r, i) => {
-			await a(n, o, r), t && await a(n, o, t), e?.onSuccess && await e.onSuccess(t, r, i);
+		onSuccess: async (t, r, i, ...s) => {
+			await a(n, o, r), t && await a(n, o, t), e?.onSuccess && await e.onSuccess(t, r, i, ...s);
 		}
 	});
 }
@@ -119,9 +119,9 @@ function A(e) {
 			let n = e.id;
 			return t.updateEntityJson(n, e, r);
 		},
-		onSuccess: async (t, r, i) => {
-			let s = t.id, c = o.getEntityJsonQueryKey(s, void 0, !1);
-			n.setQueryData(c, t), await a(n, o, s, c), e?.onSuccess && await e.onSuccess(t, r, i);
+		onSuccess: async (t, r, i, ...s) => {
+			let c = t.id, l = o.getEntityJsonQueryKey(c, void 0, !1);
+			n.setQueryData(l, t), await a(n, o, c, l), e?.onSuccess && await e.onSuccess(t, r, i, ...s);
 		}
 	});
 }
@@ -174,8 +174,8 @@ function L(e) {
 	return m({
 		...e,
 		mutationFn: (e) => t.createEntityACL(e, r),
-		onSuccess: async (t, r, i) => {
-			await I(t.id, t, n, a), e?.onSuccess && await e.onSuccess(t, r, i);
+		onSuccess: async (t, r, i, ...o) => {
+			await I(t.id, t, n, a), e?.onSuccess && await e.onSuccess(t, r, i, ...o);
 		}
 	});
 }
@@ -184,8 +184,8 @@ function R(e) {
 	return m({
 		...e,
 		mutationFn: (e) => t.updateEntityACL(e, r),
-		onSuccess: async (t, r, i) => {
-			await I(t.id, t, n, a), e?.onSuccess && await e.onSuccess(t, r, i);
+		onSuccess: async (t, r, i, ...o) => {
+			await I(t.id, t, n, a), e?.onSuccess && await e.onSuccess(t, r, i, ...o);
 		}
 	});
 }
@@ -194,8 +194,8 @@ function z(e) {
 	return m({
 		...e,
 		mutationFn: (e) => t.deleteEntityACL(e, r),
-		onSuccess: async (t, r, i) => {
-			await I(r, null, n, a), e?.onSuccess && await e.onSuccess(t, r, i);
+		onSuccess: async (t, r, i, ...o) => {
+			await I(r, null, n, a), e?.onSuccess && await e.onSuccess(t, r, i, ...o);
 		}
 	});
 }
@@ -217,8 +217,8 @@ function H(e) {
 			let n = await r(o, e.entityId, e.originalColumnModels, e.newColumnModels);
 			return t.updateTable(n, o);
 		},
-		onSuccess: async (t, r, i) => {
-			await a(n, s, r.entityId), e?.onSuccess && await e.onSuccess(t, r, i);
+		onSuccess: async (t, r, i, ...o) => {
+			await a(n, s, r.entityId), e?.onSuccess && await e.onSuccess(t, r, i, ...o);
 		}
 	});
 }

package/dist/synapse-queries/entity/useEntity.js.map

@@ -1 +1 @@
-{"version":3,"file":"useEntity.js","names":[],"sources":["../../../src/synapse-queries/entity/useEntity.ts"],"sourcesContent":["/*\n * Hooks to access Entity Services in Synapse\n */\n\nimport SynapseClient from '@/synapse-client'\nimport { allowNotFoundError } from '@/synapse-client/SynapseClientUtils'\nimport { useSynapseContext } from '@/utils/context/SynapseContext'\nimport { entityJsonKeys } from '@/utils/functions/EntityTypeUtils'\nimport { createTableUpdateTransactionRequest } from '@/utils/functions/TableColumnSchemaUtils'\nimport {\n  EntityLookupRequest,\n  SynapseClientError,\n} from '@sage-bionetworks/synapse-client'\nimport {\n  AccessControlList,\n  ColumnModel,\n  Entity,\n  EntityBundle,\n  EntityHeader,\n  EntityId,\n  EntityJson,\n  EntityPath,\n  Evaluation,\n  GetEvaluationParameters,\n  PaginatedResults,\n  UserEntityPermissions,\n  VersionInfo,\n} from '@sage-bionetworks/synapse-types'\nimport {\n  InfiniteData,\n  QueryClient,\n  QueryKey,\n  queryOptions,\n  skipToken,\n  useInfiniteQuery,\n  UseInfiniteQueryOptions,\n  useMutation,\n  UseMutationOptions,\n  useQueries,\n  useQuery,\n  useQueryClient,\n  UseQueryOptions,\n  useSuspenseQuery,\n  UseSuspenseQueryOptions,\n} from '@tanstack/react-query'\nimport { omit, pick } from 'lodash-es'\nimport { useMemo } from 'react'\nimport { SetOptional } from 'type-fest'\nimport { getNextPageParamForPaginatedResults } from '../InfiniteQueryUtils'\nimport { KeyFactory } from '../KeyFactory'\nimport { invalidateAllQueriesForEntity } from '../QueryFilterUtils'\nimport { useGetEntityBundleSuspenseQueryOptions } from './useEntityBundle'\n\nexport function useGetEntityQueryOptions<T extends Entity>() {\n  const { keyFactory, accessToken } = useSynapseContext()\n  return (\n    entityId?: string,\n    versionNumber?: string | number,\n  ): UseQueryOptions<T, SynapseClientError> =>\n    queryOptions<T, SynapseClientError>({\n      queryKey: keyFactory.getEntityVersionQueryKey(entityId, versionNumber),\n      queryFn: entityId\n        ? () =>\n            SynapseClient.getEntity<T>(\n              accessToken,\n              entityId,\n              versionNumber?.toString(),\n            )\n        : skipToken,\n    })\n}\n\nexport function useGetEntity<T extends Entity>(\n  entityId?: string,\n  versionNumber?: string | number,\n  options?: Partial<UseQueryOptions<T, SynapseClientError>>,\n) {\n  const getEntityQueryOptions = useGetEntityQueryOptions<T>()\n  return useQuery({\n    ...options,\n    ...getEntityQueryOptions(entityId, versionNumber),\n  })\n}\n\nexport function useGetEntities(\n  entityHeaders: Pick<EntityHeader, 'id' | 'versionNumber'>[],\n  options?: Partial<UseQueryOptions<Entity[], SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const queries = useMemo(\n    () => ({\n      queries: entityHeaders.map(header => {\n        return {\n          queryKey: keyFactory.getEntityVersionQueryKey(\n            header.id,\n            header.versionNumber,\n          ),\n          queryFn: () =>\n            SynapseClient.getEntity(\n              accessToken,\n              header.id,\n              header.versionNumber,\n            ),\n          options,\n        }\n      }),\n    }),\n    [accessToken, entityHeaders, keyFactory, options],\n  )\n  return useQueries(queries)\n}\n\nexport function useCreateEntity(\n  options?: UseMutationOptions<\n    Entity,\n    SynapseClientError,\n    Pick<Entity, 'name' | 'description' | 'parentId' | 'concreteType'>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<\n    Entity,\n    SynapseClientError,\n    Pick<Entity, 'name' | 'description' | 'parentId' | 'concreteType'>\n  >({\n    mutationFn: (entity: Entity) =>\n      SynapseClient.createEntity(entity, accessToken),\n    onSuccess: async (newEntity, variables, ctx) => {\n      const entityDataQueryKey = keyFactory.getEntityQueryKey(newEntity.id!)\n      queryClient.setQueryData(entityDataQueryKey, newEntity)\n      queryClient.setQueryData<EntityLookupQueryData>(\n        keyFactory.getEntityLookupQueryKey({\n          parentId: newEntity.parentId,\n          entityName: newEntity.name,\n        }),\n        newEntity.id,\n      )\n      await invalidateAllQueriesForEntity(\n        queryClient,\n        keyFactory,\n        newEntity.id!,\n        entityDataQueryKey,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(newEntity, variables, ctx)\n      }\n    },\n  })\n}\n\nexport function useUpdateEntity<T extends Entity>(\n  options?: Partial<UseMutationOptions<T, SynapseClientError, T>>,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<T, SynapseClientError, T>({\n    ...options,\n    mutationFn: (entity: T) =>\n      SynapseClient.updateEntity<T>(entity, accessToken),\n    onSuccess: async (updatedEntity, variables, ctx) => {\n      const entityDataQueryKey = keyFactory.getEntityQueryKey(updatedEntity.id!)\n      queryClient.setQueryData(entityDataQueryKey, updatedEntity)\n      await invalidateAllQueriesForEntity(\n        queryClient,\n        keyFactory,\n        updatedEntity.id!,\n        entityDataQueryKey,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(updatedEntity, variables, ctx)\n      }\n    },\n  })\n}\n\nexport function useDeleteEntity(\n  options?: Partial<\n    UseMutationOptions<string | undefined, SynapseClientError, string>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<string | undefined, SynapseClientError, string>({\n    ...options,\n    mutationFn: async (entityId: string) => {\n      const entity = await SynapseClient.getEntity<Entity>(\n        accessToken,\n        entityId,\n      )\n      await SynapseClient.deleteEntity(accessToken, entityId)\n      return entity.parentId\n    },\n    onSuccess: async (parentId, entityId, ctx) => {\n      await invalidateAllQueriesForEntity(queryClient, keyFactory, entityId)\n      if (parentId) {\n        await invalidateAllQueriesForEntity(queryClient, keyFactory, parentId)\n      }\n      if (options?.onSuccess) {\n        await options.onSuccess(parentId, entityId, ctx)\n      }\n    },\n  })\n}\n\nexport function useGetVersions(\n  entityId: string,\n  offset: number = 0,\n  limit: number = 200,\n  options?: Partial<\n    UseQueryOptions<PaginatedResults<VersionInfo>, SynapseClientError>\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getPaginatedEntityVersionsQueryKey(\n      entityId,\n      limit,\n      offset,\n    ),\n    queryFn: () =>\n      SynapseClient.getEntityVersions(entityId, accessToken, offset, limit),\n  })\n}\n\nexport function useGetVersionsInfinite<\n  TData = InfiniteData<PaginatedResults<VersionInfo>>,\n>(\n  entityId: string,\n  options: Partial<\n    UseInfiniteQueryOptions<\n      PaginatedResults<VersionInfo>,\n      SynapseClientError,\n      TData,\n      QueryKey,\n      number | undefined\n    >\n  >,\n) {\n  const LIMIT = 200\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useInfiniteQuery<\n    PaginatedResults<VersionInfo>,\n    SynapseClientError,\n    TData,\n    QueryKey,\n    number | undefined\n  >({\n    ...options,\n    queryKey: keyFactory.getEntityVersionsQueryKey(entityId),\n    queryFn: async context => {\n      return await SynapseClient.getEntityVersions(\n        entityId,\n        accessToken,\n        context.pageParam,\n        LIMIT,\n      )\n    },\n    initialPageParam: undefined,\n    getNextPageParam: getNextPageParamForPaginatedResults,\n  })\n}\n\nexport function getStandardEntityFields(json: EntityJson): EntityJson {\n  return pick(json, entityJsonKeys[json.concreteType]) as EntityJson\n}\n\nexport function removeStandardEntityFields(\n  json: EntityJson,\n): Record<\n  string,\n  string | number | boolean | string[] | number[] | boolean[] | undefined\n> {\n  return omit(json, entityJsonKeys[json.concreteType])\n}\n\n/**\n * This hook automatically transforms the data to include these objects:\n * - `entity`: the unmodified Entity data object\n * - `entityMetadata`: the standard entity fields contained in the JSON response\n * - `annotations`: the annotations contained in the JSON response\n *\n * The union of these objects would be equal in value to the `data` object.\n */\nexport function useGetJson(\n  entityId: string,\n  versionNumber: number | undefined,\n  includeDerivedAnnotations: boolean,\n  options?: Partial<UseQueryOptions<EntityJson, SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityJsonQueryKey(\n      entityId,\n      versionNumber,\n      includeDerivedAnnotations,\n    ),\n    queryFn: () =>\n      SynapseClient.getEntityJson(\n        entityId,\n        versionNumber,\n        includeDerivedAnnotations,\n        accessToken,\n      ),\n\n    select: data => {\n      // Separate the standard fields and annotations.\n      const entityMetadata = getStandardEntityFields(data)\n\n      const annotations = removeStandardEntityFields(data)\n\n      return {\n        entity: data,\n        entityMetadata,\n        annotations,\n      }\n    },\n  })\n}\n\nexport function useUpdateViaJson(\n  options?: Partial<\n    UseMutationOptions<EntityJson, SynapseClientError, EntityJson>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useMutation<EntityJson, SynapseClientError, EntityJson>({\n    ...options,\n    mutationFn: (json: EntityJson) => {\n      const entityId = json.id\n      return SynapseClient.updateEntityJson(entityId, json, accessToken)\n    },\n    onSuccess: async (data, variables, ctx) => {\n      const entityId = data.id\n      // This annotation data will never include derived annotations, which are calculated by the backend asynchronously\n      const entityJsonQueryKey = keyFactory.getEntityJsonQueryKey(\n        entityId,\n        undefined,\n        false,\n      )\n      queryClient.setQueryData(entityJsonQueryKey, data)\n      await invalidateAllQueriesForEntity(\n        queryClient,\n        keyFactory,\n        entityId,\n        entityJsonQueryKey,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(data, variables, ctx)\n      }\n    },\n  })\n}\n\nexport function useGetEntityPath(\n  entityId: string,\n  options?: Partial<UseQueryOptions<EntityPath, SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityPathQueryKey(entityId),\n    queryFn: () => SynapseClient.getEntityPath(entityId, accessToken),\n  })\n}\n\nexport function useGetEntityACL(\n  entityId: string,\n  options?: Partial<UseQueryOptions<AccessControlList, SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityPathQueryKey(entityId),\n    queryFn: () => SynapseClient.getEntityACL(entityId, accessToken),\n  })\n}\n\nexport function useGetEntityAlias(\n  alias: string,\n  options?: Partial<UseQueryOptions<EntityId | null, SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityAliasQueryKey(alias),\n    queryFn: () => SynapseClient.getEntityAlias(alias, accessToken),\n  })\n}\n\nexport function useGetEntityEvaluations(\n  entityId: string,\n  params?: GetEvaluationParameters,\n  options?: Partial<UseQueryOptions<Evaluation[] | null, SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityEvaluationsQueryKey(entityId),\n    queryFn: () =>\n      SynapseClient.getAllEntityEvaluations(entityId, params, accessToken),\n  })\n}\n\nexport function useGetEntityPermissions(\n  entityId: string,\n  options?: Partial<\n    UseQueryOptions<UserEntityPermissions | null, SynapseClientError>\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityPermissionsQueryKey(entityId),\n    queryFn: () => SynapseClient.getEntityPermissions(entityId, accessToken),\n  })\n}\n\nconst onMutateEntityAclSuccess = async (\n  entityId: string,\n  updatedACL: AccessControlList | null,\n  queryClient: QueryClient,\n  keyFactory: KeyFactory,\n) => {\n  const entityAclQueryKey = keyFactory.getEntityACLQueryKey(entityId)\n  if (updatedACL) {\n    queryClient.setQueryData(entityAclQueryKey, updatedACL)\n  }\n  await invalidateAllQueriesForEntity(\n    queryClient,\n    keyFactory,\n    entityId,\n    entityAclQueryKey,\n  )\n}\n\nexport function useCreateEntityACL(\n  options?: Partial<\n    UseMutationOptions<AccessControlList, SynapseClientError, AccessControlList>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<AccessControlList, SynapseClientError, AccessControlList>({\n    ...options,\n    mutationFn: (acl: AccessControlList) =>\n      SynapseClient.createEntityACL(acl, accessToken),\n    onSuccess: async (updatedACL: AccessControlList, variables, ctx) => {\n      await onMutateEntityAclSuccess(\n        updatedACL.id,\n        updatedACL,\n        queryClient,\n        keyFactory,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(updatedACL, variables, ctx)\n      }\n    },\n  })\n}\n\nexport function useUpdateEntityACL(\n  options?: Partial<\n    UseMutationOptions<AccessControlList, SynapseClientError, AccessControlList>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<AccessControlList, SynapseClientError, AccessControlList>({\n    ...options,\n    mutationFn: (acl: AccessControlList) =>\n      SynapseClient.updateEntityACL(acl, accessToken),\n    onSuccess: async (updatedACL: AccessControlList, variables, ctx) => {\n      await onMutateEntityAclSuccess(\n        updatedACL.id,\n        updatedACL,\n        queryClient,\n        keyFactory,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(updatedACL, variables, ctx)\n      }\n    },\n  })\n}\n\nexport function useDeleteEntityACL(\n  options?: Partial<UseMutationOptions<void, SynapseClientError, string>>,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<void, SynapseClientError, string>({\n    ...options,\n    mutationFn: (entityId: string) =>\n      SynapseClient.deleteEntityACL(entityId, accessToken),\n    onSuccess: async (result: void, entityId, ctx) => {\n      await onMutateEntityAclSuccess(entityId, null, queryClient, keyFactory)\n\n      if (options?.onSuccess) {\n        await options.onSuccess(result, entityId, ctx)\n      }\n    },\n  })\n}\n\nfunction useGetEntityBenefactorACLQueryOptions(\n  entityId: string,\n): UseSuspenseQueryOptions<\n  EntityBundle<{ includeBenefactorACL: true }>,\n  SynapseClientError,\n  AccessControlList\n> {\n  const selectBenefactorACL = (\n    data: EntityBundle<{ includeBenefactorACL: true }>,\n  ): AccessControlList => data.benefactorAcl\n  return useGetEntityBundleSuspenseQueryOptions<\n    { includeBenefactorACL: true },\n    AccessControlList\n  >(\n    entityId,\n    undefined,\n    {\n      includeBenefactorACL: true,\n    },\n    selectBenefactorACL,\n  )\n}\n\n/**\n * Retrieve the ACL of an entity. This call will succeed even for entities where the caller\n * does not have READ permission.\n * @param entityId\n * @param options\n */\nexport function useSuspenseGetEntityBenefactorACL(\n  entityId: string,\n  options?: Partial<\n    UseSuspenseQueryOptions<\n      EntityBundle<{ includeBenefactorACL: true }>,\n      SynapseClientError,\n      AccessControlList\n    >\n  >,\n) {\n  const queryOptions = useGetEntityBenefactorACLQueryOptions(entityId)\n  return useSuspenseQuery({\n    ...options,\n    ...queryOptions,\n  })\n}\n\ntype UpdateTableMutationRequest = {\n  entityId: string\n  originalColumnModels: ColumnModel[]\n  newColumnModels: SetOptional<ColumnModel, 'id'>[]\n}\n\nexport function useUpdateTableColumns(\n  options?: Partial<\n    UseMutationOptions<unknown, SynapseClientError, UpdateTableMutationRequest>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<unknown, SynapseClientError, UpdateTableMutationRequest>({\n    ...options,\n    mutationFn: async (request: UpdateTableMutationRequest) => {\n      // This call will create new column models as appropriate\n      const transactionRequest = await createTableUpdateTransactionRequest(\n        accessToken!,\n        request.entityId,\n        request.originalColumnModels,\n        request.newColumnModels,\n      )\n\n      return SynapseClient.updateTable(transactionRequest, accessToken)\n    },\n    onSuccess: async (response, variables, ctx) => {\n      await invalidateAllQueriesForEntity(\n        queryClient,\n        keyFactory,\n        variables.entityId,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(response, variables, ctx)\n      }\n    },\n  })\n}\n\ntype EntityLookupQueryData = string | null\nexport function useGetEntityLookupQueryOptions() {\n  const { keyFactory, synapseClient } = useSynapseContext()\n  return (\n    entityLookupRequest: EntityLookupRequest,\n  ): UseQueryOptions<EntityLookupQueryData, SynapseClientError> =>\n    queryOptions<EntityLookupQueryData, SynapseClientError>({\n      queryKey: keyFactory.getEntityLookupQueryKey(entityLookupRequest),\n      queryFn: async () =>\n        (\n          await allowNotFoundError(() =>\n            synapseClient.entityServicesClient.postRepoV1EntityChild({\n              entityLookupRequest: entityLookupRequest,\n            }),\n          )\n        )?.id ?? null,\n    })\n}\n"],"mappings":";;;;;;;;;;;;AAqDA,SAAgB,IAA6C;CAC3D,IAAM,EAAE,eAAY,mBAAgB,EAAkB;CACtD,QACE,GACA,MAEA,EAAoC;EAClC,UAAU,EAAW,yBAAyB,GAAU,CAAa;EACrE,SAAS,UAEH,EAAc,UACZ,GACA,GACA,GAAe,SAAS,CAC1B,IACF;CACN,CAAC;AACL;AAEA,SAAgB,EACd,GACA,GACA,GACA;CACA,IAAM,IAAwB,EAA4B;CAC1D,OAAO,EAAS;EACd,GAAG;EACH,GAAG,EAAsB,GAAU,CAAa;CAClD,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CAqBtD,OAAO,EApBS,SACP,EACL,SAAS,EAAc,KAAI,OAClB;EACL,UAAU,EAAW,yBACnB,EAAO,IACP,EAAO,aACT;EACA,eACE,EAAc,UACZ,GACA,EAAO,IACP,EAAO,aACT;EACF;CACF,EACD,EACH,IACA;EAAC;EAAa;EAAe;EAAY;CAAO,CAEhC,CAAO;AAC3B;AAEA,SAAgB,EACd,GAKA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAIL;EACA,aAAa,MACX,EAAc,aAAa,GAAQ,CAAW;EAChD,WAAW,OAAO,GAAW,GAAW,MAAQ;GAC9C,IAAM,IAAqB,EAAW,kBAAkB,EAAU,EAAG;GAgBrE,AAfA,EAAY,aAAa,GAAoB,CAAS,GACtD,EAAY,aACV,EAAW,wBAAwB;IACjC,UAAU,EAAU;IACpB,YAAY,EAAU;GACxB,CAAC,GACD,EAAU,EACZ,GACA,MAAM,EACJ,GACA,GACA,EAAU,IACV,CACF,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAW,GAAW,CAAG;EAErD;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GACA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAAsC;EAC3C,GAAG;EACH,aAAa,MACX,EAAc,aAAgB,GAAQ,CAAW;EACnD,WAAW,OAAO,GAAe,GAAW,MAAQ;GAClD,IAAM,IAAqB,EAAW,kBAAkB,EAAc,EAAG;GASzE,AARA,EAAY,aAAa,GAAoB,CAAa,GAC1D,MAAM,EACJ,GACA,GACA,EAAc,IACd,CACF,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAe,GAAW,CAAG;EAEzD;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GAGA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAA4D;EACjE,GAAG;EACH,YAAY,OAAO,MAAqB;GACtC,IAAM,IAAS,MAAM,EAAc,UACjC,GACA,CACF;GAEA,OADA,MAAM,EAAc,aAAa,GAAa,CAAQ,GAC/C,EAAO;EAChB;EACA,WAAW,OAAO,GAAU,GAAU,MAAQ;GAK5C,AAJA,MAAM,EAA8B,GAAa,GAAY,CAAQ,GACjE,KACF,MAAM,EAA8B,GAAa,GAAY,CAAQ,GAEnE,GAAS,aACX,MAAM,EAAQ,UAAU,GAAU,GAAU,CAAG;EAEnD;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GACA,IAAiB,GACjB,IAAgB,KAChB,GAGA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,mCACnB,GACA,GACA,CACF;EACA,eACE,EAAc,kBAAkB,GAAU,GAAa,GAAQ,CAAK;CACxE,CAAC;AACH;AAEA,SAAgB,EAGd,GACA,GASA;CACA,IACM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAML;EACA,GAAG;EACH,UAAU,EAAW,0BAA0B,CAAQ;EACvD,SAAS,OAAM,MACN,MAAM,EAAc,kBACzB,GACA,GACA,EAAQ,WACR,GACF;EAEF,kBAAkB,KAAA;EAClB,kBAAkB;CACpB,CAAC;AACH;AAEA,SAAgB,EAAwB,GAA8B;CACpE,OAAO,EAAK,GAAM,EAAe,EAAK,aAAa;AACrD;AAEA,SAAgB,EACd,GAIA;CACA,OAAO,EAAK,GAAM,EAAe,EAAK,aAAa;AACrD;AAUA,SAAgB,EACd,GACA,GACA,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,sBACnB,GACA,GACA,CACF;EACA,eACE,EAAc,cACZ,GACA,GACA,GACA,CACF;EAEF,SAAQ,OAMC;GACL,QAAQ;GACR,gBANqB,EAAwB,CAM7C;GACA,aALkB,EAA2B,CAK7C;EACF;CAEJ,CAAC;AACH;AAEA,SAAgB,EACd,GAGA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAwD;EAC7D,GAAG;EACH,aAAa,MAAqB;GAChC,IAAM,IAAW,EAAK;GACtB,OAAO,EAAc,iBAAiB,GAAU,GAAM,CAAW;EACnE;EACA,WAAW,OAAO,GAAM,GAAW,MAAQ;GACzC,IAAM,IAAW,EAAK,IAEhB,IAAqB,EAAW,sBACpC,GACA,KAAA,GACA,EACF;GASA,AARA,EAAY,aAAa,GAAoB,CAAI,GACjD,MAAM,EACJ,GACA,GACA,GACA,CACF,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAM,GAAW,CAAG;EAEhD;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,sBAAsB,CAAQ;EACnD,eAAe,EAAc,cAAc,GAAU,CAAW;CAClE,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,sBAAsB,CAAQ;EACnD,eAAe,EAAc,aAAa,GAAU,CAAW;CACjE,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,uBAAuB,CAAK;EACjD,eAAe,EAAc,eAAe,GAAO,CAAW;CAChE,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,6BAA6B,CAAQ;EAC1D,eACE,EAAc,wBAAwB,GAAU,GAAQ,CAAW;CACvE,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GAGA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,6BAA6B,CAAQ;EAC1D,eAAe,EAAc,qBAAqB,GAAU,CAAW;CACzE,CAAC;AACH;AAEA,IAAM,IAA2B,OAC/B,GACA,GACA,GACA,MACG;CACH,IAAM,IAAoB,EAAW,qBAAqB,CAAQ;CAIlE,AAHI,KACF,EAAY,aAAa,GAAmB,CAAU,GAExD,MAAM,EACJ,GACA,GACA,GACA,CACF;AACF;AAEA,SAAgB,EACd,GAGA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAAsE;EAC3E,GAAG;EACH,aAAa,MACX,EAAc,gBAAgB,GAAK,CAAW;EAChD,WAAW,OAAO,GAA+B,GAAW,MAAQ;GAQlE,AAPA,MAAM,EACJ,EAAW,IACX,GACA,GACA,CACF,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAY,GAAW,CAAG;EAEtD;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GAGA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAAsE;EAC3E,GAAG;EACH,aAAa,MACX,EAAc,gBAAgB,GAAK,CAAW;EAChD,WAAW,OAAO,GAA+B,GAAW,MAAQ;GAQlE,AAPA,MAAM,EACJ,EAAW,IACX,GACA,GACA,CACF,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAY,GAAW,CAAG;EAEtD;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GACA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAA8C;EACnD,GAAG;EACH,aAAa,MACX,EAAc,gBAAgB,GAAU,CAAW;EACrD,WAAW,OAAO,GAAc,GAAU,MAAQ;GAGhD,AAFA,MAAM,EAAyB,GAAU,MAAM,GAAa,CAAU,GAElE,GAAS,aACX,MAAM,EAAQ,UAAU,GAAQ,GAAU,CAAG;EAEjD;CACF,CAAC;AACH;AAEA,SAAS,EACP,GAKA;CAIA,OAAO,EAIL,GACA,KAAA,GACA,EACE,sBAAsB,GACxB,IAVA,MACsB,EAAK,aAW7B;AACF;AAQA,SAAgB,EACd,GACA,GAOA;CACA,IAAM,IAAe,EAAsC,CAAQ;CACnE,OAAO,EAAiB;EACtB,GAAG;EACH,GAAG;CACL,CAAC;AACH;AAQA,SAAgB,EACd,GAGA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAAqE;EAC1E,GAAG;EACH,YAAY,OAAO,MAAwC;GAEzD,IAAM,IAAqB,MAAM,EAC/B,GACA,EAAQ,UACR,EAAQ,sBACR,EAAQ,eACV;GAEA,OAAO,EAAc,YAAY,GAAoB,CAAW;EAClE;EACA,WAAW,OAAO,GAAU,GAAW,MAAQ;GAO7C,AANA,MAAM,EACJ,GACA,GACA,EAAU,QACZ,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAU,GAAW,CAAG;EAEpD;CACF,CAAC;AACH;AAGA,SAAgB,IAAiC;CAC/C,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CACxD,QACE,MAEA,EAAwD;EACtD,UAAU,EAAW,wBAAwB,CAAmB;EAChE,SAAS,aAEL,MAAM,QACJ,EAAc,qBAAqB,sBAAsB,EAClC,uBACvB,CAAC,CACH,IACC,MAAM;CACb,CAAC;AACL"}
+{"version":3,"file":"useEntity.js","names":[],"sources":["../../../src/synapse-queries/entity/useEntity.ts"],"sourcesContent":["/*\n * Hooks to access Entity Services in Synapse\n */\n\nimport SynapseClient from '@/synapse-client'\nimport { allowNotFoundError } from '@/synapse-client/SynapseClientUtils'\nimport { useSynapseContext } from '@/utils/context/SynapseContext'\nimport { entityJsonKeys } from '@/utils/functions/EntityTypeUtils'\nimport { createTableUpdateTransactionRequest } from '@/utils/functions/TableColumnSchemaUtils'\nimport {\n  EntityLookupRequest,\n  SynapseClientError,\n} from '@sage-bionetworks/synapse-client'\nimport {\n  AccessControlList,\n  ColumnModel,\n  Entity,\n  EntityBundle,\n  EntityHeader,\n  EntityId,\n  EntityJson,\n  EntityPath,\n  Evaluation,\n  GetEvaluationParameters,\n  PaginatedResults,\n  UserEntityPermissions,\n  VersionInfo,\n} from '@sage-bionetworks/synapse-types'\nimport {\n  InfiniteData,\n  QueryClient,\n  QueryKey,\n  queryOptions,\n  skipToken,\n  useInfiniteQuery,\n  UseInfiniteQueryOptions,\n  useMutation,\n  UseMutationOptions,\n  useQueries,\n  useQuery,\n  useQueryClient,\n  UseQueryOptions,\n  useSuspenseQuery,\n  UseSuspenseQueryOptions,\n} from '@tanstack/react-query'\nimport { omit, pick } from 'lodash-es'\nimport { useMemo } from 'react'\nimport { SetOptional } from 'type-fest'\nimport { getNextPageParamForPaginatedResults } from '../InfiniteQueryUtils'\nimport { KeyFactory } from '../KeyFactory'\nimport { invalidateAllQueriesForEntity } from '../QueryFilterUtils'\nimport { useGetEntityBundleSuspenseQueryOptions } from './useEntityBundle'\n\nexport function useGetEntityQueryOptions<T extends Entity>() {\n  const { keyFactory, accessToken } = useSynapseContext()\n  return (\n    entityId?: string,\n    versionNumber?: string | number,\n  ): UseQueryOptions<T, SynapseClientError> =>\n    queryOptions<T, SynapseClientError>({\n      queryKey: keyFactory.getEntityVersionQueryKey(entityId, versionNumber),\n      queryFn: entityId\n        ? () =>\n            SynapseClient.getEntity<T>(\n              accessToken,\n              entityId,\n              versionNumber?.toString(),\n            )\n        : skipToken,\n    })\n}\n\nexport function useGetEntity<T extends Entity>(\n  entityId?: string,\n  versionNumber?: string | number,\n  options?: Partial<UseQueryOptions<T, SynapseClientError>>,\n) {\n  const getEntityQueryOptions = useGetEntityQueryOptions<T>()\n  return useQuery({\n    ...options,\n    ...getEntityQueryOptions(entityId, versionNumber),\n  })\n}\n\nexport function useGetEntities(\n  entityHeaders: Pick<EntityHeader, 'id' | 'versionNumber'>[],\n  options?: Partial<UseQueryOptions<Entity[], SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  const queries = useMemo(\n    () => ({\n      queries: entityHeaders.map(header => {\n        return {\n          queryKey: keyFactory.getEntityVersionQueryKey(\n            header.id,\n            header.versionNumber,\n          ),\n          queryFn: () =>\n            SynapseClient.getEntity(\n              accessToken,\n              header.id,\n              header.versionNumber,\n            ),\n          options,\n        }\n      }),\n    }),\n    [accessToken, entityHeaders, keyFactory, options],\n  )\n  return useQueries(queries)\n}\n\nexport function useCreateEntity(\n  options?: UseMutationOptions<\n    Entity,\n    SynapseClientError,\n    Pick<Entity, 'name' | 'description' | 'parentId' | 'concreteType'>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<\n    Entity,\n    SynapseClientError,\n    Pick<Entity, 'name' | 'description' | 'parentId' | 'concreteType'>\n  >({\n    mutationFn: (entity: Entity) =>\n      SynapseClient.createEntity(entity, accessToken),\n    onSuccess: async (newEntity, variables, ctx, ...rest) => {\n      const entityDataQueryKey = keyFactory.getEntityQueryKey(newEntity.id!)\n      queryClient.setQueryData(entityDataQueryKey, newEntity)\n      queryClient.setQueryData<EntityLookupQueryData>(\n        keyFactory.getEntityLookupQueryKey({\n          parentId: newEntity.parentId,\n          entityName: newEntity.name,\n        }),\n        newEntity.id,\n      )\n      await invalidateAllQueriesForEntity(\n        queryClient,\n        keyFactory,\n        newEntity.id!,\n        entityDataQueryKey,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(newEntity, variables, ctx, ...rest)\n      }\n    },\n  })\n}\n\nexport function useUpdateEntity<T extends Entity>(\n  options?: Partial<UseMutationOptions<T, SynapseClientError, T>>,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<T, SynapseClientError, T>({\n    ...options,\n    mutationFn: (entity: T) =>\n      SynapseClient.updateEntity<T>(entity, accessToken),\n    onSuccess: async (updatedEntity, variables, ctx, ...rest) => {\n      const entityDataQueryKey = keyFactory.getEntityQueryKey(updatedEntity.id!)\n      queryClient.setQueryData(entityDataQueryKey, updatedEntity)\n      await invalidateAllQueriesForEntity(\n        queryClient,\n        keyFactory,\n        updatedEntity.id!,\n        entityDataQueryKey,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(updatedEntity, variables, ctx, ...rest)\n      }\n    },\n  })\n}\n\nexport function useDeleteEntity(\n  options?: Partial<\n    UseMutationOptions<string | undefined, SynapseClientError, string>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<string | undefined, SynapseClientError, string>({\n    ...options,\n    mutationFn: async (entityId: string) => {\n      const entity = await SynapseClient.getEntity<Entity>(\n        accessToken,\n        entityId,\n      )\n      await SynapseClient.deleteEntity(accessToken, entityId)\n      return entity.parentId\n    },\n    onSuccess: async (parentId, entityId, ctx, ...rest) => {\n      await invalidateAllQueriesForEntity(queryClient, keyFactory, entityId)\n      if (parentId) {\n        await invalidateAllQueriesForEntity(queryClient, keyFactory, parentId)\n      }\n      if (options?.onSuccess) {\n        await options.onSuccess(parentId, entityId, ctx, ...rest)\n      }\n    },\n  })\n}\n\nexport function useGetVersions(\n  entityId: string,\n  offset: number = 0,\n  limit: number = 200,\n  options?: Partial<\n    UseQueryOptions<PaginatedResults<VersionInfo>, SynapseClientError>\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getPaginatedEntityVersionsQueryKey(\n      entityId,\n      limit,\n      offset,\n    ),\n    queryFn: () =>\n      SynapseClient.getEntityVersions(entityId, accessToken, offset, limit),\n  })\n}\n\nexport function useGetVersionsInfinite<\n  TData = InfiniteData<PaginatedResults<VersionInfo>>,\n>(\n  entityId: string,\n  options: Partial<\n    UseInfiniteQueryOptions<\n      PaginatedResults<VersionInfo>,\n      SynapseClientError,\n      TData,\n      QueryKey,\n      number | undefined\n    >\n  >,\n) {\n  const LIMIT = 200\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useInfiniteQuery<\n    PaginatedResults<VersionInfo>,\n    SynapseClientError,\n    TData,\n    QueryKey,\n    number | undefined\n  >({\n    ...options,\n    queryKey: keyFactory.getEntityVersionsQueryKey(entityId),\n    queryFn: async context => {\n      return await SynapseClient.getEntityVersions(\n        entityId,\n        accessToken,\n        context.pageParam,\n        LIMIT,\n      )\n    },\n    initialPageParam: undefined,\n    getNextPageParam: getNextPageParamForPaginatedResults,\n  })\n}\n\nexport function getStandardEntityFields(json: EntityJson): EntityJson {\n  return pick(json, entityJsonKeys[json.concreteType]) as EntityJson\n}\n\nexport function removeStandardEntityFields(\n  json: EntityJson,\n): Record<\n  string,\n  string | number | boolean | string[] | number[] | boolean[] | undefined\n> {\n  return omit(json, entityJsonKeys[json.concreteType])\n}\n\n/**\n * This hook automatically transforms the data to include these objects:\n * - `entity`: the unmodified Entity data object\n * - `entityMetadata`: the standard entity fields contained in the JSON response\n * - `annotations`: the annotations contained in the JSON response\n *\n * The union of these objects would be equal in value to the `data` object.\n */\nexport function useGetJson(\n  entityId: string,\n  versionNumber: number | undefined,\n  includeDerivedAnnotations: boolean,\n  options?: Partial<UseQueryOptions<EntityJson, SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityJsonQueryKey(\n      entityId,\n      versionNumber,\n      includeDerivedAnnotations,\n    ),\n    queryFn: () =>\n      SynapseClient.getEntityJson(\n        entityId,\n        versionNumber,\n        includeDerivedAnnotations,\n        accessToken,\n      ),\n\n    select: data => {\n      // Separate the standard fields and annotations.\n      const entityMetadata = getStandardEntityFields(data)\n\n      const annotations = removeStandardEntityFields(data)\n\n      return {\n        entity: data,\n        entityMetadata,\n        annotations,\n      }\n    },\n  })\n}\n\nexport function useUpdateViaJson(\n  options?: Partial<\n    UseMutationOptions<EntityJson, SynapseClientError, EntityJson>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useMutation<EntityJson, SynapseClientError, EntityJson>({\n    ...options,\n    mutationFn: (json: EntityJson) => {\n      const entityId = json.id\n      return SynapseClient.updateEntityJson(entityId, json, accessToken)\n    },\n    onSuccess: async (data, variables, ctx, ...rest) => {\n      const entityId = data.id\n      // This annotation data will never include derived annotations, which are calculated by the backend asynchronously\n      const entityJsonQueryKey = keyFactory.getEntityJsonQueryKey(\n        entityId,\n        undefined,\n        false,\n      )\n      queryClient.setQueryData(entityJsonQueryKey, data)\n      await invalidateAllQueriesForEntity(\n        queryClient,\n        keyFactory,\n        entityId,\n        entityJsonQueryKey,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(data, variables, ctx, ...rest)\n      }\n    },\n  })\n}\n\nexport function useGetEntityPath(\n  entityId: string,\n  options?: Partial<UseQueryOptions<EntityPath, SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityPathQueryKey(entityId),\n    queryFn: () => SynapseClient.getEntityPath(entityId, accessToken),\n  })\n}\n\nexport function useGetEntityACL(\n  entityId: string,\n  options?: Partial<UseQueryOptions<AccessControlList, SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityPathQueryKey(entityId),\n    queryFn: () => SynapseClient.getEntityACL(entityId, accessToken),\n  })\n}\n\nexport function useGetEntityAlias(\n  alias: string,\n  options?: Partial<UseQueryOptions<EntityId | null, SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityAliasQueryKey(alias),\n    queryFn: () => SynapseClient.getEntityAlias(alias, accessToken),\n  })\n}\n\nexport function useGetEntityEvaluations(\n  entityId: string,\n  params?: GetEvaluationParameters,\n  options?: Partial<UseQueryOptions<Evaluation[] | null, SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityEvaluationsQueryKey(entityId),\n    queryFn: () =>\n      SynapseClient.getAllEntityEvaluations(entityId, params, accessToken),\n  })\n}\n\nexport function useGetEntityPermissions(\n  entityId: string,\n  options?: Partial<\n    UseQueryOptions<UserEntityPermissions | null, SynapseClientError>\n  >,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n  return useQuery({\n    ...options,\n    queryKey: keyFactory.getEntityPermissionsQueryKey(entityId),\n    queryFn: () => SynapseClient.getEntityPermissions(entityId, accessToken),\n  })\n}\n\nconst onMutateEntityAclSuccess = async (\n  entityId: string,\n  updatedACL: AccessControlList | null,\n  queryClient: QueryClient,\n  keyFactory: KeyFactory,\n) => {\n  const entityAclQueryKey = keyFactory.getEntityACLQueryKey(entityId)\n  if (updatedACL) {\n    queryClient.setQueryData(entityAclQueryKey, updatedACL)\n  }\n  await invalidateAllQueriesForEntity(\n    queryClient,\n    keyFactory,\n    entityId,\n    entityAclQueryKey,\n  )\n}\n\nexport function useCreateEntityACL(\n  options?: Partial<\n    UseMutationOptions<AccessControlList, SynapseClientError, AccessControlList>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<AccessControlList, SynapseClientError, AccessControlList>({\n    ...options,\n    mutationFn: (acl: AccessControlList) =>\n      SynapseClient.createEntityACL(acl, accessToken),\n    onSuccess: async (\n      updatedACL: AccessControlList,\n      variables,\n      ctx,\n      ...rest\n    ) => {\n      await onMutateEntityAclSuccess(\n        updatedACL.id,\n        updatedACL,\n        queryClient,\n        keyFactory,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(updatedACL, variables, ctx, ...rest)\n      }\n    },\n  })\n}\n\nexport function useUpdateEntityACL(\n  options?: Partial<\n    UseMutationOptions<AccessControlList, SynapseClientError, AccessControlList>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<AccessControlList, SynapseClientError, AccessControlList>({\n    ...options,\n    mutationFn: (acl: AccessControlList) =>\n      SynapseClient.updateEntityACL(acl, accessToken),\n    onSuccess: async (\n      updatedACL: AccessControlList,\n      variables,\n      ctx,\n      ...rest\n    ) => {\n      await onMutateEntityAclSuccess(\n        updatedACL.id,\n        updatedACL,\n        queryClient,\n        keyFactory,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(updatedACL, variables, ctx, ...rest)\n      }\n    },\n  })\n}\n\nexport function useDeleteEntityACL(\n  options?: Partial<UseMutationOptions<void, SynapseClientError, string>>,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<void, SynapseClientError, string>({\n    ...options,\n    mutationFn: (entityId: string) =>\n      SynapseClient.deleteEntityACL(entityId, accessToken),\n    onSuccess: async (result: void, entityId, ctx, ...rest) => {\n      await onMutateEntityAclSuccess(entityId, null, queryClient, keyFactory)\n\n      if (options?.onSuccess) {\n        await options.onSuccess(result, entityId, ctx, ...rest)\n      }\n    },\n  })\n}\n\nfunction useGetEntityBenefactorACLQueryOptions(\n  entityId: string,\n): UseSuspenseQueryOptions<\n  EntityBundle<{ includeBenefactorACL: true }>,\n  SynapseClientError,\n  AccessControlList\n> {\n  const selectBenefactorACL = (\n    data: EntityBundle<{ includeBenefactorACL: true }>,\n  ): AccessControlList => data.benefactorAcl\n  return useGetEntityBundleSuspenseQueryOptions<\n    { includeBenefactorACL: true },\n    AccessControlList\n  >(\n    entityId,\n    undefined,\n    {\n      includeBenefactorACL: true,\n    },\n    selectBenefactorACL,\n  )\n}\n\n/**\n * Retrieve the ACL of an entity. This call will succeed even for entities where the caller\n * does not have READ permission.\n * @param entityId\n * @param options\n */\nexport function useSuspenseGetEntityBenefactorACL(\n  entityId: string,\n  options?: Partial<\n    UseSuspenseQueryOptions<\n      EntityBundle<{ includeBenefactorACL: true }>,\n      SynapseClientError,\n      AccessControlList\n    >\n  >,\n) {\n  const queryOptions = useGetEntityBenefactorACLQueryOptions(entityId)\n  return useSuspenseQuery({\n    ...options,\n    ...queryOptions,\n  })\n}\n\ntype UpdateTableMutationRequest = {\n  entityId: string\n  originalColumnModels: ColumnModel[]\n  newColumnModels: SetOptional<ColumnModel, 'id'>[]\n}\n\nexport function useUpdateTableColumns(\n  options?: Partial<\n    UseMutationOptions<unknown, SynapseClientError, UpdateTableMutationRequest>\n  >,\n) {\n  const queryClient = useQueryClient()\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useMutation<unknown, SynapseClientError, UpdateTableMutationRequest>({\n    ...options,\n    mutationFn: async (request: UpdateTableMutationRequest) => {\n      // This call will create new column models as appropriate\n      const transactionRequest = await createTableUpdateTransactionRequest(\n        accessToken!,\n        request.entityId,\n        request.originalColumnModels,\n        request.newColumnModels,\n      )\n\n      return SynapseClient.updateTable(transactionRequest, accessToken)\n    },\n    onSuccess: async (response, variables, ctx, ...rest) => {\n      await invalidateAllQueriesForEntity(\n        queryClient,\n        keyFactory,\n        variables.entityId,\n      )\n\n      if (options?.onSuccess) {\n        await options.onSuccess(response, variables, ctx, ...rest)\n      }\n    },\n  })\n}\n\ntype EntityLookupQueryData = string | null\nexport function useGetEntityLookupQueryOptions() {\n  const { keyFactory, synapseClient } = useSynapseContext()\n  return (\n    entityLookupRequest: EntityLookupRequest,\n  ): UseQueryOptions<EntityLookupQueryData, SynapseClientError> =>\n    queryOptions<EntityLookupQueryData, SynapseClientError>({\n      queryKey: keyFactory.getEntityLookupQueryKey(entityLookupRequest),\n      queryFn: async () =>\n        (\n          await allowNotFoundError(() =>\n            synapseClient.entityServicesClient.postRepoV1EntityChild({\n              entityLookupRequest: entityLookupRequest,\n            }),\n          )\n        )?.id ?? null,\n    })\n}\n"],"mappings":";;;;;;;;;;;;AAqDA,SAAgB,IAA6C;CAC3D,IAAM,EAAE,eAAY,mBAAgB,EAAkB;CACtD,QACE,GACA,MAEA,EAAoC;EAClC,UAAU,EAAW,yBAAyB,GAAU,CAAa;EACrE,SAAS,UAEH,EAAc,UACZ,GACA,GACA,GAAe,SAAS,CAC1B,IACF;CACN,CAAC;AACL;AAEA,SAAgB,EACd,GACA,GACA,GACA;CACA,IAAM,IAAwB,EAA4B;CAC1D,OAAO,EAAS;EACd,GAAG;EACH,GAAG,EAAsB,GAAU,CAAa;CAClD,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CAqBtD,OAAO,EApBS,SACP,EACL,SAAS,EAAc,KAAI,OAClB;EACL,UAAU,EAAW,yBACnB,EAAO,IACP,EAAO,aACT;EACA,eACE,EAAc,UACZ,GACA,EAAO,IACP,EAAO,aACT;EACF;CACF,EACD,EACH,IACA;EAAC;EAAa;EAAe;EAAY;CAAO,CAEhC,CAAO;AAC3B;AAEA,SAAgB,EACd,GAKA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAIL;EACA,aAAa,MACX,EAAc,aAAa,GAAQ,CAAW;EAChD,WAAW,OAAO,GAAW,GAAW,GAAK,GAAG,MAAS;GACvD,IAAM,IAAqB,EAAW,kBAAkB,EAAU,EAAG;GAgBrE,AAfA,EAAY,aAAa,GAAoB,CAAS,GACtD,EAAY,aACV,EAAW,wBAAwB;IACjC,UAAU,EAAU;IACpB,YAAY,EAAU;GACxB,CAAC,GACD,EAAU,EACZ,GACA,MAAM,EACJ,GACA,GACA,EAAU,IACV,CACF,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAW,GAAW,GAAK,GAAG,CAAI;EAE9D;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GACA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAAsC;EAC3C,GAAG;EACH,aAAa,MACX,EAAc,aAAgB,GAAQ,CAAW;EACnD,WAAW,OAAO,GAAe,GAAW,GAAK,GAAG,MAAS;GAC3D,IAAM,IAAqB,EAAW,kBAAkB,EAAc,EAAG;GASzE,AARA,EAAY,aAAa,GAAoB,CAAa,GAC1D,MAAM,EACJ,GACA,GACA,EAAc,IACd,CACF,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAe,GAAW,GAAK,GAAG,CAAI;EAElE;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GAGA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAA4D;EACjE,GAAG;EACH,YAAY,OAAO,MAAqB;GACtC,IAAM,IAAS,MAAM,EAAc,UACjC,GACA,CACF;GAEA,OADA,MAAM,EAAc,aAAa,GAAa,CAAQ,GAC/C,EAAO;EAChB;EACA,WAAW,OAAO,GAAU,GAAU,GAAK,GAAG,MAAS;GAKrD,AAJA,MAAM,EAA8B,GAAa,GAAY,CAAQ,GACjE,KACF,MAAM,EAA8B,GAAa,GAAY,CAAQ,GAEnE,GAAS,aACX,MAAM,EAAQ,UAAU,GAAU,GAAU,GAAK,GAAG,CAAI;EAE5D;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GACA,IAAiB,GACjB,IAAgB,KAChB,GAGA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,mCACnB,GACA,GACA,CACF;EACA,eACE,EAAc,kBAAkB,GAAU,GAAa,GAAQ,CAAK;CACxE,CAAC;AACH;AAEA,SAAgB,EAGd,GACA,GASA;CACA,IACM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAML;EACA,GAAG;EACH,UAAU,EAAW,0BAA0B,CAAQ;EACvD,SAAS,OAAM,MACN,MAAM,EAAc,kBACzB,GACA,GACA,EAAQ,WACR,GACF;EAEF,kBAAkB,KAAA;EAClB,kBAAkB;CACpB,CAAC;AACH;AAEA,SAAgB,EAAwB,GAA8B;CACpE,OAAO,EAAK,GAAM,EAAe,EAAK,aAAa;AACrD;AAEA,SAAgB,EACd,GAIA;CACA,OAAO,EAAK,GAAM,EAAe,EAAK,aAAa;AACrD;AAUA,SAAgB,EACd,GACA,GACA,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,sBACnB,GACA,GACA,CACF;EACA,eACE,EAAc,cACZ,GACA,GACA,GACA,CACF;EAEF,SAAQ,OAMC;GACL,QAAQ;GACR,gBANqB,EAAwB,CAM7C;GACA,aALkB,EAA2B,CAK7C;EACF;CAEJ,CAAC;AACH;AAEA,SAAgB,EACd,GAGA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAwD;EAC7D,GAAG;EACH,aAAa,MAAqB;GAChC,IAAM,IAAW,EAAK;GACtB,OAAO,EAAc,iBAAiB,GAAU,GAAM,CAAW;EACnE;EACA,WAAW,OAAO,GAAM,GAAW,GAAK,GAAG,MAAS;GAClD,IAAM,IAAW,EAAK,IAEhB,IAAqB,EAAW,sBACpC,GACA,KAAA,GACA,EACF;GASA,AARA,EAAY,aAAa,GAAoB,CAAI,GACjD,MAAM,EACJ,GACA,GACA,GACA,CACF,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAM,GAAW,GAAK,GAAG,CAAI;EAEzD;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,sBAAsB,CAAQ;EACnD,eAAe,EAAc,cAAc,GAAU,CAAW;CAClE,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,sBAAsB,CAAQ;EACnD,eAAe,EAAc,aAAa,GAAU,CAAW;CACjE,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,uBAAuB,CAAK;EACjD,eAAe,EAAc,eAAe,GAAO,CAAW;CAChE,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,6BAA6B,CAAQ;EAC1D,eACE,EAAc,wBAAwB,GAAU,GAAQ,CAAW;CACvE,CAAC;AACH;AAEA,SAAgB,EACd,GACA,GAGA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CACtD,OAAO,EAAS;EACd,GAAG;EACH,UAAU,EAAW,6BAA6B,CAAQ;EAC1D,eAAe,EAAc,qBAAqB,GAAU,CAAW;CACzE,CAAC;AACH;AAEA,IAAM,IAA2B,OAC/B,GACA,GACA,GACA,MACG;CACH,IAAM,IAAoB,EAAW,qBAAqB,CAAQ;CAIlE,AAHI,KACF,EAAY,aAAa,GAAmB,CAAU,GAExD,MAAM,EACJ,GACA,GACA,GACA,CACF;AACF;AAEA,SAAgB,EACd,GAGA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAAsE;EAC3E,GAAG;EACH,aAAa,MACX,EAAc,gBAAgB,GAAK,CAAW;EAChD,WAAW,OACT,GACA,GACA,GACA,GAAG,MACA;GAQH,AAPA,MAAM,EACJ,EAAW,IACX,GACA,GACA,CACF,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAY,GAAW,GAAK,GAAG,CAAI;EAE/D;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GAGA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAAsE;EAC3E,GAAG;EACH,aAAa,MACX,EAAc,gBAAgB,GAAK,CAAW;EAChD,WAAW,OACT,GACA,GACA,GACA,GAAG,MACA;GAQH,AAPA,MAAM,EACJ,EAAW,IACX,GACA,GACA,CACF,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAY,GAAW,GAAK,GAAG,CAAI;EAE/D;CACF,CAAC;AACH;AAEA,SAAgB,EACd,GACA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAA8C;EACnD,GAAG;EACH,aAAa,MACX,EAAc,gBAAgB,GAAU,CAAW;EACrD,WAAW,OAAO,GAAc,GAAU,GAAK,GAAG,MAAS;GAGzD,AAFA,MAAM,EAAyB,GAAU,MAAM,GAAa,CAAU,GAElE,GAAS,aACX,MAAM,EAAQ,UAAU,GAAQ,GAAU,GAAK,GAAG,CAAI;EAE1D;CACF,CAAC;AACH;AAEA,SAAS,EACP,GAKA;CAIA,OAAO,EAIL,GACA,KAAA,GACA,EACE,sBAAsB,GACxB,IAVA,MACsB,EAAK,aAW7B;AACF;AAQA,SAAgB,EACd,GACA,GAOA;CACA,IAAM,IAAe,EAAsC,CAAQ;CACnE,OAAO,EAAiB;EACtB,GAAG;EACH,GAAG;CACL,CAAC;AACH;AAQA,SAAgB,EACd,GAGA;CACA,IAAM,IAAc,EAAe,GAC7B,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAAqE;EAC1E,GAAG;EACH,YAAY,OAAO,MAAwC;GAEzD,IAAM,IAAqB,MAAM,EAC/B,GACA,EAAQ,UACR,EAAQ,sBACR,EAAQ,eACV;GAEA,OAAO,EAAc,YAAY,GAAoB,CAAW;EAClE;EACA,WAAW,OAAO,GAAU,GAAW,GAAK,GAAG,MAAS;GAOtD,AANA,MAAM,EACJ,GACA,GACA,EAAU,QACZ,GAEI,GAAS,aACX,MAAM,EAAQ,UAAU,GAAU,GAAW,GAAK,GAAG,CAAI;EAE7D;CACF,CAAC;AACH;AAGA,SAAgB,IAAiC;CAC/C,IAAM,EAAE,eAAY,qBAAkB,EAAkB;CACxD,QACE,MAEA,EAAwD;EACtD,UAAU,EAAW,wBAAwB,CAAmB;EAChE,SAAS,aAEL,MAAM,QACJ,EAAc,qBAAqB,sBAAsB,EAClC,uBACvB,CAAC,CACH,IACC,MAAM;CACb,CAAC;AACL"}

package/dist/synapse-queries/entity/useExportToADWorkbench.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useExportToADWorkbench.d.ts","sourceRoot":"","sources":["../../../src/synapse-queries/entity/useExportToADWorkbench.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,kBAAkB,EAClB,YAAY,EACb,MAAM,iCAAiC,CAAA;AAGxC,wBAAgB,sBAAsB,CACpC,kBAAkB,EAAE,kBAAkB,EACtC,aAAa,CAAC,EAAE,YAAY,EAAE,EAC9B,gBAAgB,GAAE,MAAa,EAC/B,kBAAkB,GAAE,MAAe,EACnC,qBAAqB,GAAE,MAAyB,uBAyCjD"}
+{"version":3,"file":"useExportToADWorkbench.d.ts","sourceRoot":"","sources":["../../../src/synapse-queries/entity/useExportToADWorkbench.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,kBAAkB,EAClB,YAAY,EACb,MAAM,iCAAiC,CAAA;AAGxC,wBAAgB,sBAAsB,CACpC,kBAAkB,EAAE,kBAAkB,EACtC,aAAa,CAAC,EAAE,YAAY,EAAE,EAC9B,gBAAgB,GAAE,MAAa,EAC/B,kBAAkB,GAAE,MAAe,EACnC,qBAAqB,GAAE,MAAyB,uBA0CjD"}

package/dist/synapse-queries/entity/useExportToADWorkbench.js

@@ -16,7 +16,8 @@ function a(a, o, s = "id", c = "name", l = "currentVersion") {
 				writeHeader: !0,
 				includeRowIdAndRowVersion: !1,
 				csvTableDescriptor: { separator: "," },
-				additionalFilters: a.query.additionalFilters
+				additionalFilters: a.query.additionalFilters,
+				cohorts: a.query.cohorts
 			}, f = await t.createTableCsvForDownload(r, u), p = `https://adwb-ws-transfer.discover.alzheimersdata.org/?DRS_URI=${encodeURIComponent(`drs://repo-prod.prod.sagebase.org/fh${f.resultsFileHandleId}`)}`;
 			window.open(p, "_blank");
 		} catch (t) {