@shopify/ui-extensions-server-kit 0.0.0-snapshot-20240820121935 → 0.0.0-snapshot-20250604200552

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 # @shopify/ui-extensions-server-kit
 
-## 0.0.0-snapshot-20240820121935
+## 0.0.0-snapshot-20250604200552
+
+### Minor Changes
+
+- 2f13008: Add support for displaying POS dev logs
+
+## 5.2.1
 
 ### Patch Changes
 

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.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/context/ExtensionServerProvider.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const E=require("./constants.cjs.js"),o=require("../state/actions/actions.cjs.js"),d=require("../ExtensionServerClient/ExtensionServerClient.cjs.js"),a=require("../hooks/useIsomorphicLayoutEffect.cjs.js"),p=require("../hooks/useExtensionServerState.cjs.js"),r=require("react");function x({children:f,options:S}){const[i,n]=p.useExtensionServerState(),[c,v]=r.useState(S),[t]=r.useState(()=>new d.ExtensionServerClient),u=r.useCallback((s=c)=>{v(s)},[c]);a.useIsomorphicLayoutEffect(()=>t.connect(c),[t,c]),a.useIsomorphicLayoutEffect(()=>{const s=[t.on("update",e=>n(o.createUpdateAction(e))),t.on("connected",e=>n(o.createConnectedAction(e))),t.on("refresh",e=>n(o.createRefreshAction(e))),t.on("focus",e=>n(o.createFocusAction(e))),t.on("unfocus",e=>n(o.createUnfocusAction(e)))];return()=>s.forEach(e=>e())},[n]);const l=r.useMemo(()=>({dispatch:n,state:i,connect:u,client:t}),[n,u,i,t]);return r.createElement(E.extensionServerContext.Provider,{value:l},f)}exports.ExtensionServerProvider=x;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const E=require("./constants.cjs.js"),n=require("../state/actions/actions.cjs.js"),d=require("../ExtensionServerClient/ExtensionServerClient.cjs.js"),a=require("../hooks/useIsomorphicLayoutEffect.cjs.js"),p=require("../hooks/useExtensionServerState.cjs.js"),r=require("react");function x({children:f,options:S}){const[i,o]=p.useExtensionServerState(),[c,l]=r.useState(S),[t]=r.useState(()=>new d.ExtensionServerClient),u=r.useCallback((s=c)=>{l(s)},[c]);a.useIsomorphicLayoutEffect(()=>t.connect(c),[t,c]),a.useIsomorphicLayoutEffect(()=>{const s=[t.on("update",e=>o(n.createUpdateAction(e))),t.on("connected",e=>o(n.createConnectedAction(e))),t.on("refresh",e=>o(n.createRefreshAction(e))),t.on("focus",e=>o(n.createFocusAction(e))),t.on("unfocus",e=>o(n.createUnfocusAction(e))),t.on("log",e=>o(n.createLogAction(e)))];return()=>s.forEach(e=>e())},[o]);const v=r.useMemo(()=>({dispatch:o,state:i,connect:u,client:t}),[o,u,i,t]);return r.createElement(E.extensionServerContext.Provider,{value:v},f)}exports.ExtensionServerProvider=x;

package/dist/context/ExtensionServerProvider.es.js

@@ -1,11 +1,11 @@
-import { extensionServerContext as d } from "./constants.es.js";
-import { createUpdateAction as l, createConnectedAction as v, createRefreshAction as x, createFocusAction as E, createUnfocusAction as S } from "../state/actions/actions.es.js";
+import { extensionServerContext as l } from "./constants.es.js";
+import { createUpdateAction as d, createConnectedAction as v, createRefreshAction as x, createFocusAction as A, createUnfocusAction as E, createLogAction as S } from "../state/actions/actions.es.js";
 import { ExtensionServerClient as h } from "../ExtensionServerClient/ExtensionServerClient.es.js";
 import { useIsomorphicLayoutEffect as i } from "../hooks/useIsomorphicLayoutEffect.es.js";
-import { useExtensionServerState as A } from "../hooks/useExtensionServerState.es.js";
-import C, { useState as a, useCallback as P, useMemo as R } from "react";
-function I({ children: u, options: f }) {
-  const [c, o] = A(), [n, m] = a(f), [t] = a(() => new h()), s = P(
+import { useExtensionServerState as C } from "../hooks/useExtensionServerState.es.js";
+import g, { useState as a, useCallback as L, useMemo as P } from "react";
+function F({ children: u, options: f }) {
+  const [c, o] = C(), [n, m] = a(f), [t] = a(() => new h()), s = L(
     (r = n) => {
       m(r);
     },
@@ -13,17 +13,18 @@ function I({ children: u, options: f }) {
   );
   i(() => t.connect(n), [t, n]), i(() => {
     const r = [
-      t.on("update", (e) => o(l(e))),
+      t.on("update", (e) => o(d(e))),
       t.on("connected", (e) => o(v(e))),
       t.on("refresh", (e) => o(x(e))),
-      t.on("focus", (e) => o(E(e))),
-      t.on("unfocus", (e) => o(S(e)))
+      t.on("focus", (e) => o(A(e))),
+      t.on("unfocus", (e) => o(E(e))),
+      t.on("log", (e) => o(S(e)))
     ];
     return () => r.forEach((e) => e());
   }, [o]);
-  const p = R(() => ({ dispatch: o, state: c, connect: s, client: t }), [o, s, c, t]);
-  return /* @__PURE__ */ C.createElement(d.Provider, { value: p }, u);
+  const p = P(() => ({ dispatch: o, state: c, connect: s, client: t }), [o, s, c, t]);
+  return /* @__PURE__ */ g.createElement(l.Provider, { value: p }, u);
 }
 export {
-  I as ExtensionServerProvider
+  F as ExtensionServerProvider
 };

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 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"),e=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"),t=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=e.createConnectedAction;exports.createFocusAction=e.createFocusAction;exports.createLogAction=e.createLogAction;exports.createRefreshAction=e.createRefreshAction;exports.createUnfocusAction=e.createUnfocusAction;exports.createUpdateAction=e.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=t.TRANSLATED_KEYS;exports.dictionaryToFlatMap=t.dictionaryToFlatMap;exports.flattenDevExtensionTranslations=t.flattenDevExtensionTranslations;exports.getFlattenedLocalization=t.getFlattenedLocalization;exports.isFlattenedTranslations=t.isFlattenedTranslations;exports.resolveDevExtensionLocale=t.resolveDevExtensionLocale;

package/dist/index.es.js

@@ -1,54 +1,55 @@
 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 { AVAILABLE_SURFACES as a } from "./ExtensionServerClient/types.es.js";
-import { useExtensionClient as m } from "./hooks/useExtensionClient.es.js";
+import { ExtensionServerClient as s } from "./ExtensionServerClient/ExtensionServerClient.es.js";
+import { AVAILABLE_SURFACES as p } from "./ExtensionServerClient/types.es.js";
+import { useExtensionClient as c } from "./hooks/useExtensionClient.es.js";
 import { useExtensionServerContext as E } from "./hooks/useExtensionServerContext.es.js";
-import { useExtensionServerEvent as A } from "./hooks/useExtensionServerEvent.es.js";
+import { useExtensionServerEvent as S } 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 { createConnectedAction as T, createFocusAction as U, createLogAction as C, createRefreshAction as F, createUnfocusAction as I, createUpdateAction as g } 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 { Status as h } from "./types.es.js";
+import { groupByKey as K } from "./utilities/groupByKey.es.js";
+import { noop as z } from "./utilities/noop.es.js";
+import { replaceUpdated as P } from "./utilities/replaceUpdated.es.js";
+import { set as b } from "./utilities/set.es.js";
+import { assetToString as k } from "./utilities/assetToString.es.js";
+import { isValidSurface as w } from "./utilities/isValidSurface.es.js";
+import { isUIExtension as H } from "./utilities/isUIExtension.es.js";
+import { TRANSLATED_KEYS as O, dictionaryToFlatMap as Q, flattenDevExtensionTranslations as W, getFlattenedLocalization as X, isFlattenedTranslations as Z, resolveDevExtensionLocale as $ } from "./i18n.es.js";
 export {
-  a as AVAILABLE_SURFACES,
+  p 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,
+  h as Status,
+  O as TRANSLATED_KEYS,
+  k as assetToString,
+  T as createConnectedAction,
   U as createFocusAction,
-  C as createRefreshAction,
-  F as createUnfocusAction,
-  I as createUpdateAction,
-  O as dictionaryToFlatMap,
+  C as createLogAction,
+  F as createRefreshAction,
+  I as createUnfocusAction,
+  g as createUpdateAction,
+  Q 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,
+  W as flattenDevExtensionTranslations,
+  X as getFlattenedLocalization,
+  K as groupByKey,
+  Z as isFlattenedTranslations,
+  H as isUIExtension,
+  w as isValidSurface,
+  z as noop,
+  P as replaceUpdated,
+  $ as resolveDevExtensionLocale,
+  b as set,
+  c as useExtensionClient,
   E as useExtensionServerContext,
-  A as useExtensionServerEvent,
+  S as useExtensionServerEvent,
   u as useExtensionServerState,
   d as useIsomorphicLayoutEffect
 };

package/dist/state/actions/actions.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function t(e){return{type:"connected",payload:e}}function c(e){return{type:"update",payload:e}}function n(e){return{type:"refresh",payload:e}}function o(e){return{type:"focus",payload:e}}function r(e){return{type:"unfocus",payload:e}}exports.createConnectedAction=t;exports.createFocusAction=o;exports.createRefreshAction=n;exports.createUnfocusAction=r;exports.createUpdateAction=c;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function t(e){return{type:"connected",payload:e}}function c(e){return{type:"update",payload:e}}function n(e){return{type:"refresh",payload:e}}function o(e){return{type:"focus",payload:e}}function r(e){return{type:"unfocus",payload:e}}function u(e){return{type:"log",payload:e}}exports.createConnectedAction=t;exports.createFocusAction=o;exports.createLogAction=u;exports.createRefreshAction=n;exports.createUnfocusAction=r;exports.createUpdateAction=c;

package/dist/state/actions/actions.d.ts

@@ -1,6 +1,7 @@
-import type { ConnectedAction, UpdateAction, RefreshAction, FocusAction, UnfocusAction } from './types';
+import type { ConnectedAction, UpdateAction, RefreshAction, FocusAction, UnfocusAction, LogAction } from './types';
 export declare function createConnectedAction(payload: ConnectedAction['payload']): ConnectedAction;
 export declare function createUpdateAction(payload: UpdateAction['payload']): UpdateAction;
 export declare function createRefreshAction(payload: RefreshAction['payload']): RefreshAction;
 export declare function createFocusAction(payload: FocusAction['payload']): FocusAction;
 export declare function createUnfocusAction(payload: UnfocusAction['payload']): UnfocusAction;
+export declare function createLogAction(payload: LogAction['payload']): LogAction;

package/dist/state/actions/actions.es.js

@@ -28,9 +28,16 @@ function o(e) {
     payload: e
   };
 }
+function u(e) {
+  return {
+    type: "log",
+    payload: e
+  };
+}
 export {
   t as createConnectedAction,
   r as createFocusAction,
+  u as createLogAction,
   c as createRefreshAction,
   o as createUnfocusAction,
   n as createUpdateAction

package/dist/state/actions/types.d.ts

@@ -18,4 +18,8 @@ export interface UnfocusAction {
     type: 'unfocus';
     payload: ExtensionServer.InboundEvents['unfocus'];
 }
-export type ExtensionServerActions = ConnectedAction | UpdateAction | RefreshAction | FocusAction | UnfocusAction;
+export interface LogAction {
+    type: 'log';
+    payload: ExtensionServer.InboundEvents['log'];
+}
+export type ExtensionServerActions = ConnectedAction | UpdateAction | RefreshAction | FocusAction | UnfocusAction | LogAction;

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.d.ts

@@ -47,6 +47,11 @@ declare global {
             navigate: {
                 url: string;
             };
+            log: {
+                level: string;
+                args: unknown[];
+                extensionName: string;
+            };
         }
         namespace API {
             interface BaseResponse {
@@ -93,6 +98,9 @@ export interface ExtensionPoint {
     localization?: FlattenedLocalization | Localization | null;
     name: string;
     description?: string;
+    assets?: {
+        [name: string]: Asset;
+    };
 }
 export type ExtensionPoints = string[] | ExtensionPoint[] | null;
 interface CollectBuyerConsentCapabilities {

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,6 +1,6 @@
 {
   "name": "@shopify/ui-extensions-server-kit",
-  "version": "0.0.0-snapshot-20240820121935",
+  "version": "0.0.0-snapshot-20250604200552",
   "private": false,
   "license": "MIT",
   "exports": {
@@ -40,15 +40,13 @@
   "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": "5.4.12"
   },
   "peerDependencies": {
     "react": "^17.0.2"

package/project.json

@@ -56,7 +56,6 @@
     },
     "test": {
       "executor": "nx:run-commands",
-      "dependsOn": ["^build"],
       "options": {
         "command": "pnpm vitest run",
         "cwd": "packages/ui-extensions-server-kit"
@@ -64,7 +63,6 @@
     },
     "test:watch": {
       "executor": "nx:run-commands",
-      "dependsOn": ["^build"],
       "options": {
         "command": "pnpm vitest watch",
         "cwd": "packages/ui-extensions-server-kit"

package/src/ExtensionServerClient/ExtensionServerClient.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-dynamic-delete */
 /* eslint-disable no-console */
 import {Surface} from './types.js'
 import {
@@ -211,7 +212,7 @@ export class ExtensionServerClient implements ExtensionServer.Client {
 
       const localization = shouldUpdateTranslations
         ? getFlattenedLocalization(extension.localization, this.options.locales)
-        : this.uiExtensionsByUuid[extension.uuid]?.localization || extension.localization
+        : this.uiExtensionsByUuid[extension.uuid]?.localization ?? extension.localization
 
       const parsedTranslation: {[key: string]: string} =
         localization && isFlattenedTranslations(localization) ? JSON.parse(localization.translations) : localization

package/src/ExtensionServerClient/types.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-invalid-void-type */
+/* eslint-disable @typescript-eslint/no-empty-interface */
 import type {LocalesOptions} from '../i18n'
 
 declare global {

package/src/context/ExtensionServerProvider.tsx

@@ -5,6 +5,7 @@ import {
   createRefreshAction,
   createFocusAction,
   createUnfocusAction,
+  createLogAction,
 } from '../state'
 
 import {ExtensionServerClient} from '../ExtensionServerClient'
@@ -35,6 +36,7 @@ export function ExtensionServerProvider({children, options: defaultOptions}: Ext
       client.on('refresh', (payload) => dispatch(createRefreshAction(payload))),
       client.on('focus', (payload) => dispatch(createFocusAction(payload))),
       client.on('unfocus', (payload) => dispatch(createUnfocusAction(payload))),
+      client.on('log', (payload) => dispatch(createLogAction(payload))),
     ]
 
     return () => listeners.forEach((unsubscribe) => unsubscribe())

package/src/state/actions/actions.ts

@@ -1,4 +1,4 @@
-import type {ConnectedAction, UpdateAction, RefreshAction, FocusAction, UnfocusAction} from './types'
+import type {ConnectedAction, UpdateAction, RefreshAction, FocusAction, UnfocusAction, LogAction} from './types'
 
 export function createConnectedAction(payload: ConnectedAction['payload']): ConnectedAction {
   return {
@@ -34,3 +34,10 @@ export function createUnfocusAction(payload: UnfocusAction['payload']): UnfocusA
     payload,
   }
 }
+
+export function createLogAction(payload: LogAction['payload']): LogAction {
+  return {
+    type: 'log',
+    payload,
+  }
+}

package/src/state/actions/types.ts

@@ -23,4 +23,15 @@ export interface UnfocusAction {
   payload: ExtensionServer.InboundEvents['unfocus']
 }
 
-export type ExtensionServerActions = ConnectedAction | UpdateAction | RefreshAction | FocusAction | UnfocusAction
+export interface LogAction {
+  type: 'log'
+  payload: ExtensionServer.InboundEvents['log']
+}
+
+export type ExtensionServerActions =
+  | ConnectedAction
+  | UpdateAction
+  | RefreshAction
+  | FocusAction
+  | UnfocusAction
+  | LogAction

package/src/state/reducers/extensionServerReducer.test.ts

@@ -7,6 +7,7 @@ import {
   createRefreshAction,
   createFocusAction,
   createUnfocusAction,
+  createLogAction,
 } from '../actions'
 
 import type {ExtensionServerState} from './types'
@@ -105,7 +106,7 @@ describe('extensionServerReducer()', () => {
     const state1 = extensionServerReducer(previousState, action)
     // eslint-disable-next-line node/no-unsupported-features/node-builtins
     const url1 = new URL(state1.extensions[0].assets.main.url)
-    const timestamp1 = url1.searchParams.get('lastUpdated') || ''
+    const timestamp1 = url1.searchParams.get('lastUpdated') ?? ''
 
     expect(timestamp1.length).toBeGreaterThan(0)
 
@@ -115,7 +116,7 @@ describe('extensionServerReducer()', () => {
     const state2 = extensionServerReducer(state1, action)
     // eslint-disable-next-line node/no-unsupported-features/node-builtins
     const url2 = new URL(state2.extensions[0].assets.main.url)
-    const timestamp2 = url2.searchParams.get('lastUpdated') || ''
+    const timestamp2 = url2.searchParams.get('lastUpdated') ?? ''
 
     expect(timestamp2.length).toBeGreaterThan(0)
     expect(timestamp1).not.toStrictEqual(timestamp2)
@@ -157,4 +158,17 @@ describe('extensionServerReducer()', () => {
       expect(state.extensions[0].development.focused).toBe(false)
     })
   })
+
+  test('does not mutate the state when receiving log events', () => {
+    const extension = mockExtension()
+    const previousState: ExtensionServerState = {
+      store: 'test-store.com',
+      extensions: [extension],
+    }
+
+    const action = createLogAction({level: 'info', args: ['test'], extensionName: extension.name})
+    const state = extensionServerReducer(previousState, action)
+
+    expect(state).toStrictEqual(previousState)
+  })
 })

package/src/testing/extensions.ts

@@ -29,7 +29,7 @@ export function mockExtension(obj: DeepPartial<ExtensionPayload> = {}): Extensio
         url: `https://secure-link.com/extensions/${uuid}/assets/handle.js?lastUpdated=${lastUpdated}`,
         lastUpdated,
       },
-      ...((obj.assets || {}) as any),
+      ...((obj.assets ?? {}) as any),
     },
     development: {
       hidden: false,
@@ -44,7 +44,7 @@ export function mockExtension(obj: DeepPartial<ExtensionPayload> = {}): Extensio
         name: 'render name',
         version: '1.0.0',
       },
-      ...((obj.development || {}) as any),
+      ...((obj.development ?? {}) as any),
     },
     // this is due to the naive DeepPartial but also more complex ones
     // [see stackoverflow](https://stackoverflow.com/a/68699273) assume that

package/src/types.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-invalid-void-type */
 /* eslint-disable @shopify/strict-component-boundaries */
 import {FlattenedLocalization, Localization} from './i18n'
 import './ExtensionServerClient/types'
@@ -37,6 +38,7 @@ declare global {
       focus: {uuid: string}[]
       unfocus: void
       navigate: {url: string}
+      log: {level: string; args: unknown[]; extensionName: string}
     }
 
     // API responses
@@ -93,6 +95,7 @@ export interface ExtensionPoint {
   localization?: FlattenedLocalization | Localization | null
   name: string
   description?: string
+  assets?: {[name: string]: Asset}
 }
 
 export type ExtensionPoints = string[] | ExtensionPoint[] | null

package/src/utilities/replaceUpdated.ts

@@ -4,6 +4,7 @@ export function replaceUpdated<T>(arr: T[], updates: T[], cb: (v: T) => unknown)
     // eslint-disable-next-line node/callback-return
     const key = cb(item)
     if (updatesMap.has(key)) {
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       const updated = updatesMap.get(key)!
       updatesMap.delete(key)
       return updated

package/src/utilities/set.ts

@@ -16,6 +16,7 @@ export function set<TObject, TValue>(obj: TObject, pathFn: (o: TObject) => TValu
 
   const newObj: TObject = {...obj}
   let current: any = newObj
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
   const lastKey = path.pop()!
 
   for (const key of path) {

package/node_modules/@types/node/LICENSE

@@ -1,21 +0,0 @@
-    MIT License
-
-    Copyright (c) Microsoft Corporation.
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-    SOFTWARE