feat: add @capacitor-mlkit/selfie-segmentation package (#66)

Co-authored-by: Robin Genz <[email protected]>
Co-authored-by: Philipp Grosswiler <[email protected]>

.changeset/config.json

@@ -9,6 +9,7 @@
     [
       "@capacitor-mlkit/barcode-scanning",
       "@capacitor-mlkit/face-detection",
+      "@capacitor-mlkit/selfie-segmentation",
       "@capacitor-mlkit/translation"
     ]
   ],

.changeset/fifty-mirrors-teach.md

@@ -0,0 +1,5 @@
+---
+'@capacitor-mlkit/selfie-segmentation': minor
+---
+
+Initial release 🎉

README.md

@@ -47,11 +47,12 @@ Click on the name of the desired plugin under the [`Plugins`](#plugins) section
 
 ## Plugins
 
-| Name                                            | Package                             | Version                                                                                                                                                           | Downloads                                                                                                                                                              |
-| ----------------------------------------------- | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [Barcode Scanning](./packages/barcode-scanning) | `@capacitor-mlkit/barcode-scanning` | [![npm badge](https://img.shields.io/npm/v/@capacitor-mlkit/barcode-scanning?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/barcode-scanning) | [![npm downloads](https://img.shields.io/npm/dw/@capacitor-mlkit/barcode-scanning?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/barcode-scanning) |
-| [Face Detection](./packages/face-detection)     | `@capacitor-mlkit/face-detection`   | [![npm badge](https://img.shields.io/npm/v/@capacitor-mlkit/face-detection?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/face-detection)     | [![npm downloads](https://img.shields.io/npm/dw/@capacitor-mlkit/face-detection?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/face-detection)     |
-| [Translation](./packages/translation)           | `@capacitor-mlkit/translation`      | [![npm badge](https://img.shields.io/npm/v/@capacitor-mlkit/translation?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/translation)           | [![npm downloads](https://img.shields.io/npm/dw/@capacitor-mlkit/translation?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/translation)           |
+| Name                                                  | Package                                | Version                                                                                                                                                                 | Downloads                                                                                                                                                                    |
+| ----------------------------------------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Barcode Scanning](./packages/barcode-scanning)       | `@capacitor-mlkit/barcode-scanning`    | [![npm badge](https://img.shields.io/npm/v/@capacitor-mlkit/barcode-scanning?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/barcode-scanning)       | [![npm downloads](https://img.shields.io/npm/dw/@capacitor-mlkit/barcode-scanning?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/barcode-scanning)       |
+| [Face Detection](./packages/face-detection)           | `@capacitor-mlkit/face-detection`      | [![npm badge](https://img.shields.io/npm/v/@capacitor-mlkit/face-detection?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/face-detection)           | [![npm downloads](https://img.shields.io/npm/dw/@capacitor-mlkit/face-detection?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/face-detection)           |
+| [Selfie Segmentation](./packages/selfie-segmentation) | `@capacitor-mlkit/selfie-segmentation` | [![npm badge](https://img.shields.io/npm/v/@capacitor-mlkit/selfie-segmentation?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/selfie-segmentation) | [![npm downloads](https://img.shields.io/npm/dw/@capacitor-mlkit/selfie-segmentation?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/selfie-segmentation) |
+| [Translation](./packages/translation)                 | `@capacitor-mlkit/translation`         | [![npm badge](https://img.shields.io/npm/v/@capacitor-mlkit/translation?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/translation)                 | [![npm downloads](https://img.shields.io/npm/dw/@capacitor-mlkit/translation?style=flat-square)](https://www.npmjs.com/package/@capacitor-mlkit/translation)                 |
 
 ## Changelogs
 

packages/barcode-scanning/README.md

@@ -1,6 +1,6 @@
 # @capacitor-mlkit/barcode-scanning
 
-Unofficial Capacitor plugin for [ML Kit Barcode scanning](https://developers.google.com/ml-kit/vision/barcode-scanning).[^1][^2]
+Unofficial Capacitor plugin for [ML Kit Barcode Scanning](https://developers.google.com/ml-kit/vision/barcode-scanning).[^1][^2]
 
 ## Features
 

packages/barcode-scanning/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@capacitor-mlkit/barcode-scanning",
   "version": "5.1.0",
-  "description": "Capacitor plugin for ML Kit Barcode scanning.",
+  "description": "Capacitor plugin for ML Kit Barcode Scanning.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
@@ -21,7 +21,7 @@
     "url": "git+https://github.com/capawesome-team/capacitor-mlkit.git"
   },
   "bugs": {
-    "url": "https://github.com/capawesome-team/capacitor-mlkit.git/issues"
+    "url": "https://github.com/capawesome-team/capacitor-mlkit/issues"
   },
   "funding": [
     {

packages/face-detection/README.md

@@ -39,7 +39,7 @@ A working example can be found here: [robingenz/capacitor-mlkit-plugin-demo](htt
 import { FaceDetection, PerformanceMode, LandmarkMode, ContourMode, ClassificationMode } from '@capacitor-mlkit/face-detection';
 
 const processImage = async () => {
-  await FaceDetection.processImage({
+  const { faces } = await FaceDetection.processImage({
     path: 'path/to/image.jpg',
     performanceMode: PerformanceMode.Fast,
     landmarkMode: LandmarkMode.All,
@@ -48,6 +48,7 @@ const processImage = async () => {
     minFaceSize: 0.1,
     enableTracking: false,
   });
+  return faces;
 };
 ```
 

packages/face-detection/package.json

@@ -21,7 +21,7 @@
     "url": "git+https://github.com/capawesome-team/capacitor-mlkit.git"
   },
   "bugs": {
-    "url": "https://github.com/capawesome-team/capacitor-mlkit.git/issues"
+    "url": "https://github.com/capawesome-team/capacitor-mlkit/issues"
   },
   "funding": [
     {

packages/selfie-segmentation/.eslintignore

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

packages/selfie-segmentation/.gitignore

@@ -0,0 +1,61 @@
+# node files
+dist
+node_modules
+
+# iOS files
+Pods
+Podfile.lock
+Build
+xcuserdata
+
+# macOS files
+.DS_Store
+
+
+
+# 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
+
+# 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

packages/selfie-segmentation/.prettierignore

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

packages/selfie-segmentation/.prettierrc.js

@@ -0,0 +1,2 @@
+const config = require('../../.prettierrc.js');
+module.exports = config;

packages/selfie-segmentation/BREAKING.md

@@ -0,0 +1,3 @@
+# Breaking Changes
+
+This is a comprehensive list of the breaking changes introduced in the major version releases of Capacitor ML Kit Selfie Segmentation plugin.

packages/selfie-segmentation/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

packages/selfie-segmentation/CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing
+
+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.

packages/selfie-segmentation/CapacitorMlkitSelfieSegmentation.podspec

@@ -0,0 +1,19 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorMlkitSelfieSegmentation'
+  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/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '13.0'
+  s.dependency 'Capacitor'
+  s.dependency 'GoogleMLKit/SegmentationSelfie', '4.0.0'
+  s.swift_version = '5.1'
+  s.static_framework = true
+end