Merge pull request #1 from capacitor-community/chore/release-1.0.0

Release v1.0.0

.eslintignore

@@ -0,0 +1,2 @@
+build
+dist

.gitignore

@@ -1,36 +1,70 @@
-.idea/
+# node files
 dist
-.sourcemaps
+node_modules
+
+# iOS files
+Pods
+Podfile.lock
+Package.resolved
+Build
+xcuserdata
+/.build
+/Packages
 xcuserdata/
-node_modules/
-cli/dist/commands/copy.js
-Pods/
-test_project/
-*.map
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc
+
+
+# macOS files
 .DS_Store
-Podfile.lock
-example/www/
-example/electron/www/*
-example/electron/capacitor.config.json
-example/android/app/src/main/assets/public/*
-!example/android/app/src/main/assets/public/.gitkeep
-example/ios/IonicRunner/public/*
-!example/ios/IonicRunner/public/.gitkeep
-Build/*
-Index/
-.*.sw*
-site/www
-android-template.iml
-!/build/.npmkeep
-lerna-debug.log
-capacitor-ios/
+
+
+
+# Based on Android gitignore template: https://github.com/github/gitignore/blob/HEAD/Android.gitignore
+
+# Built application files
+*.apk
+*.ap_
+
+# Files for the ART/Dalvik VM
+*.dex
+
+# Java class files
+*.class
+
+# Generated files
+bin
+gen
+out
+
+# Gradle files
+.gradle
+build
+
+# Local configuration file (sdk path, etc)
 local.properties
-contents.xcworkspacedata
-.stencil/
-android-template/.gradle/
-android-template/app/app.iml
-/site/.env
-/site/.firebase
-.gradle/
-.settings/
-.project
+
+# Proguard folder generated by Eclipse
+proguard
+
+# Log Files
+*.log
+
+# Android Studio Navigation editor temp files
+.navigation
+
+# Android Studio captures folder
+captures
+
+# IntelliJ
+*.iml
+.idea
+
+# Keystore files
+# Uncomment the following line if you do not want to check your keystore files in.
+#*.jks
+
+# External native build folder generated in Android Studio 2.2 and later
+.externalNativeBuild

.npmrc

@@ -0,0 +1 @@
+engine-strict=false

.nvmrc

@@ -0,0 +1 @@
+20.11.1

.prettierignore

@@ -0,0 +1,3 @@
+build
+dist
+example-app

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## v6.0.0
+
+- initial release

CONTRIBUTING.md

@@ -1,3 +1,52 @@
 # Contributing
 
-TODO
+This guide provides instructions for contributing to this Capacitor plugin.
+
+## Developing
+
+### Local Setup
+
+1. Fork and clone the repo.
+1. Install the dependencies.
+
+    ```shell
+    npm install
+    ```
+
+1. Install SwiftLint if you're on macOS.
+
+    ```shell
+    brew install swiftlint
+    ```
+
+### Scripts
+
+#### `npm run build`
+
+Build the plugin web assets and generate plugin API documentation using [`@capacitor/docgen`](https://github.com/ionic-team/capacitor-docgen).
+
+It will compile the TypeScript code from `src/` into ESM JavaScript in `dist/esm/`. These files are used in apps with bundlers when your plugin is imported.
+
+Then, Rollup will bundle the code into a single file at `dist/plugin.js`. This file is used in apps without bundlers by including it as a script in `index.html`.
+
+#### `npm run verify`
+
+Build and validate the web and native projects.
+
+This is useful to run in CI to verify that the plugin builds for all platforms.
+
+#### `npm run lint` / `npm run fmt`
+
+Check formatting and code quality, autoformat/autofix if possible.
+
+This template is integrated with ESLint, Prettier, and SwiftLint. Using these tools is completely optional, but the [Capacitor Community](https://github.com/capacitor-community/) strives to have consistent code style and structure for easier cooperation.
+
+## Publishing
+
+There is a `prepublishOnly` hook in `package.json` which prepares the plugin before publishing, so all you need to do is run:
+
+```shell
+npm publish
+```
+
+> **Note**: The [`files`](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#files) array in `package.json` specifies which files get published. If you rename files/directories or add files elsewhere, you may need to update it.

CapacitorCommunityDeviceSecurityDetect.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorCommunityDeviceSecurityDetect'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '13.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapacitorCommunityDeviceSecurityDetect",
+    platforms: [.iOS(.v13)],
+    products: [
+        .library(
+            name: "CapacitorCommunityDeviceSecurityDetect",
+            targets: ["DeviceSecurityDetectPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", branch: "main")
+    ],
+    targets: [
+        .target(
+            name: "DeviceSecurityDetectPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/DeviceSecurityDetectPlugin"),
+        .testTarget(
+            name: "DeviceSecurityDetectPluginTests",
+            dependencies: ["DeviceSecurityDetectPlugin"],
+            path: "ios/Tests/DeviceSecurityDetectPluginTests")
+    ]
+)

README.md

@@ -1,8 +1,8 @@
 <p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
-<h3 align="center">Example</h3>
-<p align="center"><strong><code>@capacitor-community/example</code></strong></p>
+<h3 align="center">Device Security Detect Plugin</h3>
+<p align="center"><strong><code>@capacitor-community/device-security-detect</code></strong></p>
 <p align="center">
-  Capacitor community plugin for something awesome.
+  The Device Security Detect plugin is designed to provide comprehensive device security detection capabilities for Capacitor-based applications. It aims to detect the device has been rooted (Android) or jailbroken (iOS). By using this plugin, developers can enhance the security of their applications and take appropriate actions based on the detected security status.
 </p>
 
 <p align="center">
@@ -17,20 +17,69 @@
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 </p>
 
+## Table of Contents
+
+- [Maintainers](#maintainers)
+- [Plugin versions](#plugin-versions)
+- [Supported Platforms](#supported-platforms)
+- [Installation](#installation)
+- [API](#api)
+- [Usage](#usage)
+
 ## Maintainers
 
-| Maintainer | GitHub | Social |
-| -----------| -------| -------|
-| Ionitron (example) | [Ionitron](https://github.com/ionitron) | [@ionitron](https://twitter.com/ionitron) |
+| Maintainer | GitHub                              | Active |
+| ---------- | -------------------------------     | ------ |
+| 4ooper     | [4ooper](https://github.com/4ooper) | yes    |
+| ryaa       | [ryaa](https://github.com/ryaa)     | yes    |
+
+## Plugin versions
+
+| Capacitor version | Plugin version |
+| ----------------- | -------------- |
+| 6.x               | 6.x            |
+
+## Supported Platforms
+
+- iOS
+- Android
 
 ## Installation
 
-TODO
+```bash
+npm install @capacitor-community/device-security-detect
+npx cap sync
+```
+
+## API
+
+<docgen-index>
 
-## Configuration
+* [`isJailBreakOrRooted()`](#isjailbreakorrooted)
 
-TODO
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### isJailBreakOrRooted()
+
+```typescript
+isJailBreakOrRooted() => Promise<{ value: boolean; }>
+```
+
+**Returns:** <code>Promise&lt;{ value: boolean; }&gt;</code>
+
+--------------------
+
+</docgen-api>
 
 ## Usage
 
-TODO
+### Detect if the device has been rooted (Android) or jailbroken (iOS)
+
+```
+import { DeviceSecurityDetect } from '@capacitor-community/device-security-detect';
+
+const { value } = await DeviceSecurityDetect.isJailBreakOrRooted();
+```

android/.gitignore

@@ -0,0 +1 @@
+/build

android/build.gradle

@@ -0,0 +1,58 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.2.1'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "com.mukha.andrei.plugins.device.secutiry.detect"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

android/gradle.properties

@@ -0,0 +1,22 @@
+# Project-wide Gradle settings.
+
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+org.gradle.jvmargs=-Xmx1536m
+
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+# org.gradle.parallel=true
+
+# AndroidX package structure to make it clearer which packages are bundled with the
+# Android operating system, and which are packaged with your app's APK
+# https://developer.android.com/topic/libraries/support-library/androidx-rn
+android.useAndroidX=true