Merge pull request #3914 from LiteFarmOrg/LF-4995/Create_POST_endpoint_to_add_Market_directory_info

LF-4995: Create post endpoint to add market directory info

Author: kathyavini

packages/api/db/migration/20251024195921_add_market_directory_info_permissions.js

@@ -0,0 +1,70 @@
+/*
+ *  Copyright 2025 LiteFarm.org
+ *  This file is part of LiteFarm.
+ *
+ *  LiteFarm is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  LiteFarm is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *  GNU General Public License for more details, see <https://www.gnu.org/licenses/>.
+ */
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+
+export const up = async function (knex) {
+  await knex('permissions').insert([
+    {
+      permission_id: 179,
+      name: 'add:market_directory_info',
+      description: 'add market_directory_info',
+    },
+    {
+      permission_id: 180,
+      name: 'edit:market_directory_info',
+      description: 'edit market_directory_info',
+    },
+    {
+      permission_id: 181,
+      name: 'delete:market_directory_info',
+      description: 'delete market_directory_info',
+    },
+    {
+      permission_id: 182,
+      name: 'get:market_directory_info',
+      description: 'get market_directory_info',
+    },
+  ]);
+  await knex('rolePermissions').insert([
+    { role_id: 1, permission_id: 179 },
+    { role_id: 2, permission_id: 179 },
+    { role_id: 5, permission_id: 179 },
+    { role_id: 1, permission_id: 180 },
+    { role_id: 2, permission_id: 180 },
+    { role_id: 5, permission_id: 180 },
+    { role_id: 1, permission_id: 181 },
+    { role_id: 2, permission_id: 181 },
+    { role_id: 5, permission_id: 181 },
+    { role_id: 1, permission_id: 182 },
+    { role_id: 2, permission_id: 182 },
+    { role_id: 5, permission_id: 182 },
+  ]);
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+export const down = function (knex) {
+  const permissions = [179, 180, 181, 182];
+  return Promise.all([
+    knex('rolePermissions').whereIn('permission_id', permissions).del(),
+    knex('permissions').whereIn('permission_id', permissions).del(),
+  ]);
+};

packages/api/src/controllers/marketDirectoryInfoController.ts

@@ -0,0 +1,50 @@
+/*
+ *  Copyright 2025 LiteFarm.org
+ *  This file is part of LiteFarm.
+ *
+ *  LiteFarm is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  LiteFarm is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *  GNU General Public License for more details, see <https://www.gnu.org/licenses/>.
+ */
+
+import { Response } from 'express';
+import baseController from './baseController.js';
+import MarketDirectoryInfoModel from '../models/marketDirectoryInfoModel.js';
+import { MarketDirectoryInfoReqBody } from '../middleware/validation/checkMarketDirectoryInfo.js';
+import { HttpError, LiteFarmRequest } from '../types.js';
+
+const marketDirectoryInfoController = {
+  addMarketDirectoryInfo() {
+    return async (
+      req: LiteFarmRequest<unknown, unknown, unknown, MarketDirectoryInfoReqBody>,
+      res: Response,
+    ) => {
+      const { farm_id } = req.headers;
+
+      try {
+        const result = await baseController.post(
+          MarketDirectoryInfoModel,
+          { ...req.body, farm_id },
+          req,
+        );
+
+        return res.status(201).send(result);
+      } catch (error: unknown) {
+        console.error(error);
+        const err = error as HttpError;
+        const status = err.status || err.code || 500;
+        return res.status(status).json({
+          error: err.message || err,
+        });
+      }
+    };
+  },
+};
+
+export default marketDirectoryInfoController;

packages/api/src/middleware/validation/checkMarketDirectoryInfo.ts

@@ -0,0 +1,84 @@
+/*
+ *  Copyright 2025 LiteFarm.org
+ *  This file is part of LiteFarm.
+ *
+ *  LiteFarm is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  LiteFarm is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *  GNU General Public License for more details, see <https://www.gnu.org/licenses/>.
+ */
+
+import { Response, NextFunction } from 'express';
+import { LiteFarmRequest } from '../../types.js';
+import { isValidAddress, isValidEmail } from '../../util/validation.js';
+import { isValidUrl } from '../../util/url.js';
+import { SOCIALS, validateSocialAndExtractUsername } from '../../util/socials.js';
+import MarketDirectoryInfoModel from '../../models/marketDirectoryInfoModel.js';
+
+export interface MarketDirectoryInfoReqBody {
+  farm_name?: string;
+  logo?: string;
+  about?: string;
+  contact_first_name?: string;
+  contact_last_name?: string;
+  contact_email?: string;
+  email?: string;
+  country_code?: number;
+  phone_number?: string;
+  address?: string;
+  website?: string;
+  instagram?: string;
+  facebook?: string;
+  x?: string;
+}
+
+export function checkAndTransformMarketDirectoryInfo() {
+  return async (
+    req: LiteFarmRequest<unknown, unknown, unknown, MarketDirectoryInfoReqBody>,
+    res: Response,
+    next: NextFunction,
+  ) => {
+    if (req.method === 'POST') {
+      // @ts-expect-error: TS doesn't see query() through softDelete HOC; safe at runtime
+      const record = await MarketDirectoryInfoModel.query()
+        .where({ farm_id: req.headers.farm_id })
+        .first();
+
+      if (record) {
+        return res.status(409).send('Market directory info for this farm already exists');
+      }
+    }
+
+    const { address, website } = req.body;
+
+    for (const emailProperty of ['contact_email', 'email'] as const) {
+      if (req.body[emailProperty] && !isValidEmail(req.body[emailProperty])) {
+        return res.status(400).send(`Invalid ${emailProperty}`);
+      }
+    }
+
+    if (address && !(await isValidAddress(address))) {
+      return res.status(400).send('Invalid address');
+    }
+
+    if (website && !(await isValidUrl(website)) /* TODO: LF-5011 */) {
+      return res.status(400).send('Invalid website');
+    }
+
+    for (const social of SOCIALS.filter((social) => req.body[social]?.trim())) {
+      const socialUsername = validateSocialAndExtractUsername(social, req.body[social]!);
+
+      if (!socialUsername) {
+        return res.status(400).send(`Invalid ${social}`);
+      }
+      req.body[social] = socialUsername;
+    }
+
+    next();
+  };
+}

packages/api/src/models/marketDirectoryInfoModel.js

@@ -14,6 +14,7 @@
  */
 
 import baseModel from './baseModel.js';
+import { checkAndTrimString } from '../util/util.js';
 
 class MarketDirectoryInfo extends baseModel {
   static get tableName() {
@@ -24,6 +25,34 @@ class MarketDirectoryInfo extends baseModel {
     return 'id';
   }
 
+  static get stringProperties() {
+    const stringProperties = [];
+    for (const [key, value] of Object.entries(this.jsonSchema.properties)) {
+      if (value.type.includes('string')) {
+        stringProperties.push(key);
+      }
+    }
+    return stringProperties;
+  }
+
+  async $beforeInsert(queryContext) {
+    await super.$beforeInsert(queryContext);
+    this.trimStringProperties();
+  }
+
+  async $beforeUpdate(opt, queryContext) {
+    await super.$beforeUpdate(opt, queryContext);
+    this.trimStringProperties();
+  }
+
+  trimStringProperties() {
+    for (const key of this.constructor.stringProperties) {
+      if (key in this) {
+        this[key] = checkAndTrimString(this[key]);
+      }
+    }
+  }
+
   // Optional JSON schema. This is not the database schema! Nothing is generated
   // based on this. This is only used for validation. Whenever a model instance
   // is created it is checked against this schema. http://json-schema.org/.
@@ -36,15 +65,15 @@ class MarketDirectoryInfo extends baseModel {
         farm_id: { type: 'string' },
         farm_name: { type: 'string', minLength: 1, maxLength: 255 },
         logo: { type: ['string', 'null'], maxLength: 255 },
-        about: { type: ['string', 'null'] },
+        about: { type: ['string', 'null'], maxLength: 3000 },
         contact_first_name: { type: 'string', minLength: 1, maxLength: 255 },
         contact_last_name: { type: ['string', 'null'], maxLength: 255 },
         contact_email: { type: 'string', minLength: 1, maxLength: 255 },
         email: { type: ['string', 'null'], maxLength: 255 },
         country_code: { type: ['integer', 'null'], minimum: 1, maximum: 999 },
         phone_number: { type: ['string', 'null'], maxLength: 255 },
         address: { type: 'string', minLength: 1, maxLength: 255 },
-        website: { type: ['string', 'null'] },
+        website: { type: ['string', 'null'], maxLength: 2000 },
         instagram: { type: ['string', 'null'], maxLength: 255 },
         facebook: { type: ['string', 'null'], maxLength: 255 },
         x: { type: ['string', 'null'], maxLength: 255 },

packages/api/src/routes/marketDirectoryInfoRoute.ts

@@ -0,0 +1,30 @@
+/*
+ *  Copyright 2025 LiteFarm.org
+ *  This file is part of LiteFarm.
+ *
+ *  LiteFarm is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  LiteFarm is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *  GNU General Public License for more details, see <https://www.gnu.org/licenses/>.
+ */
+
+import express from 'express';
+import checkScope from '../middleware/acl/checkScope.js';
+import { checkAndTransformMarketDirectoryInfo } from '../middleware/validation/checkMarketDirectoryInfo.js';
+import MarketDirectoryInfoController from '../controllers/marketDirectoryInfoController.js';
+
+const router = express.Router();
+
+router.post(
+  '/',
+  checkScope(['add:market_directory_info']),
+  checkAndTransformMarketDirectoryInfo(),
+  MarketDirectoryInfoController.addMarketDirectoryInfo(),
+);
+
+export default router;

packages/api/src/server.ts

@@ -175,6 +175,7 @@ import farmAddonRoute from './routes/farmAddonRoute.js';
 import weatherRoute from './routes/weatherRoute.js';
 import irrigationPrescriptionRoute from './routes/irrigationPrescriptionRoute.js';
 import irrigationPrescriptionRequestRoute from './routes/irrigationPrescriptionRequestRoute.js';
+import marketDirectoryInfoRoute from './routes/marketDirectoryInfoRoute.js';
 
 // register API
 const router = promiseRouter();
@@ -343,7 +344,8 @@ app
   .use('/farm_addon', farmAddonRoute)
   .use('/weather', weatherRoute)
   .use('/irrigation_prescriptions', irrigationPrescriptionRoute)
-  .use('/irrigation_prescription_request', irrigationPrescriptionRequestRoute);
+  .use('/irrigation_prescription_request', irrigationPrescriptionRequestRoute)
+  .use('/market_directory_info', marketDirectoryInfoRoute);
 
 // Allow a 1MB limit on sensors to match incoming Ensemble data
 app.use('/sensor', express.json({ limit: '1MB' }), rejectBodyInGetAndDelete, sensorRoute);

packages/api/src/types.ts

@@ -21,8 +21,12 @@ export interface HttpError extends Error {
 }
 
 // TODO: Remove farm_id conditional and cast this in a checkScope() that takes the function and casts this to req
-export interface LiteFarmRequest<QueryParams = unknown, RouteParams = unknown>
-  extends Request<RouteParams, unknown, unknown, QueryParams> {
+export interface LiteFarmRequest<
+  QueryParams = unknown,
+  RouteParams = unknown,
+  ResBody = unknown,
+  ReqBody = unknown,
+> extends Request<RouteParams, ResBody, ReqBody, QueryParams> {
   headers: Request['headers'] & {
     farm_id?: string;
   };

packages/api/src/util/googleMaps.ts

@@ -0,0 +1,31 @@
+/*
+ *  Copyright 2025 LiteFarm.org
+ *  This file is part of LiteFarm.
+ *
+ *  LiteFarm is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  LiteFarm is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *  GNU General Public License for more details, see <https://www.gnu.org/licenses/>.
+ */
+
+import { Client } from '@googlemaps/google-maps-services-js';
+const googleClient = new Client({});
+
+export async function getAddressComponents(address: string) {
+  try {
+    const response = await googleClient.geocode({
+      params: {
+        address,
+        key: process.env.GOOGLE_API_KEY!,
+      },
+    });
+    return response.data.results[0]?.address_components;
+  } catch (error) {
+    console.error(error);
+  }
+}