@gen3/core 0.10.95 → 0.10.98

package/dist/cjs/index.js

@@ -97,6 +97,7 @@ const isFetchError = (obj)=>{
  */ const fetchFence = async ({ endpoint, headers, body = {}, method = 'GET', isJSON = true })=>{
     const res = await fetch(`${GEN3_FENCE_API}${endpoint}`, {
         method: method,
+        credentials: 'include',
         headers: headers,
         body: 'POST' === method ? JSON.stringify(body) : null
     });
@@ -189,6 +190,10 @@ const userAuthApi = react.createApi({
                             return {
                                 error: error
                             };
+                        } else {
+                            return {
+                                error: 'Unknown Error'
+                            };
                         }
                     }
                     return {
@@ -246,6 +251,9 @@ const selectHeadersWithCSRFToken = toolkit.createSelector([
             }
             if (csrfToken) headers.set('X-CSRF-Token', csrfToken);
             return headers;
+        },
+        validateStatus: (response)=>{
+            return response.status >= 200 && response.status < 300;
         }
     }),
     endpoints: ()=>({})
@@ -823,7 +831,8 @@ const newCohort = ({ filters = {}, customName })=>{
         filters: filters ?? {},
         modified: false,
         saved: false,
-        modified_datetime: ts.toISOString()
+        modified_datetime: ts.toISOString(),
+        counts: {}
     };
 };
 const createCohortId = ()=>toolkit.nanoid();
@@ -1497,6 +1506,22 @@ const fetchFencePresignedURL = async ({ guid, method = 'GET', onAbort = ()=>null
     return await response.json();
 };
 
+/**
+ * Converts HistogramData to HistogramDataAsStringKey by ensuring the key is a string.
+ * If the key is already a string, it's used as is.
+ * If the key is a number tuple [min, max], it's converted to a string in the format "min-max".
+ *
+ * @param data The HistogramData object to convert
+ * @returns HistogramDataAsStringKey with the converted key
+ */ const convertToHistogramDataAsStringKey = (data)=>{
+    return {
+        key: typeof data.key === 'string' ? data.key : `${data.key[0]}-${data.key[1]}`,
+        count: data.count
+    };
+};
+const calculatePercentageAsNumber = (count, total)=>count ? count / total * 100 : 0;
+const calculatePercentageAsString = (count, total)=>`${(count / total * 100).toFixed(2)}%`;
+
 const queryWTSFederatedLoginStatus = async (signal)=>{
     try {
         const results = await fetchJSONDataFromURL(`${GEN3_WTS_API}/external_oidc/`, false, HttpMethod.GET, undefined, signal);
@@ -1807,19 +1832,42 @@ const CoreProvider = ({ children })=>{
 // Add more endpoints here
 const { useAskQuestionMutation, useGetAISearchStatusQuery, useGetAISearchVersionQuery } = aiSearchApi;
 
+const TAGS$1 = 'authz';
+const authzTags = gen3Api.enhanceEndpoints({
+    addTagTypes: [
+        TAGS$1
+    ]
+});
 /**
  * Creates the authzApi for checking arborist permissions for a selected user
  * @see https://petstore.swagger.io/?url=https://raw.githubusercontent.com/uc-cdis/arborist/master/docs/openapi.yaml#/auth/get_auth_mapping
  * @see https://github.com/uc-cdis/arborist/blob/master/docs/relationships.simplified.png
  * @returns: An arborist response dict of user permissions {method, service} for each resource path.
- */ const authzApi = gen3Api.injectEndpoints({
+ */ const authzApi = authzTags.injectEndpoints({
     endpoints: (builder)=>({
             getAuthzMappings: builder.query({
                 query: ()=>`${GEN3_AUTHZ_API}/mapping`
+            }),
+            getAuthzResources: builder.query({
+                query: ()=>({
+                        url: `${GEN3_AUTHZ_API}/resources`,
+                        method: 'GET'
+                    })
+            }),
+            createAuthzResource: builder.mutation({
+                query: (request)=>({
+                        // url: `${GEN3_AUTHZ_API}/resources/${request.resourcePath}${request?.path ? `&p=${request.path}` : ''}`,
+                        url: `${GEN3_AUTHZ_API}/resources`,
+                        method: 'POST',
+                        body: request.data
+                    }),
+                invalidatesTags: [
+                    TAGS$1
+                ]
             })
         })
 });
-const { useGetAuthzMappingsQuery, useLazyGetAuthzMappingsQuery } = authzApi;
+const { useGetAuthzMappingsQuery, useLazyGetAuthzMappingsQuery, useGetAuthzResourcesQuery, useLazyGetAuthzResourcesQuery, useCreateAuthzResourceMutation } = authzApi;
 const selectAuthzMapping = authzApi.endpoints.getAuthzMappings.select();
 const selectAuthzMappingData = toolkit.createSelector(selectAuthzMapping, (authzMapping)=>authzMapping?.data ?? {
         mappings: []
@@ -2937,6 +2985,7 @@ const handleOperation = (handler, op)=>{
         case 'nested':
             return handler.handleNestedFilter(op);
         case 'in':
+        case 'includes':
             return handler.handleIncludes(op);
         case 'excludeifany':
             return handler.handleExcludeIfAny(op);
@@ -3091,6 +3140,9 @@ function isUnion(value) {
 function isIntersection(value) {
     return typeof value === 'object' && value !== null && value.operator === 'and' && Array.isArray(value.operands);
 }
+const isOperandsType = (operation)=>{
+    return operation?.operands !== undefined;
+};
 
 const FieldNameOverrides = {};
 const COMMON_PREPOSITIONS = [
@@ -3930,7 +3982,7 @@ const buildGetAggregationQuery = (type, fields, filters, accessibility = Accessi
     };
     return queryBody;
 };
-const { useGetRawDataAndTotalCountsQuery, useGetAccessibleDataQuery, useGetAllFieldsForTypeQuery, useGetAggsQuery, useGetAggsNoFilterSelfQuery, useLazyGetAggsQuery, useGetSubAggsQuery, useGetCountsQuery, useGetFieldCountSummaryQuery, useGetFieldsForIndexQuery, useGetSharedFieldsForIndexQuery, useGeneralGQLQuery, useLazyGeneralGQLQuery } = explorerApi;
+const { useGetRawDataAndTotalCountsQuery, useGetAccessibleDataQuery, useGetAllFieldsForTypeQuery, useGetAggsQuery, useGetAggsNoFilterSelfQuery, useLazyGetAggsQuery, useLazyGetAggsNoFilterSelfQuery, useGetSubAggsQuery, useGetCountsQuery, useGetFieldCountSummaryQuery, useGetFieldsForIndexQuery, useGetSharedFieldsForIndexQuery, useGeneralGQLQuery, useLazyGeneralGQLQuery } = explorerApi;
 
 /**
  * Creates a Guppy API for fetching bulk (> 10K rows) elasticsearch data
@@ -4210,6 +4262,178 @@ const queryMultipleMDSRecords = async (guids, useAggMDS = false, signal)=>{
     });
 };
 
+class MissingServiceConfigurationError extends Error {
+    constructor(serviceName){
+        super(`Missing service configuration for ${serviceName}`);
+        this.name = 'MissingServiceConfigurationError';
+    }
+}
+
+// Default console logger
+const defaultLogger = {
+    warn: (message)=>console.warn(message),
+    error: (message)=>console.error(message)
+};
+
+const DefaultRemoteSupportAction = async ()=>{
+    throw new Error('No remote support service registered for this service name');
+};
+class RemoteSupportServiceRegistry {
+    constructor(logger = defaultLogger){
+        this.services = new Map();
+        this.logger = logger;
+    }
+    /**
+   * Register a remote support service
+   * @param serviceName - Unique identifier for the service
+   * @param action - The action function to execute for this service
+   * @throws Error if serviceName or action is invalid
+   */ registerService(serviceName, action) {
+        if (!serviceName?.trim()) {
+            throw new Error('Service name cannot be empty or null');
+        }
+        if (typeof action !== 'function') {
+            throw new Error('Action must be a function');
+        }
+        if (this.services.has(serviceName)) {
+            this.logger.warn(`Service '${serviceName}' is already registered and will be overwritten.`);
+        }
+        this.services.set(serviceName, action);
+    }
+    /**
+   * Get a registered service action
+   * @param serviceName - The service identifier
+   * @returns The registered action or default action if not found
+   */ getSupportService(serviceName) {
+        if (!serviceName?.trim()) {
+            this.logger.error('Service name cannot be empty or null');
+            return DefaultRemoteSupportAction;
+        }
+        const service = this.services.get(serviceName);
+        if (!service) {
+            this.logger.warn(`Service '${serviceName}' not registered. Using default action.`);
+            throw new MissingServiceConfigurationError(serviceName);
+        }
+        return service;
+    }
+    /**
+   * Check if a service is registered
+   * @param serviceName - The service identifier
+   * @returns true if service is registered
+   */ hasService(serviceName) {
+        return this.services.has(serviceName);
+    }
+    /**
+   * Get all registered service names
+   * @returns Array of registered service names
+   */ getRegisteredServices() {
+        return Array.from(this.services.keys());
+    }
+    /**
+   * Unregister a service
+   * @param serviceName - The service identifier
+   * @returns true if service was removed, false if it wasn't registered
+   */ unregisterService(serviceName) {
+        return this.services.delete(serviceName);
+    }
+    /**
+   * Clear all registered services
+   */ clear() {
+        this.services.clear();
+    }
+    /**
+   * Get the number of registered services
+   */ size() {
+        return this.services.size;
+    }
+}
+let defaultRegistryInstance = null;
+function getRemoteSupportServiceRegistry(logger) {
+    if (!defaultRegistryInstance) {
+        defaultRegistryInstance = new RemoteSupportServiceRegistry(logger);
+    }
+    return defaultRegistryInstance;
+}
+
+const ZENDESK_MAX_SUBJECT_LENGTH = 255;
+const ZENDESK_DOMAIN = process.env.NEXT_PUBLIC_GEN3_ZENDESK_API || 'https://<SUBDOMAIN_NAME>.zendesk.com';
+const createZendeskTicket = async ({ subject, fullName, email, contents }, configuration)=>{
+    const { zendeskSubdomainName } = configuration;
+    try {
+        let zendeskTicketCreationURL = `${ZENDESK_DOMAIN}/api/v2/requests`;
+        if (zendeskSubdomainName) {
+            zendeskTicketCreationURL = zendeskTicketCreationURL.replace('<SUBDOMAIN_NAME>', zendeskSubdomainName);
+        } else {
+            // This is the default Gen3 helpdesk subdomain
+            zendeskTicketCreationURL = zendeskTicketCreationURL.replace('<SUBDOMAIN_NAME>', 'gen3support');
+        }
+        let ticketSubject = subject;
+        if (subject.length > ZENDESK_MAX_SUBJECT_LENGTH) {
+            ticketSubject = `${subject.substring(0, ZENDESK_MAX_SUBJECT_LENGTH - 3)}...`;
+        }
+        await fetch(zendeskTicketCreationURL, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify({
+                request: {
+                    subject: ticketSubject,
+                    comment: {
+                        body: contents
+                    },
+                    requester: {
+                        name: fullName,
+                        email
+                    }
+                }
+            })
+        }).then((response)=>{
+            if (response.status !== 201) {
+                throw new Error(`Request for create Zendesk ticket failed with status ${response.status}`);
+            }
+            return response;
+        });
+    } catch (err) {
+        throw new Error(`Request for create Zendesk ticket failed: ${err}`);
+    }
+};
+
+const registerDefaultRemoteSupport = ()=>{
+    const registry = getRemoteSupportServiceRegistry();
+    registry.registerService('zenDesk', createZendeskTicket);
+};
+
+/**
+ * Converts a Partial<RequestListQuery> object to a URL query string
+ * @param params - The parameters to convert
+ * @returns A formatted query string (including the leading '?')
+ */ const convertToQueryString = (params)=>{
+    if (!params || Object.keys(params).length === 0) {
+        return '';
+    }
+    const queryParts = [];
+    // Handle policy_ids array
+    if (params.policy_ids && params.policy_ids.length > 0) {
+        params.policy_ids.forEach((id)=>{
+            queryParts.push(`policy_id=${encodeURIComponent(id)}`);
+        });
+    }
+    if (params.resource_ids && params.resource_ids.length > 0) {
+        params.resource_ids.forEach((id)=>{
+            queryParts.push(`resource_id=${encodeURIComponent(id)}`);
+        });
+    }
+    // Handle status
+    if (params.status !== undefined) {
+        queryParts.push(`status=${encodeURIComponent(params.status)}`);
+    }
+    // Handle revoke
+    if (params.revoke !== undefined) {
+        queryParts.push(`revoke=${params.revoke}`);
+    }
+    return queryParts.length > 0 ? `?${queryParts.join('&')}` : undefined;
+};
 /**
  * Defines requester service using a base URL and expected endpoints. Derived from gen3Api core API.
  *
@@ -4218,9 +4442,30 @@ const queryMultipleMDSRecords = async (guids, useAggMDS = false, signal)=>{
  *    @see https://github.com/uc-cdis/requestor?tab=readme-ov-file#requestor
  *    @see https://petstore.swagger.io/?url=https://raw.githubusercontent.com/uc-cdis/requestor/master/docs/openapi.yaml#/Query/list_requests_request_get
  * @returns: Object of request made
- */ const requestorApi = gen3Api.injectEndpoints({
+ */ //TODO convert snakeCase yTpes o camelCase by adding transform respomse
+const requestorApi = gen3Api.injectEndpoints({
     endpoints: (builder)=>({
+            status: builder.query({
+                // get status of requestor service
+                query: ()=>`${GEN3_REQUESTOR_API}/_status`
+            }),
             request: builder.query({
+                query: (params)=>{
+                    const strParams = params ? convertToQueryString(params) : undefined;
+                    return `${GEN3_REQUESTOR_API}/request${strParams ?? ''}`;
+                }
+            }),
+            userRequest: builder.query({
+                // get a list of requests
+                query: (params)=>{
+                    const strParams = params ? convertToQueryString(params) : undefined;
+                    return `${GEN3_REQUESTOR_API}/request/user${strParams ?? ''}`;
+                }
+            }),
+            requestById: builder.query({
+                query: (requestId)=>`${GEN3_REQUESTOR_API}/request/${requestId}`
+            }),
+            createRequest: builder.mutation({
                 query: (queryBody)=>({
                         url: `${GEN3_REQUESTOR_API}/request`,
                         method: 'POST',
@@ -4234,7 +4479,7 @@ const queryMultipleMDSRecords = async (guids, useAggMDS = false, signal)=>{
             })
         })
 });
-const { useRequestQuery, useLazyRequestQuery } = requestorApi;
+const { useCreateRequestMutation, useRequestQuery, useLazyRequestQuery, useStatusQuery: useRequestorStatusQuery, useRequestByIdQuery, useUserRequestQuery } = requestorApi;
 
 /**
  * Creates a loadingStatusApi for checking the status of a sower data download job
@@ -4635,6 +4880,7 @@ exports.GEN3_WORKSPACE_API = GEN3_WORKSPACE_API;
 exports.HTTPError = HTTPError;
 exports.HTTPErrorMessages = HTTPErrorMessages;
 exports.HttpMethod = HttpMethod;
+exports.MissingServiceConfigurationError = MissingServiceConfigurationError;
 exports.Modals = Modals;
 exports.PodConditionType = PodConditionType;
 exports.PodStatus = PodStatus;
@@ -4643,11 +4889,15 @@ exports.WorkspaceStatus = WorkspaceStatus;
 exports.addNewDefaultUnsavedCohort = addNewDefaultUnsavedCohort;
 exports.buildGetAggregationQuery = buildGetAggregationQuery;
 exports.buildListItemsGroupedByDataset = buildListItemsGroupedByDataset;
+exports.calculatePercentageAsNumber = calculatePercentageAsNumber;
+exports.calculatePercentageAsString = calculatePercentageAsString;
 exports.clearActiveWorkspaceId = clearActiveWorkspaceId;
 exports.clearCohortFilters = clearCohortFilters;
 exports.cohortReducer = cohortReducer;
 exports.convertFilterSetToGqlFilter = convertFilterSetToGqlFilter;
 exports.convertFilterToGqlFilter = convertFilterToGqlFilter;
+exports.convertToHistogramDataAsStringKey = convertToHistogramDataAsStringKey;
+exports.convertToQueryString = convertToQueryString;
 exports.coreStore = coreStore;
 exports.createAppApiForRTKQ = createAppApiForRTKQ;
 exports.createAppStore = createAppStore;
@@ -4675,6 +4925,7 @@ exports.getCurrentTimestamp = getCurrentTimestamp;
 exports.getFederatedLoginStatus = getFederatedLoginStatus;
 exports.getGen3AppId = getGen3AppId;
 exports.getNumberOfItemsInDatalist = getNumberOfItemsInDatalist;
+exports.getRemoteSupportServiceRegistry = getRemoteSupportServiceRegistry;
 exports.getTimestamp = getTimestamp;
 exports.graphQLAPI = graphQLAPI;
 exports.graphQLWithTags = graphQLWithTags;
@@ -4715,6 +4966,7 @@ exports.isJSONValue = isJSONValue;
 exports.isJSONValueArray = isJSONValueArray;
 exports.isNotDefined = isNotDefined;
 exports.isObject = isObject;
+exports.isOperandsType = isOperandsType;
 exports.isOperationWithField = isOperationWithField;
 exports.isOperatorWithFieldAndArrayOfOperands = isOperatorWithFieldAndArrayOfOperands;
 exports.isPending = isPending;
@@ -4736,6 +4988,7 @@ exports.processHistogramResponse = processHistogramResponse;
 exports.projectCodeFromResourcePath = projectCodeFromResourcePath;
 exports.queryMultipleMDSRecords = queryMultipleMDSRecords;
 exports.rawDataQueryStrForEachField = rawDataQueryStrForEachField;
+exports.registerDefaultRemoteSupport = registerDefaultRemoteSupport;
 exports.removeCohort = removeCohort;
 exports.removeCohortFilter = removeCohortFilter;
 exports.requestorApi = requestorApi;
@@ -4804,6 +5057,8 @@ exports.useAskQuestionMutation = useAskQuestionMutation;
 exports.useAuthorizeFromCredentialsMutation = useAuthorizeFromCredentialsMutation;
 exports.useCoreDispatch = useCoreDispatch;
 exports.useCoreSelector = useCoreSelector;
+exports.useCreateAuthzResourceMutation = useCreateAuthzResourceMutation;
+exports.useCreateRequestMutation = useCreateRequestMutation;
 exports.useDataLibrary = useDataLibrary;
 exports.useDownloadFromGuppyMutation = useDownloadFromGuppyMutation;
 exports.useFetchUserDetailsQuery = useFetchUserDetailsQuery;
@@ -4818,6 +5073,7 @@ exports.useGetAggsQuery = useGetAggsQuery;
 exports.useGetAllFieldsForTypeQuery = useGetAllFieldsForTypeQuery;
 exports.useGetArrayTypes = useGetArrayTypes;
 exports.useGetAuthzMappingsQuery = useGetAuthzMappingsQuery;
+exports.useGetAuthzResourcesQuery = useGetAuthzResourcesQuery;
 exports.useGetCSRFQuery = useGetCSRFQuery;
 exports.useGetCohortManifestQuery = useGetCohortManifestQuery;
 exports.useGetCountsQuery = useGetCountsQuery;
@@ -4863,8 +5119,10 @@ exports.useIsUserLoggedIn = useIsUserLoggedIn;
 exports.useLaunchWorkspaceMutation = useLaunchWorkspaceMutation;
 exports.useLazyFetchUserDetailsQuery = useLazyFetchUserDetailsQuery;
 exports.useLazyGeneralGQLQuery = useLazyGeneralGQLQuery;
+exports.useLazyGetAggsNoFilterSelfQuery = useLazyGetAggsNoFilterSelfQuery;
 exports.useLazyGetAggsQuery = useLazyGetAggsQuery;
 exports.useLazyGetAuthzMappingsQuery = useLazyGetAuthzMappingsQuery;
+exports.useLazyGetAuthzResourcesQuery = useLazyGetAuthzResourcesQuery;
 exports.useLazyGetCSRFQuery = useLazyGetCSRFQuery;
 exports.useLazyGetCrosswalkDataQuery = useLazyGetCrosswalkDataQuery;
 exports.useLazyGetDownloadQuery = useLazyGetDownloadQuery;
@@ -4877,11 +5135,14 @@ exports.useLazyIsExternalConnectedQuery = useLazyIsExternalConnectedQuery;
 exports.useLazyRequestQuery = useLazyRequestQuery;
 exports.usePrevious = usePrevious;
 exports.useRemoveCredentialMutation = useRemoveCredentialMutation;
+exports.useRequestByIdQuery = useRequestByIdQuery;
 exports.useRequestQuery = useRequestQuery;
+exports.useRequestorStatusQuery = useRequestorStatusQuery;
 exports.useSetCurrentPayModelMutation = useSetCurrentPayModelMutation;
 exports.useSubmitSowerJobMutation = useSubmitSowerJobMutation;
 exports.useTerminateWorkspaceMutation = useTerminateWorkspaceMutation;
 exports.useUserAuth = useUserAuth;
+exports.useUserRequestQuery = useUserRequestQuery;
 exports.userHasCreateOrUpdateOnAnyProject = userHasCreateOrUpdateOnAnyProject;
 exports.userHasDataUpload = userHasDataUpload;
 exports.userHasMethodForServiceOnProject = userHasMethodForServiceOnProject;