@adhese/sdk-react 1.3.2 → 1.4.0-nightly-20241118121055
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/CHANGELOG.md +14 -0
- package/dist/AdheseSlot.js +4 -2
- package/dist/AdheseSlot.js.map +1 -1
- package/dist/cjs/AdheseSlot.cjs +3 -1
- package/dist/cjs/AdheseSlot.cjs.map +1 -1
- package/dist/cjs/sdkReact.cjs +1 -0
- package/dist/cjs/sdkReact.cjs.map +1 -1
- package/dist/cjs/useAdheseSlot.cjs +19 -11
- package/dist/cjs/useAdheseSlot.cjs.map +1 -1
- package/dist/sdkReact.d.ts +6 -1
- package/dist/sdkReact.js +3 -2
- package/dist/useAdheseSlot.js +21 -13
- package/dist/useAdheseSlot.js.map +1 -1
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @adhese/sdk-react
|
|
2
2
|
|
|
3
|
+
## 1.4.0-nightly-20241118121055
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 556744b: Add useWatch hook that will allow you to observer if a value of reactive object changes within an Adhese slot. The value that is watched is converted into a proper React state that will trigger a re-render when it changes.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- 556744b: Make sure that the slot state is not updated every time a internal value changes
|
|
12
|
+
- Updated dependencies [556744b]
|
|
13
|
+
- Updated dependencies [236883d]
|
|
14
|
+
- @adhese/sdk-shared@1.3.0-nightly-20241118121055
|
|
15
|
+
- @adhese/sdk@1.4.0-nightly-20241118121055
|
|
16
|
+
|
|
3
17
|
## 1.3.2
|
|
4
18
|
|
|
5
19
|
### Patch Changes
|
package/dist/AdheseSlot.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { jsx } from "react/jsx-runtime";
|
|
2
2
|
import { watch } from "@adhese/sdk-shared";
|
|
3
3
|
import { useId, useCallback } from "react";
|
|
4
|
-
import { useAdheseSlot } from "./useAdheseSlot.js";
|
|
4
|
+
import { useAdheseSlot, useWatch } from "./useAdheseSlot.js";
|
|
5
5
|
function AdheseSlot({
|
|
6
6
|
onChange,
|
|
7
7
|
width,
|
|
@@ -41,7 +41,9 @@ function AdheseSlot({
|
|
|
41
41
|
}, { immediate: true, deep: true });
|
|
42
42
|
}, [setup, onChange])
|
|
43
43
|
});
|
|
44
|
-
const
|
|
44
|
+
const status = useWatch(slotState ? () => slotState.status : void 0);
|
|
45
|
+
const slotFormat = useWatch(slotState ? () => slotState.format : void 0);
|
|
46
|
+
const name = useWatch(slotState ? () => slotState.name : void 0);
|
|
45
47
|
if (["error", "empty"].includes(status ?? "")) {
|
|
46
48
|
return null;
|
|
47
49
|
}
|
package/dist/AdheseSlot.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdheseSlot.js","sources":["../src/AdheseSlot.tsx"],"sourcesContent":["'use client';\n\nimport type { AdheseSlotOptions, AdheseSlot as Slot } from '@adhese/sdk';\nimport { watch } from '@adhese/sdk-shared';\nimport { type HTMLAttributes, type ReactNode, useCallback, useId } from 'react';\nimport { useAdheseSlot } from './useAdheseSlot';\n\nexport type AdheseSlotProps = {\n /**\n * Placeholder to be shown when the slot is not rendered yet.\n */\n placeholder?: ReactNode;\n /**\n * Callback to be called when the slot is created or disposed\n */\n onChange?(slot: Slot | null): void;\n /**\n * Inject custom React elements into the slot when it's rendered.\n */\n render?(slot: Slot): ReactNode;\n} & Omit<AdheseSlotOptions, 'containingElement' | 'context'> & HTMLAttributes<HTMLDivElement>;\n\n/**\n * Component to create an Adhese slot. The slot will be disposed when the component is unmounted. The slot will be\n * created when the containing element is available and the Adhese instance is available.\n *\n * @warning Make sure to wrap your `setup` function in a `useCallback` as it can trigger an infinite loop if it's not\n * memoized.\n */\n// eslint-disable-next-line ts/naming-convention\nexport function AdheseSlot({\n onChange,\n width,\n height,\n lazyLoading,\n lazyLoadingOptions,\n slot,\n pluginOptions,\n renderMode,\n type,\n setup,\n parameters,\n format,\n id,\n render,\n placeholder,\n style,\n ...props\n}: AdheseSlotProps): ReactNode {\n const reactId = useId().replaceAll(':', '');\n const componentId = id ?? `slot-${reactId}`;\n\n const slotState = useAdheseSlot(componentId, {\n width,\n height,\n lazyLoading,\n lazyLoadingOptions,\n slot,\n pluginOptions,\n renderMode: render ? 'none' : renderMode,\n type,\n parameters,\n format,\n setup: useCallback(((context, hooks): void => {\n setup?.(context, hooks);\n\n watch(context, (newSlot) => {\n onChange?.(newSlot);\n }, { immediate: true, deep: true });\n }) satisfies AdheseSlotOptions['setup'], [setup, onChange]),\n });\n\n const
|
|
1
|
+
{"version":3,"file":"AdheseSlot.js","sources":["../src/AdheseSlot.tsx"],"sourcesContent":["'use client';\n\nimport type { AdheseSlotOptions, AdheseSlot as Slot } from '@adhese/sdk';\nimport { watch } from '@adhese/sdk-shared';\nimport { type HTMLAttributes, type ReactNode, useCallback, useId } from 'react';\nimport { useAdheseSlot, useWatch } from './useAdheseSlot';\n\nexport type AdheseSlotProps = {\n /**\n * Placeholder to be shown when the slot is not rendered yet.\n */\n placeholder?: ReactNode;\n /**\n * Callback to be called when the slot is created or disposed\n */\n onChange?(slot: Slot | null): void;\n /**\n * Inject custom React elements into the slot when it's rendered.\n */\n render?(slot: Slot): ReactNode;\n} & Omit<AdheseSlotOptions, 'containingElement' | 'context'> & HTMLAttributes<HTMLDivElement>;\n\n/**\n * Component to create an Adhese slot. The slot will be disposed when the component is unmounted. The slot will be\n * created when the containing element is available and the Adhese instance is available.\n *\n * @warning Make sure to wrap your `setup` function in a `useCallback` as it can trigger an infinite loop if it's not\n * memoized.\n */\n// eslint-disable-next-line ts/naming-convention\nexport function AdheseSlot({\n onChange,\n width,\n height,\n lazyLoading,\n lazyLoadingOptions,\n slot,\n pluginOptions,\n renderMode,\n type,\n setup,\n parameters,\n format,\n id,\n render,\n placeholder,\n style,\n ...props\n}: AdheseSlotProps): ReactNode {\n const reactId = useId().replaceAll(':', '');\n const componentId = id ?? `slot-${reactId}`;\n\n const slotState = useAdheseSlot(componentId, {\n width,\n height,\n lazyLoading,\n lazyLoadingOptions,\n slot,\n pluginOptions,\n renderMode: render ? 'none' : renderMode,\n type,\n parameters,\n format,\n setup: useCallback(((context, hooks): void => {\n setup?.(context, hooks);\n\n watch(context, (newSlot) => {\n onChange?.(newSlot);\n }, { immediate: true, deep: true });\n }) satisfies AdheseSlotOptions['setup'], [setup, onChange]),\n });\n\n const status = useWatch(slotState ? (): Slot['status'] => slotState.status : undefined);\n const slotFormat = useWatch(slotState ? (): Slot['format'] => slotState.format : undefined);\n const name = useWatch(slotState ? (): Slot['name'] => slotState.name : undefined);\n\n if (['error', 'empty'].includes(status ?? '')) {\n return null;\n }\n\n return (\n <div\n data-name={name}\n data-status={status}\n data-format={slotFormat}\n data-slot={slot}\n id={componentId}\n style={{\n width,\n height,\n ...style,\n }}\n {...props}\n >\n {slotState?.data ? render?.(slotState) : placeholder}\n </div>\n );\n}\n"],"names":[],"mappings":";;;;AA8BO,SAAS,WAAW;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,GAAG;AACL,GAA+B;AAC7B,QAAM,UAAU,MAAQ,EAAA,WAAW,KAAK,EAAE;AACpC,QAAA,cAAc,MAAM,QAAQ,OAAO;AAEnC,QAAA,YAAY,cAAc,aAAa;AAAA,IAC3C;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,YAAY,SAAS,SAAS;AAAA,IAC9B;AAAA,IACA;AAAA,IACA;AAAA,IACA,OAAO,YAAa,CAAC,SAAS,UAAgB;AAC5C,qCAAQ,SAAS;AAEX,YAAA,SAAS,CAAC,YAAY;AAC1B,6CAAW;AAAA,SACV,EAAE,WAAW,MAAM,MAAM,KAAM,CAAA;AAAA,IAAA,GACK,CAAC,OAAO,QAAQ,CAAC;AAAA,EAAA,CAC3D;AAED,QAAM,SAAS,SAAS,YAAY,MAAsB,UAAU,SAAS,MAAS;AACtF,QAAM,aAAa,SAAS,YAAY,MAAsB,UAAU,SAAS,MAAS;AAC1F,QAAM,OAAO,SAAS,YAAY,MAAoB,UAAU,OAAO,MAAS;AAEhF,MAAI,CAAC,SAAS,OAAO,EAAE,SAAS,UAAU,EAAE,GAAG;AACtC,WAAA;AAAA,EACT;AAGE,SAAA;AAAA,IAAC;AAAA,IAAA;AAAA,MACC,aAAW;AAAA,MACX,eAAa;AAAA,MACb,eAAa;AAAA,MACb,aAAW;AAAA,MACX,IAAI;AAAA,MACJ,OAAO;AAAA,QACL;AAAA,QACA;AAAA,QACA,GAAG;AAAA,MACL;AAAA,MACC,GAAG;AAAA,MAEH,WAAW,uCAAA,QAAO,iCAAS,aAAa;AAAA,IAAA;AAAA,EAAA;AAG/C;"}
|
package/dist/cjs/AdheseSlot.cjs
CHANGED
|
@@ -43,7 +43,9 @@ function AdheseSlot({
|
|
|
43
43
|
}, { immediate: true, deep: true });
|
|
44
44
|
}, [setup, onChange])
|
|
45
45
|
});
|
|
46
|
-
const
|
|
46
|
+
const status = useAdheseSlot.useWatch(slotState ? () => slotState.status : void 0);
|
|
47
|
+
const slotFormat = useAdheseSlot.useWatch(slotState ? () => slotState.format : void 0);
|
|
48
|
+
const name = useAdheseSlot.useWatch(slotState ? () => slotState.name : void 0);
|
|
47
49
|
if (["error", "empty"].includes(status ?? "")) {
|
|
48
50
|
return null;
|
|
49
51
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdheseSlot.cjs","sources":["../../src/AdheseSlot.tsx"],"sourcesContent":["'use client';\n\nimport type { AdheseSlotOptions, AdheseSlot as Slot } from '@adhese/sdk';\nimport { watch } from '@adhese/sdk-shared';\nimport { type HTMLAttributes, type ReactNode, useCallback, useId } from 'react';\nimport { useAdheseSlot } from './useAdheseSlot';\n\nexport type AdheseSlotProps = {\n /**\n * Placeholder to be shown when the slot is not rendered yet.\n */\n placeholder?: ReactNode;\n /**\n * Callback to be called when the slot is created or disposed\n */\n onChange?(slot: Slot | null): void;\n /**\n * Inject custom React elements into the slot when it's rendered.\n */\n render?(slot: Slot): ReactNode;\n} & Omit<AdheseSlotOptions, 'containingElement' | 'context'> & HTMLAttributes<HTMLDivElement>;\n\n/**\n * Component to create an Adhese slot. The slot will be disposed when the component is unmounted. The slot will be\n * created when the containing element is available and the Adhese instance is available.\n *\n * @warning Make sure to wrap your `setup` function in a `useCallback` as it can trigger an infinite loop if it's not\n * memoized.\n */\n// eslint-disable-next-line ts/naming-convention\nexport function AdheseSlot({\n onChange,\n width,\n height,\n lazyLoading,\n lazyLoadingOptions,\n slot,\n pluginOptions,\n renderMode,\n type,\n setup,\n parameters,\n format,\n id,\n render,\n placeholder,\n style,\n ...props\n}: AdheseSlotProps): ReactNode {\n const reactId = useId().replaceAll(':', '');\n const componentId = id ?? `slot-${reactId}`;\n\n const slotState = useAdheseSlot(componentId, {\n width,\n height,\n lazyLoading,\n lazyLoadingOptions,\n slot,\n pluginOptions,\n renderMode: render ? 'none' : renderMode,\n type,\n parameters,\n format,\n setup: useCallback(((context, hooks): void => {\n setup?.(context, hooks);\n\n watch(context, (newSlot) => {\n onChange?.(newSlot);\n }, { immediate: true, deep: true });\n }) satisfies AdheseSlotOptions['setup'], [setup, onChange]),\n });\n\n const
|
|
1
|
+
{"version":3,"file":"AdheseSlot.cjs","sources":["../../src/AdheseSlot.tsx"],"sourcesContent":["'use client';\n\nimport type { AdheseSlotOptions, AdheseSlot as Slot } from '@adhese/sdk';\nimport { watch } from '@adhese/sdk-shared';\nimport { type HTMLAttributes, type ReactNode, useCallback, useId } from 'react';\nimport { useAdheseSlot, useWatch } from './useAdheseSlot';\n\nexport type AdheseSlotProps = {\n /**\n * Placeholder to be shown when the slot is not rendered yet.\n */\n placeholder?: ReactNode;\n /**\n * Callback to be called when the slot is created or disposed\n */\n onChange?(slot: Slot | null): void;\n /**\n * Inject custom React elements into the slot when it's rendered.\n */\n render?(slot: Slot): ReactNode;\n} & Omit<AdheseSlotOptions, 'containingElement' | 'context'> & HTMLAttributes<HTMLDivElement>;\n\n/**\n * Component to create an Adhese slot. The slot will be disposed when the component is unmounted. The slot will be\n * created when the containing element is available and the Adhese instance is available.\n *\n * @warning Make sure to wrap your `setup` function in a `useCallback` as it can trigger an infinite loop if it's not\n * memoized.\n */\n// eslint-disable-next-line ts/naming-convention\nexport function AdheseSlot({\n onChange,\n width,\n height,\n lazyLoading,\n lazyLoadingOptions,\n slot,\n pluginOptions,\n renderMode,\n type,\n setup,\n parameters,\n format,\n id,\n render,\n placeholder,\n style,\n ...props\n}: AdheseSlotProps): ReactNode {\n const reactId = useId().replaceAll(':', '');\n const componentId = id ?? `slot-${reactId}`;\n\n const slotState = useAdheseSlot(componentId, {\n width,\n height,\n lazyLoading,\n lazyLoadingOptions,\n slot,\n pluginOptions,\n renderMode: render ? 'none' : renderMode,\n type,\n parameters,\n format,\n setup: useCallback(((context, hooks): void => {\n setup?.(context, hooks);\n\n watch(context, (newSlot) => {\n onChange?.(newSlot);\n }, { immediate: true, deep: true });\n }) satisfies AdheseSlotOptions['setup'], [setup, onChange]),\n });\n\n const status = useWatch(slotState ? (): Slot['status'] => slotState.status : undefined);\n const slotFormat = useWatch(slotState ? (): Slot['format'] => slotState.format : undefined);\n const name = useWatch(slotState ? (): Slot['name'] => slotState.name : undefined);\n\n if (['error', 'empty'].includes(status ?? '')) {\n return null;\n }\n\n return (\n <div\n data-name={name}\n data-status={status}\n data-format={slotFormat}\n data-slot={slot}\n id={componentId}\n style={{\n width,\n height,\n ...style,\n }}\n {...props}\n >\n {slotState?.data ? render?.(slotState) : placeholder}\n </div>\n );\n}\n"],"names":["useId","useAdheseSlot","useCallback","watch","useWatch","jsx"],"mappings":";;;;;;AA8BO,SAAS,WAAW;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,GAAG;AACL,GAA+B;AAC7B,QAAM,UAAUA,MAAAA,MAAQ,EAAA,WAAW,KAAK,EAAE;AACpC,QAAA,cAAc,MAAM,QAAQ,OAAO;AAEnC,QAAA,YAAYC,4BAAc,aAAa;AAAA,IAC3C;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,YAAY,SAAS,SAAS;AAAA,IAC9B;AAAA,IACA;AAAA,IACA;AAAA,IACA,OAAOC,MAAA,YAAa,CAAC,SAAS,UAAgB;AAC5C,qCAAQ,SAAS;AAEXC,sBAAA,SAAS,CAAC,YAAY;AAC1B,6CAAW;AAAA,SACV,EAAE,WAAW,MAAM,MAAM,KAAM,CAAA;AAAA,IAAA,GACK,CAAC,OAAO,QAAQ,CAAC;AAAA,EAAA,CAC3D;AAED,QAAM,SAASC,cAAAA,SAAS,YAAY,MAAsB,UAAU,SAAS,MAAS;AACtF,QAAM,aAAaA,cAAAA,SAAS,YAAY,MAAsB,UAAU,SAAS,MAAS;AAC1F,QAAM,OAAOA,cAAAA,SAAS,YAAY,MAAoB,UAAU,OAAO,MAAS;AAEhF,MAAI,CAAC,SAAS,OAAO,EAAE,SAAS,UAAU,EAAE,GAAG;AACtC,WAAA;AAAA,EACT;AAGE,SAAAC,2BAAA;AAAA,IAAC;AAAA,IAAA;AAAA,MACC,aAAW;AAAA,MACX,eAAa;AAAA,MACb,eAAa;AAAA,MACb,aAAW;AAAA,MACX,IAAI;AAAA,MACJ,OAAO;AAAA,QACL;AAAA,QACA;AAAA,QACA,GAAG;AAAA,MACL;AAAA,MACC,GAAG;AAAA,MAEH,WAAW,uCAAA,QAAO,iCAAS,aAAa;AAAA,IAAA;AAAA,EAAA;AAG/C;;"}
|
package/dist/cjs/sdkReact.cjs
CHANGED
|
@@ -7,4 +7,5 @@ exports.AdheseProvider = adheseContext.AdheseProvider;
|
|
|
7
7
|
exports.useAdhese = adheseContext.useAdhese;
|
|
8
8
|
exports.AdheseSlot = AdheseSlot.AdheseSlot;
|
|
9
9
|
exports.useAdheseSlot = useAdheseSlot.useAdheseSlot;
|
|
10
|
+
exports.useWatch = useAdheseSlot.useWatch;
|
|
10
11
|
//# sourceMappingURL=sdkReact.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdkReact.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"sdkReact.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
|
|
@@ -12,21 +12,13 @@ function useAdheseSlot(elementRef, options) {
|
|
|
12
12
|
slot: options.slot
|
|
13
13
|
}), [adhese == null ? void 0 : adhese.location, options.format, options.slot]);
|
|
14
14
|
const [slot, setSlot] = react.useState(null);
|
|
15
|
-
const setup = react.useCallback((context, hooks) => {
|
|
16
|
-
var _a;
|
|
17
|
-
(_a = options.setup) == null ? void 0 : _a.call(options, context, hooks);
|
|
18
|
-
sdkShared.watch(context, (newSlot) => {
|
|
19
|
-
setSlot(newSlot && { ...newSlot });
|
|
20
|
-
}, { deep: true, immediate: true });
|
|
21
|
-
}, [options.setup]);
|
|
22
15
|
react.useEffect(() => {
|
|
23
16
|
const element = typeof elementRef === "string" ? elementRef : elementRef.current;
|
|
24
17
|
if (adhese && element) {
|
|
25
|
-
adhese == null ? void 0 : adhese.addSlot({
|
|
18
|
+
setSlot(adhese == null ? void 0 : adhese.addSlot({
|
|
26
19
|
...options,
|
|
27
|
-
containingElement: element
|
|
28
|
-
|
|
29
|
-
});
|
|
20
|
+
containingElement: element
|
|
21
|
+
}));
|
|
30
22
|
}
|
|
31
23
|
return () => {
|
|
32
24
|
setSlot(null);
|
|
@@ -34,5 +26,21 @@ function useAdheseSlot(elementRef, options) {
|
|
|
34
26
|
}, [adhese, ...Object.values(options), slotSignature]);
|
|
35
27
|
return slot;
|
|
36
28
|
}
|
|
29
|
+
function useWatch(value, options) {
|
|
30
|
+
const [state, setState] = react.useState(typeof value === "function" ? value() : value);
|
|
31
|
+
react.useEffect(() => {
|
|
32
|
+
let handle;
|
|
33
|
+
if (value) {
|
|
34
|
+
handle = sdkShared.watch(value, (newValue) => {
|
|
35
|
+
setState(newValue);
|
|
36
|
+
}, { immediate: true, ...options });
|
|
37
|
+
}
|
|
38
|
+
return () => {
|
|
39
|
+
handle == null ? void 0 : handle.stop();
|
|
40
|
+
};
|
|
41
|
+
}, [value]);
|
|
42
|
+
return state;
|
|
43
|
+
}
|
|
37
44
|
exports.useAdheseSlot = useAdheseSlot;
|
|
45
|
+
exports.useWatch = useWatch;
|
|
38
46
|
//# sourceMappingURL=useAdheseSlot.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useAdheseSlot.cjs","sources":["../../src/useAdheseSlot.ts"],"sourcesContent":["import type { AdheseSlot, AdheseSlotOptions } from '@adhese/sdk';\nimport { generateSlotSignature, watch } from '@adhese/sdk-shared';\nimport {\n type RefObject,\n
|
|
1
|
+
{"version":3,"file":"useAdheseSlot.cjs","sources":["../../src/useAdheseSlot.ts"],"sourcesContent":["import type { AdheseSlot, AdheseSlotOptions } from '@adhese/sdk';\nimport { generateSlotSignature, watch, type WatchHandle, type WatchOptions } from '@adhese/sdk-shared';\nimport {\n type RefObject,\n useEffect,\n useMemo,\n useState,\n} from 'react';\nimport { useAdhese } from './adheseContext';\n\n/**\n * Hook to create an Adhese slot. The slot will be disposed when the component is unmounted. The slot will be created\n * when the containing element is available and the Adhese instance is available.\n * @param elementRef The ref to the containing element\n * @param options The options to create the slot\n *\n * @warning Make sure to wrap your `setup` function in a `useCallback` as it can trigger an infinite loop if it's not\n * memoized.\n */\nexport function useAdheseSlot(elementRef: RefObject<HTMLElement> | string, options: Omit<AdheseSlotOptions, 'containingElement' | 'context'>): AdheseSlot | null {\n const adhese = useAdhese();\n\n const slotSignature = useMemo(() => (adhese?.location) && generateSlotSignature({\n location: adhese.location,\n format: options.format,\n parameters: options.parameters,\n slot: options.slot,\n }), [adhese?.location, options.format, options.slot]);\n\n const [slot, setSlot] = useState<AdheseSlot | null>(null);\n\n useEffect(() => {\n const element = typeof elementRef === 'string' ? elementRef : elementRef.current;\n\n if (adhese && element) {\n setSlot(adhese?.addSlot({\n ...options,\n containingElement: element,\n }));\n }\n\n return (): void => {\n setSlot(null);\n };\n }, [adhese, ...Object.values(options), slotSignature]);\n\n return slot;\n}\n\n/**\n * Hook that will observe a value on a reactive object and convert to React state\n */\nexport function useWatch<\n Input,\n Output = Input extends () => unknown ? ReturnType<Input> | undefined : Input | undefined,\n>(value?: Input, options?: Omit<WatchOptions, 'immediate'>): Output {\n const [state, setState] = useState<Output>(typeof value === 'function' ? value() : value);\n\n useEffect(() => {\n let handle: WatchHandle | undefined;\n\n if (value) {\n handle = watch(value, (newValue) => {\n setState(newValue as Output);\n }, { immediate: true, ...options });\n }\n\n return (): void => {\n handle?.stop();\n };\n }, [value]);\n\n return state;\n}\n"],"names":["useAdhese","useMemo","generateSlotSignature","useState","useEffect","watch"],"mappings":";;;;;AAmBgB,SAAA,cAAc,YAA6C,SAAsF;AAC/J,QAAM,SAASA,cAAAA;AAEf,QAAM,gBAAgBC,MAAA,QAAQ,OAAO,iCAAQ,aAAaC,UAAAA,sBAAsB;AAAA,IAC9E,UAAU,OAAO;AAAA,IACjB,QAAQ,QAAQ;AAAA,IAChB,YAAY,QAAQ;AAAA,IACpB,MAAM,QAAQ;AAAA,EAAA,CACf,GAAG,CAAC,iCAAQ,UAAU,QAAQ,QAAQ,QAAQ,IAAI,CAAC;AAEpD,QAAM,CAAC,MAAM,OAAO,IAAIC,eAA4B,IAAI;AAExDC,QAAAA,UAAU,MAAM;AACd,UAAM,UAAU,OAAO,eAAe,WAAW,aAAa,WAAW;AAEzE,QAAI,UAAU,SAAS;AACrB,cAAQ,iCAAQ,QAAQ;AAAA,QACtB,GAAG;AAAA,QACH,mBAAmB;AAAA,MACpB,EAAC;AAAA,IACJ;AAEA,WAAO,MAAY;AACjB,cAAQ,IAAI;AAAA,IAAA;AAAA,EACd,GACC,CAAC,QAAQ,GAAG,OAAO,OAAO,OAAO,GAAG,aAAa,CAAC;AAE9C,SAAA;AACT;AAKgB,SAAA,SAGd,OAAe,SAAmD;AAC5D,QAAA,CAAC,OAAO,QAAQ,IAAID,MAAA,SAAiB,OAAO,UAAU,aAAa,UAAU,KAAK;AAExFC,QAAAA,UAAU,MAAM;AACV,QAAA;AAEJ,QAAI,OAAO;AACA,eAAAC,UAAA,MAAM,OAAO,CAAC,aAAa;AAClC,iBAAS,QAAkB;AAAA,SAC1B,EAAE,WAAW,MAAM,GAAG,QAAS,CAAA;AAAA,IACpC;AAEA,WAAO,MAAY;AACjB,uCAAQ;AAAA,IAAK;AAAA,EACf,GACC,CAAC,KAAK,CAAC;AAEH,SAAA;AACT;;;"}
|
package/dist/sdkReact.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { AdheseOptions, Adhese, AdheseSlot as AdheseSlot$1, AdheseSlotOptions } from '@adhese/sdk';
|
|
2
2
|
import { PropsWithChildren, ReactElement, ReactNode, HTMLAttributes, RefObject } from 'react';
|
|
3
|
+
import { WatchOptions } from '@adhese/sdk-shared';
|
|
3
4
|
|
|
4
5
|
/**
|
|
5
6
|
* Provider to create an Adhese instance with the given options. Via the `useAdhese` hook, the Adhese instance can be
|
|
@@ -47,5 +48,9 @@ declare function AdheseSlot({ onChange, width, height, lazyLoading, lazyLoadingO
|
|
|
47
48
|
* memoized.
|
|
48
49
|
*/
|
|
49
50
|
declare function useAdheseSlot(elementRef: RefObject<HTMLElement> | string, options: Omit<AdheseSlotOptions, 'containingElement' | 'context'>): AdheseSlot$1 | null;
|
|
51
|
+
/**
|
|
52
|
+
* Hook that will observe a value on a reactive object and convert to React state
|
|
53
|
+
*/
|
|
54
|
+
declare function useWatch<Input, Output = Input extends () => unknown ? ReturnType<Input> | undefined : Input | undefined>(value?: Input, options?: Omit<WatchOptions, 'immediate'>): Output;
|
|
50
55
|
|
|
51
|
-
export { AdheseProvider, AdheseSlot, useAdhese, useAdheseSlot };
|
|
56
|
+
export { AdheseProvider, AdheseSlot, useAdhese, useAdheseSlot, useWatch };
|
package/dist/sdkReact.js
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import { AdheseProvider, useAdhese } from "./adheseContext.js";
|
|
2
2
|
import { AdheseSlot } from "./AdheseSlot.js";
|
|
3
|
-
import { useAdheseSlot } from "./useAdheseSlot.js";
|
|
3
|
+
import { useAdheseSlot, useWatch } from "./useAdheseSlot.js";
|
|
4
4
|
export {
|
|
5
5
|
AdheseProvider,
|
|
6
6
|
AdheseSlot,
|
|
7
7
|
useAdhese,
|
|
8
|
-
useAdheseSlot
|
|
8
|
+
useAdheseSlot,
|
|
9
|
+
useWatch
|
|
9
10
|
};
|
|
10
11
|
//# sourceMappingURL=sdkReact.js.map
|
package/dist/useAdheseSlot.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { generateSlotSignature, watch } from "@adhese/sdk-shared";
|
|
2
|
-
import { useMemo, useState,
|
|
2
|
+
import { useMemo, useState, useEffect } from "react";
|
|
3
3
|
import { useAdhese } from "./adheseContext.js";
|
|
4
4
|
function useAdheseSlot(elementRef, options) {
|
|
5
5
|
const adhese = useAdhese();
|
|
@@ -10,21 +10,13 @@ function useAdheseSlot(elementRef, options) {
|
|
|
10
10
|
slot: options.slot
|
|
11
11
|
}), [adhese == null ? void 0 : adhese.location, options.format, options.slot]);
|
|
12
12
|
const [slot, setSlot] = useState(null);
|
|
13
|
-
const setup = useCallback((context, hooks) => {
|
|
14
|
-
var _a;
|
|
15
|
-
(_a = options.setup) == null ? void 0 : _a.call(options, context, hooks);
|
|
16
|
-
watch(context, (newSlot) => {
|
|
17
|
-
setSlot(newSlot && { ...newSlot });
|
|
18
|
-
}, { deep: true, immediate: true });
|
|
19
|
-
}, [options.setup]);
|
|
20
13
|
useEffect(() => {
|
|
21
14
|
const element = typeof elementRef === "string" ? elementRef : elementRef.current;
|
|
22
15
|
if (adhese && element) {
|
|
23
|
-
adhese == null ? void 0 : adhese.addSlot({
|
|
16
|
+
setSlot(adhese == null ? void 0 : adhese.addSlot({
|
|
24
17
|
...options,
|
|
25
|
-
containingElement: element
|
|
26
|
-
|
|
27
|
-
});
|
|
18
|
+
containingElement: element
|
|
19
|
+
}));
|
|
28
20
|
}
|
|
29
21
|
return () => {
|
|
30
22
|
setSlot(null);
|
|
@@ -32,7 +24,23 @@ function useAdheseSlot(elementRef, options) {
|
|
|
32
24
|
}, [adhese, ...Object.values(options), slotSignature]);
|
|
33
25
|
return slot;
|
|
34
26
|
}
|
|
27
|
+
function useWatch(value, options) {
|
|
28
|
+
const [state, setState] = useState(typeof value === "function" ? value() : value);
|
|
29
|
+
useEffect(() => {
|
|
30
|
+
let handle;
|
|
31
|
+
if (value) {
|
|
32
|
+
handle = watch(value, (newValue) => {
|
|
33
|
+
setState(newValue);
|
|
34
|
+
}, { immediate: true, ...options });
|
|
35
|
+
}
|
|
36
|
+
return () => {
|
|
37
|
+
handle == null ? void 0 : handle.stop();
|
|
38
|
+
};
|
|
39
|
+
}, [value]);
|
|
40
|
+
return state;
|
|
41
|
+
}
|
|
35
42
|
export {
|
|
36
|
-
useAdheseSlot
|
|
43
|
+
useAdheseSlot,
|
|
44
|
+
useWatch
|
|
37
45
|
};
|
|
38
46
|
//# sourceMappingURL=useAdheseSlot.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useAdheseSlot.js","sources":["../src/useAdheseSlot.ts"],"sourcesContent":["import type { AdheseSlot, AdheseSlotOptions } from '@adhese/sdk';\nimport { generateSlotSignature, watch } from '@adhese/sdk-shared';\nimport {\n type RefObject,\n
|
|
1
|
+
{"version":3,"file":"useAdheseSlot.js","sources":["../src/useAdheseSlot.ts"],"sourcesContent":["import type { AdheseSlot, AdheseSlotOptions } from '@adhese/sdk';\nimport { generateSlotSignature, watch, type WatchHandle, type WatchOptions } from '@adhese/sdk-shared';\nimport {\n type RefObject,\n useEffect,\n useMemo,\n useState,\n} from 'react';\nimport { useAdhese } from './adheseContext';\n\n/**\n * Hook to create an Adhese slot. The slot will be disposed when the component is unmounted. The slot will be created\n * when the containing element is available and the Adhese instance is available.\n * @param elementRef The ref to the containing element\n * @param options The options to create the slot\n *\n * @warning Make sure to wrap your `setup` function in a `useCallback` as it can trigger an infinite loop if it's not\n * memoized.\n */\nexport function useAdheseSlot(elementRef: RefObject<HTMLElement> | string, options: Omit<AdheseSlotOptions, 'containingElement' | 'context'>): AdheseSlot | null {\n const adhese = useAdhese();\n\n const slotSignature = useMemo(() => (adhese?.location) && generateSlotSignature({\n location: adhese.location,\n format: options.format,\n parameters: options.parameters,\n slot: options.slot,\n }), [adhese?.location, options.format, options.slot]);\n\n const [slot, setSlot] = useState<AdheseSlot | null>(null);\n\n useEffect(() => {\n const element = typeof elementRef === 'string' ? elementRef : elementRef.current;\n\n if (adhese && element) {\n setSlot(adhese?.addSlot({\n ...options,\n containingElement: element,\n }));\n }\n\n return (): void => {\n setSlot(null);\n };\n }, [adhese, ...Object.values(options), slotSignature]);\n\n return slot;\n}\n\n/**\n * Hook that will observe a value on a reactive object and convert to React state\n */\nexport function useWatch<\n Input,\n Output = Input extends () => unknown ? ReturnType<Input> | undefined : Input | undefined,\n>(value?: Input, options?: Omit<WatchOptions, 'immediate'>): Output {\n const [state, setState] = useState<Output>(typeof value === 'function' ? value() : value);\n\n useEffect(() => {\n let handle: WatchHandle | undefined;\n\n if (value) {\n handle = watch(value, (newValue) => {\n setState(newValue as Output);\n }, { immediate: true, ...options });\n }\n\n return (): void => {\n handle?.stop();\n };\n }, [value]);\n\n return state;\n}\n"],"names":[],"mappings":";;;AAmBgB,SAAA,cAAc,YAA6C,SAAsF;AAC/J,QAAM,SAAS;AAEf,QAAM,gBAAgB,QAAQ,OAAO,iCAAQ,aAAa,sBAAsB;AAAA,IAC9E,UAAU,OAAO;AAAA,IACjB,QAAQ,QAAQ;AAAA,IAChB,YAAY,QAAQ;AAAA,IACpB,MAAM,QAAQ;AAAA,EAAA,CACf,GAAG,CAAC,iCAAQ,UAAU,QAAQ,QAAQ,QAAQ,IAAI,CAAC;AAEpD,QAAM,CAAC,MAAM,OAAO,IAAI,SAA4B,IAAI;AAExD,YAAU,MAAM;AACd,UAAM,UAAU,OAAO,eAAe,WAAW,aAAa,WAAW;AAEzE,QAAI,UAAU,SAAS;AACrB,cAAQ,iCAAQ,QAAQ;AAAA,QACtB,GAAG;AAAA,QACH,mBAAmB;AAAA,MACpB,EAAC;AAAA,IACJ;AAEA,WAAO,MAAY;AACjB,cAAQ,IAAI;AAAA,IAAA;AAAA,EACd,GACC,CAAC,QAAQ,GAAG,OAAO,OAAO,OAAO,GAAG,aAAa,CAAC;AAE9C,SAAA;AACT;AAKgB,SAAA,SAGd,OAAe,SAAmD;AAC5D,QAAA,CAAC,OAAO,QAAQ,IAAI,SAAiB,OAAO,UAAU,aAAa,UAAU,KAAK;AAExF,YAAU,MAAM;AACV,QAAA;AAEJ,QAAI,OAAO;AACA,eAAA,MAAM,OAAO,CAAC,aAAa;AAClC,iBAAS,QAAkB;AAAA,SAC1B,EAAE,WAAW,MAAM,GAAG,QAAS,CAAA;AAAA,IACpC;AAEA,WAAO,MAAY;AACjB,uCAAQ;AAAA,IAAK;AAAA,EACf,GACC,CAAC,KAAK,CAAC;AAEH,SAAA;AACT;"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@adhese/sdk-react",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.4.0-nightly-20241118121055",
|
|
5
5
|
"description": "Adhese SDK",
|
|
6
6
|
"license": "GPL-3.0",
|
|
7
7
|
"repository": {
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
"react-dom": ">=16.13"
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
|
-
"@adhese/sdk": "1.
|
|
49
|
-
"@adhese/sdk-shared": "1.
|
|
48
|
+
"@adhese/sdk": "1.4.0-nightly-20241118121055",
|
|
49
|
+
"@adhese/sdk-shared": "1.3.0-nightly-20241118121055"
|
|
50
50
|
}
|
|
51
51
|
}
|