@shopify/ui-extensions-server-kit 5.2.1 → 5.3.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @shopify/ui-extensions-server-kit
 
+## 5.3.1
+
+### Patch Changes
+
+- 7f2f69a: Added optional `error` property to ExtensionPayload which include the `message` and `file`
+
+## 5.3.0
+
+### Minor Changes
+
+- 386bf0e: Add support for displaying UI Extension dev logs
+
 ## 5.2.1
 
 ### Patch Changes

package/README.md

@@ -13,7 +13,7 @@ Learn more in the [commands docs](./packages/cli/README.md#commands).
 
 <p>&nbsp;</p>
 
-### Before you begin ###
+## Before you begin
 
 Install the latest version of  [Node.js](https://nodejs.org/en/download/) and [npm](https://docs.npmjs.com/getting-started) (or another package manager of your choice).
 
@@ -41,7 +41,7 @@ To work with themes, the CLI needs to be installed globally with:
 
 You can also use do it through Homebrew on macOS: `brew tap shopify/shopify && brew install shopify-cli`
 
-Learn more in the docs: [Shopify CLI for themes](https://shopify.dev/docs/themes/tools/cli)
+Learn more in the docs: [Shopify CLI for themes](https://shopify.dev/docs/storefronts/themes/tools/cli)
 
 <p>&nbsp;</p>
 

package/dist/ExtensionServerClient/ExtensionServerClient.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const h=require("../i18n.cjs.js"),E=require("../utilities/isValidSurface.cjs.js"),f=require("../utilities/isUIExtension.cjs.js");class g{constructor(n={}){this.EVENT_THAT_WILL_MUTATE_THE_SERVER=["update"],this.listeners={},this.connectionListeners={close:new Set,open:new Set},this.connected=!1,this.uiExtensionsByUuid={},this.id=(Math.random()+1).toString(36).substring(7),this.options=p({...n,connection:{automaticConnect:!0,protocols:[],...n.connection??{}}}),this.setupConnection(this.options.connection.automaticConnect)}connect(n={connection:{}}){const t=S(this.options,n);return JSON.stringify(t)!==JSON.stringify(this.options)&&(this.options=t,this.setupConnection(!0)),()=>{this.closeConnection()}}on(n,t){return this.listeners[n]||(this.listeners[n]=new Set),this.listeners[n].add(t),()=>this.listeners[n].delete(t)}persist(n,t){var s,e,i;if(this.EVENT_THAT_WILL_MUTATE_THE_SERVER.includes(n))return this.options.locales?((e=t.extensions)==null||e.forEach(o=>{h.TRANSLATED_KEYS.forEach(a=>{var c;f.isUIExtension(o)&&((c=o.extensionPoints)==null||c.forEach(l=>{delete l[a]})),delete o[a]})}),(i=this.connection)==null?void 0:i.send(JSON.stringify({event:n,data:t}))):(s=this.connection)==null?void 0:s.send(JSON.stringify({event:n,data:t}));console.warn('You tried to use "persist" with a dispatch event. Please use the "emit" method instead.')}emit(...n){var e;const[t,s]=n;if(this.EVENT_THAT_WILL_MUTATE_THE_SERVER.includes(t))return console.warn(`You tried to use "emit" with a the "${t}" event. Please use the "persist" method instead to persist changes to the server.`);(e=this.connection)==null||e.send(JSON.stringify({event:"dispatch",data:{type:t,payload:s}}))}onConnection(n,t){return this.connectionListeners[n].add(t),()=>this.connectionListeners[n].delete(t)}initializeConnection(){var n;this.connection&&(this.connection.addEventListener("open",t=>{this.connected=!0,this.connectionListeners.open.forEach(s=>s(t))}),this.connection.addEventListener("close",t=>{this.connected=!1,this.connectionListeners.close.forEach(s=>s(t))}),(n=this.connection)==null||n.addEventListener("message",t=>{var s,e;try{const{event:i,data:o}=JSON.parse(t.data);if(i==="dispatch"){const{type:c,payload:l}=o;(s=this.listeners[c])==null||s.forEach(u=>u(l));return}const a=o.extensions?T(o.extensions,this.options.surface):o.extensions;(e=this.listeners[i])==null||e.forEach(c=>{c({...o,extensions:this._getLocalizedExtensions(a)})})}catch(i){console.error("[ExtensionServer] Something went wrong while parsing a server message:",i instanceof Error?i.message:i)}}))}setupConnection(n=!0){this.options.connection.url&&n&&(this.closeConnection(),this.connection=new WebSocket(this.options.connection.url,this.options.connection.protocols),this.initializeConnection())}closeConnection(){var n;this.connected&&((n=this.connection)==null||n.close())}_getLocalizedExtensions(n){return n==null?void 0:n.map(t=>{var a,c,l,u,d;if(!this.options.locales||!f.isUIExtension(t))return t;const e=((c=(a=this.uiExtensionsByUuid[t.uuid])==null?void 0:a.localization)==null?void 0:c.lastUpdated)!==((l=t.localization)==null?void 0:l.lastUpdated)?h.getFlattenedLocalization(t.localization,this.options.locales):((u=this.uiExtensionsByUuid[t.uuid])==null?void 0:u.localization)||t.localization,i=e&&h.isFlattenedTranslations(e)?JSON.parse(e.translations):e,o={...t,localization:e,name:i&&t.name.startsWith("t:")?this._getLocalizedValue(i,t.name):t.name,...t.description&&{description:i&&((d=t.description)!=null&&d.startsWith("t:"))?this._getLocalizedValue(i,t.description):t.description}};return this.uiExtensionsByUuid[t.uuid]={...o,extensionPoints:this._getLocalizedExtensionPoints(e,o)},this.uiExtensionsByUuid[t.uuid]})}_getLocalizedExtensionPoints(n,{extensionPoints:t,name:s,description:e}){return!n||!h.isFlattenedTranslations(n)?t:t==null?void 0:t.map(i=>({...i,localization:n,name:s,...e&&{description:e}}))}_getLocalizedValue(n,t){const s=t.replace("t:","");return n[s]||t}}function S(r,n){return p({...r,...n,connection:{...r.connection,...n.connection}})}function p(r){return E.isValidSurface(r.surface)||delete r.surface,r}function T(r,n){return n?r.filter(t=>t.surface===n?!0:Array.isArray(t.extensionPoints)?t.extensionPoints.filter(i=>typeof i=="string"?!1:i.surface===n).length>0:!1):r}exports.ExtensionServerClient=g;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const h=require("../i18n.cjs.js"),E=require("../utilities/isValidSurface.cjs.js"),f=require("../utilities/isUIExtension.cjs.js");class g{constructor(n={}){this.EVENT_THAT_WILL_MUTATE_THE_SERVER=["update"],this.listeners={},this.connectionListeners={close:new Set,open:new Set},this.connected=!1,this.uiExtensionsByUuid={},this.id=(Math.random()+1).toString(36).substring(7),this.options=p({...n,connection:{automaticConnect:!0,protocols:[],...n.connection??{}}}),this.setupConnection(this.options.connection.automaticConnect)}connect(n={connection:{}}){const t=S(this.options,n);return JSON.stringify(t)!==JSON.stringify(this.options)&&(this.options=t,this.setupConnection(!0)),()=>{this.closeConnection()}}on(n,t){return this.listeners[n]||(this.listeners[n]=new Set),this.listeners[n].add(t),()=>this.listeners[n].delete(t)}persist(n,t){var s,e,i;if(this.EVENT_THAT_WILL_MUTATE_THE_SERVER.includes(n))return this.options.locales?((e=t.extensions)==null||e.forEach(o=>{h.TRANSLATED_KEYS.forEach(a=>{var c;f.isUIExtension(o)&&((c=o.extensionPoints)==null||c.forEach(l=>{delete l[a]})),delete o[a]})}),(i=this.connection)==null?void 0:i.send(JSON.stringify({event:n,data:t}))):(s=this.connection)==null?void 0:s.send(JSON.stringify({event:n,data:t}));console.warn('You tried to use "persist" with a dispatch event. Please use the "emit" method instead.')}emit(...n){var e;const[t,s]=n;if(this.EVENT_THAT_WILL_MUTATE_THE_SERVER.includes(t))return console.warn(`You tried to use "emit" with a the "${t}" event. Please use the "persist" method instead to persist changes to the server.`);(e=this.connection)==null||e.send(JSON.stringify({event:"dispatch",data:{type:t,payload:s}}))}onConnection(n,t){return this.connectionListeners[n].add(t),()=>this.connectionListeners[n].delete(t)}initializeConnection(){var n;this.connection&&(this.connection.addEventListener("open",t=>{this.connected=!0,this.connectionListeners.open.forEach(s=>s(t))}),this.connection.addEventListener("close",t=>{this.connected=!1,this.connectionListeners.close.forEach(s=>s(t))}),(n=this.connection)==null||n.addEventListener("message",t=>{var s,e;try{const{event:i,data:o}=JSON.parse(t.data);if(i==="dispatch"){const{type:c,payload:l}=o;(s=this.listeners[c])==null||s.forEach(u=>u(l));return}const a=o.extensions?T(o.extensions,this.options.surface):o.extensions;(e=this.listeners[i])==null||e.forEach(c=>{c({...o,extensions:this._getLocalizedExtensions(a)})})}catch(i){console.error("[ExtensionServer] Something went wrong while parsing a server message:",i instanceof Error?i.message:i)}}))}setupConnection(n=!0){this.options.connection.url&&n&&(this.closeConnection(),this.connection=new WebSocket(this.options.connection.url,this.options.connection.protocols),this.initializeConnection())}closeConnection(){var n;this.connected&&((n=this.connection)==null||n.close())}_getLocalizedExtensions(n){return n==null?void 0:n.map(t=>{var a,c,l,u,d;if(!this.options.locales||!f.isUIExtension(t))return t;const e=((c=(a=this.uiExtensionsByUuid[t.uuid])==null?void 0:a.localization)==null?void 0:c.lastUpdated)!==((l=t.localization)==null?void 0:l.lastUpdated)?h.getFlattenedLocalization(t.localization,this.options.locales):((u=this.uiExtensionsByUuid[t.uuid])==null?void 0:u.localization)??t.localization,i=e&&h.isFlattenedTranslations(e)?JSON.parse(e.translations):e,o={...t,localization:e,name:i&&t.name.startsWith("t:")?this._getLocalizedValue(i,t.name):t.name,...t.description&&{description:i&&((d=t.description)!=null&&d.startsWith("t:"))?this._getLocalizedValue(i,t.description):t.description}};return this.uiExtensionsByUuid[t.uuid]={...o,extensionPoints:this._getLocalizedExtensionPoints(e,o)},this.uiExtensionsByUuid[t.uuid]})}_getLocalizedExtensionPoints(n,{extensionPoints:t,name:s,description:e}){return!n||!h.isFlattenedTranslations(n)?t:t==null?void 0:t.map(i=>({...i,localization:n,name:s,...e&&{description:e}}))}_getLocalizedValue(n,t){const s=t.replace("t:","");return n[s]||t}}function S(r,n){return p({...r,...n,connection:{...r.connection,...n.connection}})}function p(r){return E.isValidSurface(r.surface)||delete r.surface,r}function T(r,n){return n?r.filter(t=>t.surface===n?!0:Array.isArray(t.extensionPoints)?t.extensionPoints.filter(i=>typeof i=="string"?!1:i.surface===n).length>0:!1):r}exports.ExtensionServerClient=g;

package/dist/ExtensionServerClient/ExtensionServerClient.d.ts

@@ -1,3 +1,4 @@
+import { ExtensionServer } from './server-types.js';
 import { DeepPartial } from '../types';
 export declare class ExtensionServerClient implements ExtensionServer.Client {
     id: string;

package/dist/ExtensionServerClient/ExtensionServerClient.es.js

@@ -85,7 +85,7 @@ class z {
       var a, c, h, l, u;
       if (!this.options.locales || !f(t))
         return t;
-      const e = ((c = (a = this.uiExtensionsByUuid[t.uuid]) == null ? void 0 : a.localization) == null ? void 0 : c.lastUpdated) !== ((h = t.localization) == null ? void 0 : h.lastUpdated) ? g(t.localization, this.options.locales) : ((l = this.uiExtensionsByUuid[t.uuid]) == null ? void 0 : l.localization) || t.localization, i = e && d(e) ? JSON.parse(e.translations) : e, o = {
+      const e = ((c = (a = this.uiExtensionsByUuid[t.uuid]) == null ? void 0 : a.localization) == null ? void 0 : c.lastUpdated) !== ((h = t.localization) == null ? void 0 : h.lastUpdated) ? g(t.localization, this.options.locales) : ((l = this.uiExtensionsByUuid[t.uuid]) == null ? void 0 : l.localization) ?? t.localization, i = e && d(e) ? JSON.parse(e.translations) : e, o = {
         ...t,
         localization: e,
         name: i && t.name.startsWith("t:") ? this._getLocalizedValue(i, t.name) : t.name,

package/dist/ExtensionServerClient/ExtensionServerClient.test.d.ts

@@ -1 +1,9 @@
+declare module './ExtensionServerClient' {
+    namespace ExtensionServer {
+        interface ConnectionOptions {
+            url?: string;
+            automaticConnect?: boolean;
+        }
+    }
+}
 export {};

package/dist/ExtensionServerClient/server-types.d.ts

@@ -0,0 +1,42 @@
+import { Surface } from './types.js';
+import { ExtensionPayload, ExtensionPoint } from '../types';
+import { FlattenedLocalization, Localization } from '../i18n';
+export declare namespace ExtensionServer {
+    interface UIExtension extends ExtensionPayload {
+        extensionPoints: ExtensionPoint[];
+        localization?: FlattenedLocalization | Localization | null;
+    }
+    interface Client {
+        id: string;
+        connection: WebSocket;
+        options: Options;
+        connect(options?: Options): () => void;
+        on<TEvent extends keyof InboundEvents>(event: TEvent, listener: (payload: InboundEvents[TEvent]) => void): () => void;
+        persist<TEvent extends keyof OutboundPersistEvents>(event: TEvent, data: OutboundPersistEvents[TEvent]): void;
+        emit<TEvent extends keyof DispatchEvents>(...args: EmitArgs<TEvent>): void;
+        onConnection<TEvent extends 'close' | 'open'>(event: TEvent, listener: (event: Event) => void): () => void;
+    }
+    interface Options {
+        connection: {
+            url?: string;
+            automaticConnect?: boolean;
+            protocols?: string | string[];
+        };
+        surface?: Surface;
+        locales?: any;
+    }
+    interface ServerEvents {
+        event: string;
+        data: any;
+    }
+    interface InboundEvents {
+        [key: string]: any;
+    }
+    interface OutboundPersistEvents {
+        [key: string]: any;
+    }
+    interface DispatchEvents {
+        [key: string]: any;
+    }
+    type EmitArgs<TEvent extends keyof DispatchEvents> = undefined extends DispatchEvents[TEvent] ? [event: TEvent] : [event: TEvent, payload: DispatchEvents[TEvent]];
+}

package/dist/context/constants.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("../ExtensionServerClient/ExtensionServerClient.cjs.js"),o=require("../state/reducers/constants.cjs.js"),e=require("../utilities/noop.cjs.js"),r=require("react"),t={connect:e.noop,dispatch:e.noop,state:o.INITIAL_STATE,client:new n.ExtensionServerClient},s=r.createContext(t);exports.DEFAULT_VALUE=t;exports.extensionServerContext=s;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("../ExtensionServerClient/ExtensionServerClient.cjs.js"),n=require("../state/reducers/constants.cjs.js"),e=require("../utilities/noop.cjs.js"),o=require("react"),r={connect:e.noop,dispatch:e.noop,state:n.INITIAL_STATE,client:new t.ExtensionServerClient},s=o.createContext(r);exports.extensionServerContext=s;

package/dist/context/constants.d.ts

@@ -1,3 +1,2 @@
 import type { ExtensionServerContext } from './types';
-export declare const DEFAULT_VALUE: ExtensionServerContext;
 export declare const extensionServerContext: import("react").Context<ExtensionServerContext>;

package/dist/context/constants.es.js

@@ -9,6 +9,5 @@ const r = {
   client: new o()
 }, s = n(r);
 export {
-  r as DEFAULT_VALUE,
   s as extensionServerContext
 };

package/dist/context/types.d.ts

@@ -1,3 +1,4 @@
+import { ExtensionServer } from '../ExtensionServerClient/server-types.js';
 import type { ExtensionServerState, ExtensionServerActions } from '../state';
 export interface ExtensionServerContext {
     client: ExtensionServer.Client;

package/dist/hooks/index.d.ts

@@ -1,5 +1,3 @@
-export * from './useExtensionClient';
 export * from './useExtensionServerContext';
-export * from './useExtensionServerEvent';
 export * from './useExtensionServerState';
 export * from './useIsomorphicLayoutEffect';

package/dist/i18n.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const L=["localization","name","description"];function u(n){const t=new Map;return f(n,(e,s)=>t.set(e,s)),t}function f(n,t,e){Object.keys(n).forEach(s=>{const o=n[s],r=e?`${e}.${s}`:s;o!=null&&(typeof o=="string"?t(r,o):f(o,t,r))})}function c(n,t){const e=a(n.translations[n.defaultLocale]),s=i(t),o=a(n.translations[s]),r=a(n.translations[t]);return d(new Map([...e,...o,...r]))}function a(n){return n?u(n):new Map}function p(n,t){const e=new Set(Object.keys(n.translations));if(e.size===0||e.has(t.user))return t.user;const s=i(t.user);if(e.has(s))return s;if(t.shop&&e.has(t.shop))return t.shop;const o=t.shop&&i(t.shop);return o&&e.has(o)?o:n.defaultLocale}function d(n){const t={};for(const[e,s]of n)t[e]=s;return t}function i(n){return n.split("-")[0]}function T(n,t){if(!n||!t)return;if(l(n))return n;const e=p(n,t),s=JSON.stringify(c(n,e));return{extensionLocale:e,translations:s,lastUpdated:n.lastUpdated}}function l(n){return typeof n.translations=="string"&&Object.prototype.hasOwnProperty.call(n,"extensionLocale")}exports.TRANSLATED_KEYS=L;exports.dictionaryToFlatMap=u;exports.flattenDevExtensionTranslations=c;exports.getFlattenedLocalization=T;exports.isFlattenedTranslations=l;exports.resolveDevExtensionLocale=p;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const l=["localization","name","description"];function L(n){const t=new Map;return u(n,(e,s)=>t.set(e,s)),t}function u(n,t,e){Object.keys(n).forEach(s=>{const o=n[s],r=e?`${e}.${s}`:s;o!=null&&(typeof o=="string"?t(r,o):u(o,t,r))})}function f(n,t){const e=a(n.translations[n.defaultLocale]),s=i(t),o=a(n.translations[s]),r=a(n.translations[t]);return d(new Map([...e,...o,...r]))}function a(n){return n?L(n):new Map}function c(n,t){const e=new Set(Object.keys(n.translations));if(e.size===0||e.has(t.user))return t.user;const s=i(t.user);if(e.has(s))return s;if(t.shop&&e.has(t.shop))return t.shop;const o=t.shop&&i(t.shop);return o&&e.has(o)?o:n.defaultLocale}function d(n){const t={};for(const[e,s]of n)t[e]=s;return t}function i(n){return n.split("-")[0]}function T(n,t){if(!n||!t)return;if(p(n))return n;const e=c(n,t),s=JSON.stringify(f(n,e));return{extensionLocale:e,translations:s,lastUpdated:n.lastUpdated}}function p(n){return typeof n.translations=="string"&&Object.prototype.hasOwnProperty.call(n,"extensionLocale")}exports.TRANSLATED_KEYS=l;exports.flattenDevExtensionTranslations=f;exports.getFlattenedLocalization=T;exports.isFlattenedTranslations=p;exports.resolveDevExtensionLocale=c;

package/dist/i18n.d.ts

@@ -22,9 +22,6 @@ export interface LocalesOptions {
     user: string;
     shop?: string;
 }
-export interface TranslationDictionary {
-    [key: string]: string | TranslationDictionary;
-}
 /**
  * This is a flattened dictionary of extension translations for the active locale.
  *
@@ -63,26 +60,10 @@ export interface TranslationDictionary {
  * }
  * ```
  */
-export interface ExtensionTranslationMap {
+interface ExtensionTranslationMap {
     [key: string]: string;
 }
 export declare const TRANSLATED_KEYS: string[];
-/**
- * From a nested dictionary like the following :
- *
- * ```typescript
- * const dictionary = {
- *   Foo: {
- *     Bar: {
- *        fooBar: 'something'
- *     }
- *   }
- * }
- *
- * Returns a map containing this pair : {'Foo.Bar.fooBar': 'something'}
- * ```
- */
-export declare function dictionaryToFlatMap(dictionary: TranslationDictionary): Map<string, string>;
 export declare function flattenDevExtensionTranslations(localization: Localization, locale: string): ExtensionTranslationMap;
 export declare function resolveDevExtensionLocale(localization: Localization, locales: {
     user: string;

package/dist/i18n.es.js

@@ -53,7 +53,6 @@ function d(n) {
 }
 export {
   h as TRANSLATED_KEYS,
-  f as dictionaryToFlatMap,
   c as flattenDevExtensionTranslations,
   l as getFlattenedLocalization,
   d as isFlattenedTranslations,

package/dist/index.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("./context/ExtensionServerProvider.cjs.js"),n=require("./context/constants.cjs.js"),o=require("./ExtensionServerClient/ExtensionServerClient.cjs.js"),s=require("./ExtensionServerClient/types.cjs.js"),i=require("./hooks/useExtensionClient.cjs.js"),c=require("./hooks/useExtensionServerContext.cjs.js"),a=require("./hooks/useExtensionServerEvent.cjs.js"),u=require("./hooks/useExtensionServerState.cjs.js"),E=require("./hooks/useIsomorphicLayoutEffect.cjs.js"),t=require("./state/actions/actions.cjs.js"),S=require("./state/reducers/constants.cjs.js"),x=require("./state/reducers/extensionServerReducer.cjs.js"),l=require("./types.cjs.js"),v=require("./utilities/groupByKey.cjs.js"),A=require("./utilities/noop.cjs.js"),d=require("./utilities/replaceUpdated.cjs.js"),p=require("./utilities/set.cjs.js"),T=require("./utilities/assetToString.cjs.js"),q=require("./utilities/isValidSurface.cjs.js"),L=require("./utilities/isUIExtension.cjs.js"),e=require("./i18n.cjs.js");exports.ExtensionServerProvider=r.ExtensionServerProvider;exports.DEFAULT_VALUE=n.DEFAULT_VALUE;exports.extensionServerContext=n.extensionServerContext;exports.ExtensionServerClient=o.ExtensionServerClient;exports.AVAILABLE_SURFACES=s.AVAILABLE_SURFACES;exports.useExtensionClient=i.useExtensionClient;exports.useExtensionServerContext=c.useExtensionServerContext;exports.useExtensionServerEvent=a.useExtensionServerEvent;exports.useExtensionServerState=u.useExtensionServerState;exports.useIsomorphicLayoutEffect=E.useIsomorphicLayoutEffect;exports.createConnectedAction=t.createConnectedAction;exports.createFocusAction=t.createFocusAction;exports.createRefreshAction=t.createRefreshAction;exports.createUnfocusAction=t.createUnfocusAction;exports.createUpdateAction=t.createUpdateAction;exports.INITIAL_STATE=S.INITIAL_STATE;exports.extensionServerReducer=x.extensionServerReducer;exports.Status=l.Status;exports.groupByKey=v.groupByKey;exports.noop=A.noop;exports.replaceUpdated=d.replaceUpdated;exports.set=p.set;exports.assetToString=T.assetToString;exports.isValidSurface=q.isValidSurface;exports.isUIExtension=L.isUIExtension;exports.TRANSLATED_KEYS=e.TRANSLATED_KEYS;exports.dictionaryToFlatMap=e.dictionaryToFlatMap;exports.flattenDevExtensionTranslations=e.flattenDevExtensionTranslations;exports.getFlattenedLocalization=e.getFlattenedLocalization;exports.isFlattenedTranslations=e.isFlattenedTranslations;exports.resolveDevExtensionLocale=e.resolveDevExtensionLocale;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("./context/ExtensionServerProvider.cjs.js"),r=require("./context/constants.cjs.js"),o=require("./ExtensionServerClient/ExtensionServerClient.cjs.js"),s=require("./ExtensionServerClient/types.cjs.js"),i=require("./hooks/useExtensionServerContext.cjs.js"),c=require("./hooks/useExtensionServerState.cjs.js"),a=require("./hooks/useIsomorphicLayoutEffect.cjs.js"),e=require("./state/actions/actions.cjs.js"),u=require("./state/reducers/constants.cjs.js"),S=require("./state/reducers/extensionServerReducer.cjs.js"),E=require("./types.cjs.js"),x=require("./utilities/noop.cjs.js"),l=require("./utilities/replaceUpdated.cjs.js"),v=require("./utilities/set.cjs.js"),A=require("./utilities/assetToString.cjs.js"),d=require("./utilities/isValidSurface.cjs.js"),q=require("./utilities/isUIExtension.cjs.js"),t=require("./i18n.cjs.js");exports.ExtensionServerProvider=n.ExtensionServerProvider;exports.extensionServerContext=r.extensionServerContext;exports.ExtensionServerClient=o.ExtensionServerClient;exports.AVAILABLE_SURFACES=s.AVAILABLE_SURFACES;exports.useExtensionServerContext=i.useExtensionServerContext;exports.useExtensionServerState=c.useExtensionServerState;exports.useIsomorphicLayoutEffect=a.useIsomorphicLayoutEffect;exports.createConnectedAction=e.createConnectedAction;exports.createFocusAction=e.createFocusAction;exports.createRefreshAction=e.createRefreshAction;exports.createUnfocusAction=e.createUnfocusAction;exports.createUpdateAction=e.createUpdateAction;exports.INITIAL_STATE=u.INITIAL_STATE;exports.extensionServerReducer=S.extensionServerReducer;exports.Status=E.Status;exports.noop=x.noop;exports.replaceUpdated=l.replaceUpdated;exports.set=v.set;exports.assetToString=A.assetToString;exports.isValidSurface=d.isValidSurface;exports.isUIExtension=q.isUIExtension;exports.TRANSLATED_KEYS=t.TRANSLATED_KEYS;exports.flattenDevExtensionTranslations=t.flattenDevExtensionTranslations;exports.getFlattenedLocalization=t.getFlattenedLocalization;exports.isFlattenedTranslations=t.isFlattenedTranslations;exports.resolveDevExtensionLocale=t.resolveDevExtensionLocale;

package/dist/index.es.js

@@ -1,54 +1,46 @@
 import { ExtensionServerProvider as r } from "./context/ExtensionServerProvider.es.js";
-import { DEFAULT_VALUE as n, extensionServerContext as x } from "./context/constants.es.js";
-import { ExtensionServerClient as i } from "./ExtensionServerClient/ExtensionServerClient.es.js";
+import { extensionServerContext as n } from "./context/constants.es.js";
+import { ExtensionServerClient as s } from "./ExtensionServerClient/ExtensionServerClient.es.js";
 import { AVAILABLE_SURFACES as a } from "./ExtensionServerClient/types.es.js";
-import { useExtensionClient as m } from "./hooks/useExtensionClient.es.js";
-import { useExtensionServerContext as E } from "./hooks/useExtensionServerContext.es.js";
-import { useExtensionServerEvent as A } from "./hooks/useExtensionServerEvent.es.js";
-import { useExtensionServerState as u } from "./hooks/useExtensionServerState.es.js";
-import { useIsomorphicLayoutEffect as d } from "./hooks/useIsomorphicLayoutEffect.es.js";
-import { createConnectedAction as L, createFocusAction as U, createRefreshAction as C, createUnfocusAction as F, createUpdateAction as I } from "./state/actions/actions.es.js";
-import { INITIAL_STATE as D } from "./state/reducers/constants.es.js";
-import { extensionServerReducer as _ } from "./state/reducers/extensionServerReducer.es.js";
-import { Status as V } from "./types.es.js";
-import { groupByKey as B } from "./utilities/groupByKey.es.js";
-import { noop as N } from "./utilities/noop.es.js";
-import { replaceUpdated as M } from "./utilities/replaceUpdated.es.js";
-import { set as Y } from "./utilities/set.es.js";
-import { assetToString as j } from "./utilities/assetToString.es.js";
-import { isValidSurface as q } from "./utilities/isValidSurface.es.js";
-import { isUIExtension as G } from "./utilities/isUIExtension.es.js";
-import { TRANSLATED_KEYS as J, dictionaryToFlatMap as O, flattenDevExtensionTranslations as Q, getFlattenedLocalization as W, isFlattenedTranslations as X, resolveDevExtensionLocale as Z } from "./i18n.es.js";
+import { useExtensionServerContext as p } from "./hooks/useExtensionServerContext.es.js";
+import { useExtensionServerState as m } from "./hooks/useExtensionServerState.es.js";
+import { useIsomorphicLayoutEffect as A } from "./hooks/useIsomorphicLayoutEffect.es.js";
+import { createConnectedAction as l, createFocusAction as v, createRefreshAction as d, createUnfocusAction as u, createUpdateAction as T } from "./state/actions/actions.es.js";
+import { INITIAL_STATE as I } from "./state/reducers/constants.es.js";
+import { extensionServerReducer as U } from "./state/reducers/extensionServerReducer.es.js";
+import { Status as R } from "./types.es.js";
+import { noop as _ } from "./utilities/noop.es.js";
+import { replaceUpdated as h } from "./utilities/replaceUpdated.es.js";
+import { set as V } from "./utilities/set.es.js";
+import { assetToString as z } from "./utilities/assetToString.es.js";
+import { isValidSurface as K } from "./utilities/isValidSurface.es.js";
+import { isUIExtension as Y } from "./utilities/isUIExtension.es.js";
+import { TRANSLATED_KEYS as j, flattenDevExtensionTranslations as k, getFlattenedLocalization as q, isFlattenedTranslations as w, resolveDevExtensionLocale as G } from "./i18n.es.js";
 export {
   a as AVAILABLE_SURFACES,
-  n as DEFAULT_VALUE,
-  i as ExtensionServerClient,
+  s as ExtensionServerClient,
   r as ExtensionServerProvider,
-  D as INITIAL_STATE,
-  V as Status,
-  J as TRANSLATED_KEYS,
-  j as assetToString,
-  L as createConnectedAction,
-  U as createFocusAction,
-  C as createRefreshAction,
-  F as createUnfocusAction,
-  I as createUpdateAction,
-  O as dictionaryToFlatMap,
-  x as extensionServerContext,
-  _ as extensionServerReducer,
-  Q as flattenDevExtensionTranslations,
-  W as getFlattenedLocalization,
-  B as groupByKey,
-  X as isFlattenedTranslations,
-  G as isUIExtension,
-  q as isValidSurface,
-  N as noop,
-  M as replaceUpdated,
-  Z as resolveDevExtensionLocale,
-  Y as set,
-  m as useExtensionClient,
-  E as useExtensionServerContext,
-  A as useExtensionServerEvent,
-  u as useExtensionServerState,
-  d as useIsomorphicLayoutEffect
+  I as INITIAL_STATE,
+  R as Status,
+  j as TRANSLATED_KEYS,
+  z as assetToString,
+  l as createConnectedAction,
+  v as createFocusAction,
+  d as createRefreshAction,
+  u as createUnfocusAction,
+  T as createUpdateAction,
+  n as extensionServerContext,
+  U as extensionServerReducer,
+  k as flattenDevExtensionTranslations,
+  q as getFlattenedLocalization,
+  w as isFlattenedTranslations,
+  Y as isUIExtension,
+  K as isValidSurface,
+  _ as noop,
+  h as replaceUpdated,
+  G as resolveDevExtensionLocale,
+  V as set,
+  p as useExtensionServerContext,
+  m as useExtensionServerState,
+  A as useIsomorphicLayoutEffect
 };

package/dist/testing/extensions.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("../types.cjs.js");let i=0;function a(e){return`00000000000${e}`.slice(-12)}function r(e={}){const t=`00000000-0000-0000-0000-${a(i++)}`,n=Date.now();return{handle:"my-extension",name:"My extension",description:"My extension description",surface:"admin",type:"purchase_option",externalType:"external_type",uuid:t,version:"extension version",...e,assets:{main:{name:"main",url:`https://secure-link.com/extensions/${t}/assets/handle.js?lastUpdated=${n}`,lastUpdated:n},...e.assets||{}},development:{hidden:!1,status:s.Status.Success,resource:{url:"resourceUrl"},root:{url:`https://secure-link.com/extensions/${t}`},renderer:{name:"render name",version:"1.0.0"},...e.development||{}},extensionPoints:e.extensionPoints,capabilities:e.capabilities,localization:e.localization,authenticatedRedirectStartUrl:e.authenticatedRedirectStartUrl,authenticatedRedirectRedirectUrls:e.authenticatedRedirectRedirectUrls,settings:{fields:[{key:"sample-key",name:"sample_name",type:"sample_type"}]}}}exports.mockExtension=r;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("../types.cjs.js");let i=0;function a(e){return`00000000000${e}`.slice(-12)}function r(e={}){const t=`00000000-0000-0000-0000-${a(i++)}`,n=Date.now();return{handle:"my-extension",name:"My extension",description:"My extension description",surface:"admin",type:"purchase_option",externalType:"external_type",uuid:t,version:"extension version",...e,assets:{main:{name:"main",url:`https://secure-link.com/extensions/${t}/assets/handle.js?lastUpdated=${n}`,lastUpdated:n},...e.assets??{}},development:{hidden:!1,status:s.Status.Success,resource:{url:"resourceUrl"},root:{url:`https://secure-link.com/extensions/${t}`},renderer:{name:"render name",version:"1.0.0"},...e.development??{}},extensionPoints:e.extensionPoints,capabilities:e.capabilities,localization:e.localization,authenticatedRedirectStartUrl:e.authenticatedRedirectStartUrl,authenticatedRedirectRedirectUrls:e.authenticatedRedirectRedirectUrls,settings:{fields:[{key:"sample-key",name:"sample_name",type:"sample_type"}]}}}exports.mockExtension=r;

package/dist/testing/extensions.es.js

@@ -21,7 +21,7 @@ function c(e = {}) {
         url: `https://secure-link.com/extensions/${t}/assets/handle.js?lastUpdated=${n}`,
         lastUpdated: n
       },
-      ...e.assets || {}
+      ...e.assets ?? {}
     },
     development: {
       hidden: !1,
@@ -36,7 +36,7 @@ function c(e = {}) {
         name: "render name",
         version: "1.0.0"
       },
-      ...e.development || {}
+      ...e.development ?? {}
     },
     // this is due to the naive DeepPartial but also more complex ones
     // [see stackoverflow](https://stackoverflow.com/a/68699273) assume that

package/dist/types.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});var e=(r=>(r.Error="error",r.Success="success",r))(e||{});exports.Status=e;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});var t=(e=>(e.Success="success",e))(t||{});exports.Status=t;

package/dist/types.d.ts

@@ -73,14 +73,14 @@ declare global {
 export type DeepPartial<T> = {
     [P in keyof T]?: DeepPartial<T[P]>;
 };
-export interface ResourceURL {
+interface ResourceURL {
     url: string;
 }
 export interface Asset extends ResourceURL {
     name: string;
     lastUpdated: number;
 }
-export interface Metafield {
+interface Metafield {
     namespace: string;
     key: string;
 }
@@ -93,8 +93,11 @@ export interface ExtensionPoint {
     localization?: FlattenedLocalization | Localization | null;
     name: string;
     description?: string;
+    assets?: {
+        [name: string]: Asset;
+    };
 }
-export type ExtensionPoints = string[] | ExtensionPoint[] | null;
+type ExtensionPoints = string[] | ExtensionPoint[] | null;
 interface CollectBuyerConsentCapabilities {
     smsMarketing: boolean;
     customerPrivacy: boolean;
@@ -125,6 +128,10 @@ export interface ExtensionPayload {
             name: string;
             version: string;
         };
+        error?: {
+            message: string;
+            file?: string;
+        };
     };
     uuid: string;
     version: string;
@@ -149,7 +156,6 @@ export interface ExtensionPayload {
     };
 }
 export declare enum Status {
-    Error = "error",
     Success = "success"
 }
 export interface App {

package/dist/types.es.js

@@ -1,4 +1,4 @@
-var e = /* @__PURE__ */ ((r) => (r.Error = "error", r.Success = "success", r))(e || {});
+var c = /* @__PURE__ */ ((s) => (s.Success = "success", s))(c || {});
 export {
-  e as Status
+  c as Status
 };

package/dist/utilities/index.d.ts

@@ -1,4 +1,3 @@
-export * from './groupByKey';
 export * from './noop';
 export * from './replaceUpdated';
 export * from './set';

package/node_modules/@shopify/ui-extensions-test-utils/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './render';
+export * from './renderHook';
+export * from './withProviders';

package/node_modules/@shopify/ui-extensions-test-utils/dist/render.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare function render<TProps, TProviderProps>(element: React.ReactElement<TProps>, Providers?: React.ComponentType<TProviderProps>, options?: Omit<TProviderProps, 'children'>): import("@shopify/react-testing").Root<any>;

package/node_modules/@shopify/ui-extensions-test-utils/dist/renderHook.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+export interface HookWrapper<T> {
+    result: T;
+    /**
+     * Use to wrap calls to stateful hook methods:
+     *
+     * ```ts
+     * const hook = testHook(() => useToggle(false))
+     * expect(hook.result.value).toBe(false)
+     * hook.act(() => hook.result.toggle())
+     * expect(hook.result.value).toBe(true)
+     * ```
+     **/
+    act<TR>(callback: (currentResult: T) => TR): TR;
+    forceUpdate(): void;
+}
+export declare function renderHook<T, TP>(hook: () => T, Providers?: React.ComponentType<TP>, options?: Omit<TP, 'children'>): HookWrapper<T>;

package/node_modules/@shopify/ui-extensions-test-utils/dist/withProviders.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+export type ProviderComponent<TProps = any> = React.ComponentType<React.PropsWithChildren<TProps>>;
+export type Tail<T extends any[]> = T extends [head: any, ...tail: infer TRest] ? TRest : never;
+export type PropUnion<TProviders extends any[], TProps extends {
+    [k: string]: any;
+} = Empty> = TProviders[0] extends React.ComponentType<any> ? React.ComponentPropsWithoutRef<TProviders[0]> & PropUnion<Tail<TProviders>> : TProps;
+export interface Empty {
+}
+export declare function withProviders<T extends ProviderComponent[]>(...providers: T): ProviderComponent<PropUnion<T>>;

package/node_modules/@shopify/ui-extensions-test-utils/dist/withProviders.js

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-empty-interface */
 import React from 'react';
 export function withProviders(...providers) {
     return function Providers({ children, ...props }) {

package/node_modules/@shopify/ui-extensions-test-utils/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@shopify/ui-extensions-test-utils",
   "version": "3.26.0",
+  "packageManager": "pnpm@10.11.1",
   "private": true,
   "license": "MIT",
   "main": "dist/index",
@@ -28,12 +29,10 @@
   },
   "devDependencies": {
     "@shopify/react-testing": "^3.0.0",
-    "@types/node": "18.19.3",
     "@types/react": "16.14.0",
     "@types/react-dom": "^16.9.11",
     "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "typescript": "5.2.2"
+    "react-dom": "^17.0.2"
   },
   "peerDependencies": {
     "react": "^17.0.2"

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@shopify/ui-extensions-server-kit",
-  "version": "5.2.1",
+  "version": "5.3.1",
   "private": false,
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Shopify/cli.git",
+    "directory": "packages/ui-extensions-server-kit"
+  },
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -40,15 +45,12 @@
   "devDependencies": {
     "@shopify/react-testing": "^3.0.0",
     "@shopify/ui-extensions-test-utils": "3.26.0",
-    "@types/node": "18.19.3",
     "@types/react": "17.0.2",
     "@vitejs/plugin-react-refresh": "^1.3.6",
-    "jest-websocket-mock": "^2.4.0",
     "jsdom": "^20.0.3",
     "react": "^17.0.2",
-    "typescript": "5.2.2",
     "vi-fetch": "^0.8.0",
-    "vite": "^5.3.1"
+    "vite": "6.3.6"
   },
   "peerDependencies": {
     "react": "^17.0.2"
@@ -58,7 +60,6 @@
     "clean": "nx clean",
     "lint": "nx lint",
     "lint:fix": "nx lint:fix",
-    "test": "nx run ui-extensions-server-kit:test",
-    "test:watch": "nx test:watch"
+    "vitest": "vitest"
   }
 }

package/project.json

@@ -53,22 +53,6 @@
         "command": "pnpm eslint src --fix",
         "cwd": "packages/ui-extensions-server-kit"
       }
-    },
-    "test": {
-      "executor": "nx:run-commands",
-      "dependsOn": ["^build"],
-      "options": {
-        "command": "pnpm vitest run",
-        "cwd": "packages/ui-extensions-server-kit"
-      }
-    },
-    "test:watch": {
-      "executor": "nx:run-commands",
-      "dependsOn": ["^build"],
-      "options": {
-        "command": "pnpm vitest watch",
-        "cwd": "packages/ui-extensions-server-kit"
-      }
     }
   }
 }