@gitlab/duo-ui 0.1.0 → 0.3.0

package/dist/components/chat/mock_data.js

@@ -0,0 +1,162 @@
+import { setStoryTimeout } from '@gitlab/ui/dist/utils/test_utils';
+import { DOCUMENTATION_SOURCE_TYPES, MESSAGE_MODEL_ROLES, CHAT_RESET_MESSAGE, CHAT_CLEAR_MESSAGE, CHAT_INCLUDE_MESSAGE } from './constants';
+import { getMockContextItems } from './components/duo_chat_context/mock_context_data';
+
+const MOCK_SOURCES = [{
+  title: 'GitLab Handbook',
+  source_type: DOCUMENTATION_SOURCE_TYPES.HANDBOOK.value,
+  source_url: '/handbook/'
+}, {
+  stage: 'Mock Stage',
+  group: 'Mock Group',
+  source_type: DOCUMENTATION_SOURCE_TYPES.DOC.value,
+  source_url: '/company/team/'
+}, {
+  date: '2023-04-21',
+  author: 'Test User',
+  source_type: DOCUMENTATION_SOURCE_TYPES.BLOG.value,
+  source_url: '/blog/'
+}];
+const MOCK_RESPONSE_MESSAGE = {
+  id: '123',
+  content: 'Here is a simple JavaScript function to sum two numbers:\n\n  ```js\n  function sum(a, b) {\n    return a + b;\n  }\n  ```\n  \n  To use it:\n  \n  ```js\n  const result = sum(5, 3); // result = 8\n  ```\n  \n  This function takes two number parameters, a and b. It returns the sum of adding them together.\n',
+  contentHtml: '<p data-sourcepos="1:1-1:56" dir="auto">Here is a simple JavaScript function to sum two numbers:</p>\n<div class="gl-relative markdown-code-block js-markdown-code">\n<pre data-sourcepos="3:1-7:3" data-canonical-lang="js" class="code highlight js-syntax-highlight language-javascript" lang="javascript" v-pre="true"><code><span id="LC1" class="line" lang="javascript"><span class="kd">function</span> <span class="nf">sum</span><span class="p">(</span><span class="nx">a</span><span class="p">,</span> <span class="nx">b</span><span class="p">)</span> <span class="p">{</span></span>\n<span id="LC2" class="line" lang="javascript">  <span class="k">return</span> <span class="nx">a</span> <span class="o">+</span> <span class="nx">b</span><span class="p">;</span></span>\n<span id="LC3" class="line" lang="javascript"><span class="p">}</span></span></code></pre>\n<copy-code></copy-code>\n<insert-code-snippet></insert-code-snippet>\n</div>\n<p data-sourcepos="9:1-9:10" dir="auto">To use it:</p>\n<div class="gl-relative markdown-code-block js-markdown-code">\n<pre data-sourcepos="11:1-13:3" data-canonical-lang="js" class="code highlight js-syntax-highlight language-javascript" lang="javascript" v-pre="true"><code><span id="LC1" class="line" lang="javascript"><span class="kd">const</span> <span class="nx">result</span> <span class="o">=</span> <span class="nf">sum</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">3</span><span class="p">);</span> <span class="c1">// result = 8</span></span></code></pre>\n<copy-code></copy-code>\n</div>\n<p data-sourcepos="15:1-15:95" dir="auto">This function takes two number parameters, a and b. It returns the sum of adding them together.</p>',
+  role: MESSAGE_MODEL_ROLES.assistant,
+  extras: {
+    sources: MOCK_SOURCES,
+    contextItems: getMockContextItems().slice(0, 2)
+  },
+  requestId: '987',
+  errors: [],
+  timestamp: '2021-04-21T12:00:00.000Z'
+};
+const generateSeparateChunks = n => {
+  const res = [];
+  for (let i = 1; i <= n; i += 1) {
+    res.push({
+      chunkId: i,
+      content: `chunk #${i}`,
+      role: MESSAGE_MODEL_ROLES.assistant,
+      requestId: '987',
+      errors: [],
+      timestamp: '2021-04-21T12:00:00.000Z'
+    });
+  }
+  return res;
+};
+const MOCK_RESPONSE_MESSAGE_FOR_STREAMING = {
+  id: '123',
+  content: `To change your password in GitLab:
+
+  1. Log in to your GitLab account.
+  2. Select your avatar in the top right corner and choose Edit profile.
+  3. On the left sidebar, select Password.
+  4. Enter your current password in the Current password field.
+  5. Enter your new password in the New password and Password confirmation fields.
+  6. Select Save password.
+  7. If you don't know your current password, select the I forgot my password link to reset it.
+
+  GitLab enforces password requirements when you choose a new password.
+
+  ~~~yaml
+  # And here is a
+  # code block
+  everyone:
+    likes:
+      yaml: true
+  ~~~
+  which is rendered while streaming.
+  `,
+  role: 'assistant',
+  extras: {
+    contextItems: getMockContextItems().slice(0, 2)
+  },
+  requestId: '987',
+  errors: [],
+  timestamp: '2021-04-21T12:00:00.000Z'
+};
+
+// Utility function for delay
+async function delayRandom() {
+  let min = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 16;
+  let max = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 267;
+  const delay = Math.floor(Math.random() * (max - min + 1)) + min;
+  // eslint-disable-next-line no-promise-executor-return
+  return new Promise(resolve => setStoryTimeout(resolve, delay));
+}
+function generateMockResponseChunks() {
+  try {
+    let requestId = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
+    return async function* () {
+      const chunkSize = 5;
+      const contentLength = MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content.length;
+      const chunkCount = Math.ceil(contentLength / chunkSize);
+      for (let chunkId = 0; chunkId < chunkCount; chunkId += 1) {
+        const start = chunkId * chunkSize;
+        const end = Math.min((chunkId + 1) * chunkSize, contentLength);
+        const chunk = {
+          ...MOCK_RESPONSE_MESSAGE_FOR_STREAMING,
+          requestId,
+          content: MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content.substring(start, end),
+          chunkId: chunkId + 1
+        };
+
+        // eslint-disable-next-line no-await-in-loop
+        await delayRandom();
+        yield chunk;
+      }
+      yield {
+        ...MOCK_RESPONSE_MESSAGE_FOR_STREAMING,
+        requestId,
+        content: MOCK_RESPONSE_MESSAGE_FOR_STREAMING.content,
+        chunkId: null
+      };
+    }();
+  } catch (e) {
+    return Promise.reject(e);
+  }
+}
+const MOCK_USER_PROMPT_MESSAGE = {
+  id: '456',
+  chunkId: null,
+  content: 'How to create a new template?',
+  contentHtml: '<p>How to create a new template?</p>',
+  role: MESSAGE_MODEL_ROLES.user,
+  requestId: '987',
+  errors: [],
+  timestamp: '2021-04-21T12:00:00.000Z',
+  extras: {
+    contextItems: getMockContextItems().slice(0, 2)
+  }
+};
+const renderMarkdown = content => content;
+const renderGFM = el => {
+  const codeBlock = el.querySelectorAll('.markdown-code-block');
+  codeBlock.forEach(block => {
+    block === null || block === void 0 ? void 0 : block.classList.add('duo-chat-markdown', 'duo-chat-compact-markdown');
+  });
+};
+const SLASH_COMMANDS = [{
+  name: CHAT_RESET_MESSAGE,
+  shouldSubmit: true,
+  description: 'Reset conversation, ignore the previous messages.'
+}, {
+  name: CHAT_CLEAR_MESSAGE,
+  shouldSubmit: true,
+  description: 'Delete all messages in this conversation.'
+}, {
+  name: '/tests',
+  description: 'Write tests for the selected snippet.'
+}, {
+  name: '/refactor',
+  description: 'Refactor the selected snippet.'
+}, {
+  name: '/explain',
+  description: 'Explain the selected snippet.'
+}];
+const INCLUDE_SLASH_COMMAND = {
+  name: CHAT_INCLUDE_MESSAGE,
+  description: 'Include additional context in the conversation.'
+};
+
+export { INCLUDE_SLASH_COMMAND, MOCK_RESPONSE_MESSAGE, MOCK_RESPONSE_MESSAGE_FOR_STREAMING, MOCK_USER_PROMPT_MESSAGE, SLASH_COMMANDS, generateMockResponseChunks, generateSeparateChunks, renderGFM, renderMarkdown };

package/dist/components/user_feedback/user_feedback.js

@@ -0,0 +1,97 @@
+import { GlAlert, GlButton } from '@gitlab/ui';
+import FeedbackModal from './user_feedback_modal';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+const i18n = {
+  FEEDBACK_LINK_TEXT: 'Give feedback to improve this answer.',
+  FEEDBACK_THANKS: 'Thank you for your feedback.'
+};
+var script = {
+  name: 'GlDuoUserFeedback',
+  components: {
+    GlAlert,
+    GlButton,
+    FeedbackModal
+  },
+  props: {
+    /**
+     * Whether the message already has gotten feedback
+     */
+    feedbackReceived: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * The text to be displayed as the feedback link/button.
+     */
+    feedbackLinkText: {
+      type: String,
+      required: false,
+      default: i18n.FEEDBACK_LINK_TEXT
+    },
+    /**
+     * The URL of a page to provide more explanations on the experiment. If provided, clicking
+     * the feedback link will open a new tab with the URL instead of showing the feedback modal.
+     */
+    feedbackLinkUrl: {
+      type: String,
+      required: false,
+      default: ''
+    }
+  },
+  computed: {
+    shouldRenderModal() {
+      return !this.feedbackReceived && !this.feedbackLinkUrl;
+    }
+  },
+  methods: {
+    notify(event) {
+      /**
+       * Notify listeners about the feedback form submission.
+       * @param {*} event An event, containing the feedback choices and the extended feedback text.
+       */
+      this.$emit('feedback', event);
+    }
+  },
+  i18n
+};
+
+/* script */
+const __vue_script__ = script;
+
+/* template */
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('div',{staticClass:"gl-w-full gl-pt-4"},[_c('div',[(!_vm.feedbackReceived)?_c('gl-button',{attrs:{"variant":"link","target":"_blank","href":_vm.feedbackLinkUrl,"button-text-classes":"!gl-whitespace-normal gl-text-left"},on:{"click":function($event){_vm.shouldRenderModal && _vm.$refs.feedbackModal.show();}}},[_vm._v(_vm._s(_vm.feedbackLinkText))]):_c('gl-alert',{attrs:{"variant":"success","dismissible":false}},[_vm._v("\n      "+_vm._s(_vm.$options.i18n.FEEDBACK_THANKS)+"\n    ")])],1),_vm._v(" "),(_vm.shouldRenderModal)?_c('feedback-modal',{ref:"feedbackModal",on:{"feedback-submitted":_vm.notify},scopedSlots:_vm._u([{key:"feedback-extra-fields",fn:function(){return [_vm._t("feedback-extra-fields")]},proxy:true}],null,true)}):_vm._e()],1)};
+var __vue_staticRenderFns__ = [];
+
+  /* style */
+  const __vue_inject_styles__ = undefined;
+  /* scoped */
+  const __vue_scope_id__ = undefined;
+  /* module identifier */
+  const __vue_module_identifier__ = undefined;
+  /* functional template */
+  const __vue_is_functional_template__ = false;
+  /* style inject */
+  
+  /* style inject SSR */
+  
+  /* style inject shadow dom */
+  
+
+  
+  const __vue_component__ = __vue_normalize__(
+    { render: __vue_render__, staticRenderFns: __vue_staticRenderFns__ },
+    __vue_inject_styles__,
+    __vue_script__,
+    __vue_scope_id__,
+    __vue_is_functional_template__,
+    __vue_module_identifier__,
+    false,
+    undefined,
+    undefined,
+    undefined
+  );
+
+export default __vue_component__;
+export { i18n };

package/dist/components/user_feedback/user_feedback_modal.js

@@ -0,0 +1,149 @@
+import { GlModal, GlAlert, GlFormCheckboxGroup, GlFormGroup, GlFormTextarea } from '@gitlab/ui';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+const i18n = {
+  MODAL: {
+    TITLE: 'Give feedback on GitLab Duo',
+    DESCRIPTION: 'To help improve GitLab Duo, send your feeback to GitLab team members.',
+    ALERT: 'GitLab team members cannot see the AI content. Please be as descriptive as possible.',
+    OPTIONS_LABEL: 'How could the AI content be improved?',
+    SITUATION_DESCRIPTION_LABEL: 'What were you doing?',
+    SITUATION_DESCRIPTION_PLACEHOLDER: 'The situation in which you interacted with GitLab Duo Chat.',
+    IMPROVEMENT_SUGGESTION_LABEL: 'How could the response be improved?',
+    IMPROVEMENT_SUGGESTION_PLACEHOLDER: 'How the response might better meet your needs.',
+    MORE_LABEL: 'More information',
+    MORE_PLACEHOLDER: 'How could the content be improved?',
+    REQUIRED_VALIDATION_ERROR: 'Select at least one option.',
+    FEEDBACK_OPTIONS: {
+      helpful: 'Helpful',
+      unhelpful: 'Unhelpful or irrelevant',
+      incorrect: 'Factually incorrect',
+      long: 'Too long',
+      abuse: 'Abusive or offensive',
+      other: 'Something else'
+    },
+    ACTIONS: {
+      submit: 'Submit',
+      cancel: 'Cancel'
+    }
+  }
+};
+const feedbackOptions = [{
+  text: i18n.MODAL.FEEDBACK_OPTIONS.helpful,
+  value: 'helpful'
+}, {
+  text: i18n.MODAL.FEEDBACK_OPTIONS.unhelpful,
+  value: 'unhelpful'
+}, {
+  text: i18n.MODAL.FEEDBACK_OPTIONS.incorrect,
+  value: 'incorrect'
+}, {
+  text: i18n.MODAL.FEEDBACK_OPTIONS.long,
+  value: 'long'
+}, {
+  text: i18n.MODAL.FEEDBACK_OPTIONS.abuse,
+  value: 'abuse'
+}, {
+  text: i18n.MODAL.FEEDBACK_OPTIONS.other,
+  value: 'other'
+}];
+var script = {
+  name: 'DuoChatFeedbackModal',
+  components: {
+    GlModal,
+    GlAlert,
+    GlFormCheckboxGroup,
+    GlFormGroup,
+    GlFormTextarea
+  },
+  inject: {
+    modalTitle: {
+      default: i18n.MODAL.TITLE
+    },
+    modalAlert: {
+      default: i18n.MODAL.ALERT
+    }
+  },
+  data() {
+    return {
+      selectedFeedbackOptions: [],
+      extendedFeedback: '',
+      isValid: null
+    };
+  },
+  watch: {
+    selectedFeedbackOptions(options) {
+      this.isValid = options.length > 0;
+    }
+  },
+  methods: {
+    close() {
+      this.$refs.feedbackModal.hide();
+    },
+    show() {
+      this.$refs.feedbackModal.show();
+    },
+    onFeedbackSubmit(e) {
+      if (this.selectedFeedbackOptions.length) {
+        this.$emit('feedback-submitted', {
+          feedbackChoices: this.selectedFeedbackOptions,
+          extendedTextFeedback: this.extendedFeedback
+        });
+        this.close();
+        this.isValid = null;
+      } else {
+        e === null || e === void 0 ? void 0 : e.preventDefault();
+        this.isValid = false;
+      }
+    }
+  },
+  actions: {
+    primary: {
+      text: i18n.MODAL.ACTIONS.submit
+    },
+    cancel: {
+      text: i18n.MODAL.ACTIONS.cancel
+    }
+  },
+  feedbackOptions,
+  i18n
+};
+
+/* script */
+const __vue_script__ = script;
+
+/* template */
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('gl-modal',{ref:"feedbackModal",attrs:{"modal-id":"feedbackModal","title":_vm.modalTitle,"action-primary":_vm.$options.actions.primary,"action-cancel":_vm.$options.actions.cancel,"visible":false,"size":"sm"},on:{"primary":_vm.onFeedbackSubmit,"canceled":_vm.close}},[_c('p',[_vm._v(_vm._s(_vm.$options.i18n.MODAL.DESCRIPTION))]),_vm._v(" "),_c('gl-form-group',{attrs:{"invalid-feedback":_vm.$options.i18n.MODAL.REQUIRED_VALIDATION_ERROR,"state":_vm.isValid,"label":_vm.$options.i18n.MODAL.OPTIONS_LABEL,"data-testid":"feedback-options"}},[_c('gl-form-checkbox-group',{attrs:{"options":_vm.$options.feedbackOptions},model:{value:(_vm.selectedFeedbackOptions),callback:function ($$v) {_vm.selectedFeedbackOptions=$$v;},expression:"selectedFeedbackOptions"}})],1),_vm._v(" "),_c('gl-alert',{staticClass:"gl-mb-5",attrs:{"dismissible":false}},[_vm._v(_vm._s(_vm.modalAlert))]),_vm._v(" "),_vm._t("feedback-extra-fields",function(){return [_c('gl-form-group',{attrs:{"label":_vm.$options.i18n.MODAL.MORE_LABEL,"optional":""}},[_c('gl-form-textarea',{attrs:{"placeholder":_vm.$options.i18n.MODAL.MORE_PLACEHOLDER},model:{value:(_vm.extendedFeedback),callback:function ($$v) {_vm.extendedFeedback=$$v;},expression:"extendedFeedback"}})],1)]})],2)};
+var __vue_staticRenderFns__ = [];
+
+  /* style */
+  const __vue_inject_styles__ = undefined;
+  /* scoped */
+  const __vue_scope_id__ = undefined;
+  /* module identifier */
+  const __vue_module_identifier__ = undefined;
+  /* functional template */
+  const __vue_is_functional_template__ = false;
+  /* style inject */
+  
+  /* style inject SSR */
+  
+  /* style inject shadow dom */
+  
+
+  
+  const __vue_component__ = __vue_normalize__(
+    { render: __vue_render__, staticRenderFns: __vue_staticRenderFns__ },
+    __vue_inject_styles__,
+    __vue_script__,
+    __vue_scope_id__,
+    __vue_is_functional_template__,
+    __vue_module_identifier__,
+    false,
+    undefined,
+    undefined,
+    undefined
+  );
+
+export default __vue_component__;
+export { feedbackOptions, i18n };

package/dist/components/workflow/components/duo_workflow_panel/duo_workflow_panel.js

@@ -0,0 +1,95 @@
+import { GlCollapse, GlButton, GlIcon, GlTooltipDirective } from '@gitlab/ui';
+import { translate } from '@gitlab/ui/dist/utils/i18n';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+var script = {
+  name: 'GlDuoWorkflowPanel',
+  components: {
+    GlCollapse,
+    GlButton,
+    GlIcon
+  },
+  directives: {
+    GlTooltip: GlTooltipDirective
+  },
+  props: {
+    /**
+     * The icon to show in the header.
+     */
+    headerIcon: {
+      type: String,
+      required: false,
+      default: ''
+    },
+    /**
+     * The text used as the title and aria-label for the button when the collapse is collapsed
+     */
+    expandPanelButtonTitle: {
+      type: String,
+      required: false,
+      default: translate('GlDuoWorkflowPanel.expandButtonTitle', 'Expand')
+    },
+    /**
+     * The text used as the title and aria-label for the button when the collapse is expanded
+     */
+    collapsePanelButtonTitle: {
+      type: String,
+      required: false,
+      default: translate('GlDuoWorkflowPanel.collapseButtonTitle', 'Collapse')
+    },
+    /**
+     * Whether the panel is expanded or not
+     */
+    expanded: {
+      type: Boolean,
+      required: false,
+      default: true
+    }
+  },
+  computed: {
+    buttonIcon() {
+      return this.expanded ? 'chevron-up' : 'chevron-down';
+    },
+    buttonTitle() {
+      return this.expanded ? this.collapsePanelButtonTitle : this.expandPanelButtonTitle;
+    }
+  }
+};
+
+/* script */
+const __vue_script__ = script;
+
+/* template */
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('div',[_c('div',{staticClass:"gl-flex gl-flex-nowrap gl-items-center"},[(_vm.headerIcon)?_c('gl-icon',{staticClass:"gl-mr-3",attrs:{"name":_vm.headerIcon,"size":24}}):_vm._e(),_vm._v(" "),_c('div',{staticClass:"gl-flex gl-flex-grow gl-items-baseline"},[_c('h2',{staticClass:"gl-mb-0"},[_vm._t("title")],2),_vm._v(" "),_c('small',{staticClass:"gl-ml-3"},[_vm._t("subtitle")],2)]),_vm._v(" "),_c('gl-button',{directives:[{name:"gl-tooltip",rawName:"v-gl-tooltip"}],attrs:{"category":"tertiary","icon":_vm.buttonIcon,"title":_vm.buttonTitle,"aria-label":_vm.buttonTitle},on:{"click":function($event){return _vm.$emit('toggle-panel')}}})],1),_vm._v(" "),_c('gl-collapse',{attrs:{"visible":_vm.expanded}},[_c('div',{staticClass:"gl-ml-7 gl-mt-4 gl-flex-grow"},[_vm._t("content")],2)])],1)};
+var __vue_staticRenderFns__ = [];
+
+  /* style */
+  const __vue_inject_styles__ = undefined;
+  /* scoped */
+  const __vue_scope_id__ = undefined;
+  /* module identifier */
+  const __vue_module_identifier__ = undefined;
+  /* functional template */
+  const __vue_is_functional_template__ = false;
+  /* style inject */
+  
+  /* style inject SSR */
+  
+  /* style inject shadow dom */
+  
+
+  
+  const __vue_component__ = __vue_normalize__(
+    { render: __vue_render__, staticRenderFns: __vue_staticRenderFns__ },
+    __vue_inject_styles__,
+    __vue_script__,
+    __vue_scope_id__,
+    __vue_is_functional_template__,
+    __vue_module_identifier__,
+    false,
+    undefined,
+    undefined,
+    undefined
+  );
+
+export default __vue_component__;