app.plugin.js

/* eslint-disable import/no-extraneous-dependencies, functional/immutable-data, no-param-reassign, @typescript-eslint/no-var-requires */
const {
  withPlugins,
  createRunOncePlugin,
  withEntitlementsPlist,
  withInfoPlist,
} = require('@expo/config-plugins')

/**
 * @typedef ConfigPlugin
 * @type {import('@expo/config-plugins').ConfigPlugin<T>}
 * @template T = void
*/

// please note that the BackgroundConfig currently doesn't actually enable background delivery for any types, but you
// can set it to false if you don't want the entitlement

/**
 * @typedef BackgroundConfig
 * @type {false | Partial<Record<
 *  import('./src/native-types').HKSampleTypeIdentifier,
 *  import('./src/native-types').HKUpdateFrequency
 * >>}

/**
 * @typedef InfoPlistConfig
 * @type {{
 *  NSHealthShareUsageDescription?: string | false,
 *  NSHealthUpdateUsageDescription?: string | false
 * }}
*/

/**
 * @typedef AppPluginConfig
 * @type {InfoPlistConfig & { background?: BackgroundConfig }}
*/

/**
   * @type {ConfigPlugin<{background: BackgroundConfig}>}
   */
const withEntitlementsPlugin = (
  config,
  /**
   * @type {{background: BackgroundConfig} | undefined}
   * */
  props,
) => withEntitlementsPlist(config, (config) => {
  config.modResults['com.apple.developer.healthkit'] = true

  // background is enabled by default, but possible to opt-out from
  // (haven't seen any drawbacks from having it enabled)
  if (props?.background !== false) {
    config.modResults['com.apple.developer.healthkit.background-delivery'] = true
  }

  return config
})

/**
 * @type {ConfigPlugin<InfoPlistConfig>}
 */
const withInfoPlistPlugin = (config,
  /**
  * @type {{NSHealthShareUsageDescription: string | boolean, NSHealthUpdateUsageDescription: string | boolean} | undefined}
  * */
  props) => withInfoPlist(config, (config) => {
  if (props?.NSHealthShareUsageDescription !== false) {
    config.modResults.NSHealthShareUsageDescription = props.NSHealthShareUsageDescription ?? `${config.name} wants to read your health data`
  }

  if (props?.NSHealthUpdateUsageDescription !== false) {
    config.modResults.NSHealthUpdateUsageDescription = props.NSHealthUpdateUsageDescription ?? `${config.name} wants to update your health data`
  }

  return config
})

const pkg = require('./package.json')

/**
 * @type {ConfigPlugin<AppPluginConfig>}
*/
const healthkitAppPlugin = (config, props) => withPlugins(config, [
  [withEntitlementsPlugin, props],
  [withInfoPlistPlugin, props],
])

/**
 * @type {ConfigPlugin<AppPluginConfig>}
*/
module.exports = createRunOncePlugin(healthkitAppPlugin, pkg.name, pkg.version)