@nosto/nosto-react 2.0.0 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -0
- package/dist/index.d.ts +172 -27
- package/dist/index.es.js +552 -521
- package/dist/index.umd.js +9 -9
- package/package.json +8 -19
- package/src/components/Nosto404.tsx +17 -3
- package/src/components/NostoCategory.tsx +19 -3
- package/src/components/NostoCheckout.tsx +17 -3
- package/src/components/NostoHome.tsx +17 -3
- package/src/components/NostoOrder.tsx +19 -6
- package/src/components/NostoOther.tsx +17 -3
- package/src/components/NostoPlacement.tsx +5 -3
- package/src/components/NostoProduct.tsx +21 -8
- package/src/components/NostoProvider.tsx +21 -77
- package/src/components/NostoSearch.tsx +19 -3
- package/src/components/NostoSession.tsx +26 -6
- package/src/components/index.ts +11 -11
- package/src/context.ts +2 -2
- package/src/hooks/index.ts +2 -1
- package/src/hooks/scriptLoader.ts +30 -0
- package/src/hooks/useLoadClientScript.ts +84 -0
- package/src/hooks/useNostoApi.ts +2 -2
- package/src/hooks/useNostoContext.ts +1 -7
- package/src/hooks/useRenderCampaigns.tsx +2 -3
- package/src/index.ts +1 -0
- package/src/utils/snakeize.ts +5 -1
- package/src/utils/types.ts +29 -0
package/dist/index.umd.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
(function(E
|
|
1
|
+
(function(m,E){typeof exports=="object"&&typeof module<"u"?E(exports,require("react"),require("react-dom/client")):typeof define=="function"&&define.amd?define(["exports","react","react-dom/client"],E):(m=typeof globalThis<"u"?globalThis:m||self,E(m["@nosto/nosto-react"]={},m.React,m.ReactDOM))})(this,function(m,E,Ge){"use strict";const ue=t=>String(t)==="[object Object]";function le(t){if(!ue(t))return!1;const o=t.constructor;if(o===void 0)return!0;const a=o.prototype;return!(!ue(a)||!a.hasOwnProperty("isPrototypeOf"))}function Z(t,o){if(t===o)return!0;if(t instanceof Date&&o instanceof Date)return t.getTime()===o.getTime();if(t instanceof Array&&o instanceof Array)return t.length!==o.length?!1:t.every((a,c)=>Z(a,o[c]));if(le(t)&&le(o)){const a=Object.entries(t);return a.length!==Object.keys(o).length?!1:a.every(([c,i])=>Z(i,o[c]))}return!1}function fe(t,o){return E.useEffect(t,Ke(o))}function Ke(t){const o=E.useRef(t),a=E.useRef(0);return Z(t,o.current)||(o.current=t,a.current+=1),E.useMemo(()=>o.current,[a.current])}const q=E.createContext({account:"",currentVariation:"",responseMode:"HTML",clientScriptLoaded:!1});function H(){return E.useContext(q)}function A(t,o,a){const{clientScriptLoaded:c,currentVariation:i,responseMode:p}=H();(a!=null&&a.deep?fe:E.useEffect)(()=>{c&&window.nostojs(h=>{h.defaultSession().setVariation(i).setResponseMode(p),t(h)})},[c,i,p,...o??[]])}var Q={exports:{}},M={};/**
|
|
2
2
|
* @license React
|
|
3
3
|
* react-jsx-runtime.production.min.js
|
|
4
4
|
*
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*
|
|
7
7
|
* This source code is licensed under the MIT license found in the
|
|
8
8
|
* LICENSE file in the root directory of this source tree.
|
|
9
|
-
*/var de;function
|
|
9
|
+
*/var de;function $e(){if(de)return M;de=1;var t=E,o=Symbol.for("react.element"),a=Symbol.for("react.fragment"),c=Object.prototype.hasOwnProperty,i=t.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,p={key:!0,ref:!0,__self:!0,__source:!0};function C(h,g,O){var w,f={},S=null,j=null;O!==void 0&&(S=""+O),g.key!==void 0&&(S=""+g.key),g.ref!==void 0&&(j=g.ref);for(w in g)c.call(g,w)&&!p.hasOwnProperty(w)&&(f[w]=g[w]);if(h&&h.defaultProps)for(w in g=h.defaultProps,g)f[w]===void 0&&(f[w]=g[w]);return{$$typeof:o,type:h,key:S,ref:j,props:f,_owner:i.current}}return M.Fragment=a,M.jsx=C,M.jsxs=C,M}var W={};/**
|
|
10
10
|
* @license React
|
|
11
11
|
* react-jsx-runtime.development.js
|
|
12
12
|
*
|
|
@@ -14,12 +14,12 @@
|
|
|
14
14
|
*
|
|
15
15
|
* This source code is licensed under the MIT license found in the
|
|
16
16
|
* LICENSE file in the root directory of this source tree.
|
|
17
|
-
*/var me;function
|
|
18
|
-
`+re+e}}var ne=!1,
|
|
19
|
-
`),
|
|
20
|
-
`),
|
|
21
|
-
`+u[
|
|
17
|
+
*/var me;function Xe(){return me||(me=1,process.env.NODE_ENV!=="production"&&function(){var t=E,o=Symbol.for("react.element"),a=Symbol.for("react.portal"),c=Symbol.for("react.fragment"),i=Symbol.for("react.strict_mode"),p=Symbol.for("react.profiler"),C=Symbol.for("react.provider"),h=Symbol.for("react.context"),g=Symbol.for("react.forward_ref"),O=Symbol.for("react.suspense"),w=Symbol.for("react.suspense_list"),f=Symbol.for("react.memo"),S=Symbol.for("react.lazy"),j=Symbol.for("react.offscreen"),F=Symbol.iterator,B="@@iterator";function z(e){if(e===null||typeof e!="object")return null;var r=F&&e[F]||e[B];return typeof r=="function"?r:null}var T=t.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED;function b(e){{for(var r=arguments.length,n=new Array(r>1?r-1:0),s=1;s<r;s++)n[s-1]=arguments[s];pt("error",e,n)}}function pt(e,r,n){{var s=T.ReactDebugCurrentFrame,d=s.getStackAddendum();d!==""&&(r+="%s",n=n.concat([d]));var v=n.map(function(l){return String(l)});v.unshift("Warning: "+r),Function.prototype.apply.call(console[e],console,v)}}var ht=!1,gt=!1,yt=!1,Rt=!1,Et=!1,Ce;Ce=Symbol.for("react.module.reference");function wt(e){return!!(typeof e=="string"||typeof e=="function"||e===c||e===p||Et||e===i||e===O||e===w||Rt||e===j||ht||gt||yt||typeof e=="object"&&e!==null&&(e.$$typeof===S||e.$$typeof===f||e.$$typeof===C||e.$$typeof===h||e.$$typeof===g||e.$$typeof===Ce||e.getModuleId!==void 0))}function bt(e,r,n){var s=e.displayName;if(s)return s;var d=r.displayName||r.name||"";return d!==""?n+"("+d+")":n}function _e(e){return e.displayName||"Context"}function N(e){if(e==null)return null;if(typeof e.tag=="number"&&b("Received an unexpected object in getComponentNameFromType(). This is likely a bug in React. Please file an issue."),typeof e=="function")return e.displayName||e.name||null;if(typeof e=="string")return e;switch(e){case c:return"Fragment";case a:return"Portal";case p:return"Profiler";case i:return"StrictMode";case O:return"Suspense";case w:return"SuspenseList"}if(typeof e=="object")switch(e.$$typeof){case h:var r=e;return _e(r)+".Consumer";case C:var n=e;return _e(n._context)+".Provider";case g:return bt(e,e.render,"ForwardRef");case f:var s=e.displayName||null;return s!==null?s:N(e.type)||"Memo";case S:{var d=e,v=d._payload,l=d._init;try{return N(l(v))}catch{return null}}}return null}var x=Object.assign,Y=0,Se,Pe,Oe,Te,je,Ne,ke;function Ae(){}Ae.__reactDisabledLog=!0;function Ct(){{if(Y===0){Se=console.log,Pe=console.info,Oe=console.warn,Te=console.error,je=console.group,Ne=console.groupCollapsed,ke=console.groupEnd;var e={configurable:!0,enumerable:!0,value:Ae,writable:!0};Object.defineProperties(console,{info:e,log:e,warn:e,error:e,group:e,groupCollapsed:e,groupEnd:e})}Y++}}function _t(){{if(Y--,Y===0){var e={configurable:!0,enumerable:!0,writable:!0};Object.defineProperties(console,{log:x({},e,{value:Se}),info:x({},e,{value:Pe}),warn:x({},e,{value:Oe}),error:x({},e,{value:Te}),group:x({},e,{value:je}),groupCollapsed:x({},e,{value:Ne}),groupEnd:x({},e,{value:ke})})}Y<0&&b("disabledDepth fell below zero. This is a bug in React. Please file an issue.")}}var te=T.ReactCurrentDispatcher,re;function J(e,r,n){{if(re===void 0)try{throw Error()}catch(d){var s=d.stack.trim().match(/\n( *(at )?)/);re=s&&s[1]||""}return`
|
|
18
|
+
`+re+e}}var ne=!1,G;{var St=typeof WeakMap=="function"?WeakMap:Map;G=new St}function De(e,r){if(!e||ne)return"";{var n=G.get(e);if(n!==void 0)return n}var s;ne=!0;var d=Error.prepareStackTrace;Error.prepareStackTrace=void 0;var v;v=te.current,te.current=null,Ct();try{if(r){var l=function(){throw Error()};if(Object.defineProperty(l.prototype,"props",{set:function(){throw Error()}}),typeof Reflect=="object"&&Reflect.construct){try{Reflect.construct(l,[])}catch(k){s=k}Reflect.construct(e,[],l)}else{try{l.call()}catch(k){s=k}e.call(l.prototype)}}else{try{throw Error()}catch(k){s=k}e()}}catch(k){if(k&&s&&typeof k.stack=="string"){for(var u=k.stack.split(`
|
|
19
|
+
`),_=s.stack.split(`
|
|
20
|
+
`),y=u.length-1,R=_.length-1;y>=1&&R>=0&&u[y]!==_[R];)R--;for(;y>=1&&R>=0;y--,R--)if(u[y]!==_[R]){if(y!==1||R!==1)do if(y--,R--,R<0||u[y]!==_[R]){var P=`
|
|
21
|
+
`+u[y].replace(" at new "," at ");return e.displayName&&P.includes("<anonymous>")&&(P=P.replace("<anonymous>",e.displayName)),typeof e=="function"&&G.set(e,P),P}while(y>=1&&R>=0);break}}}finally{ne=!1,te.current=v,_t(),Error.prepareStackTrace=d}var I=e?e.displayName||e.name:"",Je=I?J(I):"";return typeof e=="function"&&G.set(e,Je),Je}function Pt(e,r,n){return De(e,!1)}function Ot(e){var r=e.prototype;return!!(r&&r.isReactComponent)}function K(e,r,n){if(e==null)return"";if(typeof e=="function")return De(e,Ot(e));if(typeof e=="string")return J(e);switch(e){case O:return J("Suspense");case w:return J("SuspenseList")}if(typeof e=="object")switch(e.$$typeof){case g:return Pt(e.render);case f:return K(e.type,r,n);case S:{var s=e,d=s._payload,v=s._init;try{return K(v(d),r,n)}catch{}}}return""}var $=Object.prototype.hasOwnProperty,xe={},Fe=T.ReactDebugCurrentFrame;function X(e){if(e){var r=e._owner,n=K(e.type,e._source,r?r.type:null);Fe.setExtraStackFrame(n)}else Fe.setExtraStackFrame(null)}function Tt(e,r,n,s,d){{var v=Function.call.bind($);for(var l in e)if(v(e,l)){var u=void 0;try{if(typeof e[l]!="function"){var _=Error((s||"React class")+": "+n+" type `"+l+"` is invalid; it must be a function, usually from the `prop-types` package, but received `"+typeof e[l]+"`.This often happens because of typos such as `PropTypes.function` instead of `PropTypes.func`.");throw _.name="Invariant Violation",_}u=e[l](r,l,s,n,null,"SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED")}catch(y){u=y}u&&!(u instanceof Error)&&(X(d),b("%s: type specification of %s `%s` is invalid; the type checker function must return `null` or an `Error` but returned a %s. You may have forgotten to pass an argument to the type checker creator (arrayOf, instanceOf, objectOf, oneOf, oneOfType, and shape all require an argument).",s||"React class",n,l,typeof u),X(null)),u instanceof Error&&!(u.message in xe)&&(xe[u.message]=!0,X(d),b("Failed %s type: %s",n,u.message),X(null))}}}var jt=Array.isArray;function oe(e){return jt(e)}function Nt(e){{var r=typeof Symbol=="function"&&Symbol.toStringTag,n=r&&e[Symbol.toStringTag]||e.constructor.name||"Object";return n}}function kt(e){try{return Le(e),!1}catch{return!0}}function Le(e){return""+e}function Ie(e){if(kt(e))return b("The provided key is an unsupported type %s. This value must be coerced to a string before before using it here.",Nt(e)),Le(e)}var U=T.ReactCurrentOwner,At={key:!0,ref:!0,__self:!0,__source:!0},Me,We,ae;ae={};function Dt(e){if($.call(e,"ref")){var r=Object.getOwnPropertyDescriptor(e,"ref").get;if(r&&r.isReactWarning)return!1}return e.ref!==void 0}function xt(e){if($.call(e,"key")){var r=Object.getOwnPropertyDescriptor(e,"key").get;if(r&&r.isReactWarning)return!1}return e.key!==void 0}function Ft(e,r){if(typeof e.ref=="string"&&U.current&&r&&U.current.stateNode!==r){var n=N(U.current.type);ae[n]||(b('Component "%s" contains the string ref "%s". Support for string refs will be removed in a future major release. This case cannot be automatically converted to an arrow function. We ask you to manually fix this case by using useRef() or createRef() instead. Learn more about using refs safely here: https://reactjs.org/link/strict-mode-string-ref',N(U.current.type),e.ref),ae[n]=!0)}}function Lt(e,r){{var n=function(){Me||(Me=!0,b("%s: `key` is not a prop. Trying to access it will result in `undefined` being returned. If you need to access the same value within the child component, you should pass it as a different prop. (https://reactjs.org/link/special-props)",r))};n.isReactWarning=!0,Object.defineProperty(e,"key",{get:n,configurable:!0})}}function It(e,r){{var n=function(){We||(We=!0,b("%s: `ref` is not a prop. Trying to access it will result in `undefined` being returned. If you need to access the same value within the child component, you should pass it as a different prop. (https://reactjs.org/link/special-props)",r))};n.isReactWarning=!0,Object.defineProperty(e,"ref",{get:n,configurable:!0})}}var Mt=function(e,r,n,s,d,v,l){var u={$$typeof:o,type:e,key:r,ref:n,props:l,_owner:v};return u._store={},Object.defineProperty(u._store,"validated",{configurable:!1,enumerable:!1,writable:!0,value:!1}),Object.defineProperty(u,"_self",{configurable:!1,enumerable:!1,writable:!1,value:s}),Object.defineProperty(u,"_source",{configurable:!1,enumerable:!1,writable:!1,value:d}),Object.freeze&&(Object.freeze(u.props),Object.freeze(u)),u};function Wt(e,r,n,s,d){{var v,l={},u=null,_=null;n!==void 0&&(Ie(n),u=""+n),xt(r)&&(Ie(r.key),u=""+r.key),Dt(r)&&(_=r.ref,Ft(r,d));for(v in r)$.call(r,v)&&!At.hasOwnProperty(v)&&(l[v]=r[v]);if(e&&e.defaultProps){var y=e.defaultProps;for(v in y)l[v]===void 0&&(l[v]=y[v])}if(u||_){var R=typeof e=="function"?e.displayName||e.name||"Unknown":e;u&&Lt(l,R),_&&It(l,R)}return Mt(e,u,_,d,s,U.current,l)}}var ie=T.ReactCurrentOwner,Ve=T.ReactDebugCurrentFrame;function L(e){if(e){var r=e._owner,n=K(e.type,e._source,r?r.type:null);Ve.setExtraStackFrame(n)}else Ve.setExtraStackFrame(null)}var se;se=!1;function ce(e){return typeof e=="object"&&e!==null&&e.$$typeof===o}function Ye(){{if(ie.current){var e=N(ie.current.type);if(e)return`
|
|
22
22
|
|
|
23
|
-
Check the render method of \``+e+"`."}return""}}function
|
|
23
|
+
Check the render method of \``+e+"`."}return""}}function Vt(e){return""}var Ue={};function Yt(e){{var r=Ye();if(!r){var n=typeof e=="string"?e:e.displayName||e.name;n&&(r=`
|
|
24
24
|
|
|
25
|
-
Check the top-level render call using <`+n+">.")}return
|
|
25
|
+
Check the top-level render call using <`+n+">.")}return r}}function He(e,r){{if(!e._store||e._store.validated||e.key!=null)return;e._store.validated=!0;var n=Yt(r);if(Ue[n])return;Ue[n]=!0;var s="";e&&e._owner&&e._owner!==ie.current&&(s=" It was passed a child from "+N(e._owner.type)+"."),L(e),b('Each child in a list should have a unique "key" prop.%s%s See https://reactjs.org/link/warning-keys for more information.',n,s),L(null)}}function Be(e,r){{if(typeof e!="object")return;if(oe(e))for(var n=0;n<e.length;n++){var s=e[n];ce(s)&&He(s,r)}else if(ce(e))e._store&&(e._store.validated=!0);else if(e){var d=z(e);if(typeof d=="function"&&d!==e.entries)for(var v=d.call(e),l;!(l=v.next()).done;)ce(l.value)&&He(l.value,r)}}}function Ut(e){{var r=e.type;if(r==null||typeof r=="string")return;var n;if(typeof r=="function")n=r.propTypes;else if(typeof r=="object"&&(r.$$typeof===g||r.$$typeof===f))n=r.propTypes;else return;if(n){var s=N(r);Tt(n,e.props,"prop",s,e)}else if(r.PropTypes!==void 0&&!se){se=!0;var d=N(r);b("Component %s declared `PropTypes` instead of `propTypes`. Did you misspell the property assignment?",d||"Unknown")}typeof r.getDefaultProps=="function"&&!r.getDefaultProps.isReactClassApproved&&b("getDefaultProps is only used on classic React.createClass definitions. Use a static property named `defaultProps` instead.")}}function Ht(e){{for(var r=Object.keys(e.props),n=0;n<r.length;n++){var s=r[n];if(s!=="children"&&s!=="key"){L(e),b("Invalid prop `%s` supplied to `React.Fragment`. React.Fragment can only have `key` and `children` props.",s),L(null);break}}e.ref!==null&&(L(e),b("Invalid attribute `ref` supplied to `React.Fragment`."),L(null))}}function ze(e,r,n,s,d,v){{var l=wt(e);if(!l){var u="";(e===void 0||typeof e=="object"&&e!==null&&Object.keys(e).length===0)&&(u+=" You likely forgot to export your component from the file it's defined in, or you might have mixed up default and named imports.");var _=Vt();_?u+=_:u+=Ye();var y;e===null?y="null":oe(e)?y="array":e!==void 0&&e.$$typeof===o?(y="<"+(N(e.type)||"Unknown")+" />",u=" Did you accidentally export a JSX literal instead of a component?"):y=typeof e,b("React.jsx: type is invalid -- expected a string (for built-in components) or a class/function (for composite components) but got: %s.%s",y,u)}var R=Wt(e,r,n,d,v);if(R==null)return R;if(l){var P=r.children;if(P!==void 0)if(s)if(oe(P)){for(var I=0;I<P.length;I++)Be(P[I],e);Object.freeze&&Object.freeze(P)}else b("React.jsx: Static children should always be an array. You are likely explicitly calling React.jsxs or React.jsxDEV. Use the Babel transform instead.");else Be(P,e)}return e===c?Ht(R):Ut(R),R}}function Bt(e,r,n){return ze(e,r,n,!0)}function zt(e,r,n){return ze(e,r,n,!1)}var Jt=zt,Gt=Bt;W.Fragment=c,W.jsx=Jt,W.jsxs=Gt}()),W}process.env.NODE_ENV==="production"?Q.exports=$e():Q.exports=Xe();var ee=Q.exports;function Ze(t){return E.cloneElement(t.recommendationComponent,{nostoRecommendation:t.nostoRecommendation})}function qe(t){if(!window.nostojs)throw new Error("Nosto has not yet been initialized");window.nostojs(o=>{o.placements.injectCampaigns(t.recommendations)})}function D(){const{responseMode:t,recommendationComponent:o}=H(),a=E.useRef({});if(t=="HTML")return{renderCampaigns:qe};function c(i){var C;const p=((C=i.campaigns)==null?void 0:C.recommendations)??{};for(const h in p){const g=p[h],O="#"+h,w=document.querySelector(O);w&&(a.current[h]||(a.current[h]=Ge.createRoot(w)),a.current[h].render(ee.jsx(Ze,{recommendationComponent:o,nostoRecommendation:g})))}}return{renderCampaigns:c}}function Qe(){return typeof window.nosto<"u"}function et(t,o){return new Promise((a,c)=>{const i=document.createElement("script");i.type="text/javascript",i.src=t,i.async=!0,i.onload=()=>a(),i.onerror=()=>c(),Object.entries((o==null?void 0:o.attributes)??{}).forEach(([p,C])=>i.setAttribute(p,C)),(o==null?void 0:o.position)==="head"?document.head.appendChild(i):document.body.appendChild(i)})}function tt(t){const{host:o="connect.nosto.com",scriptLoader:a=et,account:c,shopifyMarkets:i,loadScript:p=!0}=t,[C,h]=E.useState(!1);return E.useEffect(()=>{function g(){var f;"nostoReactTest"in window&&((f=window.nosto)==null||f.reload({site:"localhost"})),h(!0)}async function O(f,S={}){const j=`//${o}${f}`,F={"nosto-client-script":"",...S};await a(j,{attributes:F}),g()}function w(){var B,z;const f=document.querySelector("[nosto-client-script]"),S=String((i==null?void 0:i.marketId)||""),j=(i==null?void 0:i.language)||"",F=(f==null?void 0:f.getAttribute("nosto-language"))!==j||(f==null?void 0:f.getAttribute("nosto-market-id"))!==S;if(!f||F){C&&h(!1);const T=document.querySelector("#nosto-sandbox");(B=f==null?void 0:f.parentNode)==null||B.removeChild(f),(z=T==null?void 0:T.parentNode)==null||z.removeChild(T);const b=`/script/shopify/market/nosto.js?merchant=${c}&market=${S}&locale=${j.toLowerCase()}`;O(b,{"nosto-language":j,"nosto-market-id":S})}}if(window.nostojs||(window.nostojs=f=>{(window.nostojs.q=window.nostojs.q||[]).push(f)},window.nostojs(f=>f.setAutoLoad(!1))),!p){window.nosto?g():window.nostojs(g);return}if(!Qe()&&!i){const f=`/include/${c}`;O(f)}i&&w()},[i==null?void 0:i.marketId,i==null?void 0:i.language]),{clientScriptLoaded:C}}function rt(t){return ve(t),null}function ve(t){const{renderCampaigns:o}=D();A(async a=>{const c=await a.defaultSession().viewNotFound().setPlacements((t==null?void 0:t.placements)||a.placements.getPlacements()).load();o(c)})}function nt(t){return pe(t),null}function pe(t){const{renderCampaigns:o}=D();A(async a=>{const c=await a.defaultSession().viewOther().setPlacements((t==null?void 0:t.placements)||a.placements.getPlacements()).load();o(c)})}function ot(t){return he(t),null}function he(t){const{renderCampaigns:o}=D();A(async a=>{const c=await a.defaultSession().viewCart().setPlacements((t==null?void 0:t.placements)||a.placements.getPlacements()).load();o(c)})}function at(t){return ge(t),null}function ge({product:t,tagging:o,placements:a}){const{renderCampaigns:c}=D();A(async i=>{const p=await i.defaultSession().viewProduct(o??t).setPlacements(a||i.placements.getPlacements()).load();c(p)},[t,o==null?void 0:o.selected_sku_id])}function it(t){return ye(t),null}function ye({category:t,placements:o}){const{renderCampaigns:a}=D();A(async c=>{const i=await c.defaultSession().viewCategory(t).setPlacements(o||c.placements.getPlacements()).load();a(i)},[t])}function st(t){return Re(t),null}function Re({query:t,placements:o}){const{renderCampaigns:a}=D();A(async c=>{const i=await c.defaultSession().viewSearch(t).setPlacements(o||c.placements.getPlacements()).load();a(i)},[t])}function V(t){return!t||typeof t!="object"||ct(t)||ut(t)?t:Array.isArray(t)?t.map(V):Object.keys(t).reduce((o,a)=>{const c=a[0].toLowerCase()+a.slice(1).replace(/([A-Z]+)/g,(i,p)=>"_"+p.toLowerCase());return o[c]=V(t[a]),o},{})}function ct(t){return Object.prototype.toString.call(t)==="[object Date]"}function ut(t){return Object.prototype.toString.call(t)==="[object RegExp]"}function lt(t){return Ee(t),null}function Ee({order:t,placements:o}){const{renderCampaigns:a}=D();A(async c=>{const i=await c.defaultSession().addOrder(V(t)).setPlacements(o||c.placements.getPlacements()).load();a(i)},[t],{deep:!0})}function ft(t){return we(t),null}function we(t){const{renderCampaigns:o}=D();A(async a=>{const c=await a.defaultSession().viewFrontPage().setPlacements((t==null?void 0:t.placements)||a.placements.getPlacements()).load();o(c)})}function dt({id:t,pageType:o}){return ee.jsx("div",{className:"nosto_element",id:t},t+(o||""))}function mt(t){const{account:o,multiCurrency:a=!1,children:c,recommendationComponent:i}=t,p=a?t.currentVariation:"";if(i&&!E.isValidElement(i))throw new Error("The recommendationComponent prop must be a valid React element. Please provide a valid React element.");const C=i?"JSON_ORIGINAL":"HTML",{clientScriptLoaded:h}=tt(t);return ee.jsx(q.Provider,{value:{account:o,clientScriptLoaded:h,currentVariation:p,responseMode:C,recommendationComponent:i},children:c})}function vt(t){return be(t),null}function be({cart:t,customer:o}={}){const{clientScriptLoaded:a}=H();fe(()=>{const c=t?V(t):void 0,i=o?V(o):void 0;a&&window.nostojs(p=>{p.defaultSession().setResponseMode("HTML").setCart(c).setCustomer(i).viewOther().load({skipPageViews:!0})})},[a,t,o])}m.Nosto404=rt,m.NostoCategory=it,m.NostoCheckout=ot,m.NostoContext=q,m.NostoHome=ft,m.NostoOrder=lt,m.NostoOther=nt,m.NostoPlacement=dt,m.NostoProduct=at,m.NostoProvider=mt,m.NostoSearch=st,m.NostoSession=vt,m.useNosto404=ve,m.useNostoCategory=ye,m.useNostoCheckout=he,m.useNostoContext=H,m.useNostoHome=we,m.useNostoOrder=Ee,m.useNostoOther=pe,m.useNostoProduct=ge,m.useNostoSearch=Re,m.useNostoSession=be,Object.defineProperty(m,Symbol.toStringTag,{value:"Module"})});
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nosto/nosto-react",
|
|
3
3
|
"description": "Component library to simply implementing Nosto on React.",
|
|
4
|
-
"version": "2.
|
|
4
|
+
"version": "2.2.0",
|
|
5
5
|
"author": "Mridang Agarwalla, Dominik Gilg",
|
|
6
6
|
"license": "ISC",
|
|
7
7
|
"repository": {
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"clean": "rimraf dist",
|
|
23
23
|
"prettier": "prettier '{src,spec}/**' --list-different",
|
|
24
24
|
"prettier:fix": "prettier '{src,spec}/**' --write",
|
|
25
|
-
"test": "
|
|
25
|
+
"test": "vitest run --silent",
|
|
26
26
|
"typedoc": "typedoc src/index.ts"
|
|
27
27
|
},
|
|
28
28
|
"files": [
|
|
@@ -30,32 +30,29 @@
|
|
|
30
30
|
"src"
|
|
31
31
|
],
|
|
32
32
|
"devDependencies": {
|
|
33
|
-
"@testing-library/jest-dom": "^
|
|
34
|
-
"@testing-library/react": "^
|
|
33
|
+
"@testing-library/jest-dom": "^6.4.8",
|
|
34
|
+
"@testing-library/react": "^16.0.0",
|
|
35
35
|
"@testing-library/user-event": "^14.4.3",
|
|
36
|
-
"@types/jest": "^29.5.0",
|
|
37
36
|
"@types/react": "^18.0.0",
|
|
38
37
|
"@types/react-dom": "^18.0.0",
|
|
39
38
|
"@types/user-event": "^4.1.1",
|
|
40
39
|
"@typescript-eslint/eslint-plugin": "^6.11.0",
|
|
41
40
|
"@typescript-eslint/parser": "^6.11.0",
|
|
42
|
-
"@vitejs/plugin-react": "^
|
|
41
|
+
"@vitejs/plugin-react": "^4.3.1",
|
|
43
42
|
"eslint": "^8.53.0",
|
|
44
43
|
"eslint-plugin-promise": "^6.1.1",
|
|
45
44
|
"eslint-plugin-react": "^7.33.2",
|
|
46
|
-
"jest": "^29.5.0",
|
|
47
|
-
"jest-environment-jsdom": "^29.5.0",
|
|
48
45
|
"prettier": "^2.0.5",
|
|
49
46
|
"react": "*",
|
|
50
47
|
"react-dom": "*",
|
|
51
48
|
"react-router": "^6.25.1",
|
|
52
49
|
"react-router-dom": "^6.25.1",
|
|
53
50
|
"rimraf": "^3.0.2",
|
|
54
|
-
"ts-jest": "^29.1.0",
|
|
55
51
|
"typedoc": "^0.24.1",
|
|
56
52
|
"typescript": "^4.6.3",
|
|
57
53
|
"vite": "^5.2.10",
|
|
58
|
-
"vite-plugin-dts": "^3.9.1"
|
|
54
|
+
"vite-plugin-dts": "^3.9.1",
|
|
55
|
+
"vitest": "^2.0.5"
|
|
59
56
|
},
|
|
60
57
|
"main": "./dist/index.umd.js",
|
|
61
58
|
"module": "./dist/index.es.js",
|
|
@@ -70,13 +67,5 @@
|
|
|
70
67
|
"bugs": {
|
|
71
68
|
"url": "https://github.com/Nosto/nosto-react/issues"
|
|
72
69
|
},
|
|
73
|
-
"homepage": "https://github.com/Nosto/nosto-react#readme"
|
|
74
|
-
"jest": {
|
|
75
|
-
"preset": "ts-jest",
|
|
76
|
-
"testEnvironment": "jsdom",
|
|
77
|
-
"testEnvironmentOptions": {
|
|
78
|
-
"resources": "usable",
|
|
79
|
-
"runScripts": "dangerously"
|
|
80
|
-
}
|
|
81
|
-
}
|
|
70
|
+
"homepage": "https://github.com/Nosto/nosto-react#readme"
|
|
82
71
|
}
|
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
import { useNostoApi, useRenderCampaigns } from "../hooks"
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* @group Components
|
|
5
|
+
*/
|
|
6
|
+
export type Nosto404Props = { placements?: string[] }
|
|
7
|
+
|
|
3
8
|
/**
|
|
4
9
|
* You can personalise your cart and checkout pages by using the `Nosto404` component.
|
|
5
10
|
* The component does not require any props.
|
|
@@ -20,16 +25,25 @@ import { useNostoApi, useRenderCampaigns } from "../hooks"
|
|
|
20
25
|
*
|
|
21
26
|
* @group Components
|
|
22
27
|
*/
|
|
23
|
-
export default function Nosto404(props:
|
|
28
|
+
export default function Nosto404(props: Nosto404Props) {
|
|
29
|
+
useNosto404(props)
|
|
30
|
+
return null
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* You can personalise your cart and checkout pages by using the `useNosto404` hook.
|
|
35
|
+
*
|
|
36
|
+
* @group Hooks
|
|
37
|
+
*/
|
|
38
|
+
export function useNosto404(props?: Nosto404Props) {
|
|
24
39
|
const { renderCampaigns } = useRenderCampaigns()
|
|
25
40
|
|
|
26
41
|
useNostoApi(
|
|
27
42
|
async (api) => {
|
|
28
43
|
const data = await api.defaultSession()
|
|
29
44
|
.viewNotFound()
|
|
30
|
-
.setPlacements(props
|
|
45
|
+
.setPlacements(props?.placements || api.placements.getPlacements())
|
|
31
46
|
.load()
|
|
32
47
|
renderCampaigns(data)
|
|
33
48
|
})
|
|
34
|
-
return null
|
|
35
49
|
}
|
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
import { useNostoApi, useRenderCampaigns } from "../hooks"
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* @group Components
|
|
5
|
+
*/
|
|
6
|
+
export type NostoCategoryProps = {
|
|
7
|
+
category: string
|
|
8
|
+
placements?: string[]
|
|
9
|
+
}
|
|
10
|
+
|
|
3
11
|
/**
|
|
4
12
|
* You can personalise your category and collection pages by using the NostoCategory component.
|
|
5
13
|
* The component requires that you provide it the the slash-delimited slug representation of the current category.
|
|
@@ -22,8 +30,17 @@ import { useNostoApi, useRenderCampaigns } from "../hooks"
|
|
|
22
30
|
*
|
|
23
31
|
* @group Components
|
|
24
32
|
*/
|
|
25
|
-
export default function NostoCategory(props:
|
|
26
|
-
|
|
33
|
+
export default function NostoCategory(props: NostoCategoryProps) {
|
|
34
|
+
useNostoCategory(props)
|
|
35
|
+
return null
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* You can personalise your category and collection pages by using the useNostoCategory hook.
|
|
40
|
+
*
|
|
41
|
+
* @group Hooks
|
|
42
|
+
*/
|
|
43
|
+
export function useNostoCategory({ category, placements }: NostoCategoryProps) {
|
|
27
44
|
const { renderCampaigns } = useRenderCampaigns()
|
|
28
45
|
|
|
29
46
|
useNostoApi(
|
|
@@ -36,5 +53,4 @@ export default function NostoCategory(props: { category: string; placements?: st
|
|
|
36
53
|
},
|
|
37
54
|
[category]
|
|
38
55
|
)
|
|
39
|
-
return null
|
|
40
56
|
}
|
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
import { useNostoApi, useRenderCampaigns } from "../hooks"
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* @group Components
|
|
5
|
+
*/
|
|
6
|
+
export type NostoCheckoutProps = { placements?: string[] }
|
|
7
|
+
|
|
3
8
|
/**
|
|
4
9
|
* You can personalise your cart and checkout pages by using the NostoCheckout component.
|
|
5
10
|
* The component does not require any props.
|
|
@@ -19,16 +24,25 @@ import { useNostoApi, useRenderCampaigns } from "../hooks"
|
|
|
19
24
|
*
|
|
20
25
|
* @group Components
|
|
21
26
|
*/
|
|
22
|
-
export default function NostoCheckout(props:
|
|
27
|
+
export default function NostoCheckout(props: NostoCheckoutProps) {
|
|
28
|
+
useNostoCheckout(props)
|
|
29
|
+
return null
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* You can personalise your cart and checkout pages by using the useNostoCheckout hook.
|
|
34
|
+
*
|
|
35
|
+
* @group Hooks
|
|
36
|
+
*/
|
|
37
|
+
export function useNostoCheckout(props?: NostoCheckoutProps) {
|
|
23
38
|
const { renderCampaigns } = useRenderCampaigns()
|
|
24
39
|
|
|
25
40
|
useNostoApi(
|
|
26
41
|
async (api) => {
|
|
27
42
|
const data = await api.defaultSession()
|
|
28
43
|
.viewCart()
|
|
29
|
-
.setPlacements(props
|
|
44
|
+
.setPlacements(props?.placements || api.placements.getPlacements())
|
|
30
45
|
.load()
|
|
31
46
|
renderCampaigns(data)
|
|
32
47
|
})
|
|
33
|
-
return null
|
|
34
48
|
}
|
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
import { useRenderCampaigns, useNostoApi } from "../hooks"
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* @group Components
|
|
5
|
+
*/
|
|
6
|
+
export type NostoHomeProps = { placements?: string[] }
|
|
7
|
+
|
|
3
8
|
/**
|
|
4
9
|
* The `NostoHome` component must be used to personalise the home page. The component does not require any props.
|
|
5
10
|
*
|
|
@@ -23,17 +28,26 @@ import { useRenderCampaigns, useNostoApi } from "../hooks"
|
|
|
23
28
|
*
|
|
24
29
|
* @group Components
|
|
25
30
|
*/
|
|
26
|
-
export default function NostoHome(props:
|
|
31
|
+
export default function NostoHome(props: NostoHomeProps) {
|
|
32
|
+
useNostoHome(props)
|
|
33
|
+
return null
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* You can personalise your home page by using the useNostoHome hook.
|
|
38
|
+
*
|
|
39
|
+
* @group Hooks
|
|
40
|
+
*/
|
|
41
|
+
export function useNostoHome(props?: NostoHomeProps) {
|
|
27
42
|
const { renderCampaigns } = useRenderCampaigns()
|
|
28
43
|
|
|
29
44
|
useNostoApi(
|
|
30
45
|
async (api) => {
|
|
31
46
|
const data = await api.defaultSession()
|
|
32
47
|
.viewFrontPage()
|
|
33
|
-
.setPlacements(props
|
|
48
|
+
.setPlacements(props?.placements || api.placements.getPlacements())
|
|
34
49
|
.load()
|
|
35
50
|
renderCampaigns(data)
|
|
36
51
|
}
|
|
37
52
|
)
|
|
38
|
-
return null
|
|
39
53
|
}
|
|
@@ -2,6 +2,14 @@ import { Order } from "../types"
|
|
|
2
2
|
import { useRenderCampaigns, useNostoApi } from "../hooks"
|
|
3
3
|
import { snakeize } from "../utils/snakeize"
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* @group Components
|
|
7
|
+
*/
|
|
8
|
+
export type NostoOrderProps = {
|
|
9
|
+
order: Order
|
|
10
|
+
placements?: string[]
|
|
11
|
+
}
|
|
12
|
+
|
|
5
13
|
/**
|
|
6
14
|
* You can personalise your order-confirmation/thank-you page by using the `NostoOrder` component.
|
|
7
15
|
* The component requires that you provide it with the details of the order.
|
|
@@ -21,11 +29,17 @@ import { snakeize } from "../utils/snakeize"
|
|
|
21
29
|
*
|
|
22
30
|
* @group Components
|
|
23
31
|
*/
|
|
24
|
-
export default function NostoOrder(props: {
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
}
|
|
28
|
-
|
|
32
|
+
export default function NostoOrder(props: NostoOrderProps) {
|
|
33
|
+
useNostoOrder(props)
|
|
34
|
+
return null
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* You can personalise your order-confirmation/thank-you page by using the `useNostoOrder` hook.
|
|
39
|
+
*
|
|
40
|
+
* @group Hooks
|
|
41
|
+
*/
|
|
42
|
+
export function useNostoOrder({ order, placements }: NostoOrderProps) {
|
|
29
43
|
const { renderCampaigns } = useRenderCampaigns()
|
|
30
44
|
|
|
31
45
|
useNostoApi(
|
|
@@ -39,5 +53,4 @@ export default function NostoOrder(props: {
|
|
|
39
53
|
[order],
|
|
40
54
|
{ deep: true }
|
|
41
55
|
)
|
|
42
|
-
return null
|
|
43
56
|
}
|
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
import { useRenderCampaigns, useNostoApi } from "../hooks"
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* @group Components
|
|
5
|
+
*/
|
|
6
|
+
export type NostoOtherProps = { placements?: string[] }
|
|
7
|
+
|
|
3
8
|
/**
|
|
4
9
|
* You can personalise your miscellaneous pages by using the NostoOther component.
|
|
5
10
|
* The component does not require any props.
|
|
@@ -19,16 +24,25 @@ import { useRenderCampaigns, useNostoApi } from "../hooks"
|
|
|
19
24
|
*
|
|
20
25
|
* @group Components
|
|
21
26
|
*/
|
|
22
|
-
export default function NostoOther(props:
|
|
27
|
+
export default function NostoOther(props: NostoOtherProps) {
|
|
28
|
+
useNostoOther(props)
|
|
29
|
+
return null
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* You can personalise your miscellaneous pages by using the useNostoOther hook.
|
|
34
|
+
*
|
|
35
|
+
* @group Hooks
|
|
36
|
+
*/
|
|
37
|
+
export function useNostoOther(props?: NostoOtherProps) {
|
|
23
38
|
const { renderCampaigns } = useRenderCampaigns()
|
|
24
39
|
|
|
25
40
|
useNostoApi(
|
|
26
41
|
async (api) => {
|
|
27
42
|
const data = await api.defaultSession()
|
|
28
43
|
.viewOther()
|
|
29
|
-
.setPlacements(props
|
|
44
|
+
.setPlacements(props?.placements || api.placements.getPlacements())
|
|
30
45
|
.load()
|
|
31
46
|
renderCampaigns(data)
|
|
32
47
|
})
|
|
33
|
-
return null
|
|
34
48
|
}
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @group Components
|
|
3
|
+
*/
|
|
4
|
+
export type NostoPlacementProps = { id: string; pageType?: string }
|
|
2
5
|
|
|
3
6
|
/**
|
|
4
7
|
* Nosto React has a special component called NostoPlacement.
|
|
@@ -13,7 +16,6 @@ import React from "react"
|
|
|
13
16
|
*
|
|
14
17
|
* @group Components
|
|
15
18
|
*/
|
|
16
|
-
export default function NostoPlacement(
|
|
17
|
-
const { id, pageType } = props
|
|
19
|
+
export default function NostoPlacement({ id, pageType }: NostoPlacementProps) {
|
|
18
20
|
return <div className="nosto_element" id={id} key={id + (pageType || "")} />
|
|
19
21
|
}
|
|
@@ -1,6 +1,15 @@
|
|
|
1
1
|
import { useRenderCampaigns, useNostoApi } from "../hooks"
|
|
2
2
|
import { Product } from "../types"
|
|
3
3
|
|
|
4
|
+
/**
|
|
5
|
+
* @group Components
|
|
6
|
+
*/
|
|
7
|
+
export type NostoProductProps = {
|
|
8
|
+
product: string
|
|
9
|
+
tagging?: Product
|
|
10
|
+
placements?: string[]
|
|
11
|
+
}
|
|
12
|
+
|
|
4
13
|
/**
|
|
5
14
|
* The NostoProduct component must be used to personalise the product page.
|
|
6
15
|
* The component requires that you provide it the identifier of the current product being viewed.
|
|
@@ -25,12 +34,17 @@ import { Product } from "../types"
|
|
|
25
34
|
*
|
|
26
35
|
* @group Components
|
|
27
36
|
*/
|
|
28
|
-
export default function NostoProduct(props: {
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
37
|
+
export default function NostoProduct(props: NostoProductProps) {
|
|
38
|
+
useNostoProduct(props)
|
|
39
|
+
return null
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* You can personalise your product pages by using the useNostoProduct hook.
|
|
44
|
+
*
|
|
45
|
+
* @group Hooks
|
|
46
|
+
*/
|
|
47
|
+
export function useNostoProduct({ product, tagging, placements }: NostoProductProps) {
|
|
34
48
|
const { renderCampaigns } = useRenderCampaigns()
|
|
35
49
|
|
|
36
50
|
useNostoApi(
|
|
@@ -43,5 +57,4 @@ export default function NostoProduct(props: {
|
|
|
43
57
|
},
|
|
44
58
|
[product, tagging?.selected_sku_id]
|
|
45
59
|
)
|
|
46
|
-
|
|
47
|
-
}
|
|
60
|
+
}
|