synapse-react-client 4.0.41 → 4.0.42

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 { 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.\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 * Initiate the DocuSign routing for a data access request's eDUC.\n * @see POST /repo/v1/dataAccessRequest/{requestId}/signature\n */\nexport function useInitiateDataAccessRequestSignature(\n  options?: UseMutationOptions<EDucSignatureQuota, SynapseClientError, string>,\n) {\n  const { synapseClient } = useSynapseContext()\n  const queryClient = useQueryClient()\n  const { keyFactory } = useSynapseContext()\n\n  return useMutation<EDucSignatureQuota, SynapseClientError, string>({\n    ...options,\n    mutationFn: (requestId: string) =>\n      synapseClient.dataAccessServicesClient.postRepoV1DataAccessRequestRequestIdSignature(\n        { requestId },\n      ),\n    onSuccess: async (data, requestId, ctx) => {\n      await Promise.all([\n        queryClient.invalidateQueries({\n          queryKey: keyFactory.getDataAccessRequestSignatureQueryKey(requestId),\n        }),\n        queryClient.invalidateQueries({\n          queryKey: keyFactory.getDataAccessRequestQueryKey(),\n        }),\n      ])\n      if (options?.onSuccess) {\n        return options.onSuccess(data, requestId, 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<void, SynapseClientError, string>,\n) {\n  const { synapseClient } = useSynapseContext()\n  const queryClient = useQueryClient()\n  const { keyFactory } = useSynapseContext()\n\n  return useMutation<void, SynapseClientError, string>({\n    ...options,\n    mutationFn: (requestId: string) =>\n      synapseClient.dataAccessServicesClient.deleteRepoV1DataAccessRequestRequestIdSignature(\n        { requestId },\n      ),\n    onSuccess: async (data, requestId, ctx) => {\n      await Promise.all([\n        queryClient.invalidateQueries({\n          queryKey: keyFactory.getDataAccessRequestSignatureQueryKey(requestId),\n        }),\n        queryClient.invalidateQueries({\n          queryKey: keyFactory.getDataAccessRequestQueryKey(),\n        }),\n      ])\n      if (options?.onSuccess) {\n        return options.onSuccess(data, requestId, ctx)\n      }\n      return\n    },\n  })\n}\n"],"mappings":";;;;AA8BA,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;AAMA,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;AAMA,SAAgB,EACd,GACA;CACA,IAAM,EAAE,qBAAkB,EAAkB,GACtC,IAAc,EAAe,GAC7B,EAAE,kBAAe,EAAkB;CAEzC,OAAO,EAA4D;EACjE,GAAG;EACH,aAAa,MACX,EAAc,yBAAyB,8CACrC,EAAE,aAAU,CACd;EACF,WAAW,OAAO,GAAM,GAAW,MAAQ;GASzC,IARA,MAAM,QAAQ,IAAI,CAChB,EAAY,kBAAkB,EAC5B,UAAU,EAAW,sCAAsC,CAAS,EACtE,CAAC,GACD,EAAY,kBAAkB,EAC5B,UAAU,EAAW,6BAA6B,EACpD,CAAC,CACH,CAAC,GACG,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,CAAG;EAGjD;CACF,CAAC;AACH;AAMA,SAAgB,EACd,GACA;CACA,IAAM,EAAE,qBAAkB,EAAkB,GACtC,IAAc,EAAe,GAC7B,EAAE,kBAAe,EAAkB;CAEzC,OAAO,EAA8C;EACnD,GAAG;EACH,aAAa,MACX,EAAc,yBAAyB,gDACrC,EAAE,aAAU,CACd;EACF,WAAW,OAAO,GAAM,GAAW,MAAQ;GASzC,IARA,MAAM,QAAQ,IAAI,CAChB,EAAY,kBAAkB,EAC5B,UAAU,EAAW,sCAAsC,CAAS,EACtE,CAAC,GACD,EAAY,kBAAkB,EAC5B,UAAU,EAAW,6BAA6B,EACpD,CAAC,CACH,CAAC,GACG,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.\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 * Initiate the DocuSign routing for a data access request's eDUC.\n * @see POST /repo/v1/dataAccessRequest/{requestId}/signature\n */\nexport function useInitiateDataAccessRequestSignature(\n  options?: UseMutationOptions<EDucSignatureQuota, SynapseClientError, string>,\n) {\n  const { synapseClient } = useSynapseContext()\n  const queryClient = useQueryClient()\n  const { keyFactory } = useSynapseContext()\n\n  return useMutation<EDucSignatureQuota, SynapseClientError, string>({\n    ...options,\n    mutationFn: (requestId: string) =>\n      synapseClient.dataAccessServicesClient.postRepoV1DataAccessRequestRequestIdSignature(\n        { requestId },\n      ),\n    onSuccess: async (data, requestId, ctx) => {\n      await Promise.all([\n        queryClient.invalidateQueries({\n          queryKey: keyFactory.getDataAccessRequestSignatureQueryKey(requestId),\n        }),\n        queryClient.invalidateQueries({\n          queryKey: keyFactory.getDataAccessRequestQueryKey(),\n        }),\n      ])\n      if (options?.onSuccess) {\n        return options.onSuccess(data, requestId, 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<EDucSignatureStatus, SynapseClientError, string>,\n) {\n  const { keyFactory, synapseClient } = useSynapseContext()\n  const queryClient = useQueryClient()\n\n  return useMutation<EDucSignatureStatus, SynapseClientError, string>({\n    ...options,\n    mutationFn: (requestId: string) =>\n      synapseClient.dataAccessServicesClient.putRepoV1DataAccessRequestRequestIdSignature(\n        { requestId },\n      ),\n    onSuccess: async (data, requestId, ctx) => {\n      await Promise.all([\n        queryClient.invalidateQueries({\n          queryKey: keyFactory.getDataAccessRequestSignatureQueryKey(requestId),\n        }),\n        queryClient.invalidateQueries({\n          queryKey: keyFactory.getDataAccessRequestQueryKey(),\n        }),\n      ])\n      if (options?.onSuccess) {\n        return options.onSuccess(data, requestId, 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<void, SynapseClientError, string>,\n) {\n  const { synapseClient } = useSynapseContext()\n  const queryClient = useQueryClient()\n  const { keyFactory } = useSynapseContext()\n\n  return useMutation<void, SynapseClientError, string>({\n    ...options,\n    mutationFn: (requestId: string) =>\n      synapseClient.dataAccessServicesClient.deleteRepoV1DataAccessRequestRequestIdSignature(\n        { requestId },\n      ),\n    onSuccess: async (data, requestId, ctx) => {\n      await Promise.all([\n        queryClient.invalidateQueries({\n          queryKey: keyFactory.getDataAccessRequestSignatureQueryKey(requestId),\n        }),\n        queryClient.invalidateQueries({\n          queryKey: keyFactory.getDataAccessRequestQueryKey(),\n        }),\n      ])\n      if (options?.onSuccess) {\n        return options.onSuccess(data, requestId, 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;AAMA,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;AAMA,SAAgB,EACd,GACA;CACA,IAAM,EAAE,qBAAkB,EAAkB,GACtC,IAAc,EAAe,GAC7B,EAAE,kBAAe,EAAkB;CAEzC,OAAO,EAA4D;EACjE,GAAG;EACH,aAAa,MACX,EAAc,yBAAyB,8CACrC,EAAE,aAAU,CACd;EACF,WAAW,OAAO,GAAM,GAAW,MAAQ;GASzC,IARA,MAAM,QAAQ,IAAI,CAChB,EAAY,kBAAkB,EAC5B,UAAU,EAAW,sCAAsC,CAAS,EACtE,CAAC,GACD,EAAY,kBAAkB,EAC5B,UAAU,EAAW,6BAA6B,EACpD,CAAC,CACH,CAAC,GACG,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,GACA;CACA,IAAM,EAAE,eAAY,qBAAkB,EAAkB,GAClD,IAAc,EAAe;CAEnC,OAAO,EAA6D;EAClE,GAAG;EACH,aAAa,MACX,EAAc,yBAAyB,6CACrC,EAAE,aAAU,CACd;EACF,WAAW,OAAO,GAAM,GAAW,MAAQ;GASzC,IARA,MAAM,QAAQ,IAAI,CAChB,EAAY,kBAAkB,EAC5B,UAAU,EAAW,sCAAsC,CAAS,EACtE,CAAC,GACD,EAAY,kBAAkB,EAC5B,UAAU,EAAW,6BAA6B,EACpD,CAAC,CACH,CAAC,GACG,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,CAAG;EAGjD;CACF,CAAC;AACH;AAMA,SAAgB,EACd,GACA;CACA,IAAM,EAAE,qBAAkB,EAAkB,GACtC,IAAc,EAAe,GAC7B,EAAE,kBAAe,EAAkB;CAEzC,OAAO,EAA8C;EACnD,GAAG;EACH,aAAa,MACX,EAAc,yBAAyB,gDACrC,EAAE,aAAU,CACd;EACF,WAAW,OAAO,GAAM,GAAW,MAAQ;GASzC,IARA,MAAM,QAAQ,IAAI,CAChB,EAAY,kBAAkB,EAC5B,UAAU,EAAW,sCAAsC,CAAS,EACtE,CAAC,GACD,EAAY,kBAAkB,EAC5B,UAAU,EAAW,6BAA6B,EACpD,CAAC,CACH,CAAC,GACG,GAAS,WACX,OAAO,EAAQ,UAAU,GAAM,GAAW,CAAG;EAGjD;CACF,CAAC;AACH"}

package/dist/synapse-queries/file/useDirectUploadToS3.js

@@ -1,17 +1,17 @@
 import { calculateMd5 as e } from "../../synapse-client/SynapseClient.js";
-import { uploadToS3 as t } from "./UploadToS3.js";
-import { useCreateExternalFileHandle as n } from "./useFileHandle.js";
+import { useCreateExternalFileHandle as t } from "./useFileHandle.js";
+import { uploadToS3 as n } from "./UploadToS3.js";
 import { useMutation as r } from "@tanstack/react-query";
 //#region src/synapse-queries/file/useDirectUploadToS3.ts
 function i(i) {
-	let { mutateAsync: a } = n();
+	let { mutateAsync: a } = t();
 	return r({
 		...i,
-		mutationFn: async (n) => {
-			let { accessKey: r, secretKey: i, bucketName: o, endpoint: s, fileName: c, contentType: l, blob: u, progressCallback: d, keyPrefixUUID: f, storageLocationId: p, onMd5Computed: m, abortController: h } = n, g = await e(u);
+		mutationFn: async (t) => {
+			let { accessKey: r, secretKey: i, bucketName: o, endpoint: s, fileName: c, contentType: l, blob: u, progressCallback: d, keyPrefixUUID: f, storageLocationId: p, onMd5Computed: m, abortController: h } = t, g = await e(u);
 			m && m();
 			let _ = `${f}/${c}`;
-			return await t(u, _, s, r, i, o, l, h, d), await a({ externalFileHandleInterface: {
+			return await n(u, _, s, r, i, o, l, h, d), await a({ externalFileHandleInterface: {
 				concreteType: "org.sagebionetworks.repo.model.file.ExternalObjectStoreFileHandle",
 				contentMd5: g,
 				contentSize: u.size,

package/dist/synapse-queries/file/useFileHandle.d.ts

@@ -1,3 +1,11 @@
 import { PostFileV1ExternalFileHandleRequest } from '@sage-bionetworks/synapse-client';
+import { SynapseClientError } from '@sage-bionetworks/synapse-client/util/SynapseClientError';
+import { FileHandle } from '@sage-bionetworks/synapse-types';
+import { UseQueryOptions } from '@tanstack/react-query';
 export declare function useCreateExternalFileHandle(): import("@tanstack/react-query").UseMutationResult<import("@sage-bionetworks/synapse-client").ExternalFileHandleInterface, Error, PostFileV1ExternalFileHandleRequest, unknown>;
+/**
+ * Get a file handle by its id. Synapse only serves a file handle that is not associated with an
+ * object to the user that created it.
+ */
+export declare function useGetCreatorFileHandle(fileHandleId: string, options?: Partial<UseQueryOptions<FileHandle, SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<FileHandle, SynapseClientError>;
 //# sourceMappingURL=useFileHandle.d.ts.map

package/dist/synapse-queries/file/useFileHandle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useFileHandle.d.ts","sourceRoot":"","sources":["../../../src/synapse-queries/file/useFileHandle.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mCAAmC,EAAE,MAAM,kCAAkC,CAAA;AAGtF,wBAAgB,2BAA2B,mLAO1C"}
+{"version":3,"file":"useFileHandle.d.ts","sourceRoot":"","sources":["../../../src/synapse-queries/file/useFileHandle.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mCAAmC,EAAE,MAAM,kCAAkC,CAAA;AAEtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,0DAA0D,CAAA;AAC7F,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAC5D,OAAO,EAAyB,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAE9E,wBAAgB,2BAA2B,mLAO1C;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC,kFASnE"}

package/dist/synapse-queries/file/useFileHandle.js

@@ -1,12 +1,21 @@
-import { useSynapseContext as e } from "../../utils/context/SynapseContext.js";
+import e from "../../synapse-client/index.js";
+import { useSynapseContext as t } from "../../utils/context/SynapseContext.js";
 import "../../utils/index.js";
-import { useMutation as t } from "@tanstack/react-query";
+import { useMutation as n, useQuery as r } from "@tanstack/react-query";
 //#region src/synapse-queries/file/useFileHandle.ts
-function n() {
-	let { synapseClient: n } = e();
-	return t({ mutationFn: (e) => n.fileServicesClient.postFileV1ExternalFileHandle(e) });
+function i() {
+	let { synapseClient: e } = t();
+	return n({ mutationFn: (t) => e.fileServicesClient.postFileV1ExternalFileHandle(t) });
+}
+function a(n, i) {
+	let { accessToken: a, keyFactory: o } = t();
+	return r({
+		...i,
+		queryKey: o.getFileHandleQueryKey(n),
+		queryFn: () => e.getFileHandleById(n, a)
+	});
 }
 //#endregion
-export { n as useCreateExternalFileHandle };
+export { i as useCreateExternalFileHandle, a as useGetCreatorFileHandle };
 
 //# sourceMappingURL=useFileHandle.js.map

package/dist/synapse-queries/file/useFileHandle.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFileHandle.js","names":[],"sources":["../../../src/synapse-queries/file/useFileHandle.ts"],"sourcesContent":["import { useSynapseContext } from '@/utils/index'\nimport { PostFileV1ExternalFileHandleRequest } from '@sage-bionetworks/synapse-client'\nimport { useMutation } from '@tanstack/react-query'\n\nexport function useCreateExternalFileHandle() {\n  const { synapseClient } = useSynapseContext()\n\n  return useMutation({\n    mutationFn: (args: PostFileV1ExternalFileHandleRequest) =>\n      synapseClient.fileServicesClient.postFileV1ExternalFileHandle(args),\n  })\n}\n"],"mappings":";;;;AAIA,SAAgB,IAA8B;CAC5C,IAAM,EAAE,qBAAkB,EAAkB;CAE5C,OAAO,EAAY,EACjB,aAAa,MACX,EAAc,mBAAmB,6BAA6B,CAAI,EACtE,CAAC;AACH"}
+{"version":3,"file":"useFileHandle.js","names":[],"sources":["../../../src/synapse-queries/file/useFileHandle.ts"],"sourcesContent":["import { useSynapseContext } from '@/utils/index'\nimport { PostFileV1ExternalFileHandleRequest } from '@sage-bionetworks/synapse-client'\nimport SynapseClient from '@/synapse-client'\nimport { SynapseClientError } from '@sage-bionetworks/synapse-client/util/SynapseClientError'\nimport { FileHandle } from '@sage-bionetworks/synapse-types'\nimport { useMutation, useQuery, UseQueryOptions } from '@tanstack/react-query'\n\nexport function useCreateExternalFileHandle() {\n  const { synapseClient } = useSynapseContext()\n\n  return useMutation({\n    mutationFn: (args: PostFileV1ExternalFileHandleRequest) =>\n      synapseClient.fileServicesClient.postFileV1ExternalFileHandle(args),\n  })\n}\n\n/**\n * Get a file handle by its id. Synapse only serves a file handle that is not associated with an\n * object to the user that created it.\n */\nexport function useGetCreatorFileHandle(\n  fileHandleId: string,\n  options?: Partial<UseQueryOptions<FileHandle, SynapseClientError>>,\n) {\n  const { accessToken, keyFactory } = useSynapseContext()\n\n  return useQuery<FileHandle, SynapseClientError>({\n    ...options,\n    queryKey: keyFactory.getFileHandleQueryKey(fileHandleId),\n    queryFn: () => SynapseClient.getFileHandleById(fileHandleId, accessToken),\n  })\n}\n"],"mappings":";;;;;AAOA,SAAgB,IAA8B;CAC5C,IAAM,EAAE,qBAAkB,EAAkB;CAE5C,OAAO,EAAY,EACjB,aAAa,MACX,EAAc,mBAAmB,6BAA6B,CAAI,EACtE,CAAC;AACH;AAMA,SAAgB,EACd,GACA,GACA;CACA,IAAM,EAAE,gBAAa,kBAAe,EAAkB;CAEtD,OAAO,EAAyC;EAC9C,GAAG;EACH,UAAU,EAAW,sBAAsB,CAAY;EACvD,eAAe,EAAc,kBAAkB,GAAc,CAAW;CAC1E,CAAC;AACH"}