add designation metadata

src/controllers/publish.ts

@@ -6,6 +6,7 @@ import { generateViewErrors } from '../utils/generate-view-errors';
 import {
     collectionValidator,
     descriptionValidator,
+    designationValidator,
     hasError,
     qualityValidator,
     roundingAppliedValidator,
@@ -24,6 +25,7 @@ import { NotFoundException } from '../exceptions/not-found.exception';
 import { statusToColour } from '../utils/status-to-colour';
 import { singleLangDataset } from '../utils/single-lang-dataset';
 import { updateSourceTypes } from '../utils/update-source-types';
+import { Designation } from '../enums/designation';
 
 export const start = (req: Request, res: Response, next: NextFunction) => {
     res.render('publish/start');
@@ -318,3 +320,31 @@ export const provideQuality = async (req: Request, res: Response, next: NextFunc
 
     res.render('publish/quality', { ...datasetInfo, errors });
 };
+
+export const provideDesignation = async (req: Request, res: Response, next: NextFunction) => {
+    let errors: ViewErrDTO | undefined;
+    const dataset = singleLangDataset(res.locals.dataset, req.language);
+    const designationOptions = Object.values(Designation);
+    let designation = dataset?.datasetInfo?.designation;
+
+    if (req.method === 'POST') {
+        try {
+            const designationError = await hasError(designationValidator(), req);
+            if (designationError) {
+                res.status(400);
+                throw new Error('errors.designation.missing');
+            }
+
+            designation = req.body.designation;
+
+            await req.swapi.updateDatasetInfo(dataset.id, { designation, language: req.language });
+            res.redirect(req.buildUrl(`/publish/${dataset.id}/tasklist`, req.language));
+            return;
+        } catch (err) {
+            const error: ViewError = { field: 'designation', tag: { name: 'errors.designation.missing' } };
+            errors = generateViewErrors(undefined, 400, [error]);
+        }
+    }
+
+    res.render('publish/designation', { designation, designationOptions, errors });
+};

src/dtos/dataset-info.ts

@@ -1,3 +1,5 @@
+import { Designation } from '../enums/designation';
+
 export interface DatasetInfoDTO {
     language?: string;
     title?: string;
@@ -6,4 +8,5 @@ export interface DatasetInfoDTO {
     quality?: string;
     rounding_applied?: boolean;
     rounding_description?: string;
+    designation?: Designation;
 }

src/enums/designation.ts

@@ -0,0 +1,6 @@
+export enum Designation {
+    Official = 'official',
+    Accredited = 'accredited',
+    InDevelopment = 'in_development',
+    None = 'none'
+}

src/middleware/translations/en.json

@@ -110,6 +110,23 @@
                 }
             }
         },
+        "designation": {
+            "heading": "How is this dataset designated?",
+            "options": {
+                "official": {
+                    "label": "Official statistics"
+                },
+                "accredited": {
+                    "label": "Accredited official statistics"
+                },
+                "in_development": {
+                    "label": "Official statistics in development"
+                },
+                "none": {
+                    "label": "No designation"
+                }
+            }
+        },
         "upload": {
             "title": "Upload the data table",
             "note": "The file should be in a CSV format"
@@ -284,6 +301,9 @@
         "rounding_description": {
             "missing": "You need to provide a description of the rounding applied"
         },
+        "designation": {
+            "missing": "You need to provide the designation of the dataset"
+        },
         "upload": {
             "no_csv": "No CSV data provided",
             "no_csv_data": "No CSV data available"

src/routes/publish.ts

@@ -13,7 +13,8 @@ import {
     redirectToTasklist,
     provideSummary,
     provideCollection,
-    provideQuality
+    provideQuality,
+    provideDesignation
 } from '../controllers/publish';
 
 export const publish = Router();
@@ -52,3 +53,6 @@ publish.post('/:datasetId/collection', fetchDataset, upload.none(), provideColle
 
 publish.get('/:datasetId/quality', fetchDataset, provideQuality);
 publish.post('/:datasetId/quality', fetchDataset, upload.none(), provideQuality);
+
+publish.get('/:datasetId/designation', fetchDataset, provideDesignation);
+publish.post('/:datasetId/designation', fetchDataset, upload.none(), provideDesignation);

src/validators/index.ts

@@ -1,6 +1,8 @@
 import { Request } from 'express';
 import { body, param, ValidationChain } from 'express-validator';
 
+import { Designation } from '../enums/designation';
+
 export const hasError = async (validator: ValidationChain, req: Request) => {
     return !(await validator.run(req)).isEmpty();
 };
@@ -17,3 +19,5 @@ export const qualityValidator = () => body('quality').trim().notEmpty();
 export const roundingAppliedValidator = () => body('rounding_applied').notEmpty().isBoolean();
 export const roundingDescriptionValidator = () =>
     body('rounding_description').if(body('rounding_applied').equals('true')).trim().notEmpty();
+
+export const designationValidator = () => body('designation').trim().isIn(Object.values(Designation));

src/views/publish/designation.ejs

@@ -0,0 +1,43 @@
+<%- include("../partials/header"); %>
+<div class="govuk-width-container app-width-container">
+    <!-- <a href="#" class="govuk-back-link">Back</a> -->
+    <main class="govuk-main-wrapper" id="main-content" role="main">
+
+        <div class="top-links">
+            <div class="govuk-width-container">
+                <a href="javascript:history.back()" class="govuk-back-link"><%= t('buttons.back') %></a>
+                <a href="<%= buildUrl(`/publish/${locals.datasetId}/tasklist`, i18n.language) %>" class="govuk-link return-link"><%= t('publish.header.overview') %></a>
+            </div>
+        </div>
+
+        <div class="govuk-width-container">
+            <div class="govuk-grid-row">
+                <div class="govuk-grid-column-two-thirds">
+                    <h1 class="govuk-heading-xl"><%= t('publish.designation.heading') %></h1>
+
+                    <form enctype="multipart/form-data" method="post">
+                        <%- include("../partials/error-handler"); %>
+
+                        <div class="govuk-form-group">
+                            <fieldset class="govuk-fieldset" aria-describedby="designation">
+                                <div class="govuk-radios" data-module="govuk-radios">
+                                    <% locals.designationOptions.forEach(option => { %>
+                                        <div class="govuk-radios__item">
+                                            <input class="govuk-radios__input" id="<%= `designation_${option}` %>" name="designation" type="radio" value="<%= option %>" <%= locals.designation === option ? 'checked' : '' %> />
+                                            <label class="govuk-label govuk-radios__label" for="<%= `designation_${option}` %>"><%= t(`publish.designation.options.${option}.label`) %></label>
+                                        </div>
+                                    <% }) %>
+                                </div>
+                            </fieldset>
+                        </div>
+
+                        <button type="submit" class="govuk-button" data-module="govuk-button"><%= t('buttons.continue') %></button>
+                        <a class="govuk-button govuk-button--secondary" href="javascript:history.back()"><%= t('buttons.cancel')%></a>
+                    </form>
+                </div>
+            </div>
+        </div>
+    </main>
+</div>
+
+<%- include("../partials/footer"); %>