@uppy/unsplash,@uppy/provider-views: add utmSource option

transloadit · Jan 7, 2025 · 4ef8909 · 4ef8909
1 parent f3a750d
commit 4ef8909
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 3 deletions.
diff --git a/packages/@uppy/provider-views/src/Browser.tsx b/packages/@uppy/provider-views/src/Browser.tsx
@@ -24,6 +24,7 @@ type BrowserProps<M extends Meta, B extends Body> = {
   openFolder: ProviderView<M, B>['openFolder']
   noResultsLabel: string
   virtualList: boolean
+  utmSource: string
 }
 
 function Browser<M extends Meta, B extends Body>(props: BrowserProps<M, B>) {
@@ -38,6 +39,7 @@ function Browser<M extends Meta, B extends Body>(props: BrowserProps<M, B>) {
     openFolder,
     noResultsLabel,
     virtualList,
+    utmSource,
   } = props
 
   const [isShiftKeyPressed, setIsShiftKeyPressed] = useState(false)
@@ -88,6 +90,7 @@ function Browser<M extends Meta, B extends Body>(props: BrowserProps<M, B>) {
       i18n={i18n}
       openFolder={openFolder}
       file={item}
+      utmSource={utmSource}
     />
   )
 

diff --git a/packages/@uppy/provider-views/src/Item/index.tsx b/packages/@uppy/provider-views/src/Item/index.tsx
@@ -18,10 +18,19 @@ type ItemProps = {
   viewType: string
   showTitles: boolean
   i18n: I18n
+  utmSource: string
 }
 
 export default function Item(props: ItemProps): h.JSX.Element {
-  const { viewType, toggleCheckbox, showTitles, i18n, openFolder, file } = props
+  const {
+    viewType,
+    toggleCheckbox,
+    showTitles,
+    i18n,
+    openFolder,
+    file,
+    utmSource,
+  } = props
 
   const restrictionError = file.type === 'folder' ? null : file.restrictionError
   const isDisabled = !!restrictionError && file.status !== 'checked'
@@ -30,6 +39,7 @@ export default function Item(props: ItemProps): h.JSX.Element {
     file,
     openFolder,
     toggleCheckbox,
+    utmSource,
 
     i18n,
     viewType,
@@ -54,7 +64,7 @@ export default function Item(props: ItemProps): h.JSX.Element {
       return (
         <GridItem {...ourProps}>
           <a
-            href={`${file.data.author!.url}?utm_source=Companion&utm_medium=referral`}
+            href={`${file.data.author!.url}?utm_source=${utmSource}&utm_medium=referral`}
             target="_blank"
             rel="noopener noreferrer"
             className="uppy-ProviderBrowserItem-author"

diff --git a/packages/@uppy/provider-views/src/SearchProviderView/SearchProviderView.tsx b/packages/@uppy/provider-views/src/SearchProviderView/SearchProviderView.tsx
@@ -49,6 +49,7 @@ interface Opts<M extends Meta, B extends Body> {
   viewType: 'list' | 'grid' | 'unsplash'
   showTitles: boolean
   showFilter: boolean
+  utmSource?: string
 }
 type PassedOpts<M extends Meta, B extends Body> = Optional<
   Opts<M, B>,
@@ -93,6 +94,7 @@ export default class SearchProviderView<M extends Meta, B extends Body> {
       viewType: 'grid',
       showTitles: true,
       showFilter: true,
+      utmSource: 'Companion',
     }
     this.opts = { ...defaultOptions, ...opts }
 
@@ -334,6 +336,7 @@ export default class SearchProviderView<M extends Meta, B extends Body> {
           isLoading={loading}
           i18n={i18n}
           virtualList={false}
+          utmSource={this.opts.utmSource}
         />
 
         <FooterActions

diff --git a/packages/@uppy/unsplash/src/Unsplash.tsx b/packages/@uppy/unsplash/src/Unsplash.tsx
@@ -19,7 +19,7 @@ import locale from './locale.js'
 // @ts-ignore We don't want TS to generate types for the package.json
 import packageJson from '../package.json'
 
-export type UnsplashOptions = CompanionPluginOptions
+export type UnsplashOptions = { utmSource: string } & CompanionPluginOptions
 
 export default class Unsplash<M extends Meta, B extends Body>
   extends UIPlugin<UnsplashOptions, M, B, UnknownSearchProviderPluginState>
@@ -91,6 +91,7 @@ export default class Unsplash<M extends Meta, B extends Body>
       provider: this.provider,
       viewType: 'unsplash',
       showFilter: true,
+      utmSource: this.opts.utmSource,
     })
 
     const { target } = this.opts