@capawesome/capacitor-clipboard 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/clipboard/classes/options/WriteOptions.java

@@ -0,0 +1,60 @@
+package io.capawesome.capacitorjs.plugins.clipboard.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.clipboard.classes.CustomExceptions;
+
+public class WriteOptions {
+
+    @Nullable
+    private final String html;
+
+    @Nullable
+    private final String image;
+
+    @Nullable
+    private final String label;
+
+    @Nullable
+    private final String text;
+
+    @Nullable
+    private final String url;
+
+    public WriteOptions(@NonNull PluginCall call) throws Exception {
+        this.html = call.getString("html");
+        this.image = call.getString("image");
+        this.label = call.getString("label");
+        this.text = call.getString("text");
+        this.url = call.getString("url");
+        if (html == null && image == null && text == null && url == null) {
+            throw CustomExceptions.CONTENT_MISSING;
+        }
+    }
+
+    @Nullable
+    public String getHtml() {
+        return html;
+    }
+
+    @Nullable
+    public String getImage() {
+        return image;
+    }
+
+    @Nullable
+    public String getLabel() {
+        return label;
+    }
+
+    @Nullable
+    public String getText() {
+        return text;
+    }
+
+    @Nullable
+    public String getUrl() {
+        return url;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/clipboard/classes/results/ReadResult.java

@@ -0,0 +1,29 @@
+package io.capawesome.capacitorjs.plugins.clipboard.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.clipboard.classes.ClipboardContentType;
+import io.capawesome.capacitorjs.plugins.clipboard.interfaces.Result;
+
+public class ReadResult implements Result {
+
+    @NonNull
+    private final ClipboardContentType type;
+
+    @NonNull
+    private final String value;
+
+    public ReadResult(@NonNull ClipboardContentType type, @NonNull String value) {
+        this.type = type;
+        this.value = value;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("type", type.getValue());
+        result.put("value", value);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/clipboard/interfaces/Callback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.clipboard.interfaces;
+
+public interface Callback {
+    void error(Exception exception);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/clipboard/interfaces/EmptyCallback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.clipboard.interfaces;
+
+public interface EmptyCallback extends Callback {
+    void success();
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/clipboard/interfaces/NonEmptyResultCallback.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.clipboard.interfaces;
+
+import androidx.annotation.NonNull;
+
+public interface NonEmptyResultCallback<T extends Result> extends Callback {
+    void success(@NonNull T result);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/clipboard/interfaces/Result.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.clipboard.interfaces;
+
+import com.getcapacitor.JSObject;
+
+public interface Result {
+    JSObject toJSObject();
+}

package/dist/docs.json

@@ -0,0 +1,249 @@
+{
+  "api": {
+    "name": "ClipboardPlugin",
+    "slug": "clipboardplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "read",
+        "signature": "() => Promise<ReadResult>",
+        "parameters": [],
+        "returns": "Promise<ReadResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Read the current content of the system clipboard.\n\nOn Android, reading the clipboard is only possible while the app is in the\nforeground.\n\nOn iOS, reading the clipboard displays a system paste notification. This is\nexpected behavior and cannot be suppressed.",
+        "complexTypes": [
+          "ReadResult"
+        ],
+        "slug": "read"
+      },
+      {
+        "name": "write",
+        "signature": "(options: WriteOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "WriteOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Write content to the system clipboard.\n\nExactly one of `text`, `html`, `image` or `url` must be provided. The\n`html` property may additionally be combined with `text` to provide a\nplain-text fallback.",
+        "complexTypes": [
+          "WriteOptions"
+        ],
+        "slug": "write"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "ReadResult",
+      "slug": "readresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "type",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'TEXT'",
+              "name": "example"
+            }
+          ],
+          "docs": "The type of the content that was read from the clipboard.",
+          "complexTypes": [
+            "ClipboardContentType"
+          ],
+          "type": "ClipboardContentType"
+        },
+        {
+          "name": "value",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Hello World'",
+              "name": "example"
+            }
+          ],
+          "docs": "The content that was read from the clipboard.\n\nImages are returned as a Base64-encoded data URL.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "WriteOptions",
+      "slug": "writeoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "html",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'<b>Hello World</b>'",
+              "name": "example"
+            }
+          ],
+          "docs": "The HTML content to write to the clipboard.\n\nCombine this with `text` to provide a plain-text fallback for apps that\ncannot handle HTML content.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "image",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'data:image/png;base64,iVBORw0KGgo...'",
+              "name": "example"
+            }
+          ],
+          "docs": "The image to write to the clipboard as a Base64-encoded data URL.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "label",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'My label'",
+              "name": "example"
+            }
+          ],
+          "docs": "The label used to describe the clipboard content.\n\nOnly available on Android.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "text",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Hello World'",
+              "name": "example"
+            }
+          ],
+          "docs": "The plain text to write to the clipboard.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "url",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'https://capawesome.io'",
+              "name": "example"
+            }
+          ],
+          "docs": "The URL to write to the clipboard.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "ClipboardContentType",
+      "slug": "clipboardcontenttype",
+      "members": [
+        {
+          "name": "Html",
+          "value": "'HTML'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The content is HTML."
+        },
+        {
+          "name": "Image",
+          "value": "'IMAGE'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The content is an image, returned as a Base64-encoded data URL."
+        },
+        {
+          "name": "Text",
+          "value": "'TEXT'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The content is plain text."
+        },
+        {
+          "name": "Url",
+          "value": "'URL'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The content is a URL."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,144 @@
+export interface ClipboardPlugin {
+    /**
+     * Read the current content of the system clipboard.
+     *
+     * On Android, reading the clipboard is only possible while the app is in the
+     * foreground.
+     *
+     * On iOS, reading the clipboard displays a system paste notification. This is
+     * expected behavior and cannot be suppressed.
+     *
+     * @since 0.1.0
+     */
+    read(): Promise<ReadResult>;
+    /**
+     * Write content to the system clipboard.
+     *
+     * Exactly one of `text`, `html`, `image` or `url` must be provided. The
+     * `html` property may additionally be combined with `text` to provide a
+     * plain-text fallback.
+     *
+     * @since 0.1.0
+     */
+    write(options: WriteOptions): Promise<void>;
+}
+/**
+ * @since 0.1.0
+ */
+export interface ReadResult {
+    /**
+     * The type of the content that was read from the clipboard.
+     *
+     * @since 0.1.0
+     * @example 'TEXT'
+     */
+    type: ClipboardContentType;
+    /**
+     * The content that was read from the clipboard.
+     *
+     * Images are returned as a Base64-encoded data URL.
+     *
+     * @since 0.1.0
+     * @example 'Hello World'
+     */
+    value: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface WriteOptions {
+    /**
+     * The HTML content to write to the clipboard.
+     *
+     * Combine this with `text` to provide a plain-text fallback for apps that
+     * cannot handle HTML content.
+     *
+     * @since 0.1.0
+     * @example '<b>Hello World</b>'
+     */
+    html?: string;
+    /**
+     * The image to write to the clipboard as a Base64-encoded data URL.
+     *
+     * @since 0.1.0
+     * @example 'data:image/png;base64,iVBORw0KGgo...'
+     */
+    image?: string;
+    /**
+     * The label used to describe the clipboard content.
+     *
+     * Only available on Android.
+     *
+     * @since 0.1.0
+     * @example 'My label'
+     */
+    label?: string;
+    /**
+     * The plain text to write to the clipboard.
+     *
+     * @since 0.1.0
+     * @example 'Hello World'
+     */
+    text?: string;
+    /**
+     * The URL to write to the clipboard.
+     *
+     * @since 0.1.0
+     * @example 'https://capawesome.io'
+     */
+    url?: string;
+}
+/**
+ * The type of content stored on the clipboard.
+ *
+ * @since 0.1.0
+ */
+export declare enum ClipboardContentType {
+    /**
+     * The content is HTML.
+     *
+     * @since 0.1.0
+     */
+    Html = "HTML",
+    /**
+     * The content is an image, returned as a Base64-encoded data URL.
+     *
+     * @since 0.1.0
+     */
+    Image = "IMAGE",
+    /**
+     * The content is plain text.
+     *
+     * @since 0.1.0
+     */
+    Text = "TEXT",
+    /**
+     * The content is a URL.
+     *
+     * @since 0.1.0
+     */
+    Url = "URL"
+}
+/**
+ * @since 0.1.0
+ */
+export declare enum ErrorCode {
+    /**
+     * The clipboard is empty.
+     *
+     * @since 0.1.0
+     */
+    EmptyClipboard = "EMPTY_CLIPBOARD",
+    /**
+     * The clipboard content could not be read.
+     *
+     * @since 0.1.0
+     */
+    ReadFailed = "READ_FAILED",
+    /**
+     * The content could not be written to the clipboard.
+     *
+     * @since 0.1.0
+     */
+    WriteFailed = "WRITE_FAILED"
+}

package/dist/esm/definitions.js

@@ -0,0 +1,57 @@
+/**
+ * The type of content stored on the clipboard.
+ *
+ * @since 0.1.0
+ */
+export var ClipboardContentType;
+(function (ClipboardContentType) {
+    /**
+     * The content is HTML.
+     *
+     * @since 0.1.0
+     */
+    ClipboardContentType["Html"] = "HTML";
+    /**
+     * The content is an image, returned as a Base64-encoded data URL.
+     *
+     * @since 0.1.0
+     */
+    ClipboardContentType["Image"] = "IMAGE";
+    /**
+     * The content is plain text.
+     *
+     * @since 0.1.0
+     */
+    ClipboardContentType["Text"] = "TEXT";
+    /**
+     * The content is a URL.
+     *
+     * @since 0.1.0
+     */
+    ClipboardContentType["Url"] = "URL";
+})(ClipboardContentType || (ClipboardContentType = {}));
+/**
+ * @since 0.1.0
+ */
+export var ErrorCode;
+(function (ErrorCode) {
+    /**
+     * The clipboard is empty.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["EmptyClipboard"] = "EMPTY_CLIPBOARD";
+    /**
+     * The clipboard content could not be read.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["ReadFailed"] = "READ_FAILED";
+    /**
+     * The content could not be written to the clipboard.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["WriteFailed"] = "WRITE_FAILED";
+})(ErrorCode || (ErrorCode = {}));
+//# 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":"AA6FA;;;;GAIG;AACH,MAAM,CAAN,IAAY,oBAyBX;AAzBD,WAAY,oBAAoB;IAC9B;;;;OAIG;IACH,qCAAa,CAAA;IACb;;;;OAIG;IACH,uCAAe,CAAA;IACf;;;;OAIG;IACH,qCAAa,CAAA;IACb;;;;OAIG;IACH,mCAAW,CAAA;AACb,CAAC,EAzBW,oBAAoB,KAApB,oBAAoB,QAyB/B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SAmBX;AAnBD,WAAY,SAAS;IACnB;;;;OAIG;IACH,+CAAkC,CAAA;IAClC;;;;OAIG;IACH,uCAA0B,CAAA;IAC1B;;;;OAIG;IACH,yCAA4B,CAAA;AAC9B,CAAC,EAnBW,SAAS,KAAT,SAAS,QAmBpB","sourcesContent":["export interface ClipboardPlugin {\n  /**\n   * Read the current content of the system clipboard.\n   *\n   * On Android, reading the clipboard is only possible while the app is in the\n   * foreground.\n   *\n   * On iOS, reading the clipboard displays a system paste notification. This is\n   * expected behavior and cannot be suppressed.\n   *\n   * @since 0.1.0\n   */\n  read(): Promise<ReadResult>;\n  /**\n   * Write content to the system clipboard.\n   *\n   * Exactly one of `text`, `html`, `image` or `url` must be provided. The\n   * `html` property may additionally be combined with `text` to provide a\n   * plain-text fallback.\n   *\n   * @since 0.1.0\n   */\n  write(options: WriteOptions): Promise<void>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface ReadResult {\n  /**\n   * The type of the content that was read from the clipboard.\n   *\n   * @since 0.1.0\n   * @example 'TEXT'\n   */\n  type: ClipboardContentType;\n  /**\n   * The content that was read from the clipboard.\n   *\n   * Images are returned as a Base64-encoded data URL.\n   *\n   * @since 0.1.0\n   * @example 'Hello World'\n   */\n  value: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface WriteOptions {\n  /**\n   * The HTML content to write to the clipboard.\n   *\n   * Combine this with `text` to provide a plain-text fallback for apps that\n   * cannot handle HTML content.\n   *\n   * @since 0.1.0\n   * @example '<b>Hello World</b>'\n   */\n  html?: string;\n  /**\n   * The image to write to the clipboard as a Base64-encoded data URL.\n   *\n   * @since 0.1.0\n   * @example 'data:image/png;base64,iVBORw0KGgo...'\n   */\n  image?: string;\n  /**\n   * The label used to describe the clipboard content.\n   *\n   * Only available on Android.\n   *\n   * @since 0.1.0\n   * @example 'My label'\n   */\n  label?: string;\n  /**\n   * The plain text to write to the clipboard.\n   *\n   * @since 0.1.0\n   * @example 'Hello World'\n   */\n  text?: string;\n  /**\n   * The URL to write to the clipboard.\n   *\n   * @since 0.1.0\n   * @example 'https://capawesome.io'\n   */\n  url?: string;\n}\n\n/**\n * The type of content stored on the clipboard.\n *\n * @since 0.1.0\n */\nexport enum ClipboardContentType {\n  /**\n   * The content is HTML.\n   *\n   * @since 0.1.0\n   */\n  Html = 'HTML',\n  /**\n   * The content is an image, returned as a Base64-encoded data URL.\n   *\n   * @since 0.1.0\n   */\n  Image = 'IMAGE',\n  /**\n   * The content is plain text.\n   *\n   * @since 0.1.0\n   */\n  Text = 'TEXT',\n  /**\n   * The content is a URL.\n   *\n   * @since 0.1.0\n   */\n  Url = 'URL',\n}\n\n/**\n * @since 0.1.0\n */\nexport enum ErrorCode {\n  /**\n   * The clipboard is empty.\n   *\n   * @since 0.1.0\n   */\n  EmptyClipboard = 'EMPTY_CLIPBOARD',\n  /**\n   * The clipboard content could not be read.\n   *\n   * @since 0.1.0\n   */\n  ReadFailed = 'READ_FAILED',\n  /**\n   * The content could not be written to the clipboard.\n   *\n   * @since 0.1.0\n   */\n  WriteFailed = 'WRITE_FAILED',\n}\n"]}

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const Clipboard = registerPlugin('Clipboard', {
+    web: () => import('./web').then(m => new m.ClipboardWeb()),
+});
+export * from './definitions';
+export { Clipboard };
+//# 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,SAAS,GAAG,cAAc,CAAkB,WAAW,EAAE;IAC7D,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,CAAC;CAC3D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { ClipboardPlugin } from './definitions';\n\nconst Clipboard = registerPlugin<ClipboardPlugin>('Clipboard', {\n  web: () => import('./web').then(m => new m.ClipboardWeb()),\n});\n\nexport * from './definitions';\nexport { Clipboard };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,16 @@
+import { WebPlugin } from '@capacitor/core';
+import type { ClipboardPlugin, ReadResult, WriteOptions } from './definitions';
+export declare class ClipboardWeb extends WebPlugin implements ClipboardPlugin {
+    private static readonly errorContentMissing;
+    private static readonly errorEmptyClipboard;
+    private static readonly errorReadFailed;
+    private static readonly errorRichContentNotSupported;
+    private static readonly errorWriteFailed;
+    read(): Promise<ReadResult>;
+    write(options: WriteOptions): Promise<void>;
+    private static convertBlobToDataUrl;
+    private static convertDataUrlToBlob;
+    private static createException;
+    private static resolveTextType;
+    private static writeRichContent;
+}