@capacitor-community/privacy-screen - npm Package Compare versions

Comparing version 2.1.0 to 2.1.1-dev.6163d2b.1659193432

dist/docs.json

@@ -19,3 +19,3 @@ {
         ],
-        "docs": "Enables the privacy screen protection.\r\n\r\nOnly available for Android and iOS.",
+        "docs": "Enables the privacy screen protection.\n\nOnly available for Android and iOS.",
         "complexTypes": [],
@@ -35,3 +35,3 @@ "slug": "enable"
         ],
-        "docs": "Disables the privacy screen protection.\r\n\r\nOnly available for Android and iOS.",
+        "docs": "Disables the privacy screen protection.\n\nOnly available for Android and iOS.",
         "complexTypes": [],
@@ -46,3 +46,27 @@ "slug": "disable"
   "typeAliases": [],
-  "pluginConfigs": []
+  "pluginConfigs": [
+    {
+      "name": "PrivacyScreen",
+      "slug": "privacyscreen",
+      "properties": [
+        {
+          "name": "enable",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Configure whether the plugin should be enabled from startup.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ],
+      "docs": "These configuration values are available:"
+    }
+  ]
 }

dist/esm/definitions.d.ts

@@ -0,1 +1,19 @@
+declare module '@capacitor/cli' {
+    interface PluginsConfig {
+        /**
+         * These configuration values are available:
+         */
+        PrivacyScreen?: {
+            /**
+             * Configure whether the plugin should be enabled from startup.
+             *
+             * Only available for Android and iOS.
+             *
+             * @default true
+             * @example true
+             */
+            enable?: boolean;
+        };
+    }
+}
 export interface PrivacyScreenPlugin {
@@ -2,0 +20,0 @@ /**

dist/esm/definitions.js

@@ -0,2 +1,3 @@
+/// <reference types="@capacitor/cli" />
 export {};
 //# sourceMappingURL=definitions.js.map

dist/esm/index.d.ts

@@ -0,0 +0,0 @@ import type { PrivacyScreenPlugin } from './definitions';

dist/esm/index.js

@@ -0,0 +0,0 @@ import { registerPlugin } from '@capacitor/core';

dist/esm/web.d.ts

@@ -0,0 +0,0 @@ import { WebPlugin } from '@capacitor/core';

dist/esm/web.js

@@ -0,0 +0,0 @@ import { WebPlugin } from '@capacitor/core';

dist/plugin.cjs.js

@@ -0,0 +0,0 @@ 'use strict';

dist/plugin.js

@@ -28,3 +28,3 @@ var capacitorPrivacyScreen = (function (exports, core) {
 
-}({}, capacitorExports));
+})({}, capacitorExports);
 //# sourceMappingURL=plugin.js.map

package.json

 {
   "name": "@capacitor-community/privacy-screen",
-  "version": "2.1.0",
+  "version": "2.1.1-dev.6163d2b.1659193432",
   "description": "Capacitor plugin that protects your app from displaying a screenshot in Recents screen/App Switcher.",
@@ -32,7 +32,7 @@ "main": "dist/plugin.cjs.js",
     "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
-    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..",
+    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..",
     "verify:android": "cd android && ./gradlew clean build test && cd ..",
     "verify:web": "npm run build",
     "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
-    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- autocorrect --format",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
     "eslint": "eslint . --ext ts",
@@ -49,20 +49,21 @@ "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
   "devDependencies": {
-    "@capacitor/android": "3.0.0",
-    "@capacitor/core": "3.0.0",
-    "@capacitor/docgen": "0.0.16",
-    "@capacitor/ios": "3.0.0",
+    "@capacitor/android": "4.0.1",
+    "@capacitor/cli": "4.0.1",
+    "@capacitor/core": "4.0.1",
+    "@capacitor/docgen": "0.2.0",
+    "@capacitor/ios": "4.0.1",
     "@ionic/eslint-config": "0.3.0",
     "@ionic/prettier-config": "1.0.1",
     "@ionic/swiftlint-config": "1.1.2",
-    "eslint": "7.11.0",
-    "prettier": "2.2.0",
-    "prettier-plugin-java": "1.0.0",
+    "eslint": "7.32.0",
+    "prettier": "2.3.2",
+    "prettier-plugin-java": "1.0.2",
     "rimraf": "3.0.2",
-    "rollup": "2.32.0",
-    "standard-version": "9.1.0",
+    "rollup": "2.77.2",
+    "standard-version": "9.5.0",
     "swiftlint": "1.0.1",
-    "typescript": "4.0.3"
+    "typescript": "4.1.5"
   },
   "peerDependencies": {
-    "@capacitor/core": "^3.0.0"
+    "@capacitor/core": "^4.0.0"
   },
@@ -69,0 +70,0 @@ "prettier": "@ionic/prettier-config",

README.md

@@ -9,3 +9,3 @@ <p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
 <p align="center">
-  <img src="https://img.shields.io/maintenance/yes/2021?style=flat-square" />
+  <img src="https://img.shields.io/maintenance/yes/2022?style=flat-square" />
   <a href="https://github.com/capacitor-community/privacy-screen/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/capacitor-community/privacy-screen/CI/main?style=flat-square" /></a>
@@ -43,4 +43,15 @@ <a href="https://www.npmjs.com/package/@capacitor-community/privacy-screen"><img src="https://img.shields.io/npm/l/@capacitor-community/privacy-screen?style=flat-square" /></a>
 
-These config values are available:
+<docgen-config>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
+These configuration values are available:
+
+| Prop         | Type                 | Description                                                                                      | Default           |
+| ------------ | -------------------- | ------------------------------------------------------------------------------------------------ | ----------------- |
+| **`enable`** | <code>boolean</code> | Configure whether the plugin should be enabled from startup. Only available for Android and iOS. | <code>true</code> |
+
+### Examples
+
+In `capacitor.config.json`:
+
 ```json
@@ -56,4 +67,22 @@ {
 
-If you do not want the plugin to be enabled by default, set `enable` to `false`.
+In `capacitor.config.ts`:
 
+```ts
+/// <reference types="@capacitor/privacy-screen" />
+
+import { CapacitorConfig } from '@capacitor/cli';
+
+const config: CapacitorConfig = {
+  plugins: {
+    PrivacyScreen: {
+      enable: true,
+    },
+  },
+};
+
+export default config;
+```
+
+</docgen-config>
+
 ## Demo
@@ -60,0 +89,0 @@

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

27084

increased by2.74%

Lines of code

241

increased by21.72%

Number of lines in readme file

156

increased by22.83%

Worsened metrics

Dev dependency count

16

increased by6.67%

Number of package files

28

decreased by-3.45%

Number of low quality alerts

2

increased by100%

No dependency changes