cobrowse-sdk-react-native 2.13.0 → 2.15.0

package/js/useSession.js

@@ -0,0 +1,33 @@
+import { useEffect, useState } from 'react'
+import CobrowseIO from './CobrowseIO'
+
+export function useSession () {
+  const [session, setSession] = useState(null)
+
+  // initial value
+  useEffect(() => {
+    let isMounted = true
+    const getSession = async () => {
+      const session = await CobrowseIO.currentSession()
+
+      if (isMounted) {
+        setSession(session)
+      }
+    }
+
+    getSession()
+
+    return () => {
+      isMounted = false
+    }
+  }, [])
+
+  // listen to session updates
+  useEffect(() => {
+    const subscription = CobrowseIO.addListener(CobrowseIO.SESSION_UPDATED, setSession)
+
+    return () => subscription.remove()
+  }, [])
+
+  return session
+}

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "cobrowse-sdk-react-native",
-  "version": "2.13.0",
+  "version": "2.15.0",
   "description": "Cobrowse SDK for React Native",
   "main": "js/index.js",
   "types": "ts/index.d.ts",
   "scripts": {
-    "lint-fix": "ts-standard ts/*.d.ts --fix",
-    "start:dev": "nodemon --exec ./scripts/copy.sh"
+    "lint": "ts-standard",
+    "lint:fix": "npm run lint -- --fix",
+    "start:dev": "nodemon --exec ./scripts/copy.sh",
+    "test:types": "tsc -p tsconfig.eslint.json --noEmit"
   },
   "author": {
     "name": "Andy Pritchard"
@@ -27,17 +29,23 @@
   ],
   "license": "Apache-2.0",
   "optionalDependencies": {
-    "@types/react": "^18.0.18",
-    "@types/react-native": "^0.69.6"
+    "@types/react": "^18.0.24",
+    "@types/react-native": "^0.70.6"
   },
   "dependencies": {
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@types/react": "^18.0.18",
-    "@types/react-native": "^0.69.6",
-    "nodemon": "^2.0.19",
-    "ts-standard": "^11.0.0",
-    "typescript": "^4.8.2"
+    "@types/react": "^18.0.24",
+    "@types/react-native": "^0.70.6",
+    "nodemon": "^2.0.20",
+    "ts-standard": "^12.0.2",
+    "typescript": "^4.8.4"
+  },
+  "ts-standard": {
+    "project": "tsconfig.eslint.json",
+    "env": [
+      "jest"
+    ]
   }
 }

package/ts/CBIOBroadcastPickerView.d.ts

@@ -0,0 +1,8 @@
+import type { ReactElement } from 'react'
+import type { ViewProps } from 'react-native'
+
+type Props = Readonly<{
+  buttonColor?: string
+}> & ViewProps
+
+export default function (props: Props): ReactElement | null

package/ts/CobrowseView.d.ts

@@ -1,5 +1,5 @@
-import type { Component } from 'react'
-import type { View, Text } from 'react-native'
+import type { Component, ReactElement } from 'react'
+import type { ViewProps, TextProps } from 'react-native'
 
 export default class CobrowseView extends Component {
   componentDidMount (): Promise<void>
@@ -8,13 +8,13 @@ export default class CobrowseView extends Component {
 
   endSession (): Promise<void>
 
-  renderError (): Text
+  renderError (): ReactElement<TextProps>
 
-  renderCode (): View
+  renderCode (): ReactElement<ViewProps>
 
-  renderManageSession (): View
+  renderManageSession (): ReactElement<ViewProps>
 
-  renderContent (): Text | View
+  renderContent (): ReactElement<TextProps | ViewProps>
 
-  render (): View
+  render (): ReactElement<ViewProps>
 }

package/ts/Redacted.d.ts

@@ -1,8 +1,8 @@
 import type { ReactNode, ReactElement } from 'react'
 
 type Props = Readonly<{}> &
-  Readonly<{
-    children?: ReactNode | undefined
-  }>
+Readonly<{
+  children?: ReactNode | undefined
+}>
 
 export default function (props: Props): ReactElement | null

package/ts/Session.d.ts

@@ -7,6 +7,8 @@ export type SessionState = 'active' | 'authorizing' | 'ended' | 'pending'
 
 export type RemoteControlState = 'on' | 'requested' | 'rejected' | 'off'
 
+export type FullDeviceState = 'on' | 'requested' | 'rejected' | 'off'
+
 export interface Agent {
   id: string
   name: string
@@ -50,7 +52,7 @@ export default class Session {
 
   isEnded (): boolean
 
-  setFullDevice (state: boolean): Promise<void>
+  setFullDevice (state: boolean | FullDeviceState): Promise<void>
 
   setRemoteControl (state: RemoteControlState): Promise<void>
 }

package/ts/Unredacted.d.ts

@@ -3,12 +3,13 @@ import { View, ScrollView, Text, Image, FlatList, SectionList } from 'react-nati
 
 export function useUnredaction<
   T = View | ScrollView | Text | Image | FlatList | SectionList
->(shouldWarnUnhandledRefs?: boolean , componentName?: string): (elem: T) => void
+> (shouldWarnUnhandledRefs?: boolean, componentName?: string): (elem: T) => void
 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 type ForwardedRefType<T, P> = typeof React.forwardRef
 
 // HOC for adding unredaction to a whole component class
-export function unredact(Component: ReactElement): ForwardedRefType<View, Record<string, unknown>>
+export function unredact (Component: ReactElement): ForwardedRefType<View, Record<string, unknown>>
 
 // also expose a basic Component based on a View
 declare const Unredacted: ForwardRefRenderFunction<View, Record<string, unknown>>

package/ts/index.d.ts

@@ -4,3 +4,4 @@ export { default as Redacted } from './Redacted'
 export { default as SessionControl } from './SessionControl'
 export { default as Unredacted, unredact, useUnredaction } from './Unredacted'
 export { default as CobrowseAccessibilityService } from './CobrowseAccessibilityService'
+export { useSession } from './useSession'

package/ts/useSession.d.ts

@@ -0,0 +1,3 @@
+import Session from './Session'
+
+export function useSession (): Session | null