@capgo/capacitor-persistent-account 7.1.3 → 7.2.1

package/Package.swift

@@ -10,7 +10,7 @@ let package = Package(
             targets: ["CapacitorPersistentAccountPlugin"])
     ],
     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.4.4")
     ],
     targets: [
         .target(

package/README.md

@@ -26,12 +26,23 @@ npx cap sync
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
+Capacitor Persistent Account Plugin
+
+Provides persistent storage for account data across app sessions using platform-specific
+secure storage mechanisms. On iOS, this uses the Keychain. On Android, this uses
+AccountManager. This ensures account data persists even after app reinstallation.
+
 ### readAccount()
 
 ```typescript
 readAccount() => Promise<{ data: unknown | null; }>
 ```
 
+Reads the stored account data from persistent storage.
+
+Retrieves account data that was previously saved using saveAccount(). The data
+persists across app sessions and survives app reinstallation on supported platforms.
+
 **Returns:** <code>Promise&lt;{ data: unknown; }&gt;</code>
 
 --------------------
@@ -43,9 +54,15 @@ readAccount() => Promise<{ data: unknown | null; }>
 saveAccount(options: { data: unknown; }) => Promise<void>
 ```
 
-| Param         | Type                            |
-| ------------- | ------------------------------- |
-| **`options`** | <code>{ data: unknown; }</code> |
+Saves account data to persistent storage.
+
+Stores the provided account data using platform-specific secure storage mechanisms.
+The data will persist across app sessions and survive app reinstallation.
+Any existing account data will be overwritten.
+
+| Param         | Type                            | Description                                       |
+| ------------- | ------------------------------- | ------------------------------------------------- |
+| **`options`** | <code>{ data: unknown; }</code> | - The options object containing the data to save. |
 
 --------------------
 
@@ -58,6 +75,9 @@ getPluginVersion() => Promise<{ version: string; }>
 
 Get the native Capacitor plugin version
 
+Returns the version string of the native plugin implementation. Useful for
+debugging and ensuring compatibility between the JavaScript and native layers.
+
 **Returns:** <code>Promise&lt;{ version: string; }&gt;</code>
 
 --------------------

package/android/src/main/java/ee/forgr/capacitor_persistent_account/CapacitorPersistentAccountPlugin.java

@@ -11,7 +11,7 @@ import com.getcapacitor.annotation.PermissionCallback;
 @CapacitorPlugin(name = "CapacitorPersistentAccount")
 public class CapacitorPersistentAccountPlugin extends Plugin {
 
-    private final String PLUGIN_VERSION = "7.1.3";
+    private final String PLUGIN_VERSION = "7.2.1";
 
     private CapacitorPersistentAccount implementation;
 

package/dist/docs.json

@@ -2,16 +2,30 @@
   "api": {
     "name": "CapacitorPersistentAccountPlugin",
     "slug": "capacitorpersistentaccountplugin",
-    "docs": "",
-    "tags": [],
+    "docs": "Capacitor Persistent Account Plugin\n\nProvides persistent storage for account data across app sessions using platform-specific\nsecure storage mechanisms. On iOS, this uses the Keychain. On Android, this uses\nAccountManager. This ensures account data persists even after app reinstallation.",
+    "tags": [
+      {
+        "text": "CapacitorPersistentAccountPlugin",
+        "name": "interface"
+      }
+    ],
     "methods": [
       {
         "name": "readAccount",
         "signature": "() => Promise<{ data: unknown | null; }>",
         "parameters": [],
         "returns": "Promise<{ data: unknown; }>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise that resolves to an object\ncontaining the stored account data, or null if no data has been saved yet."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst result = await CapacitorPersistentAccount.readAccount();\nif (result.data) {\n  console.log('Account data:', result.data);\n} else {\n  console.log('No account data found');\n}\n```"
+          }
+        ],
+        "docs": "Reads the stored account data from persistent storage.\n\nRetrieves account data that was previously saved using saveAccount(). The data\npersists across app sessions and survives app reinstallation on supported platforms.",
         "complexTypes": [],
         "slug": "readaccount"
       },
@@ -21,13 +35,30 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "",
+            "docs": "- The options object containing the data to save.",
             "type": "{ data: unknown; }"
           }
         ],
         "returns": "Promise<void>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The options object containing the data to save."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when the data has been successfully saved."
+          },
+          {
+            "name": "throws",
+            "text": "{Error} Throws an error if the data cannot be saved to persistent storage."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait CapacitorPersistentAccount.saveAccount({\n  data: {\n    userId: '12345',\n    username: 'john.doe',\n    email: 'john@example.com'\n  }\n});\n```"
+          }
+        ],
+        "docs": "Saves account data to persistent storage.\n\nStores the provided account data using platform-specific secure storage mechanisms.\nThe data will persist across app sessions and survive app reinstallation.\nAny existing account data will be overwritten.",
         "complexTypes": [],
         "slug": "saveaccount"
       },
@@ -39,14 +70,18 @@
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise with version for this device"
+            "text": "A promise that resolves to an object\ncontaining the version string of the native plugin."
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "{Error} Throws an error if the version information cannot be retrieved."
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await CapacitorPersistentAccount.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
           }
         ],
-        "docs": "Get the native Capacitor plugin version",
+        "docs": "Get the native Capacitor plugin version\n\nReturns the version string of the native plugin implementation. Useful for\ndebugging and ensuring compatibility between the JavaScript and native layers.",
         "complexTypes": [],
         "slug": "getpluginversion"
       }

package/dist/esm/definitions.d.ts

@@ -1,15 +1,79 @@
+/**
+ * Capacitor Persistent Account Plugin
+ *
+ * Provides persistent storage for account data across app sessions using platform-specific
+ * secure storage mechanisms. On iOS, this uses the Keychain. On Android, this uses
+ * AccountManager. This ensures account data persists even after app reinstallation.
+ *
+ * @interface CapacitorPersistentAccountPlugin
+ */
 export interface CapacitorPersistentAccountPlugin {
+    /**
+     * Reads the stored account data from persistent storage.
+     *
+     * Retrieves account data that was previously saved using saveAccount(). The data
+     * persists across app sessions and survives app reinstallation on supported platforms.
+     *
+     * @returns {Promise<{ data: unknown | null }>} A promise that resolves to an object
+     *   containing the stored account data, or null if no data has been saved yet.
+     *
+     * @example
+     * ```typescript
+     * const result = await CapacitorPersistentAccount.readAccount();
+     * if (result.data) {
+     *   console.log('Account data:', result.data);
+     * } else {
+     *   console.log('No account data found');
+     * }
+     * ```
+     */
     readAccount(): Promise<{
         data: unknown | null;
     }>;
+    /**
+     * Saves account data to persistent storage.
+     *
+     * Stores the provided account data using platform-specific secure storage mechanisms.
+     * The data will persist across app sessions and survive app reinstallation.
+     * Any existing account data will be overwritten.
+     *
+     * @param {Object} options - The options object containing the data to save.
+     * @param {unknown} options.data - The account data to persist. Can be any serializable data type.
+     *
+     * @returns {Promise<void>} A promise that resolves when the data has been successfully saved.
+     *
+     * @throws {Error} Throws an error if the data cannot be saved to persistent storage.
+     *
+     * @example
+     * ```typescript
+     * await CapacitorPersistentAccount.saveAccount({
+     *   data: {
+     *     userId: '12345',
+     *     username: 'john.doe',
+     *     email: 'john@example.com'
+     *   }
+     * });
+     * ```
+     */
     saveAccount(options: {
         data: unknown;
     }): Promise<void>;
     /**
      * Get the native Capacitor plugin version
      *
-     * @returns {Promise<{ id: string }>} an Promise with version for this device
-     * @throws An error if the something went wrong
+     * Returns the version string of the native plugin implementation. Useful for
+     * debugging and ensuring compatibility between the JavaScript and native layers.
+     *
+     * @returns {Promise<{ version: string }>} A promise that resolves to an object
+     *   containing the version string of the native plugin.
+     *
+     * @throws {Error} Throws an error if the version information cannot be retrieved.
+     *
+     * @example
+     * ```typescript
+     * const { version } = await CapacitorPersistentAccount.getPluginVersion();
+     * console.log('Plugin version:', version);
+     * ```
      */
     getPluginVersion(): Promise<{
         version: string;

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface CapacitorPersistentAccountPlugin {\n  readAccount(): Promise<{ data: unknown | null }>;\n  saveAccount(options: { data: unknown }): Promise<void>;\n\n  /**\n   * Get the native Capacitor plugin version\n   *\n   * @returns {Promise<{ id: string }>} an Promise with version for this device\n   * @throws An error if the something went wrong\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Capacitor Persistent Account Plugin\n *\n * Provides persistent storage for account data across app sessions using platform-specific\n * secure storage mechanisms. On iOS, this uses the Keychain. On Android, this uses\n * AccountManager. This ensures account data persists even after app reinstallation.\n *\n * @interface CapacitorPersistentAccountPlugin\n */\nexport interface CapacitorPersistentAccountPlugin {\n  /**\n   * Reads the stored account data from persistent storage.\n   *\n   * Retrieves account data that was previously saved using saveAccount(). The data\n   * persists across app sessions and survives app reinstallation on supported platforms.\n   *\n   * @returns {Promise<{ data: unknown | null }>} A promise that resolves to an object\n   *   containing the stored account data, or null if no data has been saved yet.\n   *\n   * @example\n   * ```typescript\n   * const result = await CapacitorPersistentAccount.readAccount();\n   * if (result.data) {\n   *   console.log('Account data:', result.data);\n   * } else {\n   *   console.log('No account data found');\n   * }\n   * ```\n   */\n  readAccount(): Promise<{ data: unknown | null }>;\n\n  /**\n   * Saves account data to persistent storage.\n   *\n   * Stores the provided account data using platform-specific secure storage mechanisms.\n   * The data will persist across app sessions and survive app reinstallation.\n   * Any existing account data will be overwritten.\n   *\n   * @param {Object} options - The options object containing the data to save.\n   * @param {unknown} options.data - The account data to persist. Can be any serializable data type.\n   *\n   * @returns {Promise<void>} A promise that resolves when the data has been successfully saved.\n   *\n   * @throws {Error} Throws an error if the data cannot be saved to persistent storage.\n   *\n   * @example\n   * ```typescript\n   * await CapacitorPersistentAccount.saveAccount({\n   *   data: {\n   *     userId: '12345',\n   *     username: 'john.doe',\n   *     email: 'john@example.com'\n   *   }\n   * });\n   * ```\n   */\n  saveAccount(options: { data: unknown }): Promise<void>;\n\n  /**\n   * Get the native Capacitor plugin version\n   *\n   * Returns the version string of the native plugin implementation. Useful for\n   * debugging and ensuring compatibility between the JavaScript and native layers.\n   *\n   * @returns {Promise<{ version: string }>} A promise that resolves to an object\n   *   containing the version string of the native plugin.\n   *\n   * @throws {Error} Throws an error if the version information cannot be retrieved.\n   *\n   * @example\n   * ```typescript\n   * const { version } = await CapacitorPersistentAccount.getPluginVersion();\n   * console.log('Plugin version:', version);\n   * ```\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\n"]}

package/ios/Sources/CapacitorPersistentAccountPlugin/CapacitorPersistentAccountPlugin.swift

@@ -7,7 +7,7 @@ import Capacitor
  */
 @objc(CapacitorPersistentAccountPlugin)
 public class CapacitorPersistentAccountPlugin: CAPPlugin, CAPBridgedPlugin {
-    private let PLUGIN_VERSION: String = "7.1.3"
+    private let PLUGIN_VERSION: String = "7.2.1"
     public let identifier = "CapacitorPersistentAccountPlugin"
     public let jsName = "CapacitorPersistentAccount"
     public let pluginMethods: [CAPPluginMethod] = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-persistent-account",
-  "version": "7.1.3",
+  "version": "7.2.1",
   "description": "This plugin allows you to securely store account information for a user in Capacitor",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",