@dative-gpi/foundation-core-components 1.1.11 → 1.1.12-dashboards-explorer-01

package/components/explorers/FSBaseDashboardsExplorer.vue

@@ -0,0 +1,305 @@
+<template>
+  <FSDataTable
+    defaultMode="iterator"
+    :loading="fetchingDashboardExplorerElements"
+    :singleSelect="$props.singleSelect"
+    :items="dashboardExplorerElements"
+    :selectable="$props.selectable"
+    :tableCode="$props.tableCode"
+    :itemTo="$props.itemTo"
+    :noSearch="$props.recursiveSearch"
+    :headersOptions="headersOptions"
+    :modelValue="$props.modelValue"
+    @update:modelValue="onUpdate"
+    v-model:search="search"
+    v-bind="$attrs"
+  >
+    <template
+      v-for="(_, name) in $slots"
+      v-slot:[name]="slotData"
+    >
+      <slot
+        :name="name"
+        v-bind="slotData"
+      />
+    </template>
+    <template
+      #header.imageId-title
+    >
+      <FSIcon>
+        mdi-panorama-variant-outline
+      </FSIcon>
+    </template>
+    <template
+      #item.imageId="{ item }"
+    >
+      <FSImage
+        v-if="item.imageId"
+        height="32px"
+        width="32px"
+        :imageId="item.imageId"
+        :thumbnail="true"
+      />
+    </template>
+    <template
+      #item.tags="{ item }"
+    >
+      <FSTagGroup
+        variant="slide"
+        :showRemove="false"
+        :tags="item.tags"
+      />
+    </template>
+    <template
+      #item.type="{ item }"
+    >
+      <FSDashboardExplorerElementChip
+        :type="item.type"
+      />
+    </template>
+    <template
+      #item.icon="{ item }"
+    >
+      <FSIcon>
+        {{ item.icon }}
+      </FSIcon>
+    </template>
+    <template
+      #item.locked="{ item }"
+    >
+      <FSIconCheck
+        v-if="item.locked != null"
+        :value="item.locked"
+      />
+    </template>
+    <template
+      #item.tile="{ index, item, toggleSelect }"
+    >
+      <FSFolderTileUI
+        v-if="item.type === DashboardExplorerElementType.Folder"
+        :key="index"
+        :to="$props.itemTo && $props.itemTo(item)"
+        :imageId="item.imageId"
+        :icon="item.icon"
+        :label="item.label"
+        :code="item.code"
+        :bottomColor="item.colors"
+        :recursiveFoldersIds="item.recursiveFoldersIds"
+        :recursiveDashboardOrganisationsIds="item.recursiveDashboardOrganisationsIds"
+        :recursiveDashboardShallowsIds="item.recursiveDashboardShallowsIds"
+        :modelValue="isSelected(item.id)"
+        :selectable="$props.selectable"
+        @update:modelValue="toggleSelect(item)"
+      />
+      <FSDashboardOrganisationTileUI
+        v-if="item.type === DashboardExplorerElementType.DashboardOrganisation"
+        :key="index"
+        :to="$props.itemTo && $props.itemTo(item)"
+        :bottomColor="item.colors"
+        :imageId="item.imageId"
+        :icon="item.icon"
+        :label="item.label"
+        :code="item.code"
+        :modelValue="isSelected(item.id)"
+        :selectable="$props.selectable"
+        @update:modelValue="toggleSelect(item)"
+      />
+      <FSDashboardShallowTileUI
+        v-if="item.type === DashboardExplorerElementType.DashboardShallow"
+        :key="index"
+        :to="$props.itemTo && $props.itemTo(item)"
+        :bottomColor="item.colors"
+        :imageId="item.imageId"
+        :icon="item.icon"
+        :label="item.label"
+        :code="item.code"
+        :modelValue="isSelected(item.id)"
+        :selectable="$props.selectable"
+        @update:modelValue="toggleSelect(item)"
+      />
+      <FSDashboardOrganisationTypeTileUI
+        v-if="item.type === DashboardExplorerElementType.DashboardOrganisationType"
+        :key="index"
+        :to="$props.itemTo && $props.itemTo(item)"
+        :bottomColor="item.colors"
+        :imageId="item.imageId"
+        :icon="item.icon"
+        :label="item.label"
+        :code="item.code"
+        :modelValue="isSelected(item.id)"
+        :selectable="$props.selectable"
+        @update:modelValue="toggleSelect(item)"
+      />
+    </template>
+  </FSDataTable>
+</template>
+  
+<script lang="ts">
+import { computed, defineComponent, type PropType, ref, watch } from "vue";
+import { type RouteLocation } from "vue-router";
+import _ from "lodash";
+  
+import { DashboardExplorerElementType } from "@dative-gpi/foundation-shared-domain/enums";
+import { useDashboardExplorerElements } from "@dative-gpi/foundation-core-services/composables";
+import { type DashboardExplorerElementInfos } from "@dative-gpi/foundation-core-domain/models";
+import { dashboardExplorerElementTypeLabel } from "@dative-gpi/foundation-core-components/utils";
+import { useDebounce } from "@dative-gpi/foundation-shared-components/composables";
+
+import FSDashboardOrganisationTypeTileUI from "@dative-gpi/foundation-shared-components/components/tiles/FSDashboardOrganisationTypeTileUI.vue";
+import FSDashboardOrganisationTileUI from "@dative-gpi/foundation-shared-components/components/tiles/FSDashboardOrganisationTileUI.vue";
+import FSDashboardShallowTileUI from "@dative-gpi/foundation-shared-components/components/tiles/FSDashboardShallowTileUI.vue";
+import FSFolderTileUI from "@dative-gpi/foundation-shared-components/components/tiles/FSFolderTileUI.vue";
+import FSIconCheck from "@dative-gpi/foundation-shared-components/components/FSIconCheck.vue";
+import FSTagGroup from "@dative-gpi/foundation-shared-components/components/FSTagGroup.vue";
+import FSImage from "@dative-gpi/foundation-shared-components/components/FSImage.vue";
+import FSIcon from "@dative-gpi/foundation-shared-components/components/FSIcon.vue";
+
+import FSDashboardExplorerElementChip from "./FSDashboardExplorerElementChip.vue";
+import FSDataTable from "../lists/FSDataTable.vue";
+
+export default defineComponent({
+  name: "FSBaseDashboardsExplorer",
+  components: {
+    FSDashboardExplorerElementChip,
+    FSDashboardOrganisationTypeTileUI,
+    FSDashboardOrganisationTileUI,
+    FSDashboardShallowTileUI,
+    FSFolderTileUI,
+    FSDataTable,
+    FSIconCheck,
+    FSTagGroup,
+    FSImage,
+    FSIcon
+  },
+  props: {
+    tableCode: {
+      type: String as PropType<string | null>,
+      required: false,
+      default: null
+    },
+    recursiveSearch: {
+      type: Boolean,
+      required: false,
+      default: true
+    },
+    parentId: {
+      type: String as PropType<string | null>,
+      required: false,
+      default: null
+    },
+    root: {
+      type: Boolean,
+      required: false,
+      default: true
+    },
+    allowedTypes: {
+      type: Array as PropType<DashboardExplorerElementType[]>,
+      required: false,
+      default: () => [
+        DashboardExplorerElementType.Folder,
+        DashboardExplorerElementType.DashboardOrganisation,
+        DashboardExplorerElementType.DashboardShallow,
+        DashboardExplorerElementType.DashboardOrganisationType
+      ]
+    },
+    itemTo: {
+      type: Function as PropType<(item: DashboardExplorerElementInfos) => Partial<RouteLocation>>,
+      required: false
+    },
+    selectable: {
+      type: Boolean,
+      required: false,
+      default: true
+    },
+    singleSelect: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    modelValue: {
+      type: Array as PropType<string[]>,
+      default: () => [],
+      required: false
+    }
+  },
+  emits: ["update:modelValue", "update:types"],
+  setup(props, { emit }) {
+    const { entities, fetching: fetchingDashboardExplorerElements, getMany: getManyDashboardExplorerElements } = useDashboardExplorerElements();
+    const { debounce } = useDebounce();
+
+    const search = ref("");
+
+    const dashboardExplorerElements = computed((): DashboardExplorerElementInfos[] => {
+      return entities.value
+        .filter(e => props.allowedTypes.includes(e.type))
+        .slice()
+        .sort((a, b) => a.type - b.type);
+    });
+
+    const headersOptions = computed(() => ({
+      type: {
+        fixedFilters: props.allowedTypes.map(t => ({
+          value: t,
+          text: dashboardExplorerElementTypeLabel(t)
+        })),
+        methodFilter: (value: DashboardExplorerElementType, type: DashboardExplorerElementType) => {
+          return value === type;
+        }
+      }
+    }));
+
+    const isSelected = (id: string): boolean => {
+      return props.modelValue.includes(id);
+    };
+
+    const onUpdate = (value: string[]): void => {
+      const types = value.map(id => entities.value.find(dee => dee.id === id)?.type);
+      emit("update:types", types);
+
+      emit("update:modelValue", value);
+    }
+
+    const fetch = () => {
+      if (props.recursiveSearch && search.value) {
+        getManyDashboardExplorerElements({
+          parentId: props.parentId,
+          search: search.value,
+          types: props.allowedTypes
+        });
+      }
+      else {
+        getManyDashboardExplorerElements({
+          parentId: props.parentId,
+          root: props.root,
+          types: props.allowedTypes
+        });
+      }
+    }
+
+    // Delay to wait before fetching after a search change
+    const debounceFetch = (): void => debounce(fetch, 1000);
+  
+    watch([() => props.parentId, () => props.root, () => props.allowedTypes], (next, previous) => {
+      if ((!next && !previous) || !_.isEqual(next, previous)) {
+        fetch();
+      }
+    }, { immediate: true });
+
+    watch(search, (next, previous) => {
+      if (props.recursiveSearch && next !== previous) {
+        debounceFetch();
+      }
+    });
+
+    return {
+      fetchingDashboardExplorerElements,
+      DashboardExplorerElementType,
+      dashboardExplorerElements,
+      headersOptions,
+      search,
+      isSelected,
+      onUpdate
+    };
+  }
+});
+</script>

package/components/explorers/FSDashboardExplorerElementChip.vue

@@ -0,0 +1,37 @@
+<template>
+  <FSChip
+    :label="chipLabel"
+    :color="ColorEnum.Light"
+  />
+</template>
+
+<script lang="ts">
+import { computed, defineComponent, type PropType } from "vue";
+
+import type { DashboardExplorerElementType } from "@dative-gpi/foundation-shared-domain/enums";
+import { dashboardExplorerElementTypeLabel } from "@dative-gpi/foundation-core-components/utils";
+
+import FSChip from "@dative-gpi/foundation-shared-components/components/FSChip.vue";
+import { ColorEnum } from "@dative-gpi/foundation-shared-components/models";
+
+export default defineComponent({
+  name: "FSDashboardExplorerElementChip",
+  components: {
+    FSChip
+  },
+  props: {
+    type: {
+      type: Number as PropType<DashboardExplorerElementType>,
+      required: true
+    }
+  },
+  setup(props) {
+    const chipLabel = computed(() => dashboardExplorerElementTypeLabel(props.type));
+
+    return {
+      chipLabel,
+      ColorEnum
+    };
+  }
+});
+</script>

package/package.json

@@ -4,7 +4,7 @@
     "url": "https://github.com/Dative-GPI/foundation-shared-ui.git"
   },
   "sideEffects": false,
-  "version": "1.1.11",
+  "version": "1.1.12-dashboards-explorer-01",
   "description": "",
   "publishConfig": {
     "access": "public"
@@ -13,11 +13,11 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@dative-gpi/foundation-core-domain": "1.1.11",
-    "@dative-gpi/foundation-core-services": "1.1.11",
-    "@dative-gpi/foundation-shared-components": "1.1.11",
-    "@dative-gpi/foundation-shared-domain": "1.1.11",
-    "@dative-gpi/foundation-shared-services": "1.1.11"
+    "@dative-gpi/foundation-core-domain": "1.1.12-dashboards-explorer-01",
+    "@dative-gpi/foundation-core-services": "1.1.12-dashboards-explorer-01",
+    "@dative-gpi/foundation-shared-components": "1.1.12-dashboards-explorer-01",
+    "@dative-gpi/foundation-shared-domain": "1.1.12-dashboards-explorer-01",
+    "@dative-gpi/foundation-shared-services": "1.1.12-dashboards-explorer-01"
   },
   "peerDependencies": {
     "@dative-gpi/bones-ui": "^1.0.0",
@@ -29,5 +29,5 @@
     "sass": "1.71.1",
     "sass-loader": "13.3.2"
   },
-  "gitHead": "88c49955eb1072121652331d9703ca0879d872fe"
+  "gitHead": "fb53e71b5c00401b3238a32e8df80f1772a01e45"
 }

package/utils/dashboards.ts

@@ -1,7 +1,7 @@
 import type { DashboardOrganisationInfos, DashboardOrganisationTypeInfos, DashboardShallowInfos, FolderInfos } from "@dative-gpi/foundation-core-domain/models";
 import { useTranslations as useTranslationsProvider } from "@dative-gpi/bones-ui/composables";
 import { type ColorBase, ColorEnum } from "@dative-gpi/foundation-shared-components/models";
-import { DashboardType } from "@dative-gpi/foundation-shared-domain/enums";
+import { DashboardExplorerElementType, DashboardType } from "@dative-gpi/foundation-shared-domain/enums";
 
 const { $tr } = useTranslationsProvider();
 
@@ -49,3 +49,13 @@ export enum FoldersListType {
 
 export type DashboardsListItem = DashboardShallowListItem | DashboardOrganisationListItem | OrganisationTypeDashboardListItem;
 export type FoldersListItem = DashboardShallowListItem | DashboardOrganisationListItem | FolderListItem;
+
+export const dashboardExplorerElementTypeLabel = (type: DashboardExplorerElementType): string => {
+  switch (type) {
+    case DashboardExplorerElementType.Folder:                    return $tr("ui.common.folder", "Folder");
+    case DashboardExplorerElementType.DashboardOrganisation:     return $tr("ui.common.custom", "Custom");
+    case DashboardExplorerElementType.DashboardShallow:          return $tr("ui.dashboard-type.shallow", "Shallow copy");
+    case DashboardExplorerElementType.DashboardOrganisationType: return $tr("ui.common.shared", "Shared");
+    default:                                                     return $tr("ui.common.none", "None");
+  }
+};