@bubble-labs/capacitor-widgetsbridge-plugin 7.0.0 → 7.0.2

package/dist/esm/definitions.d.ts

@@ -1,84 +1,103 @@
+/**
+ * Provides access to native iOS WidgetKit APIs.
+ *
+ * @since 7.0.0
+ */
 export interface WidgetsBridgePlugin {
     /**
-     * Return the value from user’s defaults database associated with the specified key
+     * Return the value from user’s defaults database associated with the specified key.
      *
-     * @param {UserDefaultsOptions} options
+     * @param options Options including key and group.
      * @since 0.0.1
-     * @returns {Promise<DataResults<any>>} Promise represents the value
+     * @returns Promise resolving with the retrieved value.
      */
-    getItem(options: UserDefaultsOptions): Promise<DataResults<any>>;
+    getItem(options: UserDefaultsOptions): Promise<{
+        results: string;
+    }>;
     /**
-     * Set the value to user’s defaults database associated with the specified key
+     * Set the value in the user’s defaults database for a specified key.
      *
-     * @param {UserDefaultsOptions} options
+     * @param options Options including key, value, and group.
      * @since 0.0.1
-     * @returns {Promise<DataResults<boolean>>} Promise represents the operation results
+     * @returns Promise resolving with operation success.
      */
-    setItem(options: UserDefaultsOptions): Promise<DataResults<boolean>>;
+    setItem(options: UserDefaultsOptions): Promise<{
+        results: boolean;
+    }>;
     /**
-     * Remove the value from user’s defaults database associated with the specified key
+     * Remove the value from user’s defaults database for a specified key.
      *
-     * @param {UserDefaultsOptions} options
+     * @param options Options including key and group.
      * @since 0.0.1
-     * @returns {Promise<DataResults<boolean>>} Promise represents the operation results
+     * @returns Promise resolving with operation success.
      */
-    removeItem(options: UserDefaultsOptions): Promise<DataResults<boolean>>;
+    removeItem(options: UserDefaultsOptions): Promise<{
+        results: boolean;
+    }>;
     /**
-     * Reloads the timelines for all configured widgets belonging to the containing app
+     * Reload all configured widget timelines.
      *
      * @since 0.0.1
-     * @returns {Promise<DataResults<boolean>>} Promise represents the operation results
+     * @returns Promise resolving with operation success.
      */
-    reloadAllTimelines(): Promise<DataResults<boolean>>;
+    reloadAllTimelines(): Promise<{
+        results: boolean;
+    }>;
     /**
-     * Reloads the timelines for all widgets of a particular kind
+     * Reload widget timelines for a specific kind.
      *
-     * @param {TimelinesOptions} options
+     * @param options Widget kind identifier.
      * @since 0.0.1
-     * @returns {Promise<DataResults<boolean>>} Promise represents the operation results
+     * @returns Promise resolving with operation success.
      */
-    reloadTimelines(options: TimelinesOptions): Promise<DataResults<boolean>>;
+    reloadTimelines(options: TimelinesOptions): Promise<{
+        results: boolean;
+    }>;
     /**
-     * Get current widget configurations
+     * Get current widget configurations.
      *
      * @since 0.0.1
-     * @returns {Promise<DataResults<any>>} Promise represents the operation results
+     * @returns Promise resolving with configuration data.
      */
-    getCurrentConfigurations(): Promise<DataResults<any>>;
+    getCurrentConfigurations(): Promise<{
+        results: any;
+    }>;
 }
+/**
+ * Options for user defaults database operations.
+ *
+ * @since 0.0.1
+ */
 export interface UserDefaultsOptions {
     /**
-     * The key whose value to retrieve from storage.
+     * The key whose value to retrieve, set, or remove.
      *
      * @since 0.0.1
      */
     key: string;
     /**
-     * User defaults database name which holds and organizes key/value pairs
+     * The user defaults group to store/retrieve data from.
      *
      * @since 0.0.1
      */
     group: string;
     /**
-     * The value to set in storage with the associated key
+     * The value to set (for `setItem` only).
      *
      * @since 0.0.1
      */
     value?: string;
 }
+/**
+ * Options for specifying the widget kind when reloading timelines.
+ *
+ * @since 0.0.1
+ */
 export interface TimelinesOptions {
     /**
-     * A string that identifies the widget and matches the value you used when you created the widget’s configuration
+     * The widget kind identifier.
      *
      * @since 0.0.1
      */
     ofKind: string;
 }
-export interface DataResults<T> {
-    /**
-     * Holds response results from native code
-     *
-     * @since 0.0.1
-     */
-    results: T;
-}

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -1,5 +1,4 @@
 import { registerPlugin } from '@capacitor/core';
 const WidgetsBridgePlugin = registerPlugin('WidgetsBridgePlugin');
-export * from './definitions';
-export { WidgetsBridgePlugin };
+// export { WidgetsBridgePlugin };
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,mBAAmB,GAAG,cAAc,CAAsB,qBAAqB,CAAC,CAAC;AAEvF,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,mBAAmB,GAAG,cAAc,CAAsB,qBAAqB,CAAC,CAAC;AAGvF,kCAAkC"}

package/dist/plugin.cjs.js

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

package/dist/plugin.cjs.js.map

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

package/dist/plugin.js

@@ -1,13 +1,8 @@
-var capacitorWidgetsBridgePlugin = (function (exports, core) {
+(function (core) {
 	'use strict';
 
-	const WidgetsBridgePlugin = core.registerPlugin('WidgetsBridgePlugin');
+	core.registerPlugin('WidgetsBridgePlugin');
+	// export { WidgetsBridgePlugin };
 
-	exports.WidgetsBridgePlugin = WidgetsBridgePlugin;
-
-	Object.defineProperty(exports, '__esModule', { value: true });
-
-	return exports;
-
-}({}, capacitorExports));
+}(capacitorExports));
 //# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sources":["esm/index.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst WidgetsBridgePlugin = registerPlugin('WidgetsBridgePlugin');\nexport * from './definitions';\nexport { WidgetsBridgePlugin };\n//# sourceMappingURL=index.js.map"],"names":["registerPlugin"],"mappings":";;;AACK,OAAC,mBAAmB,GAAGA,mBAAc,CAAC,qBAAqB;;;;;;;;;;;;"}
+{"version":3,"file":"plugin.js","sources":["esm/index.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst WidgetsBridgePlugin = registerPlugin('WidgetsBridgePlugin');\n// export { WidgetsBridgePlugin };\n//# sourceMappingURL=index.js.map"],"names":["registerPlugin"],"mappings":";;;AAC4BA,oBAAc,CAAC,qBAAqB,EAAE;CAClE;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bubble-labs/capacitor-widgetsbridge-plugin",
-  "version": "7.0.0",
+  "version": "7.0.2",
   "description": "Capacitor plugin to interact with iOS WidgetKit",
   "publishConfig": {
     "access": "public"
@@ -36,7 +36,7 @@
     "eslint": "eslint . --ext ts",
     "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
     "swiftlint": "node-swiftlint",
-    "docgen": "docgen --api WidgetsBridgePlugin --output-readme README.md --output-json dist/docs.json",
+    "docgen": "echo '[docgen skipped due to map() crash]'",
     "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@capacitor/cli": "^7.0.1",
     "@capacitor/core": "^7.0.1",
-    "@capacitor/docgen": "^0.0.10",
+    "@capacitor/docgen": "^0.3.0",
     "@capacitor/ios": "^7.0.1",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "^1.0.1",

package/dist/docs.json

@@ -1,378 +0,0 @@
-{
-  "api": {
-    "name": "WidgetsBridgePlugin",
-    "slug": "widgetsbridgeplugin",
-    "docs": "",
-    "tags": [],
-    "methods": [
-      {
-        "name": "getItem",
-        "signature": "(options: UserDefaultsOptions) => Promise<DataResults<any>>",
-        "parameters": [
-          {
-            "name": "options",
-            "docs": "",
-            "type": "UserDefaultsOptions"
-          }
-        ],
-        "returns": "Promise<DataResults<any>>",
-        "tags": [
-          {
-            "name": "param",
-            "text": [
-              {
-                "text": "options",
-                "kind": "text"
-              }
-            ]
-          },
-          {
-            "name": "since",
-            "text": [
-              {
-                "text": "0.0.1",
-                "kind": "text"
-              }
-            ]
-          },
-          {
-            "name": "returns",
-            "text": [
-              {
-                "text": "Promise represents the value",
-                "kind": "text"
-              }
-            ]
-          }
-        ],
-        "docs": "Return the value from user’s defaults database associated with the specified key",
-        "complexTypes": [
-          "DataResults",
-          "UserDefaultsOptions"
-        ],
-        "slug": "getitem"
-      },
-      {
-        "name": "setItem",
-        "signature": "(options: UserDefaultsOptions) => Promise<DataResults<boolean>>",
-        "parameters": [
-          {
-            "name": "options",
-            "docs": "",
-            "type": "UserDefaultsOptions"
-          }
-        ],
-        "returns": "Promise<DataResults<boolean>>",
-        "tags": [
-          {
-            "name": "param",
-            "text": [
-              {
-                "text": "options",
-                "kind": "text"
-              }
-            ]
-          },
-          {
-            "name": "since",
-            "text": [
-              {
-                "text": "0.0.1",
-                "kind": "text"
-              }
-            ]
-          },
-          {
-            "name": "returns",
-            "text": [
-              {
-                "text": "Promise represents the operation results",
-                "kind": "text"
-              }
-            ]
-          }
-        ],
-        "docs": "Set the value to user’s defaults database associated with the specified key",
-        "complexTypes": [
-          "DataResults",
-          "UserDefaultsOptions"
-        ],
-        "slug": "setitem"
-      },
-      {
-        "name": "removeItem",
-        "signature": "(options: UserDefaultsOptions) => Promise<DataResults<boolean>>",
-        "parameters": [
-          {
-            "name": "options",
-            "docs": "",
-            "type": "UserDefaultsOptions"
-          }
-        ],
-        "returns": "Promise<DataResults<boolean>>",
-        "tags": [
-          {
-            "name": "param",
-            "text": [
-              {
-                "text": "options",
-                "kind": "text"
-              }
-            ]
-          },
-          {
-            "name": "since",
-            "text": [
-              {
-                "text": "0.0.1",
-                "kind": "text"
-              }
-            ]
-          },
-          {
-            "name": "returns",
-            "text": [
-              {
-                "text": "Promise represents the operation results",
-                "kind": "text"
-              }
-            ]
-          }
-        ],
-        "docs": "Remove the value from user’s defaults database associated with the specified key",
-        "complexTypes": [
-          "DataResults",
-          "UserDefaultsOptions"
-        ],
-        "slug": "removeitem"
-      },
-      {
-        "name": "reloadAllTimelines",
-        "signature": "() => Promise<DataResults<boolean>>",
-        "parameters": [],
-        "returns": "Promise<DataResults<boolean>>",
-        "tags": [
-          {
-            "name": "since",
-            "text": [
-              {
-                "text": "0.0.1",
-                "kind": "text"
-              }
-            ]
-          },
-          {
-            "name": "returns",
-            "text": [
-              {
-                "text": "Promise represents the operation results",
-                "kind": "text"
-              }
-            ]
-          }
-        ],
-        "docs": "Reloads the timelines for all configured widgets belonging to the containing app",
-        "complexTypes": [
-          "DataResults"
-        ],
-        "slug": "reloadalltimelines"
-      },
-      {
-        "name": "reloadTimelines",
-        "signature": "(options: TimelinesOptions) => Promise<DataResults<boolean>>",
-        "parameters": [
-          {
-            "name": "options",
-            "docs": "",
-            "type": "TimelinesOptions"
-          }
-        ],
-        "returns": "Promise<DataResults<boolean>>",
-        "tags": [
-          {
-            "name": "param",
-            "text": [
-              {
-                "text": "options",
-                "kind": "text"
-              }
-            ]
-          },
-          {
-            "name": "since",
-            "text": [
-              {
-                "text": "0.0.1",
-                "kind": "text"
-              }
-            ]
-          },
-          {
-            "name": "returns",
-            "text": [
-              {
-                "text": "Promise represents the operation results",
-                "kind": "text"
-              }
-            ]
-          }
-        ],
-        "docs": "Reloads the timelines for all widgets of a particular kind",
-        "complexTypes": [
-          "DataResults",
-          "TimelinesOptions"
-        ],
-        "slug": "reloadtimelines"
-      },
-      {
-        "name": "getCurrentConfigurations",
-        "signature": "() => Promise<DataResults<any>>",
-        "parameters": [],
-        "returns": "Promise<DataResults<any>>",
-        "tags": [
-          {
-            "name": "since",
-            "text": [
-              {
-                "text": "0.0.1",
-                "kind": "text"
-              }
-            ]
-          },
-          {
-            "name": "returns",
-            "text": [
-              {
-                "text": "Promise represents the operation results",
-                "kind": "text"
-              }
-            ]
-          }
-        ],
-        "docs": "Get current widget configurations",
-        "complexTypes": [
-          "DataResults"
-        ],
-        "slug": "getcurrentconfigurations"
-      }
-    ],
-    "properties": []
-  },
-  "interfaces": [
-    {
-      "name": "DataResults",
-      "slug": "dataresults",
-      "docs": "",
-      "tags": [],
-      "methods": [],
-      "properties": [
-        {
-          "name": "results",
-          "tags": [
-            {
-              "text": [
-                {
-                  "text": "0.0.1",
-                  "kind": "text"
-                }
-              ],
-              "name": "since"
-            }
-          ],
-          "docs": "Holds response results from native code",
-          "complexTypes": [
-            "T"
-          ],
-          "type": "T"
-        }
-      ]
-    },
-    {
-      "name": "UserDefaultsOptions",
-      "slug": "userdefaultsoptions",
-      "docs": "",
-      "tags": [],
-      "methods": [],
-      "properties": [
-        {
-          "name": "key",
-          "tags": [
-            {
-              "text": [
-                {
-                  "text": "0.0.1",
-                  "kind": "text"
-                }
-              ],
-              "name": "since"
-            }
-          ],
-          "docs": "The key whose value to retrieve from storage.",
-          "complexTypes": [],
-          "type": "string"
-        },
-        {
-          "name": "group",
-          "tags": [
-            {
-              "text": [
-                {
-                  "text": "0.0.1",
-                  "kind": "text"
-                }
-              ],
-              "name": "since"
-            }
-          ],
-          "docs": "User defaults database name which holds and organizes key/value pairs",
-          "complexTypes": [],
-          "type": "string"
-        },
-        {
-          "name": "value",
-          "tags": [
-            {
-              "text": [
-                {
-                  "text": "0.0.1",
-                  "kind": "text"
-                }
-              ],
-              "name": "since"
-            }
-          ],
-          "docs": "The value to set in storage with the associated key",
-          "complexTypes": [],
-          "type": "string | undefined"
-        }
-      ]
-    },
-    {
-      "name": "TimelinesOptions",
-      "slug": "timelinesoptions",
-      "docs": "",
-      "tags": [],
-      "methods": [],
-      "properties": [
-        {
-          "name": "ofKind",
-          "tags": [
-            {
-              "text": [
-                {
-                  "text": "0.0.1",
-                  "kind": "text"
-                }
-              ],
-              "name": "since"
-            }
-          ],
-          "docs": "A string that identifies the widget and matches the value you used when you created the widget’s configuration",
-          "complexTypes": [],
-          "type": "string"
-        }
-      ]
-    }
-  ],
-  "enums": []
-}