@capacitor/background-runner 1.0.0-rc.1

package/dist/docs.json

@@ -0,0 +1,208 @@
+{
+  "api": {
+    "name": "BackgroundRunnerPlugin",
+    "slug": "backgroundrunnerplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "checkPermissions",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Check permissions for the various Capacitor device APIs.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "checkpermissions"
+      },
+      {
+        "name": "requestPermissions",
+        "signature": "(options: RequestPermissionOptions) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RequestPermissionOptions"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Request permission to display local notifications.",
+        "complexTypes": [
+          "RequestPermissionOptions",
+          "PermissionStatus"
+        ],
+        "slug": "requestpermissions"
+      },
+      {
+        "name": "dispatchEvent",
+        "signature": "(options: DispatchEventOptions) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "DispatchEventOptions"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Dispatches an event to the configured runner.",
+        "complexTypes": [
+          "DispatchEventOptions"
+        ],
+        "slug": "dispatchevent"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "PermissionStatus",
+      "slug": "permissionstatus",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "geolocation",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        },
+        {
+          "name": "notifications",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        }
+      ]
+    },
+    {
+      "name": "RequestPermissionOptions",
+      "slug": "requestpermissionoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "apis",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "API"
+          ],
+          "type": "{}"
+        }
+      ]
+    },
+    {
+      "name": "DispatchEventOptions",
+      "slug": "dispatcheventoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "label",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The runner label to dispatch the event to",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "event",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the registered event listener.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "details",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "{ [key: string]: any; }"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "PermissionState",
+      "slug": "permissionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "'prompt'",
+          "complexTypes": []
+        },
+        {
+          "text": "'prompt-with-rationale'",
+          "complexTypes": []
+        },
+        {
+          "text": "'granted'",
+          "complexTypes": []
+        },
+        {
+          "text": "'denied'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "API",
+      "slug": "api",
+      "docs": "",
+      "types": [
+        {
+          "text": "'geolocation'",
+          "complexTypes": []
+        },
+        {
+          "text": "'notifications'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/apis.d.ts

@@ -0,0 +1,52 @@
+export interface GetCurrentPositionResult {
+    latitude: number;
+    longitude: number;
+    accuracy: number;
+    altitude: number;
+    altitudeAccuracy?: number;
+    speed: number;
+    heading: number;
+}
+export interface BatteryStatus {
+    batteryLevel: number;
+    isCharging: boolean;
+}
+export interface NetworkStatus {
+    connected: boolean;
+    connectionType: string;
+}
+export interface NotificationScheduleOptions {
+    id: number;
+    title: string;
+    body: string;
+    scheduleAt: Date;
+    sound?: string;
+    actionTypeId?: string;
+    threadIdentifier?: string;
+    summaryArgument?: string;
+    groupSummary?: string;
+    extra?: unknown;
+    ongoing?: boolean;
+    autoCancel?: boolean;
+    largeBody?: string;
+    summaryText?: string;
+    smallIcon?: string;
+    largeIcon?: string;
+    group?: string;
+    channelId?: string;
+}
+export interface CapacitorGeolocation {
+    getCurrentLocation: () => GetCurrentPositionResult;
+}
+export interface CapacitorKV {
+    set: (key: string, value: string) => void;
+    get: (key: string) => string;
+    remove: (key: string) => void;
+}
+export interface CapacitorDevice {
+    getBatteryStatus: () => BatteryStatus;
+    getNetworkStatus: () => NetworkStatus;
+}
+export interface CapacitorNotifications {
+    schedule: (options: NotificationScheduleOptions[]) => void;
+}

package/dist/esm/apis.js

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

package/dist/esm/apis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apis.js","sourceRoot":"","sources":["../../src/apis.ts"],"names":[],"mappings":"","sourcesContent":["export interface GetCurrentPositionResult {\n  latitude: number;\n  longitude: number;\n  accuracy: number;\n  altitude: number;\n  altitudeAccuracy?: number;\n  speed: number;\n  heading: number;\n}\n\nexport interface BatteryStatus {\n  batteryLevel: number;\n  isCharging: boolean;\n}\n\nexport interface NetworkStatus {\n  connected: boolean;\n  connectionType: string;\n}\n\nexport interface NotificationScheduleOptions {\n  id: number;\n  title: string;\n  body: string;\n  scheduleAt: Date;\n  sound?: string;\n  actionTypeId?: string;\n  threadIdentifier?: string;\n  summaryArgument?: string;\n  groupSummary?: string;\n  extra?: unknown;\n  ongoing?: boolean;\n  autoCancel?: boolean;\n  largeBody?: string;\n  summaryText?: string;\n  smallIcon?: string;\n  largeIcon?: string;\n  group?: string;\n  channelId?: string;\n}\n\nexport interface CapacitorGeolocation {\n  getCurrentLocation: () => GetCurrentPositionResult;\n}\n\nexport interface CapacitorKV {\n  set: (key: string, value: string) => void;\n  get: (key: string) => string;\n  remove: (key: string) => void;\n}\n\nexport interface CapacitorDevice {\n  getBatteryStatus: () => BatteryStatus;\n  getNetworkStatus: () => NetworkStatus;\n}\n\nexport interface CapacitorNotifications {\n  schedule: (options: NotificationScheduleOptions[]) => void;\n}\n"]}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,82 @@
+import type { PermissionState } from '@capacitor/core';
+export type API = 'geolocation' | 'notifications';
+export interface PermissionStatus {
+    geolocation: PermissionState;
+    notifications: PermissionState;
+}
+export interface DispatchEventOptions {
+    /**
+     * The runner label to dispatch the event to
+     *
+     * @since 1.0.0
+     */
+    label: string;
+    /**
+     * The name of the registered event listener.
+     *
+     * @since 1.0.0
+     */
+    event: string;
+    details: {
+        [key: string]: any;
+    };
+}
+export interface RequestPermissionOptions {
+    apis: API[];
+}
+export interface RegisterBackgroundTaskOptions {
+    runner: BackgroundRunnerConfig;
+}
+export interface BackgroundRunnerConfig {
+    /**
+     * The name of the runner, used in logs.
+     */
+    label: string;
+    /**
+     * The path to the runner JavaScript file, relative to the app bundle.
+     */
+    src: string;
+    /**
+     * The custom event that will be called when the background task is run.
+     */
+    event: string;
+    /**
+     * Repeats the execution of the background task based on the interval set in `interval`.
+     */
+    repeat: boolean;
+    /**
+     * The number of minutes after the the app is put into the background in which the background task should begin.
+     *
+     * If `repeat` is true, this also specifies the number of minutes between each execution.
+     */
+    interval: number;
+    /**
+     * Automatically register and schedule background task on app load.
+     */
+    autoStart?: boolean;
+}
+export interface BackgroundRunnerPlugin {
+    /**
+     * Check permissions for the various Capacitor device APIs.
+     *
+     * @since 1.0.0
+     */
+    checkPermissions(): Promise<PermissionStatus>;
+    /**
+     * Request permission to display local notifications.
+     *
+     * @since 1.0.0
+     */
+    requestPermissions(options: RequestPermissionOptions): Promise<PermissionStatus>;
+    /**
+     * Dispatches an event to the configured runner.
+     * @param options
+     * @since 1.0.0
+     */
+    dispatchEvent(options: DispatchEventOptions): Promise<void>;
+}
+declare module '@capacitor/cli' {
+    interface PluginsConfig {
+        BackgroundRunner?: BackgroundRunnerConfig;
+    }
+}

package/dist/esm/definitions.js

@@ -0,0 +1,3 @@
+/// <reference types="@capacitor/cli" />
+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":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\nimport type { PermissionState } from '@capacitor/core';\n\nexport type API = 'geolocation' | 'notifications';\n\nexport interface PermissionStatus {\n  geolocation: PermissionState;\n  notifications: PermissionState;\n}\n\nexport interface DispatchEventOptions {\n  /**\n   * The runner label to dispatch the event to\n   *\n   * @since 1.0.0\n   */\n  label: string;\n  /**\n   * The name of the registered event listener.\n   *\n   * @since 1.0.0\n   */\n  event: string;\n  details: { [key: string]: any };\n}\n\nexport interface RequestPermissionOptions {\n  apis: API[];\n}\n\nexport interface RegisterBackgroundTaskOptions {\n  runner: BackgroundRunnerConfig;\n}\n\nexport interface BackgroundRunnerConfig {\n  /**\n   * The name of the runner, used in logs.\n   */\n  label: string;\n  /**\n   * The path to the runner JavaScript file, relative to the app bundle.\n   */\n  src: string;\n  /**\n   * The custom event that will be called when the background task is run.\n   */\n  event: string;\n  /**\n   * Repeats the execution of the background task based on the interval set in `interval`.\n   */\n  repeat: boolean;\n  /**\n   * The number of minutes after the the app is put into the background in which the background task should begin.\n   *\n   * If `repeat` is true, this also specifies the number of minutes between each execution.\n   */\n  interval: number;\n  /**\n   * Automatically register and schedule background task on app load.\n   */\n  autoStart?: boolean;\n}\n\nexport interface BackgroundRunnerPlugin {\n  /**\n   * Check permissions for the various Capacitor device APIs.\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n  /**\n   * Request permission to display local notifications.\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(\n    options: RequestPermissionOptions,\n  ): Promise<PermissionStatus>;\n  /**\n   * Dispatches an event to the configured runner.\n   * @param options\n   * @since 1.0.0\n   */\n  dispatchEvent(options: DispatchEventOptions): Promise<void>;\n}\n\ndeclare module '@capacitor/cli' {\n  export interface PluginsConfig {\n    BackgroundRunner?: BackgroundRunnerConfig;\n  }\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,5 @@
+import type { BackgroundRunnerPlugin } from './definitions';
+declare const BackgroundRunner: BackgroundRunnerPlugin;
+export * from './definitions';
+export * from './apis';
+export { BackgroundRunner };

package/dist/esm/index.js

@@ -0,0 +1,8 @@
+import { registerPlugin } from '@capacitor/core';
+const BackgroundRunner = registerPlugin('BackgroundRunner', {
+    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),
+});
+export * from './definitions';
+export * from './apis';
+export { BackgroundRunner };
+//# 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,gBAAgB,GAAG,cAAc,CACrC,kBAAkB,EAClB;IACE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;CAClE,CACF,CAAC;AAEF,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AAEvB,OAAO,EAAE,gBAAgB,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { BackgroundRunnerPlugin } from './definitions';\n\nconst BackgroundRunner = registerPlugin<BackgroundRunnerPlugin>(\n  'BackgroundRunner',\n  {\n    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),\n  },\n);\n\nexport * from './definitions';\nexport * from './apis';\n\nexport { BackgroundRunner };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,8 @@
+import { WebPlugin } from '@capacitor/core';
+import type { BackgroundRunnerPlugin, PermissionStatus } from './definitions';
+export declare class BackgroundRunnerWeb extends WebPlugin implements BackgroundRunnerPlugin {
+    checkPermissions(): Promise<PermissionStatus>;
+    requestPermissions(): Promise<PermissionStatus>;
+    registerBackgroundTask(): Promise<void>;
+    dispatchEvent(): Promise<void>;
+}

package/dist/esm/web.js

@@ -0,0 +1,16 @@
+import { WebPlugin } from '@capacitor/core';
+export class BackgroundRunnerWeb extends WebPlugin {
+    checkPermissions() {
+        throw new Error('not available on web');
+    }
+    requestPermissions() {
+        throw new Error('not available on web');
+    }
+    registerBackgroundTask() {
+        throw new Error('not available on web');
+    }
+    dispatchEvent() {
+        throw new Error('not available on web');
+    }
+}
+//# 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,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,mBACX,SAAQ,SAAS;IAGjB,gBAAgB;QACd,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,kBAAkB;QAChB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,sBAAsB;QACpB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,aAAa;QACX,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { BackgroundRunnerPlugin, PermissionStatus } from './definitions';\n\nexport class BackgroundRunnerWeb\n  extends WebPlugin\n  implements BackgroundRunnerPlugin\n{\n  checkPermissions(): Promise<PermissionStatus> {\n    throw new Error('not available on web');\n  }\n\n  requestPermissions(): Promise<PermissionStatus> {\n    throw new Error('not available on web');\n  }\n\n  registerBackgroundTask(): Promise<void> {\n    throw new Error('not available on web');\n  }\n\n  dispatchEvent(): Promise<void> {\n    throw new Error('not available on web');\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,32 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@capacitor/core');
+
+const BackgroundRunner = core.registerPlugin('BackgroundRunner', {
+    web: () => Promise.resolve().then(function () { return web; }).then(m => new m.BackgroundRunnerWeb()),
+});
+
+class BackgroundRunnerWeb extends core.WebPlugin {
+    checkPermissions() {
+        throw new Error('not available on web');
+    }
+    requestPermissions() {
+        throw new Error('not available on web');
+    }
+    registerBackgroundTask() {
+        throw new Error('not available on web');
+    }
+    dispatchEvent() {
+        throw new Error('not available on web');
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    BackgroundRunnerWeb: BackgroundRunnerWeb
+});
+
+exports.BackgroundRunner = BackgroundRunner;
+//# 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 BackgroundRunner = registerPlugin('BackgroundRunner', {\n    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),\n});\nexport * from './definitions';\nexport * from './apis';\nexport { BackgroundRunner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class BackgroundRunnerWeb extends WebPlugin {\n    checkPermissions() {\n        throw new Error('not available on web');\n    }\n    requestPermissions() {\n        throw new Error('not available on web');\n    }\n    registerBackgroundTask() {\n        throw new Error('not available on web');\n    }\n    dispatchEvent() {\n        throw new Error('not available on web');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;;;AACK,MAAC,gBAAgB,GAAGA,mBAAc,CAAC,kBAAkB,EAAE;AAC5D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;AACrE,CAAC;;ACFM,MAAM,mBAAmB,SAASC,cAAS,CAAC;AACnD,IAAI,gBAAgB,GAAG;AACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,kBAAkB,GAAG;AACzB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,sBAAsB,GAAG;AAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL,IAAI,aAAa,GAAG;AACpB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAChD,KAAK;AACL;;;;;;;;;"}

package/dist/plugin.js

@@ -0,0 +1,35 @@
+var capacitorBackgroundRunner = (function (exports, core) {
+    'use strict';
+
+    const BackgroundRunner = core.registerPlugin('BackgroundRunner', {
+        web: () => Promise.resolve().then(function () { return web; }).then(m => new m.BackgroundRunnerWeb()),
+    });
+
+    class BackgroundRunnerWeb extends core.WebPlugin {
+        checkPermissions() {
+            throw new Error('not available on web');
+        }
+        requestPermissions() {
+            throw new Error('not available on web');
+        }
+        registerBackgroundTask() {
+            throw new Error('not available on web');
+        }
+        dispatchEvent() {
+            throw new Error('not available on web');
+        }
+    }
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        BackgroundRunnerWeb: BackgroundRunnerWeb
+    });
+
+    exports.BackgroundRunner = BackgroundRunner;
+
+    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 BackgroundRunner = registerPlugin('BackgroundRunner', {\n    web: () => import('./web').then(m => new m.BackgroundRunnerWeb()),\n});\nexport * from './definitions';\nexport * from './apis';\nexport { BackgroundRunner };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class BackgroundRunnerWeb extends WebPlugin {\n    checkPermissions() {\n        throw new Error('not available on web');\n    }\n    requestPermissions() {\n        throw new Error('not available on web');\n    }\n    registerBackgroundTask() {\n        throw new Error('not available on web');\n    }\n    dispatchEvent() {\n        throw new Error('not available on web');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,gBAAgB,GAAGA,mBAAc,CAAC,kBAAkB,EAAE;IAC5D,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,mBAAmB,EAAE,CAAC;IACrE,CAAC;;ICFM,MAAM,mBAAmB,SAASC,cAAS,CAAC;IACnD,IAAI,gBAAgB,GAAG;IACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,kBAAkB,GAAG;IACzB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,sBAAsB,GAAG;IAC7B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL,IAAI,aAAa,GAAG;IACpB,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAChD,KAAK;IACL;;;;;;;;;;;;;;;;;"}