feat: export USERCENTRICS_WEB_CMP_LOADER_SCRIPT_URL constant

Author: iiroj

README.md

@@ -33,7 +33,7 @@ import MyApplication from './app'
 ReactDOM.render(
     <>
         <UsercentricsScript settingsId={USERCENTRICS_SETTINGS_ID} />
-        <UsercentricsProvider windowEventName={USERCENTRICS_EVENT_NAME}>
+        <UsercentricsProvider>
             <MyApplication /** You can interact with Usercentrics inside the provider */ />
         </UsercentricsProvider>
     </>,
@@ -69,6 +69,19 @@ declare module '@s-group/react-usercentrics/augmented' {
 
 ## API
 
+### Constants
+
+#### `USERCENTRICS_WEB_CMP_LOADER_SCRIPT_URL`
+
+The url of the Usercentercis Web CMP v3 loader script. Useful when generating Link headers, for example.
+
+```ts
+response.headers.append(
+    'Link',
+    `<${USERCENTRICS_WEB_CMP_LOADER_SCRIPT_URL}>; rel=prefetch; as=script; fetchpriority="high"`,
+)
+```
+
 ### Components
 
 #### `UsercentricsScript`

src/components/UsercentricsScript.tsx

@@ -1,6 +1,8 @@
 import type { FC } from 'react'
 import React from 'react'
 
+import { USERCENTRICS_WEB_CMP_LOADER_SCRIPT_URL } from '../constants.js'
+
 interface UsercentricsScriptProps
     extends React.DetailedHTMLProps<React.ScriptHTMLAttributes<HTMLScriptElement>, HTMLScriptElement> {
     /**
@@ -31,12 +33,6 @@ interface UsercentricsScriptProps
  * @example <caption>Preview mode for development</caption>
  * () => <UsercentricsScript settingsId="1234" version="preview" />
  *
- * @example <caption>Use SDK v3 instead of previous v2</caption>
- * () => <UsercentricsScript cmpVersion="3" settingsId="1234" />
- *
- * @example <caption>Fixed UI version instead of latest</caption>
- * () => <UsercentricsScript settingsId="1234" uiVersion="3.24.0" />
- *
  * @example <caption>Fixed language code</caption>
  * () => <UsercentricsScript settingsId="1234" language="fi" />
  *
@@ -56,7 +52,7 @@ export const UsercentricsScript: FC<UsercentricsScriptProps> = ({
             data-settings-id={settingsId}
             data-version={version}
             id={id}
-            src="https://web.cmp.usercentrics.eu/ui/loader.js"
+            src={USERCENTRICS_WEB_CMP_LOADER_SCRIPT_URL}
         />
     )
 }

src/constants.ts

@@ -0,0 +1,10 @@
+/**
+ * The url of the Usercentercis Web CMP v3 loader script. Useful when generating Link headers, for example.
+ *
+ * @example
+ * response.headers.append(
+ *   'Link',
+ *   `<${USERCENTRICS_WEB_CMP_LOADER_SCRIPT_URL}>; rel=prefetch; as=script; fetchpriority="high"`,
+ * )
+ */
+export const USERCENTRICS_WEB_CMP_LOADER_SCRIPT_URL = 'https://web.cmp.usercentrics.eu/ui/loader.js'

src/index.ts

@@ -1,6 +1,7 @@
 export { UsercentricsDialogToggle } from './components/UsercentricsDialogToggle.js'
 export { UsercentricsProvider } from './components/UsercentricsProvider.js'
 export { UsercentricsScript } from './components/UsercentricsScript.js'
+export { USERCENTRICS_WEB_CMP_LOADER_SCRIPT_URL } from './constants.js'
 export { UsercentricsContext } from './context.js'
 export { useHasServiceConsent } from './hooks/use-has-service-consent.js'
 export { useHasUserInteracted } from './hooks/use-has-user-interacted.js'