Merge pull request #36 from PlayerData/assorted-small-tweaks

chore(deps): update the workflow and docs to include type checking

Author: Donald47

.github/workflows/build_and_release.yml

@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@v1
 
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: 16
 

.github/workflows/lint.yml

@@ -13,12 +13,18 @@ jobs:
         uses: actions/checkout@v1
 
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: 16
 
-      - name: Install dependencies
+      - name: Install package dependencies
         run: yarn install
+      
+      - name: Install example app dependencies
+        run: yarn example install
 
       - name: Lint
         run: yarn lint
+
+      - name: Typecheck
+        run: yarn typecheck

README.md

@@ -59,7 +59,7 @@ yarn example ios
 Make sure your code passes TypeScript and ESLint. Run the following to verify:
 
 ```sh
-yarn typescript
+yarn typecheck
 yarn lint
 ```
 

example/ios/Podfile.lock

@@ -224,7 +224,7 @@ PODS:
   - react-native-ble-plx (2.0.3):
     - MultiplatformBleAdapter (= 0.1.9)
     - React-Core
-  - react-native-document-picker (5.3.0):
+  - react-native-document-picker (9.0.1):
     - React-Core
   - react-native-get-random-values (1.8.0):
     - React-Core
@@ -440,7 +440,7 @@ SPEC CHECKSUMS:
   React-jsinspector: 218a2503198ff28a085f8e16622a8d8f507c8019
   React-logger: f79dd3cc0f9b44f5611c6c7862badd891a862cf8
   react-native-ble-plx: f10240444452dfb2d2a13a0e4f58d7783e92d76e
-  react-native-document-picker: 226068006be4c52f8ef7f32d855ee025a12e9e64
+  react-native-document-picker: 2b8f18667caee73a96708a82b284a4f40b30a156
   react-native-get-random-values: a6ea6a8a65dc93e96e24a11105b1a9c8cfe1d72a
   react-native-mcu-manager: 0b8b4258106b8a3c2888a1521a6ae3d5634ba463
   React-perflogger: 30ab8d6db10e175626069e742eead3ebe8f24fd5
@@ -460,4 +460,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: c253f0de47435bd522e26588156f2650ee8d47f0
 
-COCOAPODS: 1.11.3
+COCOAPODS: 1.12.0

example/package.json

@@ -14,12 +14,13 @@
     "react": "18.1.0",
     "react-native": "0.68.1",
     "react-native-ble-plx": "^2.0.2",
-    "react-native-document-picker": "^5.0.2",
+    "react-native-document-picker": "9.0.1",
     "react-native-get-random-values": "^1.8.0"
   },
   "devDependencies": {
     "@babel/core": "^7.12.10",
     "@babel/runtime": "^7.12.5",
+    "@types/lodash": "^4.14.186",
     "@types/react-native": "^0.67.6",
     "babel-plugin-module-resolver": "^4.1.0",
     "metro-react-native-babel-preset": "^0.70.2",

example/src/useFilePicker.ts

@@ -1,8 +1,8 @@
 import { useState } from 'react';
 import { Platform } from 'react-native';
-import DocumentPicker, {
-  DocumentPickerOptions,
-} from 'react-native-document-picker';
+import DocumentPicker from 'react-native-document-picker';
+
+import type { DocumentPickerResponse } from 'react-native-document-picker';
 
 export interface SelectedFile {
   uri: string;
@@ -17,41 +17,34 @@ const useFilePicker = (): {
   const [selectedFile, setSelectedFile] = useState<SelectedFile | null>(null);
   const [filePickerError, setError] = useState<string | null>(null);
 
-  const runDocumentPicker = async (
-    pickerArgs: DocumentPickerOptions<any>,
-    fileDelimiter: string
-  ) => {
-    try {
-      const res = await DocumentPicker.pickSingle(pickerArgs);
-      const uri = res.fileCopyUri ? res.fileCopyUri : res.uri;
-      setSelectedFile({ uri, name: uri.split(fileDelimiter).slice(-1)[0] });
-    } catch (err) {
-      if (!DocumentPicker.isCancel(err)) {
-        setSelectedFile(null);
-        setError(err.message);
-      }
-    }
-  };
-
   const pickFile = async () => {
+    let result: DocumentPickerResponse | null = null;
+    let fileDelimiter: string | null = null;
     try {
       if (Platform.OS === 'ios') {
-        runDocumentPicker(
-          {
-            type: ['public.data'],
-            copyTo: 'cachesDirectory',
-          },
-          '/'
-        );
-      } else {
-        runDocumentPicker(
-          {
-            type: ['*/*'],
-          },
-          '%2F'
-        );
+        type os = 'ios';
+        fileDelimiter = '%2F';
+        result = await DocumentPicker.pickSingle<os>({
+          allowMultiSelection: false,
+          type: ['public.data'],
+          copyTo: 'cachesDirectory',
+        });
+      }
+      if (Platform.OS === 'android') {
+        type os = 'android';
+        fileDelimiter = '/';
+        result = await DocumentPicker.pickSingle<os>({
+          allowMultiSelection: false,
+          type: ['*/*'],
+        });
       }
-    } catch (err) {
+
+      if (result == null || fileDelimiter == null) {
+        throw 'Failed to pick a file, is your OS supported?';
+      }
+      const uri = result.fileCopyUri ? result.fileCopyUri : result.uri;
+      setSelectedFile({ uri, name: uri.split(fileDelimiter).slice(-1)[0] });
+    } catch (err: any) {
       if (!DocumentPicker.isCancel(err)) {
         setSelectedFile(null);
         setError(err.message);

example/yarn.lock

@@ -1018,6 +1018,11 @@
   dependencies:
     "@types/istanbul-lib-report" "*"
 
+"@types/lodash@^4.14.186":
+  version "4.14.195"
+  resolved "https://npm.playerdata.co.uk/@types/lodash/-/lodash-4.14.195.tgz#bafc975b252eb6cea78882ce8a7b6bf22a6de632"
+  integrity sha512-Hwx9EUgdwf2GLarOjQp5ZH8ZmblzcbTBC2wtQWNKARBSxM9ezRIAUpeDTgoQRAFB0+8CNWXVA9+MaSOzOF3nPg==
+
 "@types/node@*":
   version "17.0.31"
   resolved "https://npm.playerdata.co.uk/@types%2fnode/-/node-17.0.31.tgz#a5bb84ecfa27eec5e1c802c6bbf8139bdb163a5d"
@@ -3562,10 +3567,10 @@ react-native-codegen@^0.0.13:
     jscodeshift "^0.13.1"
     nullthrows "^1.1.1"
 
-react-native-document-picker@^5.0.2:
-  version "5.3.0"
-  resolved "https://npm.playerdata.co.uk/react-native-document-picker/-/react-native-document-picker-5.3.0.tgz#90f53def42d87a316b76311c729ba401c2823ffa"
-  integrity sha512-vFw9pHJywEY+xeMGM8LgfZYMw12bXQNi8vf2DblFLh11lSLf6J99nZweAGVDB8Va+Fg6CP+nLfWG2bWgL4XmMw==
+react-native-document-picker@9.0.1:
+  version "9.0.1"
+  resolved "https://npm.playerdata.co.uk/react-native-document-picker/-/react-native-document-picker-9.0.1.tgz#a5ceec157f84dbadb85fe717c657569755f4c6ca"
+  integrity sha512-l2c2xChwsdjzZIV9QJc85buC3vXkM5ZuY4943yMDj3TiszJp1spmHNaRMZKYIh3yVwdD2jENm0DBU5AWa+jhLg==
   dependencies:
     invariant "^2.2.4"
 

package.json

@@ -64,7 +64,7 @@
     "react-native": "0.68.1",
     "react-native-builder-bob": "^0.18.1",
     "semantic-release": "^17.4.2",
-    "typescript": "^4.1.3"
+    "typescript": "5.0.4"
   },
   "peerDependencies": {
     "react": "*",

src/Upgrade.ts

@@ -1,8 +1,6 @@
-import {
-  NativeModules,
-  NativeEventEmitter,
-  EmitterSubscription,
-} from 'react-native';
+import { NativeModules, NativeEventEmitter } from 'react-native';
+
+import type { EmitterSubscription } from 'react-native';
 
 import { v4 as uuidv4 } from 'uuid';
 

src/index.tsx

@@ -2,14 +2,13 @@ import { NativeModules } from 'react-native';
 
 const { McuManager } = NativeModules;
 
-import Upgrade, {
-  FirmwareUpgradeState,
-  UpgradeOptions,
-  UpgradeMode,
-} from './Upgrade';
+import Upgrade, { UpgradeMode } from './Upgrade';
+
+import type { FirmwareUpgradeState, UpgradeOptions } from './Upgrade';
 
 export const eraseImage = McuManager?.eraseImage as (
   bleId: string
 ) => Promise<void>;
 
-export { Upgrade, FirmwareUpgradeState, UpgradeOptions, UpgradeMode };
+export { Upgrade, UpgradeMode };
+export type { FirmwareUpgradeState, UpgradeOptions };