react-sqlite-hook - npm Package Compare versions

Comparing version 2.1.0 to 2.1.1

CHANGELOG.md

@@ -0,1 +1,14 @@
+## 2.1.1 (2021-10-18)
+
+### Chore
+
+- update to @capacitor/core 3.2.4
+- update to @capacitor-community/sqlite 3.2.4
+
+### Added Features
+
+- add `getMigratableDbList` method (iOS, Android)
+- add `dbNameList` paramter to `addSQLiteSuffix`and `deleteOldDatabase`  methods (iOS, Android)
+
+
 ## 2.1.0 (2021-09-25)
@@ -2,0 +15,0 @@

dist/package.json

 {
   "name": "react-sqlite-hook",
-  "version": "2.0.6",
+  "version": "2.1.0",
   "description": "React Hook for @Capacitor-community/sqlite plugin",
@@ -45,16 +45,15 @@ "repository": {
   "peerDependencies": {
-    "@capacitor-community/sqlite": "^3.2.3-1",
-    "@capacitor/core": "^3.2.3",
+    "@capacitor-community/sqlite": "^3.2.4",
+    "@capacitor/core": "^3.2.4",
     "react": "^17.0.2"
   },
   "devDependencies": {
-    "@capacitor-community/sqlite": "3.2.3-1",
-    "@capacitor/core": "3.2.3",
+    "@capacitor-community/sqlite": "3.2.4",
+    "@capacitor/core": "3.2.4",
     "@capacitor/docgen": "0.0.17",
     "@testing-library/react-hooks": "^5.1.2",
-    "@types/jest": "^26.0.23",
+    "@types/jest": "^27.0.2",
     "@types/react-test-renderer": "^17.0.1",
     "conventional-changelog": "^3.1.24",
-    "jest": "^26.5.0",
-    "jest-environment-jsdom-fourteen": "^0.1.0",
+    "jest": "^27.3.0",
     "np": "^7.5.0",
@@ -66,3 +65,3 @@ "react": "17.0.2",
     "rimraf": "^3.0.2",
-    "ts-jest": "^26.4.4",
+    "ts-jest": "^27.0.7",
     "typedoc": "^0.20.36",
@@ -69,0 +68,0 @@ "typescript": "^4.0.5",

dist/useSQLite.d.ts

@@ -115,15 +115,24 @@ import { AvailableResult } from './util/models';
     /**
-     * Add SQLIte Suffix to existing databases
+     * Get Migratable database List
      * @param folderPath
-     * @returns Promise<void>
-     * @since 2.0.0
+     * @returns Promise<capSQLiteValues>
+     * @since 2.1.1
      */
-    addSQLiteSuffix(folderPath?: string): Promise<void>;
+    getMigratableDbList(folderPath?: string): Promise<capSQLiteValues>;
     /**
+    * Add SQLIte Suffix to existing databases
+    * @param folderPath
+    * @param dbNameList since 2.1.1
+    * @returns Promise<void>
+    * @since 2.0.0
+    */
+    addSQLiteSuffix(folderPath?: string, dbNameList?: string[]): Promise<void>;
+    /**
      * Delete Old Cordova databases
      * @param folderPath
+     * @param dbNameList since 2.1.1
      * @returns Promise<void>
      * @since 2.0.0
      */
-    deleteOldDatabases(folderPath?: string): Promise<void>;
+    deleteOldDatabases(folderPath?: string, dbNameList?: string[]): Promise<void>;
     /**
@@ -130,0 +139,0 @@ * Import a database From a JSON

dist/useSQLite.js

@@ -219,9 +219,31 @@ import { useCallback, useMemo, useEffect } from 'react';
     /**
+     * Get the migratable database list
+     * @param folderPath
+     *
+     */
+    const getMigratableDbList = useCallback(async (folderPath) => {
+        const path = folderPath ? folderPath : "default";
+        try {
+            const r = await mSQLite.getMigratableDbList(path);
+            if (r) {
+                return Promise.resolve(r);
+            }
+            else {
+                return Promise.reject("Error in getMigratableDbList");
+            }
+        }
+        catch (err) {
+            return Promise.reject(err);
+        }
+    }, [mSQLite]);
+    /**
      * Add SQLIte Suffix to existing databases
      * @param folderPath
+     * @param dbNameList
      */
-    const addSQLiteSuffix = useCallback(async (folderPath) => {
+    const addSQLiteSuffix = useCallback(async (folderPath, dbNameList) => {
         const path = folderPath ? folderPath : "default";
+        const dbList = dbNameList ? dbNameList : [];
         try {
-            await mSQLite.addSQLiteSuffix(path);
+            await mSQLite.addSQLiteSuffix(path, dbList);
             return Promise.resolve();
@@ -236,7 +258,9 @@ }
      * @param folderPath
+     * @param dbNameList
      */
-    const deleteOldDatabases = useCallback(async (folderPath) => {
+    const deleteOldDatabases = useCallback(async (folderPath, dbNameList) => {
         const path = folderPath ? folderPath : "default";
+        const dbList = dbNameList ? dbNameList : [];
         try {
-            await mSQLite.deleteOldDatabases(path);
+            await mSQLite.deleteOldDatabases(path, dbList);
             return Promise.resolve();
@@ -440,3 +464,3 @@ }
     if (!availableFeaturesN.useSQLite) {
-        return Object.assign({ initWebStore: featureNotAvailableError, saveToStore: featureNotAvailableError, echo: featureNotAvailableError, getPlatform: featureNotAvailableError, getCapacitorSQLite: 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, checkConnectionsConsistency: featureNotAvailableError, isSecretStored: featureNotAvailableError, setEncryptionSecret: featureNotAvailableError, changeEncryptionSecret: featureNotAvailableError }, notAvailable);
+        return Object.assign({ initWebStore: featureNotAvailableError, saveToStore: featureNotAvailableError, echo: featureNotAvailableError, getPlatform: featureNotAvailableError, getCapacitorSQLite: 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, getMigratableDbList: featureNotAvailableError, addSQLiteSuffix: featureNotAvailableError, deleteOldDatabases: featureNotAvailableError, checkConnectionsConsistency: featureNotAvailableError, isSecretStored: featureNotAvailableError, setEncryptionSecret: featureNotAvailableError, changeEncryptionSecret: featureNotAvailableError }, notAvailable);
     }
@@ -447,3 +471,3 @@ else {
             addUpgradeStatement, importFromJson, isJsonValid, copyFromAssets,
-            isConnection, isDatabase, getDatabaseList, addSQLiteSuffix,
+            isConnection, isDatabase, getDatabaseList, getMigratableDbList, addSQLiteSuffix,
             deleteOldDatabases, checkConnectionsConsistency,
@@ -450,0 +474,0 @@ isSecretStored, setEncryptionSecret, changeEncryptionSecret,

docs/APIHook.md

@@ -26,2 +26,3 @@ <p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
 * [`getDatabaseList()`](#getdatabaselist)
+* [`getMigratableDbList(...)`](#getmigratabledblist)
 * [`addSQLiteSuffix(...)`](#addsqlitesuffix)
@@ -285,9 +286,9 @@ * [`deleteOldDatabases(...)`](#deleteolddatabases)
 
-### addSQLiteSuffix(...)
+### getMigratableDbList(...)
 
 ```typescript
-addSQLiteSuffix(folderPath?: string | undefined) => Promise<void>
+getMigratableDbList(folderPath?: string | undefined) => Promise<capSQLiteValues>
 ```
 
-Add SQLIte Suffix to existing databases
+Get Migratable database List
 
@@ -298,2 +299,22 @@ | Param            | Type                |
 
+**Returns:** <code>Promise&lt;<a href="#capsqlitevalues">capSQLiteValues</a>&gt;</code>
+
+**Since:** 2.1.1
+
+--------------------
+
+
+### addSQLiteSuffix(...)
+
+```typescript
+addSQLiteSuffix(folderPath?: string | undefined, dbNameList?: string[] | undefined) => Promise<void>
+```
+
+Add SQLIte Suffix to existing databases
+
+| Param            | Type                  | Description |
+| ---------------- | --------------------- | ----------- |
+| **`folderPath`** | <code>string</code>   |             |
+| **`dbNameList`** | <code>string[]</code> | since 2.1.1 |
+
 **Since:** 2.0.0
@@ -307,3 +328,3 @@
 ```typescript
-deleteOldDatabases(folderPath?: string | undefined) => Promise<void>
+deleteOldDatabases(folderPath?: string | undefined, dbNameList?: string[] | undefined) => Promise<void>
 ```
@@ -313,5 +334,6 @@
 
-| Param            | Type                |
-| ---------------- | ------------------- |
-| **`folderPath`** | <code>string</code> |
+| Param            | Type                  | Description |
+| ---------------- | --------------------- | ----------- |
+| **`folderPath`** | <code>string</code>   |             |
+| **`dbNameList`** | <code>string[]</code> | since 2.1.1 |
 
@@ -318,0 +340,0 @@ **Since:** 2.0.0

package.json

 {
   "name": "react-sqlite-hook",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "React Hook for @Capacitor-community/sqlite plugin",
@@ -45,16 +45,15 @@ "repository": {
   "peerDependencies": {
-    "@capacitor-community/sqlite": "^3.2.3-1",
-    "@capacitor/core": "^3.2.3",
+    "@capacitor-community/sqlite": "^3.2.4",
+    "@capacitor/core": "^3.2.4",
     "react": "^17.0.2"
   },
   "devDependencies": {
-    "@capacitor-community/sqlite": "3.2.3-1",
-    "@capacitor/core": "3.2.3",
+    "@capacitor-community/sqlite": "3.2.4",
+    "@capacitor/core": "3.2.4",
     "@capacitor/docgen": "0.0.17",
     "@testing-library/react-hooks": "^5.1.2",
-    "@types/jest": "^26.0.23",
+    "@types/jest": "^27.0.2",
     "@types/react-test-renderer": "^17.0.1",
     "conventional-changelog": "^3.1.24",
-    "jest": "^26.5.0",
-    "jest-environment-jsdom-fourteen": "^0.1.0",
+    "jest": "^27.3.0",
     "np": "^7.5.0",
@@ -66,3 +65,3 @@ "react": "17.0.2",
     "rimraf": "^3.0.2",
-    "ts-jest": "^26.4.4",
+    "ts-jest": "^27.0.7",
     "typedoc": "^0.20.36",
@@ -69,0 +68,0 @@ "typescript": "^4.0.5",

README.md

@@ -25,3 +25,3 @@ <p align="center"><br><img src="https://avatars3.githubusercontent.com/u/16580653?v=4" width="128" height="128" /></p>
 
-## @LATEST For Capacitor 3 (Main)
+## @LATEST For Capacitor 3 (Master)
 
@@ -68,2 +68,3 @@ The `Capacitor3`react-sqlite-hook interfacing the `@capacitor-community/sqlite@latest`
 | getDatabaseList             | ✅      | ✅   | ✅       | ✅  |
+| getMigratableDbList         | ✅      | ✅   | ❌       | ❌  |
 | addSQLiteSuffix             | ✅      | ✅   | ❌       | ❌  |
@@ -70,0 +71,0 @@ | deleteOldDatabases          | ✅      | ✅   | ❌       | ❌  |

src/useSQLite.ts

@@ -123,15 +123,24 @@ import { useCallback, useMemo, useEffect } from 'react';
     /**
+     * Get Migratable database List
+     * @param folderPath
+     * @returns Promise<capSQLiteValues>
+     * @since 2.1.1
+     */
+    getMigratableDbList(folderPath?: string): Promise<capSQLiteValues>
+     /**
      * Add SQLIte Suffix to existing databases
      * @param folderPath
+     * @param dbNameList since 2.1.1
      * @returns Promise<void>
      * @since 2.0.0
      */
-    addSQLiteSuffix(folderPath?: string): Promise<void>
+    addSQLiteSuffix(folderPath?: string, dbNameList?: string[]): Promise<void>
     /**
      * Delete Old Cordova databases
      * @param folderPath
+     * @param dbNameList since 2.1.1
      * @returns Promise<void>
      * @since 2.0.0
      */
-    deleteOldDatabases(folderPath?: string): Promise<void>;
+    deleteOldDatabases(folderPath?: string, dbNameList?: string[]): Promise<void>;
     /**
@@ -420,9 +429,30 @@ * Import a database From a JSON
     /**
+     * Get the migratable database list
+     * @param folderPath
+     * 
+     */
+     const getMigratableDbList = useCallback(async (folderPath?: string): Promise<capSQLiteValues> => {
+        const path: string = folderPath ? folderPath : "default"
+        try {
+            const r = await mSQLite.getMigratableDbList(path);
+            if(r) {
+                return Promise.resolve(r);
+            } else {
+                return Promise.reject("Error in getMigratableDbList");
+            }
+        } catch(err) {
+            return Promise.reject(err);
+        }
+
+    }, [mSQLite]);
+    /**
      * Add SQLIte Suffix to existing databases
      * @param folderPath
+     * @param dbNameList
      */
-    const addSQLiteSuffix = useCallback(async (folderPath?: string): Promise<void> => {
+    const addSQLiteSuffix = useCallback(async (folderPath?: string, dbNameList?: string[]): Promise<void> => {
         const path: string = folderPath ? folderPath : "default"
+        const dbList: string[] = dbNameList ? dbNameList : []
         try {
-            await mSQLite.addSQLiteSuffix(path);
+            await mSQLite.addSQLiteSuffix(path, dbList);
             return Promise.resolve();
@@ -437,7 +467,9 @@ } catch(err) {
      * @param folderPath
+     * @param dbNameList
      */
-    const deleteOldDatabases = useCallback(async (folderPath?: string): Promise<void> => {
+    const deleteOldDatabases = useCallback(async (folderPath?: string, dbNameList?: string[]): Promise<void> => {
         const path: string = folderPath ? folderPath : "default"
+        const dbList: string[] = dbNameList ? dbNameList : []
         try {
-            await mSQLite.deleteOldDatabases(path);
+            await mSQLite.deleteOldDatabases(path, dbList);
             return Promise.resolve();
@@ -653,2 +685,3 @@ } catch(err) {
             getDatabaseList: featureNotAvailableError,
+            getMigratableDbList: featureNotAvailableError,
             addSQLiteSuffix: featureNotAvailableError,
@@ -666,3 +699,3 @@ deleteOldDatabases: featureNotAvailableError,
             addUpgradeStatement, importFromJson, isJsonValid, copyFromAssets,
-            isConnection, isDatabase, getDatabaseList, addSQLiteSuffix,
+            isConnection, isDatabase, getDatabaseList, getMigratableDbList, addSQLiteSuffix,
             deleteOldDatabases, checkConnectionsConsistency, 
@@ -669,0 +702,0 @@ isSecretStored, setEncryptionSecret, changeEncryptionSecret,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

103405

increased by4.13%

Dev dependency count

18

decreased by-5.26%

Lines of code

1800

increased by3.81%

Number of lines in readme file

130

increased by0.78%

No dependency changes