@capacitor-mlkit/selfie-segmentation 5.2.0

package/android/src/main/java/io/capawesome/capacitorjs/plugins/mlkit/selfiesegmentation/classes/ProcessImageResult.java

@@ -0,0 +1,29 @@
+package io.capawesome.capacitorjs.plugins.mlkit.selfiesegmentation.classes;
+
+import com.getcapacitor.JSObject;
+
+public class ProcessImageResult {
+
+    private final String imagePath;
+
+    private final int width;
+    private final int height;
+
+    public ProcessImageResult(String imagePath, int width, int height) {
+        this.imagePath = imagePath;
+
+        this.width = width;
+        this.height = height;
+    }
+
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+
+        result.put("path", imagePath);
+
+        result.put("width", width);
+        result.put("height", height);
+
+        return result;
+    }
+}

package/dist/docs.json

@@ -0,0 +1,156 @@
+{
+  "api": {
+    "name": "SelfieSegmentationPlugin",
+    "slug": "selfiesegmentationplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "processImage",
+        "signature": "(options: ProcessImageOptions) => Promise<ProcessImageResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ProcessImageOptions"
+          }
+        ],
+        "returns": "Promise<ProcessImageResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "5.2.0"
+          }
+        ],
+        "docs": "Performs segmentation on an input image.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "ProcessImageResult",
+          "ProcessImageOptions"
+        ],
+        "slug": "processimage"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "ProcessImageResult",
+      "slug": "processimageresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "5.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "5.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The path to the segmented image file.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "width",
+          "tags": [
+            {
+              "text": "5.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Returns the width of the image file.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "height",
+          "tags": [
+            {
+              "text": "5.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Returns the height of the image file.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "ProcessImageOptions",
+      "slug": "processimageoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "5.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "5.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The local path to the image file.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "width",
+          "tags": [
+            {
+              "text": "5.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Scale the image to this width.\nIf no `height` is given, it will respect the aspect ratio.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "height",
+          "tags": [
+            {
+              "text": "5.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Scale the image to this height.\nIf no `width` is given, it will respect the aspect ratio.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "confidence",
+          "tags": [
+            {
+              "text": "5.2.0",
+              "name": "since"
+            },
+            {
+              "text": "0.9",
+              "name": "default"
+            }
+          ],
+          "docs": "Sets the confidence threshold.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,65 @@
+export interface SelfieSegmentationPlugin {
+    /**
+     * Performs segmentation on an input image.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 5.2.0
+     */
+    processImage(options: ProcessImageOptions): Promise<ProcessImageResult>;
+}
+/**
+ * @since 5.2.0
+ */
+export interface ProcessImageOptions {
+    /**
+     * The local path to the image file.
+     *
+     * @since 5.2.0
+     */
+    path: string;
+    /**
+     * Scale the image to this width.
+     * If no `height` is given, it will respect the aspect ratio.
+     *
+     * @since 5.2.0
+     */
+    width?: number;
+    /**
+     * Scale the image to this height.
+     * If no `width` is given, it will respect the aspect ratio.
+     *
+     * @since 5.2.0
+     */
+    height?: number;
+    /**
+     * Sets the confidence threshold.
+     *
+     * @since 5.2.0
+     * @default 0.9
+     */
+    confidence?: number;
+}
+/**
+ * @since 5.2.0
+ */
+export interface ProcessImageResult {
+    /**
+     * The path to the segmented image file.
+     *
+     * @since 5.2.0
+     */
+    path: string;
+    /**
+     * Returns the width of the image file.
+     *
+     * @since 5.2.0
+     */
+    width: number;
+    /**
+     * Returns the height of the image file.
+     *
+     * @since 5.2.0
+     */
+    height: number;
+}

package/dist/esm/definitions.js

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

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface SelfieSegmentationPlugin {\n  /**\n   * Performs segmentation on an input image.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 5.2.0\n   */\n  processImage(options: ProcessImageOptions): Promise<ProcessImageResult>;\n}\n\n/**\n * @since 5.2.0\n */\nexport interface ProcessImageOptions {\n  /**\n   * The local path to the image file.\n   *\n   * @since 5.2.0\n   */\n  path: string;\n\n  /**\n   * Scale the image to this width.\n   * If no `height` is given, it will respect the aspect ratio.\n   *\n   * @since 5.2.0\n   */\n  width?: number;\n  /**\n   * Scale the image to this height.\n   * If no `width` is given, it will respect the aspect ratio.\n   *\n   * @since 5.2.0\n   */\n  height?: number;\n\n  /**\n   * Sets the confidence threshold.\n   *\n   * @since 5.2.0\n   * @default 0.9\n   */\n  confidence?: number;\n}\n\n/**\n * @since 5.2.0\n */\nexport interface ProcessImageResult {\n  /**\n   * The path to the segmented image file.\n   *\n   * @since 5.2.0\n   */\n  path: string;\n  /**\n   * Returns the width of the image file.\n   *\n   * @since 5.2.0\n   */\n  width: number;\n  /**\n   * Returns the height of the image file.\n   *\n   * @since 5.2.0\n   */\n  height: number;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { SelfieSegmentationPlugin } from './definitions';
+declare const SelfieSegmentation: SelfieSegmentationPlugin;
+export * from './definitions';
+export { SelfieSegmentation };

package/dist/esm/index.js

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

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,kBAAkB,GAAG,cAAc,CACvC,oBAAoB,EACpB;IACE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,qBAAqB,EAAE,CAAC;CACpE,CACF,CAAC;AAEF,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,kBAAkB,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { SelfieSegmentationPlugin } from './definitions';\n\nconst SelfieSegmentation = registerPlugin<SelfieSegmentationPlugin>(\n  'SelfieSegmentation',\n  {\n    web: () => import('./web').then(m => new m.SelfieSegmentationWeb()),\n  },\n);\n\nexport * from './definitions';\nexport { SelfieSegmentation };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,6 @@
+import { WebPlugin } from '@capacitor/core';
+import type { SelfieSegmentationPlugin, ProcessImageOptions, ProcessImageResult } from './definitions';
+export declare class SelfieSegmentationWeb extends WebPlugin implements SelfieSegmentationPlugin {
+    processImage(_options: ProcessImageOptions): Promise<ProcessImageResult>;
+    private createUnavailableException;
+}

package/dist/esm/web.js

@@ -0,0 +1,10 @@
+import { CapacitorException, ExceptionCode, WebPlugin } from '@capacitor/core';
+export class SelfieSegmentationWeb extends WebPlugin {
+    async processImage(_options) {
+        throw this.createUnavailableException();
+    }
+    createUnavailableException() {
+        return new CapacitorException('This Selfie Segmentation plugin method is not available on this platform.', ExceptionCode.Unavailable);
+    }
+}
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAQ/E,MAAM,OAAO,qBACX,SAAQ,SAAS;IAGV,KAAK,CAAC,YAAY,CACvB,QAA6B;QAE7B,MAAM,IAAI,CAAC,0BAA0B,EAAE,CAAC;IAC1C,CAAC;IAEO,0BAA0B;QAChC,OAAO,IAAI,kBAAkB,CAC3B,2EAA2E,EAC3E,aAAa,CAAC,WAAW,CAC1B,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { CapacitorException, ExceptionCode, WebPlugin } from '@capacitor/core';\n\nimport type {\n  SelfieSegmentationPlugin,\n  ProcessImageOptions,\n  ProcessImageResult,\n} from './definitions';\n\nexport class SelfieSegmentationWeb\n  extends WebPlugin\n  implements SelfieSegmentationPlugin\n{\n  public async processImage(\n    _options: ProcessImageOptions,\n  ): Promise<ProcessImageResult> {\n    throw this.createUnavailableException();\n  }\n\n  private createUnavailableException(): CapacitorException {\n    return new CapacitorException(\n      'This Selfie Segmentation plugin method is not available on this platform.',\n      ExceptionCode.Unavailable,\n    );\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,26 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@capacitor/core');
+
+const SelfieSegmentation = core.registerPlugin('SelfieSegmentation', {
+    web: () => Promise.resolve().then(function () { return web; }).then(m => new m.SelfieSegmentationWeb()),
+});
+
+class SelfieSegmentationWeb extends core.WebPlugin {
+    async processImage(_options) {
+        throw this.createUnavailableException();
+    }
+    createUnavailableException() {
+        return new core.CapacitorException('This Selfie Segmentation plugin method is not available on this platform.', core.ExceptionCode.Unavailable);
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    SelfieSegmentationWeb: SelfieSegmentationWeb
+});
+
+exports.SelfieSegmentation = SelfieSegmentation;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst SelfieSegmentation = registerPlugin('SelfieSegmentation', {\n    web: () => import('./web').then(m => new m.SelfieSegmentationWeb()),\n});\nexport * from './definitions';\nexport { SelfieSegmentation };\n//# sourceMappingURL=index.js.map","import { CapacitorException, ExceptionCode, WebPlugin } from '@capacitor/core';\nexport class SelfieSegmentationWeb extends WebPlugin {\n    async processImage(_options) {\n        throw this.createUnavailableException();\n    }\n    createUnavailableException() {\n        return new CapacitorException('This Selfie Segmentation plugin method is not available on this platform.', ExceptionCode.Unavailable);\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin","CapacitorException","ExceptionCode"],"mappings":";;;;;;AACK,MAAC,kBAAkB,GAAGA,mBAAc,CAAC,oBAAoB,EAAE;AAChE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,qBAAqB,EAAE,CAAC;AACvE,CAAC;;ACFM,MAAM,qBAAqB,SAASC,cAAS,CAAC;AACrD,IAAI,MAAM,YAAY,CAAC,QAAQ,EAAE;AACjC,QAAQ,MAAM,IAAI,CAAC,0BAA0B,EAAE,CAAC;AAChD,KAAK;AACL,IAAI,0BAA0B,GAAG;AACjC,QAAQ,OAAO,IAAIC,uBAAkB,CAAC,2EAA2E,EAAEC,kBAAa,CAAC,WAAW,CAAC,CAAC;AAC9I,KAAK;AACL;;;;;;;;;"}

package/dist/plugin.js

@@ -0,0 +1,29 @@
+var capacitorSelfieSegmentation = (function (exports, core) {
+    'use strict';
+
+    const SelfieSegmentation = core.registerPlugin('SelfieSegmentation', {
+        web: () => Promise.resolve().then(function () { return web; }).then(m => new m.SelfieSegmentationWeb()),
+    });
+
+    class SelfieSegmentationWeb extends core.WebPlugin {
+        async processImage(_options) {
+            throw this.createUnavailableException();
+        }
+        createUnavailableException() {
+            return new core.CapacitorException('This Selfie Segmentation plugin method is not available on this platform.', core.ExceptionCode.Unavailable);
+        }
+    }
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        SelfieSegmentationWeb: SelfieSegmentationWeb
+    });
+
+    exports.SelfieSegmentation = SelfieSegmentation;
+
+    Object.defineProperty(exports, '__esModule', { value: true });
+
+    return exports;
+
+})({}, capacitorExports);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst SelfieSegmentation = registerPlugin('SelfieSegmentation', {\n    web: () => import('./web').then(m => new m.SelfieSegmentationWeb()),\n});\nexport * from './definitions';\nexport { SelfieSegmentation };\n//# sourceMappingURL=index.js.map","import { CapacitorException, ExceptionCode, WebPlugin } from '@capacitor/core';\nexport class SelfieSegmentationWeb extends WebPlugin {\n    async processImage(_options) {\n        throw this.createUnavailableException();\n    }\n    createUnavailableException() {\n        return new CapacitorException('This Selfie Segmentation plugin method is not available on this platform.', ExceptionCode.Unavailable);\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin","CapacitorException","ExceptionCode"],"mappings":";;;AACK,UAAC,kBAAkB,GAAGA,mBAAc,CAAC,oBAAoB,EAAE;IAChE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,qBAAqB,EAAE,CAAC;IACvE,CAAC;;ICFM,MAAM,qBAAqB,SAASC,cAAS,CAAC;IACrD,IAAI,MAAM,YAAY,CAAC,QAAQ,EAAE;IACjC,QAAQ,MAAM,IAAI,CAAC,0BAA0B,EAAE,CAAC;IAChD,KAAK;IACL,IAAI,0BAA0B,GAAG;IACjC,QAAQ,OAAO,IAAIC,uBAAkB,CAAC,2EAA2E,EAAEC,kBAAa,CAAC,WAAW,CAAC,CAAC;IAC9I,KAAK;IACL;;;;;;;;;;;;;;;;;"}

package/ios/Plugin/Classes/ProcessImageOptions.swift

@@ -0,0 +1,64 @@
+import Foundation
+import UIKit
+
+extension UIImage {
+    public func scaledImage(width: Int?, height: Int?) -> UIImage {
+        let newWidth: CGFloat
+        let newHeight: CGFloat
+
+        if let width = width {
+            newWidth = CGFloat(width)
+            if let height = height {
+                newHeight = CGFloat(height)
+            } else {
+                let scaleFactor = newWidth / self.size.width
+                newHeight = self.size.height * scaleFactor
+            }
+        } else
+        if let height = height {
+            newHeight = CGFloat(height)
+            if let width = width {
+                newWidth = CGFloat(width)
+            } else {
+                let scaleFactor = newHeight / self.size.height
+                newWidth = self.size.width * scaleFactor
+            }
+        } else {
+            return self
+        }
+
+        let newSize = CGSize(width: newWidth, height: newHeight)
+
+        if newSize.width >= size.width && newSize.height >= size.height {
+            return self
+        }
+
+        UIGraphicsBeginImageContextWithOptions(newSize, false, scale)
+        defer { UIGraphicsEndImageContext() }
+        draw(in: CGRect(origin: .zero, size: newSize))
+        return UIGraphicsGetImageFromCurrentImageContext() ?? self
+    }
+}
+
+@objc class ProcessImageOptions: NSObject {
+    private var image: UIImage
+    private var confidence: CGFloat
+
+    init(
+        image: UIImage,
+        width: Int?,
+        height: Int?,
+        confidence: CGFloat
+    ) {
+        self.image = image.scaledImage(width: width, height: height)
+        self.confidence = confidence
+    }
+
+    func getImage() -> UIImage {
+        return image
+    }
+
+    func getConfidence() -> CGFloat {
+        return confidence
+    }
+}

package/ios/Plugin/Classes/ProcessImageResult.swift

@@ -0,0 +1,30 @@
+import Foundation
+import Capacitor
+
+@objc class ProcessImageResult: NSObject {
+    let image: UIImage
+
+    init(image: UIImage) {
+        self.image = image
+    }
+
+    func toJSObject() throws -> JSObject {
+        var result = JSObject()
+
+        if let data = image.pngData() {
+            let uniqueFileNameWithExtension = UUID().uuidString + ".png"
+            var directory = URL(fileURLWithPath: NSTemporaryDirectory())
+            if let cachesDirectory = FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask).first {
+                directory = cachesDirectory
+            }
+            let url = directory.appendingPathComponent(uniqueFileNameWithExtension)
+            try data.write(to: url)
+
+            result["path"] = url.absoluteString
+            result["width"] = Int(image.size.width)
+            result["height"] = Int(image.size.height)
+        }
+
+        return result
+    }
+}

package/ios/Plugin/Info.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>FMWK</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<key>NSPrincipalClass</key>
+	<string></string>
+</dict>
+</plist>