@lvce-editor/extension-search-view 1.1.0 → 1.3.0

package/README.md

@@ -1 +1,7 @@
-# extension-search-view
+# Extension Search View
+
+Webworker for the extension search view in Lvce Editor.
+
+## Gitpod
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/lvce-editor/extension-search-view)

package/dist/extensionSearchViewWorkerMain.js

@@ -18,6 +18,134 @@ const execute = (command, ...args) => {
   return fn(...args);
 };
 
+const handleError = async (error, notify = true, prefix = '') => {
+  console.error(error);
+};
+
+const emptyObject = {};
+const RE_PLACEHOLDER = /\{(PH\d+)\}/g;
+const i18nString = (key, placeholders = emptyObject) => {
+  if (placeholders === emptyObject) {
+    return key;
+  }
+  const replacer = (match, rest) => {
+    // @ts-ignore
+    return placeholders[rest];
+  };
+  return key.replaceAll(RE_PLACEHOLDER, replacer);
+};
+
+/**
+ * @enum {string}
+ */
+const UiStrings = {
+  NoExtensionsFound: 'No extensions found.',
+  Filter: 'Filter',
+  Refresh: 'Refresh',
+  ClearExtensionSearchResults: 'Clear extension search results',
+  Enable: 'Enable',
+  Disable: 'Disable',
+  Uninstall: 'Uninstall',
+  InstallAnotherVersion: 'Install Another Version',
+  SearchExtensionsInMarketplace: 'Search Extensions in Marketplace',
+  ViewsAndMoreActions: 'Views and more Actions...',
+  Extensions: 'Extensions',
+  Installed: 'Installed'
+};
+const noExtensionsFound = () => {
+  return i18nString(UiStrings.NoExtensionsFound);
+};
+const filter = () => {
+  return i18nString(UiStrings.Filter);
+};
+const extensions = () => {
+  return i18nString(UiStrings.Extensions);
+};
+const clearExtensionSearchResults = () => {
+  return i18nString(UiStrings.ClearExtensionSearchResults);
+};
+const searchExtensionsInMarketPlace = () => {
+  return i18nString(UiStrings.SearchExtensionsInMarketplace);
+};
+
+const getFinalDeltaY = (height, itemHeight, itemsLength) => {
+  const contentHeight = itemsLength * itemHeight;
+  const finalDeltaY = Math.max(contentHeight - height, 0);
+  return finalDeltaY;
+};
+
+let AssertionError$1 = class AssertionError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'AssertionError';
+  }
+};
+const getType$2 = value => {
+  switch (typeof value) {
+    case 'number':
+      return 'number';
+    case 'function':
+      return 'function';
+    case 'string':
+      return 'string';
+    case 'object':
+      if (value === null) {
+        return 'null';
+      }
+      if (Array.isArray(value)) {
+        return 'array';
+      }
+      return 'object';
+    case 'boolean':
+      return 'boolean';
+    default:
+      return 'unknown';
+  }
+};
+const number$1 = value => {
+  const type = getType$2(value);
+  if (type !== 'number') {
+    throw new AssertionError$1('expected value to be of type number');
+  }
+};
+
+const getListHeight$1 = (itemsLength, itemHeight, maxHeight) => {
+  number$1(itemsLength);
+  number$1(itemHeight);
+  number$1(maxHeight);
+  if (itemsLength === 0) {
+    return itemHeight;
+  }
+  const totalHeight = itemsLength * itemHeight;
+  return Math.min(totalHeight, maxHeight);
+};
+
+// TODO optimize this function to return the minimum number
+// of visible items needed, e.g. when not scrolled 5 items with
+// 20px fill 100px but when scrolled 6 items are needed
+const getNumberOfVisibleItems = (listHeight, itemHeight) => {
+  return Math.ceil(listHeight / itemHeight) + 1;
+};
+
+/**
+ *
+ * @param {number} size
+ * @param {number} contentSize
+ * @param {number} minimumSliderSize
+ * @returns
+ */
+const getScrollBarSize = (size, contentSize, minimumSliderSize) => {
+  if (size >= contentSize) {
+    return 0;
+  }
+  return Math.max(Math.round(size ** 2 / contentSize), minimumSliderSize);
+};
+const getScrollBarOffset = (delta, finalDelta, size, scrollBarSize) => {
+  const scrollBarOffset = delta / finalDelta * (size - scrollBarSize);
+  return scrollBarOffset;
+};
+const getScrollBarY = getScrollBarOffset;
+
 const Installed = '@installed';
 const Enabled = '@enabled';
 const Disabled = '@disabled';
@@ -68,6 +196,46 @@ const parseValue = value => {
 
 const assetDir = '';
 
+const Web = 1;
+const Electron = 2;
+const Remote = 3;
+const Test = 4;
+
+// TODO treeshake this function out
+
+/**
+ * @returns {number}
+ */
+const getPlatform = () => {
+  // @ts-ignore
+  if (typeof PLATFORM !== 'undefined') {
+    // @ts-ignore
+    return PLATFORM;
+  }
+  if (typeof process !== 'undefined' && process.env.NODE_ENV === 'test') {
+    return Test;
+  }
+  // TODO find a better way to pass runtime environment
+  if (typeof name !== 'undefined' && name.endsWith('(Electron)')) {
+    return Electron;
+  }
+  if (typeof name !== 'undefined' && name.endsWith('(Web)')) {
+    return Web;
+  }
+  return Remote;
+};
+const platform = getPlatform();
+
+const getRemoteUrl = extension => {
+  if (platform === Remote || platform === Electron) {
+    if (extension.builtin) {
+      return `${assetDir}/extensions/${extension.id}/${extension.icon}`;
+    }
+    return `/remote/${extension.path}/${extension.icon}`; // TODO support windows paths
+  }
+  return '';
+};
+
 const ExtensionDefaultIcon = `${assetDir}/icons/extensionDefaultIcon.png`;
 const ExtensionLanguageBasics = `${assetDir}/icons/language-icon.svg`;
 const ExtensionTheme = `${assetDir}/icons/theme-icon.png`;
@@ -91,7 +259,7 @@ const getIcon = extension => {
     }
     return ExtensionDefaultIcon;
   }
-  return '';
+  return getRemoteUrl(extension);
 };
 const RE_PUBLISHER = /^[a-z\d\-]+/;
 
@@ -236,8 +404,395 @@ const searchExtensions = async (extensions, value) => {
   }
 };
 
+// TODO debounce
+const handleInput = async (state, value) => {
+  try {
+    const {
+      allExtensions,
+      itemHeight,
+      minimumSliderSize,
+      height
+    } = state;
+    // TODO cancel ongoing requests
+    // TODO handle errors
+    const items = await searchExtensions(allExtensions, value);
+    if (items.length === 0) {
+      return {
+        ...state,
+        items,
+        minLineY: 0,
+        deltaY: 0,
+        allExtensions,
+        maxLineY: 0,
+        scrollBarHeight: 0,
+        finalDeltaY: 0,
+        message: noExtensionsFound(),
+        searchValue: value,
+        placeholder: searchExtensionsInMarketPlace()
+      };
+    }
+    // @ts-ignore
+    const listHeight = getListHeight$1(state);
+    const total = items.length;
+    const contentHeight = total * itemHeight;
+    const scrollBarHeight = getScrollBarSize(height, contentHeight, minimumSliderSize);
+    const numberOfVisible = getNumberOfVisibleItems(listHeight, itemHeight);
+    const maxLineY = Math.min(numberOfVisible, total);
+    const finalDeltaY = getFinalDeltaY(listHeight, itemHeight, total);
+    return {
+      ...state,
+      items,
+      minLineY: 0,
+      deltaY: 0,
+      allExtensions,
+      maxLineY,
+      scrollBarHeight,
+      finalDeltaY,
+      message: '',
+      searchValue: value,
+      placeholder: searchExtensionsInMarketPlace()
+    };
+
+    // TODO handle out of order responses (a bit complicated)
+    // for now just assume everything comes back in order
+  } catch (error) {
+    await handleError(error);
+    return {
+      ...state,
+      searchValue: value,
+      message: `${error}`
+    };
+  }
+};
+
+const clearSearchResults = state => {
+  return handleInput(state, '');
+};
+
+const Button = 1;
+
+const ExtensionActions = 'ExtensionActions';
+const ExtensionActive = 'ExtensionActive';
+const ExtensionHeader = 'ExtensionHeader';
+const ExtensionListItem = 'ExtensionListItem';
+const ExtensionListItemAuthorName = 'ExtensionListItemAuthorName';
+const ExtensionListItemDescription = 'ExtensionListItemDescription';
+const ExtensionListItemDetail = 'ExtensionListItemDetail';
+const ExtensionListItemFooter = 'ExtensionListItemFooter';
+const ExtensionListItemIcon = 'ExtensionListItemIcon';
+const ExtensionListItemName = 'ExtensionListItemName';
+const ListItems = 'ListItems';
+const MultilineInputBox = 'MultilineInputBox';
+const ScrollBarThumb = 'ScrollBarThumb';
+const ScrollBarThumbActive = 'ScrollBarThumbActive';
+const SearchField = 'SearchField';
+const SearchFieldButtons = 'SearchFieldButtons';
+const SearchFieldContainer = 'SearchFieldContainer';
+
+const CheckBox = 'checkbox';
+const List = 'list';
+const ListItem = 'listitem';
+const None = 'none';
+
+const Div = 4;
+const Text = 12;
+const Img = 17;
+const TextArea = 62;
+
+const getSearchFieldButtonVirtualDom = button => {
+  const {
+    icon,
+    checked,
+    title
+  } = button;
+  return [{
+    type: Div,
+    className: `SearchFieldButton ${checked ? 'SearchFieldButtonChecked' : ''}`,
+    title,
+    role: CheckBox,
+    ariaChecked: checked,
+    tabIndex: 0,
+    childCount: 1
+  }, {
+    type: Div,
+    className: `MaskIcon ${icon}`,
+    childCount: 0
+  }];
+};
+
+const getSearchFieldVirtualDom = (name, placeholder, onInput, insideButtons, outsideButtons, onFocus = '') => {
+  const dom = [{
+    type: Div,
+    className: SearchField,
+    role: None,
+    childCount: 2
+  }, {
+    type: TextArea,
+    className: MultilineInputBox,
+    spellcheck: false,
+    autocapitalize: 'off',
+    autocorrect: 'off',
+    placeholder,
+    name,
+    onInput,
+    onFocus,
+    childCount: 0
+  }, {
+    type: Div,
+    className: SearchFieldButtons,
+    childCount: insideButtons.length
+  }, ...insideButtons.flatMap(getSearchFieldButtonVirtualDom)];
+  if (outsideButtons.length > 0) {
+    dom.unshift({
+      type: Div,
+      className: SearchFieldContainer,
+      role: None,
+      childCount: 1 + outsideButtons.length
+    });
+    dom.push(...outsideButtons.flatMap(getSearchFieldButtonVirtualDom));
+  }
+  return dom;
+};
+
+const getExtensionHeaderVirtualDom = (placeholder, actions) => {
+  return [{
+    type: Div,
+    className: ExtensionHeader,
+    childCount: 1
+  }, ...getSearchFieldVirtualDom('extensions', placeholder, 'handleExtensionsInput', actions, [])];
+};
+
+const HandleContextMenu = 'handleContextMenu';
+const HandlePointerDown = 'handlePointerDown';
+const HandleTouchStart = 'handleTouchStart';
+const HandleWheel = 'handleWheel';
+
+const Extension = 'Extension';
+
+const text = data => {
+  return {
+    type: Text,
+    text: data,
+    childCount: 0
+  };
+};
+
+const listItemDetail = {
+  type: Div,
+  className: ExtensionListItemDetail,
+  childCount: 3
+};
+const listItemName = {
+  type: Div,
+  className: ExtensionListItemName,
+  childCount: 1
+};
+const listItemDescription = {
+  type: Div,
+  className: ExtensionListItemDescription,
+  childCount: 1
+};
+const listItemFooter = {
+  type: Div,
+  className: ExtensionListItemFooter,
+  childCount: 2
+};
+const listItemAuthorName = {
+  type: Div,
+  className: ExtensionListItemAuthorName,
+  childCount: 1
+};
+const getExtensionListItemVirtualDom = extension => {
+  const {
+    posInSet,
+    setSize,
+    top,
+    icon,
+    name,
+    description,
+    publisher,
+    focused
+  } = extension;
+  const dom = [{
+    type: Div,
+    role: ListItem,
+    ariaRoleDescription: Extension,
+    className: ExtensionListItem,
+    ariaPosInSet: posInSet,
+    ariaSetSize: setSize,
+    top,
+    childCount: 2
+  }, {
+    type: Img,
+    src: icon,
+    className: ExtensionListItemIcon,
+    role: None,
+    childCount: 0
+  }, listItemDetail, listItemName, text(name), listItemDescription, text(description), listItemFooter, listItemAuthorName, text(publisher), {
+    type: Div,
+    className: ExtensionActions,
+    childCount: 0
+  }];
+  if (focused) {
+    dom[0].id = 'ExtensionActive';
+    dom[0].className += ' ' + ExtensionActive;
+  }
+  return dom;
+};
+
+const getExtensionsListVirtualDom = visibleExtensions => {
+  const dom = [{
+    type: Div,
+    className: ListItems,
+    tabIndex: 0,
+    ariaLabel: extensions(),
+    role: List,
+    oncontextmenu: HandleContextMenu,
+    onpointerdown: HandlePointerDown,
+    ontouchstart: HandleTouchStart,
+    onwheelpassive: HandleWheel,
+    childCount: visibleExtensions.length
+  }, ...visibleExtensions.flatMap(getExtensionListItemVirtualDom)];
+  return dom;
+};
+
+const getExtensionsVirtualDom = visibleExtensions => {
+  const dom = getExtensionsListVirtualDom(visibleExtensions);
+  // TODO
+  return dom;
+};
+
+const getVisibleItem = (item, setSize, itemHeight, minLineY, relative, i, focusedIndex) => {
+  return {
+    ...item,
+    setSize,
+    posInSet: i + 1,
+    top: (i - minLineY) * itemHeight - relative,
+    focused: i === focusedIndex
+  };
+};
+const getVisible = state => {
+  const {
+    minLineY,
+    maxLineY,
+    items,
+    itemHeight,
+    deltaY,
+    focusedIndex
+  } = state;
+  const setSize = items.length;
+  const visible = [];
+  const relative = deltaY % itemHeight;
+  for (let i = minLineY; i < maxLineY; i++) {
+    const item = items[i];
+    visible.push(getVisibleItem(item, setSize, itemHeight, minLineY, relative, i, focusedIndex));
+  }
+  return visible;
+};
+
+const ClearAll = 'ClearAll';
+const Filter = 'Filter';
+
+const px = value => {
+  return `${value}px`;
+};
+const position = (x, y) => {
+  return `${x}px ${y}px`;
+};
+
+const SetMessage = 'setMessage';
+const SetScrollBar = 'setScrollBar';
+const SetSearchValue = 'setSearchValue';
+
+const getListHeight = state => {
+  const {
+    height,
+    headerHeight
+  } = state;
+  return height - headerHeight;
+};
+const renderExtensions = {
+  isEqual(oldState, newState) {
+    return oldState.items === newState.items && oldState.minLineY === newState.minLineY && oldState.maxLineY === newState.maxLineY && oldState.deltaY === newState.deltaY && oldState.focusedIndex === newState.focusedIndex;
+  },
+  apply(oldState, newState) {
+    // TODO render extensions incrementally when scrolling
+    const visibleExtensions = getVisible(newState);
+    const dom = getExtensionsVirtualDom(visibleExtensions);
+    return ['setExtensionsDom', dom];
+  }
+};
+const renderScrollBar = {
+  isEqual(oldState, newState) {
+    return oldState.negativeMargin === newState.negativeMargin && oldState.deltaY === newState.deltaY && oldState.height === newState.height && oldState.finalDeltaY === newState.finalDeltaY && oldState.items.length === newState.items.length && oldState.scrollBarActive === newState.scrollBarActive;
+  },
+  apply(oldState, newState) {
+    // @ts-ignore
+    const listHeight = getListHeight(newState);
+    const total = newState.items.length;
+    const contentHeight = total * newState.itemHeight;
+    const scrollBarHeight = getScrollBarSize(listHeight, contentHeight, newState.minimumSliderSize);
+    const scrollBarY = getScrollBarY(newState.deltaY, newState.finalDeltaY, newState.height - newState.headerHeight, scrollBarHeight);
+    const roundedScrollBarY = Math.round(scrollBarY);
+    const heightString = px(scrollBarHeight);
+    const translateString = position(0, roundedScrollBarY);
+    let className = ScrollBarThumb;
+    if (newState.scrollBarActive) {
+      className += ' ' + ScrollBarThumbActive;
+    }
+    return [/* method */SetScrollBar, translateString, heightString, className];
+  }
+};
+const renderMessage = {
+  isEqual(oldState, newState) {
+    return oldState.message === newState.message;
+  },
+  apply(oldState, newState) {
+    return [/* method */SetMessage, /* message */newState.message];
+  }
+};
+const renderSearchValue = {
+  isEqual(oldState, newState) {
+    return oldState.searchValue === newState.searchValue;
+  },
+  apply(oldState, newState) {
+    return [/* method */SetSearchValue, oldState.searchValue, newState.searchValue];
+  }
+};
+const renderHeader = {
+  isEqual(oldState, newState) {
+    return oldState.placeholder === newState.placeholder;
+  },
+  apply(oldState, newState) {
+    const actions = [{
+      type: Button,
+      title: clearExtensionSearchResults(),
+      icon: `MaskIcon${ClearAll}`,
+      command: 'Extensions.clearSearchResults'
+    }, {
+      type: Button,
+      title: filter(),
+      icon: `MaskIcon${Filter}`
+    }];
+    const dom = getExtensionHeaderVirtualDom(newState.placeholder, actions);
+    return ['setHeaderDom', dom];
+  }
+};
+const render = [renderScrollBar, renderMessage, renderExtensions, renderSearchValue, renderHeader];
+const doRender = (oldState, newState) => {
+  const commands = [];
+  for (const item of render) {
+    if (!item.isEqual(oldState, newState)) {
+      commands.push(item.apply(oldState, newState));
+    }
+  }
+  return commands;
+};
+
 const commandMap = {
-  'SearchExtensions.searchExtensions': searchExtensions
+  'SearchExtensions.searchExtensions': searchExtensions,
+  'SearchExtensions.render': doRender,
+  'SearchExtensions.clearSearchResults': clearSearchResults
 };
 
 const Two = '2.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/extension-search-view",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "",
   "main": "dist/extensionSearchViewWorkerMain.js",
   "type": "module",