@capacitor-community/sqlite 5.0.5-2 → 5.0.6

package/src/definitions.ts

@@ -120,6 +120,20 @@ export interface CapacitorSQLitePlugin {
    * @since 0.0.1
    */
   close(options: capSQLiteOptions): Promise<void>;
+  /**
+   * Load a SQlite extension
+   * @param options :capSQLiteExtensionPath
+   * @returns Promise<void>
+   * @since 5.0.6
+   */
+  //  loadExtension(options: capSQLiteExtensionPath): Promise<void>;
+  /**
+   * Enable Or Disable Extension Loading
+   * @param options
+   * @returns Promise<void>
+   * @since 5.0.6
+   */
+  //  enableLoadExtension(options: capSQLiteExtensionEnable): Promise<void>;
   /**
    * GetUrl get the database Url
    * @param options: capSQLiteOptions
@@ -391,6 +405,38 @@ export interface capEchoOptions {
    */
   value?: string;
 }
+export interface capSQLiteExtensionPath {
+  /**
+   * The database name
+   */
+  database?: string;
+  /**
+   * The extension path
+   */
+  path?: string;
+  /**
+   * ReadOnly / ReadWrite
+   * default ReadWrite (false)
+   * @since 4.1.0-7
+   */
+  readonly?: boolean;
+}
+export interface capSQLiteExtensionEnable {
+  /**
+   * The database name
+   */
+  database?: string;
+  /**
+   * The enabling toggle (1: ON, 0: OFF)
+   */
+  toggle?: boolean;
+  /**
+   * ReadOnly / ReadWrite
+   * default ReadWrite (false)
+   * @since 4.1.0-7
+   */
+  readonly?: boolean;
+}
 export interface capConnectionOptions {
   /**
    * The database name
@@ -436,6 +482,7 @@ export interface capSQLiteOptions {
    */
   readonly?: boolean;
 }
+
 export interface capNCDatabasePathOptions {
   /**
    * the database path
@@ -506,6 +553,14 @@ export interface capSQLiteSetOptions {
    * @since 4.1.0-7
    */
   readonly?: boolean;
+  /**
+   * return mode
+   * default 'no'
+   * value 'all'
+   * value 'one' for Electron platform
+   * @since 5.0.5-3
+   */
+  returnMode?: string;
 }
 export interface capSQLiteRunOptions {
   /**
@@ -532,6 +587,14 @@ export interface capSQLiteRunOptions {
    * @since 4.1.0-7
    */
   readonly?: boolean;
+  /**
+   * return mode
+   * default 'no'
+   * value 'all'
+   * value 'one' for Electron platform
+   * @since 5.0.5-3
+   */
+  returnMode?: string;
 }
 export interface capSQLiteQueryOptions {
   /**
@@ -721,6 +784,10 @@ export interface Changes {
    * the lastId created from a run command
    */
   lastId?: number;
+  /**
+   * values when RETURNING
+   */
+  values?: any[];
 }
 export interface capSQLiteValues {
   /**
@@ -749,6 +816,12 @@ export interface capSQLiteSyncDate {
 }
 
 /* JSON Types */
+export interface EncryptJson {
+  /**
+   * The encrypted JsonSQLite base64 string
+   */
+  expData: string;
+}
 export interface JsonSQLite {
   /**
    * The database name
@@ -1572,7 +1645,7 @@ export class SQLiteConnection implements ISQLiteConnection {
       const res = await this.sqlite.getDatabaseList();
       const values: string[] = res.values;
       values.sort();
-      const ret = {values: values};
+      const ret = { values: values };
       return Promise.resolve(ret);
     } catch (err) {
       return Promise.reject(err);
@@ -1679,6 +1752,20 @@ export interface ISQLiteDBConnection {
    * @since 3.2.0
    */
   getVersion(): Promise<capVersionResult>;
+  /**
+   * Load a SQlite extension
+   * @param path :SQlite extension path
+   * @returns Promise<void>
+   * @since 5.0.6
+   */
+  loadExtension(path: string): Promise<void>;
+  /**
+   * Enable Or Disable Extension Loading
+   * @param toggle true:on false:off
+   * @returns Promise<void>
+   * @since 5.0.6
+   */
+  enableLoadExtension(toggle: boolean): Promise<void>;
   /**
    * Execute SQLite DB Connection Statements
    * @param statements
@@ -1705,6 +1792,7 @@ export interface ISQLiteDBConnection {
     statement: string,
     values?: any[],
     transaction?: boolean,
+    returnMode?: string,
   ): Promise<capSQLiteChanges>;
   /**
    * Execute SQLite DB Connection Set
@@ -1715,6 +1803,7 @@ export interface ISQLiteDBConnection {
   executeSet(
     set: capSQLiteSet[],
     transaction?: boolean,
+    returnMode?: string,
   ): Promise<capSQLiteChanges>;
   /**
    * Check if a SQLite DB Connection exists
@@ -1827,6 +1916,43 @@ export class SQLiteDBConnection implements ISQLiteDBConnection {
       return Promise.reject(err);
     }
   }
+
+  async loadExtension(path: string): Promise<void> {
+    try {
+      console.log(`database: ${this.dbName}`);
+      console.log(`readonly: ${this.readonly}}`);
+      console.log(`path: ${path}}`);
+      await this.sqlite.loadExtension({
+        database: this.dbName,
+        path: path,
+        readonly: this.readonly,
+      });
+      console.log(`loadExtension successful`);
+      return Promise.resolve();
+    } catch (err) {
+      console.log(`loadExtension failed `);
+      return Promise.reject(err);
+    }
+  }
+  async enableLoadExtension(toggle: boolean): Promise<void> {
+    try {
+      console.log(`database: ${this.dbName}`);
+      console.log(`readonly: ${this.readonly}`);
+      console.log(`toggle: ${toggle}`);
+      await this.sqlite.enableLoadExtension({
+        database: this.dbName,
+        toggle: toggle,
+        readonly: this.readonly,
+      });
+      console.log(`enableLoadExtension successful`);
+      return Promise.resolve();
+    } catch (err) {
+      console.log(err);
+      console.log(`enableLoadExtension failed `);
+      return Promise.reject(err);
+    }
+  }
+
   async getUrl(): Promise<capSQLiteUrl> {
     try {
       const res: capSQLiteUrl = await this.sqlite.getUrl({
@@ -1898,22 +2024,9 @@ export class SQLiteDBConnection implements ISQLiteDBConnection {
           readonly: this.readonly,
         });
       }
-      if (res && typeof res.values[0] === 'object') {
-        if (Object.keys(res.values[0]).includes('ios_columns')) {
-          const columnList: string[] = res.values[0]['ios_columns'];
-          const iosRes: any[] = [];
-          for (let i = 1; i < res.values.length; i++) {
-            const rowJson: any = res.values[i];
-            const resRowJson: any = {};
-            for (const item of columnList) {
-              resRowJson[item] = rowJson[item];
-            }
-            iosRes.push(resRowJson);
-          }
-          res = {};
-          res['values'] = iosRes;
-        }
-      }
+
+      // reorder rows for ios
+      res = await this.reorderRows(res);
       return Promise.resolve(res);
     } catch (err) {
       return Promise.reject(err);
@@ -1923,28 +2036,39 @@ export class SQLiteDBConnection implements ISQLiteDBConnection {
     statement: string,
     values?: any[],
     transaction = true,
+    returnMode = 'no',
   ): Promise<capSQLiteChanges> {
     let res: any;
     try {
       if (!this.readonly) {
         if (values && values.length > 0) {
+          const mRetMode = statement.toUpperCase().includes('RETURNING')
+            ? returnMode
+            : 'no';
           res = await this.sqlite.run({
             database: this.dbName,
             statement: statement,
             values: values,
             transaction: transaction,
             readonly: false,
+            returnMode: mRetMode,
           });
           //        }
         } else {
+          const mRetMode = statement.toUpperCase().includes('RETURNING')
+            ? returnMode
+            : 'no';
           res = await this.sqlite.run({
             database: this.dbName,
             statement: statement,
             values: [],
             transaction: transaction,
             readonly: false,
+            returnMode: mRetMode,
           });
         }
+        // reorder rows for ios
+        res.changes = await this.reorderRows(res.changes);
         return Promise.resolve(res);
       } else {
         return Promise.reject('not allowed in read-only mode');
@@ -1956,16 +2080,21 @@ export class SQLiteDBConnection implements ISQLiteDBConnection {
   async executeSet(
     set: capSQLiteSet[],
     transaction = true,
+    returnMode = 'no',
   ): Promise<capSQLiteChanges> {
+    let res: any;
     try {
       if (!this.readonly) {
-        const res: any = await this.sqlite.executeSet({
+        res = await this.sqlite.executeSet({
           database: this.dbName,
           set: set,
           transaction: transaction,
           readonly: false,
+          returnMode: returnMode,
         });
         //      }
+        // reorder rows for ios
+        res.changes = await this.reorderRows(res.changes);
         return Promise.resolve(res);
       } else {
         return Promise.reject('not allowed in read-only mode');
@@ -2111,12 +2240,16 @@ export class SQLiteDBConnection implements ISQLiteDBConnection {
         }
         for (const task of txn) {
           if (task.values && task.values.length > 0) {
+            const retMode = task.statement.toUpperCase().includes('RETURNING')
+              ? 'all'
+              : 'no';
             const ret = await this.sqlite.run({
               database: this.dbName,
               statement: task.statement,
               values: task.values,
               transaction: false,
               readonly: false,
+              returnMode: retMode,
             });
             if (ret.changes.lastId === -1) {
               await this.execute('ROLLBACK;', false);
@@ -2160,4 +2293,24 @@ export class SQLiteDBConnection implements ISQLiteDBConnection {
       return Promise.reject(err);
     }
   }
+  private async reorderRows(res: any): Promise<any> {
+    const retRes: any = res;
+    if (res?.values && typeof res.values[0] === 'object') {
+      if (Object.keys(res.values[0]).includes('ios_columns')) {
+        const columnList: string[] = res.values[0]['ios_columns'];
+        const iosRes: any[] = [];
+        for (let i = 1; i < res.values.length; i++) {
+          const rowJson: any = res.values[i];
+          const resRowJson: any = {};
+          for (const item of columnList) {
+            resRowJson[item] = rowJson[item];
+          }
+          iosRes.push(resRowJson);
+        }
+        retRes['values'] = iosRes;
+      }
+    }
+
+    return Promise.resolve(retRes);
+  }
 }

package/src/web.ts

@@ -32,6 +32,8 @@ import type {
   capSQLiteUrl,
   capSQLiteValues,
   capVersionResult,
+  capSQLiteExtensionPath,
+  capSQLiteExtensionEnable,
 } from './definitions';
 
 export class CapacitorSQLiteWeb
@@ -591,4 +593,12 @@ export class CapacitorSQLiteWeb
   async isInConfigBiometricAuth(): Promise<capSQLiteResult> {
     throw this.unimplemented('Not implemented on web.');
   }
+  async loadExtension(options: capSQLiteExtensionPath): Promise<void> {
+    console.log('loadExtension', options);
+    throw this.unimplemented('Not implemented on web.');
+  }
+  async enableLoadExtension(options: capSQLiteExtensionEnable): Promise<void> {
+    console.log('enableLoadExtension', options);
+    throw this.unimplemented('Not implemented on web.');
+  }
 }