@use-voltra/ios-client 1.4.1 → 2.0.0-rc.2

package/ios/ui/Voltra.swift

@@ -0,0 +1,86 @@
+import SwiftUI
+
+public enum VoltraWidgetRenderingMode {
+  case fullColor
+  case accented
+  case vibrant
+  case unknown
+}
+
+public struct VoltraWidgetEnvironment {
+  public let isHomeScreenWidget: Bool
+  public let renderingMode: VoltraWidgetRenderingMode
+  public let showsContainerBackground: Bool
+
+  var usesReducedBackgroundPresentation: Bool {
+    renderingMode != .fullColor || !showsContainerBackground
+  }
+
+  var suppressesDecorativeContainerEffects: Bool {
+    isHomeScreenWidget && usesReducedBackgroundPresentation
+  }
+
+  public init(
+    isHomeScreenWidget: Bool,
+    renderingMode: VoltraWidgetRenderingMode,
+    showsContainerBackground: Bool
+  ) {
+    self.isHomeScreenWidget = isHomeScreenWidget
+    self.renderingMode = renderingMode
+    self.showsContainerBackground = showsContainerBackground
+  }
+}
+
+struct VoltraEnvironment {
+  /// Activity ID for Live Activity interactions
+  let activityId: String
+
+  /// Widget-specific presentation context, when rendering inside WidgetKit.
+  let widget: VoltraWidgetEnvironment?
+}
+
+public struct Voltra: View {
+  /// Pre-parsed root node
+  public var root: VoltraNode
+
+  /// Activity ID for Live Activity interactions
+  public var activityId: String
+
+  /// Widget-specific presentation context, when rendering inside WidgetKit.
+  var widget: VoltraWidgetEnvironment?
+
+  /// Initialize Voltra
+  ///
+  /// - Parameter root: Pre-parsed root VoltraNode
+  /// - Parameter callback: Handler for element interactions
+  /// - Parameter activityId: Activity ID for Live Activity interactions
+  /// - Parameter widget: Widget rendering context used to adapt Voltra output for WidgetKit surfaces
+  public init(root: VoltraNode, activityId: String, widget: VoltraWidgetEnvironment? = nil) {
+    self.root = root
+    self.activityId = activityId
+    self.widget = widget
+  }
+
+  /// Generated body for SwiftUI
+  public var body: some View {
+    root
+      .environment(\.voltraEnvironment, VoltraEnvironment(
+        activityId: activityId,
+        widget: widget
+      ))
+  }
+}
+
+private struct VoltraEnvironmentKey: EnvironmentKey {
+  static let defaultValue: VoltraEnvironment = .init(
+    activityId: "",
+    widget: nil
+  )
+}
+
+extension EnvironmentValues {
+  var voltraEnvironment: VoltraEnvironment {
+    get { self[VoltraEnvironmentKey.self] }
+    set { self[VoltraEnvironmentKey.self] = newValue }
+  }
+}

package/package.json

@@ -1,31 +1,80 @@
 {
   "name": "@use-voltra/ios-client",
-  "version": "1.4.1",
+  "version": "2.0.0-rc.2",
   "description": "Client-only Voltra APIs for iOS",
-  "main": "build/cjs/index.js",
-  "module": "build/esm/index.js",
-  "types": "build/types/index.d.ts",
+  "main": "./build/commonjs/index.js",
+  "module": "./build/module/index.js",
+  "types": "./build/typescript/module/index.d.ts",
   "exports": {
     ".": {
-      "types": "./build/types/index.d.ts",
-      "require": "./build/cjs/index.js",
-      "import": "./build/esm/index.js",
-      "default": "./build/esm/index.js"
+      "source": "./src/index.ts",
+      "import": {
+        "types": "./build/typescript/module/index.d.ts",
+        "default": "./build/module/index.js"
+      },
+      "require": {
+        "types": "./build/typescript/commonjs/index.d.ts",
+        "default": "./build/commonjs/index.js"
+      },
+      "default": "./build/module/index.js"
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./app.plugin.js": "./expo-plugin/app.plugin.js"
   },
   "files": [
     "build",
-    "README.md"
+    "expo-plugin",
+    "ios",
+    "src",
+    "!ios/.build",
+    "Voltra.podspec",
+    "README.md",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
   ],
   "scripts": {
-    "build": "node ../../scripts/build-package.mjs packages/ios-client",
-    "clean": "rm -rf build",
-    "lint": "oxlint src",
-    "typecheck": "tsc -p tsconfig.typecheck.json --noEmit"
+    "build": "npm run clean && npm run build:expo-plugin && bob build",
+    "build:expo-plugin": "node ../../scripts/build-package.mjs packages/ios-client/expo-plugin",
+    "clean": "rm -rf build && npm run clean:expo-plugin",
+    "clean:expo-plugin": "rm -rf expo-plugin/build",
+    "format:check": "npm run format:swift:check",
+    "format:fix": "npm run format:swift:fix",
+    "format:swift:check": "swiftformat --lint ios",
+    "format:swift:fix": "swiftformat ios",
+    "lint": "oxlint src expo-plugin/src",
+    "typecheck": "tsc -p tsconfig.typecheck.json --noEmit && tsc -p expo-plugin/tsconfig.typecheck.json --noEmit",
+    "test": "jest --config expo-plugin/jest.config.js",
+    "test:swift": "cd ios && swift test"
   },
   "dependencies": {
-    "@use-voltra/ios": "1.4.1"
+    "@babel/core": "^7.27.4",
+    "@expo/config-plugins": "~10.1.2",
+    "@expo/plist": "^0.3.5",
+    "@use-voltra/expo-plugin": "2.0.0-rc.2",
+    "@use-voltra/ios": "2.0.0-rc.2",
+    "dedent": "^1.7.1",
+    "xcode": "^3.0.1"
+  },
+  "peerDependencies": {
+    "expo": "*",
+    "react": "*",
+    "react-native": "*"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.19.25",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.3.4"
   },
   "keywords": [
     "react-native",
@@ -45,9 +94,46 @@
   },
   "license": "MIT",
   "homepage": "https://use-voltra.dev",
-  "peerDependencies": {
-    "expo": "*",
-    "react": "*",
-    "react-native": "*"
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "build",
+    "exclude": "**/{__tests__,__fixtures__,__mocks__,__rsc_tests__}/**",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true,
+          "sourceMaps": true
+        }
+      ],
+      [
+        "commonjs",
+        {
+          "esm": true,
+          "sourceMaps": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "VoltraSpec",
+    "type": "all",
+    "jsSrcsDir": "src",
+    "ios": {
+      "modulesProvider": {
+        "NativeVoltra": "NativeVoltra"
+      },
+      "components": {
+        "VoltraView": {
+          "className": "VoltraViewComponentView"
+        }
+      }
+    }
   }
 }

package/src/VoltraModule.ts

@@ -0,0 +1,2 @@
+export type { Spec as VoltraIOSModuleSpec } from './native/NativeVoltra'
+export { getNativeVoltra } from './native/NativeVoltra'

package/src/components/VoltraLiveActivityPreview.tsx

@@ -0,0 +1,29 @@
+import React from 'react'
+import { type StyleProp, type ViewStyle } from 'react-native'
+
+import { VoltraView, type VoltraViewProps } from './VoltraView.js'
+
+const LOCK_SCREEN_DIMENSIONS = {
+  width: 364,
+  height: 160,
+}
+
+export type VoltraLiveActivityPreviewProps = Omit<VoltraViewProps, 'style'> & {
+  style?: StyleProp<ViewStyle>
+}
+
+export function VoltraLiveActivityPreview({ style, children, ...voltraViewProps }: VoltraLiveActivityPreviewProps) {
+  const previewStyle: StyleProp<ViewStyle> = [
+    {
+      width: LOCK_SCREEN_DIMENSIONS.width,
+      height: LOCK_SCREEN_DIMENSIONS.height,
+    },
+    style,
+  ]
+
+  return (
+    <VoltraView {...voltraViewProps} style={previewStyle}>
+      {children}
+    </VoltraView>
+  )
+}

package/src/components/VoltraView.tsx

@@ -0,0 +1,49 @@
+import React, { type ReactNode, useEffect, useMemo } from 'react'
+import { type StyleProp, type ViewStyle } from 'react-native'
+
+import { renderVoltraVariantToJson } from '@use-voltra/ios'
+
+import VoltraFabricView from '../native/VoltraRNNativeComponent'
+
+import { addVoltraListener, type VoltraInteractionEvent } from '../events.js'
+
+const generateViewId = () => `voltra-view-${Date.now()}-${Math.random().toString(36).substring(2, 9)}`
+
+const voltraViewStyle: ViewStyle = {
+  flex: 1,
+}
+
+export type VoltraViewProps = {
+  id?: string
+  children: ReactNode
+  style?: StyleProp<ViewStyle>
+  onInteraction?: (event: VoltraInteractionEvent) => void
+  testID?: string
+}
+
+export function VoltraView({ id, children, style, onInteraction, testID }: VoltraViewProps) {
+  const viewId = useMemo(() => id || generateViewId(), [id])
+
+  const json = renderVoltraVariantToJson(children)
+  const payload = JSON.stringify(json)
+
+  useEffect(() => {
+    if (!onInteraction) return
+
+    const subscription = addVoltraListener('interaction', (event) => {
+      if (event.source === viewId) {
+        onInteraction({
+          type: 'interaction',
+          source: event.source,
+          timestamp: event.timestamp,
+          identifier: event.identifier,
+          payload: event.payload,
+        })
+      }
+    })
+
+    return () => subscription.remove()
+  }, [viewId, onInteraction])
+
+  return <VoltraFabricView payload={payload} style={[voltraViewStyle, style]} testID={testID} viewId={viewId} />
+}

package/src/components/VoltraWidgetPreview.tsx

@@ -0,0 +1,38 @@
+import React from 'react'
+import { type StyleProp, type ViewStyle } from 'react-native'
+
+import type { WidgetFamily } from '@use-voltra/ios'
+
+import { VoltraView, type VoltraViewProps } from './VoltraView.js'
+
+const WIDGET_DIMENSIONS: Record<WidgetFamily, { width: number; height: number }> = {
+  systemSmall: { width: 170, height: 170 },
+  systemMedium: { width: 364, height: 170 },
+  systemLarge: { width: 364, height: 382 },
+  systemExtraLarge: { width: 364, height: 768 },
+  accessoryCircular: { width: 76, height: 76 },
+  accessoryRectangular: { width: 172, height: 76 },
+  accessoryInline: { width: 172, height: 40 },
+}
+
+export type VoltraWidgetPreviewProps = Omit<VoltraViewProps, 'style'> & {
+  family: WidgetFamily
+  style?: StyleProp<ViewStyle>
+}
+
+export function VoltraWidgetPreview({ family, style, children, ...voltraViewProps }: VoltraWidgetPreviewProps) {
+  const dimensions = WIDGET_DIMENSIONS[family]
+  const previewStyle: StyleProp<ViewStyle> = [
+    {
+      width: dimensions.width,
+      height: dimensions.height,
+    },
+    style,
+  ]
+
+  return (
+    <VoltraView {...voltraViewProps} style={previewStyle}>
+      {children}
+    </VoltraView>
+  )
+}

package/src/events.ts

@@ -0,0 +1,70 @@
+import { Platform } from 'react-native'
+
+import type { EventSubscription } from './types.js'
+import { getNativeVoltra } from './VoltraModule.js'
+
+export type BasicVoltraEvent = {
+  source: string
+  timestamp: number
+}
+
+export type VoltraActivityState = 'active' | 'dismissed' | 'pending' | 'stale' | 'ended' | string
+export type VoltraActivityTokenReceivedEvent = BasicVoltraEvent & {
+  type: 'activityTokenReceived'
+  activityName: string
+  pushToken: string
+}
+export type VoltraActivityPushToStartTokenReceivedEvent = BasicVoltraEvent & {
+  type: 'activityPushToStartTokenReceived'
+  pushToStartToken: string
+}
+export type VoltraActivityUpdateEvent = BasicVoltraEvent & {
+  type: 'stateChange'
+  activityName: string
+  activityState: VoltraActivityState
+}
+
+export type VoltraInteractionEvent = BasicVoltraEvent & {
+  type: 'interaction'
+  identifier: string
+  payload: string
+}
+
+const noopSubscription: EventSubscription = {
+  remove: () => {},
+}
+
+export type VoltraEventMap = {
+  activityTokenReceived: VoltraActivityTokenReceivedEvent
+  activityPushToStartTokenReceived: VoltraActivityPushToStartTokenReceivedEvent
+  stateChange: VoltraActivityUpdateEvent
+  interaction: VoltraInteractionEvent
+}
+
+export function addVoltraListener<K extends keyof VoltraEventMap>(
+  event: K,
+  listener: (event: VoltraEventMap[K]) => void
+): EventSubscription {
+  if (Platform.OS !== 'ios') {
+    console.warn(`[Voltra] Event '${event}' is only supported on iOS. Returning no-op subscription.`)
+    return noopSubscription
+  }
+
+  const voltraModule = getNativeVoltra()
+
+  switch (event) {
+    case 'activityTokenReceived':
+      return voltraModule.onActivityTokenReceived(listener as (arg: VoltraActivityTokenReceivedEvent) => void)
+    case 'activityPushToStartTokenReceived':
+      return voltraModule.onActivityPushToStartTokenReceived(
+        listener as (arg: VoltraActivityPushToStartTokenReceivedEvent) => void
+      )
+    case 'stateChange':
+      return voltraModule.onStateChanged(listener as (arg: VoltraActivityUpdateEvent) => void)
+    case 'interaction':
+      return voltraModule.onInteraction(listener as (arg: VoltraInteractionEvent) => void)
+    default:
+      console.warn(`[Voltra] Event '${event}' is not supported. Returning no-op subscription.`)
+      return noopSubscription
+  }
+}

package/src/helpers.ts

@@ -0,0 +1,21 @@
+import { Platform } from 'react-native'
+
+import { getNativeVoltra } from './VoltraModule.js'
+
+export function isGlassSupported(): boolean {
+  if (Platform.OS !== 'ios') return false
+  const v: any = Platform.Version
+  let major = 0
+  if (typeof v === 'string') {
+    const m = parseInt(v.split('.')[0] || '0', 10)
+    if (!Number.isNaN(m)) major = m
+  } else if (typeof v === 'number') {
+    major = Math.floor(v)
+  }
+  return major >= 26
+}
+
+export function isHeadless(): boolean {
+  if (Platform.OS !== 'ios') return false
+  return getNativeVoltra().isHeadless?.() ?? false
+}

package/src/index.ts

@@ -0,0 +1,52 @@
+export { Voltra } from '@use-voltra/ios'
+export {
+  VoltraLiveActivityPreview,
+  type VoltraLiveActivityPreviewProps,
+} from './components/VoltraLiveActivityPreview.js'
+export { VoltraView, type VoltraViewProps } from './components/VoltraView.js'
+export { VoltraWidgetPreview, type VoltraWidgetPreviewProps } from './components/VoltraWidgetPreview.js'
+export * from './events.js'
+export { isGlassSupported, isHeadless } from './helpers.js'
+export { logger, type VoltraLogLevel } from './logger.js'
+export {
+  endAllLiveActivities,
+  type EndLiveActivityOptions,
+  isLiveActivityActive,
+  type SharedLiveActivityOptions,
+  startLiveActivity,
+  type StartLiveActivityOptions,
+  stopLiveActivity,
+  updateLiveActivity,
+  type UpdateLiveActivityOptions,
+  useLiveActivity,
+  type UseLiveActivityOptions,
+  type UseLiveActivityResult,
+} from './live-activity/api.js'
+export type { DismissalPolicy, LiveActivityVariants } from '@use-voltra/ios'
+export {
+  clearPreloadedImages,
+  type PreloadImageOptions,
+  preloadImages,
+  type PreloadImagesResult,
+  reloadLiveActivities,
+} from './preload.js'
+export { assertRunningOnApple } from './utils/assertRunningOnApple.js'
+export { useUpdateOnHMR } from './utils/useUpdateOnHMR.js'
+export * from './utils/helpers.js'
+export type { VoltraElementJson, VoltraNodeJson } from './types.js'
+export {
+  clearWidgetServerCredentials,
+  setWidgetServerCredentials,
+  type WidgetServerCredentials,
+} from './widgets/server-credentials.js'
+export type { WidgetFamily, WidgetInfo, WidgetVariants } from '@use-voltra/ios'
+export {
+  clearAllWidgets,
+  clearWidget,
+  getActiveWidgets,
+  reloadWidgets,
+  type ScheduledWidgetEntry,
+  scheduleWidget,
+  updateWidget,
+  type UpdateWidgetOptions,
+} from './widgets/widget-api.js'