@zelloptt/react-native-zello-sdk 0.1.0

package/package.json

@@ -0,0 +1,195 @@
+{
+  "name": "@zelloptt/react-native-zello-sdk",
+  "version": "0.1.0",
+  "description": "Zello SDK for React Native",
+  "source": "./src/index",
+  "main": "./lib/commonjs/index.js",
+  "module": "./lib/module/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/typescript/module/src/index.d.ts",
+        "default": "./lib/module/index.js"
+      },
+      "require": {
+        "types": "./lib/typescript/commonjs/src/index.d.ts",
+        "default": "./lib/commonjs/index.js"
+      }
+    }
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.podspec",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*",
+    "!src/docs",
+    "!src/docs/**/*"
+  ],
+  "scripts": {
+    "example": "yarn workspace react-native-zello-sdk-example",
+    "test": "jest",
+    "typecheck": "tsc",
+    "format": "eslint \"**/*.ts?(x)\" \"**/*.js?(x)\" --fix && prettier --log-level warn --write \"**/*.ts?(x)\" \"**/*.js?(x)\"",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "release": "release-it",
+    "docs": "npx typedoc --out src/docs --entryPointStrategy expand src --exclude \"src/docs/**/*\" --exclude \"src/utils/**/*\""
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zelloptt/react-native-zello-sdk/react-native-zello-sdk.git"
+  },
+  "author": "Zello, Inc. <sdk@zello.com> (https://github.com/zelloptt/react-native-zello-sdk)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/zelloptt/react-native-zello-sdk/react-native-zello-sdk/issues"
+  },
+  "homepage": "https://github.com/zelloptt/react-native-zello-sdk/react-native-zello-sdk#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^17.0.2",
+    "@evilmartians/lefthook": "^1.5.0",
+    "@react-native/eslint-config": "^0.73.1",
+    "@release-it/conventional-changelog": "^5.0.0",
+    "@types/jest": "^29.5.5",
+    "@types/lodash": "4.17.7",
+    "@types/react": "^18.2.44",
+    "commitlint": "^17.0.2",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "jest": "^29.7.0",
+    "lodash": "4.17.21",
+    "prettier": "^3.0.3",
+    "react": "18.2.0",
+    "react-native": "0.74.5",
+    "react-native-builder-bob": "^0.29.0",
+    "release-it": "^15.0.0",
+    "turbo": "^1.10.7",
+    "typescript": "^5.2.2"
+  },
+  "resolutions": {
+    "@types/react": "^18.2.44"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@3.6.1",
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "angular"
+      }
+    }
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native",
+      "prettier"
+    ],
+    "ignorePatterns": ["src/docs"],
+    "rules": {
+      "no-bitwise": "off",
+      "react/react-in-jsx-scope": "off",
+      "prettier/prettier": [
+        "error",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json",
+          "esm": true
+        }
+      ]
+    ]
+  },
+  "create-react-native-library": {
+    "type": "module-legacy",
+    "languages": "kotlin-swift",
+    "version": "0.40.0"
+  }
+}

package/react-native-zello-sdk.podspec

@@ -0,0 +1,43 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
+
+Pod::Spec.new do |s|
+  s.name         = "react-native-zello-sdk"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => min_ios_version_supported }
+  s.source       = { :git => "https://github.com/zelloptt/react-native-zello-sdk/react-native-zello-sdk.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm,swift}"
+
+  s.dependency 'ZelloSDK', '~> 0.3.1'
+
+  # Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.
+  # See https://github.com/facebook/react-native/blob/febf6b7f33fdb4904669f99d795eba4c0f95d7bf/scripts/cocoapods/new_architecture.rb#L79.
+  if respond_to?(:install_modules_dependencies, true)
+    install_modules_dependencies(s)
+  else
+    s.dependency "React-Core"
+
+    # Don't install the dependencies when we run `pod install` in the old architecture.
+    if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
+      s.compiler_flags = folly_compiler_flags + " -DRCT_NEW_ARCH_ENABLED=1"
+      s.pod_target_xcconfig    = {
+          "HEADER_SEARCH_PATHS" => "\"$(PODS_ROOT)/boost\"",
+          "OTHER_CPLUSPLUSFLAGS" => "-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1",
+          "CLANG_CXX_LANGUAGE_STANDARD" => "c++17"
+      }
+      s.dependency "React-Codegen"
+      s.dependency "RCT-Folly"
+      s.dependency "RCTRequired"
+      s.dependency "RCTTypeSafety"
+      s.dependency "ReactCommon/turbomodule/core"
+    end
+  end
+end

package/src/events/index.ts

@@ -0,0 +1,191 @@
+export enum ZelloEvent {
+  /**
+   * The connection to the Zello Work network has failed.
+   * {@link sdk.Zello.state | Zello.state} will be {@link types.ZelloConnectionState.Disconnected | ZelloConnectionState.Disconnected}.
+   * @param {@link types.ZelloConnectionState | ZelloConnectionState} state The current state of the connection.
+   * @param {@link types.ZelloConnectionError | ZelloConnectionError} error The error that caused the connection to fail.
+   */
+  CONNECT_FAILED = 'onConnectFailed',
+  /**
+   * The connection to the Zello Work network has started.
+   * {@link sdk.Zello.state | Zello.state} will be {@link types.ZelloConnectionState.Connecting | ZelloConnectionState.Connecting}.
+   * @param {@link types.ZelloConnectionState | ZelloConnectionState} state The current state of the connection.
+   * */
+  CONNECT_STARTED = 'onConnectStarted',
+  /**
+   * The connection to the Zello Work network has succeeded.
+   * {@link sdk.Zello.state | Zello.state} will be {@link types.ZelloConnectionState.Connected | ZelloConnectionState.Connected}.
+   * @param {@link types.ZelloConnectionState | ZelloConnectionState} state The current state of the connection.
+   * */
+  CONNECT_SUCCEEDED = 'onConnectSucceeded',
+  /**
+   * The connection to the Zello Work network has been disconnected.
+   * {@link sdk.Zello.state | Zello.state} will be {@link types.ZelloConnectionState.Disconnected | ZelloConnectionState.Disconnected}.
+   * @param {@link types.ZelloConnectionState | ZelloConnectionState} state The current state of the connection.
+   */
+  DISCONNECTED = 'onDisconnected',
+  /**
+   * The connection to the Zello Work network is attempting to reconnect.
+   * {@link sdk.Zello.state | Zello.state} will be {@link types.ZelloConnectionState.Reconnecting | ZelloConnectionState.Reconnecting}.
+   * @param {@link types.ZelloConnectionState | ZelloConnectionState} state The current state of the connection.
+   */
+  RECONNECTING = 'onWillReconnect',
+  /**
+   * The contact list has been updated.
+   * {@link sdk.Zello.users | Zello.users} and @{link sdk.Zello.channels | Zello.channels} will be updated.
+   * @param {@link types.ZelloUser | ZelloUser[]} users The list of users.
+   * @param {@link types.ZelloChannel | ZelloChannel[]} channels The list of channels.
+   */
+  CONTACT_LIST_UPDATED = 'onContactListUpdated',
+  /**
+   * The selected contact has changed.
+   * {@link sdk.Zello.selectedContact | Zello.selectedContact} will be updated.
+   * @param {@link types.ZelloContact | ZelloContact} contact The selected contact.
+   */
+  SELECTED_CONTACT_CHANGED = 'onSelectedContactChanged',
+  /**
+   * The account status has changed.
+   * {@link sdk.Zello.accountStatus | Zello.accountStatus} will be updated.
+   * @param {@link types.ZelloAccountStatus | ZelloAccountStatus} status The current account status.
+   */
+  ACCOUNT_STATUS_CHANGED = 'onAccountStatusChanged',
+  /**
+   * An incoming voice message has started.
+   * {@link sdk.Zello.incomingVoiceMessage | Zello.incomingVoiceMessage} will be updated.
+   * @param {@link types.ZelloIncomingVoiceMessage | ZelloIncomingVoiceMessage} voiceMessage The incoming voice message.
+   */
+  INCOMING_VOICE_MESSAGE_STARTED = 'onIncomingVoiceMessageStarted',
+  /**
+   * An incoming voice message has stopped.
+   * {@link sdk.Zello.incomingVoiceMessage | Zello.incomingVoiceMessage} will be set to undefined.
+   * @param {@link types.ZelloIncomingVoiceMessage | ZelloIncomingVoiceMessage} voiceMessage The incoming voice message.
+   */
+  INCOMING_VOICE_MESSAGE_STOPPED = 'onIncomingVoiceMessageStopped',
+  /**
+   * An outgoing voice message is connecting.
+   * {@link sdk.Zello.outgoingVoiceMessage | Zello.outgoingVoiceMessage} will be updated.
+   * @param {@link types.ZelloOutgoingVoiceMessage | ZelloOutgoingVoiceMessage} voiceMessage The outgoing voice message.
+   */
+  OUTGOING_VOICE_MESSAGE_CONNECTING = 'onOutgoingVoiceMessageConnecting',
+  /**
+   * An outgoing voice message has started.
+   * {@link sdk.Zello.outgoingVoiceMessage | Zello.outgoingVoiceMessage} will be updated.
+   * @param {@link types.ZelloOutgoingVoiceMessage | ZelloOutgoingVoiceMessage} voiceMessage The outgoing voice message.
+   */
+  OUTGOING_VOICE_MESSAGE_STARTED = 'onOutgoingVoiceMessageStarted',
+  /**
+   * An outgoing voice message has stopped.
+   * {@link sdk.Zello.outgoingVoiceMessage | Zello.outgoingVoiceMessage} will be set to undefined.
+   * @param {@link types.ZelloOutgoingVoiceMessage | ZelloOutgoingVoiceMessage} voiceMessage The outgoing voice message.
+   * @param {@link types.ZelloOutgoingVoiceMessageState} error Optional; An error that caused the outgoing voice message to stop.
+   */
+  OUTGOING_VOICE_MESSAGE_STOPPED = 'onOutgoingVoiceMessageStopped',
+  /**
+   * An incoming image message has been received.
+   * @param {@link types.ZelloImageMessage | ZelloImageMessage} imageMessage The incoming image message.
+   */
+  INCOMING_IMAGE_MESSAGE_RECEIVED = 'onIncomingImageMessage',
+  /**
+   * An outgoing image message has been sent.
+   * @param {@link types.ZelloImageMessage | ZelloImageMessage} imageMessage The outgoing image message.
+   */
+  OUTGOING_IMAGE_MESSAGE_SENT = 'onOutgoingImageMessageSent',
+  /**
+   * An outgoing image message has failed to send.
+   * @param {@link types.ZelloImageMessage | ZelloImageMessage} imageMessage The outgoing image message.
+   */
+  OUTGOING_IMAGE_MESSAGE_SEND_FAILED = 'onOutgoingImageMessageSendFailed',
+  /**
+   * An incoming alert message has been received.
+   * @param {@link types.ZelloAlertMessage | ZelloAlertMessage} alertMessage The incoming alert message.
+   */
+  INCOMING_ALERT_MESSAGE_RECEIVED = 'onIncomingAlertMessage',
+  /**
+   * An outgoing alert message has been sent.
+   * @param {@link types.ZelloAlertMessage | ZelloAlertMessage} alertMessage The outgoing alert message.
+   */
+  OUTGOING_ALERT_MESSAGE_SENT = 'onOutgoingAlertMessageSent',
+  /**
+   * An outgoing alert message has failed to send.
+   * @param {@link types.ZelloAlertMessage | ZelloAlertMessage} alertMessage The outgoing alert message.
+   */
+  OUTGOING_ALERT_MESSAGE_SEND_FAILED = 'onOutgoingAlertMessageSendFailed',
+  /**
+   * An incoming text message has been received.
+   * @param {@link types.ZelloTextMessage | ZelloTextMessage} textMessage The incoming text message.
+   */
+  INCOMING_TEXT_MESSAGE_RECEIVED = 'onIncomingTextMessage',
+  /**
+   * An outgoing text message has been sent.
+   * @param {@link types.ZelloTextMessage | ZelloTextMessage} textMessage The outgoing text message.
+   */
+  OUTGOING_TEXT_MESSAGE_SENT = 'onOutgoingTextMessageSent',
+  /**
+   * An outgoing text message has failed to send.
+   * @param {@link types.ZelloTextMessage | ZelloTextMessage} textMessage The outgoing text message.
+   */
+  OUTGOING_TEXT_MESSAGE_SEND_FAILED = 'onOutgoingTextMessageSendFailed',
+  /**
+   * An incoming location message has been received.
+   * @param {@link types.ZelloLocationMessage | ZelloLocationMessage} locationMessage The incoming location message.
+   */
+  INCOMING_LOCATION_MESSAGE_RECEIVED = 'onIncomingLocationMessage',
+  /**
+   * An outgoing location message has been sent.
+   * @param {@link types.ZelloLocationMessage | ZelloLocationMessage} locationMessage The outgoing location message.
+   */
+  OUTGOING_LOCATION_MESSAGE_SENT = 'onOutgoingLocationMessageSent',
+  /**
+   * An outgoing location message has failed to send.
+   * @param {@link types.ZelloLocationMessage | ZelloLocationMessage} locationMessage The outgoing location message.
+   */
+  OUTGOING_LOCATION_MESSAGE_SEND_FAILED = 'onOutgoingLocationMessageSendFailed',
+  /**
+   * An incoming emergency has started.
+   * {@link sdk.Zello.incomingEmergencies | Zello.incomingEmergencies} will be updated.
+   * @param {@link types.ZelloIncomingEmergency | ZelloIncomingEmergency} emergency The incoming emergency.
+   * @param {@link types.ZelloIncomingEmergency | ZelloIncomingEmergency[]} emergencies The list of incoming emergencies.
+   */
+  INCOMING_EMERGENCY_STARTED = 'onIncomingEmergencyStarted',
+  /**
+   * An incoming emergency has stopped.
+   * {@link sdk.Zello.incomingEmergencies | Zello.incomingEmergencies} will be updated.
+   * @param {@link types.ZelloIncomingEmergency | ZelloIncomingEmergency} emergency The stopped incoming emergency.
+   * @param {@link types.ZelloIncomingEmergency | ZelloIncomingEmergency[]} emergencies The list of incoming emergencies.
+   */
+  INCOMING_EMERGENCY_STOPPED = 'onIncomingEmergencyStopped',
+  /**
+   * An outgoing emergency has started.
+   * {@link sdk.Zello.outgoingEmergency | Zello.outgoingEmergency} will be updated.
+   * @param {@link types.ZelloOutgoingEmergency | ZelloOutgoingEmergency} emergency The outgoing emergency.
+   */
+  OUTGOING_EMERGENCY_STARTED = 'onOutgoingEmergencyStarted',
+  /**
+   * An outgoing emergency has stopped.
+   * {@link sdk.Zello.outgoingEmergency | Zello.outgoingEmergency} will be set to undefined.
+   * @param {@link types.ZelloOutgoingEmergency | ZelloOutgoingEmergency} emergency The stopped outgoing emergency.
+   */
+  OUTGOING_EMERGENCY_STOPPED = 'onOutgoingEmergencyStopped',
+  /**
+   * The list of recent entries has been updated.
+   * {@link sdk.Zello.recents | Zello.recents} will be updated.
+   * @param {@link types.ZelloRecentEntry | ZelloRecentEntry[]} recents The list of recent entries.
+   */
+  RECENTS_UPDATED = 'onRecentsUpdated',
+  /**
+   * The history has been updated.
+   */
+  HISTORY_UPDATED = 'onHistoryUpdated',
+  /**
+   * The history playback of a voice message has started.
+   * {@link sdk.Zello.historyVoiceMessage | Zello.historyVoiceMessage} will be updated.
+   * @param {@link types.ZelloHistoryVoiceMessage | ZelloHistoryVoiceMessage} voiceMessage The started history voice message.
+   */
+  HISTORY_PLAYBACK_STARTED = 'onHistoryPlaybackStarted',
+  /**
+   * The history playback of a voice message has stopped.
+   * {@link sdk.Zello.historyVoiceMessage | Zello.historyVoiceMessage} will be set to undefined.
+   * @param {@link types.ZelloHistoryVoiceMessage | ZelloHistoryVoiceMessage} voiceMessage The stopped history voice message.
+   */
+  HISTORY_PLAYBACK_STOPPED = 'onHistoryPlaybackStopped',
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+// noinspection JSUnusedGlobalSymbols
+
+import { Zello } from './sdk';
+
+export default Zello;
+export * from './events';
+export * from './types';
+export * from './utils';