Merge pull request #35

Ability to order the sub-topics and datasets
Vizzuality · Nov 22, 2024 · 6fe21d1 · 6fe21d1
2 parents 5060101 + 45785d2
commit 6fe21d1
Show file tree

Hide file tree

Showing 15 changed files with 129 additions and 46 deletions.
diff --git a/client/src/components/panels/contextual-layers/index.tsx b/client/src/components/panels/contextual-layers/index.tsx
@@ -9,12 +9,7 @@ import XMarkIcon from "@/svgs/xmark.svg";
 import Item from "./item";
 
 const ContextualLayersPanel = () => {
-  const { data, isLoading } = useDatasetsBySubTopic(
-    "contextual",
-    "sub_topic.name,name",
-    ["layer", "download_link"],
-    true,
-  );
+  const { data, isLoading } = useDatasetsBySubTopic("contextual", ["layer", "download_link"], true);
 
   return (
     <>

diff --git a/client/src/components/panels/drought/index.tsx b/client/src/components/panels/drought/index.tsx
@@ -8,7 +8,6 @@ import useDatasetsBySubTopic from "@/hooks/use-datasets-by-sub-topic";
 const DroughtPanel = () => {
   const { data, isLoading } = useDatasetsBySubTopic(
     "drought",
-    "sub_topic.name:desc,name",
     ["name", "params_config", "download_link"],
     true,
   );

diff --git a/client/src/components/panels/flood/index.tsx b/client/src/components/panels/flood/index.tsx
@@ -8,7 +8,6 @@ import useDatasetsBySubTopic from "@/hooks/use-datasets-by-sub-topic";
 const FloodPanel = () => {
   const { data, isLoading } = useDatasetsBySubTopic(
     "flood",
-    "sub_topic.name:desc,name",
     ["name", "params_config", "download_link"],
     true,
   );

diff --git a/client/src/components/panels/hydrometeorological/index.tsx b/client/src/components/panels/hydrometeorological/index.tsx
@@ -9,7 +9,6 @@ import HydrometeorologicalImage from "../../../../public/assets/images/hydromete
 const HydrometeorologicalPanel = () => {
   const { data, isLoading } = useDatasetsBySubTopic(
     "hydrometeorological",
-    "sub_topic.name:desc,name",
     ["name", "params_config", "download_link"],
     true,
   );

diff --git a/client/src/hooks/use-datasets-by-sub-topic.ts b/client/src/hooks/use-datasets-by-sub-topic.ts
@@ -15,7 +15,6 @@ type DatasetsBySubTopic = {
 
 export default function useDatasetsBySubTopic(
   topicSlug: string,
-  sort = "sub_topic.name,name",
   layersFields = ["name"],
   includeMetadata = false,
 ) {
@@ -25,10 +24,10 @@ export default function useDatasetsBySubTopic(
     {
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore-error
-      fields: ["name", "short_description"],
+      fields: ["name", "short_description", "order"],
       populate: {
         sub_topic: {
-          fields: ["name"],
+          fields: ["name", "order"],
         },
         default_layer: {
           fields: ["id"],
@@ -46,7 +45,7 @@ export default function useDatasetsBySubTopic(
           },
         },
       },
-      sort,
+      sort: "sub_topic.order,order",
     },
     {
       query: {

diff --git a/client/src/hooks/use-topic-tab-layer-management.ts b/client/src/hooks/use-topic-tab-layer-management.ts
@@ -10,7 +10,7 @@ export default function useTopicTabLayerManagement() {
 
   const [layers, { addLayer, removeLayer }] = useMapLayers();
 
-  const { data, isLoading } = useDatasetsBySubTopic(tab, "sub_topic.name:desc,name");
+  const { data, isLoading } = useDatasetsBySubTopic(tab);
 
   // The ids of all the layers that belong to the topic
   const topicLayerIds = useMemo(() => {

diff --git a/client/src/types/generated/strapi.schemas.ts b/client/src/types/generated/strapi.schemas.ts
@@ -603,6 +603,7 @@ export interface SubTopic {
   createdAt?: string;
   createdBy?: SubTopicCreatedBy;
   name: string;
+  order?: number;
   updatedAt?: string;
   updatedBy?: SubTopicUpdatedBy;
 }
@@ -763,6 +764,7 @@ export interface SubTopicListResponse {
 
 export type SubTopicRequestData = {
   name: string;
+  order?: number;
 };
 
 export interface SubTopicRequest {
@@ -1173,6 +1175,7 @@ export type LayerDatasetDataAttributes = {
   layers?: LayerDatasetDataAttributesLayers;
   metadata?: LayerDatasetDataAttributesMetadata;
   name?: string;
+  order?: number;
   short_description?: string;
   sub_topic?: LayerDatasetDataAttributesSubTopic;
   topic?: LayerDatasetDataAttributesTopic;
@@ -1266,6 +1269,7 @@ export type LayerDatasetDataAttributesSubTopicDataAttributes = {
   createdAt?: string;
   createdBy?: LayerDatasetDataAttributesSubTopicDataAttributesCreatedBy;
   name?: string;
+  order?: number;
   updatedAt?: string;
   updatedBy?: LayerDatasetDataAttributesSubTopicDataAttributesUpdatedBy;
 };
@@ -1700,6 +1704,7 @@ export interface Dataset {
   layers?: DatasetLayers;
   metadata?: MetadataItemComponent;
   name: string;
+  order?: number;
   short_description?: string;
   sub_topic?: DatasetSubTopic;
   topic?: DatasetTopic;
@@ -1824,6 +1829,7 @@ export type DatasetLayersDataItemAttributesDatasetDataAttributes = {
   layers?: DatasetLayersDataItemAttributesDatasetDataAttributesLayers;
   metadata?: DatasetLayersDataItemAttributesDatasetDataAttributesMetadata;
   name?: string;
+  order?: number;
   short_description?: string;
   sub_topic?: DatasetLayersDataItemAttributesDatasetDataAttributesSubTopic;
   topic?: DatasetLayersDataItemAttributesDatasetDataAttributesTopic;
@@ -2041,6 +2047,7 @@ export type DatasetLayersDataItemAttributesDatasetDataAttributesSubTopicDataAttr
   createdAt?: string;
   createdBy?: DatasetLayersDataItemAttributesDatasetDataAttributesSubTopicDataAttributesCreatedBy;
   name?: string;
+  order?: number;
   updatedAt?: string;
   updatedBy?: DatasetLayersDataItemAttributesDatasetDataAttributesSubTopicDataAttributesUpdatedBy;
 };
@@ -2245,6 +2252,7 @@ export type DatasetRequestData = {
   layers?: DatasetRequestDataLayersItem[];
   metadata?: MetadataItemComponent;
   name: string;
+  order?: number;
   short_description?: string;
   sub_topic?: DatasetRequestDataSubTopic;
   topic?: DatasetRequestDataTopic;
@@ -2368,6 +2376,7 @@ export type ChartDataLayerDataAttributesDatasetDataAttributes = {
   layers?: ChartDataLayerDataAttributesDatasetDataAttributesLayers;
   metadata?: ChartDataLayerDataAttributesDatasetDataAttributesMetadata;
   name?: string;
+  order?: number;
   short_description?: string;
   sub_topic?: ChartDataLayerDataAttributesDatasetDataAttributesSubTopic;
   topic?: ChartDataLayerDataAttributesDatasetDataAttributesTopic;
@@ -2585,6 +2594,7 @@ export type ChartDataLayerDataAttributesDatasetDataAttributesSubTopicDataAttribu
   createdAt?: string;
   createdBy?: ChartDataLayerDataAttributesDatasetDataAttributesSubTopicDataAttributesCreatedBy;
   name?: string;
+  order?: number;
   updatedAt?: string;
   updatedBy?: ChartDataLayerDataAttributesDatasetDataAttributesSubTopicDataAttributesUpdatedBy;
 };

diff --git a/cms/config/sync/admin-role.strapi-super-admin.json b/cms/config/sync/admin-role.strapi-super-admin.json
@@ -75,7 +75,8 @@
           "metadata.units",
           "metadata.full_name",
           "metadata.temporal_resolution",
-          "short_description"
+          "short_description",
+          "order"
         ]
       },
       "conditions": []
@@ -107,7 +108,8 @@
           "metadata.units",
           "metadata.full_name",
           "metadata.temporal_resolution",
-          "short_description"
+          "short_description",
+          "order"
         ]
       },
       "conditions": []
@@ -132,7 +134,8 @@
           "metadata.units",
           "metadata.full_name",
           "metadata.temporal_resolution",
-          "short_description"
+          "short_description",
+          "order"
         ]
       },
       "conditions": []
@@ -280,7 +283,8 @@
       "subject": "api::sub-topic.sub-topic",
       "properties": {
         "fields": [
-          "name"
+          "name",
+          "order"
         ]
       },
       "conditions": []
@@ -298,7 +302,8 @@
       "subject": "api::sub-topic.sub-topic",
       "properties": {
         "fields": [
-          "name"
+          "name",
+          "order"
         ]
       },
       "conditions": []
@@ -309,7 +314,8 @@
       "subject": "api::sub-topic.sub-topic",
       "properties": {
         "fields": [
-          "name"
+          "name",
+          "order"
         ]
       },
       "conditions": []

diff --git a/.../core-store.plugin_content_manager_configuration_content_types##api##dataset.dataset.json b/.../core-store.plugin_content_manager_configuration_content_types##api##dataset.dataset.json
@@ -121,6 +121,20 @@
           "sortable": true
         }
       },
+      "order": {
+        "edit": {
+          "label": "order",
+          "description": "Define the order of the dataset within a sub-topic. The value is relative to the other datasets.",
+          "placeholder": "",
+          "visible": true,
+          "editable": true
+        },
+        "list": {
+          "label": "order",
+          "searchable": true,
+          "sortable": true
+        }
+      },
       "createdAt": {
         "edit": {
           "label": "createdAt",
@@ -186,6 +200,10 @@
           {
             "name": "name",
             "size": 6
+          },
+          {
+            "name": "order",
+            "size": 6
           }
         ],
         [
@@ -225,7 +243,8 @@
         "id",
         "topic",
         "sub_topic",
-        "name"
+        "name",
+        "order"
       ]
     },
     "uid": "api::dataset.dataset"

diff --git a/...e-store.plugin_content_manager_configuration_content_types##api##sub-topic.sub-topic.json b/...e-store.plugin_content_manager_configuration_content_types##api##sub-topic.sub-topic.json
@@ -33,6 +33,20 @@
           "sortable": true
         }
       },
+      "order": {
+        "edit": {
+          "label": "order",
+          "description": "Define the order of the sub-topic within a topic. The value is relative to the other sub-topics.",
+          "placeholder": "",
+          "visible": true,
+          "editable": true
+        },
+        "list": {
+          "label": "order",
+          "searchable": true,
+          "sortable": true
+        }
+      },
       "createdAt": {
         "edit": {
           "label": "createdAt",
@@ -93,17 +107,22 @@
       }
     },
     "layouts": {
-      "list": [
-        "id",
-        "name"
-      ],
       "edit": [
         [
           {
             "name": "name",
             "size": 6
+          },
+          {
+            "name": "order",
+            "size": 4
           }
         ]
+      ],
+      "list": [
+        "id",
+        "name",
+        "order"
       ]
     },
     "uid": "api::sub-topic.sub-topic"

diff --git a/cms/src/api/dataset/content-types/dataset/schema.json b/cms/src/api/dataset/content-types/dataset/schema.json
@@ -44,6 +44,9 @@
     "short_description": {
       "type": "text",
       "maxLength": 100
+    },
+    "order": {
+      "type": "integer"
     }
   }
 }
diff --git a/cms/src/api/sub-topic/content-types/sub-topic/schema.json b/cms/src/api/sub-topic/content-types/sub-topic/schema.json
@@ -15,6 +15,9 @@
     "name": {
       "type": "string",
       "required": true
+    },
+    "order": {
+      "type": "integer"
     }
   }
 }