@redsift/table 9.2.4-muiv5 → 9.3.0-muiv5

package/index.d.ts

@@ -82,11 +82,22 @@ type StyledDataGridProps = {
 
 declare const DataGrid: Comp<DataGridProps, HTMLDivElement>;
 
+type CompletionResponse = {
+    linkOperator: 'and' | 'or';
+    items: [
+        {
+            columnField: string;
+            operatorValue: string;
+            value?: string;
+        }
+    ];
+};
 interface FilterConfig {
     columns: object[];
     typeOperators: object;
     notes: string;
-    openaiApiKey: string | undefined;
+    openaiApiKey?: string;
+    completionFunc?: (nlpFilterConfig: FilterConfig, prompt: string, model: string) => Promise<CompletionResponse>;
 }
 
 type GridToolbarColumnsProps = Omit<typeof GridToolbarColumnsButton, 'ref'>;

package/index.js

@@ -2,7 +2,7 @@ import { GRID_DETAIL_PANEL_TOGGLE_COL_DEF, getGridNumericOperators as getGridNum
 export { getGridBooleanOperators, getGridDateOperators, getGridSingleSelectOperators } from '@mui/x-data-grid-pro';
 import * as React from 'react';
 import React__default, { Children, isValidElement, cloneElement, useLayoutEffect, useEffect, useRef, forwardRef, useState, useCallback, createElement } from 'react';
-import { Icon, baseContainer, useId as useId$2, partitionComponents, isComponent, Flexbox, TextField as TextField$2, Button, Switch, CtasColorPalette, NotificationsColorPalette, IconButton as IconButton$2, Checkbox, Text, LinkButton, Shield } from '@redsift/design-system';
+import { Icon, baseContainer, useId as useId$2, partitionComponents, isComponent, Flexbox, TextField as TextField$2, Button, Switch, Text, CtasColorPalette, NotificationsColorPalette, IconButton as IconButton$2, Checkbox, LinkButton, Shield } from '@redsift/design-system';
 import { mdiSync, mdiFilterVariant, mdiViewColumn, mdiChevronUp, mdiChevronDown, mdiViewHeadline, mdiViewSequential, mdiViewStream, mdiChevronRight, mdiTrayArrowDown } from '@redsift/icons';
 import emStyled from '@emotion/styled';
 import { Global, ThemeContext, keyframes } from '@emotion/react';
@@ -21660,12 +21660,7 @@ const StyledGridToolbarFilterSemanticField = styled$3.form`
 const API_URL = 'https://api.openai.com/v1/chat/completions';
 async function getCompletion(text, role, openai_api_key) {
   let model = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 'gpt-3.5-turbo-0613';
-  let verbose = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : true;
-  /**
-   * Returns the text responded by GPT.
-   */
   try {
-    const t0 = new Date();
     const messages = [{
       role: 'system',
       content: role
@@ -21673,15 +21668,8 @@ async function getCompletion(text, role, openai_api_key) {
       role: 'user',
       content: text
     }];
-    if (verbose) {
-      console.log('******************************');
-      console.log('prompt:', text);
-      console.log('model:', model);
-      console.log('characters count (4 chars ~ 1 token)');
-      console.log(`-   system=${role.length}`);
-      console.log(`-     user=${text.length}`);
-    }
-    const response = await fetch(API_URL, {
+    const url = API_URL;
+    const response = await fetch(url, {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
@@ -21694,15 +21682,6 @@ async function getCompletion(text, role, openai_api_key) {
       })
     });
     const data = await response.json();
-    if (verbose) {
-      const t1 = new Date();
-      const t = (role.length + text.length + data.choices[0].message.content.length) / 4;
-      console.log(`- response=${data.choices[0].message.content.length}`);
-      console.log(`total is about ${t.toFixed(0)} tokens and took ${// @ts-ignore
-      ((t1 - t0) / 1000).toFixed(0)} seconds to complete`);
-      console.log('response:');
-      console.log(data.choices[0].message.content);
-    }
     return data.choices[0].message.content;
   } catch (error) {
     return '';
@@ -21713,77 +21692,66 @@ const _excluded$e = ["className", "nlpFilterConfig", "onFilterModelChange"];
 const COMPONENT_NAME$2 = 'GridToolbarFilterSemanticField';
 const CLASSNAME$2 = 'redsift-datagrid-toolbar-nlp-filter-field';
 const DATE_FORMAT = 'yyyy-mm-dd';
+const DEFAULT_GPT_MODEL = 'gpt-4-0613';
 const DEFAULT_FILTER = {
   items: []
 };
-const ROLE = `The AI assistant parses user input to generate a JSON object that will be used as a row filter for a data table MUI Data Grid.
+const getRole = config => {
+  const today = new Date().toDateString();
+  const columns = `[${config.columns.map(_ref => {
+    let {
+      field
+    } = _ref;
+    return `"${field}"`;
+  }).join(', ')}]`;
+  const operators = Object.entries(config.typeOperators).map(_ref2 => {
+    let [k, values] = _ref2;
+    return values.length === 1 ? `    - For "${k}" data type, operator must only be "${values[0]}"` : `    - For "${k}" data type, operator must be one of [${values.map(v => `"${v}"`).join(', ')}]`;
+  }).join('\n');
+  const column_description = config.columns.map(_ref3 => {
+    let {
+      field,
+      type,
+      description
+    } = _ref3;
+    return `- "${field}": "${type}" data type; ${description ? description.trim() : ''}`;
+  }).join('\n');
+  return `The AI assistant parses user input to generate a JSON object that will be used as a row filter for a data table MUI Data Grid.
 The filter supports mulitple conditions using only two logical operator "and", "or". It only allows "and" between all conditions or "or" between all conditions. It can't mix the two types.
 The AI assistant extracts information from the user input and generates a JSON object with exactly the two keys "linkOperator" and "items":
 - "linkOperator": the logical operator, only "and" or "or" are allowed. If there is only one condition in the "items", use "and".
 - "items": a list of conditions, each is an object with exactly the three keys "columnField", "operatorValue" and "value":
-  - "columnField": the column name, must be one of {{columns}}
-  - "value": 
+  - "columnField": the column name, must be one of ${columns}
+  - "value":
     - this can be skipped if the "operatorValue" is either "isEmpty" or "isNotEmpty"
     - a list of multiple values if the "operatorValue" ends with "AnyOf"
-    - otherwise, it's a single value represented as a string: "true" instead of true, "false" instead of false, "0.6" instead of 0.6. 
-    For "date" data type, use ${DATE_FORMAT}. If relative date is input, convert to the actual date given today is {{today}}.
+    - otherwise, it's a single value represented as a string: "true" instead of true, "false" instead of false, "0.6" instead of 0.6.
+    For "date" data type, use ${DATE_FORMAT}. If relative date is input, convert to the actual date given today is ${today}.
   - "operatorValue": the comparison operator, accepted values depend on the data type of the column
-{{type operators}}
+${operators}
 
 Below is the datatype in square bracket, constraints on the data range if any, followed by the description of each column used in the data table:
-{{column description}}
+${column_description}
 
 Notes:
 - For "boolean" data type, use "is" operator with value "false" instead of "isEmpty".
-{{notes}}
+${config.notes.trim()}
 
 Pay close attention to the the data type, description and supported operators above to make a valid selection of fields.
 Think step by step and check carefully if the chosen operator is supported by the chosen data type.
 Return just the JSON object without any extra text, explanation or note.
-If the user input can't be parsed, return a JSON object to indicate the error and the reason {"code":"error", "reason":"explain why it was failed to parse"}.`;
-function fillSlots(role, config) {
-  // Today
-  const todayText = new Date().toDateString();
-  role = role.replace('{{today}}', todayText);
-
-  // Column names
-  const columnText = '[' + config.columns.map(_ref => {
-    let {
-      field
-    } = _ref;
-    return `"${field}"`;
-  }).join(', ') + ']';
-  role = role.replace('{{columns}}', columnText);
-
-  // Type operators
-  const opreatorText = Object.entries(config.typeOperators).map(_ref2 => {
-    let [k, values] = _ref2;
-    if (values.length == 1) {
-      return `    - For "${k}" data type, operator must only be "${values[0]}"`;
-    } else {
-      const types = '[' + values.map(v => `"${v}"`).join(', ') + ']';
-      return `    - For "${k}" data type, operator must be one of ${types}`;
-    }
-  }).join('\n');
-  role = role.replace('{{type operators}}', opreatorText);
-
-  // Column description
-  // const descriptionText = config.columns.map(({field, type, description}) => `- "${field}": "${type}" data type; operators must be one of [${config.typeOperators[type].map(v => '"' + v + '"').join(', ')}]; ${description.trim()}`).join('\n');
-  const descriptionText = config.columns.map(_ref3 => {
-    let {
-      field,
-      type,
-      description
-    } = _ref3;
-    return `- "${field}": "${type}" data type; ${description ? description.trim() : ''}`;
-  }).join('\n');
-  role = role.replace('{{column description}}', descriptionText);
-
-  // Notes
-  role = role.replace('{{notes}}', config.notes.trim());
-
-  // console.log(role);
-  return role;
+If the user input can't be parsed, return a JSON object to indicate the error and the reason {"code":"error", "reason":"explain why it was failed to parse"}.
+`;
+};
+async function getOpenAICompletion(config, prompt, model) {
+  const text = 'Parse the text delimited by triple backticks: ```' + prompt.trim() + '``` and make sure the output is a valid JSON object';
+  const role = getRole(config);
+  const completion = await getCompletion(text, role, config.openaiApiKey, model);
+  const response = JSON.parse(completion);
+  if ('code' in response) {
+    throw new Error(response.reason);
+  }
+  return response;
 }
 
 /**
@@ -21798,7 +21766,8 @@ const GridToolbarFilterSemanticField = /*#__PURE__*/forwardRef((props, ref) => {
     } = props,
     forwardedProps = _objectWithoutProperties(props, _excluded$e);
   const [prompt, setPrompt] = useState('');
-  const [model, setModel] = useState('gpt-4-0613');
+  const modelRef = useRef(DEFAULT_GPT_MODEL);
+  const showErrorRef = useRef(false);
   const [isLoading, setIsLoading] = useState(false);
   const handlePromptSubmit = async event => {
     event.preventDefault();
@@ -21810,36 +21779,33 @@ const GridToolbarFilterSemanticField = /*#__PURE__*/forwardRef((props, ref) => {
       const response = sessionStorage.getItem(prompt);
       if (response && response !== JSON.stringify(DEFAULT_FILTER)) {
         filter = JSON.parse(response);
-        console.log('filter from cache:', filter);
       } else {
         setIsLoading(true);
-        const role = fillSlots(ROLE, nlpFilterConfig);
-        const text = 'Parse the text delimited by triple backticks: ```' + prompt.trim() + '``` and make sure the output is a valid JSON object';
-        const output_str = await getCompletion(text, role, nlpFilterConfig.openaiApiKey, model);
+        showErrorRef.current = false;
         try {
-          filter = JSON.parse(output_str);
-          if (filter.code === 'error') {
-            console.log('GPT does not understand input', filter.reason);
-            filter = DEFAULT_FILTER;
+          if (nlpFilterConfig.completionFunc !== undefined) {
+            filter = await nlpFilterConfig.completionFunc(nlpFilterConfig, prompt, modelRef.current);
           } else {
-            sessionStorage.setItem(prompt, output_str);
+            filter = await getOpenAICompletion(nlpFilterConfig, prompt, modelRef.current);
           }
+          sessionStorage.setItem(prompt, JSON.stringify(filter));
         } catch (error) {
-          console.log(error);
+          showErrorRef.current = true;
           filter = DEFAULT_FILTER;
         }
 
         // MUI requires different id
-        filter.items.forEach((d, i) => {
-          d.id = i;
-        });
-        console.log('filter:', filter);
+        filter.items.forEach((d, i) => d.id = i);
       }
       onFilterModelChange(filter);
       setIsLoading(false);
     }
   };
-  return /*#__PURE__*/React__default.createElement(StyledGridToolbarFilterSemanticField, _extends$2({}, forwardedProps, {
+  return /*#__PURE__*/React__default.createElement(Flexbox, {
+    flexDirection: "column",
+    gap: "0",
+    width: "100%"
+  }, /*#__PURE__*/React__default.createElement(StyledGridToolbarFilterSemanticField, _extends$2({}, forwardedProps, {
     className: classNames(GridToolbarFilterSemanticField.className, className),
     ref: fieldRef,
     onSubmit: handlePromptSubmit
@@ -21857,13 +21823,14 @@ const GridToolbarFilterSemanticField = /*#__PURE__*/forwardRef((props, ref) => {
     "aria-label": "Submit",
     type: "submit",
     isLoading: isLoading
-  }, "Run")), /*#__PURE__*/React__default.createElement(Tooltip, null, /*#__PURE__*/React__default.createElement(Tooltip.Trigger, null, /*#__PURE__*/React__default.createElement(Switch
-  // style={{"display":"none"}} // Hide it for the demo
-  , {
+  }, "Run")), /*#__PURE__*/React__default.createElement(Tooltip, null, /*#__PURE__*/React__default.createElement(Tooltip.Trigger, null, /*#__PURE__*/React__default.createElement(Switch, {
     width: "175px",
-    isSelected: model === 'gpt-4-0613',
-    onChange: value => setModel(value ? 'gpt-4-0613' : 'gpt-3.5-turbo-0613')
-  }, "Power mode")), /*#__PURE__*/React__default.createElement(Tooltip.Content, null, "The Power mode can get better results but is slower.")));
+    isSelected: modelRef.current === 'gpt-4-0613',
+    onChange: value => modelRef.current = value ? 'gpt-4-0613' : 'gpt-3.5-turbo-0613'
+  }, "Power mode")), /*#__PURE__*/React__default.createElement(Tooltip.Content, null, "The Power mode can get better results but is slower."))), showErrorRef.current && /*#__PURE__*/React__default.createElement(Text, {
+    color: "error",
+    marginLeft: "8px"
+  }, "Unable to find a valid filter, please try again with a more specific prompt."));
 });
 GridToolbarFilterSemanticField.className = CLASSNAME$2;
 GridToolbarFilterSemanticField.displayName = COMPONENT_NAME$2;