@dialstack/sdk-react 3.7.0 → 3.9.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.
Files changed (53) hide show
  1. package/dist/ai-agent.cjs +1 -1
  2. package/dist/ai-agent.cjs.map +1 -1
  3. package/dist/ai-agent.d.cts +4 -4
  4. package/dist/ai-agent.d.ts +4 -4
  5. package/dist/ai-agent.mjs +1 -1
  6. package/dist/ai-agent.mjs.map +1 -1
  7. package/dist/call-history.cjs +1 -1
  8. package/dist/call-history.cjs.map +1 -1
  9. package/dist/call-history.mjs +1 -1
  10. package/dist/call-history.mjs.map +1 -1
  11. package/dist/call-logs.cjs +1 -1
  12. package/dist/call-logs.cjs.map +1 -1
  13. package/dist/call-logs.d.cts +15 -1
  14. package/dist/call-logs.d.ts +15 -1
  15. package/dist/call-logs.mjs +1 -1
  16. package/dist/call-logs.mjs.map +1 -1
  17. package/dist/dial-plan.cjs +1 -1
  18. package/dist/dial-plan.cjs.map +1 -1
  19. package/dist/dial-plan.mjs +1 -1
  20. package/dist/dial-plan.mjs.map +1 -1
  21. package/dist/index.cjs +1 -1
  22. package/dist/index.cjs.map +1 -1
  23. package/dist/index.d.cts +37 -3
  24. package/dist/index.d.ts +37 -3
  25. package/dist/index.mjs +1 -1
  26. package/dist/index.mjs.map +1 -1
  27. package/dist/onboarding.cjs +1 -1
  28. package/dist/onboarding.cjs.map +1 -1
  29. package/dist/onboarding.mjs +1 -1
  30. package/dist/onboarding.mjs.map +1 -1
  31. package/dist/phone-number-ordering.cjs +1 -1
  32. package/dist/phone-number-ordering.cjs.map +1 -1
  33. package/dist/phone-number-ordering.d.cts +11 -5
  34. package/dist/phone-number-ordering.d.ts +11 -5
  35. package/dist/phone-number-ordering.mjs +1 -1
  36. package/dist/phone-number-ordering.mjs.map +1 -1
  37. package/dist/phone-numbers.cjs +1 -1
  38. package/dist/phone-numbers.cjs.map +1 -1
  39. package/dist/phone-numbers.mjs +1 -1
  40. package/dist/phone-numbers.mjs.map +1 -1
  41. package/dist/softphone.cjs +1 -1
  42. package/dist/softphone.cjs.map +1 -1
  43. package/dist/softphone.d.cts +102 -25
  44. package/dist/softphone.d.ts +102 -25
  45. package/dist/softphone.mjs +1 -1
  46. package/dist/softphone.mjs.map +1 -1
  47. package/dist/voicemails.cjs +1 -1
  48. package/dist/voicemails.cjs.map +1 -1
  49. package/dist/voicemails.d.cts +4 -0
  50. package/dist/voicemails.d.ts +4 -0
  51. package/dist/voicemails.mjs +1 -1
  52. package/dist/voicemails.mjs.map +1 -1
  53. package/package.json +3 -3
package/dist/index.cjs CHANGED
@@ -1,2 +1,2 @@
1
- "use strict";var e=require("react");const t=e.createContext(null),r=()=>{const r=e.useContext(t);if(!r)throw new Error("Could not find DialStack context; You need to wrap your app in a <DialstackComponentsProvider> provider. See https://docs.dialstack.ai/sdk/react for setup instructions.");return r};exports.DialstackComponentsContext=t,exports.DialstackComponentsProvider=({dialstack:r,children:n})=>{const a={dialstack:r};return e.createElement(t.Provider,{value:a},n)},exports.useAppearance=function(t){const[r,n]=e.useState(()=>t.getAppearance());return e.useEffect(()=>{if("undefined"==typeof document)return;const e=document.createElement("div"),r=e=>{const t=e.detail;n(null==t?void 0:t.appearance)};return e.addEventListener("dialstack-appearance-update",r),t.addAppearanceTarget(e),()=>{t.removeAppearanceTarget(e),e.removeEventListener("dialstack-appearance-update",r)}},[t]),r},exports.useCreateComponent=function(t,r){const n=e.useRef(null),[a,o]=e.useState(null);return{containerRef:e.useCallback(e=>{if(n.current&&n.current.parentNode&&(n.current.parentNode.removeChild(n.current),n.current=null,o(null)),!e)return;const a=t.create(r);try{!function(e,t){if(!e||"function"!=typeof e.setInstance)throw new Error(`<dialstack-${t}> was created but is not a registered custom element, so it would render nothing. Install @dialstack/sdk-js alongside @dialstack/sdk-react and import it once at your entry point — importing it is what registers the elements. On @dialstack/sdk-js/pure nothing registers on import: await registerComponents() before rendering. If it is installed, check that your bundler is not dropping its side effects.`)}(a,r)}catch(e){throw t.removeAppearanceTarget(a),e}try{a.setAttribute("data-dialstack-sdk-version","3.7.0")}catch(e){console.log("Error setting SDK version attribute:",e)}e.appendChild(a),n.current=a,o(a)},[t,r]),componentInstance:a}},exports.useDialstack=()=>{const{dialstack:e}=r();return e},exports.useDialstackComponents=r,exports.useUpdateWithSetter=function(t,r,n){e.useEffect(()=>{if(t&&void 0!==r)try{n(t,r)}catch(e){console.error("DialStack: Error calling setter:",e)}},[t,r,n])};
1
+ "use strict";var e=require("react");const t=e.createContext(null),n=()=>{const n=e.useContext(t);if(!n)throw new Error("Could not find DialStack context; You need to wrap your app in a <DialstackComponentsProvider> provider. See https://docs.dialstack.ai/sdks/setup for setup instructions.");return n};function r(e,t,n,r,o=!1){if(!t)return;const a=e.current,s=null!==a&&a.component===t;if(void 0===n){if(!o||!s||void 0===a.value)return}else if(s&&Object.is(a.value,n))return;e.current={component:t,value:n};try{r(t,n)}catch(e){console.error("DialStack: Error calling setter:",e)}}exports.DialstackComponentsContext=t,exports.DialstackComponentsProvider=({dialstack:n,children:r})=>{var o;null===(o=null==n?void 0:n.registerClientPackage)||void 0===o||o.call(n,"sdk-react","3.9.0");const a={dialstack:n};return e.createElement(t.Provider,{value:a},r)},exports.useAppearance=function(t){const[n,r]=e.useState(()=>t.getAppearance());return e.useEffect(()=>{if("undefined"==typeof document)return;const e=document.createElement("div"),n=e=>{const t=e.detail;r(null==t?void 0:t.appearance)};return e.addEventListener("dialstack-appearance-update",n),t.addAppearanceTarget(e),()=>{t.removeAppearanceTarget(e),e.removeEventListener("dialstack-appearance-update",n)}},[t]),n},exports.useCreateComponent=function(t,n,r){const o=e.useRef(null),a=e.useRef(r);e.useLayoutEffect(()=>{a.current=r});const[s,c]=e.useState(null);return{containerRef:e.useCallback(e=>{var r;if(o.current&&o.current.parentNode&&(o.current.parentNode.removeChild(o.current),o.current=null,c(null)),!e)return;const s=t.create(n);try{!function(e,t){if(!e||"function"!=typeof e.setInstance)throw new Error(`<dialstack-${t}> was created but is not a registered custom element, so it would render nothing. Install @dialstack/sdk-js alongside @dialstack/sdk-react and import it once at your entry point — importing it is what registers the elements. On @dialstack/sdk-js/pure nothing registers on import: await registerComponents() before rendering. If it is installed, check that your bundler is not dropping its side effects.`)}(s,n)}catch(e){throw t.removeAppearanceTarget(s),e}null===(r=a.current)||void 0===r||r.call(a,s),e.appendChild(s),o.current=s,c(s)},[t,n]),componentInstance:s}},exports.useDialstack=()=>{const{dialstack:e}=n();return e},exports.useDialstackComponents=n,exports.useReportComponent=function(n){var r,o,a;null===(a=null===(o=null===(r=e.useContext(t))||void 0===r?void 0:r.dialstack)||void 0===o?void 0:o.registerClientComponent)||void 0===a||a.call(o,"sdk-react",n)},exports.useUpdateHandlerWithSetter=function(t,n,o){const a=e.useRef(null);e.useEffect(()=>r(a,t,n,o,!0))},exports.useUpdateWithSetter=function(t,n,o){const a=e.useRef(null);e.useEffect(()=>r(a,t,n,o))};
2
2
  //# sourceMappingURL=index.cjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs","sources":["../src/react/DialstackComponentsProvider.tsx","../src/react/useAppearance.ts","../src/react/useCreateComponent.tsx","../src/react/version.ts","../src/react/useUpdateWithSetter.ts"],"sourcesContent":[null,null,null,null,null],"names":["DialstackComponentsContext","createContext","useDialstackComponents","context","useContext","Error","DialstackComponentsProvider","dialstack","children","value","React","createElement","Provider","appearance","setAppearance","useState","getAppearance","useEffect","document","target","handler","event","detail","addEventListener","addAppearanceTarget","removeAppearanceTarget","removeEventListener","tagName","componentRef","useRef","componentInstance","setComponentInstance","containerRef","useCallback","container","current","parentNode","removeChild","component","create","element","setInstance","assertUpgraded","err","setAttribute","e","console","log","appendChild","useDialstack","onUpdated","undefined","error"],"mappings":"oCAmBA,MAAMA,EAA6BC,EAAAA,cAAsD,MAsD5EC,EAAyBA,KACpC,MAAMC,EAAUC,EAAAA,WAAWJ,GAC3B,IAAKG,EACH,MAAM,IAAIE,MACR,4KAIJ,OAAOF,4EA5B8EG,EACrFC,YACAC,eAEA,MAAMC,EAAyC,CAC7CF,aAGF,OACEG,EAAAC,cAACX,EAA2BY,SAAQ,CAACH,MAAOA,GACzCD,0BC9CD,SAAwBD,GAC5B,MAAOM,EAAYC,GAAiBC,EAAAA,SAAwC,IAC1ER,EAAUS,iBAqBZ,OAlBAC,EAAAA,UAAU,KACR,GAAwB,oBAAbC,SAA0B,OAErC,MAAMC,EAASD,SAASP,cAAc,OAChCS,EAAWC,IACf,MAAMC,EAAUD,EAAqEC,OACrFR,EAAcQ,eAAAA,EAAQT,aAMxB,OAJAM,EAAOI,iBAAiB,8BAA+BH,GAEvDb,EAAUiB,oBAAoBL,GAEvB,KACLZ,EAAUkB,uBAAuBN,GACjCA,EAAOO,oBAAoB,8BAA+BN,KAE3D,CAACb,IAEGM,CACT,6BC2BM,SACJN,EACAoB,GAEA,MAAMC,EAAeC,EAAAA,OAAmC,OAEjDC,EAAmBC,GAAwBhB,EAAAA,SAAqC,MA0CvF,MAAO,CACLiB,aAxCmBC,EAAAA,YAClBC,IAQC,GANIN,EAAaO,SAAWP,EAAaO,QAAQC,aAC/CR,EAAaO,QAAQC,WAAWC,YAAYT,EAAaO,SACzDP,EAAaO,QAAU,KACvBJ,EAAqB,QAGlBG,EAAW,OAGhB,MAAMI,EAAY/B,EAAUgC,OAAOZ,GACnC,KAvDN,SAAwBa,EAAkBb,GACxC,IAAIa,GAAyE,mBAAtDA,EAAsCC,YAG7D,MAAM,IAAIpC,MACR,cAAcsB,sZAOlB,CA4CQe,CAAeJ,EAAWX,EAC5B,CAAE,MAAOgB,GAMP,MADApC,EAAUkB,uBAAuBa,GAC3BK,CACR,CAGA,IACEL,EAAUM,aAAa,6BCrGA,QDsGzB,CAAE,MAAOC,GACPC,QAAQC,IAAI,uCAAwCF,EACtD,CAGAX,EAAUc,YAAYV,GACtBV,EAAaO,QAAUG,EACvBP,EAAqBO,IAEvB,CAAC/B,EAAWoB,IAKZG,oBAEJ,uBF/B4BmB,KAC1B,MAAM1C,UAAEA,GAAcL,IACtB,OAAOK,yEIrDP+B,EACA7B,EACAyC,GAEAjC,EAAAA,UAAU,KACR,GAAKqB,QAAuBa,IAAV1C,EAElB,IACEyC,EAAUZ,EAAW7B,EACvB,CAAE,MAAO2C,GACPN,QAAQM,MAAM,mCAAoCA,EACpD,GACC,CAACd,EAAW7B,EAAOyC,GACxB"}
1
+ {"version":3,"file":"index.cjs","sources":["../src/react/version.ts","../src/react/DialstackComponentsProvider.tsx","../src/react/useUpdateWithSetter.ts","../src/react/useAppearance.ts","../src/react/useCreateComponent.tsx"],"sourcesContent":[null,null,null,null,null],"names":["DialstackComponentsContext","createContext","useDialstackComponents","context","useContext","Error","applyIfChanged","applied","component","value","onUpdated","clearOnRemove","last","current","sameComponent","undefined","Object","is","error","console","DialstackComponentsProvider","dialstack","children","_a","registerClientPackage","call","React","createElement","Provider","appearance","setAppearance","useState","getAppearance","useEffect","document","target","handler","event","detail","addEventListener","addAppearanceTarget","removeAppearanceTarget","removeEventListener","tagName","beforeAttach","componentRef","useRef","beforeAttachRef","useLayoutEffect","componentInstance","setComponentInstance","containerRef","useCallback","container","parentNode","removeChild","create","element","setInstance","assertUpgraded","err","appendChild","useDialstack","name","_c","_b","registerClientComponent"],"mappings":"oCAEO,MCkBDA,EAA6BC,EAAAA,cAAsD,MA6D5EC,EAAyBA,KACpC,MAAMC,EAAUC,EAAAA,WAAWJ,GAC3B,IAAKG,EACH,MAAM,IAAIE,MACR,6KAIJ,OAAOF,GCgBT,SAASG,EACPC,EACAC,EACAC,EACAC,EACAC,GAAgB,GAEhB,IAAKH,EAAW,OAChB,MAAMI,EAAOL,EAAQM,QACfC,EAAyB,OAATF,GAAiBA,EAAKJ,YAAcA,EAC1D,QAAcO,IAAVN,GAEF,IAAKE,IAAkBG,QAAgCC,IAAfH,EAAKH,MAAqB,YAC7D,GAAIK,GAAiBE,OAAOC,GAAGL,EAAKH,MAAOA,GAChD,OAKFF,EAAQM,QAAU,CAAEL,YAAWC,SAC/B,IACEC,EAAUF,EAAWC,EACvB,CAAE,MAAOS,GACPC,QAAQD,MAAM,mCAAoCA,EACpD,CACF,0ED5EuFE,EACrFC,YACAC,qBAOgC,QAAhCC,EAAAF,aAAS,EAATA,EAAWG,6BAAqB,IAAAD,GAAAA,EAAAE,KAAAJ,EAAG,YD7DN,SC+D7B,MAAMZ,EAAyC,CAC7CY,aAGF,OACEK,EAAAC,cAAC3B,EAA2B4B,SAAQ,CAACnB,MAAOA,GACzCa,0BEtDD,SAAwBD,GAC5B,MAAOQ,EAAYC,GAAiBC,EAAAA,SAAwC,IAC1EV,EAAUW,iBAqBZ,OAlBAC,EAAAA,UAAU,KACR,GAAwB,oBAAbC,SAA0B,OAErC,MAAMC,EAASD,SAASP,cAAc,OAChCS,EAAWC,IACf,MAAMC,EAAUD,EAAqEC,OACrFR,EAAcQ,eAAAA,EAAQT,aAMxB,OAJAM,EAAOI,iBAAiB,8BAA+BH,GAEvDf,EAAUmB,oBAAoBL,GAEvB,KACLd,EAAUoB,uBAAuBN,GACjCA,EAAOO,oBAAoB,8BAA+BN,KAE3D,CAACf,IAEGQ,CACT,6BCyBM,SACJR,EACAsB,EAOAC,GAEA,MAAMC,EAAeC,EAAAA,OAAmC,MAIlDC,EAAkBD,EAAAA,OAAOF,GAC/BI,EAAAA,gBAAgB,KACdD,EAAgBlC,QAAU+B,IAG5B,MAAOK,EAAmBC,GAAwBnB,EAAAA,SAAqC,MAqCvF,MAAO,CACLoB,aAnCmBC,EAAAA,YAClBC,UAQC,GANIR,EAAahC,SAAWgC,EAAahC,QAAQyC,aAC/CT,EAAahC,QAAQyC,WAAWC,YAAYV,EAAahC,SACzDgC,EAAahC,QAAU,KACvBqC,EAAqB,QAGlBG,EAAW,OAGhB,MAAM7C,EAAYa,EAAUmC,OAAOb,GACnC,KArEN,SAAwBc,EAAkBd,GACxC,IAAIc,GAAyE,mBAAtDA,EAAsCC,YAG7D,MAAM,IAAIrD,MACR,cAAcsC,sZAOlB,CA0DQgB,CAAenD,EAAWmC,EAC5B,CAAE,MAAOiB,GAMP,MADAvC,EAAUoB,uBAAuBjC,GAC3BoD,CACR,CAEuB,QAAvBrC,EAAAwB,EAAgBlC,mBAAOU,GAAAA,EAAAE,KAAAsB,EAAGvC,GAG1B6C,EAAUQ,YAAYrD,GACtBqC,EAAahC,QAAUL,EACvB0C,EAAqB1C,IAEvB,CAACa,EAAWsB,IAKZM,oBAEJ,uBH9B4Ba,KAC1B,MAAMzC,UAAEA,GAAcnB,IACtB,OAAOmB,+DAUH,SAA6B0C,aACyC,QAA1EC,EAAiD,QAAjDC,EAAsC,QAAtC1C,EAAAnB,EAAAA,WAAWJ,UAA2B,IAAAuB,OAAA,EAAAA,EAAEF,iBAAS,IAAA4C,OAAA,EAAAA,EAAEC,mCAAuBF,GAAAA,EAAAvC,KAAAwC,EAAG,YAAaF,EAC5F,8CC7BEvD,EACA4B,EACA1B,GAEA,MAAMH,EAAUuC,EAAAA,OAA0B,MAC1Cb,EAAAA,UAAU,IAAM3B,EAAeC,EAASC,EAAW4B,EAAS1B,GAAW,GACzE,uCAtCEF,EACAC,EACAC,GAEA,MAAMH,EAAUuC,EAAAA,OAA0B,MAG1Cb,EAAAA,UAAU,IAAM3B,EAAeC,EAASC,EAAWC,EAAOC,GAC5D"}
package/dist/index.d.cts CHANGED
@@ -60,6 +60,14 @@ declare const useDialstackComponents: () => DialstackComponentsContextValue;
60
60
  * @throws {Error} If used outside of DialstackComponentsProvider
61
61
  */
62
62
  declare const useDialstack: () => DialStackInstance;
63
+ /**
64
+ * Report a React-only component (one that is not a web component, which
65
+ * reports itself) in the `DialStack-Client` header. No-op outside a provider.
66
+ * Runs during render, like the provider's own registration, so requests from
67
+ * the component's children's mount effects already carry it.
68
+ * @internal
69
+ */
70
+ declare function useReportComponent(name: string): void;
63
71
 
64
72
  /**
65
73
  * React hook for creating and managing Web Components
@@ -91,7 +99,14 @@ interface UseCreateComponentResult<T extends ComponentTagName> {
91
99
  * // TypeScript knows about setUserId, setOnVoicemailPlay, etc.
92
100
  * ```
93
101
  */
94
- declare function useCreateComponent<T extends ComponentTagName>(dialstack: DialStackInstance, tagName: T): UseCreateComponentResult<T>;
102
+ declare function useCreateComponent<T extends ComponentTagName>(dialstack: DialStackInstance, tagName: T,
103
+ /**
104
+ * Applies props to the element before it is attached. Attaching is what
105
+ * starts its first load, and the prop effects only run after that, so a
106
+ * setting that shapes the first request belongs here or it costs a second
107
+ * one. Read at creation time; it does not re-run.
108
+ */
109
+ beforeAttach?: (component: ComponentElement[T]) => void): UseCreateComponentResult<T>;
95
110
 
96
111
  /**
97
112
  * React hook for synchronizing React props to Web Component setter methods
@@ -105,6 +120,17 @@ declare function useCreateComponent<T extends ComponentTagName>(dialstack: DialS
105
120
  * This enables declarative React patterns (props) to control imperative
106
121
  * Web Component APIs (setter methods) in a type-safe way.
107
122
  *
123
+ * The setter runs only when the component or the value changes, compared by
124
+ * identity like React's own effect deps, so a host that re-renders often
125
+ * doesn't make the element re-render or reload.
126
+ * That makes two things part of the contract:
127
+ * - `onUpdated` must depend only on `component` and `value`. A setter closing
128
+ * over other state isn't re-run when only that state changes; pass it in
129
+ * `value` instead.
130
+ * - Keep object props stable (a constant, `useMemo`, state) and replace rather
131
+ * than mutate them: an inline `{…}` is a new value on every render, and a
132
+ * value mutated in place is the same one.
133
+ *
108
134
  * @param component - The Web Component instance (or null if not mounted)
109
135
  * @param value - The prop value to sync
110
136
  * @param onUpdated - Callback that receives the component and value, should call the setter
@@ -119,7 +145,8 @@ declare function useCreateComponent<T extends ComponentTagName>(dialstack: DialS
119
145
  * comp.setUserId(val);
120
146
  * });
121
147
  *
122
- * useUpdateWithSetter(componentInstance, onVoicemailSelect, (comp, val) => {
148
+ * // A callback: removing the prop clears it on the element.
149
+ * useUpdateHandlerWithSetter(componentInstance, onVoicemailSelect, (comp, val) => {
123
150
  * comp.setOnVoicemailSelect(val);
124
151
  * });
125
152
  *
@@ -128,6 +155,13 @@ declare function useCreateComponent<T extends ComponentTagName>(dialstack: DialS
128
155
  * ```
129
156
  */
130
157
  declare function useUpdateWithSetter<T extends HTMLElement, V>(component: T | null, value: V | undefined, onUpdated: (component: T, value: V) => void): void;
158
+ /**
159
+ * `useUpdateWithSetter` for a callback prop: when the host stops passing it,
160
+ * the setter is called once with `undefined`, so the element stops calling a
161
+ * handler the host has let go of. Other props keep their last value instead,
162
+ * since clearing them would need a per-setter reset to defaults.
163
+ */
164
+ declare function useUpdateHandlerWithSetter<T extends HTMLElement, H>(component: T | null, handler: H | undefined, onUpdated: (component: T, handler: H | undefined) => void): void;
131
165
 
132
166
  /**
133
167
  * useAppearance — subscribe to live appearance updates from a DialStack instance.
@@ -144,5 +178,5 @@ declare function useUpdateWithSetter<T extends HTMLElement, V>(component: T | nu
144
178
  */
145
179
  declare function useAppearance(dialstack: DialStackInstance): AppearanceOptions | undefined;
146
180
 
147
- export { DialstackComponentsContext, DialstackComponentsProvider, useAppearance, useCreateComponent, useDialstack, useDialstackComponents, useUpdateWithSetter };
181
+ export { DialstackComponentsContext, DialstackComponentsProvider, useAppearance, useCreateComponent, useDialstack, useDialstackComponents, useReportComponent, useUpdateHandlerWithSetter, useUpdateWithSetter };
148
182
  export type { DialstackComponentsProviderProps };
package/dist/index.d.ts CHANGED
@@ -60,6 +60,14 @@ declare const useDialstackComponents: () => DialstackComponentsContextValue;
60
60
  * @throws {Error} If used outside of DialstackComponentsProvider
61
61
  */
62
62
  declare const useDialstack: () => DialStackInstance;
63
+ /**
64
+ * Report a React-only component (one that is not a web component, which
65
+ * reports itself) in the `DialStack-Client` header. No-op outside a provider.
66
+ * Runs during render, like the provider's own registration, so requests from
67
+ * the component's children's mount effects already carry it.
68
+ * @internal
69
+ */
70
+ declare function useReportComponent(name: string): void;
63
71
 
64
72
  /**
65
73
  * React hook for creating and managing Web Components
@@ -91,7 +99,14 @@ interface UseCreateComponentResult<T extends ComponentTagName> {
91
99
  * // TypeScript knows about setUserId, setOnVoicemailPlay, etc.
92
100
  * ```
93
101
  */
94
- declare function useCreateComponent<T extends ComponentTagName>(dialstack: DialStackInstance, tagName: T): UseCreateComponentResult<T>;
102
+ declare function useCreateComponent<T extends ComponentTagName>(dialstack: DialStackInstance, tagName: T,
103
+ /**
104
+ * Applies props to the element before it is attached. Attaching is what
105
+ * starts its first load, and the prop effects only run after that, so a
106
+ * setting that shapes the first request belongs here or it costs a second
107
+ * one. Read at creation time; it does not re-run.
108
+ */
109
+ beforeAttach?: (component: ComponentElement[T]) => void): UseCreateComponentResult<T>;
95
110
 
96
111
  /**
97
112
  * React hook for synchronizing React props to Web Component setter methods
@@ -105,6 +120,17 @@ declare function useCreateComponent<T extends ComponentTagName>(dialstack: DialS
105
120
  * This enables declarative React patterns (props) to control imperative
106
121
  * Web Component APIs (setter methods) in a type-safe way.
107
122
  *
123
+ * The setter runs only when the component or the value changes, compared by
124
+ * identity like React's own effect deps, so a host that re-renders often
125
+ * doesn't make the element re-render or reload.
126
+ * That makes two things part of the contract:
127
+ * - `onUpdated` must depend only on `component` and `value`. A setter closing
128
+ * over other state isn't re-run when only that state changes; pass it in
129
+ * `value` instead.
130
+ * - Keep object props stable (a constant, `useMemo`, state) and replace rather
131
+ * than mutate them: an inline `{…}` is a new value on every render, and a
132
+ * value mutated in place is the same one.
133
+ *
108
134
  * @param component - The Web Component instance (or null if not mounted)
109
135
  * @param value - The prop value to sync
110
136
  * @param onUpdated - Callback that receives the component and value, should call the setter
@@ -119,7 +145,8 @@ declare function useCreateComponent<T extends ComponentTagName>(dialstack: DialS
119
145
  * comp.setUserId(val);
120
146
  * });
121
147
  *
122
- * useUpdateWithSetter(componentInstance, onVoicemailSelect, (comp, val) => {
148
+ * // A callback: removing the prop clears it on the element.
149
+ * useUpdateHandlerWithSetter(componentInstance, onVoicemailSelect, (comp, val) => {
123
150
  * comp.setOnVoicemailSelect(val);
124
151
  * });
125
152
  *
@@ -128,6 +155,13 @@ declare function useCreateComponent<T extends ComponentTagName>(dialstack: DialS
128
155
  * ```
129
156
  */
130
157
  declare function useUpdateWithSetter<T extends HTMLElement, V>(component: T | null, value: V | undefined, onUpdated: (component: T, value: V) => void): void;
158
+ /**
159
+ * `useUpdateWithSetter` for a callback prop: when the host stops passing it,
160
+ * the setter is called once with `undefined`, so the element stops calling a
161
+ * handler the host has let go of. Other props keep their last value instead,
162
+ * since clearing them would need a per-setter reset to defaults.
163
+ */
164
+ declare function useUpdateHandlerWithSetter<T extends HTMLElement, H>(component: T | null, handler: H | undefined, onUpdated: (component: T, handler: H | undefined) => void): void;
131
165
 
132
166
  /**
133
167
  * useAppearance — subscribe to live appearance updates from a DialStack instance.
@@ -144,5 +178,5 @@ declare function useUpdateWithSetter<T extends HTMLElement, V>(component: T | nu
144
178
  */
145
179
  declare function useAppearance(dialstack: DialStackInstance): AppearanceOptions | undefined;
146
180
 
147
- export { DialstackComponentsContext, DialstackComponentsProvider, useAppearance, useCreateComponent, useDialstack, useDialstackComponents, useUpdateWithSetter };
181
+ export { DialstackComponentsContext, DialstackComponentsProvider, useAppearance, useCreateComponent, useDialstack, useDialstackComponents, useReportComponent, useUpdateHandlerWithSetter, useUpdateWithSetter };
148
182
  export type { DialstackComponentsProviderProps };
package/dist/index.mjs CHANGED
@@ -1,2 +1,2 @@
1
- import e,{createContext as t,useContext as r,useRef as n,useState as a,useCallback as o,useEffect as i}from"react";const c=t(null),s=({dialstack:t,children:r})=>{const n={dialstack:t};return e.createElement(c.Provider,{value:n},r)},d=()=>{const e=r(c);if(!e)throw new Error("Could not find DialStack context; You need to wrap your app in a <DialstackComponentsProvider> provider. See https://docs.dialstack.ai/sdk/react for setup instructions.");return e},l=()=>{const{dialstack:e}=d();return e};function u(e,t){const r=n(null),[i,c]=a(null);return{containerRef:o(n=>{if(r.current&&r.current.parentNode&&(r.current.parentNode.removeChild(r.current),r.current=null,c(null)),!n)return;const a=e.create(t);try{!function(e,t){if(!e||"function"!=typeof e.setInstance)throw new Error(`<dialstack-${t}> was created but is not a registered custom element, so it would render nothing. Install @dialstack/sdk-js alongside @dialstack/sdk-react and import it once at your entry point — importing it is what registers the elements. On @dialstack/sdk-js/pure nothing registers on import: await registerComponents() before rendering. If it is installed, check that your bundler is not dropping its side effects.`)}(a,t)}catch(t){throw e.removeAppearanceTarget(a),t}try{a.setAttribute("data-dialstack-sdk-version","3.7.0")}catch(e){console.log("Error setting SDK version attribute:",e)}n.appendChild(a),r.current=a,c(a)},[e,t]),componentInstance:i}}function p(e,t,r){i(()=>{if(e&&void 0!==t)try{r(e,t)}catch(e){console.error("DialStack: Error calling setter:",e)}},[e,t,r])}function f(e){const[t,r]=a(()=>e.getAppearance());return i(()=>{if("undefined"==typeof document)return;const t=document.createElement("div"),n=e=>{const t=e.detail;r(null==t?void 0:t.appearance)};return t.addEventListener("dialstack-appearance-update",n),e.addAppearanceTarget(t),()=>{e.removeAppearanceTarget(t),t.removeEventListener("dialstack-appearance-update",n)}},[e]),t}export{c as DialstackComponentsContext,s as DialstackComponentsProvider,f as useAppearance,u as useCreateComponent,l as useDialstack,d as useDialstackComponents,p as useUpdateWithSetter};
1
+ import e,{createContext as t,useContext as n,useRef as r,useLayoutEffect as a,useState as o,useCallback as i,useEffect as c}from"react";const l=t(null),s=({dialstack:t,children:n})=>{var r;null===(r=null==t?void 0:t.registerClientPackage)||void 0===r||r.call(t,"sdk-react","3.9.0");const a={dialstack:t};return e.createElement(l.Provider,{value:a},n)},u=()=>{const e=n(l);if(!e)throw new Error("Could not find DialStack context; You need to wrap your app in a <DialstackComponentsProvider> provider. See https://docs.dialstack.ai/sdks/setup for setup instructions.");return e},d=()=>{const{dialstack:e}=u();return e};function p(e){var t,r,a;null===(a=null===(r=null===(t=n(l))||void 0===t?void 0:t.dialstack)||void 0===r?void 0:r.registerClientComponent)||void 0===a||a.call(r,"sdk-react",e)}function v(e,t,n){const c=r(null),l=r(n);a(()=>{l.current=n});const[s,u]=o(null);return{containerRef:i(n=>{var r;if(c.current&&c.current.parentNode&&(c.current.parentNode.removeChild(c.current),c.current=null,u(null)),!n)return;const a=e.create(t);try{!function(e,t){if(!e||"function"!=typeof e.setInstance)throw new Error(`<dialstack-${t}> was created but is not a registered custom element, so it would render nothing. Install @dialstack/sdk-js alongside @dialstack/sdk-react and import it once at your entry point — importing it is what registers the elements. On @dialstack/sdk-js/pure nothing registers on import: await registerComponents() before rendering. If it is installed, check that your bundler is not dropping its side effects.`)}(a,t)}catch(t){throw e.removeAppearanceTarget(a),t}null===(r=l.current)||void 0===r||r.call(l,a),n.appendChild(a),c.current=a,u(a)},[e,t]),componentInstance:s}}function f(e,t,n){const a=r(null);c(()=>m(a,e,t,n))}function k(e,t,n){const a=r(null);c(()=>m(a,e,t,n,!0))}function m(e,t,n,r,a=!1){if(!t)return;const o=e.current,i=null!==o&&o.component===t;if(void 0===n){if(!a||!i||void 0===o.value)return}else if(i&&Object.is(o.value,n))return;e.current={component:t,value:n};try{r(t,n)}catch(e){console.error("DialStack: Error calling setter:",e)}}function g(e){const[t,n]=o(()=>e.getAppearance());return c(()=>{if("undefined"==typeof document)return;const t=document.createElement("div"),r=e=>{const t=e.detail;n(null==t?void 0:t.appearance)};return t.addEventListener("dialstack-appearance-update",r),e.addAppearanceTarget(t),()=>{e.removeAppearanceTarget(t),t.removeEventListener("dialstack-appearance-update",r)}},[e]),t}export{l as DialstackComponentsContext,s as DialstackComponentsProvider,g as useAppearance,v as useCreateComponent,d as useDialstack,u as useDialstackComponents,p as useReportComponent,k as useUpdateHandlerWithSetter,f as useUpdateWithSetter};
2
2
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sources":["../src/react/DialstackComponentsProvider.tsx","../src/react/useCreateComponent.tsx","../src/react/version.ts","../src/react/useUpdateWithSetter.ts","../src/react/useAppearance.ts"],"sourcesContent":[null,null,null,null,null],"names":["DialstackComponentsContext","createContext","DialstackComponentsProvider","dialstack","children","value","React","createElement","Provider","useDialstackComponents","context","useContext","Error","useDialstack","useCreateComponent","tagName","componentRef","useRef","componentInstance","setComponentInstance","useState","containerRef","useCallback","container","current","parentNode","removeChild","component","create","element","setInstance","assertUpgraded","err","removeAppearanceTarget","setAttribute","e","console","log","appendChild","useUpdateWithSetter","onUpdated","useEffect","undefined","error","useAppearance","appearance","setAppearance","getAppearance","document","target","handler","event","detail","addEventListener","addAppearanceTarget","removeEventListener"],"mappings":"mHAmBA,MAAMA,EAA6BC,EAAsD,MAkC5EC,EAA0EA,EACrFC,YACAC,eAEA,MAAMC,EAAyC,CAC7CF,aAGF,OACEG,EAAAC,cAACP,EAA2BQ,SAAQ,CAACH,MAAOA,GACzCD,IAUMK,EAAyBA,KACpC,MAAMC,EAAUC,EAAWX,GAC3B,IAAKU,EACH,MAAM,IAAIE,MACR,4KAIJ,OAAOF,GAQIG,EAAeA,KAC1B,MAAMV,UAAEA,GAAcM,IACtB,OAAON,GCvBH,SAAUW,EACdX,EACAY,GAEA,MAAMC,EAAeC,EAAmC,OAEjDC,EAAmBC,GAAwBC,EAAqC,MA0CvF,MAAO,CACLC,aAxCmBC,EAClBC,IAQC,GANIP,EAAaQ,SAAWR,EAAaQ,QAAQC,aAC/CT,EAAaQ,QAAQC,WAAWC,YAAYV,EAAaQ,SACzDR,EAAaQ,QAAU,KACvBL,EAAqB,QAGlBI,EAAW,OAGhB,MAAMI,EAAYxB,EAAUyB,OAAOb,GACnC,KAvDN,SAAwBc,EAAkBd,GACxC,IAAIc,GAAyE,mBAAtDA,EAAsCC,YAG7D,MAAM,IAAIlB,MACR,cAAcG,sZAOlB,CA4CQgB,CAAeJ,EAAWZ,EAC5B,CAAE,MAAOiB,GAMP,MADA7B,EAAU8B,uBAAuBN,GAC3BK,CACR,CAGA,IACEL,EAAUO,aAAa,6BCrGA,QDsGzB,CAAE,MAAOC,GACPC,QAAQC,IAAI,uCAAwCF,EACtD,CAGAZ,EAAUe,YAAYX,GACtBX,EAAaQ,QAAUG,EACvBR,EAAqBQ,IAEvB,CAACxB,EAAWY,IAKZG,oBAEJ,UEnFgBqB,EACdZ,EACAtB,EACAmC,GAEAC,EAAU,KACR,GAAKd,QAAuBe,IAAVrC,EAElB,IACEmC,EAAUb,EAAWtB,EACvB,CAAE,MAAOsC,GACPP,QAAQO,MAAM,mCAAoCA,EACpD,GACC,CAAChB,EAAWtB,EAAOmC,GACxB,CClCM,SAAUI,EAAczC,GAC5B,MAAO0C,EAAYC,GAAiB1B,EAAwC,IAC1EjB,EAAU4C,iBAqBZ,OAlBAN,EAAU,KACR,GAAwB,oBAAbO,SAA0B,OAErC,MAAMC,EAASD,SAASzC,cAAc,OAChC2C,EAAWC,IACf,MAAMC,EAAUD,EAAqEC,OACrFN,EAAcM,eAAAA,EAAQP,aAMxB,OAJAI,EAAOI,iBAAiB,8BAA+BH,GAEvD/C,EAAUmD,oBAAoBL,GAEvB,KACL9C,EAAU8B,uBAAuBgB,GACjCA,EAAOM,oBAAoB,8BAA+BL,KAE3D,CAAC/C,IAEG0C,CACT"}
1
+ {"version":3,"file":"index.mjs","sources":["../src/react/version.ts","../src/react/DialstackComponentsProvider.tsx","../src/react/useCreateComponent.tsx","../src/react/useUpdateWithSetter.ts","../src/react/useAppearance.ts"],"sourcesContent":[null,null,null,null,null],"names":["DialstackComponentsContext","createContext","DialstackComponentsProvider","dialstack","children","_a","registerClientPackage","call","value","React","createElement","Provider","useDialstackComponents","context","useContext","Error","useDialstack","useReportComponent","name","_c","_b","registerClientComponent","useCreateComponent","tagName","beforeAttach","componentRef","useRef","beforeAttachRef","useLayoutEffect","current","componentInstance","setComponentInstance","useState","containerRef","useCallback","container","parentNode","removeChild","component","create","element","setInstance","assertUpgraded","err","removeAppearanceTarget","appendChild","useUpdateWithSetter","onUpdated","applied","useEffect","applyIfChanged","useUpdateHandlerWithSetter","handler","clearOnRemove","last","sameComponent","undefined","Object","is","error","console","useAppearance","appearance","setAppearance","getAppearance","document","target","event","detail","addEventListener","addAppearanceTarget","removeEventListener"],"mappings":"wIAEO,MCkBDA,EAA6BC,EAAsD,MAkC5EC,EAA0EA,EACrFC,YACAC,qBAOgC,QAAhCC,EAAAF,aAAS,EAATA,EAAWG,6BAAqB,IAAAD,GAAAA,EAAAE,KAAAJ,EAAG,YD7DN,SC+D7B,MAAMK,EAAyC,CAC7CL,aAGF,OACEM,EAAAC,cAACV,EAA2BW,SAAQ,CAACH,MAAOA,GACzCJ,IAUMQ,EAAyBA,KACpC,MAAMC,EAAUC,EAAWd,GAC3B,IAAKa,EACH,MAAM,IAAIE,MACR,6KAIJ,OAAOF,GAQIG,EAAeA,KAC1B,MAAMb,UAAEA,GAAcS,IACtB,OAAOT,GAUH,SAAUc,EAAmBC,aACyC,QAA1EC,EAAiD,QAAjDC,EAAsC,QAAtCf,EAAAS,EAAWd,UAA2B,IAAAK,OAAA,EAAAA,EAAEF,iBAAS,IAAAiB,OAAA,EAAAA,EAAEC,mCAAuBF,GAAAA,EAAAZ,KAAAa,EAAG,YAAaF,EAC5F,CC7CM,SAAUI,EACdnB,EACAoB,EAOAC,GAEA,MAAMC,EAAeC,EAAmC,MAIlDC,EAAkBD,EAAOF,GAC/BI,EAAgB,KACdD,EAAgBE,QAAUL,IAG5B,MAAOM,EAAmBC,GAAwBC,EAAqC,MAqCvF,MAAO,CACLC,aAnCmBC,EAClBC,UAQC,GANIV,EAAaI,SAAWJ,EAAaI,QAAQO,aAC/CX,EAAaI,QAAQO,WAAWC,YAAYZ,EAAaI,SACzDJ,EAAaI,QAAU,KACvBE,EAAqB,QAGlBI,EAAW,OAGhB,MAAMG,EAAYnC,EAAUoC,OAAOhB,GACnC,KArEN,SAAwBiB,EAAkBjB,GACxC,IAAIiB,GAAyE,mBAAtDA,EAAsCC,YAG7D,MAAM,IAAI1B,MACR,cAAcQ,sZAOlB,CA0DQmB,CAAeJ,EAAWf,EAC5B,CAAE,MAAOoB,GAMP,MADAxC,EAAUyC,uBAAuBN,GAC3BK,CACR,CAEuB,QAAvBtC,EAAAsB,EAAgBE,mBAAOxB,GAAAA,EAAAE,KAAAoB,EAAGW,GAG1BH,EAAUU,YAAYP,GACtBb,EAAaI,QAAUS,EACvBP,EAAqBO,IAEvB,CAACnC,EAAWoB,IAKZO,oBAEJ,UC9EgBgB,EACdR,EACA9B,EACAuC,GAEA,MAAMC,EAAUtB,EAA0B,MAG1CuB,EAAU,IAAMC,EAAeF,EAASV,EAAW9B,EAAOuC,GAC5D,UAuBgBI,EACdb,EACAc,EACAL,GAEA,MAAMC,EAAUtB,EAA0B,MAC1CuB,EAAU,IAAMC,EAAeF,EAASV,EAAWc,EAASL,GAAW,GACzE,CAiBA,SAASG,EACPF,EACAV,EACA9B,EACAuC,EACAM,GAAgB,GAEhB,IAAKf,EAAW,OAChB,MAAMgB,EAAON,EAAQnB,QACf0B,EAAyB,OAATD,GAAiBA,EAAKhB,YAAcA,EAC1D,QAAckB,IAAVhD,GAEF,IAAK6C,IAAkBE,QAAgCC,IAAfF,EAAK9C,MAAqB,YAC7D,GAAI+C,GAAiBE,OAAOC,GAAGJ,EAAK9C,MAAOA,GAChD,OAKFwC,EAAQnB,QAAU,CAAES,YAAW9B,SAC/B,IACEuC,EAAUT,EAAW9B,EACvB,CAAE,MAAOmD,GACPC,QAAQD,MAAM,mCAAoCA,EACpD,CACF,CCjHM,SAAUE,EAAc1D,GAC5B,MAAO2D,EAAYC,GAAiB/B,EAAwC,IAC1E7B,EAAU6D,iBAqBZ,OAlBAf,EAAU,KACR,GAAwB,oBAAbgB,SAA0B,OAErC,MAAMC,EAASD,SAASvD,cAAc,OAChC0C,EAAWe,IACf,MAAMC,EAAUD,EAAqEC,OACrFL,EAAcK,eAAAA,EAAQN,aAMxB,OAJAI,EAAOG,iBAAiB,8BAA+BjB,GAEvDjD,EAAUmE,oBAAoBJ,GAEvB,KACL/D,EAAUyC,uBAAuBsB,GACjCA,EAAOK,oBAAoB,8BAA+BnB,KAE3D,CAACjD,IAEG2D,CACT"}