@capgo/capacitor-share-target 7.0.0 → 7.0.2

package/Package.swift

@@ -10,7 +10,7 @@ let package = Package(
             targets: ["CapacitorShareTargetPlugin"])
     ],
     dependencies: [
-        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.4.3")
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0")
     ],
     targets: [
         .target(

package/README.md

@@ -69,7 +69,7 @@ CapacitorShareTarget.addListener('shareReceived', (event) => {
 
 <docgen-index>
 
-* [`addListener('shareReceived', ...)`](#addlistenersharereceived)
+* [`addListener('shareReceived', ...)`](#addlistenersharereceived-)
 * [`removeAllListeners()`](#removealllisteners)
 * [`getPluginVersion()`](#getpluginversion)
 * [Interfaces](#interfaces)
@@ -79,6 +79,11 @@ CapacitorShareTarget.addListener('shareReceived', (event) => {
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
+Capacitor Share Target Plugin interface.
+
+This plugin allows your application to receive content shared from other apps.
+Users can share text, URLs, and files to your app from other applications.
+
 ### addListener('shareReceived', ...)
 
 ```typescript
@@ -146,22 +151,22 @@ Returns the current version of the native plugin implementation.
 
 Event data received when content is shared to the application.
 
-| Prop        | Type                        | Description                                        | Since |
-| ----------- | --------------------------- | -------------------------------------------------- | ----- |
-| **`title`** | <code>string</code>         | The title of the shared content.                   | 0.1.0 |
-| **`texts`** | <code>string[]</code>       | Array of text content shared to the application.   | 0.1.0 |
-| **`files`** | <code>SharedFile[]</code>   | Array of files shared to the application.          | 0.2.0 |
+| Prop        | Type                      | Description                                      | Since |
+| ----------- | ------------------------- | ------------------------------------------------ | ----- |
+| **`title`** | <code>string</code>       | The title of the shared content.                 | 0.1.0 |
+| **`texts`** | <code>string[]</code>     | Array of text content shared to the application. | 0.1.0 |
+| **`files`** | <code>SharedFile[]</code> | Array of files shared to the application.        | 0.2.0 |
 
 
 #### SharedFile
 
 Represents a file shared to the application.
 
-| Prop           | Type                | Description                                                                                      | Since |
-| -------------- | ------------------- | ------------------------------------------------------------------------------------------------ | ----- |
+| Prop           | Type                | Description                                                                                                                             | Since |
+| -------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----- |
 | **`uri`**      | <code>string</code> | The URI of the shared file. On Android/iOS this will be a file path or data URL. On web this will be a cached URL accessible via fetch. | 0.1.0 |
-| **`name`**     | <code>string</code> | The name of the shared file, with or without extension.                                          | 0.1.0 |
-| **`mimeType`** | <code>string</code> | The MIME type of the shared file.                                                                | 0.1.0 |
+| **`name`**     | <code>string</code> | The name of the shared file, with or without extension.                                                                                 | 0.1.0 |
+| **`mimeType`** | <code>string</code> | The MIME type of the shared file.                                                                                                       | 0.1.0 |
 
 </docgen-api>
 

package/android/src/main/java/app/capgo/sharetarget/CapacitorShareTargetPlugin.java

@@ -169,9 +169,10 @@ public class CapacitorShareTargetPlugin extends Plugin {
 
             File outputFile = new File(cacheDir, fileName);
 
-            try (InputStream inputStream = getActivity().getContentResolver().openInputStream(uri);
-                 FileOutputStream outputStream = new FileOutputStream(outputFile)) {
-
+            try (
+                InputStream inputStream = getActivity().getContentResolver().openInputStream(uri);
+                FileOutputStream outputStream = new FileOutputStream(outputFile)
+            ) {
                 if (inputStream == null) {
                     return null;
                 }

package/dist/docs.json

@@ -0,0 +1,234 @@
+{
+  "api": {
+    "name": "CapacitorShareTargetPlugin",
+    "slug": "capacitorsharetargetplugin",
+    "docs": "Capacitor Share Target Plugin interface.\n\nThis plugin allows your application to receive content shared from other apps.\nUsers can share text, URLs, and files to your app from other applications.",
+    "tags": [
+      {
+        "text": "0.1.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'shareReceived', listenerFunc: (event: ShareReceivedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "The event name. Must be 'shareReceived'.",
+            "type": "'shareReceived'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "Callback function invoked when content is shared to the app.",
+            "type": "(event: ShareReceivedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          },
+          {
+            "name": "param",
+            "text": "eventName The event name. Must be 'shareReceived'."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc Callback function invoked when content is shared to the app."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves to a listener handle that can be used to remove the listener."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst listener = await CapacitorShareTarget.addListener('shareReceived', (event) => {\n  console.log('Title:', event.title);\n  console.log('Texts:', event.texts);\n  event.files?.forEach(file => {\n    console.log(`File: ${file.name} (${file.mimeType})`);\n  });\n});\n\n// To remove the listener:\nawait listener.remove();\n```"
+          }
+        ],
+        "docs": "Listen for shareReceived event.\n\nRegisters a listener that will be called when content is shared to the application\nfrom another app. The callback receives event data containing title, texts, and files.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ShareReceivedEvent"
+        ],
+        "slug": "addlistenersharereceived-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when all listeners have been removed."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorShareTarget.removeAllListeners();\n```"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with an object containing the version string."
+          },
+          {
+            "name": "throws",
+            "text": "An error if something went wrong retrieving the version."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version} = await CapacitorShareTarget.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
+          }
+        ],
+        "docs": "Get the native Capacitor plugin version.\n\nReturns the current version of the native plugin implementation.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "ShareReceivedEvent",
+      "slug": "sharereceivedevent",
+      "docs": "Event data received when content is shared to the application.",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "title",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The title of the shared content.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "texts",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Array of text content shared to the application.",
+          "complexTypes": [],
+          "type": "string[]"
+        },
+        {
+          "name": "files",
+          "tags": [
+            {
+              "text": "0.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Array of files shared to the application.",
+          "complexTypes": [
+            "SharedFile"
+          ],
+          "type": "SharedFile[]"
+        }
+      ]
+    },
+    {
+      "name": "SharedFile",
+      "slug": "sharedfile",
+      "docs": "Represents a file shared to the application.",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "uri",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The URI of the shared file. On Android/iOS this will be a file path or data URL.\nOn web this will be a cached URL accessible via fetch.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the shared file, with or without extension.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "mimeType",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The MIME type of the shared file.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -108,7 +108,7 @@ export interface CapacitorShareTargetPlugin {
      *
      * @example
      * ```typescript
-     * const { version } = await CapacitorShareTarget.getPluginVersion();
+     * const { version} = await CapacitorShareTarget.getPluginVersion();
      * console.log('Plugin version:', version);
      * ```
      */
@@ -116,4 +116,3 @@ export interface CapacitorShareTargetPlugin {
         version: string;
     }>;
 }
-//# sourceMappingURL=definitions.d.ts.map

package/dist/esm/index.d.ts

@@ -2,4 +2,3 @@ import type { CapacitorShareTargetPlugin } from './definitions';
 declare const CapacitorShareTarget: CapacitorShareTargetPlugin;
 export * from './definitions';
 export { CapacitorShareTarget };
-//# sourceMappingURL=index.d.ts.map

package/dist/esm/web.d.ts

@@ -5,4 +5,3 @@ export declare class CapacitorShareTargetWeb extends WebPlugin implements Capaci
         version: string;
     }>;
 }
-//# sourceMappingURL=web.d.ts.map

package/dist/plugin.js

@@ -20,5 +20,5 @@ var capacitorCapacitorShareTarget = (function (exports, core) {
 
     return exports;
 
-})({}, core);
+})({}, capacitorExports);
 //# sourceMappingURL=plugin.js.map

package/ios/Sources/CapacitorShareTargetPlugin/CapacitorShareTargetPlugin.swift

@@ -7,7 +7,7 @@ import Capacitor
  */
 @objc(CapacitorShareTargetPlugin)
 public class CapacitorShareTargetPlugin: CAPPlugin, CAPBridgedPlugin {
-    private let PLUGIN_VERSION: String = "7.0.0"
+    private let PLUGIN_VERSION: String = "7.0.2"
     public let identifier = "CapacitorShareTargetPlugin"
     public let jsName = "CapacitorShareTarget"
     public let pluginMethods: [CAPPluginMethod] = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-share-target",
-  "version": "7.0.0",
+  "version": "7.0.2",
   "description": "Receive shared content from other apps",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -43,7 +43,7 @@
     "prettier": "prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java",
     "swiftlint": "node-swiftlint",
     "docgen": "docgen --api CapacitorShareTargetPlugin --output-readme README.md --output-json dist/docs.json",
-    "build": "npm run clean && tsc && rollup -c rollup.config.mjs",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
     "prepublishOnly": "npm run build"
@@ -57,7 +57,6 @@
     "@ionic/eslint-config": "^0.4.0",
     "@ionic/prettier-config": "^4.0.0",
     "@ionic/swiftlint-config": "^2.0.0",
-    "@rollup/plugin-node-resolve": "^16.0.3",
     "@types/node": "^22.13.1",
     "eslint": "^8.57.0",
     "eslint-plugin-import": "^2.31.0",

package/dist/esm/definitions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAE5D;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;IAEhB;;;;OAIG;IACH,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,WAAW,CACT,SAAS,EAAE,eAAe,EAC1B,YAAY,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,GAChD,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjC;;;;;;;;;;OAUG;IACH,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAClD"}

package/dist/esm/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAEhE,QAAA,MAAM,oBAAoB,4BAExB,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/esm/web.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAEhE,qBAAa,uBAAwB,SAAQ,SAAU,YAAW,0BAA0B;IACpF,gBAAgB,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAGvD"}