@shopify/ui-extensions 1.0.2 → 2.0.0-alpha.0

package/build/node/components/index.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "BlockStack", {
+  enumerable: true,
+  get: function () {
+    return _BlockStack.BlockStack;
+  }
+});
+Object.defineProperty(exports, "Button", {
+  enumerable: true,
+  get: function () {
+    return _Button.Button;
+  }
+});
+Object.defineProperty(exports, "Text", {
+  enumerable: true,
+  get: function () {
+    return _Text.Text;
+  }
+});
+Object.defineProperty(exports, "TextField", {
+  enumerable: true,
+  get: function () {
+    return _TextField.TextField;
+  }
+});
+Object.defineProperty(exports, "View", {
+  enumerable: true,
+  get: function () {
+    return _View.View;
+  }
+});
+
+var _BlockStack = require("./BlockStack/BlockStack");
+
+var _Button = require("./Button/Button");
+
+var _Text = require("./Text/Text");
+
+var _TextField = require("./TextField/TextField");
+
+var _View = require("./View/View");

package/build/node/components.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "BlockStack", {
+  enumerable: true,
+  get: function () {
+    return _BlockStack.BlockStack;
+  }
+});
+Object.defineProperty(exports, "Button", {
+  enumerable: true,
+  get: function () {
+    return _Button.Button;
+  }
+});
+Object.defineProperty(exports, "Text", {
+  enumerable: true,
+  get: function () {
+    return _Text.Text;
+  }
+});
+Object.defineProperty(exports, "TextField", {
+  enumerable: true,
+  get: function () {
+    return _TextField.TextField;
+  }
+});
+Object.defineProperty(exports, "View", {
+  enumerable: true,
+  get: function () {
+    return _View.View;
+  }
+});
+
+var _BlockStack = require("./components/BlockStack/BlockStack");
+
+var _Button = require("./components/Button/Button");
+
+var _Text = require("./components/Text/Text");
+
+var _TextField = require("./components/TextField/TextField");
+
+var _View = require("./components/View/View");

package/build/node/extension.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/index.js

@@ -1 +1,44 @@
-"use strict";
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _api = require("./api");
+
+Object.keys(_api).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _api[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _api[key];
+    }
+  });
+});
+
+var _components = require("./components");
+
+Object.keys(_components).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _components[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _components[key];
+    }
+  });
+});
+
+var _extension = require("./extension");
+
+Object.keys(_extension).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _extension[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _extension[key];
+    }
+  });
+});

package/build/node/surfaces/admin/api/checkout-editor/README.md

@@ -0,0 +1 @@
+# Checkout editor API

package/build/node/surfaces/admin/api/checkout-editor/render-settings.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/surfaces/admin/api/standard/README.md

@@ -0,0 +1 @@
+# Standard admin API

package/build/node/surfaces/admin/api/standard/standard.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/surfaces/admin/api.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/{types/shared/index.js → surfaces/admin/components.js}

@@ -4,15 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 
-var _Spacing = require("./Spacing");
+var _components = require("../../components");
 
-Object.keys(_Spacing).forEach(function (key) {
+Object.keys(_components).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _Spacing[key]) return;
+  if (key in exports && exports[key] === _components[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _Spacing[key];
+      return _components[key];
     }
   });
 });

package/build/node/surfaces/admin/extension-points.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/surfaces/admin/extension.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  extension: true
+};
+exports.extension = void 0;
+
+var _registration = require("../../utilities/registration");
+
+var _extension = require("../../extension");
+
+Object.keys(_extension).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _extension[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _extension[key];
+    }
+  });
+});
+const extension = (0, _registration.createExtensionRegistrationFunction)();
+exports.extension = extension;

package/build/node/surfaces/admin/index.js

@@ -0,0 +1,70 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _api = require("./api");
+
+Object.keys(_api).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _api[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _api[key];
+    }
+  });
+});
+
+var _components = require("./components");
+
+Object.keys(_components).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _components[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _components[key];
+    }
+  });
+});
+
+var _extensionPoints = require("./extension-points");
+
+Object.keys(_extensionPoints).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _extensionPoints[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _extensionPoints[key];
+    }
+  });
+});
+
+var _extension = require("./extension");
+
+Object.keys(_extension).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _extension[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _extension[key];
+    }
+  });
+});
+
+var _shared = require("./shared");
+
+Object.keys(_shared).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _shared[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _shared[key];
+    }
+  });
+});

package/build/node/surfaces/admin/shared.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/surfaces/checkout/api/cart-line-details/README.md

@@ -0,0 +1 @@
+# Checkout cart line details API

package/build/node/surfaces/checkout/api/cart-line-details/render-after.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/surfaces/checkout/api/shared.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/surfaces/checkout/api/standard/README.md

@@ -0,0 +1 @@
+# Standard checkout API

package/build/node/surfaces/checkout/api/standard/standard.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/surfaces/checkout/api.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/surfaces/checkout/components.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _components = require("../../components");
+
+Object.keys(_components).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _components[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _components[key];
+    }
+  });
+});

package/build/node/surfaces/checkout/extension-points.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/surfaces/checkout/extension.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  extension: true
+};
+exports.extension = void 0;
+
+var _registration = require("../../utilities/registration");
+
+var _extension = require("../../extension");
+
+Object.keys(_extension).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _extension[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _extension[key];
+    }
+  });
+});
+const extension = (0, _registration.createExtensionRegistrationFunction)();
+exports.extension = extension;

package/build/node/surfaces/checkout/index.js

@@ -0,0 +1,70 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _api = require("./api");
+
+Object.keys(_api).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _api[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _api[key];
+    }
+  });
+});
+
+var _components = require("./components");
+
+Object.keys(_components).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _components[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _components[key];
+    }
+  });
+});
+
+var _extensionPoints = require("./extension-points");
+
+Object.keys(_extensionPoints).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _extensionPoints[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _extensionPoints[key];
+    }
+  });
+});
+
+var _extension = require("./extension");
+
+Object.keys(_extension).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _extension[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _extension[key];
+    }
+  });
+});
+
+var _shared = require("./shared");
+
+Object.keys(_shared).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _shared[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _shared[key];
+    }
+  });
+});

package/build/node/surfaces/checkout/shared.js

@@ -0,0 +1 @@
+"use strict";

package/build/node/utilities/registration.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createExtensionRegistrationFunction = createExtensionRegistrationFunction;
+
+var _core = require("@remote-ui/core");
+
+/**
+ * This function takes an extension function that is expecting a `RemoteRoot` as its
+ * first argument, and returns a new function that accepts a `RemoteChannel` instead.
+ * This is a convenience that allows the raw UI extension API to only expose the simpler
+ * `RemoteChannel` type, while allowing the extension to use the more powerful `RemoteRoot`,
+ * provided by a version of `@remote-ui/core` that the extension controls.
+ */
+function createExtensionRegistrationFunction() {
+  const extensionWrapper = (_extensionPoint, extensionWithRemoteRoot) => {
+    async function extension(...args) {
+      // This handles extensions that do not take a `RemoteChannel` as their first argument.
+      // This is true for ”non-rendering” extension points, like `Checkout::PostPurchase::ShouldRender`.
+      if (args.length === 1 || typeof args[0] !== 'object' || args[0] == null || !('channel' in args[0])) {
+        const result = await extensionWithRemoteRoot(...args);
+        return result;
+      }
+
+      const [{
+        channel,
+        components
+      }, ...rest] = args;
+      const root = (0, _core.createRemoteRoot)(channel, {
+        components,
+        strict: true
+      });
+      const result = await extensionWithRemoteRoot(root, ...rest);
+      await root.mount();
+      return result;
+    }
+
+    return extension;
+  };
+
+  return extensionWrapper;
+}

package/build/ts/api.d.ts

@@ -0,0 +1,8 @@
+export interface ExtensionInstance {
+    readonly id: string;
+}
+export interface StandardApi {
+    readonly extension: ExtensionInstance;
+    readonly extensionPoint: string;
+}
+//# sourceMappingURL=api.d.ts.map

package/build/ts/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;IACtC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;CACjC"}

package/build/ts/components/BlockStack/BlockStack.d.ts

@@ -0,0 +1,8 @@
+export interface BlockStackProps {
+}
+export declare const BlockStack: "BlockStack" & {
+    readonly type?: "BlockStack" | undefined;
+    readonly props?: BlockStackProps | undefined;
+    readonly children?: true | undefined;
+};
+//# sourceMappingURL=BlockStack.d.ts.map

package/build/ts/components/BlockStack/BlockStack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlockStack.d.ts","sourceRoot":"","sources":["../../../../src/components/BlockStack/BlockStack.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,eAAe;CAAG;AAEnC,eAAO,MAAM,UAAU;;;;CAEtB,CAAC"}

package/build/ts/components/BlockStack/BlockStack.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockStack = void 0;
+var core_1 = require("@remote-ui/core");
+exports.BlockStack = (0, core_1.createRemoteComponent)('BlockStack');

package/build/ts/components/Button/Button.d.ts

@@ -0,0 +1,12 @@
+export interface ButtonProps {
+    /**
+     * A callback that is run after the button is pressed.
+     */
+    onPress?(): void;
+}
+export declare const Button: "Button" & {
+    readonly type?: "Button" | undefined;
+    readonly props?: ButtonProps | undefined;
+    readonly children?: true | undefined;
+};
+//# sourceMappingURL=Button.d.ts.map

package/build/ts/components/Button/Button.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Button.d.ts","sourceRoot":"","sources":["../../../../src/components/Button/Button.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,CAAC,IAAI,IAAI,CAAC;CAClB;AAED,eAAO,MAAM,MAAM;;;;CAAyD,CAAC"}

package/build/ts/components/Button/Button.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Button = void 0;
+var core_1 = require("@remote-ui/core");
+exports.Button = (0, core_1.createRemoteComponent)('Button');

package/build/ts/components/Text/Text.d.ts

@@ -0,0 +1,8 @@
+export interface TextProps {
+}
+export declare const Text: "Text" & {
+    readonly type?: "Text" | undefined;
+    readonly props?: TextProps | undefined;
+    readonly children?: true | undefined;
+};
+//# sourceMappingURL=Text.d.ts.map

package/build/ts/components/Text/Text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Text.d.ts","sourceRoot":"","sources":["../../../../src/components/Text/Text.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,SAAS;CAAG;AAE7B,eAAO,MAAM,IAAI;;;;CAAmD,CAAC"}

package/build/ts/components/Text/Text.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Text = void 0;
+var core_1 = require("@remote-ui/core");
+exports.Text = (0, core_1.createRemoteComponent)('Text');

package/build/ts/components/TextField/TextField.d.ts

@@ -0,0 +1,43 @@
+export interface TextFieldProps {
+    /**
+     * Content to use as the field label.
+     */
+    label: string;
+    /**
+     * The current value for the field. If omitted, the field will be empty. You should
+     * update this value in response to the `onChange` callback.
+     */
+    value?: string;
+    /**
+     * Callback when the user has **finished editing** a field. Unlike `onChange`
+     * callbacks you may be familiar with from Polaris or other React component libraries,
+     * this callback is **not** run on every change to the input. Text fields are
+     * “partially controlled” components, which means that while the user edits the
+     * field, its state is controlled by the component. Once the user has signalled that
+     * they have finished editing the field (typically, by blurring the field), `onChange`
+     * is called if the input actually changed from the most recent `value` property. At
+     * that point, you are expected to store this “committed value” in state, and reflect
+     * it in the text field’s `value` property.
+     *
+     * This state management model is important given how UI Extensions are rendered. UI Extension components
+     * run on a separate thread from the UI, so they can’t respond to input synchronously.
+     * A pattern popularized by [controlled React components](https://reactjs.org/docs/forms.html#controlled-components)
+     * is to have the component be the source of truth for the input `value`, and update
+     * the `value` on every user input. The delay in responding to events from a UI
+     * extension is only a few milliseconds, but attempting to strictly store state with
+     * this delay can cause issues if a user types quickly, or if the user is using a
+     * lower-powered device. Having the UI thread take ownership for “in progress” input,
+     * and only synchronizing when the user is finished with a field, avoids this risk.
+     *
+     * This callback is called with the current value of the field. If the value of a field
+     * is the same as the current `value` prop provided to the field, the `onChange` callback
+     * will not be run.
+     */
+    onChange?(value: string): void;
+}
+export declare const TextField: "TextField" & {
+    readonly type?: "TextField" | undefined;
+    readonly props?: TextFieldProps | undefined;
+    readonly children?: true | undefined;
+};
+//# sourceMappingURL=TextField.d.ts.map

package/build/ts/components/TextField/TextField.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextField.d.ts","sourceRoot":"","sources":["../../../../src/components/TextField/TextField.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,eAAO,MAAM,SAAS;;;;CAErB,CAAC"}

package/build/ts/components/TextField/TextField.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextField = void 0;
+var core_1 = require("@remote-ui/core");
+exports.TextField = (0, core_1.createRemoteComponent)('TextField');

package/build/ts/components/View/View.d.ts

@@ -0,0 +1,8 @@
+export interface ViewProps {
+}
+export declare const View: "View" & {
+    readonly type?: "View" | undefined;
+    readonly props?: ViewProps | undefined;
+    readonly children?: true | undefined;
+};
+//# sourceMappingURL=View.d.ts.map

package/build/ts/components/View/View.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"View.d.ts","sourceRoot":"","sources":["../../../../src/components/View/View.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,SAAS;CAAG;AAE7B,eAAO,MAAM,IAAI;;;;CAAmD,CAAC"}

package/build/ts/components/View/View.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.View = void 0;
+var core_1 = require("@remote-ui/core");
+exports.View = (0, core_1.createRemoteComponent)('View');

package/build/ts/components/index.d.ts

@@ -0,0 +1,11 @@
+export { BlockStack } from './BlockStack/BlockStack';
+export type { BlockStackProps } from './BlockStack/BlockStack';
+export { Button } from './Button/Button';
+export type { ButtonProps } from './Button/Button';
+export { Text } from './Text/Text';
+export type { TextProps } from './Text/Text';
+export { TextField } from './TextField/TextField';
+export type { TextFieldProps } from './TextField/TextField';
+export { View } from './View/View';
+export type { ViewProps } from './View/View';
+//# sourceMappingURL=index.d.ts.map

package/build/ts/components/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,yBAAyB,CAAC;AACnD,YAAY,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAE7D,OAAO,EAAC,MAAM,EAAC,MAAM,iBAAiB,CAAC;AACvC,YAAY,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,IAAI,EAAC,MAAM,aAAa,CAAC;AACjC,YAAY,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAE3C,OAAO,EAAC,SAAS,EAAC,MAAM,uBAAuB,CAAC;AAChD,YAAY,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AAE1D,OAAO,EAAC,IAAI,EAAC,MAAM,aAAa,CAAC;AACjC,YAAY,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC"}