feat(api): implement bulk inventory creation admin API endpoint

app/migrations/20250227103030-data-source-priority.cjs

@@ -0,0 +1,15 @@
+"use strict";
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.addColumn("DataSourceI18n", "priority", {
+      type: Sequelize.DOUBLE,
+      nullable: true,
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.removeColumn("DataSourceI18n", "priority");
+  },
+};

app/scripts/catalogue-sync.ts

@@ -36,6 +36,7 @@ interface Source {
   subsector_id?: string;
   created?: Date;
   last_updated?: Date;
+  priority?: number;
 }
 
 function snakeToCamel(str: string): string {
@@ -181,7 +182,6 @@ async function syncDataCatalogue() {
     return result as DataSourceCreationAttributes;
   });
 
-  console.dir(sources);
   logger.debug("Saving sources...");
 
   /*

app/src/app/api/v0/admin/bulk/route.ts

@@ -0,0 +1,18 @@
+import AdminService from "@/backend/AdminService";
+import { apiHandler } from "@/util/api";
+import { NextResponse } from "next/server";
+import { z } from "zod";
+
+const createBulkInventoriesRequest = z.object({
+  cityLocodes: z.array(z.string()), // List of city locodes
+  emails: z.array(z.string().email()), // Comma separated list of emails to invite to the all of the created inventories
+  years: z.array(z.number().int().positive()), // List of years to create inventories for (can be comma separated input, multiple select dropdown etc., so multiple years can be chosen)
+  scope: z.enum(["gpc_basic", "gpc_basic_plus"]), // Scope selection (gpc_basic or gpc_basic_plus)
+  gwp: z.enum(["AR5", "AR6"]), // GWP selection (AR5 or AR6)
+});
+
+export const POST = apiHandler(async (req, { session }) => {
+  const props = createBulkInventoriesRequest.parse(await req.json());
+  const result = await AdminService.createBulkInventories(props, session);
+  return NextResponse.json(result);
+});

app/src/app/api/v0/city/[city]/user/[user]/route.ts

@@ -19,8 +19,8 @@ const updateUserRequest = z.object({
   role: z.nativeEnum(Roles),
 });
 
-export const PATCH = apiHandler(async (_req, { params, session }) => {
-  const body = updateUserRequest.parse(await _req.json());
+export const PATCH = apiHandler(async (req, { params, session }) => {
+  const body = updateUserRequest.parse(await req.json());
   let user = await db.models.User.findOne({ where: { userId: params.user } });
 
   if (!user) {

app/src/app/api/v0/datasource/[inventoryId]/route.ts

@@ -1,4 +1,7 @@
-import DataSourceService from "@/backend/DataSourceService";
+import DataSourceService, {
+  downscaledByCountryPopulation,
+  downscaledByRegionPopulation,
+} from "@/backend/DataSourceService";
 import { db } from "@/models";
 import { City } from "@/models/City";
 import { DataSourceI18n as DataSource } from "@/models/DataSourceI18n";
@@ -9,84 +12,7 @@ import { SubSector } from "@/models/SubSector";
 import { apiHandler } from "@/util/api";
 import createHttpError from "http-errors";
 import { NextRequest, NextResponse } from "next/server";
-import { Op } from "sequelize";
 import { z } from "zod";
-import { logger } from "@/services/logger";
-import { Publisher } from "@/models/Publisher";
-import { findClosestYear, PopulationEntry } from "@/util/helpers";
-import { PopulationAttributes } from "@/models/Population";
-import { Inventory } from "@/models/Inventory";
-import { maxPopulationYearDifference } from "@/util/constants";
-
-const downscaledByCountryPopulation = "global_api_downscaled_by_population";
-const downscaledByRegionPopulation =
-  "global_api_downscaled_by_region_population";
-const populationScalingRetrievalMethods = [
-  downscaledByCountryPopulation,
-  downscaledByRegionPopulation,
-];
-
-async function findPopulationScaleFactors(
-  inventory: Inventory,
-  sources: DataSource[],
-) {
-  let countryPopulationScaleFactor = 1;
-  let regionPopulationScaleFactor = 1;
-  let populationIssue: string | null = null;
-  if (
-    sources.some((source) =>
-      populationScalingRetrievalMethods.includes(source.retrievalMethod ?? ""),
-    )
-  ) {
-    const populations = await db.models.Population.findAll({
-      where: {
-        cityId: inventory.cityId,
-        year: {
-          [Op.between]: [
-            inventory.year! - maxPopulationYearDifference,
-            inventory.year! + maxPopulationYearDifference,
-          ],
-        },
-      },
-      order: [["year", "DESC"]], // favor more recent population entries
-    });
-    const cityPopulations = populations.filter((pop) => !!pop.population);
-    const cityPopulation = findClosestYear(
-      cityPopulations as PopulationEntry[],
-      inventory.year!,
-    );
-    const countryPopulations = populations.filter(
-      (pop) => !!pop.countryPopulation,
-    );
-    const countryPopulation = findClosestYear(
-      countryPopulations as PopulationEntry[],
-      inventory.year!,
-    ) as PopulationAttributes;
-    const regionPopulations = populations.filter(
-      (pop) => !!pop.regionPopulation,
-    );
-    const regionPopulation = findClosestYear(
-      regionPopulations as PopulationEntry[],
-      inventory.year!,
-    ) as PopulationAttributes;
-    // TODO allow country downscaling to work if there is no region population?
-    if (!cityPopulation || !countryPopulation || !regionPopulation) {
-      // City is missing population/ region population/ country population for a year close to the inventory year
-      populationIssue = "missing-population"; // translation key
-    } else {
-      countryPopulationScaleFactor =
-        cityPopulation.population / countryPopulation.countryPopulation!;
-      regionPopulationScaleFactor =
-        cityPopulation.population / regionPopulation.regionPopulation!;
-    }
-  }
-
-  return {
-    countryPopulationScaleFactor,
-    regionPopulationScaleFactor,
-    populationIssue,
-  };
-}
 
 export const GET = apiHandler(async (_req: NextRequest, { params }) => {
   const inventory = await db.models.Inventory.findOne({
@@ -97,48 +23,7 @@ export const GET = apiHandler(async (_req: NextRequest, { params }) => {
     throw new createHttpError.NotFound("Inventory not found");
   }
 
-  const include = [
-    {
-      model: DataSource,
-      as: "dataSources",
-      include: [
-        { model: Scope, as: "scopes" },
-        { model: Publisher, as: "publisher" },
-        {
-          model: InventoryValue,
-          as: "inventoryValues",
-          required: false,
-          where: { inventoryId: params.inventoryId },
-        },
-        { model: SubSector, as: "subSector" },
-        {
-          model: SubCategory,
-          as: "subCategory",
-          include: [
-            { model: SubSector, as: "subsector" },
-            { model: Scope, as: "scope" },
-          ],
-        },
-      ],
-    },
-  ];
-
-  const sectors = await db.models.Sector.findAll({ include });
-  const subSectors = await db.models.SubSector.findAll({ include });
-  const subCategories = await db.models.SubCategory.findAll({ include });
-
-  const sectorSources = sectors.flatMap((sector) => sector.dataSources);
-  const subSectorSources = subSectors.flatMap(
-    (subSector) => subSector.dataSources,
-  );
-  const subCategorySources = subCategories.flatMap(
-    (subCategory) => subCategory.dataSources,
-  );
-
-  const sources = sectorSources
-    .concat(subSectorSources)
-    .concat(subCategorySources);
-
+  const sources = await DataSourceService.findAllSources(params.inventoryId);
   const { applicableSources, removedSources } = DataSourceService.filterSources(
     inventory,
     sources,
@@ -149,7 +34,10 @@ export const GET = apiHandler(async (_req: NextRequest, { params }) => {
     countryPopulationScaleFactor,
     regionPopulationScaleFactor,
     populationIssue,
-  } = await findPopulationScaleFactors(inventory, applicableSources);
+  } = await DataSourceService.findPopulationScaleFactors(
+    inventory,
+    applicableSources,
+  );
 
   // TODO add query parameter to make this optional?
   const sourceData = await Promise.all(
@@ -234,59 +122,20 @@ export const POST = apiHandler(async (req: NextRequest, { params }) => {
   // TODO check if the user has made manual edits that would be overwritten
   // TODO create new versioning record
 
-  const {
-    countryPopulationScaleFactor,
-    regionPopulationScaleFactor,
-    populationIssue,
-  } = await findPopulationScaleFactors(inventory, applicableSources);
+  const populationScaleFactors =
+    await DataSourceService.findPopulationScaleFactors(
+      inventory,
+      applicableSources,
+    );
 
   // download source data and apply in database
   const sourceResults = await Promise.all(
     applicableSources.map(async (source) => {
-      const result: { id: string; success: boolean; issue?: string } = {
-        id: source.datasourceId,
-        success: true,
-        issue: undefined,
-      };
-
-      if (source.retrievalMethod === "global_api") {
-        const sourceStatus = await DataSourceService.applyGlobalAPISource(
-          source,
-          inventory,
-        );
-        if (typeof sourceStatus === "string") {
-          result.issue = sourceStatus;
-          result.success = false;
-        }
-      } else if (
-        populationScalingRetrievalMethods.includes(source.retrievalMethod ?? "")
-      ) {
-        if (populationIssue) {
-          result.issue = populationIssue;
-          result.success = false;
-          return result;
-        }
-        let scaleFactor = 1.0;
-        if (source.retrievalMethod === downscaledByCountryPopulation) {
-          scaleFactor = countryPopulationScaleFactor;
-        } else if (source.retrievalMethod === downscaledByRegionPopulation) {
-          scaleFactor = regionPopulationScaleFactor;
-        }
-        const sourceStatus = await DataSourceService.applyGlobalAPISource(
-          source,
-          inventory,
-          scaleFactor,
-        );
-        if (typeof sourceStatus === "string") {
-          result.issue = sourceStatus;
-          result.success = false;
-        }
-      } else {
-        result.issue = `Unsupported retrieval method ${source.retrievalMethod} for data source ${source.datasourceId}`;
-        logger.error(result.issue);
-        result.success = false;
-      }
-
+      const result = await DataSourceService.applySource(
+        source,
+        inventory,
+        populationScaleFactors,
+      );
       return result;
     }),
   );