react-sqlite-hook - npm Package Compare versions

Comparing version 2.0.0-alpha.1 to 2.0.0

CHANGELOG.md

@@ -0,1 +1,8 @@
+## 2.0.0 (2021-03-20) REFACTOR
+
+## Chore
+
+- @capacitor/core@3.0.0-rc.0
+- @capacitor-community/sqlite@3.0.0-beta.7
+
 ## 2.0.0-alpha.1 (2021-01-26) REFACTOR
@@ -2,0 +9,0 @@

dist/package.json

 {
   "name": "react-sqlite-hook",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0-alpha.1",
   "description": "React Hook for @Capacitor-community/sqlite plugin",
@@ -47,8 +47,8 @@ "repository": {
     "react": "^17.0.1",
-    "@capacitor/core": "next",
-    "@capacitor-community/sqlite": "next"
+    "@capacitor/core": "^3.0.0-rc.0",
+    "@capacitor-community/sqlite": "^3.0.0-beta.7"
   },
   "devDependencies": {
-    "@capacitor-community/sqlite": "next",
-    "@capacitor/core": "next",
+    "@capacitor-community/sqlite": "^3.0.0-beta.7",
+    "@capacitor/core": "^3.0.0-rc.0",
     "@capacitor/docgen": "0.0.14",
@@ -55,0 +55,0 @@ "@testing-library/react-hooks": "^3.4.2",

dist/useSQLite.d.ts

 import { AvailableResult } from './util/models';
-import { SQLiteDBConnection, capSQLiteChanges } from '@capacitor-community/sqlite';
+import { SQLiteDBConnection, capSQLiteChanges, capSQLiteValues } from '@capacitor-community/sqlite';
 export { SQLiteDBConnection };
@@ -70,2 +70,36 @@ /**
     /**
+     * Check if database connection exists
+     * @param database
+     * @returns Promise<Result>
+     * @since 2.0.0
+     */
+    isConnection(database: string): Promise<Result>;
+    /**
+     * Check if database exists
+     * @param database
+     * @returns Promise<Result>
+     * @since 2.0.0
+     */
+    isDatabase(database: string): Promise<Result>;
+    /**
+     * Get the database list
+     * @returns Promise<capSQLiteValues>
+     * @since 1.0.1 refactor
+     */
+    getDatabaseList(): Promise<capSQLiteValues>;
+    /**
+     * Add SQLIte Suffix to existing databases
+     * @param folderPath
+     * @returns Promise<void>
+     * @since 2.0.0
+     */
+    addSQLiteSuffix(folderPath?: string): Promise<void>;
+    /**
+     * Delete Old Cordova databases
+     * @param folderPath
+     * @returns Promise<void>
+     * @since 2.0.0
+     */
+    deleteOldDatabases(folderPath?: string): Promise<void>;
+    /**
      * Import a database From a JSON
@@ -72,0 +106,0 @@ * @param jsonstring string

dist/useSQLite.js

@@ -83,2 +83,95 @@ import { useCallback, useMemo } from 'react';
     /**
+     * Check if database connection exists
+     * @param database
+     */
+    const isConnection = useCallback(async (dbName) => {
+        if (dbName.length > 0) {
+            try {
+                const r = await mSQLite.isConnection(dbName);
+                if (r) {
+                    return Promise.resolve(r);
+                }
+                else {
+                    return Promise.reject("No returned isConnection");
+                }
+            }
+            catch (err) {
+                return Promise.reject(err);
+            }
+        }
+        else {
+            return Promise.reject('Must provide a database name');
+        }
+    }, [mSQLite]);
+    /**
+     * Check if database exists
+     * @param database
+     */
+    const isDatabase = useCallback(async (dbName) => {
+        if (dbName.length > 0) {
+            try {
+                const r = await mSQLite.isDatabase(dbName);
+                if (r) {
+                    return Promise.resolve(r);
+                }
+                else {
+                    return Promise.reject("Error in isDatabase");
+                }
+            }
+            catch (err) {
+                return Promise.reject(err);
+            }
+        }
+        else {
+            return Promise.reject('Must provide a database name');
+        }
+    }, [mSQLite]);
+    /**
+     * Get the database list
+     * @returns Promise<capSQLiteValues>
+     * @since 1.0.1 refactor
+     */
+    const getDatabaseList = useCallback(async () => {
+        try {
+            const r = await mSQLite.getDatabaseList();
+            if (r) {
+                return Promise.resolve(r);
+            }
+            else {
+                return Promise.reject("Error in getDatabaseList");
+            }
+        }
+        catch (err) {
+            return Promise.reject(err);
+        }
+    }, [mSQLite]);
+    /**
+     * Add SQLIte Suffix to existing databases
+     * @param folderPath
+     */
+    const addSQLiteSuffix = useCallback(async (folderPath) => {
+        const path = folderPath ? folderPath : "default";
+        try {
+            await mSQLite.addSQLiteSuffix(path);
+            return Promise.resolve();
+        }
+        catch (err) {
+            return Promise.reject(err);
+        }
+    }, [mSQLite]);
+    /**
+     * Delete Old Cordova databases
+     * @param folderPath
+     */
+    const deleteOldDatabases = useCallback(async (folderPath) => {
+        const path = folderPath ? folderPath : "default";
+        try {
+            await mSQLite.deleteOldDatabases(path);
+            return Promise.resolve();
+        }
+        catch (err) {
+            return Promise.reject(err);
+        }
+    }, [mSQLite]);
+    /**
      * Retrieve a Connection to the Database
@@ -216,3 +309,3 @@ * @param dbName string
     if (!availableFeaturesN.useSQLite) {
-        return Object.assign({ echo: featureNotAvailableError, getPlatform: featureNotAvailableError, createConnection: featureNotAvailableError, closeConnection: featureNotAvailableError, retrieveConnection: featureNotAvailableError, retrieveAllConnections: featureNotAvailableError, closeAllConnections: featureNotAvailableError, addUpgradeStatement: featureNotAvailableError, importFromJson: featureNotAvailableError, isJsonValid: featureNotAvailableError, copyFromAssets: featureNotAvailableError }, notAvailable);
+        return Object.assign({ echo: featureNotAvailableError, getPlatform: featureNotAvailableError, createConnection: featureNotAvailableError, closeConnection: featureNotAvailableError, retrieveConnection: featureNotAvailableError, retrieveAllConnections: featureNotAvailableError, closeAllConnections: featureNotAvailableError, addUpgradeStatement: featureNotAvailableError, importFromJson: featureNotAvailableError, isJsonValid: featureNotAvailableError, copyFromAssets: featureNotAvailableError, isConnection: featureNotAvailableError, isDatabase: featureNotAvailableError, getDatabaseList: featureNotAvailableError, addSQLiteSuffix: featureNotAvailableError, deleteOldDatabases: featureNotAvailableError }, notAvailable);
     }
@@ -223,5 +316,6 @@ else {
             addUpgradeStatement, importFromJson, isJsonValid, copyFromAssets,
-            isAvailable: true };
+            isConnection, isDatabase, getDatabaseList, addSQLiteSuffix,
+            deleteOldDatabases, isAvailable: true };
     }
 };
 //# sourceMappingURL=useSQLite.js.map

docs/APIHook.md

@@ -20,2 +20,7 @@ <p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
 * [`closeAllConnections()`](#closeallconnections)
+* [`isConnection(...)`](#isconnection)
+* [`isDatabase(...)`](#isdatabase)
+* [`getDatabaseList()`](#getdatabaselist)
+* [`addSQLiteSuffix(...)`](#addsqlitesuffix)
+* [`deleteOldDatabases(...)`](#deleteolddatabases)
 * [`importFromJson(...)`](#importfromjson)
@@ -173,2 +178,89 @@ * [`isJsonValid(...)`](#isjsonvalid)
 
+### isConnection(...)
+
+```typescript
+isConnection(database: string) => Promise<Result>
+```
+
+Check if database connection exists
+
+| Param          | Type                |
+| -------------- | ------------------- |
+| **`database`** | <code>string</code> |
+
+**Returns:** <code>Promise&lt;<a href="#result">Result</a>&gt;</code>
+
+**Since:** 2.0.0
+
+--------------------
+
+
+### isDatabase(...)
+
+```typescript
+isDatabase(database: string) => Promise<Result>
+```
+
+Check if database exists
+
+| Param          | Type                |
+| -------------- | ------------------- |
+| **`database`** | <code>string</code> |
+
+**Returns:** <code>Promise&lt;<a href="#result">Result</a>&gt;</code>
+
+**Since:** 2.0.0
+
+--------------------
+
+
+### getDatabaseList()
+
+```typescript
+getDatabaseList() => Promise<capSQLiteValues>
+```
+
+Get the database list
+
+**Returns:** <code>Promise&lt;<a href="#capsqlitevalues">capSQLiteValues</a>&gt;</code>
+
+**Since:** 1.0.1 refactor
+
+--------------------
+
+
+### addSQLiteSuffix(...)
+
+```typescript
+addSQLiteSuffix(folderPath?: string | undefined) => Promise<void>
+```
+
+Add SQLIte Suffix to existing databases
+
+| Param            | Type                |
+| ---------------- | ------------------- |
+| **`folderPath`** | <code>string</code> |
+
+**Since:** 2.0.0
+
+--------------------
+
+
+### deleteOldDatabases(...)
+
+```typescript
+deleteOldDatabases(folderPath?: string | undefined) => Promise<void>
+```
+
+Delete Old Cordova databases
+
+| Param            | Type                |
+| ---------------- | ------------------- |
+| **`folderPath`** | <code>string</code> |
+
+**Since:** 2.0.0
+
+--------------------
+
+
 ### importFromJson(...)
@@ -262,2 +354,17 @@
 
+#### Result
+
+| Prop          | Type                 |
+| ------------- | -------------------- |
+| **`result`**  | <code>boolean</code> |
+| **`message`** | <code>string</code>  |
+
+
+#### capSQLiteValues
+
+| Prop         | Type               | Description                      |
+| ------------ | ------------------ | -------------------------------- |
+| **`values`** | <code>any[]</code> | the data values list as an Array |
+
+
 #### capSQLiteChanges
@@ -277,10 +384,2 @@
 
-
-#### Result
-
-| Prop          | Type                 |
-| ------------- | -------------------- |
-| **`result`**  | <code>boolean</code> |
-| **`message`** | <code>string</code>  |
-
 </docgen-api>

package.json

 {
   "name": "react-sqlite-hook",
-  "version": "2.0.0-alpha.1",
+  "version": "2.0.0",
   "description": "React Hook for @Capacitor-community/sqlite plugin",
@@ -47,8 +47,8 @@ "repository": {
     "react": "^17.0.1",
-    "@capacitor/core": "next",
-    "@capacitor-community/sqlite": "next"
+    "@capacitor/core": "^3.0.0-rc.0",
+    "@capacitor-community/sqlite": "^3.0.0-beta.7"
   },
   "devDependencies": {
-    "@capacitor-community/sqlite": "next",
-    "@capacitor/core": "next",
+    "@capacitor-community/sqlite": "^3.0.0-beta.7",
+    "@capacitor/core": "^3.0.0-rc.0",
     "@capacitor/docgen": "0.0.14",
@@ -55,0 +55,0 @@ "@testing-library/react-hooks": "^3.4.2",

src/useSQLite.ts

@@ -6,4 +6,4 @@ import { useCallback, useMemo } from 'react';
                                     from './util/feature-check';
-import { CapacitorSQLite, SQLiteDBConnection,
-         SQLiteConnection, capSQLiteChanges } from '@capacitor-community/sqlite';
+import { CapacitorSQLite, SQLiteDBConnection, SQLiteConnection,
+         capSQLiteChanges, capSQLiteValues } from '@capacitor-community/sqlite';
 
@@ -80,2 +80,36 @@ export { SQLiteDBConnection }
     /**
+     * Check if database connection exists
+     * @param database
+     * @returns Promise<Result>
+     * @since 2.0.0
+     */
+    isConnection(database: string): Promise<Result>;
+    /**
+     * Check if database exists
+     * @param database
+     * @returns Promise<Result>
+     * @since 2.0.0
+     */
+    isDatabase(database: string): Promise<Result>;
+    /**
+     * Get the database list
+     * @returns Promise<capSQLiteValues>
+     * @since 1.0.1 refactor
+     */
+    getDatabaseList(): Promise<capSQLiteValues>;
+    /**
+     * Add SQLIte Suffix to existing databases
+     * @param folderPath
+     * @returns Promise<void>
+     * @since 2.0.0
+     */
+    addSQLiteSuffix(folderPath?: string): Promise<void>
+    /**
+     * Delete Old Cordova databases
+     * @param folderPath
+     * @returns Promise<void>
+     * @since 2.0.0
+     */
+    deleteOldDatabases(folderPath?: string): Promise<void>;
+    /**
      * Import a database From a JSON
@@ -204,2 +238,91 @@ * @param jsonstring string
     /**
+     * Check if database connection exists
+     * @param database
+     */
+     const isConnection = useCallback(async (dbName: string): Promise<Result> => {
+        if(dbName.length > 0) {
+            try {
+                const r = await mSQLite.isConnection(dbName);
+                if(r) {
+                        return Promise.resolve(r);
+                } else {
+                    return Promise.reject("No returned isConnection");
+                }
+            } catch (err) {
+                return Promise.reject(err);
+            } 
+        } else {
+            return Promise.reject('Must provide a database name');
+        }
+
+    }, [mSQLite]);
+    /**
+     * Check if database exists
+     * @param database
+     */
+    const isDatabase = useCallback(async (dbName: string): Promise<Result> => {
+        if(dbName.length > 0) {
+            try {
+
+                const r = await mSQLite.isDatabase(dbName);
+                if(r) {
+                    return Promise.resolve(r);
+                } else {
+                    return Promise.reject("Error in isDatabase");
+                }
+            } catch (err) {
+                return Promise.reject(err);
+            }
+        } else {
+            return Promise.reject('Must provide a database name');
+        }
+
+    }, [mSQLite]);
+    /**
+     * Get the database list
+     * @returns Promise<capSQLiteValues>
+     * @since 1.0.1 refactor
+     */
+    const getDatabaseList = useCallback(async (): Promise<capSQLiteValues> => {
+        try {
+            const r = await mSQLite.getDatabaseList();
+            if(r) {
+                return Promise.resolve(r);
+            } else {
+                return Promise.reject("Error in getDatabaseList");
+            }
+        } catch (err) {
+            return Promise.reject(err);
+        }
+
+    }, [mSQLite]);
+    /**
+     * Add SQLIte Suffix to existing databases
+     * @param folderPath
+     */
+    const addSQLiteSuffix = useCallback(async (folderPath?: string): Promise<void> => {
+        const path: string = folderPath ? folderPath : "default"
+        try {
+            await mSQLite.addSQLiteSuffix(path);
+            return Promise.resolve();
+        } catch(err) {
+            return Promise.reject(err);
+        }
+
+    }, [mSQLite]);
+    /**
+     * Delete Old Cordova databases
+     * @param folderPath
+     */
+    const deleteOldDatabases = useCallback(async (folderPath?: string): Promise<void> => {
+        const path: string = folderPath ? folderPath : "default"
+        try {
+            await mSQLite.deleteOldDatabases(path);
+            return Promise.resolve();
+        } catch(err) {
+            return Promise.reject(err);
+        }
+    }, [mSQLite]);
+
+    /**
      * Retrieve a Connection to the Database
@@ -344,2 +467,7 @@ * @param dbName string
             copyFromAssets: featureNotAvailableError,
+            isConnection: featureNotAvailableError,
+            isDatabase: featureNotAvailableError,
+            getDatabaseList: featureNotAvailableError,
+            addSQLiteSuffix: featureNotAvailableError,
+            deleteOldDatabases: featureNotAvailableError,
             ...notAvailable
@@ -351,5 +479,6 @@ };
             addUpgradeStatement, importFromJson, isJsonValid, copyFromAssets,
-            isAvailable: true};
+            isConnection, isDatabase, getDatabaseList, addSQLiteSuffix,
+            deleteOldDatabases, isAvailable: true};
     }
 
 }

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

76338

increased by19.27%

Lines of code

1360

increased by22.74%

Number of low quality alerts

0

decreased by-100%

No dependency changes