@uppy/companion,@uppy/companion-client: pass query params along more consistently

packages/@uppy/companion-client/src/Provider.js

@@ -7,6 +7,11 @@ const getName = (id) => {
  return id.split('-').map((s) => s.charAt(0).toUpperCase() + s.slice(1)).join(' ')
 }
 
+const queryString = (params, prefix = '?') => {
+ const str = new URLSearchParams(params).toString()
+ return str ? `${prefix}${str}` : ''
+}
+
 function getOrigin () {
  // eslint-disable-next-line no-restricted-globals
  return location.origin
@@ -92,15 +97,15 @@ export default class Provider extends RequestClient {
  }
 
  authUrl (queries = {}) {
- const params = new URLSearchParams({
+ const qs = queryString({
  state: btoa(JSON.stringify({ origin: getOrigin() })),
  ...queries,
+ ...this.cutomQueryParams,
+ ...(this.preAuthToken && {
+ uppyPreAuthToken: this.preAuthToken,
+ }),
  })
- if (this.preAuthToken) {
- params.set('uppyPreAuthToken', this.preAuthToken)
- }
-
- return `${this.hostname}/${this.id}/connect?${params}`
+ return `${this.hostname}/${this.id}/connect${qs}`
  }
 
  async login (queries) {
@@ -148,11 +153,11 @@ export default class Provider extends RequestClient {
  }
 
  refreshTokenUrl () {
- return `${this.hostname}/${this.id}/refresh-token`
+ return `${this.hostname}/${this.id}/refresh-token${queryString(this.cutomQueryParams)}`
  }
 
  fileUrl (id) {
- return `${this.hostname}/${this.id}/get/${id}`
+ return `${this.hostname}/${this.id}/get/${id}${queryString(this.cutomQueryParams)}`
  }
 
  /** @protected */
@@ -199,11 +204,11 @@ export default class Provider extends RequestClient {
  }
 
  list (directory, options) {
- return this.get(`${this.id}/list/${directory || ''}`, options)
+ return this.get(`${this.id}/list/${directory || ''}${queryString(this.cutomQueryParams)}`, options)
  }
 
  async logout (options) {
- const response = await this.get(`${this.id}/logout`, options)
+ const response = await this.get(`${this.id}/logout${queryString(this.cutomQueryParams)}`, options)
  await this.#removeAuthToken()
  return response
  }

packages/@uppy/companion/src/companion.js

@@ -73,6 +73,7 @@ module.exports.app = (optionsArg = {}) => {
  const providers = providerManager.getDefaultProviders()
 
  providerManager.addProviderOptions(options, grantConfig)
+ options.providerOptions = merge(options.providerOptions, grantConfig)
 
  const { customProviders } = options
  if (customProviders) {

packages/@uppy/companion/src/server/controllers/connect.js

@@ -1,6 +1,11 @@
 const atob = require('atob')
 const oAuthState = require('../helpers/oauth-state')
 
+const queryString = (params, prefix = '') => {
+ const str = new URLSearchParams(params).toString()
+ return str ? `${prefix}${str}` : ''
+}
+
 /**
  * initializes the oAuth flow for a provider.
  *
@@ -27,5 +32,10 @@ module.exports = function connect (req, res) {
  state = oAuthState.addToState(state, { preAuthToken: req.query.uppyPreAuthToken }, secret)
  }
 
- res.redirect(req.companion.buildURL(`/connect/${req.companion.provider.authProvider}?state=${state}`, true))
+ const providerName = req.companion.provider.authProvider
+ const qs = queryString(Object.fromEntries(
+ req.companion.options.providerOptions[providerName]?.dynamic?.map(p => [p, req.query[p]]) || [],
+ ), '&')
+
+ res.redirect(req.companion.buildURL(`/connect/${providerName}?state=${state}${qs}`, true))
 }

packages/@uppy/companion/src/server/controllers/list.js

@@ -1,5 +1,10 @@
 const { respondWithError } = require('../provider/error')
 
+/**
+ *
+ * @param {{ query: object, params: object, companion: object }} req
+ * @param {object} res
+ */
 async function list ({ query, params, companion }, res, next) {
  const { accessToken } = companion.providerTokens
 

packages/@uppy/companion/src/server/controllers/logout.js

@@ -3,18 +3,17 @@
 
 /**
  *
- * @param {object} req
+ * @param {{ query: object, params: object, companion: object, session: object }} req
  * @param {object} res
  */
-async function logout (req, res, next) {
+async function logout ({ query, params, companion, session }, res, next) {
  const cleanSession = () => {
- if (req.session.grant) {
- req.session.grant.state = null
- req.session.grant.dynamic = null
+ if (session.grant) {
+ session.grant.state = null
+ session.grant.dynamic = null
  }
  }
- const { providerName } = req.params
- const { companion } = req
+ const { providerName } = params
  const tokens = companion.allProvidersTokens ? companion.allProvidersTokens[providerName] : null
 
  if (!tokens) {
@@ -25,8 +24,8 @@
 
  try {
  const { accessToken } = tokens
- const data = await companion.provider.logout({ token: accessToken, companion })
+ const data = await companion.provider.logout({ companion, token: accessToken, query })
  delete companion.allProvidersTokens[providerName]
  tokenService.removeFromCookies(res, companion.options, companion.provider.authProvider)
  cleanSession()
  res.json({ ok: true, ...data })

packages/@uppy/companion/src/server/controllers/thumbnail.js

@@ -1,15 +1,15 @@
 /**
  *
- * @param {object} req
+ * @param {{ params: object, companion: object, query: object }} req
  * @param {object} res
  */
-async function thumbnail (req, res, next) {
- const { providerName, id } = req.params
- const { accessToken } = req.companion.allProvidersTokens[providerName]
- const { provider } = req.companion
+async function thumbnail ({ params, companion, query }, res, next) {
+ const { providerName, id } = params
+ const { accessToken } = companion.allProvidersTokens[providerName]
+ const { provider } = companion
 
  try {
- const { stream } = await provider.thumbnail({ id, token: accessToken })
+ const { stream } = await provider.thumbnail({ id, token: accessToken, query })
  stream.pipe(res)
  } catch (err) {
  if (err.isAuthError) res.sendStatus(401)

packages/@uppy/companion/src/server/controllers/url.js

@@ -57,7 +57,7 @@ const downloadURL = async (url, blockLocalIPs, traceId) => {
 }
 
 /**
- * Fteches the size and content type of a URL
+ * Fetches the size and content type of a URL
  *
  * @param {object} req expressJS request object
  * @param {object} res expressJS response object

packages/@uppy/companion/src/server/provider/credentials.js

@@ -27,7 +27,7 @@ async function fetchKeys (url, providerName, credentialRequestParams) {
 }
 
 /**
- * Fetches for a providers OAuth credentials. If the config for thtat provider allows fetching
+ * Fetches for a providers OAuth credentials. If the config for that provider allows fetching
  * of the credentials via http, and the `credentialRequestParams` argument is provided, the oauth
  * credentials will be fetched via http. Otherwise, the credentials provided via companion options
  * will be used instead.