Skip to content
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

(feat) Add pinCheck() functionality, upd dependencies, ready for Capacitor 7, enhance documentation, and add local TGZ creation scripts #7

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

fabiomartino
Copy link

Title:
Add Pin Check Functionality, Update Dependencies, Prepare for Capacitor 7, Enhance Documentation, and Add Local TGZ Creation in Package Scripts

Description:

This pull request includes several important updates and improvements for the project:

Pin Check Functionality:

  • Added a new functionality to check if the device has PIN or other authentication methods enabled.
  • On Android, this feature uses the KeyguardManager to determine if the device's lock screen is secure.
  • On iOS, the feature leverages the LocalAuthentication framework to check if the device supports and has enabled device owner authentication (PIN, password, or biometrics).
  • The new functionality is accessible through the pinCheck method exposed in the plugin, making it easy for developers to verify if the device has security measures in place.
  • The implementation of the pinCheck method is based on code from the Latrixz repository (link to original repo) and a fork from mchl18 (link to fork).

Android Dependencies Update:

  • Updated Android dependencies to stay in sync with the latest updates.
  • The only change is related to the Java version, which has been kept at Java 17 instead of upgrading to Java 21 to maintain compatibility with the existing codebase.

Prepared for Capacitor 7:

  • The plugin is now ready to be used with Capacitor 7, ensuring future compatibility with this version of Capacitor.
  • No breaking changes have been introduced, but necessary preparations have been made for an easy upgrade.

Documentation Updates:

  • Extended the documentation in the README.md file to provide more detailed instructions and examples for the new features, especially the pinCheck functionality.
  • Added inline documentation to the code in web.ts, descriptions.ts, and index.ts to improve code readability and provide additional context for developers working with the plugin.

Local TGZ Creation in Package Scripts:

  • Added new scripts in package.json to facilitate the creation of local .tgz packages for testing purposes.
  • This allows developers to test changes locally without needing to publish the package to a registry, improving the development workflow.

Changelog:

  • Added: pinCheck method for Android and iOS to check if device authentication (PIN, password, biometrics) is enabled.
  • Updated: Android dependencies, including Java version update to Java 17.
  • Prepared: Plugin for Capacitor 7 compatibility.
  • Enhanced: Documentation in README.md and inline comments in web.ts, descriptions.ts, and index.ts.
  • Added: Scripts in package.json to create local .tgz files for easier local testing.

Notes:

  • The pinCheck functionality was inspired by code from the Latrixz repository (original repository) and a fork from mchl18 (forked repository).
  • Please verify the changes in both Android and iOS environments, especially the new pinCheck feature.
  • The update to Java 17 for Android ensures stability with existing project configurations.

Let me know if you need further modifications or details!

… Capacitor 7, enhance documentation, and add local TGZ creation scripts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant