feat(cms/client): Add dataset short description

SS-143
Vizzuality · Nov 22, 2024 · 5060101 · 5060101
1 parent ca498fe
commit 5060101
Show file tree

Hide file tree

Showing 8 changed files with 75 additions and 12 deletions.
diff --git a/client/src/components/dataset-card/index.tsx b/client/src/components/dataset-card/index.tsx
@@ -48,12 +48,20 @@ import {
 interface DatasetCardProps {
   id: number;
   name: string;
+  shortDescription?: string;
   defaultLayerId: number | undefined;
   layers: DatasetLayersDataItem[];
   metadata?: MetadataItemComponent;
 }
 
-const DatasetCard = ({ id, name, defaultLayerId, layers, metadata }: DatasetCardProps) => {
+const DatasetCard = ({
+  id,
+  name,
+  shortDescription,
+  defaultLayerId,
+  layers,
+  metadata,
+}: DatasetCardProps) => {
   const [layersConfiguration, { addLayer, updateLayer, removeLayer }] = useMapLayers();
   const [location] = useLocation();
 
@@ -360,6 +368,7 @@ const DatasetCard = ({ id, name, defaultLayerId, layers, metadata }: DatasetCard
           />
         </div>
       </div>
+      {!!shortDescription && <div className="mt-1 text-sm">{shortDescription}</div>}
       <div className="mt-1 flex flex-col gap-1.5">
         {layers.length > 1 && (
           <Select

diff --git a/client/src/hooks/use-datasets-by-sub-topic.ts b/client/src/hooks/use-datasets-by-sub-topic.ts
@@ -6,6 +6,7 @@ type DatasetsBySubTopic = {
   datasets: {
     id: number;
     name: string;
+    shortDescription?: string;
     defaultLayerId: number | undefined;
     layers: DatasetLayersDataItem[];
     metadata?: MetadataItemComponent;
@@ -24,7 +25,7 @@ export default function useDatasetsBySubTopic(
     {
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore-error
-      fields: ["name"],
+      fields: ["name", "short_description"],
       populate: {
         sub_topic: {
           fields: ["name"],
@@ -63,6 +64,7 @@ export default function useDatasetsBySubTopic(
           for (const item of data.data) {
             const subTopic = item.attributes!.sub_topic!.data!.attributes!.name! as string;
             const dataset = item.attributes!.name;
+            const shortDescription = item.attributes!.short_description;
             const defaultLayerId = item.attributes!.default_layer!.data?.id;
             const layers = item.attributes!.layers!.data!;
             const metadata = item.attributes!.metadata;
@@ -76,6 +78,7 @@ export default function useDatasetsBySubTopic(
             res[currentIndex].datasets.push({
               id: item.id!,
               name: dataset,
+              shortDescription,
               defaultLayerId,
               layers,
               ...(includeMetadata ? { metadata: metadata ?? undefined } : {}),

diff --git a/client/src/types/generated/strapi.schemas.ts b/client/src/types/generated/strapi.schemas.ts
@@ -1173,6 +1173,7 @@ export type LayerDatasetDataAttributes = {
   layers?: LayerDatasetDataAttributesLayers;
   metadata?: LayerDatasetDataAttributesMetadata;
   name?: string;
+  short_description?: string;
   sub_topic?: LayerDatasetDataAttributesSubTopic;
   topic?: LayerDatasetDataAttributesTopic;
   updatedAt?: string;
@@ -1699,6 +1700,7 @@ export interface Dataset {
   layers?: DatasetLayers;
   metadata?: MetadataItemComponent;
   name: string;
+  short_description?: string;
   sub_topic?: DatasetSubTopic;
   topic?: DatasetTopic;
   updatedAt?: string;
@@ -1822,6 +1824,7 @@ export type DatasetLayersDataItemAttributesDatasetDataAttributes = {
   layers?: DatasetLayersDataItemAttributesDatasetDataAttributesLayers;
   metadata?: DatasetLayersDataItemAttributesDatasetDataAttributesMetadata;
   name?: string;
+  short_description?: string;
   sub_topic?: DatasetLayersDataItemAttributesDatasetDataAttributesSubTopic;
   topic?: DatasetLayersDataItemAttributesDatasetDataAttributesTopic;
   updatedAt?: string;
@@ -2242,6 +2245,7 @@ export type DatasetRequestData = {
   layers?: DatasetRequestDataLayersItem[];
   metadata?: MetadataItemComponent;
   name: string;
+  short_description?: string;
   sub_topic?: DatasetRequestDataSubTopic;
   topic?: DatasetRequestDataTopic;
 };
@@ -2364,6 +2368,7 @@ export type ChartDataLayerDataAttributesDatasetDataAttributes = {
   layers?: ChartDataLayerDataAttributesDatasetDataAttributesLayers;
   metadata?: ChartDataLayerDataAttributesDatasetDataAttributesMetadata;
   name?: string;
+  short_description?: string;
   sub_topic?: ChartDataLayerDataAttributesDatasetDataAttributesSubTopic;
   topic?: ChartDataLayerDataAttributesDatasetDataAttributesTopic;
   updatedAt?: string;

diff --git a/cms/config/sync/admin-role.strapi-super-admin.json b/cms/config/sync/admin-role.strapi-super-admin.json
@@ -74,7 +74,8 @@
           "metadata.spatial_resolution",
           "metadata.units",
           "metadata.full_name",
-          "metadata.temporal_resolution"
+          "metadata.temporal_resolution",
+          "short_description"
         ]
       },
       "conditions": []
@@ -105,7 +106,8 @@
           "metadata.spatial_resolution",
           "metadata.units",
           "metadata.full_name",
-          "metadata.temporal_resolution"
+          "metadata.temporal_resolution",
+          "short_description"
         ]
       },
       "conditions": []
@@ -129,7 +131,8 @@
           "metadata.spatial_resolution",
           "metadata.units",
           "metadata.full_name",
-          "metadata.temporal_resolution"
+          "metadata.temporal_resolution",
+          "short_description"
         ]
       },
       "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
@@ -107,6 +107,20 @@
           "sortable": false
         }
       },
+      "short_description": {
+        "edit": {
+          "label": "short_description",
+          "description": "Displayed in the dataset cards",
+          "placeholder": "",
+          "visible": true,
+          "editable": true
+        },
+        "list": {
+          "label": "short_description",
+          "searchable": true,
+          "sortable": true
+        }
+      },
       "createdAt": {
         "edit": {
           "label": "createdAt",
@@ -167,12 +181,6 @@
       }
     },
     "layouts": {
-      "list": [
-        "id",
-        "topic",
-        "sub_topic",
-        "name"
-      ],
       "edit": [
         [
           {
@@ -200,12 +208,24 @@
             "size": 6
           }
         ],
+        [
+          {
+            "name": "short_description",
+            "size": 12
+          }
+        ],
         [
           {
             "name": "metadata",
             "size": 12
           }
         ]
+      ],
+      "list": [
+        "id",
+        "topic",
+        "sub_topic",
+        "name"
       ]
     },
     "uid": "api::dataset.dataset"

diff --git a/cms/src/api/dataset/content-types/dataset/schema.json b/cms/src/api/dataset/content-types/dataset/schema.json
@@ -40,6 +40,10 @@
       "type": "component",
       "repeatable": false,
       "component": "metadata.item"
+    },
+    "short_description": {
+      "type": "text",
+      "maxLength": 100
     }
   }
 }
diff --git a/cms/src/extensions/documentation/documentation/1.0.0/full_documentation.json b/cms/src/extensions/documentation/documentation/1.0.0/full_documentation.json
@@ -14,7 +14,7 @@
       "name": "Apache 2.0",
       "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
     },
-    "x-generation-date": "2024-11-18T15:05:56.007Z"
+    "x-generation-date": "2024-11-22T10:48:59.215Z"
   },
   "x-strapi-config": {
     "path": "/documentation",
@@ -725,6 +725,9 @@
                                       }
                                     }
                                   },
+                                  "short_description": {
+                                    "type": "string"
+                                  },
                                   "createdAt": {
                                     "type": "string",
                                     "format": "date-time"
@@ -1045,6 +1048,9 @@
               },
               "metadata": {
                 "$ref": "#/components/schemas/MetadataItemComponent"
+              },
+              "short_description": {
+                "type": "string"
               }
             }
           }
@@ -1645,6 +1651,9 @@
                                         }
                                       }
                                     },
+                                    "short_description": {
+                                      "type": "string"
+                                    },
                                     "createdAt": {
                                       "type": "string",
                                       "format": "date-time"
@@ -1890,6 +1899,9 @@
           "metadata": {
             "$ref": "#/components/schemas/MetadataItemComponent"
           },
+          "short_description": {
+            "type": "string"
+          },
           "createdAt": {
             "type": "string",
             "format": "date-time"
@@ -2808,6 +2820,9 @@
                           }
                         }
                       },
+                      "short_description": {
+                        "type": "string"
+                      },
                       "createdAt": {
                         "type": "string",
                         "format": "date-time"

diff --git a/cms/types/generated/contentTypes.d.ts b/cms/types/generated/contentTypes.d.ts
@@ -867,6 +867,10 @@ export interface ApiDatasetDataset extends Schema.CollectionType {
       'api::sub-topic.sub-topic'
     >;
     metadata: Attribute.Component<'metadata.item'>;
+    short_description: Attribute.Text &
+      Attribute.SetMinMaxLength<{
+        maxLength: 100;
+      }>;
     createdAt: Attribute.DateTime;
     updatedAt: Attribute.DateTime;
     createdBy: Attribute.Relation<