@bubble-labs/capacitor-plugin-siri-shorts 7.0.0

package/android/gradlew.bat

@@ -0,0 +1,92 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%"=="" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if %ERRORLEVEL% equ 0 goto execute
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

package/android/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

package/android/settings.gradle

@@ -0,0 +1,2 @@
+include ':capacitor-android'
+project(':capacitor-android').projectDir = new File('../node_modules/@capacitor/android/capacitor')

package/android/src/androidTest/java/com/getcapacitor/android/ExampleInstrumentedTest.java

@@ -0,0 +1,26 @@
+package com.getcapacitor.android;
+
+import static org.junit.Assert.*;
+
+import android.content.Context;
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+import androidx.test.platform.app.InstrumentationRegistry;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
+ */
+@RunWith(AndroidJUnit4.class)
+public class ExampleInstrumentedTest {
+
+    @Test
+    public void useAppContext() throws Exception {
+        // Context of the app under test.
+        Context appContext = InstrumentationRegistry.getInstrumentation().getTargetContext();
+
+        assertEquals("com.getcapacitor.android", appContext.getPackageName());
+    }
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,5 @@
+
+  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+      >
+  </manifest>
+ 

package/android/src/main/java/com/timozacherl/plugins/CapSiriShortcuts/SiriShortcuts.java

@@ -0,0 +1,38 @@
+package com.timozacherl.plugins.CapSiriShortcuts;
+
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+
+@CapacitorPlugin(name = "SiriShortcuts")
+public class SiriShortcuts extends Plugin {
+
+    @PluginMethod
+    public void donate(PluginCall call) {
+        String value = call.getString("value");
+
+        JSObject ret = new JSObject();
+        ret.put("value", value);
+        call.resolve(ret);
+    }
+
+    @PluginMethod
+    public void delete(PluginCall call) {
+        String value = call.getString("value");
+
+        JSObject ret = new JSObject();
+        ret.put("value", value);
+        call.resolve(ret);
+    }
+
+    @PluginMethod
+    public void deleteAll(PluginCall call) {
+        String value = call.getString("value");
+
+        JSObject ret = new JSObject();
+        ret.put("value", value);
+        call.resolve(ret);
+    }
+}

package/android/src/main/res/layout/bridge_layout_main.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<androidx.coordinatorlayout.widget.CoordinatorLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    tools:context="com.getcapacitor.BridgeActivity"
+    >
+
+    <WebView
+        android:id="@+id/webview"
+        android:layout_width="fill_parent"
+        android:layout_height="fill_parent" />
+
+</androidx.coordinatorlayout.widget.CoordinatorLayout>

package/android/src/main/res/values/colors.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+</resources>

package/android/src/main/res/values/strings.xml

@@ -0,0 +1,3 @@
+<resources>
+    <string name="my_string">Just a simple string</string>
+</resources>

package/android/src/main/res/values/styles.xml

@@ -0,0 +1,3 @@
+<resources>
+
+</resources>

package/android/src/test/java/com/getcapacitor/ExampleUnitTest.java

@@ -0,0 +1,18 @@
+package com.getcapacitor;
+
+import static org.junit.Assert.*;
+
+import org.junit.Test;
+
+/**
+ * Example local unit test, which will execute on the development machine (host).
+ *
+ * @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
+ */
+public class ExampleUnitTest {
+
+    @Test
+    public void addition_isCorrect() throws Exception {
+        assertEquals(4, 2 + 2);
+    }
+}

package/dist/docs.json

@@ -0,0 +1,279 @@
+{
+  "api": {
+    "name": "SiriShortcutsPlugin",
+    "slug": "sirishortcutsplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "donate",
+        "signature": "(options: Options) => Promise<any>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Options to specify for the donation",
+            "type": "Options"
+          }
+        ],
+        "returns": "Promise<any>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "param",
+            "text": "options Options to specify for the donation"
+          }
+        ],
+        "docs": "Donates the provided action to Siri/Shortcuts",
+        "complexTypes": [
+          "Options"
+        ],
+        "slug": "donate"
+      },
+      {
+        "name": "present",
+        "signature": "(options: Options) => Promise<any>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Options to specify for the donation",
+            "type": "Options"
+          }
+        ],
+        "returns": "Promise<any>",
+        "tags": [
+          {
+            "name": "see",
+            "text": "https ://github.com/lovetodream/capacitor-plugin-siri-shortcuts/issues/3"
+          },
+          {
+            "name": "since",
+            "text": "2.2.0"
+          },
+          {
+            "name": "param",
+            "text": "options Options to specify for the donation"
+          }
+        ],
+        "docs": "Presents a modal to the user to add the shortcut to siri and access it via voice",
+        "complexTypes": [
+          "Options"
+        ],
+        "slug": "present"
+      },
+      {
+        "name": "delete",
+        "signature": "(options: DeleteOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "DeleteOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "2.1.0"
+          },
+          {
+            "name": "param",
+            "text": "identifiers Persistent identifiers which should be deleted"
+          }
+        ],
+        "docs": "Deletes the previous donations with the provided persistent identifiers",
+        "complexTypes": [
+          "DeleteOptions"
+        ],
+        "slug": "delete"
+      },
+      {
+        "name": "deleteAll",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "2.1.0"
+          }
+        ],
+        "docs": "Delets all the previously donated activities",
+        "complexTypes": [],
+        "slug": "deleteall"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'appLaunchBySiriShortcuts', listenerFunc: (shortcut: Shortcut) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "Name of the event",
+            "type": "'appLaunchBySiriShortcuts'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "Function to execute when listener gets notified",
+            "type": "(shortcut: Shortcut) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "2.0.1"
+          },
+          {
+            "name": "param",
+            "text": "eventName Name of the event"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc Function to execute when listener gets notified"
+          }
+        ],
+        "docs": "Listens to events associated with Siri Shortcuts\nand notifies the listenerFunc if a Shortcuts has been executed.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "Shortcut"
+        ],
+        "slug": "addlistenerapplaunchbysirishortcuts"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "2.0.1"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "Options",
+      "slug": "options",
+      "docs": "Options to specify for the donation",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "persistentIdentifier",
+          "tags": [],
+          "docs": "Specify an identifier to uniquely identify the shortcut,\nin order to be able to remove it",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "title",
+          "tags": [],
+          "docs": "Specify a title for the shortcut, which is visible to the\nuser as the name of the shortcut",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "userInfo",
+          "tags": [],
+          "docs": "Provide a key-value object that contains information about\nthe shortcut, this will be returned in the getActivatedShortcut\nmethod. It is not possible to use the persistentIdentifier key,\nit is used internally",
+          "complexTypes": [
+            "UserInfo"
+          ],
+          "type": "UserInfo"
+        },
+        {
+          "name": "suggestedInvocationPhrase",
+          "tags": [],
+          "docs": "Specify the phrase to give the user some inspiration\non what the shortcut to call",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "isEligibleForSearch",
+          "tags": [],
+          "docs": "This value defaults to true, set this value to make\nit searchable in Siri",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "isEligibleForPrediction",
+          "tags": [],
+          "docs": "This value defaults to true, set this value to set whether\nthe shortcut eligible for prediction",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "UserInfo",
+      "slug": "userinfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": []
+    },
+    {
+      "name": "DeleteOptions",
+      "slug": "deleteoptions",
+      "docs": "Options to specify for a deletion",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "identifiers",
+          "tags": [],
+          "docs": "Array of persistent identifiers which should be deleted",
+          "complexTypes": [],
+          "type": "string[]"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "Shortcut",
+      "slug": "shortcut",
+      "docs": "Object which will be returned by the listener which\ncontains the persistent identifier and the userinfo\nof a shortcut",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "persistentIdentifier",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "Options"
+          ],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,112 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+export interface SiriShortcutsPlugin {
+    /**
+     * Donates the provided action to Siri/Shortcuts
+     *
+     * @since 1.0.0
+     *
+     * @param {Options} options Options to specify for the donation
+     */
+    donate(options: Options): Promise<any>;
+    /**
+     * Presents a modal to the user to add the shortcut to siri and access it via voice
+     *
+     * @see https://github.com/lovetodream/capacitor-plugin-siri-shortcuts/issues/3
+     *
+     * @since 2.2.0
+     *
+     * @param {Options} options Options to specify for the donation
+     */
+    present(options: Options): Promise<any>;
+    /**
+     * Deletes the previous donations with the provided persistent identifiers
+     *
+     * @since 2.1.0
+     *
+     * @param {DeleteOptions} identifiers Persistent identifiers which should be deleted
+     */
+    delete(options: DeleteOptions): Promise<void>;
+    /**
+     * Delets all the previously donated activities
+     *
+     * @since 2.1.0
+     */
+    deleteAll(): Promise<void>;
+    /**
+     * Listens to events associated with Siri Shortcuts
+     * and notifies the listenerFunc if a Shortcuts has been executed.
+     *
+     * @since 2.0.1
+     *
+     * @param eventName Name of the event
+     * @param listenerFunc Function to execute when listener gets notified
+     */
+    addListener(eventName: 'appLaunchBySiriShortcuts', listenerFunc: (shortcut: Shortcut) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all listeners for this plugin.
+     *
+     * @since 2.0.1
+     */
+    removeAllListeners(): Promise<void>;
+}
+export interface UserInfo {
+    /**
+     * Anything except persistentIdentifier, because the
+     * persistentIdentifier will be added automatically!
+     */
+    [key: string]: string;
+}
+/**
+ * Object which will be returned by the listener which
+ * contains the persistent identifier and the userinfo
+ * of a shortcut
+ */
+export interface Shortcut extends UserInfo {
+    persistentIdentifier: Options['persistentIdentifier'];
+}
+/**
+ * 	Options to specify for the donation
+ */
+export interface Options {
+    /**
+     * Specify an identifier to uniquely identify the shortcut,
+     * in order to be able to remove it
+     */
+    persistentIdentifier: string;
+    /**
+     * Specify a title for the shortcut, which is visible to the
+     * user as the name of the shortcut
+     */
+    title: string;
+    /**
+     * Provide a key-value object that contains information about
+     * the shortcut, this will be returned in the getActivatedShortcut
+     * method. It is not possible to use the persistentIdentifier key,
+     * it is used internally
+     */
+    userInfo?: UserInfo;
+    /**
+     * Specify the phrase to give the user some inspiration
+     * on what the shortcut to call
+     */
+    suggestedInvocationPhrase?: string;
+    /**
+     * This value defaults to true, set this value to make
+     * it searchable in Siri
+     */
+    isEligibleForSearch?: boolean;
+    /**
+     * This value defaults to true, set this value to set whether
+     * the shortcut eligible for prediction
+     */
+    isEligibleForPrediction?: boolean;
+}
+/**
+ * Options to specify for a deletion
+ */
+export interface DeleteOptions {
+    /**
+     * Array of persistent identifiers which should be deleted
+     */
+    identifiers: string[];
+}

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":""}

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+import { registerPlugin } from '@capacitor/core';
+const SiriShortcuts = registerPlugin('SiriShortcuts');
+export * from './definitions';
+export { SiriShortcuts };
+//# 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,aAAa,GAAG,cAAc,CAAsB,eAAe,CAAC,CAAC;AAE3E,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/plugin.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@capacitor/core');
+
+const SiriShortcuts = core.registerPlugin('SiriShortcuts');
+
+exports.SiriShortcuts = SiriShortcuts;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst SiriShortcuts = registerPlugin('SiriShortcuts');\nexport * from './definitions';\nexport { SiriShortcuts };\n//# sourceMappingURL=index.js.map"],"names":["registerPlugin"],"mappings":";;;;;;AACK,MAAC,aAAa,GAAGA,mBAAc,CAAC,eAAe;;;;"}