@capacitor-community/sqlite 4.6.3-4 → 4.8.0-0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor-community/sqlite",
-  "version": "4.6.3-4",
+  "version": "4.8.0-0",
   "description": "Community plugin for native & electron SQLite databases",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -56,11 +56,11 @@
     "prepublishOnly": "npm run build && npm run build-electron && npm run docgen"
   },
   "devDependencies": {
-    "@capacitor/android": "^4.6.3",
-    "@capacitor/cli": "^4.6.3",
-    "@capacitor/core": "^4.6.3",
+    "@capacitor/android": "^4.8.0",
+    "@capacitor/cli": "^4.8.0",
+    "@capacitor/core": "^4.8.0",
     "@capacitor/docgen": "^0.0.17",
-    "@capacitor/ios": "^4.6.3",
+    "@capacitor/ios": "^4.8.0",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "^1.0.1",
     "@ionic/swiftlint-config": "^1.1.2",
@@ -95,6 +95,6 @@
     }
   },
   "dependencies": {
-    "jeep-sqlite": "^2.0.0"
+    "jeep-sqlite": "^2.3.3"
   }
 }

package/src/definitions.ts

@@ -21,6 +21,24 @@ export interface CapacitorSQLitePlugin {
    */
 
   saveToStore(options: capSQLiteOptions): Promise<void>;
+  /**
+   * Get database from local disk and save it to store
+   *
+   * @param options: capSQLiteLocalDiskOptions
+   * @return Promise<void>
+   * @since 4.6.3
+   */
+
+  getFromLocalDiskToStore(options: capSQLiteLocalDiskOptions): Promise<void>;
+  /**
+   * Save database to local disk
+   *
+   * @param options: capSQLiteOptions
+   * @return Promise<void>
+   * @since 4.6.3
+   */
+
+  saveToLocalDisk(options: capSQLiteOptions): Promise<void>;
   /**
    * Check if a passphrase exists in a secure store
    *
@@ -570,6 +588,14 @@ export interface capSQLiteFromAssetsOptions {
    */
   overwrite?: boolean;
 }
+export interface capSQLiteLocalDiskOptions {
+  /**
+   * Set the overwrite mode for saving the database from local disk to store
+   * "true"/"false"  default to "true"
+   *
+   */
+  overwrite?: boolean;
+}
 export interface capSQLiteHTTPOptions {
   /**
    * The url of the database or the zipped database(s)
@@ -856,6 +882,22 @@ export interface capJsonProgressListener {
    */
   progress?: string;
 }
+export interface capHttpRequestEndedListener {
+  /**
+   * Message
+   */
+  message?: string;
+}
+export interface capPickOrSaveDatabaseEndedListener {
+  /**
+   * Pick Database's name
+   */
+  db_name?: string;
+  /**
+   * Message
+   */
+  message?: string;
+}
 export interface capSQLiteVersionUpgrade {
   toVersion: number;
   statements: string[];
@@ -878,6 +920,22 @@ export interface ISQLiteConnection {
    * @since 3.2.3-1
    */
   saveToStore(database: string): Promise<void>;
+  /**
+   * Get database from local disk and save it to store
+   *
+   * @param overwrite: boolean
+   * @return Promise<void>
+   * @since 4.6.3
+   */
+  getFromLocalDiskToStore(overwrite: boolean): Promise<void>;
+  /**
+   * Save database to local disk
+   *
+   * @param database: string
+   * @return Promise<void>
+   * @since 4.6.3
+   */
+  saveToLocalDisk(database: string): Promise<void>;
   /**
    * Echo a value
    * @param value
@@ -1170,6 +1228,25 @@ export class SQLiteConnection implements ISQLiteConnection {
       return Promise.reject(err);
     }
   }
+  async saveToLocalDisk(database: string): Promise<void> {
+    try {
+      await this.sqlite.saveToLocalDisk({ database });
+      return Promise.resolve();
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+  async getFromLocalDiskToStore(overwrite?: boolean): Promise<void> {
+    const mOverwrite: boolean = overwrite != null ? overwrite : true;
+
+    try {
+      await this.sqlite.getFromLocalDiskToStore({ overwrite: mOverwrite });
+      return Promise.resolve();
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+
   async echo(value: string): Promise<capEchoResult> {
     try {
       const res = await this.sqlite.echo({ value });

package/src/web.ts

@@ -16,6 +16,7 @@ import type {
   capSQLiteExportOptions,
   capSQLiteFromAssetsOptions,
   capSQLiteHTTPOptions,
+  capSQLiteLocalDiskOptions,
   capSQLiteImportOptions,
   capSQLiteJson,
   capSQLiteOptions,
@@ -59,6 +60,24 @@ export class CapacitorSQLiteWeb
         this.notifyListeners('sqliteExportProgressEvent', event.detail);
       },
     );
+    this.jeepSqliteElement.addEventListener(
+      'jeepSqliteHTTPRequestEnded',
+      (event: CustomEvent) => {
+        this.notifyListeners('sqliteHTTPRequestEndedEvent', event.detail);
+      },
+    );
+    this.jeepSqliteElement.addEventListener(
+      'jeepSqlitePickDatabaseEnded',
+      (event: CustomEvent) => {
+        this.notifyListeners('sqlitePickDatabaseEndedEvent', event.detail);
+      },
+    );
+    this.jeepSqliteElement.addEventListener(
+      'jeepSqliteSaveDatabaseToDisk',
+      (event: CustomEvent) => {
+        this.notifyListeners('sqliteSaveDatabaseToDiskEvent', event.detail);
+      },
+    );
 
     if (!this.isWebStoreOpen) {
       this.isWebStoreOpen = await this.jeepSqliteElement.isStoreOpen();
@@ -78,6 +97,30 @@ export class CapacitorSQLiteWeb
       throw new Error(`${err}`);
     }
   }
+  async getFromLocalDiskToStore(
+    options: capSQLiteLocalDiskOptions,
+  ): Promise<void> {
+    this.ensureJeepSqliteIsAvailable();
+    this.ensureWebstoreIsOpen();
+
+    try {
+      await this.jeepSqliteElement.getFromLocalDiskToStore(options);
+      return;
+    } catch (err) {
+      throw new Error(`${err}`);
+    }
+  }
+  async saveToLocalDisk(options: capSQLiteOptions): Promise<void> {
+    this.ensureJeepSqliteIsAvailable();
+    this.ensureWebstoreIsOpen();
+
+    try {
+      await this.jeepSqliteElement.saveToLocalDisk(options);
+      return;
+    } catch (err) {
+      throw new Error(`${err}`);
+    }
+  }
 
   async echo(options: capEchoOptions): Promise<capEchoResult> {
     this.ensureJeepSqliteIsAvailable();