@gen3/core 0.10.44

package/dist/dts/features/authz/authzMappingSlice.d.ts

@@ -0,0 +1,141 @@
+import { type AuthzMapping } from './types';
+/**
+ * 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.
+ */
+export declare const authzApi: import("@reduxjs/toolkit/dist/query").Api<import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, {
+    getAuthzMappings: import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, AuthzMapping, "gen3Services">;
+}, "gen3Services", never, keyof import("@reduxjs/toolkit/dist/query").ApiModules<any, any, any, any>>;
+export declare const useGetAuthzMappingsQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, AuthzMapping, "gen3Services">>;
+export declare const selectAuthzMapping: (state: import("@reduxjs/toolkit/dist/query/core/apiState").RootState<{
+    getAuthzMappings: import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, AuthzMapping, "gen3Services">;
+}, never, "gen3Services">) => ({
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.uninitialized;
+    originalArgs?: undefined;
+    data?: undefined;
+    error?: undefined;
+    requestId?: undefined;
+    endpointName?: string | undefined;
+    startedTimeStamp?: undefined;
+    fulfilledTimeStamp?: undefined;
+} & {
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.uninitialized;
+    isUninitialized: true;
+    isLoading: false;
+    isSuccess: false;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.fulfilled;
+    error: undefined;
+    requestId: string;
+    originalArgs: void;
+    endpointName: string;
+    startedTimeStamp: number;
+    data: AuthzMapping;
+    fulfilledTimeStamp: number;
+} & {
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.fulfilled;
+    isUninitialized: false;
+    isLoading: false;
+    isSuccess: true;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.pending;
+    originalArgs: void;
+    requestId: string;
+    data?: AuthzMapping | undefined;
+    error?: import("@reduxjs/toolkit").SerializedError | import("@reduxjs/toolkit/dist/query").FetchBaseQueryError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number | undefined;
+} & {
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.pending;
+    isUninitialized: false;
+    isLoading: true;
+    isSuccess: false;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.rejected;
+    data?: AuthzMapping | undefined;
+    requestId: string;
+    fulfilledTimeStamp?: number | undefined;
+    originalArgs: void;
+    endpointName: string;
+    startedTimeStamp: number;
+    error: import("@reduxjs/toolkit").SerializedError | import("@reduxjs/toolkit/dist/query").FetchBaseQueryError;
+} & {
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.rejected;
+    isUninitialized: false;
+    isLoading: false;
+    isSuccess: false;
+    isError: true;
+});
+export declare const selectAuthzMappingData: ((state: import("@reduxjs/toolkit/dist/query/core/apiState").RootState<{
+    getAuthzMappings: import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, AuthzMapping, "gen3Services">;
+}, never, "gen3Services">) => AuthzMapping) & import("reselect").OutputSelectorFields<(args_0: ({
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.uninitialized;
+    originalArgs?: undefined;
+    data?: undefined;
+    error?: undefined;
+    requestId?: undefined;
+    endpointName?: string | undefined;
+    startedTimeStamp?: undefined;
+    fulfilledTimeStamp?: undefined;
+} & {
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.uninitialized;
+    isUninitialized: true;
+    isLoading: false;
+    isSuccess: false;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.fulfilled;
+    error: undefined;
+    requestId: string;
+    originalArgs: void;
+    endpointName: string;
+    startedTimeStamp: number;
+    data: AuthzMapping;
+    fulfilledTimeStamp: number;
+} & {
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.fulfilled;
+    isUninitialized: false;
+    isLoading: false;
+    isSuccess: true;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.pending;
+    originalArgs: void;
+    requestId: string;
+    data?: AuthzMapping | undefined;
+    error?: import("@reduxjs/toolkit").SerializedError | import("@reduxjs/toolkit/dist/query").FetchBaseQueryError | undefined;
+    endpointName: string;
+    startedTimeStamp: number;
+    fulfilledTimeStamp?: number | undefined;
+} & {
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.pending;
+    isUninitialized: false;
+    isLoading: true;
+    isSuccess: false;
+    isError: false;
+}) | ({
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.rejected;
+    data?: AuthzMapping | undefined;
+    requestId: string;
+    fulfilledTimeStamp?: number | undefined;
+    originalArgs: void;
+    endpointName: string;
+    startedTimeStamp: number;
+    error: import("@reduxjs/toolkit").SerializedError | import("@reduxjs/toolkit/dist/query").FetchBaseQueryError;
+} & {
+    status: import("@reduxjs/toolkit/dist/query").QueryStatus.rejected;
+    isUninitialized: false;
+    isLoading: false;
+    isSuccess: false;
+    isError: true;
+})) => AuthzMapping, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};

package/dist/dts/features/authz/index.d.ts

@@ -0,0 +1,3 @@
+import { type AuthzMapping, type ServiceAndMethod } from './types';
+import { useGetAuthzMappingsQuery, selectAuthzMappingData } from './authzMappingSlice';
+export { useGetAuthzMappingsQuery, selectAuthzMappingData, type AuthzMapping, type ServiceAndMethod, };

package/dist/dts/features/authz/types.d.ts

@@ -0,0 +1,5 @@
+export interface ServiceAndMethod {
+    method: string;
+    service: string;
+}
+export type AuthzMapping = Record<string, ServiceAndMethod[]>;

package/dist/dts/features/cohort/cohortSlice.d.ts

@@ -0,0 +1,95 @@
+import { Draft, type PayloadAction } from '@reduxjs/toolkit';
+import type { CoreState } from '../../reducers';
+import { Operation, FilterSet, IndexedFilterSet } from '../filters';
+export interface Cohort {
+    readonly id: string;
+    readonly name: string;
+    readonly filters: IndexedFilterSet;
+    readonly modified?: boolean;
+    readonly modified_datetime: string;
+}
+export interface CohortState {
+    cohort: Cohort;
+}
+interface UpdateFilterParams {
+    index: string;
+    field: string;
+    filter: Operation;
+}
+interface RemoveFilterParams {
+    index: string;
+    field: string;
+}
+interface ClearAllFilterParams {
+    index: string;
+}
+/**
+ * Redux slice for cohort filters
+ */
+export declare const cohortSlice: import("@reduxjs/toolkit").Slice<CohortState, {
+    updateCohortFilter: (state: Draft<CohortState>, action: PayloadAction<UpdateFilterParams>) => {
+        cohort: {
+            filters: {
+                [x: string]: import("immer/dist/internal.js").WritableDraft<FilterSet> | {
+                    mode: "and" | "or";
+                    root: {
+                        [x: string]: Operation | import("immer/dist/internal.js").WritableDraft<import("../filters").Intersection> | import("immer/dist/internal.js").WritableDraft<import("../filters").Union> | import("immer/dist/internal.js").WritableDraft<import("../filters").Includes> | import("immer/dist/internal.js").WritableDraft<import("../filters").Equals> | import("immer/dist/internal.js").WritableDraft<import("../filters").NotEquals> | import("immer/dist/internal.js").WritableDraft<import("../filters").LessThan> | import("immer/dist/internal.js").WritableDraft<import("../filters").LessThanOrEquals> | import("immer/dist/internal.js").WritableDraft<import("../filters").GreaterThan> | import("immer/dist/internal.js").WritableDraft<import("../filters").GreaterThanOrEquals> | import("immer/dist/internal.js").WritableDraft<import("../filters").NestedFilter> | import("immer/dist/internal.js").WritableDraft<import("../filters").ExcludeIfAny> | import("immer/dist/internal.js").WritableDraft<import("../filters").Excludes>;
+                    };
+                };
+            };
+            id: string;
+            name: string;
+            modified?: boolean | undefined;
+            modified_datetime: string;
+        };
+    };
+    removeCohortFilter: (state: Draft<CohortState>, action: PayloadAction<RemoveFilterParams>) => {
+        cohort: {
+            filters: {
+                [x: string]: import("immer/dist/internal.js").WritableDraft<FilterSet> | {
+                    mode: "and" | "or";
+                    root: {
+                        [x: string]: import("immer/dist/internal.js").WritableDraft<import("../filters").Intersection> | import("immer/dist/internal.js").WritableDraft<import("../filters").Union> | import("immer/dist/internal.js").WritableDraft<import("../filters").Includes> | import("immer/dist/internal.js").WritableDraft<import("../filters").Equals> | import("immer/dist/internal.js").WritableDraft<import("../filters").NotEquals> | import("immer/dist/internal.js").WritableDraft<import("../filters").LessThan> | import("immer/dist/internal.js").WritableDraft<import("../filters").LessThanOrEquals> | import("immer/dist/internal.js").WritableDraft<import("../filters").GreaterThan> | import("immer/dist/internal.js").WritableDraft<import("../filters").GreaterThanOrEquals> | import("immer/dist/internal.js").WritableDraft<import("../filters").NestedFilter> | import("immer/dist/internal.js").WritableDraft<import("../filters").ExcludeIfAny> | import("immer/dist/internal.js").WritableDraft<import("../filters").Excludes>;
+                    };
+                };
+            };
+            id: string;
+            name: string;
+            modified?: boolean | undefined;
+            modified_datetime: string;
+        };
+    } | undefined;
+    clearCohortFilters: (state: Draft<CohortState>, action: PayloadAction<ClearAllFilterParams>) => {
+        cohort: {
+            filters: {
+                [x: string]: FilterSet | import("immer/dist/internal.js").WritableDraft<FilterSet>;
+            };
+            id: string;
+            name: string;
+            modified?: boolean | undefined;
+            modified_datetime: string;
+        };
+    };
+}, "cohort">;
+export declare const updateCohortFilter: import("@reduxjs/toolkit").ActionCreatorWithPayload<UpdateFilterParams, "cohort/updateCohortFilter">, removeCohortFilter: import("@reduxjs/toolkit").ActionCreatorWithPayload<RemoveFilterParams, "cohort/removeCohortFilter">, clearCohortFilters: import("@reduxjs/toolkit").ActionCreatorWithPayload<ClearAllFilterParams, "cohort/clearCohortFilters">;
+export declare const selectCohortFilters: (state: CoreState) => IndexedFilterSet;
+export declare const selectCurrentCohortId: (state: CoreState) => string;
+export declare const selectCurrentCohort: (state: CoreState) => Cohort;
+export declare const selectCurrentCohortName: (state: CoreState) => string;
+/**
+ * Select a filter by its name from the current cohort. If the filter is not found
+ * returns undefined.
+ * @param state - Core
+ * @param index which cohort index to select from
+ * @param name name of the filter to select
+ */
+export declare const selectIndexedFilterByName: (state: CoreState, index: string, name: string) => Operation | undefined;
+/**
+ * Select a filter from the index.
+ * returns undefined.
+ * @param state - Core
+ * @param index which cohort index to select from
+ */
+export declare const selectIndexFilters: (state: CoreState, index: string) => FilterSet;
+export declare const cohortReducer: import("redux").Reducer<CohortState>;
+export {};

package/dist/dts/features/cohort/index.d.ts

@@ -0,0 +1,2 @@
+import { cohortReducer, selectCohortFilters, selectIndexFilters, selectIndexedFilterByName, selectCurrentCohortId, selectCurrentCohortName, selectCurrentCohort, updateCohortFilter, removeCohortFilter, clearCohortFilters } from './cohortSlice';
+export { selectCohortFilters, selectIndexFilters, selectIndexedFilterByName, selectCurrentCohortId, selectCurrentCohortName, selectCurrentCohort, cohortReducer, updateCohortFilter, removeCohortFilter, clearCohortFilters, };

package/dist/dts/features/download/constants.d.ts

@@ -0,0 +1,14 @@
+export declare const BATCH_EXPORT_JOB_PREFIX = "batch-export";
+export declare const GUID_PREFIX_PATTERN: RegExp;
+export declare const DOWNLOAD_UNAUTHORIZED_MESSAGE = "Unable to authorize download. Please refresh the page and ensure you are logged in.";
+export declare const DOWNLOAD_STARTED_MESSAGE: string;
+export declare const DOWNLOAD_SUCCEEDED_MESSAGE = "Your download has been prepared. If your download doesn't start automatically, please follow this direct link:";
+export declare const JOB_POLLING_INTERVAL = 5000;
+export declare const DOWNLOAD_FAIL_STATUS: {
+    inProgress: boolean;
+    message: {
+        title: string;
+        content: string;
+        active: boolean;
+    };
+};

package/dist/dts/features/download/downloadStatusApi.d.ts

@@ -0,0 +1,19 @@
+import { DownloadStatus, JobStatus } from './types';
+import { FetchArgs } from '@reduxjs/toolkit/query/react';
+export interface DownloadStatusResponse {
+    downloadStatus: DownloadStatus;
+}
+type JobListResponse = Array<JobStatus>;
+/**
+ * Creates a loadingStatusApi for checking the status of a sower data download job
+ * @param getJobList Shows the list of jobs currently running
+ *  @see https://petstore.swagger.io/?url=https://raw.githubusercontent.com/uc-cdis/sower/master/openapis/openapi.yaml#/sower/list
+ * @param getDownloadStatus Shows the status of a selected job
+ * @returns: A sower job response dict which returns job information of file downloads
+ */
+export declare const loadingStatusApi: import("@reduxjs/toolkit/query/react").Api<import("@reduxjs/toolkit/query/react").BaseQueryFn<string | FetchArgs, unknown, import("@reduxjs/toolkit/query/react").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query/react").FetchBaseQueryMeta>, {
+    getJobList: import("@reduxjs/toolkit/query/react").QueryDefinition<void, import("@reduxjs/toolkit/query/react").BaseQueryFn<string | FetchArgs, unknown, import("@reduxjs/toolkit/query/react").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query/react").FetchBaseQueryMeta>, never, JobListResponse, "gen3Services">;
+    getDownloadStatus: import("@reduxjs/toolkit/query/react").QueryDefinition<string | FetchArgs, import("@reduxjs/toolkit/query/react").BaseQueryFn<string | FetchArgs, unknown, import("@reduxjs/toolkit/query/react").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query/react").FetchBaseQueryMeta>, never, DownloadStatus, "gen3Services">;
+}, "gen3Services", never, keyof import("@reduxjs/toolkit/query/react").ApiModules<any, any, any, any>>;
+export declare const useGetJobListQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query/react").QueryDefinition<void, import("@reduxjs/toolkit/query/react").BaseQueryFn<string | FetchArgs, unknown, import("@reduxjs/toolkit/query/react").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query/react").FetchBaseQueryMeta>, never, JobListResponse, "gen3Services">>, useGetDownloadStatusQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query/react").QueryDefinition<string | FetchArgs, import("@reduxjs/toolkit/query/react").BaseQueryFn<string | FetchArgs, unknown, import("@reduxjs/toolkit/query/react").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query/react").FetchBaseQueryMeta>, never, DownloadStatus, "gen3Services">>;
+export {};

package/dist/dts/features/download/index.d.ts

@@ -0,0 +1,2 @@
+import { useGetJobListQuery, useGetDownloadStatusQuery } from './downloadStatusApi';
+export { useGetJobListQuery, useGetDownloadStatusQuery };

package/dist/dts/features/download/types.d.ts

@@ -0,0 +1,20 @@
+export interface JobStatus {
+    uid: string;
+    status: 'Running' | 'Completed' | 'Failed' | 'Unknown';
+    name: string;
+}
+export interface JobOutput {
+    output: string;
+}
+export interface DownloadStatus {
+    inProgress: boolean;
+    uid: string;
+    message: {
+        content: string | {
+            msg: string;
+            url: string;
+        };
+        active: boolean;
+        title: string;
+    };
+}

package/dist/dts/features/drsResolver/drsHostnameSlice.d.ts

@@ -0,0 +1,5 @@
+import { CoreState } from '../../reducers';
+export type DRSHostnameMap = Record<string, string>;
+export declare const drsHostnamesReducer: import("redux").Reducer<Record<string, string>>;
+export declare const setDRSHostnames: import("@reduxjs/toolkit").ActionCreatorWithPayload<DRSHostnameMap, "drsResolver/setDRSHostnames">;
+export declare const drsHostnamesSelector: (id: string, state: CoreState) => string;

package/dist/dts/features/drsResolver/index.d.ts

@@ -0,0 +1,2 @@
+import { drsHostnamesReducer, setDRSHostnames } from './drsHostnameSlice';
+export { drsHostnamesReducer, setDRSHostnames };

package/dist/dts/features/drsResolver/resolvers/cachedDRSResolver.d.ts

@@ -0,0 +1 @@
+export declare const resolveCachedDRS: (guidsForHostnameResolution: string[]) => Promise<Record<string, string>>;

package/dist/dts/features/drsResolver/resolvers/dataGUIDSDotOrg.d.ts

@@ -0,0 +1,6 @@
+/**
+ *  Resolves DRS object ID from a list of guids using dataguids.org
+ *  Use of this function should be limited
+ * @param guidsForHostnameResolution
+ */
+export declare const resolveDRSWithDataGUISOrg: (guidsForHostnameResolution: string[]) => Promise<Record<string, string>>;

package/dist/dts/features/drsResolver/resolvers/tests/dataGUIDSDotOrg.unit.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/dts/features/drsResolver/utils.d.ts

@@ -0,0 +1,6 @@
+declare enum DRSResolverType {
+    dataGUISOrg = "dataGUISOrg",
+    cached = "cached"
+}
+export declare const resolveDRSObjectId: (guidsForHostnameResolution: string[], resolver?: DRSResolverType) => Promise<Record<string, string>>;
+export {};

package/dist/dts/features/fence/credentialsApi.d.ts

@@ -0,0 +1,35 @@
+export interface APIKey {
+    readonly jti: string;
+    readonly exp: number;
+}
+export interface Gen3FenceCredentials {
+    readonly jtis: ReadonlyArray<APIKey>;
+}
+interface DeleteCredentialParams {
+    readonly csrfToken?: string;
+    readonly id: string;
+}
+interface AuthorizeFromCredentialsParams {
+    api_key: string;
+    key_id: string;
+}
+export interface AuthTokenResponse {
+    access_token: string;
+}
+/**
+ * Adds a credentialsApi into the base gen3Api
+ * @endpoints Includes get, add, and remove credential operations
+ *  @see https://github.com/uc-cdis/fence/blob/master/openapis/swagger.yaml#L972-L1033
+ *  @param getCredentials - List all the API keys for the current user
+ *  @param addNewCredential - Get a new API key for the current user
+ *  @param removeCredential - Delete API access key with given ID for current user
+ * @returns: A fence credential API for manipulating user credentials
+ */
+export declare const credentialsApi: import("@reduxjs/toolkit/dist/query").Api<import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, import("@reduxjs/toolkit/dist/query/endpointDefinitions").UpdateDefinitions<{}, "Credentials", never> & {
+    getCredentials: import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, "Credentials", readonly APIKey[], "gen3Services">;
+    addNewCredential: import("@reduxjs/toolkit/dist/query").MutationDefinition<string, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, "Credentials", any, "gen3Services">;
+    removeCredential: import("@reduxjs/toolkit/dist/query").MutationDefinition<DeleteCredentialParams, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, "Credentials", void, "gen3Services">;
+    authorizeFromCredentials: import("@reduxjs/toolkit/dist/query").MutationDefinition<AuthorizeFromCredentialsParams, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, "Credentials", AuthTokenResponse, "gen3Services">;
+}, "gen3Services", "Credentials", keyof import("@reduxjs/toolkit/dist/query").ApiModules<any, any, any, any>>;
+export declare const useGetCredentialsQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, "Credentials", readonly APIKey[], "gen3Services">>, useAddNewCredentialMutation: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseMutation<import("@reduxjs/toolkit/dist/query").MutationDefinition<string, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, "Credentials", any, "gen3Services">>, useRemoveCredentialMutation: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseMutation<import("@reduxjs/toolkit/dist/query").MutationDefinition<DeleteCredentialParams, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, "Credentials", void, "gen3Services">>, useAuthorizeFromCredentialsMutation: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseMutation<import("@reduxjs/toolkit/dist/query").MutationDefinition<AuthorizeFromCredentialsParams, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, "Credentials", AuthTokenResponse, "gen3Services">>;
+export {};

package/dist/dts/features/fence/fenceApi.d.ts

@@ -0,0 +1,37 @@
+export interface NameUrl {
+    readonly name: string;
+    readonly url: string;
+}
+export interface Gen3LoginProvider {
+    readonly desc?: string;
+    readonly id: string;
+    readonly idp: string;
+    readonly name: string;
+    readonly secondary: boolean;
+    readonly url: string;
+    readonly urls: Array<NameUrl>;
+}
+export interface Gen3FenceLoginProviders {
+    readonly default_provider: Gen3LoginProvider;
+    readonly providers: Array<Gen3LoginProvider>;
+}
+/**
+ * Creates a fence API endpoint for handling login processes
+ * @param endpoints - defined endpoint query for logging in
+ * @returns: The generated fence login API slice
+ */
+export declare const loginProvidersApi: import("@reduxjs/toolkit/dist/query").Api<import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, {
+    getLoginProviders: import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, Gen3FenceLoginProviders, "gen3Services">;
+}, "gen3Services", never, keyof import("@reduxjs/toolkit/dist/query").ApiModules<any, any, any, any>>;
+export declare const useGetLoginProvidersQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, never, Gen3FenceLoginProviders, "gen3Services">>;
+export interface FetchRequest {
+    readonly endpoint: string;
+    readonly method?: 'GET' | 'POST';
+    readonly body?: object;
+    readonly headers?: Record<string, string>;
+    readonly isJSON?: boolean;
+}
+/**
+ * Logout from fence
+ */
+export declare const logoutFence: (redirect?: string) => Promise<import("./types").Gen3FenceResponse<unknown>>;

package/dist/dts/features/fence/index.d.ts

@@ -0,0 +1,6 @@
+import { type FetchRequest, type Gen3LoginProvider, type NameUrl, logoutFence, useGetLoginProvidersQuery } from './fenceApi';
+import { type APIKey, type Gen3FenceCredentials, useGetCredentialsQuery, useAddNewCredentialMutation, useRemoveCredentialMutation, useAuthorizeFromCredentialsMutation } from './credentialsApi';
+import { useGetJWKKeysQuery } from './jwtApi';
+import { FetchError, Gen3FenceResponse } from './types';
+import { fetchFence } from './utils';
+export { type Gen3FenceResponse, type FetchError, type FetchRequest, type APIKey, type Gen3FenceCredentials, type Gen3LoginProvider, type NameUrl, fetchFence, logoutFence, useGetCredentialsQuery, useAddNewCredentialMutation, useRemoveCredentialMutation, useGetLoginProvidersQuery, useGetJWKKeysQuery, useAuthorizeFromCredentialsMutation, };

package/dist/dts/features/fence/jwtApi.d.ts

@@ -0,0 +1,12 @@
+export interface JWTKeys {
+    keys: ReadonlyArray<string[2]>;
+}
+/**
+ * A fence API for getting the public keys which can be used to validate
+ * JWTs issued and signed by fence
+ * @returns: Fence public keys
+ */
+export declare const jwtApi: import("@reduxjs/toolkit/dist/query").Api<import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, import("@reduxjs/toolkit/dist/query/endpointDefinitions").UpdateDefinitions<{}, "fenceJWT", never> & {
+    getJWKKeys: import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, "fenceJWT", readonly JWTKeys[], "gen3Services">;
+}, "gen3Services", "fenceJWT", keyof import("@reduxjs/toolkit/dist/query").ApiModules<any, any, any, any>>;
+export declare const useGetJWKKeysQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/dist/query").QueryDefinition<void, import("@reduxjs/toolkit/dist/query").BaseQueryFn<string | import("@reduxjs/toolkit/dist/query").FetchArgs, unknown, import("@reduxjs/toolkit/dist/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/dist/query").FetchBaseQueryMeta>, "fenceJWT", readonly JWTKeys[], "gen3Services">>;

package/dist/dts/features/fence/types.d.ts

@@ -0,0 +1,12 @@
+import { JSONObject } from '../../types';
+export interface FetchError<T> {
+    readonly url: string;
+    readonly status: number;
+    readonly statusText: string;
+    readonly text: string;
+    readonly request?: T;
+}
+export interface Gen3FenceResponse<H = JSONObject | string> {
+    readonly data: H;
+    readonly status: number;
+}

package/dist/dts/features/fence/utils.d.ts

@@ -0,0 +1,12 @@
+import { FetchError, Gen3FenceResponse } from './types';
+import { FetchRequest } from './fenceApi';
+/**
+ * Template for fence error response dict
+ * @returns: An error dict response from a RESTFUL API request
+ */
+export declare const buildFetchError: <T>(res: Response, request?: T) => Promise<FetchError<T>>;
+/**
+ * Template for a standard fence request
+ * @returns: response data
+ */
+export declare const fetchFence: <T>({ endpoint, headers, body, method, isJSON, }: FetchRequest) => Promise<Gen3FenceResponse<T>>;

package/dist/dts/features/filters/filters.d.ts

@@ -0,0 +1,122 @@
+import { EnumFilterValue, Equals, ExcludeIfAny, Excludes, FilterSet, FilterValue, GreaterThan, GreaterThanOrEquals, Includes, Intersection, LessThan, LessThanOrEquals, NestedFilter, NotEquals, Operation, OperationHandler, OperationWithField, Union } from './types';
+export declare const isOperationWithField: (operation: OperationWithField | Operation) => operation is OperationWithField;
+export declare const extractFilterValue: (op: Operation) => FilterValue;
+export declare const extractEnumFilterValue: (op: Operation) => EnumFilterValue;
+export declare const handleOperation: <T>(handler: OperationHandler<T>, op: Operation) => T;
+/**
+ * Return true if a FilterSet's root value is an empty object
+ * @param fs - FilterSet to test
+ */
+export declare const isFilterEmpty: (fs: FilterSet) => boolean;
+export interface FilterGroup {
+    readonly filterIndex: number;
+    readonly filter: FilterSet;
+}
+export interface GQLEqual {
+    '=': {
+        [key: string]: string | number;
+    };
+}
+export interface GQLNotEqual {
+    '!=': {
+        [key: string]: string | number;
+    };
+}
+export interface GQLLessThan {
+    '<': {
+        [key: string]: string | number;
+    };
+}
+export interface GQLLessThanOrEquals {
+    '<=': {
+        [key: string]: string | number;
+    };
+}
+export interface GQLGreaterThan {
+    '>': {
+        [key: string]: string | number;
+    };
+}
+export interface GQLGreaterThanOrEquals {
+    '>=': {
+        [key: string]: string | number;
+    };
+}
+export interface GQLIncludes {
+    in: {
+        [key: string]: ReadonlyArray<string | number>;
+    };
+}
+export interface GQLExcludes {
+    exclude: {
+        [key: string]: ReadonlyArray<string | number>;
+    };
+}
+export interface GQLExcludeIfAny {
+    excludeifany: {
+        [key: string]: ReadonlyArray<string | number>;
+    };
+}
+export interface GQLIntersection {
+    and: ReadonlyArray<GQLFilter>;
+}
+export interface GQLUnion {
+    or: ReadonlyArray<GQLFilter>;
+}
+type NestedContents = GQLFilter & {
+    path: string;
+};
+export interface GQLNestedFilter {
+    nested: NestedContents;
+}
+export type GQLFilter = GQLEqual | GQLNotEqual | GQLLessThan | GQLLessThanOrEquals | GQLGreaterThan | GQLGreaterThanOrEquals | GQLIncludes | GQLExcludes | GQLExcludeIfAny | GQLIntersection | GQLUnion | GQLNestedFilter;
+export declare class ToGqlHandler implements OperationHandler<GQLFilter> {
+    handleEquals: (op: Equals) => GQLEqual;
+    handleNotEquals: (op: NotEquals) => GQLNotEqual;
+    handleLessThan: (op: LessThan) => GQLLessThan;
+    handleLessThanOrEquals: (op: LessThanOrEquals) => GQLLessThanOrEquals;
+    handleGreaterThan: (op: GreaterThan) => GQLGreaterThan;
+    handleGreaterThanOrEquals: (op: GreaterThanOrEquals) => GQLGreaterThanOrEquals;
+    handleIncludes: (op: Includes) => GQLIncludes;
+    handleExcludes: (op: Excludes) => GQLExcludes;
+    handleExcludeIfAny: (op: ExcludeIfAny) => GQLExcludeIfAny;
+    handleIntersection: (op: Intersection) => GQLIntersection;
+    handleUnion: (op: Union) => GQLUnion;
+    handleNestedFilter: (op: NestedFilter) => GQLNestedFilter;
+}
+export declare const convertFilterSetToGqlFilter: (fs: FilterSet, toplevelOp?: "and" | "or") => GQLFilter;
+/**
+ * Extract the operand values, if operands themselves have values,  otherwise undefined.
+ */
+export declare class ValueExtractorHandler implements OperationHandler<FilterValue> {
+    handleEquals: (op: Equals) => string | number;
+    handleNotEquals: (op: NotEquals) => string | number;
+    handleIncludes: (op: Includes) => ReadonlyArray<string | number>;
+    handleExcludes: (op: Excludes) => ReadonlyArray<string | number>;
+    handleExcludeIfAny: (op: ExcludeIfAny) => ReadonlyArray<string | number>;
+    handleGreaterThanOrEquals: (op: GreaterThanOrEquals) => string | number;
+    handleGreaterThan: (op: GreaterThan) => string | number;
+    handleLessThan: (op: LessThan) => string | number;
+    handleLessThanOrEquals: (op: LessThanOrEquals) => string | number;
+    handleIntersection: (op: Intersection) => undefined;
+    handleUnion: (op: Union) => undefined;
+    handleNestedFilter: (op: NestedFilter) => undefined;
+}
+/**
+ * Extract the operand values, if operands themselves have values,  otherwise undefined.
+ */
+export declare class EnumValueExtractorHandler implements OperationHandler<EnumFilterValue | undefined> {
+    handleEquals: (_: Equals) => undefined;
+    handleNotEquals: (_: NotEquals) => undefined;
+    handleIncludes: (op: Includes) => ReadonlyArray<string | number>;
+    handleExcludes: (op: Excludes) => ReadonlyArray<string | number>;
+    handleExcludeIfAny: (op: ExcludeIfAny) => ReadonlyArray<string | number>;
+    handleGreaterThanOrEquals: (_: GreaterThanOrEquals) => undefined;
+    handleGreaterThan: (_: GreaterThan) => undefined;
+    handleLessThan: (op: LessThan) => undefined;
+    handleLessThanOrEquals: (op: LessThanOrEquals) => undefined;
+    handleIntersection: (op: Intersection) => undefined;
+    handleUnion: (op: Union) => undefined;
+    handleNestedFilter: (op: NestedFilter) => EnumFilterValue | undefined;
+}
+export {};

package/dist/dts/features/filters/index.d.ts

@@ -0,0 +1,4 @@
+import { isFilterEmpty, isOperationWithField, convertFilterSetToGqlFilter, handleOperation, extractEnumFilterValue, extractFilterValue, type GQLFilter } from './filters';
+export * from './types';
+export * from './utils';
+export { handleOperation, isFilterEmpty, isOperationWithField, convertFilterSetToGqlFilter, extractFilterValue, extractEnumFilterValue, type GQLFilter, };

package/dist/dts/features/filters/tests/utils.unit.test.d.ts

@@ -0,0 +1 @@
+export {};