change plugin definitions

CapacitorDataStorageSqlite.podspec

@@ -1,7 +1,7 @@
 
   Pod::Spec.new do |s|
     s.name = 'CapacitorDataStorageSqlite'
-    s.version = '0.0.8-1'
+    s.version = '0.0.9'
     s.summary = 'Capacitor data storage on SQLite plugin'
     s.license = 'MIT'
     s.homepage = 'https://github.com/jepiqueau/capacitor-data-storage-sqlite.git'

dist/esm/definitions.d.ts

@@ -4,37 +4,81 @@ declare global  {
     }
 }
 export interface CapacitorDataStorageSqlitePlugin {
-    set(options: {
-        key: string;
-        value: string;
-    }): Promise<{
-        result: boolean;
-    }>;
-    get(options: {
-        key: string;
-    }): Promise<{
-        value: string;
-    }>;
-    remove(options: {
-        key: string;
-    }): Promise<{
-        result: boolean;
-    }>;
-    clear(): Promise<{
-        result: boolean;
-    }>;
-    iskey(options: {
-        key: string;
-    }): Promise<{
-        result: boolean;
-    }>;
-    keys(): Promise<{
-        keys: Array<string>;
-    }>;
-    values(): Promise<{
-        values: Array<string>;
-    }>;
-    keysvalues(): Promise<{
-        keysvalues: Array<any>;
-    }>;
+    /**
+     * Store a data with given key and value
+     * @param {capDataStorageOptions} options
+     * @returns {Promise<capDataStorageResult>} {result:boolean}
+     */
+    set(options: capDataStorageOptions): Promise<capDataStorageResult>;
+    /**
+     * Retrieve a data value for a given data key
+     * @param {capDataStorageOptions} options
+     * @returns {Promise<capDataStorageResult>} {value:string}
+     */
+    get(options: capDataStorageOptions): Promise<capDataStorageResult>;
+    /**
+     * Remove a data with given key
+     * @param {capDataStorageOptions} options
+     * @returns {Promise<capDataStorageResult>} {result:boolean}
+     */
+    remove(options: capDataStorageOptions): Promise<capDataStorageResult>;
+    /**
+     * Clear the Data Store (delete all keys)
+     * @returns {Promise<capDataStorageResult>} {result:boolean}
+     */
+    clear(): Promise<capDataStorageResult>;
+    /**
+     * Check if a data key exists
+     * @param {capDataStorageOptions} options
+     * @returns {Promise<capDataStorageResult>} {result:boolean}
+     */
+    iskey(options: capDataStorageOptions): Promise<capDataStorageResult>;
+    remove(options: capDataStorageOptions): Promise<capDataStorageResult>;
+    /**
+     * Get the data key list
+     * @returns {Promise<capDataStorageResult>} {keys:Array<string>}
+     */
+    keys(): Promise<capDataStorageResult>;
+    /**
+     * Get the data value list
+     * @returns {Promise<capDataStorageResult>} {values:Array<string>}
+     */
+    values(): Promise<capDataStorageResult>;
+    /**
+     * Get the data key/value pair list
+     * @returns {Promise<capDataStorageResult>} {keysvalues:Array<{key:string,value:string}>}
+     */
+    keysvalues(): Promise<capDataStorageResult>;
+}
+export interface capDataStorageOptions {
+    /**
+     * The data name
+     */
+    key: string;
+    /**
+     * The data value when required
+     */
+    value?: string;
+}
+export interface capDataStorageResult {
+    /**
+     * result set to true when successful else false
+     */
+    result?: boolean;
+    /**
+     * the data value for a given data key
+     */
+    value?: string;
+    /**
+     * the data key list as an Array
+     */
+    keys?: Array<string>;
+    /**
+     * the data values list as an Array
+     */
+    values?: Array<string>;
+    /**
+     * the data keys/values list as an Array of {key:string,value:string}
+     */
+    keysvalues?: Array<any>;
 }

dist/esm/web.d.ts

@@ -1,42 +1,17 @@
 import { WebPlugin } from '@capacitor/core';
 import { StorageDatabaseHelper } from './web-utils/StorageDatabaseHelper';
-import { CapacitorDataStorageSqlitePlugin } from './definitions';
-export declare class CapacitorDataStorageIdbWeb extends WebPlugin implements CapacitorDataStorageSqlitePlugin {
+import { CapacitorDataStorageSqlitePlugin, capDataStorageOptions, capDataStorageResult } from './definitions';
+export declare class CapacitorDataStorageSqlitePluginWeb extends WebPlugin implements CapacitorDataStorageSqlitePlugin {
     mDb: StorageDatabaseHelper;
     constructor();
-    set(options: {
-        key: string;
-        value: string;
-    }): Promise<{
-        result: boolean;
-    }>;
-    get(options: {
-        key: string;
-    }): Promise<{
-        value: string;
-    }>;
-    remove(options: {
-        key: string;
-    }): Promise<{
-        result: boolean;
-    }>;
-    clear(): Promise<{
-        result: boolean;
-    }>;
-    iskey(options: {
-        key: string;
-    }): Promise<{
-        result: boolean;
-    }>;
-    keys(): Promise<{
-        keys: Array<string>;
-    }>;
-    values(): Promise<{
-        values: Array<string>;
-    }>;
-    keysvalues(): Promise<{
-        keysvalues: Array<any>;
-    }>;
+    set(options: capDataStorageOptions): Promise<capDataStorageResult>;
+    get(options: capDataStorageOptions): Promise<capDataStorageResult>;
+    remove(options: capDataStorageOptions): Promise<capDataStorageResult>;
+    clear(): Promise<capDataStorageResult>;
+    iskey(options: capDataStorageOptions): Promise<capDataStorageResult>;
+    keys(): Promise<capDataStorageResult>;
+    values(): Promise<capDataStorageResult>;
+    keysvalues(): Promise<capDataStorageResult>;
 }
-declare const CapacitorDataStorageSqlite: CapacitorDataStorageIdbWeb;
+declare const CapacitorDataStorageSqlite: CapacitorDataStorageSqlitePluginWeb;
 export { CapacitorDataStorageSqlite };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-data-storage-sqlite",
-  "version": "0.0.8-1",
+  "version": "0.0.9",
   "description": "Capacitor data storage on SQLite plugin",
   "main": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",

readme.md

@@ -4,7 +4,6 @@ As capacitor provides fisrt-class Progressive Web App support so you can use thi
 
 Capacitor Data Storage SQlite Plugin provides a key-value store for simple data of type string only, so JSON object can be stored, you should manage conversion through JSON.stringify before storing and JSON.parse when retrieving the data, use the same procedure for number through number.toString() and Number().
 
-WARNING  NEVER USE VERSION 0.0.5.11 TO 0.0.5.17
 
 ## View Me
 [capacitor-data-storage-sqlite](https://ionicpwacapacitorstorage.firebaseapp.com)
@@ -27,12 +26,14 @@ npm install --save capacitor-data-storage-sqlite@latest
 
 Ionic App showing an integration of [capacitor-data-storage-sqlite plugin](https://github.com/jepiqueau/ionic-capacitor-data-storage-sqlite)
 
+Vue App showing an integration of [capacitor-data-storage-sqlite plugin](https://github.com/jepiqueau/vue-capacitor-data-storage-sqlite)
+
 PWA App showing an integration of 
-[capacitor-data-storage-sqlite plugin] (https://github.com/jepiqueau/ionicpwacapacitorstorage.git)
+[capacitor-data-storage-sqlite plugin](https://github.com/jepiqueau/ionicpwacapacitorstorage.git)
 
 
 ## Remarks
-The third release of the plugin includes the Native IOS code (Objective-C/Swift),the Native Android code (Java) and the Web code (Typescript) using Capacitor v1.0.0-beta.11
+This release of the plugin includes the Native IOS code (Objective-C/Swift),the Native Android code (Java) and the Web code (Typescript) using Capacitor v1.0.0-beta.11
 
 ## Dependencies
 The IOS code is based on SQLite.swift as wrapper for SQLite, the Web code has been implemented with localforage  as wrapper for indexDB.

src/definitions.ts

@@ -5,12 +5,83 @@ declare global {
 }
 
 export interface CapacitorDataStorageSqlitePlugin {
-  set(options: { key: string, value: string }): Promise<{result: boolean}>;
-  get(options: { key: string}): Promise<{value: string}>;
-  remove(options: {key:string}): Promise<{result: boolean}>;
-  clear(): Promise<{result: boolean}>;
-  iskey(options: {key:string}): Promise<{result: boolean}>;
-  keys(): Promise<{keys: Array<string>}>;
-  values(): Promise<{values: Array<string>}>;
-  keysvalues(): Promise<{keysvalues: Array<any>}>;
+  /**
+   * Store a data with given key and value
+   * @param {capDataStorageOptions} options 
+   * @returns {Promise<capDataStorageResult>} {result:boolean}
+   */
+  set(options: capDataStorageOptions): Promise<capDataStorageResult>;
+  /**
+   * Retrieve a data value for a given data key
+   * @param {capDataStorageOptions} options 
+   * @returns {Promise<capDataStorageResult>} {value:string}
+   */
+  get(options: capDataStorageOptions): Promise<capDataStorageResult>;
+  /**
+   * Remove a data with given key
+   * @param {capDataStorageOptions} options 
+   * @returns {Promise<capDataStorageResult>} {result:boolean}
+   */
+  remove(options: capDataStorageOptions): Promise<capDataStorageResult>;
+  /**
+   * Clear the Data Store (delete all keys)
+   * @returns {Promise<capDataStorageResult>} {result:boolean}
+   */
+  clear(): Promise<capDataStorageResult>;
+  /**
+   * Check if a data key exists
+   * @param {capDataStorageOptions} options 
+   * @returns {Promise<capDataStorageResult>} {result:boolean}
+   */
+  iskey(options: capDataStorageOptions): Promise<capDataStorageResult>;
+  remove(options: capDataStorageOptions): Promise<capDataStorageResult>;
+  /**
+   * Get the data key list
+   * @returns {Promise<capDataStorageResult>} {keys:Array<string>}
+   */
+  keys(): Promise<capDataStorageResult>;
+  /**
+   * Get the data value list
+   * @returns {Promise<capDataStorageResult>} {values:Array<string>}
+   */
+  values(): Promise<capDataStorageResult>;
+  /**
+   * Get the data key/value pair list
+   * @returns {Promise<capDataStorageResult>} {keysvalues:Array<{key:string,value:string}>}
+   */
+  keysvalues(): Promise<capDataStorageResult>;
+}
+
+export interface capDataStorageOptions {
+  /**
+   * The data name
+   */
+  key: string;
+  /**
+   * The data value when required
+   */
+  value?: string;
+}
+
+export interface capDataStorageResult {
+  /**
+   * result set to true when successful else false
+   */
+  result?: boolean;
+  /**
+   * the data value for a given data key
+   */
+  value?: string;
+  /**
+   * the data key list as an Array
+   */
+  keys?: Array<string>;
+  /**
+   * the data values list as an Array
+   */
+  values?: Array<string>;
+  /**
+   * the data keys/values list as an Array of {key:string,value:string}
+   */
+  keysvalues?: Array<any>;
 }