react-native-nitro-modules 0.21.0 → 0.22.0

package/src/views/HybridView.ts

@@ -0,0 +1,37 @@
+import type { HybridObject } from '../HybridObject'
+
+/**
+ * Describes the languages this view will be implemented in.
+ */
+export interface ViewPlatformSpec {
+  ios?: 'swift'
+  android?: 'kotlin'
+}
+
+/**
+ * Represents a Nitro `HybridView` which is implemented in a native language
+ * like Swift or Kotlin.
+ *
+ * `HybridViews`s use the Nitro Tunnel for efficient, low-overhead JS <-> Native communication.
+ *
+ * All `HybridViews`s have a C++ Fabric View base with a backing Shadow Node.
+ *
+ * - TypeScript Properties (`name: Type`) will be React Props
+ * - TypeScript Methods (`name(): Type`) will be Ref Methods
+ *
+ * @example
+ * ```tsx
+ * export interface Camera extends HybridView {
+ *   zoom: number
+ *   flash: boolean
+ *   takePhoto(): Image
+ * }
+ * ```
+ */
+export interface HybridView<
+  Platforms extends ViewPlatformSpec = { ios: 'swift'; android: 'kotlin' },
+> extends HybridObject<Platforms> {
+  /* empty interface for now */
+}
+
+export * from './getHostComponent'

package/src/views/getHostComponent.ts

@@ -0,0 +1,26 @@
+import { Platform, type HostComponent } from 'react-native'
+// @ts-expect-error this unfortunately isn't typed or default-exported.
+import * as NativeComponentRegistry from 'react-native/Libraries/NativeComponent/NativeComponentRegistry'
+
+export interface ViewConfig<Props> {
+  uiViewClassName: string
+  supportsRawText?: boolean
+  bubblingEventTypes: Record<string, unknown>
+  directEventTypes: Record<string, unknown>
+  validAttributes: Record<keyof Props, boolean>
+}
+
+/**
+ * Finds and returns a native view (aka {@linkcode HostComponent}) via the given {@linkcode name}.
+ */
+export function getHostComponent<Props>(
+  name: string,
+  getViewConfig: () => ViewConfig<Props>
+): HostComponent<Props> {
+  if (NativeComponentRegistry == null) {
+    throw new Error(
+      `NativeComponentRegistry is not available on ${Platform.OS}!`
+    )
+  }
+  return NativeComponentRegistry.get<Props>(name, getViewConfig)
+}