@use-voltra/android 2.0.0 → 2.1.1

package/src/jsx/PointMark.tsx

@@ -0,0 +1,16 @@
+import { createElement } from 'react'
+
+import type { AndroidColorValue } from '../dynamic-colors.js'
+import { VOLTRA_MARK_TAG } from './BarMark.js'
+import type { ChartDataPoint } from './chart-types.js'
+
+export type PointMarkProps = {
+  data: ChartDataPoint[]
+  color?: AndroidColorValue
+  symbol?: string
+  symbolSize?: number
+}
+
+export const PointMark = (props: PointMarkProps) => createElement('VoltraPointMark', props as any)
+PointMark.displayName = 'PointMark'
+PointMark[VOLTRA_MARK_TAG] = 'point' as const

package/src/jsx/RadioButton.tsx

@@ -0,0 +1,5 @@
+import { createVoltraComponent } from './createVoltraComponent.js'
+import type { AndroidRadioButtonProps as RadioButtonProps } from './props/AndroidRadioButton.js'
+
+export type { RadioButtonProps }
+export const RadioButton = createVoltraComponent<RadioButtonProps>('AndroidRadioButton')

package/src/jsx/Row.tsx

@@ -0,0 +1,5 @@
+import { createVoltraComponent } from './createVoltraComponent.js'
+import type { AndroidRowProps as RowProps } from './props/AndroidRow.js'
+
+export type { RowProps }
+export const Row = createVoltraComponent<RowProps>('AndroidRow')

package/src/jsx/RuleMark.tsx

@@ -0,0 +1,15 @@
+import { createElement } from 'react'
+
+import type { AndroidColorValue } from '../dynamic-colors.js'
+import { VOLTRA_MARK_TAG } from './BarMark.js'
+
+export type RuleMarkProps = {
+  xValue?: string | number
+  yValue?: number
+  color?: AndroidColorValue
+  lineWidth?: number
+}
+
+export const RuleMark = (props: RuleMarkProps) => createElement('VoltraRuleMark', props as any)
+RuleMark.displayName = 'RuleMark'
+RuleMark[VOLTRA_MARK_TAG] = 'rule' as const

package/src/jsx/Scaffold.tsx

@@ -0,0 +1,5 @@
+import { createVoltraComponent } from './createVoltraComponent.js'
+import type { AndroidScaffoldProps as ScaffoldProps } from './props/AndroidScaffold.js'
+
+export type { ScaffoldProps }
+export const Scaffold = createVoltraComponent<ScaffoldProps>('AndroidScaffold')

package/src/jsx/SectorMark.tsx

@@ -0,0 +1,17 @@
+import { createElement } from 'react'
+
+import type { AndroidColorValue } from '../dynamic-colors.js'
+import { VOLTRA_MARK_TAG } from './BarMark.js'
+import type { SectorDataPoint } from './chart-types.js'
+
+export type SectorMarkProps = {
+  data: SectorDataPoint[]
+  color?: AndroidColorValue
+  innerRadius?: number
+  outerRadius?: number
+  angularInset?: number
+}
+
+export const SectorMark = (props: SectorMarkProps) => createElement('VoltraSectorMark', props as any)
+SectorMark.displayName = 'SectorMark'
+SectorMark[VOLTRA_MARK_TAG] = 'sector' as const

package/src/jsx/Spacer.tsx

@@ -0,0 +1,5 @@
+import { createVoltraComponent } from './createVoltraComponent.js'
+import type { AndroidSpacerProps as SpacerProps } from './props/AndroidSpacer.js'
+
+export type { SpacerProps }
+export const Spacer = createVoltraComponent<SpacerProps>('AndroidSpacer')

package/src/jsx/SquareIconButton.tsx

@@ -0,0 +1,14 @@
+import { createVoltraComponent } from './createVoltraComponent.js'
+import type { AndroidSquareIconButtonProps as SquareIconButtonProps } from './props/AndroidSquareIconButton.js'
+
+export type { SquareIconButtonProps }
+export const SquareIconButton = createVoltraComponent<SquareIconButtonProps>('AndroidSquareIconButton', {
+  toJSON: (props) => {
+    const { icon, ...rest } = props
+
+    return {
+      ...rest,
+      ...(icon ? { icon: JSON.stringify(icon) } : {}),
+    }
+  },
+})

package/src/jsx/Switch.tsx

@@ -0,0 +1,5 @@
+import { createVoltraComponent } from './createVoltraComponent.js'
+import type { AndroidSwitchProps as SwitchProps } from './props/AndroidSwitch.js'
+
+export type { SwitchProps }
+export const Switch = createVoltraComponent<SwitchProps>('AndroidSwitch')

package/src/jsx/Text.tsx

@@ -0,0 +1,10 @@
+import { VoltraAndroidTextStyleProp } from '../styles/types.js'
+import { createVoltraComponent } from './createVoltraComponent.js'
+import type { AndroidTextProps } from './props/AndroidText.js'
+
+// Update 'style' to use Android text style prop
+export type TextProps = Omit<AndroidTextProps, 'style'> & {
+  style?: VoltraAndroidTextStyleProp
+}
+
+export const Text = createVoltraComponent<TextProps>('AndroidText')

package/src/jsx/TitleBar.tsx

@@ -0,0 +1,18 @@
+import type { ImageSource } from './Image.js'
+import { createVoltraComponent } from './createVoltraComponent.js'
+import type { AndroidTitleBarProps } from './props/AndroidTitleBar.js'
+
+export type TitleBarProps = Omit<AndroidTitleBarProps, 'startIcon'> & {
+  startIcon: ImageSource
+}
+
+export const TitleBar = createVoltraComponent<TitleBarProps>('AndroidTitleBar', {
+  toJSON: (props) => {
+    const { startIcon, ...rest } = props
+
+    return {
+      ...rest,
+      startIcon: JSON.stringify(startIcon),
+    }
+  },
+})

package/src/jsx/baseProps.tsx

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react'
+
+import type { VoltraAndroidStyleProp } from '../styles/types.js'
+
+export type VoltraAndroidBaseProps = {
+  id?: string
+  deepLinkUrl?: string
+  style?: VoltraAndroidStyleProp
+  children?: ReactNode
+}
+
+/** Alias used by generated `props/*.ts` component types */
+export type VoltraBaseProps = VoltraAndroidBaseProps

package/src/jsx/chart-types.ts

@@ -0,0 +1,2 @@
+export type ChartDataPoint = { x: string | number; y: number; series?: string }
+export type SectorDataPoint = { value: number; category: string }

package/src/jsx/createVoltraComponent.ts

@@ -0,0 +1,2 @@
+export { createVoltraComponent, isVoltraComponent, VOLTRA_COMPONENT_TAG } from '@use-voltra/core'
+export type { VoltraComponent, VoltraComponentOptions } from '@use-voltra/core'

package/src/jsx/index.ts

@@ -0,0 +1 @@
+export * from './primitives.js'

package/src/jsx/primitives.ts

@@ -0,0 +1,28 @@
+export * from './AreaMark.js'
+export * from './BarMark.js'
+export * from './Box.js'
+export * from './Button.js'
+export * from './Chart.js'
+export * from './chart-types.js'
+export * from './CheckBox.js'
+export * from './CircleIconButton.js'
+export * from './CircularProgressIndicator.js'
+export * from './Column.js'
+export * from './FilledButton.js'
+export * from './Image.js'
+export * from './LazyColumn.js'
+export * from './LazyVerticalGrid.js'
+export * from './LinearProgressIndicator.js'
+export * from './LineMark.js'
+export * from './OutlineButton.js'
+export * from './PointMark.js'
+export * from './RadioButton.js'
+export * from './Row.js'
+export * from './RuleMark.js'
+export * from './Scaffold.js'
+export * from './SectorMark.js'
+export * from './Spacer.js'
+export * from './SquareIconButton.js'
+export * from './Switch.js'
+export * from './Text.js'
+export * from './TitleBar.js'

package/src/jsx/props/.generated

@@ -0,0 +1,15 @@
+This directory contains auto-generated Android component props type files.
+DO NOT EDIT MANUALLY.
+
+Generated from: data/components.json
+Schema version: 1.0.0
+
+To regenerate these files, run:
+  pnpm run generate
+
+Users should create component files manually using createVoltraComponent with these types.
+Example:
+  import { createVoltraComponent } from '../createVoltraComponent'
+  import type { ButtonProps } from './props/Button'
+
+  export const Button = createVoltraComponent<ButtonProps>('Button')

package/src/jsx/props/AndroidBox.ts

@@ -0,0 +1,19 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidBoxProps = VoltraBaseProps & {
+  /** Content alignment within the box */
+  contentAlignment?:
+    | 'top-start'
+    | 'top-center'
+    | 'top-end'
+    | 'center-start'
+    | 'center'
+    | 'center-end'
+    | 'bottom-start'
+    | 'bottom-center'
+    | 'bottom-end'
+}

package/src/jsx/props/AndroidButton.ts

@@ -0,0 +1,10 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidButtonProps = VoltraBaseProps & {
+  /** Whether the button is enabled */
+  enabled?: boolean
+}

package/src/jsx/props/AndroidChart.ts

@@ -0,0 +1,20 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidChartProps = VoltraBaseProps & {
+  /** Compact mark data encoded from children by toJSON */
+  marks?: string
+  /** Show or hide the x-axis */
+  xAxisVisibility?: 'automatic' | 'visible' | 'hidden'
+  /** Show or hide the y-axis */
+  yAxisVisibility?: 'automatic' | 'visible' | 'hidden'
+  /** Show or hide the chart legend */
+  legendVisibility?: 'automatic' | 'visible' | 'hidden'
+  /** Map of series name to color string */
+  foregroundStyleScale?: Record<string, any>
+  /** Enable scrolling on the given axis */
+  chartScrollableAxes?: 'horizontal' | 'vertical'
+}

package/src/jsx/props/AndroidCheckBox.ts

@@ -0,0 +1,20 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidCheckBoxProps = VoltraBaseProps & {
+  /** Unique identifier for interaction events */
+  id: string
+  /** Initial checked state */
+  checked?: boolean
+  /** Text label */
+  text?: string
+  /** Checked color */
+  checkedColor?: string
+  /** Unchecked color */
+  uncheckedColor?: string
+  /** Maximum lines for text */
+  maxLines?: number
+}

package/src/jsx/props/AndroidCircleIconButton.ts

@@ -0,0 +1,18 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidCircleIconButtonProps = VoltraBaseProps & {
+  /** Icon source */
+  icon: Record<string, any>
+  /** Accessibility description */
+  contentDescription?: string
+  /** Whether the button is enabled */
+  enabled?: boolean
+  /** Background color */
+  backgroundColor?: string
+  /** Icon color */
+  contentColor?: string
+}

package/src/jsx/props/AndroidCircularProgressIndicator.ts

@@ -0,0 +1,10 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidCircularProgressIndicatorProps = VoltraBaseProps & {
+  /** Progress color */
+  color?: string
+}

package/src/jsx/props/AndroidColumn.ts

@@ -0,0 +1,12 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidColumnProps = VoltraBaseProps & {
+  /** Horizontal alignment of children */
+  horizontalAlignment?: 'start' | 'center-horizontally' | 'end'
+  /** Vertical alignment of children */
+  verticalAlignment?: 'top' | 'center-vertically' | 'bottom'
+}

package/src/jsx/props/AndroidFilledButton.ts

@@ -0,0 +1,20 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidFilledButtonProps = VoltraBaseProps & {
+  /** Text to display */
+  text: string
+  /** Whether the button is enabled */
+  enabled?: boolean
+  /** Optional icon */
+  icon?: Record<string, any>
+  /** Background color */
+  backgroundColor?: string
+  /** Text/icon color */
+  contentColor?: string
+  /** Maximum lines for text */
+  maxLines?: number
+}

package/src/jsx/props/AndroidImage.ts

@@ -0,0 +1,26 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { ReactNode } from 'react'
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidImageProps = VoltraBaseProps & {
+  /** Image source */
+  source: Record<string, any>
+  /** Resizing mode */
+  resizeMode?: 'cover' | 'contain' | 'stretch' | 'repeat' | 'center'
+  /** Accessibility description */
+  contentDescription?: string
+  /** How the image should scale within its bounds */
+  contentScale?: 'crop' | 'cover' | 'fit' | 'contain' | 'fill-bounds' | 'stretch'
+  /** Image opacity from 0 to 1 */
+  alpha?: number
+  /** Tint color filter */
+  colorFilter?: string
+  /** Legacy tint color alias for colorFilter */
+  tintColor?: string
+  /** Custom fallback content rendered when the image is missing */
+  fallback?: ReactNode
+}

package/src/jsx/props/AndroidLazyColumn.ts

@@ -0,0 +1,10 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidLazyColumnProps = VoltraBaseProps & {
+  /** Horizontal alignment of children */
+  horizontalAlignment?: 'start' | 'center-horizontally' | 'end'
+}

package/src/jsx/props/AndroidLazyVerticalGrid.ts

@@ -0,0 +1,12 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidLazyVerticalGridProps = VoltraBaseProps & {
+  /** Number of fixed grid columns */
+  columns?: number
+  /** Horizontal alignment of children */
+  horizontalAlignment?: 'start' | 'center-horizontally' | 'end'
+}

package/src/jsx/props/AndroidLinearProgressIndicator.ts

@@ -0,0 +1,14 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidLinearProgressIndicatorProps = VoltraBaseProps & {
+  /** Progress value from 0 to 1 */
+  progress?: number
+  /** Progress color */
+  color?: string
+  /** Track background color */
+  backgroundColor?: string
+}

package/src/jsx/props/AndroidOutlineButton.ts

@@ -0,0 +1,18 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidOutlineButtonProps = VoltraBaseProps & {
+  /** Text to display */
+  text: string
+  /** Whether the button is enabled */
+  enabled?: boolean
+  /** Optional icon */
+  icon?: Record<string, any>
+  /** Text/icon color */
+  contentColor?: string
+  /** Maximum lines for text */
+  maxLines?: number
+}

package/src/jsx/props/AndroidRadioButton.ts

@@ -0,0 +1,22 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidRadioButtonProps = VoltraBaseProps & {
+  /** Unique identifier for interaction events */
+  id: string
+  /** Initial checked state */
+  checked?: boolean
+  /** Whether the radio button is enabled */
+  enabled?: boolean
+  /** Text label */
+  text?: string
+  /** Checked color */
+  checkedColor?: string
+  /** Unchecked color */
+  uncheckedColor?: string
+  /** Maximum lines for text */
+  maxLines?: number
+}

package/src/jsx/props/AndroidRow.ts

@@ -0,0 +1,12 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidRowProps = VoltraBaseProps & {
+  /** Horizontal alignment of children */
+  horizontalAlignment?: 'start' | 'center-horizontally' | 'end'
+  /** Vertical alignment of children */
+  verticalAlignment?: 'top' | 'center-vertically' | 'bottom'
+}

package/src/jsx/props/AndroidScaffold.ts

@@ -0,0 +1,12 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidScaffoldProps = VoltraBaseProps & {
+  /** Background color */
+  backgroundColor?: string
+  /** Horizontal padding */
+  horizontalPadding?: number
+}

package/src/jsx/props/AndroidSpacer.ts

@@ -0,0 +1,7 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidSpacerProps = VoltraBaseProps

package/src/jsx/props/AndroidSquareIconButton.ts

@@ -0,0 +1,18 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidSquareIconButtonProps = VoltraBaseProps & {
+  /** Icon source */
+  icon: Record<string, any>
+  /** Accessibility description */
+  contentDescription?: string
+  /** Whether the button is enabled */
+  enabled?: boolean
+  /** Background color */
+  backgroundColor?: string
+  /** Icon color */
+  contentColor?: string
+}

package/src/jsx/props/AndroidSwitch.ts

@@ -0,0 +1,24 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidSwitchProps = VoltraBaseProps & {
+  /** Unique identifier for interaction events */
+  id: string
+  /** Initial checked state */
+  checked?: boolean
+  /** Text label */
+  text?: string
+  /** Checked thumb color */
+  thumbCheckedColor?: string
+  /** Unchecked thumb color */
+  thumbUncheckedColor?: string
+  /** Checked track color */
+  trackCheckedColor?: string
+  /** Unchecked track color */
+  trackUncheckedColor?: string
+  /** Maximum lines for text */
+  maxLines?: number
+}

package/src/jsx/props/AndroidText.ts

@@ -0,0 +1,14 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidTextProps = VoltraBaseProps & {
+  /** Text color */
+  color?: string
+  /** Font size */
+  fontSize?: number
+  /** Maximum lines */
+  maxLines?: number
+}

package/src/jsx/props/AndroidTitleBar.ts

@@ -0,0 +1,18 @@
+// 🤖 AUTO-GENERATED from data/components.json
+// DO NOT EDIT MANUALLY - Changes will be overwritten
+// Schema version: 1.0.0
+
+import type { VoltraBaseProps } from '../baseProps'
+
+export type AndroidTitleBarProps = VoltraBaseProps & {
+  /** Title text */
+  title: string
+  /** Leading icon */
+  startIcon: Record<string, any>
+  /** Leading icon tint color */
+  iconColor?: string
+  /** Title text color */
+  textColor?: string
+  /** Title font family */
+  fontFamily?: 'monospace' | 'serif' | 'sans-serif' | 'cursive'
+}

package/src/live-update/renderer.ts

@@ -0,0 +1,36 @@
+import { getAndroidComponentId } from '../payload/component-ids.js'
+import type { ComponentRegistry } from '../renderer/index.js'
+import { createVoltraRenderer } from '../renderer/index.js'
+import type { AndroidLiveUpdateJson, AndroidLiveUpdateVariants } from './types.js'
+
+const androidComponentRegistry: ComponentRegistry = {
+  getComponentId: (name: string) => getAndroidComponentId(name),
+}
+
+export const renderAndroidLiveUpdateToJson = (variants: AndroidLiveUpdateVariants): AndroidLiveUpdateJson => {
+  const renderer = createVoltraRenderer(androidComponentRegistry)
+
+  if (variants.collapsed) {
+    renderer.addRootNode('collapsed', variants.collapsed)
+  }
+
+  if (variants.expanded) {
+    renderer.addRootNode('expanded', variants.expanded)
+  }
+
+  const result = renderer.render() as AndroidLiveUpdateJson
+
+  if (variants.smallIcon) {
+    result.smallIcon = variants.smallIcon
+  }
+
+  if (variants.channelId) {
+    result.channelId = variants.channelId
+  }
+
+  return result
+}
+
+export const renderAndroidLiveUpdateToString = (variants: AndroidLiveUpdateVariants): string => {
+  return JSON.stringify(renderAndroidLiveUpdateToJson(variants))
+}

package/src/live-update/types.ts

@@ -0,0 +1,44 @@
+import type { ReactNode } from 'react'
+
+import type { VoltraNodeJson } from '../types.js'
+
+export type AndroidLiveUpdateVariants = {
+  collapsed?: ReactNode
+  expanded?: ReactNode
+  smallIcon?: string
+  channelId?: string
+}
+
+export type AndroidLiveUpdateVariantsJson = {
+  v: number
+  s?: Record<string, unknown>[]
+  e?: VoltraNodeJson[]
+  collapsed?: VoltraNodeJson
+  expanded?: VoltraNodeJson
+  smallIcon?: string
+  channelId?: string
+}
+
+export type AndroidLiveUpdateJson = AndroidLiveUpdateVariantsJson
+
+export type StartAndroidLiveUpdateOptions = {
+  updateName?: string
+  channelId?: string
+}
+
+export type UpdateAndroidLiveUpdateOptions = {
+  // Currently no additional options, but keeping for future extensibility
+}
+
+export type UseAndroidLiveUpdateOptions = {
+  updateName?: string
+  autoStart?: boolean
+  autoUpdate?: boolean
+}
+
+export type UseAndroidLiveUpdateResult = {
+  start: (options?: StartAndroidLiveUpdateOptions) => Promise<void>
+  update: (options?: UpdateAndroidLiveUpdateOptions) => Promise<void>
+  end: () => Promise<void>
+  isActive: boolean
+}