React Native Local Network Permission

A library to handle the local network permission introduced with iOS 14. It is only relevant for iOS, not for Android or
web.

Getting started

Add this library to your project:

npm install @generac/react-native-local-network-permission

yarn add @generac/react-native-local-network-permission

$3

#### NSLocalNetworkUsageDescription

You need to add the NSLocalNetworkUsageDescription key to your Info.plist file. This should be a description of why
your app needs Local Network permissions:

``
NSLocalNetworkUsageDescription
App requires local network access to do ...
`

_See
also: Apple documentation_

#### NSBonjourServices

You need to add the NSBonjourServices key to your Info.plist file. This should be an array of Bonjour services that
your app uses:

`
NSBonjourServices

_bonjour._tcp
_lnp._tcp.

`

_See
also: Apple documentation_

#### Expo

If you are using the Expo managed workflow, you cannot directly edit your Info.plist. Instead, you can add the
following to your app.json or app.config.js:

`
expo: {
ios: {
infoPlist: {
NSLocalNetworkUsageDescription: 'App requires local network access to do ...',
NSBonjourServices: ['_bonjour._tcp', '_lnp._tcp.'],
},
},
}
`

Usage

This library can be used in both React Native and Expo projects. Note however:
- If using Expo, you need to create a development build, using the Expo Go app will not work;
- If using bare React Native, you need to add Expo modules to your project, see Expo documentation.

`typescript
import {
checkLocalNetworkAccess,
requestLocalNetworkAccess,
} from '@generac/react-native-local-network-permission';

//you need to make sure the local network permission dialog popup once
const result = await requestLocalNetworkAccess();

//then use checkLocalNetworkAccess when you need
const result = await checkLocalNetworkAccess();
//here run the code depends local network access
`

Jest mocking

If you need to mock this library in your Jest tests, you can use the following code in your testSetup.ts file which
you need to reference in your jest.config.js under setupFilesAfterEnv:

`javascript
jest.mock('@generac/react-native-local-network-permission', () => ({
checkLocalNetworkAccess: jest.fn(),
requestLocalNetworkAccess: jest.fn(),
}),
);
`

Commit messages

This repository uses a commit message convention
which is enforced by a pre-commit hook. If you execute npm run commit instead of git commit -m "some message"` you
will be guided through the steps to write an acceptable commit message.

It is important that you do this properly, because
the semantic-release automation depends on the commit messages
to be starting with the proper keyword to determine if a major, minor or
patch semantic version should be assigned.

See also

- Apple FAQ 1
- Apple FAQ 2
- Stackoverflow inspiration for this library