@capacitor-community/sqlite 6.0.1 → 6.0.2-dev.ecc62b3.1738008093

package/src/definitions.ts

@@ -376,18 +376,14 @@ export interface CapacitorSQLitePlugin {
    * @returns Promise<capSQLiteResult>
    * @since 3.0.0-beta.11
    */
-  checkConnectionsConsistency(
-    options: capAllConnectionsOptions,
-  ): Promise<capSQLiteResult>;
+  checkConnectionsConsistency(options: capAllConnectionsOptions): Promise<capSQLiteResult>;
   /**
    * get a non conformed database path
    * @param options capNCDatabasePathOptions
    * @return Promise<capNCDatabasePathResult>
    * @since 3.3.3-1
    */
-  getNCDatabasePath(
-    options: capNCDatabasePathOptions,
-  ): Promise<capNCDatabasePathResult>;
+  getNCDatabasePath(options: capNCDatabasePathOptions): Promise<capNCDatabasePathResult>;
   /**
    * create a non conformed database connection
    * @param options capNCConnectionOptions
@@ -1117,10 +1113,7 @@ export interface ISQLiteConnection {
    * @returns Promise<void>
    * @since 3.0.0-beta.13
    */
-  changeEncryptionSecret(
-    passphrase: string,
-    oldpassphrase: string,
-  ): Promise<void>;
+  changeEncryptionSecret(passphrase: string, oldpassphrase: string): Promise<void>;
   /**
    * Clear the passphrase in a secure store
    * @returns Promise<void>
@@ -1137,14 +1130,11 @@ export interface ISQLiteConnection {
   /**
    * Add the upgrade Statement for database version upgrading
    * @param database
-   * @param upgrade @since 5.6.4 
+   * @param upgrade @since 5.6.4
    * @returns Promise<void>
    * @since 2.9.0 refactor
    */
-  addUpgradeStatement(
-    database: string,
-    upgrade: capSQLiteVersionUpgrade[]
-  ): Promise<void>;
+  addUpgradeStatement(database: string, upgrade: capSQLiteVersionUpgrade[]): Promise<void>;
   /**
    * Create a connection to a database
    * @param database
@@ -1177,10 +1167,7 @@ export interface ISQLiteConnection {
    * @returns Promise<SQLiteDBConnection>
    * @since 2.9.0 refactor
    */
-  retrieveConnection(
-    database: string,
-    readonly: boolean,
-  ): Promise<SQLiteDBConnection>;
+  retrieveConnection(database: string, readonly: boolean): Promise<SQLiteDBConnection>;
   /**
    * Retrieve all database connections
    * @returns Promise<Map<string, SQLiteDBConnection>>
@@ -1216,10 +1203,7 @@ export interface ISQLiteConnection {
    * @returns Promise<capNCDatabasePathResult>
    * @since 3.3.3-1
    */
-  getNCDatabasePath(
-    path: string,
-    database: string,
-  ): Promise<capNCDatabasePathResult>;
+  getNCDatabasePath(path: string, database: string): Promise<capNCDatabasePathResult>;
   /**
    * Create a non-conformed database connection
    * @param databasePath
@@ -1227,10 +1211,7 @@ export interface ISQLiteConnection {
    * @returns Promise<SQLiteDBConnection>
    * @since 3.3.3-1
    */
-  createNCConnection(
-    databasePath: string,
-    version: number,
-  ): Promise<SQLiteDBConnection>;
+  createNCConnection(databasePath: string, version: number): Promise<SQLiteDBConnection>;
   /**
    * Close a non-conformed database connection
    * @param databasePath
@@ -1351,10 +1332,7 @@ export interface ISQLiteConnection {
    * @param folderPath the origin from where to move the databases
    * @param dbNameList the names of the databases to move, check out the getMigratableDbList to get a list, an empty list will result in copying all the databases with '.db' extension.
    */
-  moveDatabasesAndAddSuffix(
-    folderPath?: string,
-    dbNameList?: string[],
-  ): Promise<void>;
+  moveDatabasesAndAddSuffix(folderPath?: string, dbNameList?: string[]): Promise<void>;
 }
 /**
  * SQLiteConnection Class
@@ -1423,10 +1401,7 @@ export class SQLiteConnection implements ISQLiteConnection {
       return Promise.reject(err);
     }
   }
-  async changeEncryptionSecret(
-    passphrase: string,
-    oldpassphrase: string,
-  ): Promise<void> {
+  async changeEncryptionSecret(passphrase: string, oldpassphrase: string): Promise<void> {
     try {
       await this.sqlite.changeEncryptionSecret({
         passphrase: passphrase,
@@ -1455,10 +1430,7 @@ export class SQLiteConnection implements ISQLiteConnection {
       return Promise.reject(err);
     }
   }
-  async addUpgradeStatement(
-    database: string,
-    upgrade: capSQLiteVersionUpgrade[]
-  ): Promise<void> {
+  async addUpgradeStatement(database: string, upgrade: capSQLiteVersionUpgrade[]): Promise<void> {
     try {
       if (database.endsWith('.db')) database = database.slice(0, -3);
       await this.sqlite.addUpgradeStatement({
@@ -1516,20 +1488,14 @@ export class SQLiteConnection implements ISQLiteConnection {
       return Promise.reject(err);
     }
   }
-  async isConnection(
-    database: string,
-    readonly: boolean,
-  ): Promise<capSQLiteResult> {
+  async isConnection(database: string, readonly: boolean): Promise<capSQLiteResult> {
     const res: capSQLiteResult = {} as capSQLiteResult;
     if (database.endsWith('.db')) database = database.slice(0, -3);
     const connName = readonly ? `RO_${database}` : `RW_${database}`;
     res.result = this._connectionDict.has(connName);
     return Promise.resolve(res);
   }
-  async retrieveConnection(
-    database: string,
-    readonly: boolean,
-  ): Promise<SQLiteDBConnection> {
+  async retrieveConnection(database: string, readonly: boolean): Promise<SQLiteDBConnection> {
     if (database.endsWith('.db')) database = database.slice(0, -3);
     const connName = readonly ? `RO_${database}` : `RW_${database}`;
     if (this._connectionDict.has(connName)) {
@@ -1542,25 +1508,18 @@ export class SQLiteConnection implements ISQLiteConnection {
       return Promise.reject(`Connection ${database} does not exist`);
     }
   }
-  async getNCDatabasePath(
-    path: string,
-    database: string,
-  ): Promise<capNCDatabasePathResult> {
+  async getNCDatabasePath(path: string, database: string): Promise<capNCDatabasePathResult> {
     try {
-      const databasePath: capNCDatabasePathResult =
-        await this.sqlite.getNCDatabasePath({
-          path,
-          database,
-        });
+      const databasePath: capNCDatabasePathResult = await this.sqlite.getNCDatabasePath({
+        path,
+        database,
+      });
       return Promise.resolve(databasePath);
     } catch (err) {
       return Promise.reject(err);
     }
   }
-  async createNCConnection(
-    databasePath: string,
-    version: number,
-  ): Promise<SQLiteDBConnection> {
+  async createNCConnection(databasePath: string, version: number): Promise<SQLiteDBConnection> {
     try {
       await this.sqlite.createNCConnection({
         databasePath,
@@ -1590,9 +1549,7 @@ export class SQLiteConnection implements ISQLiteConnection {
     res.result = this._connectionDict.has(connName);
     return Promise.resolve(res);
   }
-  async retrieveNCConnection(
-    databasePath: string,
-  ): Promise<SQLiteDBConnection> {
+  async retrieveNCConnection(databasePath: string): Promise<SQLiteDBConnection> {
     if (this._connectionDict.has(databasePath)) {
       const connName = `RO_${databasePath})`;
       const conn = this._connectionDict.get(connName);
@@ -1648,11 +1605,10 @@ export class SQLiteConnection implements ISQLiteConnection {
         openModes.push(key.substring(0, 2));
         dbNames.push(key.substring(3));
       }
-      const res: capSQLiteResult =
-        await this.sqlite.checkConnectionsConsistency({
-          dbNames: dbNames,
-          openModes: openModes,
-        });
+      const res: capSQLiteResult = await this.sqlite.checkConnectionsConsistency({
+        dbNames: dbNames,
+        openModes: openModes,
+      });
       if (!res.result) this._connectionDict = new Map();
       return Promise.resolve(res);
     } catch (err) {
@@ -1751,10 +1707,7 @@ export class SQLiteConnection implements ISQLiteConnection {
       return Promise.reject(err);
     }
   }
-  async addSQLiteSuffix(
-    folderPath?: string,
-    dbNameList?: string[],
-  ): Promise<void> {
+  async addSQLiteSuffix(folderPath?: string, dbNameList?: string[]): Promise<void> {
     const path: string = folderPath ? folderPath : 'default';
     const dbList: string[] = dbNameList ? dbNameList : [];
     try {
@@ -1767,10 +1720,7 @@ export class SQLiteConnection implements ISQLiteConnection {
       return Promise.reject(err);
     }
   }
-  async deleteOldDatabases(
-    folderPath?: string,
-    dbNameList?: string[],
-  ): Promise<void> {
+  async deleteOldDatabases(folderPath?: string, dbNameList?: string[]): Promise<void> {
     const path: string = folderPath ? folderPath : 'default';
     const dbList: string[] = dbNameList ? dbNameList : [];
     try {
@@ -1784,10 +1734,7 @@ export class SQLiteConnection implements ISQLiteConnection {
     }
   }
 
-  async moveDatabasesAndAddSuffix(
-    folderPath?: string,
-    dbNameList?: string[],
-  ): Promise<void> {
+  async moveDatabasesAndAddSuffix(folderPath?: string, dbNameList?: string[]): Promise<void> {
     const path: string = folderPath ? folderPath : 'default';
     const dbList: string[] = dbNameList ? dbNameList : [];
     return this.sqlite.moveDatabasesAndAddSuffix({
@@ -1885,11 +1832,7 @@ export interface ISQLiteDBConnection {
    * @returns Promise<capSQLiteChanges>
    * @since 2.9.0 refactor
    */
-  execute(
-    statements: string,
-    transaction?: boolean,
-    isSQL92?: boolean,
-  ): Promise<capSQLiteChanges>;
+  execute(statements: string, transaction?: boolean, isSQL92?: boolean): Promise<capSQLiteChanges>;
   /**
    * Execute SQLite DB Connection Query
    * @param statement
@@ -1898,11 +1841,7 @@ export interface ISQLiteDBConnection {
    * @returns Promise<Promise<DBSQLiteValues>
    * @since 2.9.0 refactor
    */
-  query(
-    statement: string,
-    values?: any[],
-    isSQL92?: boolean,
-  ): Promise<DBSQLiteValues>;
+  query(statement: string, values?: any[], isSQL92?: boolean): Promise<DBSQLiteValues>;
   /**
    * Execute SQLite DB Connection Raw Statement
    * @param statement
@@ -2005,10 +1944,7 @@ export interface ISQLiteDBConnection {
    * @returns Promise<capSQLiteChanges> since 5.0.7
    * @since 3.4.0
    */
-  executeTransaction(
-    txn: capTask[],
-    isSQL92: boolean,
-  ): Promise<capSQLiteChanges>;
+  executeTransaction(txn: capTask[], isSQL92: boolean): Promise<capSQLiteChanges>;
 }
 /**
  * SQLiteDBConnection Class
@@ -2148,11 +2084,7 @@ export class SQLiteDBConnection implements ISQLiteDBConnection {
       return Promise.reject(err);
     }
   }
-  async execute(
-    statements: string,
-    transaction = true,
-    isSQL92 = true,
-  ): Promise<capSQLiteChanges> {
+  async execute(statements: string, transaction = true, isSQL92 = true): Promise<capSQLiteChanges> {
     try {
       if (!this.readonly) {
         const res: any = await this.sqlite.execute({
@@ -2170,11 +2102,7 @@ export class SQLiteDBConnection implements ISQLiteDBConnection {
       return Promise.reject(err);
     }
   }
-  async query(
-    statement: string,
-    values?: any[],
-    isSQL92 = true,
-  ): Promise<DBSQLiteValues> {
+  async query(statement: string, values?: any[], isSQL92 = true): Promise<DBSQLiteValues> {
     let res: any;
     try {
       if (values && values.length > 0) {
@@ -2358,8 +2286,7 @@ export class SQLiteDBConnection implements ISQLiteDBConnection {
         readonly: this.readonly,
       });
       let retDate = '';
-      if (res.syncDate > 0)
-        retDate = new Date(res.syncDate * 1000).toISOString();
+      if (res.syncDate > 0) retDate = new Date(res.syncDate * 1000).toISOString();
       return Promise.resolve(retDate);
     } catch (err) {
       return Promise.reject(err);
@@ -2394,10 +2321,7 @@ export class SQLiteDBConnection implements ISQLiteDBConnection {
     }
   }
 
-  async executeTransaction(
-    txn: capTask[],
-    isSQL92 = true,
-  ): Promise<capSQLiteChanges> {
+  async executeTransaction(txn: capTask[], isSQL92 = true): Promise<capSQLiteChanges> {
     let changes = 0;
     let isActive = false;
     if (!this.readonly) {
@@ -2408,19 +2332,15 @@ export class SQLiteDBConnection implements ISQLiteDBConnection {
         database: this.dbName,
       });
       if (!isActive) {
-        return Promise.reject(
-          'After Begin Transaction, no transaction active',
-        );
+        return Promise.reject('After Begin Transaction, no transaction active');
       }
       try {
         for (const task of txn) {
-          if(typeof task !== 'object' || !('statement' in task)) {
+          if (typeof task !== 'object' || !('statement' in task)) {
             throw new Error('Error a task.statement must be provided');
           }
           if ('values' in task && task.values && task.values.length > 0) {
-            const retMode = task.statement.toUpperCase().includes('RETURNING')
-              ? 'all'
-              : 'no';
+            const retMode = task.statement.toUpperCase().includes('RETURNING') ? 'all' : 'no';
             const ret = await this.sqlite.run({
               database: this.dbName,
               statement: task.statement,

package/src/index.ts

@@ -2,14 +2,10 @@ import { registerPlugin } from '@capacitor/core';
 
 import type { CapacitorSQLitePlugin } from './definitions';
 
-const CapacitorSQLite = registerPlugin<CapacitorSQLitePlugin>(
-  'CapacitorSQLite',
-  {
-    web: () => import('./web').then(m => new m.CapacitorSQLiteWeb()),
-    electron: () =>
-      (window as any).CapacitorCustomPlatform.plugins.CapacitorSQLite,
-  },
-);
+const CapacitorSQLite = registerPlugin<CapacitorSQLitePlugin>('CapacitorSQLite', {
+  web: () => import('./web').then((m) => new m.CapacitorSQLiteWeb()),
+  electron: () => (window as any).CapacitorCustomPlatform.plugins.CapacitorSQLite,
+});
 
 export { CapacitorSQLite };
 export * from './definitions';