@shopify/ui-extensions 2.0.0-alpha.2 → 2022.10.1

package/build/esnext/index.esnext

@@ -1,3 +1 @@
-export * from './api';
-export * from './components';
-export * from './extension';
+

package/build/esnext/surfaces/checkout/components/Banner/Banner.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Use banners to communicate important messages to customers in a prominent way.
+ */
+const Banner = createRemoteComponent('Banner');
+
+export { Banner };

package/build/esnext/surfaces/checkout/components/BlockLayout/BlockLayout.esnext

@@ -0,0 +1,10 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * BlockLayout is used to lay out content over multiple rows.
+ *
+ * By default, all rows fill the available block space, sharing it equally.
+ */
+const BlockLayout = createRemoteComponent('BlockLayout');
+
+export { BlockLayout };

package/build/esnext/surfaces/checkout/components/BlockSpacer/BlockSpacer.esnext

@@ -0,0 +1,11 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * BlockSpacer is used to create empty block space, typically when variable spacing
+ * is needed between multiple elements.
+ *
+ * Note that you should favor BlockStack when spacing between all elements is the same.
+ */
+const BlockSpacer = createRemoteComponent('BlockSpacer');
+
+export { BlockSpacer };

package/build/esnext/surfaces/checkout/components/BlockStack/BlockStack.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * BlockStack is used to vertically stack elements.
+ */
+const BlockStack = createRemoteComponent('BlockStack');
+
+export { BlockStack };

package/build/esnext/surfaces/checkout/components/Button/Button.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Buttons are used for actions, such as “Add”, “Continue”, “Pay now”, or “Save”.
+ */
+const Button = createRemoteComponent('Button');
+
+export { Button };

package/build/esnext/surfaces/checkout/components/Checkbox/Checkbox.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Use checkboxes to give customers a single binary option, such as signing up for marketing, or agreeing to terms and conditions.
+ */
+const Checkbox = createRemoteComponent('Checkbox');
+
+export { Checkbox };

package/build/esnext/surfaces/checkout/components/Choice/Choice.esnext

@@ -0,0 +1,9 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Options inside a `ChoiceList`.
+ * The wrapping `ChoiceList` component will dictate if the choice renders as radio buttons or checkboxes.
+ */
+const Choice = createRemoteComponent('Choice');
+
+export { Choice };

package/build/esnext/surfaces/checkout/components/ChoiceList/ChoiceList.esnext

@@ -0,0 +1,9 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Use choice lists to present a list of choices where buyers can make
+ * a single selection or multiple selections.
+ */
+const ChoiceList = createRemoteComponent('ChoiceList');
+
+export { ChoiceList };

package/build/esnext/surfaces/checkout/components/Divider/Divider.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * A divider separates content and represents a thematic break between elements.
+ */
+const Divider = createRemoteComponent('Divider');
+
+export { Divider };

package/build/esnext/surfaces/checkout/components/Form/Form.esnext

@@ -0,0 +1,16 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * The form component should be used to wrap one or more form controls. This
+ * component provides an "implicit submit" behavior, where customers can submit
+ * the form from any input by pressing "Enter" on their keyboards. This
+ * behavior is widely expected, and should be respected as often as possible.
+ *
+ * Unlike an HTML `form` element, this component does not support configuring
+ * the descendant fields to be submitted via HTTP automatically. Instead, you
+ * must provide an `onSubmit` callback that will perform the necessary HTTP
+ * requests in JavaScript.
+ */
+const Form = createRemoteComponent('Form');
+
+export { Form };

package/build/esnext/surfaces/checkout/components/Grid/Grid.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Grid is used to lay out content in a matrix of rows and columns.
+ */
+const Grid = createRemoteComponent('Grid');
+
+export { Grid };

package/build/esnext/surfaces/checkout/components/GridItem/GridItem.esnext

@@ -0,0 +1,10 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * GridItem can be used as children of Grid.
+ *
+ * It offers a way to span the element across a number of columns and rows.
+ */
+const GridItem = createRemoteComponent('GridItem');
+
+export { GridItem };

package/build/esnext/surfaces/checkout/components/Heading/Heading.esnext

@@ -0,0 +1,13 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Headings control the visual style of headings. Use headings to introduce major
+ * sections, like Contact information, Shipping address, or Shipping method.
+ *
+ * Unlike HTML headings, you don’t explicitly specify the position of the heading in the
+ * document outline. Nest headings within the heading group component to control
+ * the document outline structure used by assistive technologies.
+ */
+const Heading = createRemoteComponent('Heading');
+
+export { Heading };

package/build/esnext/surfaces/checkout/components/HeadingGroup/HeadingGroup.esnext

@@ -0,0 +1,12 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Heading group controls the heading level of headings nested within it, like H1, H2, H3.
+ *
+ * Use a heading group whenever you use a heading to ensure the experience is the same
+ * for screen reader users. When using a heading, any children related to that
+ * heading should be nested within the same heading group.
+ */
+const HeadingGroup = createRemoteComponent('HeadingGroup');
+
+export { HeadingGroup };

package/build/esnext/surfaces/checkout/components/Icon/Icon.esnext

@@ -0,0 +1,9 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Icons are pictograms or graphic symbols.
+ * They can act as wayfinding tools or as a means of communicating functionality.
+ */
+const Icon = createRemoteComponent('Icon');
+
+export { Icon };

package/build/esnext/surfaces/checkout/components/Image/Image.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Image is used for large format, responsive images.
+ */
+const Image = createRemoteComponent('Image');
+
+export { Image };

package/build/esnext/surfaces/checkout/components/InlineLayout/InlineLayout.esnext

@@ -0,0 +1,12 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * InlineLayout is used to lay out content over multiple columns.
+ *
+ * By default, all columns are of equal size and fill the available inline space.
+ * Content does not wrap on new rows when not enough columns have been explicitly set,
+ * instead they are added as new column and fill the remaining inline space.
+ */
+const InlineLayout = createRemoteComponent('InlineLayout');
+
+export { InlineLayout };

package/build/esnext/surfaces/checkout/components/InlineSpacer/InlineSpacer.esnext

@@ -0,0 +1,11 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * InlineSpacer is used to create empty inline space, typically when variable spacing
+ * is needed between multiple elements.
+ *
+ * Note that you should favor InlineStack when spacing between all elements is the same.
+ */
+const InlineSpacer = createRemoteComponent('InlineSpacer');
+
+export { InlineSpacer };

package/build/esnext/surfaces/checkout/components/InlineStack/InlineStack.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * InlineStack is used to lay out a horizontal row of elements. Elements always wrap.
+ */
+const InlineStack = createRemoteComponent('InlineStack');
+
+export { InlineStack };

package/build/esnext/surfaces/checkout/components/Link/Link.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Link makes text interactive so customers can perform an action, such as navigating to another location.
+ */
+const Link = createRemoteComponent('Link');
+
+export { Link };

package/build/esnext/surfaces/checkout/components/List/List.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Lists display a set of related content. Each list item usually begins with a bullet or a number.
+ */
+const List = createRemoteComponent('List');
+
+export { List };

package/build/esnext/surfaces/checkout/components/ListItem/ListItem.esnext

@@ -0,0 +1,10 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * List items are used as children of the `List` component.
+ *
+ * They usually begins with a bullet or a number.
+ */
+const ListItem = createRemoteComponent('ListItem');
+
+export { ListItem };

package/build/esnext/surfaces/checkout/components/PhoneField/PhoneField.esnext

@@ -0,0 +1,13 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * A PhoneField is an input field that merchants can type into optimized
+ * for phone numbers with a country code base auto-formatting.
+ * The country code is required for the initial render of the field but
+ * it can be overriden later by the user either by selecting a country
+ * in the country selection dropdown or by manually editing the country phone code
+ * directly in the text field.
+ */
+const PhoneField = createRemoteComponent('PhoneField');
+
+export { PhoneField };

package/build/esnext/surfaces/checkout/components/Pressable/Pressable.esnext

@@ -0,0 +1,10 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Pressable is a generic interactive component. It shares the same styling properties as View but also adds
+ * pressable behavior, meaning that you can execute some logic in response to user interaction.
+ * Use this component for creating interactive elements without the default styling that comes with `Button` and `Link`.
+ */
+const Pressable = createRemoteComponent('Pressable');
+
+export { Pressable };

package/build/esnext/surfaces/checkout/components/ScrollView/ScrollView.esnext

@@ -0,0 +1,9 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * ScrollView is a container for long form content, such as order summary line items,
+ * that allows for scrolling so customers can expose more content as they view.
+ */
+const ScrollView = createRemoteComponent('ScrollView');
+
+export { ScrollView };

package/build/esnext/surfaces/checkout/components/Select/Select.esnext

@@ -0,0 +1,9 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Selects let buyers choose one option from an options menu. Consider select
+ * when you have 4 or more options, to avoid cluttering the interface.
+ */
+const Select = createRemoteComponent('Select');
+
+export { Select };

package/build/esnext/surfaces/checkout/components/SkeletonImage/SkeletonImage.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * SkeletonImage is used to provide a low fidelity representation of an image before it appears on the page.
+ */
+const SkeletonImage = createRemoteComponent('SkeletonImage');
+
+export { SkeletonImage };

package/build/esnext/surfaces/checkout/components/SkeletonText/SkeletonText.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * SkeletonText is used to provide a low fidelity representation of text content before it appears on the page.
+ */
+const SkeletonText = createRemoteComponent('SkeletonText');
+
+export { SkeletonText };

package/build/esnext/surfaces/checkout/components/SkeletonTextBlock/SkeletonTextBlock.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * SkeletonTextBlock is used to provide a low fidelity representation of a block of text before it appears on the page.
+ */
+const SkeletonTextBlock = createRemoteComponent('SkeletonTextBlock');
+
+export { SkeletonTextBlock };

package/build/esnext/surfaces/checkout/components/Spinner/Spinner.esnext

@@ -0,0 +1,9 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Spinner is used to notify buyers that their action is being processed.
+ * The Spinner is usually used when sending or receiving data from a server.
+ */
+const Spinner = createRemoteComponent('Spinner');
+
+export { Spinner };

package/build/esnext/surfaces/checkout/components/Stepper/Stepper.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Use a stepper to increase or decrease a value, like changing the quantity from 1 to 2.
+ */
+const Stepper = createRemoteComponent('Stepper');
+
+export { Stepper };

package/build/esnext/surfaces/checkout/components/Tag/Tag.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * A Tag is used to help label, organize or categorize objects. It is commonly used in Checkout to display the discounts applied to a cart.
+ */
+const Tag = createRemoteComponent('Tag');
+
+export { Tag };

package/build/esnext/surfaces/checkout/components/Text/Text.esnext

@@ -0,0 +1,9 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Text is used to visually style and provide semantic value for a small piece of text
+ * content.
+ */
+const Text = createRemoteComponent('Text');
+
+export { Text };

package/build/esnext/surfaces/checkout/components/TextBlock/TextBlock.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Text block is used to render a block of text that occupies the full width available, like a paragraph.
+ */
+const TextBlock = createRemoteComponent('TextBlock');
+
+export { TextBlock };

package/build/esnext/surfaces/checkout/components/TextField/TextField.esnext

@@ -0,0 +1,8 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Use a text field to get text input from a customer.
+ */
+const TextField = createRemoteComponent('TextField');
+
+export { TextField };

package/build/esnext/surfaces/checkout/components/Tooltip/Tooltip.esnext

@@ -0,0 +1,13 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Tooltips are floating labels that briefly explain the function of a user interface element.
+ * They must be specified inside the `overlay` prop of an activator component.
+ * Currently, activator components are `Button`, `Link`, and `Pressable`.
+ *
+ * The library takes care of applying the WAI-ARIA Tooltip Widget pattern automatically for the activator
+ * and the tooltip content. Expect screen readers to read the tooltip content when the user focuses the activator.
+ */
+const Tooltip = createRemoteComponent('Tooltip');
+
+export { Tooltip };

package/build/esnext/surfaces/checkout/components/View/View.esnext

@@ -0,0 +1,13 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ *  View is a generic container component. Its contents will always be their
+ * “natural” size, so this component can be useful in layout components (like `Grid`,
+ * `BlockStack`, `InlineStack`) that would otherwise stretch their children to fit.
+ *
+ * Note: View’s box model related properties like `padding`, `border`, `borderRadius`, and `borderColor` are implemented as
+ * [CSS Logical Properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Logical_Properties/Basic_concepts).
+ */
+const View = createRemoteComponent('View');
+
+export { View };

package/build/esnext/surfaces/checkout/extension.esnext

@@ -1,3 +1,5 @@
-import { createExtensionRegistrationFunction } from '../../utilities/registration';
-export * from '../../extension';
-export const extension = createExtensionRegistrationFunction();
+import { createExtensionRegistrationFunction } from '../../utilities/registration.esnext';
+
+const extension = createExtensionRegistrationFunction();
+
+export { extension };

package/build/esnext/surfaces/checkout/index.esnext

@@ -1,5 +1,39 @@
-export * from './api';
-export * from './components';
-export * from './extension-points';
-export * from './extension';
-export * from './shared';
+export { extension } from './extension.esnext';
+export { Banner } from './components/Banner/Banner.esnext';
+export { BlockLayout } from './components/BlockLayout/BlockLayout.esnext';
+export { BlockSpacer } from './components/BlockSpacer/BlockSpacer.esnext';
+export { BlockStack } from './components/BlockStack/BlockStack.esnext';
+export { Button } from './components/Button/Button.esnext';
+export { Checkbox } from './components/Checkbox/Checkbox.esnext';
+export { Choice } from './components/Choice/Choice.esnext';
+export { ChoiceList } from './components/ChoiceList/ChoiceList.esnext';
+export { Divider } from './components/Divider/Divider.esnext';
+export { Form } from './components/Form/Form.esnext';
+export { Grid } from './components/Grid/Grid.esnext';
+export { GridItem } from './components/GridItem/GridItem.esnext';
+export { Heading } from './components/Heading/Heading.esnext';
+export { HeadingGroup } from './components/HeadingGroup/HeadingGroup.esnext';
+export { Icon } from './components/Icon/Icon.esnext';
+export { Image } from './components/Image/Image.esnext';
+export { InlineLayout } from './components/InlineLayout/InlineLayout.esnext';
+export { InlineStack } from './components/InlineStack/InlineStack.esnext';
+export { InlineSpacer } from './components/InlineSpacer/InlineSpacer.esnext';
+export { Link } from './components/Link/Link.esnext';
+export { List } from './components/List/List.esnext';
+export { ListItem } from './components/ListItem/ListItem.esnext';
+export { PhoneField } from './components/PhoneField/PhoneField.esnext';
+export { Pressable } from './components/Pressable/Pressable.esnext';
+export { ScrollView } from './components/ScrollView/ScrollView.esnext';
+export { Select } from './components/Select/Select.esnext';
+export { SkeletonImage } from './components/SkeletonImage/SkeletonImage.esnext';
+export { SkeletonText } from './components/SkeletonText/SkeletonText.esnext';
+export { SkeletonTextBlock } from './components/SkeletonTextBlock/SkeletonTextBlock.esnext';
+export { Spinner } from './components/Spinner/Spinner.esnext';
+export { Stepper } from './components/Stepper/Stepper.esnext';
+export { Tag } from './components/Tag/Tag.esnext';
+export { Text } from './components/Text/Text.esnext';
+export { TextBlock } from './components/TextBlock/TextBlock.esnext';
+export { TextField } from './components/TextField/TextField.esnext';
+export { Tooltip } from './components/Tooltip/Tooltip.esnext';
+export { View } from './components/View/View.esnext';
+export { Style, isConditionalStyle, isConditionalStyleWithDefault } from './style/style.esnext';

package/build/esnext/surfaces/checkout/style/isEqual.esnext

@@ -0,0 +1,25 @@
+/**
+ * A simple isEqual function that can be used to compare two style objects that's
+ * good enough for our use case on the style builder.
+ */
+function isEqual(first, second) {
+  if (Object.is(first, second)) {
+    return true;
+  }
+  if (typeof first === 'object' && typeof second === 'object') {
+    if (Array.isArray(first) && Array.isArray(second)) {
+      if (first.length === second.length) {
+        return first.every((value, index) => isEqual(value, second[index]));
+      }
+    } else {
+      const firstEntries = Object.entries(first);
+      const secondEntries = Object.entries(second);
+      if (firstEntries.length === secondEntries.length) {
+        return firstEntries.every(([key]) => isEqual(first[key], second[key]));
+      }
+    }
+  }
+  return false;
+}
+
+export { isEqual };

package/build/esnext/surfaces/checkout/style/memoize.esnext

@@ -0,0 +1,132 @@
+/* eslint-disable prefer-rest-params */
+/* eslint-disable prefer-spread */
+
+// This memoize function is heavily inspired by reselect's defaultMemoize
+// https://github.com/reduxjs/reselect
+
+// Cache implementation based on Erik Rasmussen's `lru-memoize`:
+// https://github.com/erikras/lru-memoize
+
+const NOT_FOUND = 'NOT_FOUND';
+function createSingletonCache(equals) {
+  let entry;
+  return {
+    get(key) {
+      if (entry && equals(entry.key, key)) {
+        return entry.value;
+      }
+      return NOT_FOUND;
+    },
+    put(key, value) {
+      entry = {
+        key,
+        value
+      };
+    },
+    getEntries() {
+      return entry ? [entry] : [];
+    },
+    clear() {
+      entry = undefined;
+    }
+  };
+}
+function createLruCache(maxSize, equals) {
+  let entries = [];
+  function get(key) {
+    const cacheIndex = entries.findIndex(entry => equals(key, entry.key));
+
+    // We found a cached entry
+    if (cacheIndex > -1) {
+      const entry = entries[cacheIndex];
+
+      // Cached entry not at top of cache, move it to the top
+      if (cacheIndex > 0) {
+        entries.splice(cacheIndex, 1);
+        entries.unshift(entry);
+      }
+      return entry.value;
+    }
+
+    // No entry found in cache, return sentinel
+    return NOT_FOUND;
+  }
+  function put(key, value) {
+    if (get(key) === NOT_FOUND) {
+      entries.unshift({
+        key,
+        value
+      });
+      if (entries.length > maxSize) {
+        entries.pop();
+      }
+    }
+  }
+  function getEntries() {
+    return entries;
+  }
+  function clear() {
+    entries = [];
+  }
+  return {
+    get,
+    put,
+    getEntries,
+    clear
+  };
+}
+const defaultEqualityCheck = (first, second) => {
+  return first === second;
+};
+function createCacheKeyComparator(equalityCheck) {
+  return function areArgumentsShallowlyEqual(prev, next) {
+    if (prev === null || next === null || prev.length !== next.length) {
+      return false;
+    }
+
+    // Do this in a for loop (and not a `forEach` or an `every`) so we can determine equality as fast as possible.
+    const length = prev.length;
+    for (let i = 0; i < length; i++) {
+      if (!equalityCheck(prev[i], next[i])) {
+        return false;
+      }
+    }
+    return true;
+  };
+}
+// defaultMemoize now supports a configurable cache size with LRU behavior,
+// and optional comparison of the result value with existing values
+function memoize(func, equalityCheckOrOptions) {
+  const providedOptions = typeof equalityCheckOrOptions === 'object' ? equalityCheckOrOptions : {
+    equalityCheck: equalityCheckOrOptions
+  };
+  const {
+    equalityCheck = defaultEqualityCheck,
+    maxSize = 1,
+    resultEqualityCheck
+  } = providedOptions;
+  const comparator = createCacheKeyComparator(equalityCheck);
+  const cache = maxSize === 1 ? createSingletonCache(comparator) : createLruCache(maxSize, comparator);
+
+  // we reference arguments instead of spreading them for performance reasons
+  function memoized() {
+    let value = cache.get(arguments);
+    if (value === NOT_FOUND) {
+      // @ts-expect-error - we know that arguments is an array-like object
+      value = func.apply(null, arguments);
+      if (resultEqualityCheck) {
+        const entries = cache.getEntries();
+        const matchingEntry = entries.find(entry => resultEqualityCheck(entry.value, value));
+        if (matchingEntry) {
+          value = matchingEntry.value;
+        }
+      }
+      cache.put(arguments, value);
+    }
+    return value;
+  }
+  memoized.clearCache = () => cache.clear();
+  return memoized;
+}
+
+export { createCacheKeyComparator, defaultEqualityCheck, memoize };