6650 rename requisition line transformation and expose plugin data query to plugins

client/packages/common/src/plugins/types.ts

@@ -20,7 +20,8 @@ export type Plugins = {
   };
   requestRequisitionColumn?: {
     StateLoader: React.ComponentType<{ requestLines: RequestLineFragment[] }>[];
-    columns: ColumnDefinition<RequestLineFragment>[];
+    tableColumns: ColumnDefinition<RequestLineFragment>[];
+    editViewColumns: React.ComponentType<{ line: RequestLineFragment }>[];
   };
 };
 

client/packages/plugins/README.md

@@ -173,7 +173,7 @@ You can work on plugins as if they were part of the app (types should be shared,
 
 ```bash
 # From server directory
-cargo run --bin remote_server_cli -- generate-plugin-bundle -i ../client/packages/plugins/mynewplugin/frontend -o pluginbundle.json
+cargo run --bin remote_server_cli -- generate-plugin-bundle -i ../client/packages/plugins/myPluginBundle/frontend -o pluginbundle.json
 ```
 
 Above will generate `pluginbundle.json` with all backend and frontend plugins in the directory specified by `-i`, this bundle includes metadata, like code and plugin types and base64 contents of all of the files in the `dist` directory which was generated with `yarn build` command that was executed in every plugin directory.
@@ -190,7 +190,7 @@ Note you must be uploading plugins to central server for this to work
 Alternatively one command can be used for both:
 
 ```bash
-cargo run --bin remote_server_cli -- generate-and-install-plugin-bundle -i '../client/packages/plugins/mynewplugin/frontend' --url 'http://localhost:8000' --username admin --password pass
+cargo run --bin remote_server_cli -- generate-and-install-plugin-bundle -i '../client/packages/plugins/myPluginBundle/frontend' --url 'http://localhost:8000' --username admin --password pass
 ```
 
 In order to test this plugins in front end, you will need to start front end via `yarn -- -- --env LOAD_REMOTE_PLUGINS` which fetched plugins from the server rather then serving them from local directory, this is how plugins will be loaded in production (and plugins will sync and be served by remote site servers)

client/packages/plugins/backendTypes/generated/EqualFilter.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type EqualFilter<T> = { equal_to?: T, not_equal_to?: T, equal_any?: Array<T>, equal_any_or_null?: Array<T>, not_equal_all?: Array<T>, is_null?: boolean, };

client/packages/plugins/backendTypes/generated/PluginDataFilter.ts

@@ -0,0 +1,4 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { EqualFilter } from "./EqualFilter";
+
+export type PluginDataFilter = { id?: EqualFilter<string>, plugin_code?: EqualFilter<string>, related_record_id?: EqualFilter<string>, data_identifier?: EqualFilter<string>, store_id?: EqualFilter<string>, };

client/packages/plugins/backendTypes/generated/PluginTypes.ts

@@ -2,8 +2,10 @@
 import type { AverageMonthlyConsumptionInput } from "./AverageMonthlyConsumptionInput";
 import type { AverageMonthlyConsumptionItem } from "./AverageMonthlyConsumptionItem";
 import type { Function } from "./Function";
+import type { PluginDataFilter } from "./PluginDataFilter";
+import type { PluginDataRow } from "./PluginDataRow";
 import type { StorePreferenceRow } from "./StorePreferenceRow";
-import type { TransformRequisitionLineInput } from "./TransformRequisitionLineInput";
-import type { TransformRequisitionLineOutput } from "./TransformRequisitionLineOutput";
+import type { TransformRequestRequisitionLineInput } from "./TransformRequestRequisitionLineInput";
+import type { TransformRequestRequisitionLineOutput } from "./TransformRequestRequisitionLineOutput";
 
-export type PluginTypes = { average_monthly_consumption: Function<AverageMonthlyConsumptionInput, { [key in string]?: AverageMonthlyConsumptionItem }>, transform_requisition_lines: Function<TransformRequisitionLineInput, TransformRequisitionLineOutput>, get_store_preferences: StorePreferenceRow, };
+export type PluginTypes = { average_monthly_consumption: Function<AverageMonthlyConsumptionInput, { [key in string]?: AverageMonthlyConsumptionItem }>, transform_request_requisition_lines: Function<TransformRequestRequisitionLineInput, TransformRequestRequisitionLineOutput>, get_store_preferences: StorePreferenceRow, get_plugin_data: Function<PluginDataFilter, Array<PluginDataRow>>, };

client/packages/plugins/backendTypes/generated/TransformRequestRequisitionLineInput.ts

@@ -0,0 +1,5 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { RequisitionLineRow } from "./RequisitionLineRow";
+import type { RequisitionRow } from "./RequisitionRow";
+
+export type TransformRequestRequisitionLineInput = { requisition: RequisitionRow, lines: Array<RequisitionLineRow>, };

client/packages/plugins/backendTypes/generated/TransformRequestRequisitionLineOutput.ts

@@ -0,0 +1,5 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { PluginDataRow } from "./PluginDataRow";
+import type { RequisitionLineRow } from "./RequisitionLineRow";
+
+export type TransformRequestRequisitionLineOutput = { transformed_lines: Array<RequisitionLineRow>, plugin_data?: Array<PluginDataRow>, };

client/packages/plugins/backendTypes/types.ts

@@ -4,9 +4,9 @@ export type BackendPlugins = {
   average_monthly_consumption?: (
     _: PluginTypes['average_monthly_consumption']['input']
   ) => PluginTypes['average_monthly_consumption']['output'];
-  transform_requisition_lines?: (
-    _: PluginTypes['transform_requisition_lines']['input']
-  ) => PluginTypes['transform_requisition_lines']['output'];
+  transform_request_requisition_lines?: (
+    _: PluginTypes['transform_request_requisition_lines']['input']
+  ) => PluginTypes['transform_request_requisition_lines']['output'];
 };
 
 declare global {
@@ -15,4 +15,7 @@ declare global {
   var get_store_preferences: (
     _: string
   ) => PluginTypes['get_store_preferences'];
+  var get_plugin_data: (
+    _: PluginTypes['get_plugin_data']['input']
+  ) => PluginTypes['get_plugin_data']['output'];
 }

client/packages/requisitions/src/RequestRequisition/DetailView/RequestLineEdit/RequestLineEdit.tsx

@@ -19,6 +19,7 @@ import {
   TextArea,
   useAuthContext,
   useNavigate,
+  usePluginProvider,
   useToggle,
 } from '@openmsupply-client/common';
 import { DraftRequestLine } from './hooks';
@@ -71,6 +72,7 @@ export const RequestLineEdit = ({
 }: RequestLineEditProps) => {
   const t = useTranslation();
   const navigate = useNavigate();
+  const { plugins } = usePluginProvider();
   const { isOn, toggle } = useToggle();
   const [anchorEl, setAnchorEl] = React.useState<null | HTMLElement>(null);
   const { store } = useAuthContext();
@@ -83,6 +85,9 @@ export const RequestLineEdit = ({
     ?.sort((a, b) => a.name.name.localeCompare(b.name.name))
     .sort((a, b) => b.amcInUnits - a.amcInUnits)
     .sort((a, b) => b.stockInUnits - a.stockInUnits);
+
+  const line = lines.find(line => line.id === draft?.id);
+
   return (
     <Box display="flex" flexDirection="column" padding={2}>
       <Box display="flex" justifyContent="space-between">
@@ -213,6 +218,10 @@ export const RequestLineEdit = ({
                 label={t('label.amc')}
                 sx={{ marginBottom: 1 }}
               />
+              {line &&
+                plugins.requestRequisitionColumn?.editViewColumns?.map(
+                  (Column, index) => <Column key={index} line={line} />
+                )}
               {isProgram && useConsumptionData && (
                 <InputWithLabelRow
                   Input={

client/packages/requisitions/src/RequestRequisition/DetailView/columns.ts

@@ -257,7 +257,7 @@ export const useRequestColumns = () => {
   const columns = useColumns<RequestLineFragment>(
     [
       ...columnDefinitions,
-      ...(plugins.requestRequisitionColumn?.columns || []),
+      ...(plugins.requestRequisitionColumn?.tableColumns || []),
     ],
     {
       onChangeSortBy: updateSortQuery,

server/repository/src/db_diesel/backend_plugin_row.rs

@@ -8,10 +8,10 @@ use diesel_derive_enum::DbEnum;
 use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Eq, PartialEq, Debug, Serialize, Deserialize)]
-#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
+#[serde(rename_all = "snake_case")]
 pub enum PluginType {
-    Amc,
-    TransformRequisitionLines,
+    AverageMonthlyConsumption,
+    TransformRequestRequisitionLines,
 }
 
 #[derive(Clone, PartialEq, Eq, Debug, Default, Serialize, Deserialize)]
@@ -201,7 +201,10 @@ mod test {
         let repo = BackendPluginRowRepository::new(&connection);
         let id = "backend_plugin_row".to_string();
 
-        let types = PluginTypes(vec![PluginType::Amc, PluginType::Amc]);
+        let types = PluginTypes(vec![
+            PluginType::AverageMonthlyConsumption,
+            PluginType::AverageMonthlyConsumption,
+        ]);
         let _ = repo.upsert_one(BackendPluginRow {
             id: id.clone(),
             types: types.clone(),
@@ -216,6 +219,9 @@ mod test {
             .unwrap();
 
         // Showing that types serializes to a readable text in DB field
-        assert_eq!(result[0].types, r#"["AMC","AMC"]"#);
+        assert_eq!(
+            result[0].types,
+            r#"["average_monthly_consumption","average_monthly_consumption"]"#
+        );
     }
 }

server/repository/src/db_diesel/filter_sort_pagination.rs

@@ -2,6 +2,7 @@ use std::ops::Range;
 
 use chrono::{NaiveDate, NaiveDateTime};
 use serde::{Deserialize, Serialize};
+use ts_rs::TS;
 use util::inline_init;
 
 #[derive(Clone, PartialEq, Debug, Default)]
@@ -101,16 +102,22 @@ impl StringFilter {
     }
 }
 
-#[derive(Clone, PartialEq, Debug, Serialize, Deserialize)]
+#[derive(Clone, PartialEq, Debug, TS, Serialize, Deserialize)]
 pub struct EqualFilter<T>
 where
     T: 'static,
 {
+    #[ts(optional)]
     pub equal_to: Option<T>,
+    #[ts(optional)]
     pub not_equal_to: Option<T>,
+    #[ts(optional)]
     pub equal_any: Option<Vec<T>>,
+    #[ts(optional)]
     pub equal_any_or_null: Option<Vec<T>>,
+    #[ts(optional)]
     pub not_equal_all: Option<Vec<T>>,
+    #[ts(optional)]
     pub is_null: Option<bool>,
 }
 

server/repository/src/db_diesel/plugin_data.rs

@@ -4,20 +4,26 @@ use crate::{
     diesel_macros::{apply_equal_filter, apply_sort_no_case},
     DBType, EqualFilter, Pagination, PluginDataRow, RepositoryError, Sort,
 };
-
 use diesel::prelude::*;
+use serde::{Deserialize, Serialize};
+use ts_rs::TS;
 
 #[derive(Debug, Clone, PartialEq)]
 pub struct PluginData {
     pub plugin_data: PluginDataRow,
 }
 
-#[derive(Clone, PartialEq, Debug, Default)]
+#[derive(Clone, PartialEq, Debug, Default, TS, Serialize, Deserialize)]
 pub struct PluginDataFilter {
+    #[ts(optional)]
     pub id: Option<EqualFilter<String>>,
+    #[ts(optional)]
     pub plugin_code: Option<EqualFilter<String>>,
+    #[ts(optional)]
     pub related_record_id: Option<EqualFilter<String>>,
+    #[ts(optional)]
     pub data_identifier: Option<EqualFilter<String>>,
+    #[ts(optional)]
     pub store_id: Option<EqualFilter<String>>,
 }
 

server/service/src/backend_plugin/boajs/call_plugin.rs

@@ -5,6 +5,7 @@ use boa_engine::{
     JsValue, Module, Source,
 };
 
+use repository::PluginType;
 use serde::{de::DeserializeOwned, Serialize};
 use thiserror::Error;
 
@@ -30,16 +31,22 @@ impl PartialEq for BoaJsPluginError {
     }
 }
 
+fn plugin_type_to_string(r#type: &PluginType) -> String {
+    serde_json::to_string(r#type).unwrap().replace("\"", "")
+}
+
 pub(crate) fn call_plugin<I, O>(
     input: I,
-    name: &str,
+    r#type: &PluginType,
     bundle: &Vec<u8>,
 ) -> Result<O, BoaJsPluginError>
 where
     I: Serialize,
     O: DeserializeOwned,
 {
     use BoaJsPluginError as Error;
+    let r#type = plugin_type_to_string(r#type);
+
     // Initialise context with loader
     let loader = Rc::new(SimpleModuleLoader::new(Path::new("."))?);
     let mut context = &mut Context::builder().module_loader(loader.clone()).build()?;
@@ -53,28 +60,29 @@ where
     context.run_jobs();
     match promise.state() {
         PromiseState::Fulfilled(JsValue::Undefined) => {}
-        _ => return Err(Error::LoadingModule(name.to_string())),
+        _ => return Err(Error::LoadingModule(r#type.clone())),
     }
 
     // TODO should these be bound as camel case ? Also for inputs and outputs ?
     methods::log::bind_method(context)?;
     methods::sql::bind_method(context)?;
     methods::sql_type::bind_method(context)?;
     methods::get_store_preferences::bind_method(context)?;
+    methods::get_plugin_data::bind_method(context)?;
 
     let namespace = module.namespace(context);
     let plugins = namespace
         .get(js_string!("plugins"), context)?
         .as_object()
         .cloned()
-        .ok_or_else(|| Error::PluginNamespaceMissing(name.to_string()))?;
+        .ok_or_else(|| Error::PluginNamespaceMissing(r#type.clone()))?;
 
-    let key = js_string!(name);
+    let key = js_string!(r#type.as_str());
     let plugin = plugins
         .get(key, context)?
         .as_callable()
         .cloned()
-        .ok_or_else(|| Error::PluginMissing(name.to_string()))?;
+        .ok_or_else(|| Error::PluginMissing(r#type.clone()))?;
 
     let input: serde_json::Value = serde_json::to_value(&input)?;
     let js_input = JsValue::from_json(&input, &mut context)?;

server/service/src/backend_plugin/boajs/methods/get_plugin_data.rs

@@ -0,0 +1,35 @@
+use boa_engine::*;
+use repository::{PluginDataFilter, PluginDataRepository, PluginDataRow};
+
+use crate::backend_plugin::{boajs::utils::*, plugin_provider::PluginContext};
+
+pub(crate) fn bind_method(context: &mut Context) -> Result<(), JsError> {
+    context.register_global_callable(
+        JsString::from("get_plugin_data"),
+        0,
+        NativeFunction::from_copy_closure(move |_, args, mut ctx| {
+            // TODO Is this actually safe ? (need to check reference counts after plugin has run)
+            let service_provider = PluginContext::service_provider();
+
+            let filter: PluginDataFilter = get_serde_argument(&mut ctx, args, 0)?;
+
+            let connection = service_provider
+                .connection()
+                .map_err(std_error_to_js_error)?;
+
+            // TODO pagination or restrictions ?
+            let plugin_data: Vec<PluginDataRow> = PluginDataRepository::new(&connection)
+                .query_by_filter(filter)
+                .map_err(std_error_to_js_error)?
+                .into_iter()
+                .map(|r| r.plugin_data)
+                .collect();
+
+            let value: serde_json::Value =
+                serde_json::to_value(&plugin_data).map_err(std_error_to_js_error)?;
+            // We return the moved variable as a `JsValue`.
+            Ok(JsValue::from_json(&value, ctx)?)
+        }),
+    )?;
+    Ok(())
+}

server/service/src/backend_plugin/boajs/methods/mod.rs

@@ -1,3 +1,4 @@
+pub(crate) mod get_plugin_data;
 pub(crate) mod get_store_preferences;
 pub(crate) mod log;
 pub(crate) mod sql;

server/service/src/backend_plugin/boajs/utils.rs

@@ -1,6 +1,7 @@
 use std::string::FromUtf16Error;
 
-use boa_engine::{js_string, JsError, JsValue};
+use boa_engine::{js_string, Context, JsError, JsValue};
+use serde::de::DeserializeOwned;
 use std::error::Error as StandardError;
 use thiserror::Error;
 use util::format_error;
@@ -19,13 +20,11 @@ pub(super) fn get_string_argument(args: &[JsValue], index: usize) -> Result<Stri
     use GetStringArgumentError as Error;
 
     let closure = move || -> Result<String, GetStringArgumentError> {
-        let Some(arg) = args.get(index) else {
-            return Err(Error::NoArgumentAtIndex(index));
-        };
+        let arg = args.get(index).ok_or(Error::NoArgumentAtIndex(index))?;
 
-        let Some(arg) = arg.as_string() else {
-            return Err(Error::ArgumentAtIndexIsNotAString(index));
-        };
+        let arg = arg
+            .as_string()
+            .ok_or(Error::ArgumentAtIndexIsNotAString(index))?;
 
         Ok(arg.to_std_string()?)
     };
@@ -37,3 +36,31 @@ pub(super) fn std_error_to_js_error(error: impl StandardError) -> JsError {
     let as_string = JsValue::String(js_string!(format_error(&error)));
     JsError::from_opaque(as_string)
 }
+
+#[derive(Debug, Error)]
+enum GetJsonArgumentError {
+    #[error("No argument at index {0}")]
+    NoArgumentAtIndex(usize),
+    #[error(transparent)]
+    JsError(#[from] JsError),
+    #[error(transparent)]
+    SerdeError(#[from] serde_json::Error),
+}
+
+pub(super) fn get_serde_argument<D: DeserializeOwned>(
+    context: &mut Context,
+    args: &[JsValue],
+    index: usize,
+) -> Result<D, JsError> {
+    use GetJsonArgumentError as Error;
+
+    let mut closure = move || -> Result<D, GetJsonArgumentError> {
+        let arg = args.get(index).ok_or(Error::NoArgumentAtIndex(index))?;
+
+        let value = arg.to_json(context)?;
+
+        Ok(serde_json::from_value(value)?)
+    };
+
+    closure().map_err(std_error_to_js_error)
+}