Skip to content

feat(#32): methods for getting license metadata from native to JS #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/bare-example/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@
"engines": {
"node": ">=18"
}
}
}
137 changes: 134 additions & 3 deletions examples/expo-example/App.tsx
Original file line number Diff line number Diff line change
@@ -1,15 +1,100 @@
import { StatusBar } from 'expo-status-bar';
import { Platform, Pressable, StyleSheet, Text, View } from 'react-native';
import { useCallback, useState } from 'react';
import type { ListRenderItemInfo } from 'react-native';
import {
Button,
FlatList,
Modal,
Platform,
Pressable,
SafeAreaView,
ScrollView,
StyleSheet,
Text,
View,
} from 'react-native';
import { ReactNativeLegal } from 'react-native-legal';

const BUTTON_BACKGROUND_COLOR = '#8232ff';
const BUTTON_FONT_COLOR = '#FFF';
const BUTTON_RIPPLE_COLOR = '#8232ffba';
const MODAL_ITEM_HEADER_COLOR = '#fff';

function Item({ item }: { item: any }) {
const [customDetailModalVisible, setCustomDetailModalVisible] = useState(false);

const handlePress = useCallback(function handlePress() {
setCustomDetailModalVisible(true);
}, []);

const closeModal = useCallback(function closeModal() {
setCustomDetailModalVisible(false);
}, []);

return (
<View style={styles.modalItem}>
<Pressable
accessibilityRole="button"
android_ripple={{
color: BUTTON_RIPPLE_COLOR,
foreground: true,
}}
onPress={handlePress}
style={({ pressed }) => [styles.button, pressed && styles.pressed]}
>
<Text style={styles.modalItemHeader}>{item.name}</Text>
</Pressable>
<Modal animationType="slide" supportedOrientations={['portrait', 'landscape']} visible={customDetailModalVisible}>
<SafeAreaView style={styles.modal}>
<Button onPress={closeModal} title="Exit detail view" />
<ScrollView style={styles.modalDetailItem}>
<Text style={styles.modalDetailItemHeader}>{item.name}</Text>
<Text style={styles.modalDetailItemContent}>
{item.licenses
.map((license: any) => license.licenseContent)
.reduce((a: string, c: string) => a + '\n' + c, '')}
</Text>
</ScrollView>
</SafeAreaView>
</Modal>
</View>
);
}

function keyExtractor(item: any) {
return item.id;
}

function renderItem({ item }: ListRenderItemInfo<any>) {
return <Item item={item} />;
}

export default function App() {
function launchNotice() {
const [customModalVisible, setCustomModalVisible] = useState(false);
const [libraries, setLibraries] = useState<object[]>([]);

const launchNotice = useCallback(function launchNotice() {
ReactNativeLegal.launchLicenseListScreen('OSS Notice');
}
}, []);

const getLibraries = useCallback(async function getLibraries() {
const startAsync = performance.now();
const rawLibrariesAsync = await ReactNativeLegal.getLibrariesAsync();
const stopAsync = performance.now();

/**
* Android simulator ~160ms
* iOS simulator ~10ms
*/
console.log('perf async: ', stopAsync - startAsync);

setLibraries(rawLibrariesAsync.data);
setCustomModalVisible(true);
}, []);

const closeModal = useCallback(function closeModal() {
setCustomModalVisible(false);
}, []);

return (
<View style={styles.container}>
Expand All @@ -24,6 +109,23 @@ export default function App() {
>
<Text style={styles.label}>Tap to see list of OSS libraries</Text>
</Pressable>
<Pressable
accessibilityRole="button"
android_ripple={{
color: BUTTON_RIPPLE_COLOR,
foreground: true,
}}
onPress={getLibraries}
style={({ pressed }) => [styles.button, pressed && styles.pressed]}
>
<Text style={styles.label}>Tap to get list of licenses</Text>
</Pressable>
<Modal animationType="slide" supportedOrientations={['portrait', 'landscape']} visible={customModalVisible}>
<SafeAreaView style={styles.modal}>
<Button onPress={closeModal} title="Exit list" />
<FlatList data={libraries} keyExtractor={keyExtractor} renderItem={renderItem} />
</SafeAreaView>
</Modal>
<StatusBar style="dark" />
</View>
);
Expand All @@ -33,6 +135,7 @@ const styles = StyleSheet.create({
button: {
backgroundColor: BUTTON_BACKGROUND_COLOR,
borderRadius: 20,
margin: 10,
overflow: 'hidden',
padding: 20,
},
Expand All @@ -45,6 +148,34 @@ const styles = StyleSheet.create({
color: BUTTON_FONT_COLOR,
fontSize: 20,
},
modal: {
alignItems: 'center',
alignSelf: 'stretch',
flex: 1,
justifyContent: 'center',
},
modalItem: {
alignSelf: 'stretch',
},
modalItemHeader: {
color: MODAL_ITEM_HEADER_COLOR,
fontSize: 28,
fontWeight: 'bold',
margin: 8,
},
modalDetailItem: {
alignSelf: 'stretch',
margin: 16,
},
modalDetailItemHeader: {
fontSize: 28,
fontWeight: 'bold',
margin: 8,
},
modalDetailItemContent: {
fontSize: 12,
margin: 4,
},
pressed: {
opacity: Platform.select({
android: 1,
Expand Down
1 change: 1 addition & 0 deletions examples/expo-example/app.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"slug": "react-native-legal-expo-example",
"displayName": "React Native Legal Expo Example",
"version": "1.0.0",
"newArchEnabled": true,
"orientation": "portrait",
"icon": "./assets/icon.png",
"userInterfaceStyle": "light",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
package com.reactnativelegal

import android.content.Intent
import com.facebook.react.bridge.Arguments
import com.facebook.react.bridge.ReactApplicationContext
import com.facebook.react.bridge.WritableMap
import com.mikepenz.aboutlibraries.Libs
import com.mikepenz.aboutlibraries.LibsBuilder
import com.mikepenz.aboutlibraries.util.withContext

object ReactNativeLegalModuleImpl {
const val NAME = "ReactNativeLegalModule"
Expand All @@ -16,5 +20,54 @@ object ReactNativeLegalModuleImpl {
}

context.startActivity(intent)
android.util.Log.d("DUPA", "START")
LibsBuilder().libs?.let {
it.libraries.forEach { lib ->
android.util.Log.d("DUPA", "library: ${lib.name} - ${lib}")
}
}
Libs.Builder().withContext(context).build().libraries.forEach { lib ->
android.util.Log.d("DUPA", "library2: ${lib.name} - ${lib}")
}
android.util.Log.d("DUPA", "STOP")
}

fun getLibraries(reactContext: ReactApplicationContext): WritableMap {
val context = reactContext.currentActivity ?: return Arguments.createMap()

val libraries = Libs.Builder().withContext(context).build().libraries

val data = Arguments.createArray()

libraries.forEach { library ->
data.pushMap(
Arguments.createMap().apply {
putString("id", library.uniqueId)
putString("name", library.name)
putString("description", library.description)
putString("website", library.website)
putString("developers", library.developers.joinToString())
library.organization?.let { organization ->
putString("organization", organization.name)
}

val licensesArray = Arguments.createArray()

library.licenses.forEach { license ->
val licenseMap = Arguments.createMap()

licenseMap.putString("name", license.name)
licenseMap.putString("url", license.url)
licenseMap.putString("year", license.year)
licenseMap.putString("licenseContent", license.licenseContent ?: "")

licensesArray.pushMap(licenseMap)
}
putArray("licenses", licensesArray)
}
)
}

return Arguments.createMap().apply { putArray("data", data) }
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package com.reactnativelegal

import com.facebook.react.bridge.Promise
import com.facebook.react.bridge.ReactApplicationContext
import com.facebook.react.bridge.WritableMap
import com.facebook.react.module.annotations.ReactModule

@ReactModule(name = ReactNativeLegalModule.NAME)
Expand All @@ -13,6 +15,18 @@ class ReactNativeLegalModule(reactContext: ReactApplicationContext) :
)
}

override fun getLibraries(): WritableMap {
return ReactNativeLegalModuleImpl.getLibraries(reactApplicationContext)
}

override fun getLibrariesAsync(promise: Promise?) {
try {
promise?.resolve(ReactNativeLegalModuleImpl.getLibraries(reactApplicationContext))
} catch (e: Exception) {
promise?.reject(e)
}
}

companion object {
const val NAME = ReactNativeLegalModuleImpl.NAME
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package com.reactnativelegal
import com.facebook.react.bridge.ReactApplicationContext
import com.facebook.react.bridge.ReactContextBaseJavaModule
import com.facebook.react.bridge.ReactMethod
import com.facebook.react.bridge.WritableMap
import com.facebook.react.module.annotations.ReactModule

@ReactModule(name = ReactNativeLegalModule.NAME)
Expand All @@ -18,6 +19,20 @@ class ReactNativeLegalModule(private val reactContext: ReactApplicationContext)
)
}

@ReactMethod
fun getLibraries(): WritableMap {
return ReactNativeLegalModuleImpl.getLibraries(reactApplicationContext)
}

@ReactMethod
fun getLibrariesAsync(promise: Promise?) {
try {
promise?.resolve(ReactNativeLegalModuleImpl.getLibraries(reactApplicationContext))
} catch (e: Exception) {
promise?.reject(e)
}
}

companion object {
const val NAME = ReactNativeLegalModuleImpl.NAME
}
Expand Down
14 changes: 14 additions & 0 deletions packages/react-native-legal/ios/ReactNativeLegalModule.mm
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ @implementation ReactNativeLegalModule
[ReactNativeLegalModuleImpl launchLicenseListScreenWithLicenseHeaderText:licenseHeaderText];
}

RCT_EXPORT_SYNCHRONOUS_TYPED_METHOD(NSDictionary *, getLibraries)
{
return [ReactNativeLegalModuleImpl getLibraries];
}

RCT_EXPORT_METHOD(getLibrariesAsync : (RCTPromiseResolveBlock)resolve reject : (RCTPromiseRejectBlock)reject)
{
@try {
resolve([ReactNativeLegalModuleImpl getLibraries]);
} @catch (NSException *err) {
reject(err.name, err.reason, nil);
}
}

#if RCT_NEW_ARCH_ENABLED
- (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:
(const facebook::react::ObjCTurboModule::InitParams &)params
Expand Down
26 changes: 26 additions & 0 deletions packages/react-native-legal/ios/ReactNativeLegalModuleImpl.swift
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,32 @@ public class ReactNativeLegalModuleImpl: NSObject {
}
}

@objc public static func getLibraries() -> [String: Any] {
guard
let settingsBundleUrl = Bundle.main.url(forResource: "Settings", withExtension: "bundle"),
let settingsBundle = Bundle(url: settingsBundleUrl),
let licensePlistUrl = settingsBundle.url(
forResource: "com.mono0926.LicensePlist", withExtension: "plist"),
let dictArray = parsePlistToDictArray(fileUrl: licensePlistUrl)
else {
return [:]
}

let libraries = parseRawLicenseMetadataToArray(
rawLicenses: getChildPaneSpecifiers(dictArray: dictArray),
licensePlistUrl: licensePlistUrl
)

return [
"data": libraries.map({ library in
[
"id": "library-\(library.name ?? "")", "name": library.name ?? "",
"licenses": [["licenseContent": library.content ?? ""]],
]
})
]
}

private static func getChildPaneSpecifiers(dictArray: [[String: Any]]) -> [[String: Any]] {
return
dictArray
Expand Down
Loading