quasvel/packages/connect-core/src/utils/app-connectors.ts

Access and interact with Aragon Organizations and their apps.

import { Network } from '@aragon/connect-types'
import { ConnectionContext } from '../types'
import App from '../entities/App'

type AppConnectContext = {
  app: App
  config: object
  connector: string
  ipfs: ConnectionContext['ipfs']
  network: Network
  orgConnector: ConnectionContext['orgConnector']
  verbose: boolean
}

function normalizeConnectorConfig<Config extends object>(
  connector: string | [string, Config | undefined]
): [string, Config] {
  if (Array.isArray(connector)) {
    // Returning `{} as Config` shouldn’t be an issue, because the config type
    // of an app connector should have all its properties declared as optional.
    return [connector[0], connector[1] ?? ({} as Config)]
  }
  if (typeof connector === 'string') {
    return [connector, {} as Config]
  }
  throw new Error('The connector should be passed as a string or an array.')
}

// Check if an app is valid. We are not using instanceof here, because the
// passed app might come from the final app dependency, while @connect-core
// might come from the app connector they are using, with two different
// versions. It also makes it easier to work with linked dependencies, as it
// creates the same kind of issues.
function isAppValid(app: any): boolean {
  return app && app.name && app.address && app.appId && app.version
}

export function createAppConnector<
  ConnectedApp extends object,
  Config extends object
>(
  callback: (
    context: { config: Config } & AppConnectContext
  ) => ConnectedApp | Promise<ConnectedApp>
) {
  return async function connect(
    app: App | Promise<App>,
    connector?: string | [string, Config | undefined]
  ): Promise<App & ConnectedApp> {
    app = await app

    if (!isAppValid(app)) {
      throw new Error(
        `App connector: the passed value doesn’t appear to be an App.`
      )
    }

    const { connection } = app.organization
    const { orgConnector } = connection

    // App connector config.
    const [connectorName, connectorConfig] = normalizeConnectorConfig<Config>(
      // Contrary to the main connect() function, app connectors don’t require
      // the connector to be passed. In this case, the name of the org
      // connector (e.g. `name`) is used instead.
      connector || orgConnector.name
    )

    const connectedApp = await callback({
      app,
      config: connectorConfig,
      connector: connectorName,
      ipfs: connection.ipfs,
      network: orgConnector.network,
      orgConnector,
      verbose: connection.verbose,
    })

    return Object.assign(connectedApp, app)
  }
}