@capacitor-community/app-icon - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

dist/esm/definitions.d.ts

@@ -1,6 +0,1 @@
-declare module '@capacitor/core' {
-    interface PluginRegistry {
-        AppIcon: AppIconPlugin;
-    }
-}
 interface IconOptions {
@@ -7,0 +2,0 @@ /**

dist/esm/definitions.js

@@ -0,1 +1,2 @@
+export {};
 //# sourceMappingURL=definitions.js.map

dist/esm/index.d.ts

@@ -0,2 +1,4 @@
+import type { AppIconPlugin } from './definitions';
+declare const AppIcon: AppIconPlugin;
 export * from './definitions';
-export * from './web';
+export { AppIcon };

dist/esm/index.js

@@ -1,2 +0,7 @@
-export * from './web';
+import { registerPlugin } from '@capacitor/core';
+const AppIcon = registerPlugin('AppIcon', {
+    web: () => import('./web').then(m => new m.AppIconWeb()),
+});
+export * from './definitions';
+export { AppIcon };
 //# sourceMappingURL=index.js.map

dist/esm/web.d.ts

 import { WebPlugin } from '@capacitor/core';
 import { AppIconPlugin } from './definitions';
 export declare class AppIconWeb extends WebPlugin implements AppIconPlugin {
-    constructor();
     isSupported(): Promise<{
@@ -6,0 +5,0 @@ value: boolean;

dist/esm/web.js

@@ -1,37 +0,14 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { WebPlugin } from '@capacitor/core';
 export class AppIconWeb extends WebPlugin {
-    constructor() {
-        super({
-            name: 'AppIcon',
-            platforms: ['web'],
-        });
-    }
     isSupported() {
-        return __awaiter(this, void 0, void 0, function* () {
-            throw new Error("isSupported not available");
-        });
+        throw this.unimplemented('isSupported not available');
     }
     getName() {
-        return __awaiter(this, void 0, void 0, function* () {
-            throw new Error("getName not available");
-        });
+        throw this.unimplemented('getName not available');
     }
     change() {
-        return __awaiter(this, void 0, void 0, function* () {
-            throw new Error("change not available");
-        });
+        throw this.unimplemented('change not available');
     }
     reset() {
-        return __awaiter(this, void 0, void 0, function* () {
-            throw new Error("reset not available");
-        });
+        throw this.unimplemented('reset not available');
     }
@@ -38,0 +15,0 @@ }

dist/plugin.js

@@ -1,46 +0,32 @@
-var capacitorPlugin = (function (exports, core) {
+var capacitorAppCenter = (function (exports, core) {
     'use strict';
 
-    var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
-        function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-        return new (P || (P = Promise))(function (resolve, reject) {
-            function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-            function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-            function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-            step((generator = generator.apply(thisArg, _arguments || [])).next());
-        });
-    };
+    const AppIcon = core.registerPlugin('AppIcon', {
+        web: () => Promise.resolve().then(function () { return web; }).then(m => new m.AppIconWeb()),
+    });
+
     class AppIconWeb extends core.WebPlugin {
-        constructor() {
-            super({
-                name: 'AppIcon',
-                platforms: ['web'],
-            });
-        }
         isSupported() {
-            return __awaiter(this, void 0, void 0, function* () {
-                throw new Error("isSupported not available");
-            });
+            throw this.unimplemented('isSupported not available');
         }
         getName() {
-            return __awaiter(this, void 0, void 0, function* () {
-                throw new Error("getName not available");
-            });
+            throw this.unimplemented('getName not available');
         }
         change() {
-            return __awaiter(this, void 0, void 0, function* () {
-                throw new Error("change not available");
-            });
+            throw this.unimplemented('change not available');
         }
         reset() {
-            return __awaiter(this, void 0, void 0, function* () {
-                throw new Error("reset not available");
-            });
+            throw this.unimplemented('reset not available');
         }
     }
-    const AppIcon = new AppIconWeb();
-    core.registerWebPlugin(AppIcon);
+    const AppIcon$1 = new AppIconWeb();
+    core.registerWebPlugin(AppIcon$1);
 
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        AppIconWeb: AppIconWeb,
+        AppIcon: AppIcon$1
+    });
+
     exports.AppIcon = AppIcon;
-    exports.AppIconWeb = AppIconWeb;
 
@@ -47,0 +33,0 @@ Object.defineProperty(exports, '__esModule', { value: true });

package.json

 {
   "name": "@capacitor-community/app-icon",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Capacitor community plugin for changing an iOS app icon.",
-  "main": "dist/plugin.js",
+  "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
+  "unpkg": "dist/plugin.js",
+  "files": [
+    "dist/",
+    "ios/Plugin/",
+    "AppIcon.podspec"
+  ],
   "scripts": {
-    "lint": "npm run prettier -- --check && npm run swiftlint -- lint",
+    "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: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",
+    "eslint": "eslint . --ext ts",
     "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
     "swiftlint": "node-swiftlint",
-    "build": "npm run clean && tsc && rollup -c rollup.config.js",
+    "docgen": "docgen --api AppIconPlugin --output-readme README.md --output-json dist/docs.json",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
-    "prepublishOnly": "npm run build",
-    "npm-publish": "np"
+    "prepublishOnly": "npm run build"
   },
@@ -21,27 +33,19 @@ "author": "johnborges",
   "devDependencies": {
-    "@capacitor/core": "^2.4.5",
-    "@capacitor/ios": "^2.4.5",
-    "@ionic/prettier-config": "^1.0.0",
-    "@ionic/swiftlint-config": "^1.0.0",
-    "@rollup/plugin-node-resolve": "^8.1.0",
-    "prettier": "^2.0.5",
-    "prettier-plugin-java": "^0.8.0",
-    "rimraf": "^3.0.0",
-    "rollup": "^2.21.0",
+    "@capacitor/core": "3.0.0-rc.0",
+    "@capacitor/docgen": "^0.0.10",
+    "@capacitor/ios": "^3.0.0-rc.0",
+    "@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",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.32.0",
     "swiftlint": "^1.0.1",
-    "typescript": "~3.8.3"
+    "typescript": "~4.0.3"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "pretty-quick --staged"
-    }
-  },
   "peerDependencies": {
-    "@capacitor/core": "^2.4.5"
+    "@capacitor/core": "^3.0.0-rc.0"
   },
-  "files": [
-    "dist/",
-    "ios/",
-    "AppIcon.podspec"
-  ],
   "keywords": [
@@ -53,2 +57,5 @@ "capacitor",
   ],
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
   "capacitor": {
@@ -55,0 +62,0 @@ "ios": {

README.md

@@ -9,8 +9,7 @@ <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/2020?style=flat-square" />
-  <a href="https://github.com/capacitor-community/example/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/capacitor-community/example/CI?style=flat-square" /></a>
-  <a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/l/@capacitor-community/example?style=flat-square" /></a>
+  <img src="https://img.shields.io/maintenance/yes/2021?style=flat-square" />
+  <a href="https://www.npmjs.com/package/@capacitor-community/app-icon"><img src="https://img.shields.io/npm/l/@capacitor-community/app-icon?style=flat-square" /></a>
 <br>
-  <a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/dw/@capacitor-community/example?style=flat-square" /></a>
-  <a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/v/@capacitor-community/example?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/@capacitor-community/app-icon"><img src="https://img.shields.io/npm/dw/@capacitor-community/app-icon?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/@capacitor-community/app-icon"><img src="https://img.shields.io/npm/v/@capacitor-community/app-icon?style=flat-square" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
@@ -21,3 +20,3 @@ <a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-0-orange?style=flat-square" /></a>
 
-<p align="center"><img src="https://github.com/johnborges/app-icon/blob/main/media/appicon_demo.gif" width="373px" height="688px" /></p>
+<p align="center"><img src="https://github.com/capacitor-community/app-icon/blob/main/media/appicon_demo.gif" width="373px" height="688px" /></p>
 
@@ -55,3 +54,3 @@ ## Maintainers
 
-<img src="https://github.com/johnborges/app-icon/blob/main/media/xcode_project.png" width="500px" />
+<img src="https://github.com/capacitor-community/app-icon/blob/main/media/xcode_project.png" width="500px" />
 
@@ -98,6 +97,4 @@ Providing every resolution for each alternative is not required. By including the icon with the highest supported resolution, iOS will handle the other resolutions by scalling down the large one provided.
 ```javascript
-import { Plugins } from '@capacitor/core';
+import { AppIcon } from '@capacitor-community/app-icon';
 
-const { AppIcon } = Plugins;
-
 const changeIcon = async (iconName) => {
@@ -104,0 +101,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Lines of code

275

increased by77.42%

Worsened metrics

Total package byte prevSize

26256

decreased by-47.04%

Dev dependency count

13

increased by18.18%

Number of package files

21

decreased by-8.7%

Number of lines in readme file

172

decreased by-1.71%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes