The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
import type {
AddDataAppGroupsRequest,
DataApp,
DataAppGroup,
DataAppGroupPermissionWarning,
DataAppRepoStatus,
RemoveDataAppGroupRequest,
SetDataAppEnabledRequest,
} from "metabase-types/api";
import { EnterpriseApi } from "./api";
import { idTag, invalidateTags, listTag } from "./tags";
// Repo status is a single resource; tag it so it and the app list both refresh
// when a sync changes things.
const REPO_STATUS_TAG = idTag("data-app", "REPO-STATUS");
export const dataAppApi = EnterpriseApi.injectEndpoints({
endpoints: (builder) => ({
listDataApps: builder.query<DataApp[], void>({
query: () => ({
method: "GET",
url: "/api/ee/apps",
}),
providesTags: (apps = []) => [
listTag("data-app"),
...apps.map((app) => idTag("data-app", app.name)),
],
}),
getDataApp: builder.query<DataApp, string>({
query: (name) => ({
method: "GET",
url: `/api/ee/apps/${encodeURIComponent(name)}`,
}),
providesTags: (_, __, name) => [idTag("data-app", name)],
}),
getDataAppRepoStatus: builder.query<DataAppRepoStatus, void>({
query: () => ({
method: "GET",
url: "/api/ee/apps/repo-status",
}),
providesTags: () => [REPO_STATUS_TAG],
}),
getDataAppGroupPermissionWarnings: builder.query<
DataAppGroupPermissionWarning[],
string
>({
query: (name) => ({
method: "GET",
url: `/api/ee/apps/${encodeURIComponent(name)}/group-permission-warnings`,
}),
providesTags: (_, __, name) => [idTag("data-app", name)],
}),
getDataAppGroups: builder.query<DataAppGroup[], string>({
query: (name) => ({
method: "GET",
url: `/api/ee/apps/${encodeURIComponent(name)}/groups`,
}),
providesTags: (_, __, name) => [idTag("data-app", name)],
}),
addDataAppGroups: builder.mutation<DataAppGroup[], AddDataAppGroupsRequest>(
{
query: ({ name, group_ids }) => ({
method: "POST",
url: `/api/ee/apps/${encodeURIComponent(name)}/groups`,
body: { group_ids },
}),
async onQueryStarted({ name }, { dispatch, queryFulfilled }) {
try {
const { data: groups } = await queryFulfilled;
// pending group-permission-warnings request delays tag invalidation; after a
// successful add, replace the groups cache so new groups appear immediately.
dispatch(
dataAppApi.util.updateQueryData(
"getDataAppGroups",
name,
() => groups,
),
);
} catch {
return;
}
},
invalidatesTags: (_, error, { name }) =>
invalidateTags(error, [listTag("data-app"), idTag("data-app", name)]),
},
),
removeDataAppGroup: builder.mutation<void, RemoveDataAppGroupRequest>({
query: ({ name, group_id }) => ({
method: "DELETE",
url: `/api/ee/apps/${encodeURIComponent(name)}/groups/${group_id}`,
}),
async onQueryStarted({ name, group_id }, { dispatch, queryFulfilled }) {
try {
await queryFulfilled;
// pending group-permission-warnings request delays tag invalidation; after a
// successful removal, filter the group from the cache so it disappears immediately.
dispatch(
dataAppApi.util.updateQueryData(
"getDataAppGroups",
name,
(groups) => groups.filter((group) => group.id !== group_id),
),
);
} catch {
return;
}
},
invalidatesTags: (_, error, { name }) =>
invalidateTags(error, [listTag("data-app"), idTag("data-app", name)]),
}),
setDataAppEnabled: builder.mutation<DataApp, SetDataAppEnabledRequest>({
query: ({ name, enabled }) => ({
method: "PUT",
url: `/api/ee/apps/${encodeURIComponent(name)}`,
body: { enabled },
}),
invalidatesTags: (_, error, { name }) =>
invalidateTags(error, [listTag("data-app"), idTag("data-app", name)]),
}),
}),
});
export const {
useListDataAppsQuery,
useGetDataAppQuery,
useGetDataAppRepoStatusQuery,
useGetDataAppGroupsQuery,
useGetDataAppGroupPermissionWarningsQuery,
useAddDataAppGroupsMutation,
useRemoveDataAppGroupMutation,
useSetDataAppEnabledMutation,
} = dataAppApi;