climb-onyx-gui 0.13.0 → 0.14.0-dev.10

package/dist/api/hooks.d.ts

@@ -0,0 +1,11 @@
+import { ChoicesResponse, ErrorResponse, FieldsResponse, ProjectField } from '../types';
+
+declare const useFieldsInfo: (fieldsResponse: FieldsResponse | ErrorResponse) => {
+    name: string;
+    description: string;
+    fields: Map<string, ProjectField>;
+    descriptions: Map<string, string>;
+};
+declare const useChoiceDescriptions: (data: ChoicesResponse | ErrorResponse) => Map<string, string>;
+declare const useChoicesDescriptions: (fields: string[], data: (ChoicesResponse | ErrorResponse)[]) => Map<string, Map<string, string>>;
+export { useChoiceDescriptions, useChoicesDescriptions, useFieldsInfo };

package/dist/api/index.d.ts

@@ -0,0 +1,64 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { OnyxProps, ProjectProps } from '../interfaces';
+import { DetailResponse, ErrorResponse, GraphConfig, ListResponse } from '../types';
+
+interface ChoiceProps extends ProjectProps {
+    field: string;
+}
+interface ChoicesProps extends ProjectProps {
+    fields: string[];
+}
+interface IDProps extends ProjectProps {
+    searchPath?: string;
+    ID: string;
+}
+interface QueryProps extends ProjectProps {
+    searchPath: string;
+    searchParameters: string;
+}
+interface GraphQueryProps extends ProjectProps {
+    graphConfig: GraphConfig;
+}
+/** Fetch types */
+declare const useTypesQuery: (props: OnyxProps) => UseQueryResult<any, unknown>;
+/** Fetch lookups */
+declare const useLookupsQuery: (props: OnyxProps) => UseQueryResult<any, unknown>;
+/** Fetch user profile */
+declare const useProfileQuery: (props: OnyxProps) => UseQueryResult<any, unknown>;
+/** Fetch user project permissions */
+declare const useProjectPermissionsQuery: (props: OnyxProps) => UseQueryResult<any, unknown>;
+/** Fetch project fields */
+declare const useProjectFieldsQuery: (props: ProjectProps) => UseQueryResult<any, unknown>;
+/** Fetch analysis fields */
+declare const useAnalysisFieldsQuery: (props: ProjectProps) => UseQueryResult<any, unknown>;
+/** Fetch choices for a field */
+declare const useChoicesQuery: (props: ChoiceProps) => UseQueryResult<any, unknown>;
+/** Fetch choices for multiple fields */
+declare const useChoicesQueries: (props: ChoicesProps) => UseQueryResult<any, unknown>[];
+/** Fetch user activity */
+declare const useActivityQuery: (props: OnyxProps) => UseQueryResult<any, unknown>;
+/** Fetch site users */
+declare const useSiteUsersQuery: (props: OnyxProps) => UseQueryResult<any, unknown>;
+/** Fetch history from ID */
+declare const useHistoryQuery: (props: IDProps) => UseQueryResult<any, unknown>;
+/** Fetch record from record ID */
+declare const useRecordQuery: (props: IDProps) => UseQueryResult<DetailResponse | ErrorResponse, Error>;
+/** Fetch record analyses from record ID */
+declare const useRecordAnalysesQuery: (props: IDProps) => UseQueryResult<any, unknown>;
+/** Fetch analysis from analysis ID */
+declare const useAnalysisQuery: (props: IDProps) => UseQueryResult<DetailResponse | ErrorResponse, Error>;
+/** Fetch analysis records from analysis ID */
+declare const useAnalysisRecordsQuery: (props: IDProps) => UseQueryResult<any, unknown>;
+/** Fetch upstream analyses from analysis ID */
+declare const useAnalysisUpstreamQuery: (props: IDProps) => UseQueryResult<ListResponse | ErrorResponse, Error>;
+/** Fetch downstream analyses from analysis ID */
+declare const useAnalysisDownstreamQuery: (props: IDProps) => UseQueryResult<ListResponse | ErrorResponse, Error>;
+/** Fetch results from path and search parameters */
+declare const useResultsQuery: (props: QueryProps) => UseQueryResult<any, unknown>;
+/** Fetch count from path and search parameters */
+declare const useCountQuery: (props: QueryProps) => UseQueryResult<any, unknown>;
+/** Fetch summary from project and field */
+declare const useSummaryQuery: (props: GraphQueryProps) => UseQueryResult<any, unknown>;
+/** Fetch grouped summary from project, field, and groupBy */
+declare const useGroupedSummaryQuery: (props: GraphQueryProps) => UseQueryResult<any, unknown>;
+export { useActivityQuery, useAnalysisDownstreamQuery, useAnalysisFieldsQuery, useAnalysisQuery, useAnalysisRecordsQuery, useAnalysisUpstreamQuery, useChoicesQueries, useChoicesQuery, useCountQuery, useGroupedSummaryQuery, useHistoryQuery, useLookupsQuery, useProfileQuery, useProjectFieldsQuery, useProjectPermissionsQuery, useRecordAnalysesQuery, useRecordQuery, useResultsQuery, useSiteUsersQuery, useSummaryQuery, useTypesQuery, };